Order Details

5 min read

Basic Information

Debug Tool

  • Service: cps-mesh.open.orders.detail.get
  • Request Method: POST

Request Header

Header ParameterRequiredExampleNote
Content-TypeYesapplication/json

Common Parameters

Parameter NameRequiredExampleNote
app_keyYes2312521Media application AppKey How to obtain
timestampYes1596592757Timestamp in seconds
serviceYescps-mesh.open.orders.query.getAPI service name
signYes5D17CCCD5B29F98171D6D0D43136B366Signature Details

API Parameters

Parameter NameRequiredExampleNote
ads_idYesPlan ID
order_snYesOrder Number

Request Example

{
    "ads_id": "string",
    "order_sn": "string"
}

Response Parameters

NameTypeRequiredDefaultNoteAdditional Info
statusintegerOptionalStatus code
messagestringOptionalError message
dataobjectOptionalOrder return
├─ idstringOptionalOrder ID
├─ ads_idstringOptionalPlan ID
├─ ads_namestringOptionalPlan name
├─ site_idstringOptionalPromotion position ID
├─ link_idstringOptionalPromotion plan link ID
├─ euidstringOptionalFeedback tag, View explanation
├─ order_snstringOptionalOrder number
├─ parentordersnstringOptionalParent order number for some alliances, such as Alibaba, available since 2020-06-16
├─ order_timestringOptionalOrder time, format: yyyy-MM-dd HH:mm:ss
├─ orders_pricedecimal(10,2)OptionalEstimated order amount, e.g., 1.00
├─ siter_commissiondecimal(10,2)OptionalEstimated order commission, e.g., 1.00
├─ currencystringOptionalEstimated order currency: CNY (RMB), USD (Dollar)
├─ statusstringOptionalDuomai alliance settlement status: -1 Invalid, 0 Unconfirmed, 1 Confirmed, 2 Settled, View order status explanation
├─ confirm_pricedecimal(10,2)OptionalConfirmed order amount, e.g., 1.00
├─ confirmsitercommissiondecimal(10,2)OptionalConfirmed order commission, e.g., 1.00
├─ charge_currencystringOptionalConfirmed order currency: CNY (RMB), USD (Dollar)
├─ charge_timestringOptionalSettlement time, format: yyyy-MM-dd HH:mm:ss
├─ detailsobject []OptionalOrder detailsItem Type: object
├─ goods_catestringOptionalProduct category, based on actual merchant platform result
├─ goodscatenamestringOptionalProduct category name, could be a numeric identifier or textual description, based on actual merchant platform result
├─ goods_idstringOptionalProduct ID
├─ goods_namestringOptionalProduct name
├─ goods_pricestringOptionalProduct unit price, unit: Yuan. Currency: Fixed CNY (RMB)
├─ goods_tastringOptionalNumber of items
├─ orders_pricedecimal(10,2)OptionalEstimated product amount, currency consistent with the currency field, e.g., 1.00
├─ order_statusstringOptionalOriginal order status description from merchant platform, could be in English, Chinese, or numeric, based on actual result. No relation to Duomai settlement status
├─ order_commissiondecimal(10,2)OptionalEstimated product commission, currency consistent with the currency field, e.g., 1.00
├─ order_snstringOptionalOrder number
├─ parentordersnstringOptionalParent/child order number
├─ goods_imgstringOptionalProduct image URL
├─ shop_titlestringOptionalShop name
├─ dmorderstatusstringOptionalDuomai translated merchant status: -1 Unknown, 1 Pending payment, 2 Paid, 21 Processing, 3 Shipped, 31 In delivery, 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"
            }
        ]
    }
}