The Order Status API is a crucial functionality of the TD system aimed at ensuring the accuracy and timeliness of retrieving order information.
Through the Order Status API, we are able to accurately identify more cunning fraudsters who cleverly use normal identities and behaviors to evade detection at critical business checkpoints, thereby deceiving the system. Relying solely on individual business behaviors often proves difficult in revealing the true intentions of fraudsters.
Additionally, the application of the Order Status API enhances our ability to accurately identify occasional abnormal behaviors of legitimate users, thus reducing false positive rates and improving order conversion rates. We perform seamless data reporting on users at regular business checkpoints and make decisions at critical business checkpoints. This design helps minimize user interference and enhances user experience.
Through the Order Status API, we ensure that the TD system consistently receives the latest order information, thereby enhancing system security and reliability.
API Format
Base URL
- China:https://cn-event.apitd.net/order/v3
- America:https://us-event.apitd.net/order/v3
- Singapore:https://sg-event.apitd.net/order/v3
- Germany:https://de-event.apitd.net/order/v3
API
URL | Request Methods | Content-Type | Output Format | Character Set |
---|---|---|---|---|
api-base-url?partner_code=xxx&partner_key=xxx | POST | application/json | JSON | UTF-8 |
example: https://sg-event.apitd.net/order/v3?partner_code=test_code&partner_key=test_key
Authentication
Parameter | Type | Description | Required/Optional | Notes |
---|---|---|---|---|
partner_code | String | Partner Code | required | assigned by TD |
partner_key | String | Partner Key | required | assigned by TD |
Request
A complete request parameter typically consists of two parts:
- Basic Parameter: These fields contain fundamental information related to the request itself, aiming to ensure the validity and security of the request.
- Event Parameter: These fields are related to the order status, such as order_payment, order_ship, and other events. Through these fields, we can pass data related to specific events, such as payment information, shipment details, and so on.
By combining the basic fields and event fields, a complete set of request parameters is formed. This design allows us to effectively transmit and process event data related to the account status, ensuring the accuracy and security of account information.
Basic Parameter
Parameter | Type | Description | Required/Optional | Notes |
---|---|---|---|---|
channel | String | Channel Identifier | required | assigned by TD |
session_id | String | Session ID | required | The session ID is a unique identifier assigned by the website server to a specific user during the visit, which is usually stored in the form of a cookie, form parameter, or URL |
account_id | String | Account ID | conditionally required: required when account registration/creation is finished | not required when the account doesn't exist |
event_time | String | The Actual Time of the Event | required | ISO 8601, format YYYY-MM-DDTHH:mm:ss.sssZ, example: 2021-10-12T14:20:50.521+07:00 |
event_type | String | Event Type | required | enumeration: order_modify order_cancel order_payment order_payment_result order_ship order_confirm order_return order_refund order_chargeback |
terminal | Terminal | Device Information | required | |
ext | Ext | Extended Field | optional | extended field registered in the TD system |
Event Parameter
Our API design restricts each request to only involve data related to a single event. This means that you cannot simultaneously initiate multiple different event data requests, such as order_ship and order_confirm.
To ensure data accuracy and system reliability, we recommend that you send separate requests for each event, considering the independence of each event. By handling each event separately, we can better manage and track the data processing process, avoiding confusion and conflicts.
Adhering to this rule will help improve system performance and reliability, ensuring that each event is correctly processed. If you need to handle multiple different events simultaneously, we suggest sending separate requests for each event to ensure data integrity and consistency.
Event | Event Type | Required/Optional |
---|---|---|
OrderModify | order_modify | optional (strongly recommended) |
OrderCancel | order_cancel | optional (strongly recommended) |
OrderPayment | order_payment | optional (strongly recommended), but if payment information have already been passed through the verification API, they should be ignored |
OrderPaymentResult | order_payment_result | optional (strongly recommended), but if payment result information have already been passed through the verification API, they should be ignored |
OrderShip | order_ship | optional (strongly recommended) |
OrderConfirm | order_confirm | optional (strongly recommended) |
OrderReturn | order_return | optional (strongly recommended) |
OrderRefund | order_refund | optional (strongly recommended) |
OrderChargeback | order_chargeback | optional (strongly recommended) |
Request Example
Let's take the example of a order_ship event.
{
"channel": "test",
"session_id": "abc0123456789",
"account_id": "123456789",
"event_time": "2021-10-12T14:20:50.521+07:00",
"event_type": "order_ship",
"terminal": {
"black_box": "aGPH1658920283672ropYaFxT7",
"ip": "210.20.10.33"
},
"ext": {
"ext_book_id": "LFOUHOFHOHFNOUH",
"ext_book_num": 10
},
"order_id": "NX348566DIHD",
"logistics": {
"logistics_type": "Standard Shipping",
"cost": {
"currency": "USD",
"amount_local": 68,
"amount_usd": 10,
"amount_cny": 68
},
"logistics_company": "SF"
}
}
Response Parameter
Parameter | Type | Description | Required/Optional | Notes |
---|---|---|---|---|
code | Integer | API Status Code | required | |
message | String | Status Message | required | specific abnormal reasons will be provided when the API is abnormal |
sequence_id | String | Unique ID of Response | required | A unique ID used to track each request |
API Status Code
code | Description |
---|---|
200 | Success |
9001 | {Parameter} empty |
9002 | {Parameter} check error |
9003 | {Parameter} length or size exceeds 1024 |
9004 | Either black_box or ip exists |
9200 | System error |
9201 | Unknown error |
9202 | Illegal Content-Type |
Response Example
{
"code": 200,
"message": "",
"sequence_id": "1648777165770866F82AC7F326307055"
}