Attributes
JSON key/value pairs in the request body
POST | https://api.zonos.com/v1/landed_cost
HEADER zonos-version: 2019-11-21
The header above is a required input for this landed cost request to complete successfully.
| Field | Notes |
|---|---|
currency REQUIRED | The base currency string, represented by a three-letter ISO code. |
discounts OPTIONAL | The information related to any discounts, including the id, amount, and any details. |
discounts.id OPTIONAL | The unique discount identifier for the merchant or exporter. |
discounts.amount OPTIONAL | A decimal with the amount of the discount, in dollars and cents. |
discounts.detail OPTIONAL | Additional features, attributes, or descriptions of the discount. |
items REQUIRED | The list of items being exported. hash |
items.id REQUIRED | The unique item identifier for the merchant or exporter. |
items.amount REQUIRED | A decimal with the total of one single item, in dollars and cents. |
items.amount_discount OPTIONAL | The amount of the discount that applies to the item. |
items.brand OPTIONAL | The brand of the item, e.g. "Leatherman.” |
items.category OPTIONAL | Category description of the item e.g. "Clothing." |
items.color OPTIONAL | Color of the item. |
items.country_of_origin OPTIONAL | The country of manufacture or production, represented by a two-letter ISO code. This is recommended for the most accurate quotes. If no country of origin is received, the Most Favored Nation (MFN) rate is used. |
items.description_customs OPTIONAL | 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. |
items.description_retail OPTIONAL | The retail description of the item. |
items.detail OPTIONAL | Additional features, attributes, or descriptions of the item. |
items.dimensions OPTIONAL | The size of the shipment. This is recommended to get the most accurate quotes into countries where tariffs are impacted by the dimensions of the item. hash |
items.dimensions.height OPTIONAL | A decimal for the height of the item. |
items.dimensions.length OPTIONAL | A decimal for the length of the item. |
items.dimensions.unit OPTIONAL | The unit of measurement for the item dimensions.Possible values are inch, centimeter, millimeter, and null.When null, inch will be used. |
items.dimensions.width OPTIONAL | A decimal for the width of the item. |
items.duty_tax_fee_free OPTIONAL | A string to specify if the item should not be included in the landed cost calculation. When exclude is sent in the request, the item will show up in removed_items in the API response. |
items.hs_code OPTIONAL | Item HS code, 2 to 10 digits. |
items.image_url OPTIONAL | The image URL. |
items.quantity REQUIRED | An integer with the quantity of the item. |
items.upc_code OPTIONAL | The UPC code string for the item. |
items.weight OPTIONAL | A decimal for the weight of the item. |
items.weight_unit OPTIONAL | The unit of measurement string for the weight.Possible values are pound, ounce, kilogram, and null.When null, pound will be used. |
landed_cost OPTIONAL | The type of request for a landed cost.Possible values include delivery_duty_paid and delivery_duty_unpaid.The fees for a landed cost can differ, whether it is sent DDP or DDU. If null, a DDP request will be assumed.If a DDP request is made and DDP is not available, a 400 error will be returned with a message stating that DDP is not available for the service level provided.DDP and DDU are typically both available within each service level, so please ensure that this can be configured on a per-service level basis instead of account-level. |
sale_type OPTIONAL | An indicator of the type of sale.Possible values include not_for_resale for_resale.If null a not_for_resale request will be assumed. |
ship_from_country REQUIRED | The ship from country string, represented by a two-letter ISO code. |
ship_to REQUIRED | The destination address. hash |
ship_to.city OPTIONAL* | A string for the address city, town, district, suburb, or village of the customer. Depending on the country of import, this field may be REQUIRED. |
ship_to.country REQUIRED | A string for the destination country in which the bank account is located in, represented by a two-letter ISO code. |
ship_to.postal_code OPTIONAL* | A string for the destination postal code. This field may be required when the shipment is between Northern Ireland and the European Union. |
ship_to.state OPTIONAL* | A string for the destination state code when available. If the country of import is Brazil or Canada, this field is required. |
shipping REQUIRED | The shipping details such as the amount, discount amount, and service level with the carrier. hash |
shipping.amount REQUIRED | A decimal for the sum total of the shipping costs, in dollars and cents. |
shipping.amount_discount OPTIONAL | A decimal for the amount of the discount that applies to the shipping. |
shipping.service_level REQUIRED | The service_level with the carrier.See the carrier docs for the full list of available service levels by carrier. |
*This field is optional depending on the address field requirements for the country of import.
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
{
"currency": "USD",
"discounts": [
{
"id": "sale124",
"amount": 43.0,
"detail": null
}
],
"items": [
{
"id": "294395",
"amount": 75,
"amount_discount": 0,
"brand": null,
"category": "Women's Clothing",
"color": null,
"country_of_origin": "FR",
"description_customs": null,
"description_retail": "Hoka One Running Shoe - Women's",
"detail": null,
"dimensions": {
"height": 4,
"length": 6,
"unit": "inch",
"width": 11
},
"duty_tax_fee_free": null,
"hs_code": "6116.10.00",
"image_url": "https://zonos.com/images/handbag.png",
"quantity": 1,
"upc_code": null,
"weight": 10,
"weight_unit": "pound"
},
{
"id": "294396",
"amount": 15,
"country_of_origin": "CN",
"country_of_origin_source": "account_default",
"description_customs": "Men's t-shirt 100% polyester",
"description_retail": "Galaxy Quest Men's Tee Blue",
"detail": null,
"dimensions": {
"height": 4,
"lenght": 6,
"unit": "inch",
"width": 11
},
"duty_tax_fee_free": "exclude",
"hs_code": "6217.10",
"image_url": null,
"note": null,
"quantity": 1,
"upc_code": null,
"weight": 1,
"weight_unit": "pound"
}
],
"landed_cost": "delivery_duty_paid",
"sale_type": "not_for_resale",
"ship_from_country": "US",
"ship_to": {
"city": "Campinas",
"country": "BR",
"postal_code": "75828-000",
"state": "SP"
},
"shipping": {
"amount": 14.23,
"amount_discount": 0,
"service_level": "ups_express_saver"
},
"tariff_rate": "zonos_preferred"
}
Example response
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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
{
"id": "ldct_eab3008d-a8ca-4bd7-bf6d-cd178fe3cd77",
"amount_subtotal": {
"duties": 27.74,
"fees": 15.33,
"taxes": 16.23
},
"currency": {
"id": "curr_8fb20952-d",
"base": "USD",
"date": "2019-11-04T20:42:40.999+0000",
"rates": [
{
"currency": "BRL",
"rate": 0.2274
}
]
},
"customs": {
"delivery_duty_paid": "available",
"items": [
{
"id": "294395",
"amount": 32.0,
"country_of_origin": "FR",
"country_of_origin_source": null,
"description_customs": "Women's Tennis Shoe",
"description_retail": "Hoka One Running Shoe - Women's",
"detail": null,
"dimensions": {
"height": 4.0,
"length": 6.0,
"unit": "inch",
"width": 11.0
},
"hs_code": "6116.10.00",
"hs_code_source": "account_default",
"image_url": "https://zonos.com/images/handbag.png",
"note": null,
"quantity": 1,
"upc_code": null,
"weight": 10.0,
"weight_unit": "pound"
}
],
"ship_to_country": "BR",
"shipping_amount": 14.23
},
"de_minimis": [
{
"formula": "Less than 0 BRL",
"method": "FOB",
"note": null,
"threshold": "above",
"type": "duty"
},
{
"formula": "Less than 0 BRL",
"method": "FOB",
"note": null,
"threshold": "above",
"type": "tax"
}
],
"duties": [
{
"amount": 19.2,
"description": "duty",
"formula": "60%",
"item_id": "294395",
"note": "Duty is 60% of the items total.",
"type": "item"
},
{
"amount": 8.54,
"description": "Duty",
"formula": "60%",
"item_id": null,
"note": null,
"type": "shipping"
}
],
"fees": [
{
"amount": 22.0,
"description": "UPS United States Duty and Tax Forwarding Charge",
"formula": "15 USD",
"item_id": null,
"note": null,
"type": "ddp_service_fee"
},
{
"amount": 0.33,
"description": "UPS Currency Conversion Fee",
"formula": ".75% of the amount converted",
"item_id": null,
"note": null,
"type": "currency_conversion_fee"
}
],
"removed_items": [
{
"id": "294396",
"amount": 15,
"country_of_origin": "CN",
"country_of_origin_source": "account_default",
"description_customs": "Men's t-shirt 100% polyester",
"description_retail": "Galaxy Quest Men's Tee Blue",
"hs_code": "6217.10",
"hs_code_source": "account_default",
"note": null,
"quantity": 1
}
],
"remittance": [],
"taxes": [
{
"amount": 7.02,
"description": "ICMS",
"formula": "18% applied to gross amount including tax. Calculate with fomula: value/(1-0.18)*0.18",
"item_id": "294395",
"note": null,
"type": "item"
},
{
"amount": 3.12,
"description": "ICMS",
"formula": "18% applied to gross amount including tax. Calculate with fomula: value/(1-0.18)*0.18",
"item_id": null,
"note": null,
"type": "shipping"
},
{
"amount": 6.09,
"description": "ICMS",
"formula": "18% applied to gross amount including tax. Calculate with fomula: value/(1-0.18)*0.18",
"item_id": null,
"note": null,
"type": "duty"
}
]
}
Request a landed cost
Find the key/value pairs in a landed cost request.Although Zonos Landed Cost is able to provide an accurate landed cost based soley on the description of an item, the more information that is provided, the more accurate the landed cost quote will be. Below are REQUIRED and OPTIONAL inputs, but it's recommended to fill in as many OPTIONAL fields as possible.