v1

latestOpenAPI 3.1.02026-07-1270243932.3 KB

Customs Declarations

Retrieve a customs declaration

Returns an existing customs declaration using an object ID

get/customs/declarations/{CustomsDeclarationId}

Path parameters

CustomsDeclarationIdstring required

Object ID of the customs declaration

Query parameters

pageinteger

The page number you want to select

Headers

SHIPPO-API-VERSIONstring

Example:2018-02-08

Optional string used to pick a non-default API version to use. See our <a href="https://docs.goshippo.com/docs/api_concepts/apiversioning/">API version</a> guide.

Response

Customs declaration

aes_itnstring

required if eel_pfc is AES_ITN AES / ITN reference of the shipment.

b13a_filing_optionstring

B13A Option details are obtained by filing a B13A Canada Export Declaration via the Canadian Export Reporting System (CERS). <a href="https://www.cbsa-asfc.gc.ca/services/export/guide-eng.html" target="_blank" rel="noopener noreferrer"> More information on reporting commercial exports from Canada. </a> Allowed values available <a href="/shippoapi/public-api/customs-declaration-b13a-filing-option">here</a>

b13a_numberstring

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.

certificatestring

Certificate reference of the shipment.

certifyboolean required

Expresses that the certify_signer has provided all information of this customs declaration truthfully.

certify_signerstring required

Name of the person who created the customs declaration and is responsible for the validity of all information provided.

commercial_invoiceboolean

contents_explanationstring

required if contents_type is OTHER Explanation of the type of goods of the shipment.

disclaimerstring

Disclaimer for the shipment and customs information that have been provided.

Carrier-Specific Constraints:

Carrier	Constraints
FedEx	Max 554 characters

exporter_referencestring

Exporter reference of an export shipment.

importer_referencestring

Importer reference of an import shipment.

is_vat_collectedboolean

Indicates whether the shipment's destination VAT has been collected. May be required for some destinations.

invoicestring

Invoice reference of the shipment.

licensestring

License reference of the shipment.

metadatastring

A string of up to 100 characters that can be filled with any additional information you want to attach to the object.

notesstring

Additional notes to be included in the customs declaration.

address_importerstring

Object ID of the Importer address.

contents_typestring required

Type of goods of the shipment.
Allowed values available <a href="/shippoapi/public-api/customs-declaration-contents-type">here</a>

eel_pfcstring

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 <a href="/shippoapi/public-api/customs-declaration-eelpfc">here</a>

incotermstring

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 <a href="/shippoapi/public-api/customs-declaration-incoterm">here</a> Carrier-specific restrictions are in the table below.

Carrier-Specific Constraints:

Carrier	Constraints
FedEx	Must be one of DDP, DDU, FCA, DAP

itemsstring[] required

Distinct Parcel content items as Customs Items object_ids.

non_delivery_optionstring required

Indicates how the carrier should proceed in case the shipment can't be delivered. Allowed values available <a href="/shippoapi/public-api/customs-declaration-non-delivery-option">here</a>

object_createdstring date-time

Date and time of object creation.

object_idstring

Unique identifier of the given object.

object_ownerstring

Username of the user who created the object.

object_state'VALID' | 'INVALID'

Indicates the validity of the enclosing object

object_updatedstring date-time

Date and time of last object update.

testboolean

Indicates whether the object has been created in test mode.

Example response

{
  "b13a_filing_option": "FILED_ELECTRONICALLY",
  "certify": true,
  "certify_signer": "Shawn Ippotle",
  "contents_explanation": "T-Shirt purchase",
  "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"
    }
  },
  "invoice": "#123123",
  "metadata": "Order ID #123123",
  "address_importer": "257ba08436604d2aaf069caafe7acb2a",
  "contents_type": "MERCHANDISE",
  "eel_pfc": "NOEEI_30_37_a",
  "incoterm": "DDP",
  "items": [
    "5087f181d1dc4b14b73fdbf636498886"
  ],
  "non_delivery_option": "RETURN",
  "object_created": "2014-07-17T01:01:08.306Z",
  "object_id": "e2197a54da9d470480f4f8796cc419cb",
  "object_owner": "shippotle@shippo.com",
  "object_updated": "2014-07-17T01:01:08.306Z",
  "test": true
}