Portal Info
Shippo users sign in to the Shippo web app at:
https://apps.goshippo.com
API tokens are created in the Shippo API portal, under API Configuration, then Developer keys (Shippo: Authentication).
API Endpoints
The Shippo integration uses the Shippo API, a REST API that accepts and answers JSON and authenticates with a Shippo API token. "All API URLs listed in this documentation are relative to https://api.goshippo.com/", and every request must use TLS 1.2 or higher (Shippo: API Reference Overview). Shippo versions its API by date; the integration names no version, so your account's default version applies (Shippo: API versions).
Base URL:
https://api.goshippo.com
The base URL is the API Url subscription setting (see Shippo Connections and Settings). It must be Shippo's own https address. A test token and a live token use the same base URL; the token decides which set of Shippo data the calls reach.
Every endpoint below is shown with [Base URL] in place of the base URL above.
Table of Contents
Address Endpoints
Order Endpoints
Label Endpoints
Rate Endpoints
Carrier Account Endpoints
Webhook Endpoints
Address Endpoints
Check the Connection by Listing Addresses (GET)
Reads one saved address. The integration makes this call when it connects to Shippo, at the start of a transfer, to prove that the API token works (Shippo API: List all addresses).
[Base URL]/addresses?results=1
Order Endpoints
Shippo's API can list, create and read orders; it has no update, cancel or delete for them (Shippo API: Orders).
Look Up an Order by Number and Placed-at Time (GET)
Before sending a new order, the integration lists the Shippo orders placed within one second of the order's placed-at time and looks for one with the same order number. A match is returned to iPaaS.com as a collision; two or more matches stop the transfer (SHPO-BIZL-1001).
[Base URL]/orders?start_date={PlacedAt minus 1 second}&end_date={PlacedAt plus 1 second}&results=100Query parameters:
Parameter | Description |
start_date | The earliest order date to return, as a UTC time: one second before the order's placed-at time. |
end_date | The latest order date to return: one second after the order's placed-at time. |
results | Records per page: 100. |
Create an Order (POST)
Creates the order in Shippo, with its ship-to address, ship-from address, line items and weight, during a FROM iPaaS.com order transfer (Shippo API: Create a new order).
[Base URL]/orders
Get an Order by Id (GET)
Retrieves a single order by its Shippo order id (Shippo API: Retrieve an order). Used:
when an order already linked to a Shippo order is transferred again;
to load the existing order of a collision, so its ship-to and lines can be linked;
before and after an automatic label purchase, to check whether the order already has a label.
[Base URL]/orders/{order-id}
Label Endpoints
Shippo calls a bought label a transaction.
Buy a Label (POST)
Buys the label for an order when Automatic Label Purchase is on, from the order's carrier account and service level, the Default Parcel template, the order's total weight and the Label File Type (Shippo API: Create a shipping label).
[Base URL]/transactions
Get a Label by Id (GET)
Retrieves a single label by its Shippo id, during a TO iPaaS.com tracking transfer (webhook, scheduled label check or Manual Sync) (Shippo API: Retrieve a shipping label). A failed purchase attempt has no label and is not transferred.
[Base URL]/transactions/{label-id}
List Recent Labels (GET)
Lists the labels created in the last Days of Label History days, for the scheduled label check (Shippo API: List all shipping labels). See Pagination.
[Base URL]/transactions?object_created_gte={start time}&results={Label Page Size}&page={page}Query parameters:
Parameter | Description |
object_created_gte | Returns labels created at or after this UTC time: Days of Label History days before the poll starts. |
results | Labels per page: the Label Page Size setting, 1 to 100 (100 by default). |
page | The page number, starting at 1. |
Rate Endpoints
Get a Rate by Id (GET)
Retrieves the rate a label was bought with, when the label doesn't include it, to read the label's carrier account and service level (Shippo API: Retrieve a rate).
[Base URL]/rates/{rate-id}
Carrier Account Endpoints
List Carrier Accounts with Their Services (GET)
Lists the carrier accounts in Shippo with their service levels. Used by the shipping method initialization and by shipping method transfers TO iPaaS.com, and to find a label's shipping method (Shippo API: List all carrier accounts). Services of a carrier account turned off in Shippo are not read.
[Base URL]/carrier_accounts?service_levels=true&results={Carrier Account Page Size}&page={page}Query parameters:
Parameter | Description |
service_levels | true: include each carrier account's service levels. |
results | Carrier accounts per page: the Carrier Account Page Size setting, 1 to 100 (25 by default). |
page | The page number, starting at 1. |
Webhook Endpoints
The integration registers one Shippo webhook per Shippo scope set Active under Inbound Data Flows (transaction_created, transaction_updated, track_updated). Each points at the subscription's iPaaS.com webhook address with its key, and is marked as a test webhook when the API token is a test token. The integration never changes webhooks it didn't create.
Create a Webhook (POST)
Registers the webhook for a scope when the scope is set Active (Shippo API: Create a new webhook).
[Base URL]/webhooks
Update a Webhook (PUT)
Updates the integration's webhook for a scope when the scope is set Active again. A webhook the current token can't find, for example after a change between a test and a live token, is registered again (Shippo API: Update an existing webhook).
[Base URL]/webhooks/{webhook-id}
Delete a Webhook (DELETE)
Removes the integration's webhook for a scope when the scope is set inactive (Shippo API: Delete a specific webhook).
[Base URL]/webhooks/{webhook-id}
Authentication
Shippo uses token authentication: "put Authorization: ShippoToken
in your request header" (Shippo: API Reference Overview). There is no separate authorization endpoint and no token exchange; the token is sent on every request.
Authorization: ShippoToken <API Token>
The <API Token> value is the API Token subscription setting. Test tokens begin with shippo_test_ and live tokens with shippo_live_; each mode has its own data, and only live mode charges for labels (Shippo: Authentication).
Pagination
Shippo's list endpoints return one page at a time. The results parameter sets how many records a page holds (Shippo: API Reference Overview), and page chooses the page. A response carries a next link while more pages follow.
How the integration pages:
The scheduled label check (label/poll) reads pages of Label Page Size labels until a page has no next link, and stops after 50 pages in one run. When it stops at the cap, it keeps its starting point, so the next run reads the same window again, and it writes a warning that says to lower Days of Label History or raise Label Page Size.
Loading carrier accounts reads pages of Carrier Account Page Size accounts until a page has no next link.
The order look-up reads one page of up to 100 orders placed in a two-second window.
Rate Limits and Concurrency
Shippo's limits are per minute and differ by endpoint and method, with lower limits for test tokens than for live ones; "Exceeding the rate limit will give a 429 error" (Shippo: Rate limits, checked 2026-11-18). The limits for the endpoints the integration calls:
Shippo endpoint | Create or update, live / test | Get one, live / test | List, live / test |
Addresses | 500 / 50 | 4,000 / 400 | 50 / 10 |
Labels (transactions) | 500 / 50 | 4,000 / 400 | 50 / 10 |
Rates | 500 / 50 | 4,000 / 400 | 50 / 10 |
Carrier accounts | 500 / 50 | 4,000 / 400 | 50 / 10 |
Shippo doesn't publish separate limits for orders or webhooks. Contact Shippo if your account needs higher limits.
What uses the limit:
Each connection begins with one address read.
A FROM iPaaS.com order transfer makes one order look-up and one order create. With Automatic Label Purchase on, it adds an order read to check for a label, the label purchase, and further order reads when Shippo doesn't answer the purchase.
A TO iPaaS.com tracking transfer reads the label, sometimes its rate, and the carrier accounts (one call per page).
Each scheduled label check run makes one call per page of labels, and each label it finds starts a tracking transfer.
A transfer that reaches the limit is held and retried automatically (SHPO-EXTN-1002). The subscription's iPaaS.com throttle settings (API Throttle Limit, API Throttle Seconds, API Throttle Limit (To iPaaS), API Throttle Seconds (To iPaaS) and Concurrent Connections) are pre-populated; leave them at their defaults.
Related Documents
