Skip to content

Latest commit

 

History

History
37 lines (34 loc) · 61.8 KB

CustomsDeclaration.md

File metadata and controls

37 lines (34 loc) · 61.8 KB

CustomsDeclaration

Fields

Field Type Required Description Example
aesItn ?string ➖ required if eel_pfc is AES_ITN

AES / ITN reference of the shipment.
b13aFilingOption ?string ➖ 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
b13aNumber ?string ➖ 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 ?string ➖ Certificate reference of the shipment.
certify bool ✔️ Expresses that the certify_signer has provided all information of this customs declaration truthfully. true
certifySigner string ✔️ Name of the person who created the customs declaration and is responsible for the validity of all
information provided.		 Shawn Ippotle
commercialInvoice ?bool ➖ N/A
contentsExplanation ?string ➖ required if contents_type is OTHER

Explanation of the type of goods of the shipment.		 T-Shirt purchase
disclaimer ?string ➖ Disclaimer for the shipment and customs information that have been provided.
exporterIdentification ?\Shippo\API\Models\Components\CustomsExporterIdentification ➖ Additional exporter identification that may be required to ship in certain countries
exporterReference ?string ➖ Exporter reference of an export shipment.
importerReference ?string ➖ Importer reference of an import shipment.
isVatCollected ?bool ➖ Indicates whether the shipment's destination VAT has been collected. May be required for some destinations.
invoice ?string ➖ Invoice reference of the shipment. #123123
license ?string ➖ License reference of the shipment.
metadata ?string ➖ 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
notes ?string ➖ Additional notes to be included in the customs declaration.
addressImporter ?string ➖ Object ID of the Importer address. 257ba08436604d2aaf069caafe7acb2a
contentsType string ✔️ Type of goods of the shipment.
Allowed values available here		 MERCHANDISE
eelPfc ?string ➖ 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
incoterm ?string ➖ 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 and DPD UK.
If expecting DAP for other carriers, please use DDU.
Allowed values available here		 DDP
invoicedCharges ?\Shippo\API\Models\Components\CustomsInvoicedCharges ➖ Additional invoiced charges to be shown on the Customs Declaration Commercial Invoice.
items array<string> ✔️ Distinct Parcel content items as Customs Items object_ids. [
"5087f181d1dc4b14b73fdbf636498886"
]
nonDeliveryOption string ✔️ Indicates how the carrier should proceed in case the shipment can't be delivered.
Allowed values available here		 RETURN
objectCreated \DateTime ➖ Date and time of object creation. 2014-07-17T01:01:08.306Z
objectId ?string ➖ Unique identifier of the given object. e2197a54da9d470480f4f8796cc419cb
objectOwner ?string ➖ Username of the user who created the object. [email protected]
objectState ?\Shippo\API\Models\Components\ObjectStateEnum ➖ Indicates the validity of the enclosing object
objectUpdated \DateTime ➖ Date and time of last object update. 2014-07-17T01:01:08.306Z
test ?bool ➖ Indicates whether the object has been created in test mode. true