Are you ready for the new UK VAT scheme? Learn more
Find out which of Zonos’ API, plugin, or integration will work best for your project. View the API guides below for flow charts, sample use cases, and other helpful info to get you started.
Duties $7.32
Import fees $2.19
Taxes $15.25
Shipping $9.25
Learn about Zonos’ core cross-border product APIs
Landed Cost API
The Landed Cost API provides a complete breakdown of duties, taxes, and fees for each order request. This API is great if you are wanting a full, accurate landed cost with all line item details. You can display a sum of duties, fees, and taxes in your checkout or show even more detail if preferred.
Ideal for: Any project needing a complete landed cost including duty, taxes, and fees.
Read the docPOST https://api.zonos.com/v1/landed_cost
Send item information to create a request for landed cost
Read the docReturns a total landed cost breakdown including import duties, taxes, and fees.
Read the doc
Classify API
The Classify API provides an HS6-HS10 harmonized tariff code for each product submitted, allowing you to dynamically harmonize your catalog. This API can be used prior to or during the checkout process.
Ideal for: Anyone with a large catalog of products that is changing regularly. The Classify API allows you to constantly retrieve and update your system with accurate HS codes.
Read the docPOST https://api.zonos.com/v1/classify
Create a request for an item classification to the sixth or eighth digit.
Read the docGET https://api.zonos.com/v1/classify/:id
Retrieves a historical quote for an already classified item.
Read the docGET https://api.zonos.com/v1/classify
Retrieves a list of previous classifications.
Returns the subheading country-specific HS code result in the codes array with the chapter and heading information.
Read the doc
International Checkout API
The Zonos™ International Checkout API gives your ecommerce shop a beautiful, international shopping experience. In addition to a complete landed cost, International Checkout also allows the shopper to shop in their local currency and language, includes fraud coverage, custom restrictions, denied party screening, localization, international promo codes, global payments and more.
Ideal for: Merchants who want a checkout that is optimized for an international shopping experience, but don't want the hassle of transforming their domestic checkout manually. Zonos International Checkout can be used with any eCommerce platform, custom cart or application. (plugins also available for the most popular shopping cart platforms)
Our service-oriented architecture includes the following REST APIs for integrating our Zonos International Checkout.
Read the docSends cart information and items from the customer’s cart.
To use our International Checkout with your platform, all you need to do is create a cart on your site and then post the items to the International Checkout API and Zonos does the rest.
Read the docGets data for a completed order.
If you would like to pull your international orders into your platform, you can use the second endpoint, "Retrieve an order", which is recommended, but not required. Alternatively, if you have limited development resources, a hard-to-modify platform, or if you don't get many international orders, you may not want to use the "Retrieve an order" endpoint, and retrieve your orders manually. Orders are created in the Zonos system, when your customer completes checkout. You can manage all orders placed through Zonos International Checkout in the Zonos Dashboard.
Read the docUpdates various information on completed orders.
Changing or updating orders via the API is also not required, even if you create carts and retrieve orders via the Zonos International Checkout APIs.
Read the doc
Zonos’ helper APIs are designed for international commerce and can be used alone to achieve a specific cross-border functionality or as add-ons to one of our core products.
Localization API Legacy
The Localization API will provide you with country-specific address fields with labels, as well as field - show/ hide, and field - require flags for each country so you can format your checkout or application's address fields correctly for international addresses.
Ideal for: This API is helpful if your current platform or application does not have correct international address fields, or does not match up with the fields that Zonos uses.
For example, the Canary Islands do not use the city field; they only have an island. For the Canary Islands, you would hide the city field and rename the state field to "Island".
Important note: This API is considered "Legacy" because the currency and exchange rate portion is deprecated. Only use the address localization portion of this API. You will want to use the new Currency API for currency and exchange rate information.
Read the docGET: https://test-api.iglobalstores.com/2.0/localization
Message format is JSON. There are no request parameters for this endpoint.
Read the doc
Rating API
The Rating API will provide accurate shipping quotes from YOUR carrier's rates, based on package weight, dimensions, shipFrom and shipTo locations. The Rating API will use rates provided by your carrier's API, through connections that are configured in the Zonos Dashboard. If an API connection is not available for your carrier or particular service level, you can also set up rate sheets.
Ideal for: Anyone needing an easy way to surface shipping rates from one or more shipping carriers.
Read the docPOST https://api.zonos.com/v1/shipment_rating
Create a request for shipment rating by providing order and package-level information.
Read the docReturns shipping quotes by service level with a breakdown of surcharges, fees, and negotiated rate discounts that make up the quote.
Read the doc
Customs API COMING SOON
The Customs API will generate any applicable customs documents and the data to correctly fill out customs documentation, such as a commercial invoice, certification of origin, or any country-specific statements required on the commercial invoice. The API will include a link to each document to be printed and included with the shipment or to be attached electronically to the label, if available.
Ideal for: The Customs API is best used if you want to ensure you are generating the correct, required customs documents into each country. The Labels API will call the customs API so you can utilize the functionality of both when you are integrated with the Labels API.
Read the docPOST https://api.zonos.com/v1/customs
Create a request for customs documentation.
Read the docReturns the information needed to properly complete a commercial invoice and customs documents.
Read the doc
Labels API COMING SOON
The Labels API will allow you to create a shipping label or label quote for your international package/order, or for a batch of orders, by providing a link to the generated label. It will also call the Customs API and provide any needed customs documentation if you do not include them in your request. Customs documentation will be digitally attached to the label when created.
Ideal for: This API works best if you are needing to generate an international label that meets each country's international requirements and to have the customs documents attached electronically, when applicable.
POST https://api.zonos.com/v1/shipment_label
Create a shipment label and label attachments.
POST https://api.zonos.com/v1/shipment_label/:id/void
Cancel a previously created shipment label.
GET https://api.zonos.com/v1/shipment_label
Retrieve a list of recent shipment label quotes.
GET https://api.zonos.com/v1/shipment_label/:id
Look up any shipment label by quote ID.
GET https://api.zonos.com/v1/shipment_label/batch
Get a list of open batch shipment labels.
GET https://api.zonos.com/v1/shipment_label/batch/:id
Lookup a single existing batch shipment label.
POST https://api.zonos.com/v1/shipment_label/batch/:id/complete
Complete a batch shipment.
Returns a shipment label quote that contains the service level and price with an indication of whether the label was generated successfully.
When you request the label with attachments, you will be provided with a PDF of the generated label.
Chapters API
The Chapters API will provide HS codes and the subchapters of the harmonized tariff schedule, based on which HS chapter you send in your request. This includes the two-digit, four-digit, and six-digit codes with the HS description so you can harmonize your product catalog. An eight-digit, country specific subchapter will be returned if the request includes a six-digit code and the country code. This API works best if you know which chapters or subchapters your products fall within.
Ideal for: A more advanced user needing HS chapter and subchapter information including descriptions. This API can also be used to create a lookup tool for users to drill down into chapters and subchapters from an interface, to identify the correct HS code for a specific product.
Read the docPOST https://api.zonos.com/v1/chapters
Create a request for a complete or partial list of chapters and subchapters from the Harmonized Tariff Schedule.
Read the docReturns the full or partial list of chapters and subchapters for HS codes with descriptions.
Read the doc
Classify Assistant
The Classify Assistant API will return HS codes for common ecommerce product categories. Each product category will provide a category id that can be passed in the Landed Cost API to get the duty rate for your items.
Ideal for: Users that are not very familiar with the harmonized tariff schedule and would like to drill down to find an appropriate HS code for a specific category or item. This API also works well for building an interface to allow basic users or customers to classify products.
Read the docGET https://api.zonos.com/v1/categories
Retrieves the full list of consumer category names and associated identifiers.
Read the docReturns the full list of simplified consumer categories and the description for each category.
Read the doc
Currency API
The Currency API will return the current foreign exchange rate for a specific currency or country. The currency object can also be found within the Landed Cost Object.
Ideal for: Displaying prices on your website or checkout in your shoppers local currency. You can also use this API to convert prices in order confirmation emails for your customers.
Read the docGET https://api.zonos.com/v1/currency
Get an up-to-date list of foreign exchange rates by currency and country.
Read the doc
Order Complete API
The Order Complete API allows you to send Zonos the details of a completed order and get the Zonos order ID back.
Ideal for: Anyone using the International Checkout API, Zonos labels, Landed Cost Guarantee, or if you are using the Landed Cost API and would like Zonos to provide reporting on your orders or need to to update Zonos with your orders for billing purposes.
Read the docPOST https://api.zonos.com/v1/orders
Create a request for a completed order.
Read the docReturns the order details with the Zonos-specific order ID.
Read the doc
Landed Cost -Use the Landed Cost API or one of our plugins to add a complete landed cost to your custom software or checkout.
or to sign up and receive your API key to get started.
Click hereor
International Checkout There are three ways to integrate International Checkout.
or to sign up and receive your API key to get started.
Click hereZonos products work at their maximum accuracy level with HS codes, so we highly recommended using them. With Zonos Classify, you can easily get HS codes for your entire catalog.
I'll use Zonos Classify to create my own HS codes
or
I have my own
HS codes
[Zonos] has been a fantastic partner that has given us the ability to reach more countries and control our own destiny in regards to service offerings and costs. We had other options out there, but they were all tied to a company that wanted to control our freight.
Aaron B. (G2 reviews)
At Zonos, we have a documentation-first mentality and strive to create guides and information that is easy for anyone to understand.
Our docs also include a mountain of valuable information on cross-border commerce, including our country guides, de minimis tables, and more!
Read the docsCheck out our tips below to help you get going.
Now that you know about Zonos. What are some of the steps and tools available to use to inform my stakeholders and organization?
Now that you’ve identified that you are a good fit for Zonos, here’s how to get started.
Contact the Zonos Sales team to:
Our implementation timeline can depend on the integration or plugin type you are using and the ecommerce platform that you are on.
Depending on your experience level, the actual integration of the code should take 1 - 4 hours of developer time per API, notwithstanding your company’s proprietary deployment schedule or other factors that are particular to your setup. To run a successful checkout, you should plan on integrating with at least three (3) of Zonos’ APIs.
For example, a basic International Checkout integration includes:
The Landed cost API simply returns a quote for your cart by passing cart information to Zonos.
A Customer Success (CS) rep is assigned to each account that will help guide you through the process. The CS rep will also follow their account while they are with Zonos to help with questions or success.
Zonos products work at their maximum accuracy level with HS codes, so we highly recommended using them with our products. With Zonos Classify, you can easily get HS codes for your entire catalog. However, they are not required, particularly if your catalog contains very similar items. If the variety of your catalog is vast, then they are recommended.
Check out our tips below to help you get going.
