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.contents`	confirmation type	✔	The customs type category.
`customs.non_delivery`	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_to_sender` - Return to sender. `treat_as_abandoned` - Treat as abandoned.
`customs.customs_items[]`	object[]		Describes the contents of the package for customs purposes.
`customs .customs_items[] .description`	string	✔	A description of the item. Usually required if `type` is `other`. This string will not contain newline characters.
`customs .customs_items[] .quantity`	number	✔	The quantity of items in the package.
`customs .customs_items[] .value`	object		The monetary value of each unit in the package.
`customs .customs_items[] .value .amount`	number		The amount of this value.
`customs .customs_items[] .value .currency`	string		The currency that the value represents.
`customs .customs_items[] .country_of_origin`	country code string	✔	The ISO 3166 country code for the country of origin.
`customs .customs_items[] .harmonized_tariff_code`	string	✔	The Harmonized Tariff Code for the item. This string must not contain newline characters.
`customs .customs_items[] .sku`	string	✔	The Stock Keeping Unit of this customs item. This field is completely free form.
`customs .customs_items[] .sku_description`	string	✔	The user specified SKU description of this customs item. This field is completely free form.
`customs .customs_items[] .item_weight`	weight details object	✔	The weight of a single item on this customs line.
`customs .buyer_shipping_amount_paid`	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 .buyer_shipping_amount_paid .amount`	number		The amount of this value.
`customs .buyer_shipping_amount_paid .currency`	string		The currency that the value represents.
`customs.duties_paid`	object	✔	The amount of duties paid by the shipper, if any. This is generally only necessary for DDP (bill duties to sender) shipments.
`customs.duties_paid.value`	number		The amount of this value.
`customs .duties_paid .currency`	string		The currency that the value represents.