Order List
Basic Information
- Service: cps-mesh.open.orders.query.get
- Request Method: POST
Request Header
| Header Parameter | Required | Example | Note |
|---|---|---|---|
| Content-Type | Yes | application/json |
Common Parameters
| Parameter Name | Required | Example | Note |
|---|---|---|---|
| app_key | Yes | 2312521 | Media application AppKey How to obtain |
| timestamp | Yes | 1596592757 | Timestamp in seconds |
| service | Yes | cps-mesh.open.orders.query.get | API service name |
| sign | Yes | 5D17CCCD5B29F98171D6D0D43136B366 | Signature Details |
Interface Parameters
| Parameter Name | Required | Example | Note |
|---|---|---|---|
| site_id | No | Promotion ID | |
| ads_id | No | Plan ID | |
| euid | No | Feedback tag, View explanation | |
| stime | Yes | Start time, timestamp in seconds, note: time span cannot exceed 1 day | |
| etime | Yes | End time, timestamp in seconds, note: time span cannot exceed 1 day | |
| order_field | No | Time dimension updatetime: update time chargedatetime: settlement time orderdatetime: creation time Default is updatetime | |
| status | No | Query orders with settlement status in Duomai Alliance. Options: -1 Invalid 0 Unconfirmed 1 Confirmed 2 Settled View order status explanation | |
| page | No | Page number Default is 1 | |
| page_size | No | Page size Default is 20 Maximum is 200 |
Request Example
{
"site_id": "string",
"ads_id": "string",
"euid": "string",
"stime": "string",
"etime": "string",
"order_field": "string",
"status": "string",
"page": "string",
"page_size": "string"
}Response Parameters
| Name | Type | Required | Default | Note | Additional Info |
|---|---|---|---|---|---|
| status | integer | No | Status code | ||
| message | string | No | Error message | ||
| data | object | No | Order return | ||
| ├─ id | string | No | Order ID | ||
| ├─ ads_id | string | No | Plan ID | ||
| ├─ ads_name | string | No | Plan name | ||
| ├─ site_id | string | No | Promotion ID | ||
| ├─ link_id | string | No | Promotion plan link ID | ||
| ├─ euid | string | No | Feedback tag, View explanation | ||
| ├─ order_sn | string | No | Order number | ||
| ├─ parentordersn | string | No | Parent order number for some alliances, e.g., Alibaba Mama, available since 2020-06-16 | ||
| ├─ order_time | string | No | Order time, format: yyyy-MM-dd HH:mm:ss | ||
| ├─ orders_price | decimal(10,2) | No | Estimated order amount, e.g., 1.00 | ||
| ├─ siter_commission | decimal(10,2) | No | Estimated order commission, e.g., 1.00 | ||
| ├─ currency | string | No | Estimated order currency: CNY (RMB), USD (Dollar) | ||
| ├─ status | string | No | Duomai Alliance settlement status: -1 Invalid, 0 Unconfirmed, 1 Confirmed, 2 Settled, View order status explanation | ||
| ├─ confirm_price | decimal(10,2) | No | Confirmed order amount, e.g., 1.00 | ||
| ├─ confirmsitercommission | decimal(10,2) | No | Confirmed order commission, e.g., 1.00 | ||
| ├─ charge_currency | string | No | Confirmed order currency: CNY (RMB), USD (Dollar) | ||
| ├─ charge_time | string | No | Settlement time, format: yyyy-MM-dd HH:mm:ss | ||
| ├─ details | object [] | No | Order details | Item Type: object | |
| ├─ goods_cate | string | No | Product category, based on actual merchant platform result | ||
| ├─ goodscatename | string | No | Product category name, could be a number identifier or text description, based on actual merchant platform result | ||
| ├─ goods_id | string | No | Product ID | ||
| ├─ goods_name | string | No | Product name | ||
| ├─ goods_price | string | No | Product unit price, unit: yuan. Currency: fixed CNY (RMB) | ||
| ├─ goods_ta | string | No | Number of products | ||
| ├─ orders_price | decimal(10,2) | No | Estimated product amount, currency matches the currency field, e.g., 1.00 | ||
| ├─ order_status | string | No | Original order status description from the merchant platform, could be English, Chinese, or numeric, based on actual result. No corresponding relationship with Duomai Alliance settlement status | ||
| ├─ order_commission | decimal(10,2) | No | Estimated product commission, currency matches the currency field, e.g., 1.00 | ||
| ├─ order_sn | string | No | Order number | ||
| ├─ parentordersn | string | No | Parent order number/child order number | ||
| ├─ goods_img | string | No | Product image URL | ||
| ├─ shop_title | string | Yes | Shop name | ||
| ├─ dmorderstatus | string | No | Duomai translated merchant status: -1 Unknown, 1 Pending payment, 2 Paid, 21 Processing, 3 Shipped, 31 In transit, 32 Rejected, 4 Received, 41 Settling, 5 Settled, 6 Invalid, 7 Completed, 8 In dispute, 81 Dispute successful, 82 Dispute failed, 9 Refunded, 10 Returned, 11 System locked; View merchant status explanation |
Response Example
{
"status": 0,
"message": "string",
"data": {
"id": "string",
"ads_id": "string",
"ads_name": "string",
"site_id": "string",
"link_id": "string",
"euid": "string",
"order_sn": "string",
"parent_order_sn": "string",
"order_time": "string",
"orders_price": null,
"siter_commission": null,
"currency": "string",
"status": "string",
"confirm_price": null,
"confirm_siter_commission": null,
"charge_currency": "string",
"charge_time": "string",
"details": [
{
"goods_cate": "string",
"goods_cate_name": "string",
"goods_id": "string",
"goods_name": "string",
"goods_price": "string",
"goods_ta": "string",
"orders_price": null,
"order_status": "string",
"order_commission": null,
"order_sn": "string",
"parent_order_sn": "string",
"goods_img": "string",
"shop_title": "string",
"dm_order_status": "string"
}
]
}
}