# 订单搜索
# 接口说明
该接口用于根据传递的条件搜索订单
# 接口调用请求说明
POST https://api.weixin.qq.com/channels/ec/order/search?access_token=ACCESS_TOKEN
# 请求参数说明
参数 | 类型 | 是否必填 | 描述 |
---|---|---|---|
search_condition | object SearchCondition | 是 | 搜索条件,具体结构请参考SearchCondition结构体 |
on_aftersale_order_exist | number | 否 | 不传该参数:搜索全部订单; 0:搜索没有正在售后的订单; 1:搜索正在售后且售后单数量>=1的订单 除了以下几种售后单状态(AfterSaleStatus)外其它的都是正在售后的状态: USER_CANCELD MERCHANT_REFUND_RETRY_FAIL MERCHANT_FAIL MERCHANT_REFUND_SUCCESS MERCHANT_RETURN_SUCCESS |
status | number | 否 | 订单状态,枚举值见RequestOrderStatus |
next_key | string | 是 | 分页参数,上一页请求返回 |
page_size | number | 是 | 每页数量(不超过100) |
# 请求参数示例
{
"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 | string | 错误码 |
errmsg | string | 错误信息 |
order_id_list | array string | 订单号列表 |
next_key | string | 分页参数,下一个页请求回传 |
has_more | bool | 是否还有下一页, true:有下一页;false:已经结束,没有下一页。 |
# 返回参数示例
{
"errcode": 0,
"errmsg": "ok",
"orders": [
"3715847042071365120",
"3715847042071365121"
],
"has_more": false,
"next_key": "THE_NEXT_KEY_NEW"
}
# 错误码
错误码 | 错误信息 |
---|---|
公共错误码 | - |
47001 | 请求体格式不正确,请检查请求体中各个参数的类型是否正确 |
40097 | 请求体参数不正确,请检查各个参数是否按规范填写 |
10080000 | 账号发起注销,进入注销公示期 |
10080001 | 账号已注销 |
6060456 | 请求失败,请检查请求内是否包含不合法字符 |
# 结构体
# SearchCondition
搜索条件
备注:以下参数必须至少设置一个字段,否则接口报错
参数 | 类型 | 是否必填 | 描述 |
---|---|---|---|
title | string | 否 | 商品标题关键词 |
sku_code | string | 否 | 商品编码 |
user_name | string | 否 | 收件人 |
string | 否 | 收件人电话,当前字段已经废弃,请勿使用,如果原本填手机后四位,可正常使用,否则接口报错 | |
tel_number_last4 | string | 否 | 收件人电话后四位 |
order_id | string | 否 | 选填,只搜一个订单时使用 |
merchant_notes | string | 否 | 商家备注 |
customer_notes | string | 否 | 买家备注 |
address_under_review | bool | 否 | 申请修改地址审核中 |
# 枚举值
# RequestOrderStatus
订单状态
枚举值 | 描述 |
---|---|
10 | 待付款 |
20 | 待发货(包含部分发货) |
21 | 部分发货 |
30 | 待收货(包含部分发货) |
100 | 完成 |
250 | 订单取消(包括未付款自动取消,售后取消等取消情况) |