Customs Object

A customs object is used to represent customs information for international shipments.

Properties

This table lists the properties of a customs object and identifies those properties that are required. The nullable column indicates which properties may be null when the object is provided as an argument to one of your methods, and the required column indicates which properties are required when the object is returned from one of your methods.

Name	Type	Nullable?	Description
`customs`	object		Customs declarations for this package.
`customs.nonDeliveryOption`	string	✔	Indicates what should be done if the package cannot be delivered. If `undefined`, the default behavior of the receiving country's customs department applies, which may incur charges. Valid values include the following: `return` - Return to sender. `abandon` - Treat as abandoned.
`customs.contents`	object[]		Describes the contents of the package for customs purposes. Note that Customs contents may not correspond one-to-one with the package contents. Package contents usually include one item per unique merchandise SKU e.g. one red t-shirt and one blue t-shirt), whereas customs contents are often grouped by product type (e.g. two t-shirts). In addition, some package contents don't need to be declared for customs purposes.
`customs.contents[].type`	string		The customs type category. Valid values include the following: `gift` - The package contains a gift `documents` - The package contains documents. `merchandise` - The package contains merchandise. `returned_goods` - The package is a returned shipment. `commercial_sample` - The package contains a commercial sample, such as a flooring sample. `humanitarian_donation` - The package contains a donation. `other` - The package contains items that fall outside the other categories.
`customs.contents[].sku`	string		The Stock Keeping Unit. This string will not contain newline characters.
`customs .contents[] .description`	string		A description of the item. Usually required if `type` is `other`. This string will not contain newline characters.
`customs .contents[] .quantity`	object		The quantity of items in the package.
`customs .contents[] .quantity .value`	number		The value of the quantity. The minimum value is `1`.
`customs .contents[] .unitValue`	object		The monetary value of each unit in the package.
`customs .contents[] .unitValue .value`	number		The amount of this value.
`customs .contents[] .unitValue .currency`	string		The currency that the value represents.
`customs .contents[] .countryOfOrigin`	country code string	✔	The ISO 3166 country code for the country of origin. This is usually the same as `countryOfManufacture`, but some countries distinguish between the two for certain products.
`customs .contents[] .countryOfManufacture`	country code string	✔	The ISO 3166 country code for the country where the item was manufactured.
`customs .contents[] .harmonizedTariffCode`	string		The Harmonized Tariff Code for the item. This string must not contain newline characters.
`customs .buyerShippingAmountPaid`	object	✔	Indicates how much the buyer paid for shipping, if any. This amount may be different than the shipping cost billed to the shipper.
`customs .buyerShippingAmountPaid .value`	number		The amount of this value.
`customs .buyerShippingAmountPaid .currency`	string		The currency that the value represents.
`customs.dutiesPaid`	object	✔	The amount of duties paid by the shipper, if any. This is generally only necessary for DDP (bill duties to sender) shipments.
`customs.dutiesPaid.value`	number		The amount of this value.
`customs .dutiesPaid .currency`	string		The currency that the value represents.