Skip to main content
Shippo
Previewv0.1.0
71 actions · 3 events · 2 auth methods

Getting Started

1

Create or Select a Project

Set up a new project or select an existing one. See Organizations & Projects.
2

Configure the Connector

Enable the connector and set up a Connector Profile in your project. See Setup Connector Profile.

Connector Profile · API Key

Uses a Shippo API token sent in the Authorization header with the ShippoToken scheme. Live and test tokens are generated…

Connector Profile · OAuth 2.0

OAuth 2.0 authorization-code flow for Shippo platform apps. The access token is non-expiring, so no re-authentication is…
3

Link an Account

Link an account from the dashboard (or via StackOne Hub).See the guide for the authentication type chosen in the Connector Profile:

Link Account · API Key

Link Account · OAuth 2.0

4

Use Actions

Connect an AI platform to the linked account’s actions. See AI Platforms.Other ways to call actions are listed in Protocols & SDKs.

Actions

|
71 actions
Action
Description
List Addresses
List the addresses in your Shippo account.
Create Address
Create a new address in your Shippo account.
Get Address
Retrieve a single address by its Shippo object ID.
Validate Address
Validate an address against carrier databases.
Create Batch
Create a new batch in your Shippo account.
Get Batch
Retrieve a single batch by its Shippo object ID.
Add Shipments To Batch
Add shipments to an existing batch.
Remove Shipments From Batch
Remove shipments from an existing batch.
Purchase Batch
Purchase all labels in a batch.
List Carrier Accounts
List the carrier accounts in your Shippo account.
Create Carrier Account
Create a new carrier account in your Shippo account.
Get Carrier Account
Retrieve a single carrier account by its Shippo object ID.
Update Carrier Account
Update an existing carrier account by its Shippo object ID.
Register Carrier Account
Register a new carrier account with your own carrier credentials.
Get Carrier Registration Status
Check the registration status of a carrier for your account.
Initiate Carrier OAuth Sign-in
Start the OAuth sign-in flow for a carrier account.
List Customs Declarations
List the customs declarations in your Shippo account.
Create Customs Declaration
Create a new customs declaration in your Shippo account.
Get Customs Declaration
Retrieve a single customs declaration by its Shippo object ID.
List Customs Items
List the customs items in your Shippo account.
Create Customs Item
Create a new customs item in your Shippo account.
Get Customs Item
Retrieve a single customs item by its Shippo object ID.
Create Embedded Authorization
Create a scoped embedded authorization token in your Shippo account.
Create Live Rate
Fetch live checkout rates for a cart in your Shippo account.
Get Default Parcel Template
Show the current default parcel template used for live checkout rates.
Update Default Parcel Template
Set the default parcel template used for live checkout rates.
Delete Default Parcel Template
Clear the default parcel template used for live checkout rates.
List Manifests
List the manifests in your Shippo account.
Create Manifest
Create a new manifest in your Shippo account.
Get Manifest
Retrieve a single manifest by its Shippo object ID.
List Orders
List the orders in your Shippo account.
Create Order
Create a new order in your Shippo account.
Get Order
Retrieve a single order by its Shippo object ID.
List Carrier Parcel Templates
List the carrier parcel templates available in your Shippo account.
Get Carrier Parcel Template
Retrieve a single carrier parcel template by its token.
List Parcels
List the parcels in your Shippo account.
Create Parcel
Create a new parcel in your Shippo account.
Get Parcel
Retrieve a single parcel by its Shippo object ID.
Create Pickup
Create a new pickup in your Shippo account.
List Shipment Rates
List the rates in your Shippo account.
List Shipment Rates By Currency Code
List the rates in your Shippo account.
Get Rate
Retrieve a single rate by its Shippo object ID.
Create Refund
Create a new refund in your Shippo account.
List Refunds
List the refunds in your Shippo account.
Get Refund
Retrieve a single refund by its Shippo object ID.
List Service Groups
List the service groups in your Shippo account.
Create Service Group
Create a new service group in your Shippo account.
Update Service Group
Update an existing service group in your Shippo account.
Delete Service Group
Delete a service group by its Shippo object ID.
List Shipments
List the shipments in your Shippo account.
Create Shipment
Create a new shipment in your Shippo account.
Get Shipment
Retrieve a single shipment by its Shippo object ID.
List Shippo Accounts
List the managed Shippo accounts under your platform account.
Create Shippo Account
Create a new managed Shippo account under your platform account.
Get Shippo Account
Retrieve a single managed Shippo account by its object ID.
Update Shippo Account
Update an existing managed Shippo account.
Create Track
Register a tracking number for status updates.
Get Track
Get the current tracking status for a shipment.
List Transactions
List the transactions in your Shippo account.
Create Transaction
Create a new transaction (shipping label) in your Shippo account.
Get Transaction
Retrieve a single transaction (shipping label) by its Shippo object ID.
List User Parcel Templates
List the saved user parcel templates in your Shippo account.
Create User Parcel Template
Create a new saved user parcel template in your Shippo account.
Get User Parcel Template
Retrieve a single user parcel template by its Shippo object ID.
Update User Parcel Template
Update an existing user parcel template.
Delete User Parcel Template
Delete a user parcel template by its Shippo object ID.
List Webhooks
List the webhook subscriptions in your Shippo account.
Create Webhook
Create a new webhook subscription in your Shippo account.
Get Webhook
Retrieve a single webhook subscription by its object ID.
Update Webhook
Update an existing webhook subscription.
Delete Webhook
Delete a webhook subscription by its object ID.

Events

|
3 events
Event
Description
Tags
Transaction Created
Emitted when a transaction (shipping label) is created in Shippo. Maps to the Shippo webhook event transaction_created…
TransactionsWebhooks
Transaction Updated
Emitted when a transaction (shipping label) is updated in Shippo, for example when an asynchronous label finishes proces…
TransactionsWebhooks
Track Updated
Emitted when the tracking status of a shipment changes in Shippo. Maps to the Shippo webhook event track_updated. The…
TrackingWebhooks