ITN
Status, errorMsg, aesUid and other information will be returned when applying for ITN.
ITN Object
Attributes | Definitions |
---|---|
Status | Values are: true, false. |
ErrorMsg | If there is an error, an error message will be returned. |
aesUid | Needed when applying for cancellation of ITN. |
Create or Cancel Customs Declaration
Create or Cancel Customs Declaration
endpoint : https://ezeeship.com/api/ezeeship-openapi/customs/application
Customs declaration sample is the same as create label.
Where actionCode, einNumber and aesUnit are required.
For details, please refer to Shipment Object,ShipmentExtra Object and CustomsItem Object.
Create Customs Declaration actionCode is 'A',Cancel Customs Declaration actionCode is 'D' And you need to provide the aesUid of the creation return.
Customs declaration sample
POST : https://ezeeship.com/api/ezeeship-openapi/customs/application
{
"from": {
"personName": "Sender Name",
"company": "Sender Company",
"countryCode": "US",
"phone": "9999999999",
"stateCode": "CA",
"city": "San Francisco",
"addressLine1": "215 Clayton St.",
"addressLine2":"1092,IFC",
"zipCode": "94117"
},
"to": {
"personName": "Recipient Name",
"company": "Recipient Company",
"countryCode": "CN",
"phone": "9999999999",
"city": "Shanghai",
"addressLine1": "No.400 Cao Bao Road",
"addressLine2":"1092,IFC",
"zipCode": "200231"
},
"shipDate":"2021-03-25",
"carrierCode": "fedex",
"serviceCode": "fedex_international_economy",
"isTest": false,
"labelSize": 2,
"actionCode":"A",
"aesUid":"Cancel customs declaration need",
"extra": {
"einNumber": "your EIN/SSN",
"isStd": false,
"consigneeType":1
},
"parcels": [
{
"packageNum": 1,
"length": "1",
"width": "1",
"height": "1",
"distanceUnit": "in",
"weight": "1",
"massUnit": "lb",
"packageCode": "your_package"
}
],
"customsDeclarations": {
"contentsType": "Gift",
"eelPfc": "30.37(a)",
"items": [
{
"quantityUnit": "EA",
"quantity": "1",
"weight": "10",
"massUnit": "lb",
"valueAmount": 100,
"originCountry": "US",
"tariffNumber": "8517120050",
"description": "Mobile Phone",
"aesUnit":"NO"
}
]
}
}
Response :
{
"result": "OK",
"errorCode": null,
"message": "",
"zhMessage": null,
"errorType": null,
"data": {
"Status": true,
"ErrorMsg": null,
"aesUid": "21032402473507613"
}
}
Get ITN
Please apply for ITN and call it after 60 seconds, otherwise it may still be applied and the ITN code cannot be returned
GET : https://ezeeship.com/api/ezeeship-openapi/customs/getItn?aesUid=21032402473507613
Response :
{
"result": "OK",
"errorCode": null,
"message": "",
"zhMessage": null,
"errorType": null,
"data": {
"Status": true,
"Data": "X20210323811816"
}
}