Create a delivery orderSignature required
Call this API to create a delivery order.
Note: Make sure you call the uploadAttachment API and obtain the values of both the fileKey and fileName parameter in the response body and use these values when you call the createDelivery API.
Structure
Messages consist of a header and body. The following sections focus on the body structure. For the header structure, see:
Request parameters
requestId String REQUIRED
The unique ID assigned to a specific delivery request. This parameter is idempotent.
More information:
- Maximum length: 64 characters
tradeId String REQUIRED
The unique trade ID assigned by WorldTrade.
More information:
- Maximum length: 64 characters
relateProductList Array<RelateProduct> REQUIRED
The list of products associated with the delivery.
logisticsVoucherType String REQUIRED
The type of the logistics voucher. Valid values are:
LOGISTICS_BILL: Logistic documentENTRY_BILL: Customs declaration
Note:
- When the delivery origin is the Chinese mainland and the total order amount exceeds 10000 USD dollars, specify this parameter as
ENTRY_BILL.- When the delivery origin is overseas, specify this parameter as
LOGISTICS_BILL.
logisticsTrackingNo String CONDITIONAL
The tracking number.
Note:
- This parameter is returned when logisticsVoucherType is
LOGISTIC_BILL.- Length: 4 to 64 characters.
- Letters or numbers should not be repeated consecutively.
logisticsWaybillList Array<File> CONDITIONAL
The list of waybills.
- Call the uploadAttachment API and specify bizType as
WT_B2B_DELIVERY_LOGISTICS to obtain the values of fileName and fileKey parameters in the response message.- This parameter is required when logisticsVoucherType is
LOGISTICS_BILL.
fileList Array<File> CONDITIONAL
Other attachments.
- Call the uploadAttachment API and specify bizType as
WT_B2B_DELIVERY_OTHER to obtain the values of fileName and fileKey parameters in the response message.- This parameter is required as needed when logisticsVoucherType is
LOGISTICS_BILL.
carrierCode String CONDITIONAL
The carrier code. For the full list, refer to ProviderKey.
This parameter is required when logisticsVoucherType is
LOGISTIC_BILL.
More information:
- Maximum length: 32 characters
carrierName String CONDITIONAL
The carrier's name. For the full list, refer to ProviderKey.
This parameter is required when logisticsVoucherType is
LOGISTIC_BILL.
More information:
- Maximum length: 64 characters
entryOrderNo String CONDITIONAL
The customs declaration number.
Note:
- This parameter is returned when logisticsVoucherType is
ENTRY_BILL.- Length: 4 to 64 characters.
entryOrderList Array<File> CONDITIONAL
The list of customs declaration files.
- Call the uploadAttachment API and specify bizType as
WT_B2B_DELIVERY_ENTRY to obtain the values of fileName and fileKey parameters in the response message.- This parameter is required when logisticsVoucherType is
ENTRY_BILL.
superviseType String CONDITIONAL
The customs supervision mode. Valid values are:
9710: Cross border B2B export.0110: General trade B2B export.
This parameter is required when logisticsVoucherType is
ENTRY_BILL.
Response parameters
result Result REQUIRED
The result of the API call.
requestId String REQUIRED
The unique ID assigned to a specific delivery request.
More information:
- Maximum length: 64 characters
deliveryBatchId String REQUIRED
The unique ID associated with the delivery batch.
More information:
- Maximum length: 64 characters
Request
Response
Result processing logic
After calling the API, a response is returned. Possible values for result.resultStatus are:
Result status | Description |
| Indicates that the API call succeeded. |
| Indicates that the API call failed. For details, refer to result.resultCode. |
| Indicates that the API call result is unknown. If this status is returned, the Partner may implement the following query strategy:
If no queries succeed, contact our Technical Support Team. |
System-related 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. |
| OPERATION_PROHIBITED | F | The current order status does not allow operation of the shipment batch. | This order cannot be shipped. Call the queryTradeOrder API to review the order status. |
| BATCH_EXCEED_LIMIT | F | The number of delivery batches exceeds limit. | Contact the WorldTrade customer service manager for help. |
| PRODUCT_NOT_EXIST | F | The product does not exist. | Make sure that the value of the relateProductList.productId is correct and call this API again. |
| PRODUCT_TYPE_ERROR | F | The product type is incorrect. | Review the value of the parameters and call this API again. |
| INCORRECT_PRODUCT_QUANTITY | F | The product quantity is incorrect. | Correct the associated product quantity in the relateProductList.productQuantity parameter and retry with a different requestId. |
| INCORRECT_VOUCHER_TYPE | F | The voucher type is incorrect. | Choose the correct value in the logisticsVoucherType parameter and call this API again. |
| SUPERVISE_TYPE_EMPTY | F | The supervise type is empty. | Fill the superviseType parameter with a valid value and call this API again. |
| SUPERVISE_TYPE_ERROR | F | The supervise type is incorrect. | Use the correct value for the superviseType parameter and call this API again. |
| CARRIER_NAME_EMPTY | F | The carrier name is empty. | Fill the carrierName parameter with a valid value and call this API again. |
| TRACKING_NUMBER_ERROR | F | The logistics tracking number is incorrect. | Use the correct value for the logisticsTrackingNo 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. |
| USER_ERROR | F | This order does not belong to the current user. | Verify the value of the tradeId parameter and call this API again. |