Query the trade orderSignature required
Call this API to query the trade order.
Structure
Messages consist of a header and body. The following sections focus on the body structure. For the header structure, see:
Request parameters
tradeId String REQUIRED
The unique trade ID assigned by WorldTrade.
Obtain the value of this parameter by calling the createTradeOrder API.
More information:
- Maximum length: 64 characters
Response parameters
result Result REQUIRED
The result of the API call.
orderBasicInfo OrderBasicInfo REQUIRED
The detailed order information.
This parameter is returned on demand only when result.resultStatus = S.
productList Array<Product> REQUIRED
The product information.
This parameter is returned on demand only when result.resultStatus = S.
sellerInfo Participant REQUIRED
The seller information.
This parameter is returned on demand only when result.resultStatus = S.
buyerInfo Participant REQUIRED
The buyer information.
This parameter is returned on demand only when result.resultStatus = S.
paymentTerm PaymentTerm REQUIRED
The payment terms.
This parameter is returned on demand only when result.resultStatus = S.
paymentResultList Array<PaymentResult> REQUIRED
The payment results.
shippingTerm ShippingTerm REQUIRED
The shipping terms.
This parameter is returned on demand only when result.resultStatus = S.
deliveryBatchList Array<DeliveryBatch> REQUIRED
The delivery information.
This parameter is returned when both of the following conditions are met:
- result.resultStatus =
S- orderBasicInfo.deliveryStatus =
DELIVERING, DELIVERY_FAIL, DELIVERED or RECEIPT_CONFIRMED
Request
Response
Result processing logic
After calling the API, a response is returned. Possible values for result.resultStatus are:
System-realted result codes
| Code | Value | Message | Further action |
|---|---|---|---|
| SUCCESS | S | Success | |
| PROCESS_FAIL | F | A general business failure occurred. Do Not retry. | Human intervention is usually needed. It is recommended that you contact our Technical Support Team to resolve the issue. |
| PARAM_ILLEGAL | F | Illegal parameters exist. For example, a non-numeric input, or an invalid date. | Check and verify whether the request fields, including the header fields and body fields, are correct and valid. For details on the fields of each API, see the specific API Structure section. |
| INVALID_SIGNATURE | F | The signature is invalid. | Make sure the request is properly signed with a valid signature. |
| REPEAT_REQ_INCONSISTENT | F | Repeated requests are inconsistent. | Ensure all the fields in the requests are the same and try again. |
| UNKNOWN_EXCEPTION | U | API failed due to unknown reason. | The service might be down, retry later. If the issue persists, contact our Technical Support Team. |
| FILE_SIZE_EXCEED_LIMIT | F | The file size has exceeded the limit. | Limit the file size to the allowable range. |
| CONTRACT_CHECK_FAIL | F | The contract check has failed. | Contact our Technical Support Team to check the status of your API contract. Make sure it is still valid and try again. |
Business-related result codes
| Code | Value | Message | Further action |
|---|---|---|---|
| SYSTEM_EXCEPTION | F | System exception. | Contact the WorldTrade customer service manager for help. |
| PARAM_ILLEGAL | F | Illegal parameters exist. For example, a non-numeric input, or an invalid date. | Make sure that the values of the parameters are correct and retry. |
| USER_ERROR | F | This order does not belong to the current user. | Verify the value of the tradeId parameter and call this API again. |
| ORDER_NOT_EXIST | F | The order does not exist. | Verify the value of the tradeId parameter and call this API again. |