Articles in this section

Available Shippo APIs

When you configure an export, import, or other type of flow step using the prebuilt Shippo connector, you can select any of the API operations listed below, organized by API type.

Note

If your API endpoint isn’t listed here, switch the flow step to HTTP mode and configure the endpoint provided in the Shippo API documentation. You can also create a composite endpoint for this application in HTTP mode.

Resource

API endpoint

Export

Import

Addresses

Create a new address

X

List all addresses

X

Retrieve an address

X

Validate an address

X

Batches

Add shipments to a batch

X

Create a batch

X

Purchase a batch

X

Remove shipments from a batch

X

Retrieve a batch

X

Carrier accounts

Add a Shippo carrier account

X

Connect an existing carrier account using OAuth 2.0

X

Create a new carrier account

X

Get carrier registration status

X

List all carrier accounts

X

Retrieve a carrier account

X

Update a carrier account

X

Carrier parcel templates

List all carrier parcel templates

X

Retrieve a carrier parcel templates

X

Customs declarations

Create a new customs declaration

X

List all customs declarations

X

Retrieve a customs declaration

X

Customs items

Create a new customs item

X

List all customs items

X

Retrieve a customs item

X

Manifests

Create a new manifest

X

List all manifests

X

Retrieve a manifest

X

Orders

Create a new order

X

List all orders

X

Retrieve an order

X

Parcels

Create a new parcel

X

List all parcels

X

Retrieve an existing parcel

X

Pickups

Create a pickup

X

Rates

Retrieve a rate

X

Retrieve shipment rates

X

Retrieve shipment rates in currency

X

Rates at checkout

Clear current default parcel template

X

Generate a live rates request

X

Show current default parcel template

X

Update default parcel template

X

Refunds

Create a refund

X

List all refunds

X

Retrieve a refund

X

Service groups

Create a new service group

X

Delete a service group

X

List all service groups

X

Update an existing service group

X

Shipments

Create a new shipment

X

List all shipments

X

Retrieve a shipment

X

Shippo accounts

Create a Shippo account

X

List all Shippo accounts

X

Retrieve a Shippo account

X

Update a Shippo account

X

Tracking status

Get a tracking status

X

Register a tracking webhook

X

Transactions

Create a shipping label

X

List all shipping labels

X

Retrieve a shipping label

X

User parcel templates

Create a new user parcel template

X

Delete a user parcel template

X

List all user parcel templates

X

Retrieves a user parcel template

X

Update an existing user parcel template

X

Webhooks

Create a new webhook

X

Delete a specific webhook

X

List all webhooks

X

Retrieve a specific webhook

X

Update an existing webhook

X