Order List – Linkbest

Basic Information

SERVICE_NAME: linkbest.open-service.orders.query.get
Request Method: POST

Request Header

Header Parameter	Required	Example	Description
Content-Type	Yes	application/json

Common Parameters

Parameter Name	Required	Example	Description
AppKey	Yes	2312521	Website application AppKey
Timestamp	Yes	1596592757	Second-level timestamp
Service	Yes	linkbest.open-Service.orders.query.get	Interface service name
Sign	Yes	5D17CCCD5B29F98171D6D0D43136B366	Signature

Interface Parameters

Parameter Name	Required	Description
WebsiteId	No	Website ID
ProgramId	No	Plan ID
SubId	No	Feedback label
Stime	Yes	Start time, in seconds timestamp, note: the time span cannot exceed 1 day
Etime	Yes	End time, in seconds timestamp, note: the time span cannot exceed 1 day
OrderField	No	Time dimension: UpdateTime: update time, ChargeTime: settlement time, OrderDatatime: creation time, default: UpdateTime
Status	No	Query orders with settlement status in Linkbest Union. Optional values: -1 invalid, 0 unconfirmed, 1 confirmed, 2 settled
Page	No	Page number, default: 1
PageSize	No	Page size, default: 20, maximum: 200

Request Example

{
    "WebsiteId": "string",
    "ProgramId": "string",
    "SubId": "string",
    "Stime": "string",
    "Etime": "string",
    "OrderField": "string",
    "Status": "string",
    "Page": "string",
    "PageSize": "string"
}

Response Parameters

Name	Type	Required	Description	Other Information
Status	integer	Optional	Status Code
Message	string	Optional	Error message
Data	object	Optional	Order response
├─ Id	string	Optional	Order ID
├─ ProgramId	string	Optional	Plan ID
├─ ProgramName	string	Optional	Plan name
├─ WebsiteId	string	Optional	Promotion position ID
├─ LinkId	string	Optional	Promotion plan link ID
├─ SubId	string	Optional	Feedback label
├─ OrderSn	string	Optional	Order number
├─ ParentOrderSn	string	Optional	Parent order numbers
├─ OrderTime	string	Optional	Order creation time, format: yyyy-MM-dd HH:mm:ss
├─ OrdersPrice	decimal(10,2)	Optional	Estimated order amount, e.g., 1.00
├─ SiterCommission	decimal(10,2)	Optional	Estimated order commission, e.g., 1.00
├─ Currency	string	Optional	Estimated order currency: CNY Chinese Yuan, USD US Dollar
├─ Status	string	Optional	Settlement status of Linkbest Union: -1 invalid, 0 unconfirmed, 1 confirmed, 2 settled,
├─ ConfirmPrice	decimal(10,2)	Optional	Confirmed order amount, 1.00
├─ ConfirmSiterCommission	decimal(10,2)	Optional	Confirmed order commission, e.g., 1.00
├─ ChargeCurrency	string	Optional	Confirmed order currency: CNY Chinese Yuan, USD US Dollar
├─ ChargeTime	string	Optional	Settlement time, format: yyyy-MM-dd HH:mm:ss
├─ Details	object []	Optional	Order details	item type: object
├─ ItemCate	string	Optional	Product category, subject to actual merchant platform results
├─ ItemCateName	string	Optional	Product category name, may be a numeric identifier or text description, subject to actual merchant platform results
├─ ItemId	string	Optional	Product ID
├─ ItemName	string	Optional	Product name
├─ ItemPrice	string	Optional	Product unit price, unit: yuan. Currency: fixed to CNY Chinese Yuan
├─ ItemCount	string	Optional	Number of product items
├─ OrdersPrice	decimal(10,2)	Optional	Estimated product amount, currency: consistent with the currency field, e.g., 1.00
├─ OrderStatus	string	Optional	Original order status description on the merchant platform, may be in English, Chinese, numerical value, etc., subject to actual results. No corresponding relationship with the settlement status of Linkbest Union
├─ OrderCommission	decimal(10,2)	Optional	Estimated product commission, currency: consistent with the currency field, e.g., 1.00
├─ OrderSn	string	Optional	Order number
├─ ParentOrderSn	string	Optional	Parent order number/child order number
├─ ItemImg	string	Optional	Product image address
├─ ShopTitle	string	Required	Store name
├─ LbOrderStatus	string	Optional	Translated merchant status by Linkbest Union: -1 unknown, 1 pending payment, 2 paid, 21 processing, 3 shipped, 31 in transit, 32 rejected, 4 received, 41 settlement in progress, 5 settled, 6 invalid, 7 completed, 8 in dispute, 81 dispute resolved, 82 dispute failed, 9 refunded, 10 returned, 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",
        "Pagination":{
            "Page":1,
            "PageSize":20,
            "Total":0
        },
        "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"
            }
        ]
    }]
}

Get Promotion Links Order Details