Order Details - Depal Open API Doc

Request

Path Params

appKey

string

required

Header Params

Authorization

string

optional

Default:

Example:

x-depal-timestamp

string

required

timestamp when calling the service, milliseconds

x-depal-access-token

string

required

retrieve from "system.token.get"

x-depal-signature

string

required

sign the request data, refer to the signature document

Body Params application/json

orderId

string

optional

Order Number

includeFields

string

optional

orderItemList,feeList

Example

{
    "orderId": "string",
    "includeFields": "string"
}

Responses

🟢200OK

application/json

Body

code

string

optional

Status Code

msg

string

optional

INFORMATION

data

object (OrderDetailResultEn)

optional

Data

orderId

string

optional

Order Number

outOrderId

string

optional

External Order Number

status

string

optional

Order Status

cancelType

string

optional

Cancel Order Type

cancelMemo

string

optional

Cancel Order Instructions

createTime

string

optional

Creation time

updateTime

string

optional

Modification time

payTime

string

optional

First payment time

productTotalAmount

string

optional

Total commodity amount CNY yuan 2.48

freightTotalAmount

string

optional

Total freight amount CNY yuan 2.48

serviceTotalAmount

string

optional

Service fee total CNY yuan 2.48

orderItemList

array[object (CargoItemResultEn) {7}]

optional

Purchased goods, sku, breakdown, quantity, unit price, total price

feeList

array[object (FeeItemEn) {9}]

optional

Expense Details

logisticsList

array[object (LogisticsItemEn) {5}]

optional

Logistics Details

requestId

string

optional

Request ID for easy issue tracking

Example

{
    "code": "",
    "msg": "",
    "data": {
        "orderId": "",
        "outOrderId": "",
        "status": "",
        "cancelType": "",
        "cancelMemo": "",
        "createTime": "",
        "updateTime": "",
        "payTime": "",
        "productTotalAmount": "",
        "freightTotalAmount": "",
        "serviceTotalAmount": "",
        "orderItemList": [
            {
                "productId": 0,
                "skuId": "",
                "quantity": 0,
                "price": "",
                "amount": "",
                "productName": "",
                "skuAttributeNames": [
                    ""
                ]
            }
        ],
        "feeList": [
            {
                "id": "",
                "code": "",
                "createTime": "",
                "amount": "",
                "currency": "",
                "rate": "",
                "memo": "",
                "isPayed": false,
                "payTime": ""
            }
        ],
        "logisticsList": [
            {
                "deliveredDate": "",
                "goodsInfo": "",
                "goodsInfoNames": "",
                "channelCode": "",
                "logisticNo": ""
            }
        ]
    },
    "requestId": ""
}