# 搜索供货单

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

接口英文名:supplyorder_search

该接口用于搜索供货单

# 1. 调用方式

# HTTPS 调用

POST https://api.weixin.qq.com/channels/ec/order/supplyorder/search?access_token=ACCESS_TOKEN

# 云调用

  • 本接口不支持云调用。

# 第三方调用

# 2. 请求参数

# 查询参数 Query String Parameters

参数名类型必填示例说明
access_tokenstringACCESS_TOKEN接口调用凭证,可使用 access_token(微信小店商家)、authorizer_access_token(服务商代调用)

# 请求体 Request Payload

参数名类型必填说明
search_conditionobject搜索条件。备注:以下参数必须至少设置一个字段,否则接口报错
page_infoobject分页参数,上一页请求返回

# Body.search_condition Object Payload

搜索条件。备注:以下参数必须至少设置一个字段,否则接口报错

参数名类型必填说明
order_idnumber订单号,非必填,可根据订单号反查供货单
supplier_appidstring供货商appid
statusnumber供货单状态,具体枚举值请参考下文
create_time_rangeobject供货单创建时间范围。时间范围至少填一个
waybill_idstring运单号
order_create_time_rangeobject订单下单时间范围
product_codestring货品编码
spu_namestring货品名称
supplier_appnamestring供货商名称
merchant_notesstring商家备注
update_time_rangeobject供货单更新时间范围。时间范围至少填一个

# Body.page_info Object Payload

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

参数名类型必填说明
offsetnumber游标,从0开始
limitnumber分页大小,<= 100
next_keystring分页标识,代替offset,分页性能更优(首页传空,后续用resp返回的next_page设置)

# Body.search_condition.create_time_range Object Payload

供货单创建时间范围。时间范围至少填一个

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

# Body.search_condition.order_create_time_range Object Payload

订单下单时间范围

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

# Body.search_condition.update_time_range Object Payload

供货单更新时间范围。时间范围至少填一个

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

# 3. 返回参数

# 返回体 Response Payload

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

# 4. 注意事项

本接口无特殊注意事项

# 5. 代码示例

请求示例

{
    "search_condition": {
        "order_id": 0,
        "supplier_appid": "",
        "status": 0,
        "create_time_range": {
            "start_time": 0,
            "end_time": 0
        },
        "waybill_id": "",
        "order_create_time_range": {
            "start_time": 0,
            "end_time": 0
        },
        "product_code": "",
        "spu_name": "",
        "tel_last4": "",
        "user_name": "",
        "supplier_appname": "",
        "merchant_notes": "",
        "update_time_range": {
            "start_time": 0,
            "end_time": 0
        }
    },
    "page_info": {
        "offset": 0,
        "limit": 0,
        "next_key": ""
    }
}

返回示例

{
    "errcode": 0,
    "errmsg": "",
    "supply_order_id_list": [
        ""
    ],
    "next_page": {
        "offset": 0,
        "limit": 0,
        "next_key": ""
    },
    "total": 0,
    "has_more": false
}

# 6. 错误码

此接口没有特殊错误码,可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。

# 7. 适用范围

本接口支持「微信小店」账号类型调用。其他账号类型如无特殊说明,均不可调用。