Attributes
| Field | Notes |
|---|---|
id STRING | The unique identifier for the object. The id for the Landed Cost object will always be prefixed with ldct. |
amount_subtotal HASH | Landed cost total. If using for an ecommerce checkout, we recommend using these totals to display to the end user. These totals allow for an easier integration without the need to sum duties, taxes or fees by item and shipment level. Additional details are available in the landed cost object.See child attributes below. |
amount_subtotal.duties DECIMAL | Sum of all the duties in the duties array. Includes duties as levied on items, shipping, or any additional duties applied to the import. To understand how duties are calculated, see the import duty doc. |
amount_subtotal.fees DECIMAL | Sum of the various fees in the fees array. Includes the clearance fees, country import fees, or other fees applied to the import. To understand more about import fees, see the import fees doc. |
amount_subtotal.taxes DECIMAL | Sum of all the taxes in the taxes array. Includes taxes as applied to items, duty, shipping or fees. To understand more about import taxes, see the import taxes doc. |
currency HASH | Hash providing information on the base currency sent in the request and other currencies with the exchange rate used at the time of the response. This is useful if you want to convert to the import country currency or to other currencies used in the landed cost calculation.See child attributes below. |
currency.id STRING | The unique identifier for the currency object. |
currency.base STRING | The base currency as sent in the landed cost request, represented by a three-letter ISO code. All amounts in the landed cost object are listed in the base currency. |
currency.date TIMESTAMP | The date in which the currency rate was pulled, in the ISO 8601 format: YYYY-MM-DDTHH:mm:ss.sssZ |
currency.rates HASH | Hash containing the currencies and exchange rates needed for conversion from the base currency. |
currency.rates.currency STRING | An exchange rate currency used in the landed cost calculation. |
currency.rates.rate DECIMAL | The exchange rate at the time of the landed cost request for the specified currency. |
customs HASH | Hash containing information used determine the landed cost as well as information needed for customs documentation and customs clearance. See child attributes below. |
customs.delivery_duty_paid STRING | The ability to bill duties and taxes to someone other than the receiver (DDP - delivery duty paid) varies by shipping carrier, shipping service, or destination country.Possible values are available, unavailable, and unknown.If the landed cost is used for an ecommerce checkout, you should only allow the shopper to pay duties and taxes if the result is available.If the result is unknown, you may either present the shopper with an estimated amount of duty and tax they will have to pay upon delivery or you may not want to display the duty and tax at all for that carrier service level.If the result is unavailable, your account has been configured in the Zonos Dashboard to not allow DDP, even though it is an allowed service by the selected carrier. |
customs.items LIST | The list of items sent in the request.See child attributes below. |
customs.items.id STRING | The unique identifier sent in the request. |
customs.items.amount DECIMAL | The item amount in the base currency. This is the amount sent in the request for this item. |
customs.items.country_of_origin STRING | The country of manufacture where the item or article was produced. Represented by a two-letter ISO code. See the import duty doc to understand how the country of origin impacts the landed cost calculation. |
customs.items.country_of_origin_source STRING | The source of the country of origin. Possible values are zonos_catalog, api_request, and account_default platform. |
customs.items.description_customs STRING | The suggested description of goods for the commercial invoice. This description will usually differ from a retail description and will typically include a general description of what it is, what it is made from, and what it is used for. |
customs.items.description_retail STRING | The retail description of the item. |
customs.items.detail STRING | Additional features, attributes, or descriptions of the item. |
customs.items.dimensions LIST | The size of the shipment. hash |
customs.items.dimensions.height DECIMAL | The height of the item. |
customs.items.dimensions.length DECIMAL | The length of the item. |
customs.items.dimensions.unit STRING | The unit of measurement for the item dimensions.Possible values are inch, centimeter, millimeter, and null.When null, inch will be used. |
customs.items.dimensions.width DECIMAL | The width of the item. |
customs.items.hs_code STRING | The harmonized tariff code used to determine the tariff rate in the landed cost calculation. |
customs.items.hs_code_source STRING | The source of the harmonized tariff code used, which can be set by Zonos.Possible values are zonos_catalog, api_request, zonos_classified, account_default, and hs_correction. |
customs.items.image_url STRING | The image URL. |
customs.items.note STRING | Additional details on the item clearance or HS code, if applicable.An example for India is As per India's import guidelines for personal shipments, your HS code was corrected to 9804.90.00. |
customs.items.quantity INTEGER | The quantity of the item as sent in the request. |
customs.items.upc_code STRING | The UPC code of the item. |
customs.items.weight DECIMAL | The weight of the item. |
customs.items.weight_unit STRING | The unit of measurement for the weight. Possible values are pound, ounce, kilogram, and null.When null, pound will be used. |
customs.ship_to_country STRING | The import country where duties and taxes are applied. |
customs.shipping_amount DECIMAL | The shipping amount that should be listed on the customs documentation. |
de_minimis HASH | Information about the country-specific threshold that determines when duties and taxes apply. The currency rates array will contain the conversion rate used to determine if the import was above or below duty and tax thresholds. See child attributes below. |
de_minimis.formula STRING | The formula used to calculate the de minimis threshold eligibility. |
de_minimis.method STRING | This is the method of calculation, such as cif, cifd, cifdt, fob, or fobd. |
de_minimis.note STRING | Additional details on the de minimis, such as providing information if an item was not eligible for de minimis consideration, like wine. |
de_minimis.threshold STRING | Whether or not the tax is under or over the tax threshold. Possible values include above or below. |
de_minimis.type STRING | The de minimis applied to type. Possible values include tax and duty. |
duties HASH | An array of duties applied to the import. The sum of the duty amounts are equal to the amount_subtotal.duties.See child attributes below. |
duties.amount DECIMAL | The amount of duty on the item, shipping, or fee. |
duties.description STRING | Varying descriptions of the duty such as duty, anti_dumping_duty, and more. |
duties.formula STRING | The formula used to calculate the duty amount. For duty, this is typically the tariff for the import country and could be ad valorem or a specific duty rate. |
duties.item_id STRING | The unique identifier sent in the request. The id is only provided when the type is item. |
duties.note STRING | Additional details on the duty, including free trade agreements, reduced duty rates, anti-dumping duties, and more. |
duties.type STRING | The duty is applied to the type.Possible values include item, shipping, and fee. |
fees HASH | An array of fees applied to the import. The sum of the fee amounts are equal to the amount_subtotal.fees.See child attributes below. |
fees.amount DECIMAL | The fee amount applied to the item, shipping, duty, service level, carrier, or country. This amount is in the base currency and may have been converted from the import country’s respective currency to the base currency sent in the request. |
fees.description STRING | Varying descriptions of the duty such as UPS Disbursement Fee, FedEx Advancement Fee, and An Post Clearance Fee. |
fees.formula STRING | The formula used to calculate the fee. For fees, this is typically a flat amount, a percentage of the duties and taxes, or another formula. |
fees.item_id STRING | Your unique identifier sent in the landed cost request. The id is only provided when the type is item. |
fees.note STRING | Additional details on the fee, if needed. |
fees.type STRING | The fee is applied to the type.Possible values include advancement, additional_tariff_lines, ddp_service_fee, brokerage, cod, country, and other. |
messages HASH | A list of non-critical messages, e.g. “The shipping amount in the request was null, this could impact the calculation.” |
messages.message STRING | A helpful message related to your Landed Cost request and what non-critical information was missing. |
messages.type STRING | The message type.Possible values include price_adjustment, default_value_used, shipping_missing, and item_weight_missing |
remittance HASH | An array containing the amount and details of what needs to be remitted to a specific country (e.g. Australia, New Zealand, Norway, or United Kingdom). |
remittance.amount DECIMAL | The amount of money that needs to be remitted to a specific country. |
remittance.description STRING | A description of what the remittance is for (e.g. UK VAT). |
remittance.note STRING | A note about how the tax should be remitted (e.g. remit to HMRC quarterly). |
removed_items LIST | The list of items removed from the request for the landed cost calculation. ItemsSee child attributes below. |
removed_items.id STRING | The unique identifier sent in the request. |
removed_items.amount DECIMAL | The item amount in the base currency. This is the amount sent in the request for this item. |
removed_items.country_of_origin STRING | The country of manufacture where the item or article was produced. Represented by a two-letter ISO code. See the import duty doc to understand how the country of origin impacts the landed cost calculation. |
removed_items.country_or_origin_source STRING | The source of the country of origin. Possible values are zonos_catalog, api_request, and account_default platform. |
removed_items.description_customs STRING | The suggested description of goods for the commercial invoice. This description will usually differ from a retail description and will typically include a general description of what it is, what it is made from, and what it is used for. |
removed_items.description_retail STRING | The retail description of the item. |
removed_items.hs_code STRING | The harmonized tariff code used to determine the tariff rate in the landed cost calculation. |
removed_items.hs_code_source STRING | The source of the harmonized tariff code used, which can be set by Zonos.Possible values are zonos_catalog, api_request, platform, zonos_classified, account_default, and hs_correction. |
removed_items.note STRING | Additional details on the item clearance or HS code, if applicable.An example for India is As per India's import guidelines for personal shipments, your HS code was corrected to 9804.90.00. |
removed_items.quantity INTEGER | The quantity of the item as sent in the request. |
taxes HASH | An array of taxes applied to the import. The sum of the tax amounts are equal to the amount_subtotal.taxes. See child attributes below. |
taxes.amount DECIMAL | The amount of tax on the item, shipping, duty, or fee. |
taxes.description STRING | Varying descriptions of the applied tax such as tax, VAT, GST, PST, HST, and more. |
taxes.formula STRING | The formula used to calculate the tax amount typically includes the import country tax; however, this may also be a state (or provincial) tax or a reduced (or added) tax. |
taxes.item_id STRING | The unique identifier sent in the landed cost request. The id is only provided when the type is item. |
taxes.note STRING | Additional details on the tax, including reduced tax rates or other applicable information on the applied tax. |
taxes.type STRING | The tax is applied to the type.Possible values include item duty and shipping as well as the fees types of advancement, additional_tariff_lines, ddp_service_fee, brokerage, cod, country, and other. |
Example request
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
{
"id": "ldct_1Ce6vt2eZvKYlo2CrgzPqxaz",
"amount_subtotal": {
"duties": 0,
"fees": 15,
"taxes": 12.25
},
"currency": {
"id": "b5f06418-3",
"base": "USD",
"date": "2021-01-07T00:34:03.471+0000",
"rates": [
{
"currency": "GBP",
"rate": 0.8117
}
]
},
"customs": {
"delivery_duty_paid": "available",
"items": [
{
"id": "294395",
"amount": 39.17,
"country_of_origin": "FR",
"country_of_origin_source": null,
"description_customs": "Hoka One Running Shoe - Women's",
"description_retail": "Hoka One Running Shoe - Women's",
"hs_code": "6116.10",
"hs_code_source": "api_request",
"note": "Item was discounted by 47.78% from 75.00 USD to 39.17 USD",
"quantity": 1
},
{
"id": "294396",
"amount": 7.83,
"country_of_origin": "CN",
"country_of_origin_source": "account_default",
"description_customs": "Galaxy Quest Men's Tee Blue",
"description_retail": "Galaxy Quest Men's Tee Blue",
"hs_code": "6217.10",
"hs_code_source": "api_request",
"note": "Item was discounted by 47.78% from 15.00 USD to 7.83 USD",
"quantity": 1
}
],
"shipping_amount": 14.23,
"ship_to_country": "GB"
},
"de_minimis": [
{
"formula": "(cost {'<='} 135 gbp and hs_code not_starts_with \"2203,2204,2205,2206,2208,24,3303\")",
"method": "FOB",
"note": "Items value less than 135 GBP and not containing alcohol, tobacco, or other excluded items",
"threshold": "below",
"type": "duty"
},
{
"formula": "(cost {'<='} 0 gbp)",
"method": "FOB",
"note": "Tax applies to all shipments",
"threshold": "above",
"type": "tax"
}
],
"duties": [],
"fees": [
{
"amount": 15,
"description": "UPS United States Duty and Tax Forwarding Charge",
"item_id": null,
"formula": "15 USD",
"note": null,
"type": "ddp_service_fee"
}
],
"remittance": [
{
"amount": 12.25,
"description": "UK VAT",
"note": "remit to HMRC quarterly"
}
],
"removed_items": [],
"taxes": [
{
"amount": 7.83,
"description": "VAT (Value-added tax)",
"item_id": "294395",
"formula": "20%",
"note": null,
"type": "item"
},
{
"amount": 2.3719,
"description": "VAT (Value-added tax)",
"item_id": "294395",
"formula": "20%",
"note": null,
"type": "shipping"
},
{
"amount": 1.57,
"description": "VAT (Value-added tax)",
"item_id": "294396",
"formula": "20%",
"note": null,
"type": "item"
},
{
"amount": 0.4741,
"description": "VAT (Value-added tax)",
"item_id": "294396",
"formula": "20%",
"note": null,
"type": "shipping"
}
]
}
Landed Cost object
Explore the capabilities and functions of the Landed Cost object.
The Landed Cost object provides a breakdown and total of import duties, taxes, and fees.