inquiryDeclarationRequests
Use this API to inquire about the customs declaration status.
Structure
A message consists of a header and body. The following sections are focused on the body structure. For the header structure, see：
Note: Set the data type of each field (except array) as String. This means that you must use double quotation marks (" ") to enclose the field value. Examples:
- If the data type of a field is Integer and its value is 20, set it as "20".
- If the data type of a field is Boolean and its value is true, set it as "true".
Request parameters
declarationRequestIds Array<String> REQUIRED
The unique declaration request ID that is assigned by the merchant to identify a declaration request. Batch queries are supported, and up to 10 declaration request IDs are supported at a time.
More information:
- Maximum length: 32 characters
- Maximum size: 10 elements
Response parameters
result Result REQUIRED
The request result, which contains information such as status and error codes.
declarationRequestsNotFound Array<String>
The list of declaration request IDs that cannot be found in the system.
Note: This field is returned when result.resultCode is S and one or more declaration request IDs cannot be found in the system.
More information:
- Maximum length: 32 characters
- Maximum size: 10 elements
declarationRecords Array<DeclarationRecord>
The list of customs declaration records. Each record represents a customs declaration.
Note: This field is returned when result.resultCode is
S.
More information:
- Maximum size: 10 elements
Request
Response
More information
This table shows details about the customs code:
Customs name | Unified customs solution | Customs code | Alipay registration ID |
General Administration of Customs | Transmit to ZONGSHU | ZONGSHU | 31222699S7 |
Henan bonded logistics center | Transmit to ZHENGZHOU | ZHENGZHOU | 31222699S7 |
Ningbo Customs | Transmit to NINGBO | NINGBO | 31222699S7 |
Xinzheng comprehensive bonded zone (Airport) | First transmit to HENAN, then to ZONGSHU | HENAN | P460400005 |
Tianjin Customs | Transmit to ZONGSHU | ZONGSHU | 31222699S7 |
Shanghai Customs | Transmit to SHANGHAI_CBT | SHANGHAI_CBT | 31222699S7 |
Guangzhou Customs (Airport) | Transmit to Guangzhou airport national inspection. The enterprise's filing information is required. | ZONGSHU | C000010000416158 |
Guangzhou Customs (Nansha) | Transmit to Guangzhou Nansha national inspection. The enterprise's filing information is required. | ZONGSHU | C000010000416158 |
Guangzhou Customs (Huangpu) | Transmit to Guangzhou Huangpu national inspection. The enterprise's filing information is required. | ZONGSHU | C000010000416158 |
Guangzhou Customs (Shatian) | Transmit to Guangzhou Shatian national inspection. The enterprise's filing information is required. | ZONGSHU | C000010000416158 |
Hangzhou Customs | Transmit to ZONGSHU | ZONGSHU | ZF14021901 |
Result/Error codes
| Code | Value | Message | Further action |
|---|---|---|---|
| SUCCESS | S | Success | The interface is called successfully, no further action is needed. |
| ACCESS_DENIED | F | Access is denied. | Contact Antom Technical Support for detailed reasons. |
| INVALID_API | F | The called API is invalid or not active. | Contact Antom Technical Support to resolve the issue. |
| ARRAY_SIZE_EXCEEDED | F | One inquiry request only supports a maximum number of 10 declaration request IDs. | Check whether more than 10 declaration request IDs exist in the declarationRequestID field. |
| CLIENT_INVALID | F | The client ID is invalid. <span>Antom</span> has restrictions on client ID. | Check whether the client ID is correct, or contact Antom Technical Support for detailed reasons. |
| INVALID_CONTRACT | F | The parameter values in the contract do not match those in the current transaction. | Check whether the parameter values in the contract match those in the current transaction. If the values match, contact Antom Technical Support to troubleshoot the issue. |
| INVALID_SIGNATURE | F | The signature is not validated. The private key used to sign a request does not match the public key of Antom Dashboard. | Check whether the private key used to sign a request matches the public key of Antom Dashboard. The following signature references are useful:
|
| KEY_NOT_FOUND | F | The private key or public key of <span>Antom</span> or the merchant is not found. | Check whether the private key or public key exists. If not, upload the private key in Antom Dashboard. |
| MEDIA_TYPE_NOT_ACCEPTABLE | F | The server does not implement the media type that is acceptable to the client. | Check whether the media type is correct and use a media type that is accepted by Antom. |
| MERCHANT_NOT_REGISTERED | F | The merchant is not registered. | Please register the merchant by using the registration interface. Contact Antom Technical Support if failed to call the registration interface. |
| METHOD_NOT_SUPPORTED | F | The server does not implement the requested HTTP method. Only the POST method is supported. | Ensure the HTTP method is POST. |
| NO_INTERFACE_DEF | F | API is not defined. | Check whether the URL is correct. Please refer to the endpoint in the API documentation. |
| PARAM_ILLEGAL | F | The required parameters are not passed, or illegal parameters exist. For example, a non-numeric input, an invalid date, or the length and type of the parameter are wrong. | Check and verify whether the required request fields (including the header fields and body fields) of the current API are correctly passed and valid. |
| PROCESS_FAIL | F | A general business failure occurred. | Do not retry. Human intervention is usually needed. It is recommended that you contact Antom Technical Support to troubleshoot the issue. |
| RISK_REJECT | F | The request is rejected because of the risk control. | Prompt the user that the request is rejected because the risk control failed. |
| SYSTEM_ERROR | F | A system error occurred. | Do not retry, and contact Antom Technical Support for more details. |
| REQUEST_TRAFFIC_EXCEED_LIMIT | U | The request traffic exceeds the limit. | Call the API again to resolve the issue. If not resolved, contact Antom Technical Support. |
| UNKNOWN_EXCEPTION | U | An API call has failed, which is caused by unknown reasons. | Call the API again to resolve the issue. If not resolved, contact Antom Technical Support. |