Create a trade orderSignature required

2025-02-13 01:44

POST /amsin/api/v1/business/worldtrade/createTradeOrder

Call this API to create a 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

requestId String REQUIRED

The unique ID that identifies the request to create a trade order.

More information:

Maximum length: 64 characters

totalAmount Amount REQUIRED

The total amount of the trade order.

More information:

Value range: 0 - 1000000000 USD

Show child parameters

orderProductType String REQUIRED

The type of the trade order.

Valid value is:

PRODUCT_INFO: a trade order with product information.

productList Array<Product> REQUIRED

The product information.

Show child parameters

sellerInfo Participant REQUIRED

The seller information.

Show child parameters

buyerInfo Participant REQUIRED

The buyer information.

Show child parameters

paymentTerm PaymentTerm REQUIRED

The payment terms.

Show child parameters

shippingTerm ShippingTerm REQUIRED

The shipping terms.

Show child parameters

payResultNotifyUrl String REQUIRED

The callback URL specified by the Partner to receive payment results.

orderResultNotifyUrl String REQUIRED

The callback URL specified by the Partner to receive order results.

deliveryResultNotifyUrl String REQUIRED

The callback URL specified by the Partner to receive delivery results.

memo String

The order memo.

Special characters NOT supported are: : and /

Response parameters

result Result REQUIRED

The result of the API call.

Show child parameters

tradeId String REQUIRED

The unique trade ID assigned by WorldTrade.

This field is returned as needed only when result.resultStatus = S.

More information:

Maximum length: 64 characters

orderLink String REQUIRED

The order link returned to the buyer.

This field is returned as needed only when result.resultStatus = S.

orderPaymentLink String REQUIRED

The order payment link returned to the buyer.

This field is returned as needed only when result.resultStatus = S.

API Explorer

Request

URL

Request Body

Response

Response Body

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_INFO_ERROR	F	The user information is incorrect.	Make sure that the seller and buyer's information is correct and call this API again.
WRONG_DELIVERY_ORIGIN	F	The delivery origin value is incorrect.	Make sure that the value of the shippingTerm.deliveryOrigin parameter is correct and call this API again.
ORDER_REJECTED	F	The order is rejected due to security concerns.	Contact the WorldTrade customer service manager for help.
AMOUNT_ERROR	F	Incorrect order amount.	Make sure that the order amount is correct and try calling this API again.
EMAIL_ERROR	F	The seller's email and buyer's email cannot be identical.	Use different email addresses for the seller and the buyer. Then, try calling this API again.
UNSUPPORTED_BUYER_EMAIL	F	The buyer's email is not supported.	Contact the WorldTrade customer service manager for help.
REPEATED_REQUEST	F	Repeated request.	This is an idempotent API that does not need to be called again. If necessary, use a different requestId to initiate another call.
FILE_NOT_EXIST	F	The file does not exist.	Use the correct file and call this API again.
DELIVERY_COUNTRY_ERROR	F	The country of shipment is wrong	Make sure that the delivery information is correct and call this API again.
SELLER_COUNTRY_ERROR	F	The seller's country is wrong	Make sure that the value of the sellerInfo.companyAddress.countryCode parameter is correct and call this API again.

Result status	Description
`S`	Indicates that the API call succeeded.
`F`	Indicates that the API call failed. For details, refer to result.resultCode.
`U`	Indicates that the API call result is unknown. If this status is returned, the Partner may implement the following query strategy: Maximum 7 queries are allowed. Intervals between queries: 5 min, 10 min, 20 min, 40 min, 80 min, 160 min, and 320 min. If no queries succeed, contact our Technical Support Team.