Upload attachmentsSignature required
Call this API to upload the required attachments.
Structure
Messages consist of a header and body. The following sections focus on the body structure. For the header structure, see:
Request parameters
bizType String REQUIRED
The business type of the attachment. Valid values are:
WT_B2B_TRADE_PRODUCT: Product image.WT_B2B_DELIVERY_LOGISTICS: Logistics document.WT_B2B_DELIVERY_OTHER: Other document such as consignment agreement, cargo reconciliation sheet, logistics damage certification sheet, online transaction contract, payment receipt, online store transfer receipt, procurement negotiation record, etc.WT_B2B_DELIVERY_ENTRY: Customs declaration form.
Note:
- When you need to create a trade order by calling the createTradeOrder API, specify this parameter as:
WT_B2B_TRADE_PRODUCT- When you need to create a delivery order by calling the creatDelivery API, specify this parameter as one of the following:
WT_B2B_DELIVERY_LOGISTICS,WT_B2B_DELIVERY_OTHER,WT_B2B_DELIVERY_ENTRY
fileName String REQUIRED
The original file name of the attachment. For example, file.pdf.
More information:
- Maximum length: 128 characters
attachmentContent String REQUIRED
The content of the attachment.
Note:
- Maximum attachment size: 10 MB.
- Supported formats: PNG, JPG, JPEG, PDF.
- Must be Base64 encoded.
- Please note that you need to remove the unnecessary prefixes (data:[MIME type];base64) from a Base64-encoded string, e.g., data:image/png;base64.
More information:
- Maximum length: 9786710 characters
Response parameters
result Result REQUIRED
The result of the API call.
fileName String REQUIRED
The original file name of the attachment. For example, file.pdf.
This parameter is returned on demand only when result.resultStatus = S.
More information:
- Maximum length: 128 characters
fileKey String REQUIRED
The key value of the attachment.
This parameter is returned on demand only when result.resultStatus = S.
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:
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. |
| UNSUPPORTED_FILE_TYPE | F | The file type is not supported. | Call this API again by using the correct file type. |
| FILE_SIZE_ERROR | F | The file size has exceeded the limit. | Make sure that the file size is within the limit and call this API again. |
| FILE_NAME_ERROR | F | The file name is not supported. | Modify the file name and call this API again. |