获取订单
开发环境
开发环境
GET
/v1.3/ecommerce_order/get
请求参数
| 名称 | 类型 | 描述 |
|---|---|---|
| account_id* | integer | 广告主帐号 id，对订单有所有权的直客帐号或子客帐号 |
| filtering | struct[] | 过滤条件，若此字段不传，或传空则视为无限制条件，详见 [过滤条件] 数组最小长度 1，最大长度 2 |
| field* | string | 过滤字段 可选值：{ ecommerce_order_id, ecommerce_order_status } |
| operator* | enum | 操作符 当 field 取值 ecommerce_order_id 时，枚举列表：{ EQUALS, IN } 当 field 取值 ecommerce_order_status 时，枚举列表：{ EQUALS, IN } |
| values* | string[] | 字段取值，values 数组的个数限制与 operator 的取值相关，详见 [过滤条件] 当 field 取值 ecommerce_order_id 时， 字段长度最大 120 字节 当 field 取值 ecommerce_order_id 且 operator 取值 IN 时， 字段长度最大 120 字节 当 field 取值 ecommerce_order_status 时， 枚举列表：{ AWAITING_ORDER, SHIPPING_SOON, SHIPPED, DELIVERED, RETURNED } 当 field 取值 ecommerce_order_status 且 operator 取值 IN 时， 枚举列表：{ AWAITING_ORDER, SHIPPING_SOON, SHIPPED, DELIVERED, RETURNED } |
| date_range* | struct | 日期范围，最多支持查询 90 天内的数据查询 |
| start_date* | string | 开始日期，日期格式：YYYY-MM-DD 字段长度为 10 字节 |
| end_date* | string | 结束日期，日期格式：YYYY-MM-DD 字段长度为 10 字节 |
| page | integer | 页数，默认值：1 |
| page_size | integer | 分页大小，默认值：20 |
请求示例 请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET '/v1.3/ecommerce_order/get' \
--header 'access_token;' \
--header 'timestamp;' \
--header 'nonce;' \
--header 'fields;' \
--data-urlencode 'account_id=111111111' \
--data-urlencode 'filtering=[{"field":"ecommerce_order_id","operator":"EQUALS","values":["B503186974486037"]},{"field":"ecommerce_order_status","operator":"IN","values":["SHIPPED","DELIVERED"]}]' \
--data-urlencode 'date_range={"start_date":"2017-09-10","end_date":"2017-10-10"}' \
--data-urlencode 'page=1' \
--data-urlencode 'page_size=20'响应示例响应示例
{
"code": 0,
"message": "",
"message_cn": "",
"data": {
"list": [
{
"adgroup_id": "123345",
"adgroup_name": "微信广告",
"from_account_id": "123456",
"ecommerce_order_id": "B503186974486037",
"quantity": 1,
"price": 9900,
"total_price": 9900,
"user_name": "张三",
"user_phone": "13800138000",
"user_province": "黑龙江省",
"user_city": "大庆市",
"user_area": "肇源县",
"user_address": "黑龙江省大庆市肇源县阿瓦尔瓦尔",
"user_ip": "10.41.79.52",
"ecommerce_order_time": "2018-05-03 11:38:17",
"user_message": "",
"account_id": "123456",
"ecommerce_order_status": "DELIVERED",
"customized_page_name": "营销组件-商品购物页",
"destination_url": "http://ec.flzhan.cn/?r_id=134545034_7223c337c&pagetype=SINGLE&_bid=2759",
"commodity_package_detail": "营销组件-商品购物页;产品一:蓝色,34;",
"delivery_spec": {
"delivery_tracking_number": "123456",
"express_company": "ZTO",
"delivery_info_list": [
{
"delivery_update_time": "2019-06-28 10:40:17",
"delivery_detail": "货物已由本人签收，感谢您选择 xxx 物流！"
},
{
"delivery_update_time": "2019-06-28 08:40:34",
"delivery_detail": "配送员开始配送，请您准备收货，配送员，xxx，手机号，xxx"
},
{
"delivery_update_time": "2019-06-28 07:59:18",
"delivery_detail": "货物已分配，等待配送"
},
{
"delivery_update_time": "2019-06-28 07:59:17",
"delivery_detail": "货物已到达【北京角门营业部】"
},
{
"delivery_update_time": "2019-06-28 02:46:30",
"delivery_detail": "货物已完成分拣，离开【北京通州分拣中心】"
},
{
"delivery_update_time": "2019-06-27 23:31:28",
"delivery_detail": "货物已到达【北京通州分拣中心】"
},
{
"delivery_update_time": "2019-06-26 17:37:31",
"delivery_detail": "货物已完成分拣，离开【武汉外单分拣中心】"
},
{
"delivery_update_time": "2019-06-25 22:12:30",
"delivery_detail": "货物已完成分拣，离开【揭阳分拨中心】"
},
{
"delivery_update_time": "2019-06-24 19:27:29",
"delivery_detail": "货物已交付 xxx 物流"
},
{
"delivery_update_time": "2019-06-24 19:27:29",
"delivery_detail": "配送员 xxx 已经揽收完成"
}
]
}
},
{
"adgroup_id": "123345",
"adgroup_name": "微信朋友圈",
"from_account_id": "123456",
"ecommerce_order_id": "B503190359103349",
"quantity": 1,
"price": 9900,
"total_price": 9900,
"user_name": "李四",
"user_phone": "13800138000",
"user_province": "河北省",
"user_city": "承德市",
"user_area": "平泉县",
"user_address": "河北省承德市平泉县温热污染",
"user_ip": null,
"ecommerce_order_time": "2018-05-03 11:43:55",
"user_message": "",
"account_id": "20345",
"ecommerce_order_status": "AWAITING_ORDER",
"customized_page_name": "营销组件-商品购物页",
"destination_url": "https://0d493661.fyeds5.com/?r_id=134545195_f3fe56c3a&pagetype=SINGLE&_bid=2759",
"commodity_package_detail": "营销组件-商品购物页;产品一:蓝色,34;",
"delivery_spec": []
}
],
"page_info": {
"page": 1,
"page_size": 20,
"total_number": 2,
"total_page": 1
}
}
}请求参数
Header 参数
access_token
string
必需
默认值:
<ACCESS_TOKEN>
timestamp
string
必需
MarketingAPI 所使用的时间戳，若无特殊说明，均为秒级时间戳
MarketingAPI 所使用的时区为GMT+8，例如当时间戳为1494840119时，表示 2018-05-15 17:21:59
默认值:
<TIMESTAMP>
nonce
string
必需
默认值:
<NONCE>
fields
string
必需
Body 参数application/x-www-form-urlencoded
account_id
integer
必需
示例值:
111111111
filtering
string
可选
数组最小长度 1，最大长度 2
示例值:
[{"field":"ecommerce_order_id","operator":"EQUALS","values":["B503186974486037"]},{"field":"ecommerce_order_status","operator":"IN","values":["SHIPPED","DELIVERED"]}]
date_range
string
必需
示例值:
{"start_date":"2017-09-10","end_date":"2017-10-10"}
page
integer
页数，默认值：1
示例值:
1
page_size
integer
可选
示例值:
20
返回响应
修改于 2023-11-07 08:29:37