Prerequisites
Before you begin, make sure you have the following:
- An active inclusive pricing subscription with Zonos.
- A Secret GraphQL API key from your Zonos Dashboard. Navigate to Settings -> Integrations to find your API keys. The key must have a
credential_liveprefix and must not be expired.
First-time setup
Follow these steps to set up the inclusive pricing report template for the first time.
Copy the Google Sheet template
Open the inclusive pricing report template and make your own copy by going to File -> Make a copy. Do not request editor access to the original sheet.
Connect your API key
In your copied sheet, click Zonos -> Update GraphQL API Key from the menu bar (next to Help). This menu option can take a minute to appear after opening the sheet.
Authorize the script
For first-time users, an authorization dialog will appear. Click OK, then follow the prompts to authorize the script with your Google account:
- Click Select all to grant the required permissions.
- Click Continue to complete authorization.
Enter your Secret API key
After authorization, a dialog will prompt you to enter your Zonos Secret GraphQL API key. You can find this in your Zonos Dashboard under Settings -> Integrations.
Make sure to copy a valid Secret key with a credential_live prefix. Expired keys or Public keys will cause errors.
Fetch orders
Click Zonos -> Fetch Orders from the menu bar.
Select a date range
Enter a start and end date in the dialog, or use one of the preset options (Last 30 days, This month, Last month, This year), then click Fetch Orders.
When complete, your orders will populate in the Orders tab of the sheet.
Note: To save a report for future reference, right-click the Orders tab and select Duplicate, then rename it as needed. You can also export or make a copy of the entire spreadsheet.
Everyday use
After completing the first-time setup, generating new reports is straightforward:
- Skip steps 1-3 - These are a one-time process.
- Skip step 4 unless your API key has expired or you need to pull data from a different Zonos store.
- Repeat steps 5 and 6 to fetch orders for a new date range.
401 Unauthorized error
You may see an error containing HTTP fetch failed from 'order': 401: Unauthorized.
Fix: Make sure you are using a valid Secret GraphQL API key from your Zonos Dashboard. This error occurs when the key is missing, invalid, or not a Secret key type.
Security requirement failed error
You may see an error containing Security requirement failed.
Fix: Make sure you are using the Secret GraphQL API key (not a Public key) and that it does not have a status of Expired. Navigate to Settings -> Integrations in your Zonos Dashboard to verify your key status.
No orders appear
No orders populate despite providing a valid Secret GraphQL API key.
Fix: This report only generates data for orders with inclusive pricing attributes. If your items do not contain reverseAmountDetail fields, they will not be included. Verify that you have processed inclusive pricing orders within the date range you selected.
Export inclusive pricing report
Generate an item-level inclusive pricing breakdown using a Google Sheet.
The inclusive pricing report template is a Google Sheet with a built-in script that queries the Zonos GraphQL API for your orders and generates a report showing item-level breakdowns of base and inclusive amounts. This is useful for any merchant who wants visibility into how duties, taxes, and fees are distributed across items in their inclusive pricing orders.