# 搜索代发单
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南
接口英文名:dropship_search
该接口用于搜索代发单
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/channels/ec/order/dropship/search?access_token=ACCESS_TOKEN
# 云调用
- 本接口不支持云调用
# 第三方调用
本接口支持第三方平台代微信小店商家调用。
该接口所属的权限集 id 为:131
服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代微信小店商家进行调用,具体可查看 第三方调用 说明文档。
# 2. 请求参数
# 查询参数 Query String parameters
参数名 | 类型 | 必填 | 示例 | 说明 |
---|---|---|---|---|
access_token | string | 是 | ACCESS_TOKEN | 接口调用凭证,可使用 access_token(微信小店商家)、authorizer_access_token(服务商) |
# 请求体 Request Payload
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
search_condition | object | 是 | 搜索条件 |
page_info | object | 否 | 分页参数,上一页请求返回 |
# Body.search_condition Object Payload
搜索条件
参数名 | 类型 | 必填 | 说明 | 枚举 |
---|---|---|---|---|
order_id | number | 否 | 订单号,非必填,可根据订单号反查代发单 | - |
supplier_appid | string | 否 | 供货商appid | - |
status | number | 否 | 代发单状态 | 枚举值 |
create_time_range | object | 否 | 代发单创建时间范围 | - |
waybill_id | string | 否 | 运单号,只可独立查询 | - |
# Body.page_info Object Payload
分页参数,上一页请求返回
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
offset | number | 是 | 游标,从0开始 |
limit | number | 是 | 分页大小,<= 10 |
# Body.search_condition.create_time_range Object Payload
代发单创建时间范围
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
start_time | number | 是 | 秒级时间戳(距离end_time不可超过7天) |
end_time | number | 是 | 秒级时间戳(距离start_time不可超过7天) |
# 3. 返回参数
# 返回体 Response Payload
参数名 | 类型 | 说明 |
---|---|---|
errcode | number | 错误码 |
errmsg | string | 错误信息 |
ds_order_id_list | array | 代发单号列表 |
next_page | object | 分页参数,下一页请求返回 |
total | number | 总数 |
# Res.next_page Object Payload
分页参数,下一页请求返回
参数名 | 类型 | 说明 |
---|---|---|
offset | number | 游标,从0开始 |
limit | number | 分页大小,<= 100 |
# 4. 枚举信息
# Body.search_condition.status Enum
代发单状态
枚举值 | 描述 |
---|---|
100 | 待发货 |
199 | 部分发货 |
200 | 已发货 |
300 | 已取消 |
# 5. 注意事项
本接口无特殊注意事项
# 6. 代码示例
请求示例
{
"search_condition": {
"order_id": "37000204335323251",
"create_time_range": {
"start_time": 1658505600,
"end_time": 1658509200
},
"status": 0,
},
"page_info": {
"offset": 0,
"limit": 10
}
}
返回示例
{
"errcode": 0,
"errmsg": "ok",
"ds_order_id_list": [
"4404612354559743232",
"4404849110714209536"
],
"next_page": {
"offset": 10,
"limit": 10
},
"total": 100
}
# 7. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码
错误码 | 错误描述 | 解决方案 |
---|---|---|
40097 | 请求体参数不正确,请检查各个参数是否按规范填写,具体原因查看errmsg | |
47001 | 请求体格式不正确,请检查请求体中各个参数的类型是否正确 |
# 8. 适用范围
本接口支持「微信小店」账号类型调用。其他账号类型如无特殊说明,均不可调用。