# 获取代发单列表

调试诊断

接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南

接口英文名:dropship_list

该接口用于拉取代发单列表

# 1. 调用方式

# HTTPS 调用

POST https://api.weixin.qq.com/channels/ec/order/dropship/supplier/list?access_token=ACCESS_TOKEN

# 云调用

  • 本接口不支持云调用

# 第三方调用

  • 本接口支持第三方平台代供货商调用。

  • 该接口所属的权限集 id 为:192

  • 服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代供货商进行调用,具体可查看 第三方调用 说明文档。

# 2. 请求参数

# 查询参数 Query String parameters

参数名类型必填示例说明
access_tokenstringACCESS_TOKEN接口调用凭证,可使用 access_token(供货商)、authorizer_access_token(服务商)

# 请求体 Request Payload

参数名类型必填说明
create_time_rangeobject代发单创建时间范围。时间范围至少填一个
statusnumber代发单状态,具体枚举值请参考下文
shop_appidstring商家appid
page_infoobject分页参数,上一页请求返回
order_idstring订单号,非必填,可通过订单号反查代发单

# Body.create_time_range Object Payload

代发单创建时间范围。时间范围至少填一个

参数名类型必填说明
start_timenumber秒级时间戳(距离end_time不可超过7天)
end_timenumber秒级时间戳(距离start_time不可超过7天)

# Body.page_info Object Payload

分页参数,上一页请求返回

参数名类型必填说明
offsetnumber游标,从0开始
limitnumber分页大小,<= 100

# 3. 返回参数

# 返回体 Response Payload

参数名类型说明
errcodenumber错误码
errmsgstring错误信息
ds_order_id_listarray代发单号列表
next_pageobject分页参数,下一页请求返回
totalnumber总数
has_moreboolean是否还有下一页, true:有下一页;false:已经结束,没有下一页。

# Res.next_page Object Payload

分页参数,下一页请求返回

参数名类型说明
offsetnumber游标,从0开始
limitnumber分页大小,<= 100

# 4. 注意事项

status代发单状态

枚举值 描述
100 待发货
199 部分发货
200 已发货
300 已取消

# 5. 代码示例

请求示例

{
    "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
}

# 6. 错误码

以下是本接口的错误码列表,其他错误码可参考 通用错误码

错误码错误描述解决方案
40097请求体参数不正确,请检查各个参数是否按规范填写,具体原因查看errmsg
47001请求体格式不正确,请检查请求体中各个参数的类型是否正确

# 7. 适用范围

本接口暂未明确可调用账号类型,或在业务中根据调用传参自行确定是否可调用,请已实际调用情况为准。