微信小店
取消
中文
中文
EN
取消
  • 微信小店

    • # 订单搜索

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

    接口英文名：searchorder

    该接口用于根据传递的条件搜索订单

    # 1. 调用方式

    # HTTPS 调用

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

    # 云调用

    • 调用方法：channels.ec.order.search

    • 出入参和 HTTPS 调用相同，调用方式可查看 云调用 说明文档

    # 第三方调用

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

    • 该接口所属的权限集 id 为：131

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

    # 2. 请求参数

    # 查询参数 Query String parameters

    参数名类型必填示例说明
    access_tokenstring是ACCESS_TOKEN接口调用凭证，可使用 access_token、authorizer_access_token

    # 请求体 Request Payload

    参数名类型必填说明
    search_conditionobject是搜索条件，备注：搜索条件下的参数必须至少设置一个字段，否则接口报错
    on_aftersale_order_existnumber否不传该参数：搜索全部订单； 0：搜索没有正在售后的订单； 1：搜索正在售后且售后单数量>=1的订单

    除了以下几种售后单状态（AfterSaleStatus）外其它的都是正在售后的状态： USER_CANCELD MERCHANT_REFUND_RETRY_FAIL MERCHANT_FAIL MERCHANT_REFUND_SUCCESS MERCHANT_RETURN_SUCCESS

    statusnumber否订单状态，枚举值见下文
    page_sizenumber是每页数量(不超过100)
    next_keystring是分页参数，上一页请求返回

    # Body.search_condition Object Payload

    搜索条件，备注：搜索条件下的参数必须至少设置一个字段，否则接口报错

    参数名类型必填说明
    titlestring否商品标题关键词
    sku_codestring否商品编码
    user_namestring否收件人
    tel_numberstring否收件人电话，当前字段已经废弃，请勿使用，如果原本填手机后四位，可正常使用，否则接口报错
    order_idnumber否选填，只搜一个订单时使用
    merchant_notesstring否商家备注
    customer_notesstring否买家备注
    tel_number_last4string否收件人电话后四位
    address_under_reviewboolean否申请修改地址审核中

    # 3. 返回参数

    # 返回体 Response Payload

    参数名类型说明
    errcodenumber错误码
    errmsgstring错误信息
    order_id_listarray订单号列表
    next_keystring分页参数，下一个页请求回传
    has_moreboolean是否还有下一页, true:有下一页；false:已经结束，没有下一页。

    # 4. 注意事项

    订单状态

    枚举值 描述
    10 待付款
    20 待发货（包含部分发货）
    21 部分发货
    30 待收货（包含部分发货）
    100 完成
    250 订单取消（包括未付款自动取消，售后取消等取消情况）

    # 5. 代码示例

    请求示例

    {
    "search_condition": {
        "title": "标题关键字",
        "sku_code": "12321",
        "user_name": "张三",
        "tel_number": "13700000000",
        "order_id": "3713218625342112768",
        "merchant_notes": "晚点发货",
        "customer_notes": "发顺丰"
    },
    "on_aftersale_order_exist": 0,
    "status": 20,
    "page_size": 10,
    "next_key": "THE_NEXT_KEY"
}

    返回示例

    {
    "errcode": 0,
    "errmsg": "ok",
    "orders": [
        "3715847042071365120",
        "3715847042071365121"
    ],
    "has_more": false,
    "next_key": "THE_NEXT_KEY_NEW"
}

    # 6. 错误码

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

    错误码错误描述解决方案
    40097请求体参数不正确，请检查各个参数是否按规范填写
    47001请求体格式不正确，请检查请求体中各个参数的类型是否正确
    6060456请求失败，请检查请求内是否包含不合法字符
    10080000账号发起注销，进入注销公示期
    10080001账号已注销

    # 7. 适用范围

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