Linking Shippo as a source
This source is currently in alpha. The interface and available tables may change.
The Shippo connector syncs your shipping data – shipments, purchased labels, orders, addresses, parcels, refunds, customs data, and carrier accounts – into the PostHog Data warehouse, so you can analyze fulfillment and delivery alongside your product data.
Prerequisites
You need a Shippo account with access to its API settings. Shippo issues separate live (shippo_live_...) and test (shippo_test_...) API tokens – use the live token to sync your production shipping data.
Adding a data source
- In PostHog, go to the Sources tab of the data pipeline section.
- Click + New source and click Link next to this source.
- Enter your credentials (see Configuration below) and click Next.
- Select the tables you want to sync, choose a sync method and frequency, then click Import.
Once the syncs are complete, you can start querying this data in PostHog.
When linking Shippo, you'll need:
- API token – find or generate one under Settings → API in the Shippo dashboard. The token grants read access to all of your account's shipping data.
Sync modes
Each table can be synced in one of several modes, depending on what the source supports:
- Webhook (when available) – the source pushes changes to PostHog in real time. Fastest freshness, lowest ongoing cost, and the only mode that reliably captures updates and deletes.
- Incremental – only new or updated rows are synced on each run, using a cursor field (such as an
updated_attimestamp). Cheaper than a full refresh, but deletes aren't captured. - Append only – new rows are appended using a cursor field; existing rows are never updated. Ideal for immutable, append-only tables like event logs.
- Full refresh – the whole table is reloaded on every sync. Use it when a table has no reliable cursor or when you need deletions reflected.
See sync methods for a full explanation of how each mode works and how to choose between them.
The shipments table supports incremental syncs on its creation time. Note that the Shippo API doesn't return shipments older than 390 days, which bounds how far back the initial sync can reach. The other tables are synced with a full refresh.
Configuration
| Option | Type | Required |
|---|---|---|
API token | password | Yes |
Supported tables
| Table | Description | Sync method | Incremental field | Primary key |
|---|---|---|---|---|
shipments | A shipment groups a sender address, a recipient address, and one or more parcels, and is the basis for requesting rates and purchasing labels. Shipments older than 390 days are not returned by the API. | Incremental, Full refresh | object_created | — |
transactions | A transaction is the purchase of a shipping label from a rate — it carries the label URL, tracking number, and tracking status. | Full refresh | — | — |
orders | An order placed in a connected shop app (Shopify, Amazon, eBay, etc.) or created via the API, with line items, totals, and any purchased-label transactions. | Full refresh | — | — |
addresses | A sender or recipient address, including validation results. Addresses are immutable once created. | Full refresh | — | — |
parcels | The physical dimensions and weight of a package to be shipped. Parcels are immutable once created. | Full refresh | — | — |
carrier_accounts | A carrier account connected to Shippo (USPS, FedEx, UPS, etc.) used to retrieve rates and purchase labels. | Full refresh | — | — |
refunds | A request to cancel a purchased shipping label and refund the transaction. | Full refresh | — | — |
customs_items | A distinct item in an international parcel, declared for customs. Customs items are immutable once created. | Full refresh | — | — |
customs_declarations | The customs declaration for an international shipment, referencing the customs items it contains. Customs declarations are immutable once created. | Full refresh | — | — |
Troubleshooting
- If you see an authentication error, your API token is invalid or has been revoked. Generate a new token under Settings → API in the Shippo dashboard, then reconnect.
- Test mode tokens have much lower API rate limits than live tokens, so a large sync using a
shippo_test_token can take noticeably longer.
If your sync is failing or data looks wrong, see the Data warehouse troubleshooting guide. If that doesn't help, contact support – we're happy to help.