Skip to content

Latest commit

 

History

History
31 lines (28 loc) · 40.7 KB

CustomsDeclarationCreateRequest.md

File metadata and controls

31 lines (28 loc) · 40.7 KB

CustomsDeclarationCreateRequest

Fields

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

AES / ITN reference of the shipment.
b13aFilingOption ?\Shippo\API\Models\Components\CustomsDeclarationB13AFilingOptionEnum ➖ N/A 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 ?\Shippo\API\Models\Components\AddressImporter ➖ Object that represents the address of the importer
contentsType \Shippo\API\Models\Components\CustomsDeclarationContentsTypeEnum ✔️ N/A MERCHANDISE
eelPfc ?\Shippo\API\Models\Components\CustomsDeclarationEelPfcEnum ➖ N/A NOEEI_30_37_a
incoterm ?\Shippo\API\Models\Components\CustomsDeclarationIncotermEnum ➖ N/A DDP
items array<\Shippo\API\Models\Components\CustomsItemCreateRequest> ✔️ N/A
nonDeliveryOption \Shippo\API\Models\Components\CustomsDeclarationNonDeliveryOptionEnum ✔️ N/A RETURN
test ?bool ➖ N/A true