Zonos logo
DOCS

Manage products

/

Manage catalog products

COMING SOON

Create and modify products in Zonos Dashboard or via API.

Zonos Catalog manages all your product details, which you can use to power your landed cost quotes and manage your classifications. We recommend using Catalog in Dashboard if you want to avoid writing code or if you're making small changes. If you want to directly integrate with Catalog for production implementations, use the API.

Follow the steps below to add, modify, and delete your product(s) in Dashboard or via API.


Create a product

Dashboard
API

To create a product in Catalog:

  1. Go to Catalog and click on Add product in the top right-hand corner.
  2. Add your product details. The only field required to create a product is the SKU and/or product ID field(s). These fields will be used to reference your catalog products. Learn more about Catalog’s identifiers.
  3. Optional— Add your classification details.
  4. Optional— Add your shipping information (weight, dimensions, units of measure, etc.).
  5. Optional— Add restricted countries.
  6. Click save product.

To create multiple products in Catalog:

To upload multiple products or your entire product catalog at once, follow these steps.

If you attempt to create a product that already exists, Catalog will recognize the product based on the SKU and/or product ID and override the original product's details with the new details.

Edit a product

Dashboard
API

To edit a product:

  1. Click on the All products tab.
  2. Select the product you want to edit.
  3. Make your changes.
  4. Click save product.

Learn how editing existing products affect your data.

Delete a product

Dashboard
API

To delete a product:

  1. Click on the All products tab.
  2. Select the product or products you want to delete. If you want to delete all products, select the checkbox at the top left of your catalog to select all. Once your product(s) are selected, a delete button will appear.
  3. Click delete.

Restrict a product

If you want to prevent shipments to a certain country (or countries), you can add restrictions when creating or updating a product.

Dashboard
API

To restrict a single product in Catalog:

  1. Click on the All products tab.
  2. Select the product to which you want to add a restriction, which will open the edit page.
  3. Find the restrictions section at the bottom of the edit page.
  4. Add the countries you want to restrict your product to by selecting or typing the country name(s).
  5. Click save product.

To restrict multiple products in Catalog:

  1. Click on the Import/export tab.
  2. Download the Catalog template CSV.
  3. Fill out the template with your product details. Include your SKU/Product ID and restricted countries by following the Catalog CSV format.
  4. Save your file as a CSV and upload to Catalog by dragging and dropping or selecting your file by clicking browse on the same page you downloaded the CSV from.
  5. Review your uploaded products in the preview screen and click upload.

If you would like to restrict catalog products in bulk via CSV, follow the product CSV description format.

Filtering restricted products:

You can filter restricted products directly in the catalog by downloading your entire catalog in CSV format from Dashboard and opening it in Excel or Google Sheets. From there, you can use the filtering feature to view only the restricted products. This allows you to easily locate and manage the restricted products in your catalog.

If you need to update your catalog after making changes to your CSV, reupload the file and any matching products will be replaced with the updated version. This is done by identifying and matching the SKU and/or product ID.

COMING SOON

If you're using Checkout, a restricted message will be displayed in your checkout when a product is restricted to the customer's country. By default, the message will say "This item is restricted from import to your country," but you can customize your own restricted message by providing it in the restrictedCountriesMessage field when adding your country restrictions.

Export your products in Dashboard

When you export your products, it will automatically export your entire product catalog in a CSV file.

  1. Go to the main page of your Catalog.
  2. Click the Export button next to Add product.
  3. Find your full catalog file in your downloads.

Classify a catalog product via API

You can classify a product from your catalog by using the catalogItemId in the ClassificationsCreateFromCatalog mutation.

Note that a name is required to classify a product from your catalog. Consult the GraphQL API reference for a complete catalog and classification fields list.

To create and classify a catalog product simultaneously, add the ClassificationsCreateFromCatalog mutation below to your CatalogItemsCreate mutation.

Classify a catalog product to the 8+ digit (country-specific)

When the shipToCountries field is populated, the classification will be 8+ digit (country-specific) HS code. If no shipToCountries are provided, the classification will default to a 6-digit (universal) HS code. Learn more about the distinctions between universal and country-specific HS codes.

In the example below, the shipToCountries field is provided to generate a country-specific code for Canada.

Mutation

1
2
3
4
5
6
7
8
9
10
11
12
13
14
mutation ClassificationsCreateFromCatalog(
 $catalogItemToClassify: [ClassificationFromCatalogInput!]!
) {
 classificationsCalculateFromCatalog(input: $catalogItemToClassify) {
  id
  configuration {
   shipToCountries
  }
  hsCode {
   code
  }
  name
 }
}

Here’s an example of a request. While Zonos Classify will generate a classification with just a name, we strongly recommend adding as many details as possible for the best classification results.

Variables

1
2
3
4
5
6
7
8
9
10
{
  "catalogItemToClassify": [
    {
      "catalogItemId": "catalog_item_893jkdkllg03k9khjd9",
      "configuration": {
        "shipToCountries": ["CA"]
      }
    }
  ]
}

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
{
  "data": {
    "classificationsCreateFromCatalog": [
      {
        "id": "classification_8C49fk2945jmm232CcQtHtXdu",
        "configuration": {
          "shipToCountries": ["CA"]
        },
        "countryOfOrigin": "US",
        "hsCode": {
          "code": "6116.10.0020"
        },
        "name": "Cozy Design Women's Knitted Gloves with Roll Up Cuffs for Winter"
      }
    ]
  }
}