Overview
Shippo API
Addresses API v2
curl https://api.goshippo.com/customs/declarations/ \
-H "Authorization: ShippoToken " \
-H "Content-Type: application/json" \
-d '{
"contents_type": "MERCHANDISE",
"non_delivery_option": "RETURN",
"certify": true,
"certify_signer": "Simon Kreuz",
"incoterm": "DDU",
"items": [{
"description": "T-shirt",
"quantity": 20,
"net_weight": "5",
"mass_unit": "lb",
"value_amount": "200",
"value_currency": "USD",
"tariff_number": "",
"origin_country": "US"
}]
}'{
"certify": true,
"certify_signer": "Shawn Ippotle",
"contents_type": "MERCHANDISE",
"items": [
"5087f181d1dc4b14b73fdbf636498886"
],
"non_delivery_option": "RETURN",
"aes_itn": "<string>",
"b13a_filing_option": "FILED_ELECTRONICALLY",
"b13a_number": "<string>",
"certificate": "<string>",
"commercial_invoice": true,
"contents_explanation": "T-Shirt purchase",
"disclaimer": "<string>",
"duties_payor": {
"account": "2323434543",
"type": "THIRD_PARTY",
"address": {
"name": "Patrick Kavanagh",
"zip": "80331",
"country": "DE"
}
},
"exporter_identification": {
"eori_number": "PL123456790ABCDE",
"tax_id": {
"number": "123456789",
"type": "EIN"
}
},
"exporter_reference": "<string>",
"importer_reference": "<string>",
"is_vat_collected": true,
"invoice": "#123123",
"license": "<string>",
"metadata": "Order ID #123123",
"notes": "<string>",
"address_importer": "257ba08436604d2aaf069caafe7acb2a",
"eel_pfc": "NOEEI_30_37_a",
"incoterm": "DDP",
"invoiced_charges": {
"currency": "<string>",
"total_shipping": "<string>",
"total_taxes": "<string>",
"total_duties": "<string>",
"other_fees": "<string>"
},
"object_created": "2014-07-17T01:01:08.306Z",
"object_id": "e2197a54da9d470480f4f8796cc419cb",
"object_owner": "shippotle@shippo.com",
"object_state": "VALID",
"object_updated": "2014-07-17T01:01:08.306Z",
"test": true
}Create a new customs declaration
Creates a new customs declaration object
curl https://api.goshippo.com/customs/declarations/ \
-H "Authorization: ShippoToken " \
-H "Content-Type: application/json" \
-d '{
"contents_type": "MERCHANDISE",
"non_delivery_option": "RETURN",
"certify": true,
"certify_signer": "Simon Kreuz",
"incoterm": "DDU",
"items": [{
"description": "T-shirt",
"quantity": 20,
"net_weight": "5",
"mass_unit": "lb",
"value_amount": "200",
"value_currency": "USD",
"tariff_number": "",
"origin_country": "US"
}]
}'{
"certify": true,
"certify_signer": "Shawn Ippotle",
"contents_type": "MERCHANDISE",
"items": [
"5087f181d1dc4b14b73fdbf636498886"
],
"non_delivery_option": "RETURN",
"aes_itn": "<string>",
"b13a_filing_option": "FILED_ELECTRONICALLY",
"b13a_number": "<string>",
"certificate": "<string>",
"commercial_invoice": true,
"contents_explanation": "T-Shirt purchase",
"disclaimer": "<string>",
"duties_payor": {
"account": "2323434543",
"type": "THIRD_PARTY",
"address": {
"name": "Patrick Kavanagh",
"zip": "80331",
"country": "DE"
}
},
"exporter_identification": {
"eori_number": "PL123456790ABCDE",
"tax_id": {
"number": "123456789",
"type": "EIN"
}
},
"exporter_reference": "<string>",
"importer_reference": "<string>",
"is_vat_collected": true,
"invoice": "#123123",
"license": "<string>",
"metadata": "Order ID #123123",
"notes": "<string>",
"address_importer": "257ba08436604d2aaf069caafe7acb2a",
"eel_pfc": "NOEEI_30_37_a",
"incoterm": "DDP",
"invoiced_charges": {
"currency": "<string>",
"total_shipping": "<string>",
"total_taxes": "<string>",
"total_duties": "<string>",
"other_fees": "<string>"
},
"object_created": "2014-07-17T01:01:08.306Z",
"object_id": "e2197a54da9d470480f4f8796cc419cb",
"object_owner": "shippotle@shippo.com",
"object_state": "VALID",
"object_updated": "2014-07-17T01:01:08.306Z",
"test": true
}Authorizations
API key authentication using the ShippoToken scheme. Format: Authorization: ShippoToken <API_TOKEN> Example: Authorization: ShippoToken shippo_live_abc123
Headers
Optional string used to pick a non-default API version to use. See our API version guide.
"2018-02-08"
Body
CustomsDeclaration details.
Expresses that the certify_signer has provided all information of this customs declaration truthfully.
true
Name of the person who created the customs declaration and is responsible for the validity of all information provided.
"Shawn Ippotle"
Show child attributes
Show child attributes
required if eel_pfc is AES_ITN
AES / ITN reference of the shipment.
B13A Option details are obtained by filing a B13A Canada Export Declaration via the Canadian Export Reporting System (CERS). More information on reporting commercial exports from Canada. Allowed values available here
FILED_ELECTRONICALLY, SUMMARY_REPORTING, NOT_REQUIRED "FILED_ELECTRONICALLY"
must be provided if and only if b13a_filing_option is provided
Represents:
the Proof of Report (POR) Number when b13a_filing_option is FILED_ELECTRONICALLY;
the Summary ID Number when b13a_filing_option is SUMMARY_REPORTING;
or the Exemption Number when b13a_filing_option is NOT_REQUIRED.
Certificate reference of the shipment.
required if contents_type is OTHER
Explanation of the type of goods of the shipment.
"T-Shirt purchase"
Disclaimer for the shipment and customs information that have been provided.
Carrier-Specific Constraints:
| Carrier | Constraints |
|---|---|
| FedEx | Max 554 characters |
1000Specifies who will pay the duties for the shipment. Only accepted for FedEx shipments.
Show child attributes
Show child attributes
Additional exporter identification that may be required to ship in certain countries
Show child attributes
Show child attributes
Exporter reference of an export shipment.
Importer reference of an import shipment.
Indicates whether the shipment's destination VAT has been collected. May be required for some destinations.
Invoice reference of the shipment.
15"#123123"
License reference of the shipment.
A string of up to 100 characters that can be filled with any additional information you want to attach to the object.
"Order ID #123123"
Additional notes to be included in the customs declaration.
Object that represents the address of the importer
Show child attributes
Show child attributes
EEL / PFC type of the shipment. For most shipments from the US to CA, NOEEI_30_36 is applicable; for most
other shipments from the US, NOEEI_30_37_a is applicable.
Allowed values available here
NOEEI_30_37_a, NOEEI_30_37_h, NOEEI_30_37_f, NOEEI_30_36, AES_ITN "NOEEI_30_37_a"
The incoterm reference of the shipment. FCA is available for DHL Express and FedEx only. eDAP is available for DPD UK only. DAP is available for DHL Express, FedEx, and DPD UK. If expecting DAP for other carriers, please use DDU. Allowed values available here Carrier-specific restrictions are in the table below.
Carrier-Specific Constraints:
| Carrier | Constraints |
|---|---|
| FedEx | Must be one of DDP, DDU, FCA, DAP |
DDP, DDU, FCA, DAP, eDAP "DDP"
true
Response
Customs declaration
Expresses that the certify_signer has provided all information of this customs declaration truthfully.
true
Name of the person who created the customs declaration and is responsible for the validity of all information provided.
"Shawn Ippotle"
Distinct Parcel content items as Customs Items object_ids.
["5087f181d1dc4b14b73fdbf636498886"]required if eel_pfc is AES_ITN
AES / ITN reference of the shipment.
B13A Option details are obtained by filing a B13A Canada Export Declaration via the Canadian Export Reporting System (CERS). More information on reporting commercial exports from Canada. Allowed values available here
"FILED_ELECTRONICALLY"
must be provided if and only if b13a_filing_option is provided
Represents:
the Proof of Report (POR) Number when b13a_filing_option is FILED_ELECTRONICALLY;
the Summary ID Number when b13a_filing_option is SUMMARY_REPORTING;
or the Exemption Number when b13a_filing_option is NOT_REQUIRED.
Certificate reference of the shipment.
required if contents_type is OTHER
Explanation of the type of goods of the shipment.
"T-Shirt purchase"
Disclaimer for the shipment and customs information that have been provided.
Carrier-Specific Constraints:
| Carrier | Constraints |
|---|---|
| FedEx | Max 554 characters |
1000Specifies who will pay the duties for the shipment. Only accepted for FedEx shipments.
Show child attributes
Show child attributes
Additional exporter identification that may be required to ship in certain countries
Show child attributes
Show child attributes
Exporter reference of an export shipment.
Importer reference of an import shipment.
Indicates whether the shipment's destination VAT has been collected. May be required for some destinations.
Invoice reference of the shipment.
15"#123123"
License reference of the shipment.
A string of up to 100 characters that can be filled with any additional information you want to attach to the object.
"Order ID #123123"
Additional notes to be included in the customs declaration.
Object ID of the Importer address.
"257ba08436604d2aaf069caafe7acb2a"
The incoterm reference of the shipment. FCA is available for DHL Express and FedEx only. eDAP is available for DPD UK only. DAP is available for DHL Express, FedEx, and DPD UK. If expecting DAP for other carriers, please use DDU. Allowed values available here Carrier-specific restrictions are in the table below.
Carrier-Specific Constraints:
| Carrier | Constraints |
|---|---|
| FedEx | Must be one of DDP, DDU, FCA, DAP |
"DDP"
Additional invoiced charges to be shown on the Customs Declaration Commercial Invoice.
Show child attributes
Show child attributes
Date and time of object creation.
"2014-07-17T01:01:08.306Z"
Unique identifier of the given object.
"e2197a54da9d470480f4f8796cc419cb"
Username of the user who created the object.
"shippotle@shippo.com"
Indicates the validity of the enclosing object
VALID, INVALID Date and time of last object update.
"2014-07-17T01:01:08.306Z"
Indicates whether the object has been created in test mode.
true
Was this page helpful?