Publisher Integration
API Reference
Order Details

Basic Information


  • Request Method: POST

Request Header

Header ParameterRequiredExampleDescription

Common Parameters

Parameter NameRequiredExampleDescription
AppKeyYes2312521Website application AppKey
TimestampYes1596592757Second-level timestamp service name

Interface Parameters

Parameter NameRequiredExampleDescription
ProgramIdYesProgram ID
OrderSnYesOrder number

Request Example

    "ProgramId": "string",
    "OrderSn": "string"

Response Parameters

NameTypeRequiredDefault ValueDescriptionOther Information
StatusintegerOptionalStatus Code
MessagestringOptionalError message
DataobjectOptionalOrder return
├─ IdstringOptionalOrder ID
├─ ProgramIdstringOptionalProgram ID
├─ ProgramNamestringOptionalProgram Name
├─ WebsiteIdstringOptionalPromotion ID
├─ LinkIdstringOptionalPromotion Program Link ID
├─ SubIdstringOptionalFeedback label,
├─ OrderSnstringOptionalOrder number
├─ ParentOrderSnstringOptionalParent order numbers
├─ OrderTimestringOptionalOrder placement time, format: yyyy-MM-dd HH:mm:ss
├─ OrdersPricedecimal(10,2)OptionalEstimated order amount, example: 1.00
├─ SiterCommissiondecimal(10,2)OptionalEstimated order commission, example: 1.00
├─ CurrencystringOptionalEstimated order currency: CNY Chinese Yuan USD US Dollar
├─ StatusstringOptional Alliance settlement status: -1 Invalid 0 Unconfirmed 1 Confirmed 2 Settled,
├─ ConfirmPricedecimal(10,2)OptionalConfirmed order amount, 1.00
├─ ConfirmSiterCommissiondecimal(10,2)OptionalConfirmed order commission, example: 1.00
├─ ChargeCurrencystringOptionalConfirmed order currency: CNY Chinese Yuan USD US Dollar
├─ ChargeTimestringOptionalSettlement time, format: yyyy-MM-dd HH:mm:ss
├─ Detailsobject []OptionalOrder details

item type: object

├─ GoodsCatestringOptionalProduct category, subject to actual merchant platform results
├─ ItemCateNamestringOptionalProduct category name, may be a digital identifier, text description, subject to actual merchant platform results
├─ ItemIdstringOptionalProduct number
├─ ItemNamestringOptionalProduct name
├─ ItemPricestringOptionalProduct unit price, unit: yuan. Currency: fixed CNY Chinese Yuan
├─ ItemCountstringOptionalNumber of product items
├─ OrdersPricedecimal(10,2)OptionalEstimated product amount, currency: consistent with the currency field, example: 1.00
├─ OrderStatusstringOptionalOriginal order status description on the merchant platform, may be in English, Chinese, numbers, etc., subject to actual results. No corresponding relationship with Alliance settlement status
├─ OrderCommissiondecimal(10,2)OptionalEstimated product commission, currency: consistent with the currency field, example: 1.00
├─ OrderSnstringOptionalOrder number
├─ ParentOrderSnstringOptionalParent order number/child order number
├─ ItemImgstringOptionalProduct image address
├─ ShopTitlestringOptionalShop name
├─ LbOrderStatusstringOptional translated merchant status: -1 Unknown, 1 To be paid, 2 Paid, 21 In progress, 3 Shipped, 31 In delivery, 32 Rejected, 4 Received, 41 Settling, 5 Settled, 6 Invalid, 7 Completed, 8 In dispute, 81 Dispute resolved, 82 Dispute failed, 9 Refund, 10 Return, 11 System locked;

Response Example

    "Status": 0,
    "Message": "string",
    "Data": {
        "Id": "string",
        "ProgramId": "string",
        "ProgramName": "string",
        "WebsiteId": "string",
        "LinkId": "string",
        "SubId": "string",
        "OrderSn": "string",
        "ParentOrderSn": "string",
        "OrderTime": "string",
        "OrdersPrice": null,
        "SiterCommission": null,
        "Currency": "string",
        "Status": "string",
        "ConfirmPrice": null,
        "ConfirmSiterCommission": null,
        "ChargeCurrency": "string",
        "ChargeTime": "string",
        "Details": [
                "ItemCate": "string",
                "ItemCateName": "string",
                "ItemId": "string",
                "ItemName": "string",
                "ItemPrice": "string",
                "ItemCount": "string",
                "OrdersPrice": null,
                "OrderStatus": "string",
                "OrderCommission": null,
                "OrderSn": "string",
                "ParentOrderSn": "string",
                "ItemImg": "string",
                "ShopTitle": "string",
                "LbOrderStatus": "string"