Zonos js


Zonos JS integration

Learn how to integrate Checkout using Zonos JS.

Zonos JS allows you to integrate Zonos Checkout without development on your part, even when we do not have a pre-built plugin for your platform. With Zonos JS, our engineers create a script that will redirect your international customers to Checkout. This script is customized to your website and will pull the item details from your cart page through to Checkout. Completed orders will appear in Dashboard, where you can easily generate international shipping labels.

Note: By default, orders placed in Checkout will only appear in Dashboard. They will not appear in your ecommerce platform. If you need your international orders to import into your ecommerce platform, build our Retrieve an Order API.


Create and configure an account

To get started, you need to create and configure a Zonos account with your shipping settings, product information, and checkout settings. The Checkout page will use your account information when calculating a total landed cost for your international shoppers.

  1. Register for a Zonos Dashboard account.
  2. After registering, complete your account setup.

While you are configuring your account, Zonos engineers will write a custom script for your store.


Add script to your website

Once the script is ready, your onboarding Project Manager will provide it to you. Use the instructions below to add it to your website:

Custom platform

Add the following Zonos JS script tag to your <head> tag:

Script tag

<script src="{supplied scriptURL}"></script>

When you add your custom Zonos JS script to your site, it will initially be in test mode. During test mode, Hello will be active on your site, but your international customers will still go through your current native checkout flow (they will not get to Zonos Checkout).


Test the script on your site

To test the functionality of Checkout, you will need to tell the browser to load the page as if Zonos is live on your site. You can do this by manually adding ?zonos=true to the end of your URL (on each page you visit), or by adding the key zjs_debug with a value of false to your local storage for your website.

Here are the items you should test while the script is in test mode:

Your domestic checkout process is unaffected.

Elements that are not applicable to your international shoppers are hidden on the cart and product pages.

The following information is collected from the cart page and presented in Checkout: product price, discounted prices, add-ons, images, quantity, and promo codes.

Currency conversion is working properly (if enabled).

The item weight, HS code, country of origin, and dimensions are used as provided.

Ensure the shipping rates that return in Checkout align with the rates provided by your shipping carrier.

Place a test order in Checkout using your own email address. Confirm that you receive an email confirmation of the order.

Print a label in Dashboard -> Orders.


Go live!

Once you have verified that the script is working correctly, and are ready to go live, contact your onboarding Project Manager to have them activate your Zonos JS Script to make Checkout live on your site.

Important: Since Zonos JS is customized to your site's layout, it may require an update if you change your site layout or code.

Was this page helpful?

© 2023