Shipping API for e-commerce merchants to create labels, track packages, and manage shipping operations.
Toolkit · shippo
v1
01Create Batchtool
02Create Carrier Accounttool
03Create Customs Itemtool
04Create Live Ratetool
API Key · verified
95T · 0TR
shippo
Supported tools and triggers
Each tool is a typed function your agent can call. Each trigger fires an agent run when something changes upstream.
Create Batch
Tool to create a batch of shipments for bulk label purchasing. Use when you need to process multiple shipments at once with the same carrier and service level. Requires a valid carrier account ID from your Shippo account.
TOOL
Create Carrier Account
Tool to create a new carrier account in Shippo. Use when you need to register carrier credentials for shipping operations. This action requires detailed billing and contact information, and for UPS accounts specifically, the user must agree to UPS terms and conditions.
TOOL
Create Customs Item
Create a new customs item for international shipments. Customs items are required for customs declarations when shipping internationally. Use this action to define the contents, value, and origin of items being shipped across international borders.
TOOL
Create Live Rate
Tool to generate live shipping rates from multiple carriers for a given shipment. Use when you need real-time pricing for shipping from origin to destination with specific items. Returns available rates with costs and delivery estimates.
TOOL
Create Manifest
Tool to create a new shipping manifest with Shippo. Use when you need to generate a manifest document for a carrier with multiple shipments that need to be scanned at pickup.
TOOL
Create Merchant Address
Tool to create a new address for a merchant using Shippo's Platform API. Use when you need to add an address to a merchant's account for shipping operations. This endpoint is part of the Platform API and requires a merchant ID.
TOOL
Create Merchant Batch
Tool to create a batch for a merchant using the Shippo Platform API. Use when you need to create bulk shipment batches for a specific merchant account. Requires valid merchant ID, carrier account, and shipment IDs.
TOOL
Create Merchant Carrier Account
Tool to create a carrier account for a merchant using the Shippo Platform API. Use when you need to register carrier credentials for a specific merchant in a platform integration scenario.
TOOL
Create Merchant Customs Declaration
Tool to create a new customs declaration for a merchant using Shippo's Platform API. Use when you need to create a customs declaration for international shipments on behalf of a merchant. This endpoint is part of the Platform API and requires a merchant ID.
TOOL
Create Merchant Customs Item
Tool to create a new customs item for a merchant using Shippo's Platform API. Use when you need to create customs items for a merchant's international shipments. This endpoint is part of the Platform API and requires a merchant ID.
TOOL
Create Merchant Order
Tool to create an order for a merchant using the Shippo Platform API. Use when you need to create an order on behalf of a merchant account with recipient address and order details.
TOOL
Create Merchant Parcel
Tool to create a new parcel for a merchant using Shippo's Platform API. Use when you need to define package dimensions for a merchant's shipping operations. This endpoint is part of the Platform API and requires a merchant ID.
TOOL
Create Merchant Refund
Tool to create a refund for a merchant using the Shippo Platform API. Use when you need to refund a transaction for a specific merchant account. Requires valid merchant ID and transaction ID.
TOOL
Create Merchant Shipment
Tool to create a new shipment for a merchant using Shippo's Platform API. Use when you need to create a shipment with origin/destination addresses and parcel details to get shipping rates. This endpoint is part of the Platform API and requires a merchant ID.
TOOL
Create Merchant Transaction
Tool to create a shipping label transaction for a merchant using the Shippo Platform API. Use when you need to purchase a shipping label for a specific merchant account using an existing rate ID.
TOOL
Create Order
Tool to create a new order in Shippo. Use when you need to register an order for shipment processing. The order must include a recipient address and placement timestamp. Line items can be provided for detailed tracking, or a total weight can be specified.
TOOL
Create Parcel
Tool to create a new parcel in Shippo with dimensions and weight specifications. Use when you need to define package dimensions for shipping rate calculations or label generation. The parcel object is required to create shipments and obtain shipping rates.
TOOL
Create Refund
Tool to create a refund for a Shippo transaction. Use when you need to refund a previously created shipping label or transaction.
TOOL
Create Service Group
Tool to create a new Shippo service group with specified pricing model and carrier service levels. Use when you need to configure a custom shipping rate group for checkout display.
TOOL
Create Shipment
Tool to create a new shipment with Shippo. Use when you need to generate shipping rates for a package by providing origin and destination addresses and parcel details.
TOOL
Create Shippo Address
Tool to create a new address in Shippo. Use when you need to store sender or recipient addresses for shipping labels and transactions. Addresses can be validated against carrier databases before creation by setting validate=true.
TOOL
Create Shippo Webhook
Tool to create a new webhook subscription in Shippo. Use when you need to register an endpoint to receive real-time notifications for shipping events such as tracking updates, transaction creation, or batch processing. Webhooks enable automated workflows by pushing event data to your application as events occur.
TOOL
Create Transaction
Tool to create a shipping label transaction with Shippo. Use when you need to purchase a shipping label either from an existing rate ID or by specifying shipment details directly.
TOOL
Create User Parcel Template
Tool to create a new user parcel template in Shippo with preset dimensions and weight specifications. Use when you need to define reusable package configurations for shipping rate calculations or label generation. User parcel templates can be based on carrier templates with custom weights.
TOOL
Delete Default Parcel Template
Tool to clear the current default parcel template. Use when you need to remove the default parcel template configuration for live rates at checkout.
TOOL
Delete User Parcel Template
Tool to delete a user-created parcel template. Use when you need to remove a custom parcel template that is no longer needed.
TOOL
Delete Webhook
Tool to delete a specific webhook from Shippo. Use when you need to remove a webhook that is no longer needed or needs to be reconfigured.
TOOL
Get Address
Tool to retrieve a previously created address from Shippo. Use when you need to get the details of an existing address using its object ID.
TOOL
Get Carrier Account
Tool to retrieve a carrier account by its ID. Use when you need to get details about a specific carrier account configuration.
TOOL
Get Carrier Parcel Template
Tool to retrieve a specific carrier parcel template by its token. Use when you need to get detailed dimensions and specifications for a standardized carrier package type.
TOOL
Get Carrier Registration Status
Tool to retrieve carrier registration status from Shippo. Use when you need to check the registration or authentication status of a carrier account.
TOOL
Get Customs Declaration
Tool to retrieve a customs declaration by its ID. Use when you need to fetch details about a specific customs declaration including items, certifications, and shipping information.
TOOL
Get customs item
Tool to retrieve a customs item from Shippo. Use when you need to fetch details about a previously created customs declaration for international shipments.
TOOL
Get Default Parcel Template
Tool to retrieve the current default parcel template for live rates at checkout. Use when you need to view the default parcel dimensions and weight settings.
TOOL
Get Merchant
Tool to retrieve a merchant from the Shippo Platform API. Use when you need to get the details of an existing merchant using their object ID.
TOOL
Get Merchant Address
Tool to retrieve a merchant address from Shippo Platform API. Use when you need to get the details of an existing merchant address using merchant ID and address ID.
TOOL
Get Merchant Batch
Tool to retrieve a batch for a merchant from the Shippo Platform API. Use when you need to get details of an existing batch using merchant and batch IDs.
TOOL
Get Merchant Carrier Account
Tool to retrieve a carrier account for a merchant using the Shippo Platform API. Use when you need to get details about a specific carrier account associated with a merchant on the platform.
TOOL
Get Merchant Carrier Registration Status
Tool to retrieve carrier registration status for a specific merchant using Shippo's Platform API. Use when you need to check if a merchant has registered or connected a carrier account.
TOOL
Get Merchant Customs Declaration
Tool to retrieve a specific customs declaration for a merchant using Shippo's Platform API. Use when you need to fetch details about a merchant's customs declaration for international shipments.
TOOL
Get Merchant Customs Item
Tool to retrieve a customs item for a merchant using the Shippo Platform API. Use when you need to fetch details about a specific customs item for a merchant's international shipments.
TOOL
Get Merchant Manifest
Tool to retrieve a manifest for a merchant from the Shippo Platform API. Use when you need to get details of an existing manifest using merchant and manifest IDs.
TOOL
Get Merchant Order
Tool to retrieve an order for a merchant from the Shippo Platform API. Use when you need to get details of an existing order using merchant and order IDs.
TOOL
Get Merchant Parcel
Tool to retrieve a parcel for a merchant from the Shippo Platform API. Use when you need to fetch details of a parcel that belongs to a specific merchant.
TOOL
Get Merchant Rate
Tool to retrieve a specific shipping rate for a merchant using the Shippo Platform API. Use when you need to fetch detailed rate information for a merchant's shipment, including pricing, carrier details, and service level.
TOOL
Get Merchant Refund
Tool to retrieve a merchant refund from Shippo Platform API. Use when you need to get the details or status of a specific refund for a merchant.
TOOL
Get Merchant Shipment
Tool to retrieve a shipment for a merchant from the Shippo Platform API. Use when you need to fetch details of a shipment that belongs to a specific merchant.
TOOL
Get Merchant Tracking Status
Tool to retrieve tracking status for a merchant from Shippo Platform API. Use when you need to get the current status, location, and history of a package for a specific merchant using carrier and tracking number.
TOOL
Get Merchant Transaction
Tool to retrieve a shipping label transaction for a merchant from the Shippo Platform API. Use when you need to get the details of an existing transaction for a merchant including tracking information, label URLs, and transaction status.
TOOL
Get Order
Tool to retrieve an order from Shippo. Use when you need to fetch details about a specific order including shipping addresses, line items, and transactions.
TOOL
Get Parcel
Tool to retrieve a parcel by its ID. Use when you need to fetch details of an existing parcel object including dimensions, weight, and metadata.
TOOL
Get Rate
Tool to retrieve a specific shipping rate by its ID. Use when you need to fetch detailed rate information including pricing, carrier details, and service level.
TOOL
Get Refund
Tool to retrieve a refund by its ID from Shippo. Use when you need to check the status or details of a specific refund transaction. Requires the refund_id which is obtained when creating a refund.
TOOL
Get Shipment
Tool to retrieve a shipment by its ID. Use when you need to fetch details about a specific shipment including addresses, parcels, rates, and status.
TOOL
Get Shippo Account
Tool to retrieve a Shippo Account from the Shippo Platform API. Use when you need to get the details of an existing Shippo Account using its object ID.
TOOL
Get Tracking Status
Tool to retrieve tracking status for a shipment from Shippo. Use when you need to get the current status, location, and history of a package using its carrier and tracking number.
TOOL
Get Transaction
Tool to retrieve a shipping label transaction by its ID. Use when you need to get the details of an existing transaction including tracking information, label URLs, and transaction status.
TOOL
Get User Parcel Template
Tool to retrieve a specific user-created parcel template by its object ID. Use when you need to get dimensions and specifications for a custom parcel template.
TOOL
Get Webhook
Tool to retrieve a specific webhook subscription from Shippo. Use when you need to get the details of an existing webhook using its object ID.
TOOL
List Addresses
Tool to list all addresses in the Shippo account with pagination support. Use when you need to retrieve stored addresses for shipment creation or management.
TOOL
List Carrier Accounts
Tool to list all carrier accounts configured in the Shippo account with pagination support. Use when you need to retrieve carrier accounts for shipment creation or management.
TOOL
List Carrier Parcel Templates
Tool to list all carrier parcel templates available for creating shipments. Use when you need to retrieve standardized parcel dimensions provided by carriers like FedEx, USPS, UPS, etc.
TOOL
List Customs Declarations
Tool to list all customs declarations in the Shippo account with pagination support. Use when you need to retrieve customs declarations for international shipments.
TOOL
List Customs Items
Tool to list all customs items with pagination support. Use when you need to retrieve customs declarations for international shipments.
TOOL
List Manifests
Tool to list all shipping manifests from Shippo. Use when you need to retrieve a paginated list of manifests with optional filtering by page number and results per page.
TOOL
List Merchant Addresses
Tool to list all addresses for a specific merchant using the Shippo Platform API. Use when you need to retrieve merchant addresses with pagination support.
TOOL
List Merchant Carrier Accounts
Tool to list all carrier accounts for a specific merchant using the Shippo Platform API. Use when you need to retrieve carrier accounts configured for a merchant in a platform context.
TOOL
List Merchant Customs Declarations
Tool to list all customs declarations for a specific merchant using the Shippo Platform API. Use when you need to retrieve merchant customs declarations for international shipments.
TOOL
List Merchant Customs Items
Tool to list all customs items for a specific merchant using the Shippo Platform API. Use when you need to retrieve merchant customs items for international shipments.
TOOL
List Merchant Manifests
Tool to list all manifests for a specific merchant using Shippo's Platform API. Use when you need to retrieve manifests for a merchant account with optional pagination.
TOOL
List Merchant Parcels
Tool to list all parcels for a specific merchant using the Shippo Platform API. Use when you need to retrieve merchant parcels with pagination support.
TOOL
List Merchant Shipment Rates by Currency
Tool to retrieve available shipping rates for a merchant's shipment filtered by currency code using the Shippo Platform API. Use when you need to compare carrier pricing in a specific currency for a merchant's shipment.
TOOL
List Merchant Shipments
Tool to list all shipments for a specific merchant using Shippo's Platform API. Use when you need to retrieve shipments for a merchant account with optional pagination.
TOOL
List Merchant Transactions
Tool to list all shipping label transactions for a merchant using the Shippo Platform API. Use when you need to retrieve shipping labels created for a specific merchant with pagination support.
TOOL
List Merchants
Tool to list all merchants using the Shippo Platform API with pagination support. Use when you need to retrieve merchant accounts in a platform context.
TOOL
List Orders
Tool to list all orders in the Shippo account with pagination support. Use when you need to retrieve customer orders for creating shipments or managing order fulfillment.
TOOL
List Refunds
Tool to retrieve a list of all refunds from Shippo. Use when you need to view refund history, check refund statuses, or audit reimbursements for unused shipping labels. Supports pagination for large result sets.
TOOL
List Service Groups
Tool to retrieve all service groups configured in Shippo. Use when you need to view available shipping service groups, their configurations, rates, and service levels.
TOOL
List Shipment Rates
Tool to retrieve available shipping rates for a specific shipment. Use when you need to compare carrier pricing and service options for a shipment.
TOOL
List Shipment Rates by Currency
Tool to retrieve available shipping rates for a specific shipment filtered by currency code. Use when you need to compare carrier pricing in a specific currency (e.g., USD, EUR, GBP).
TOOL
List Shipments
Tool to list all shipments in the Shippo account with pagination support. Use when you need to retrieve shipment records, check shipment status, or manage shipping operations.
TOOL
List Shippo Accounts
Tool to list all Managed Shippo Accounts. Use when you need to retrieve all Shippo Accounts associated with your platform account. Supports pagination for large result sets.
TOOL
List User Parcel Templates
Tool to list all user-created parcel templates. Use when you need to retrieve custom parcel dimensions and configurations that were created by the user.
TOOL
Purchase Merchant Batch
Tool to purchase a batch for a merchant via the Shippo Platform API. Use when you need to purchase a previously created batch of shipments. The batch must be in VALID status before it can be purchased.
TOOL
Register Tracking Webhook
Tool to register a tracking webhook for a shipment. Use when you need to start tracking a shipment using its carrier and tracking number. This creates a tracking object that will receive updates about the shipment's status and location.
TOOL
Remove Shipments From Batch
Tool to remove shipments from a batch for a merchant using the Shippo Platform API. Use when you need to remove one or more shipments from an existing batch before purchase or during batch management.
TOOL
Update Carrier Account
Tool to update an existing carrier account in Shippo. Use when you need to modify carrier account settings such as activation status, account credentials, or carrier-specific parameters.
TOOL
Update Default Parcel Template
Tool to update the default parcel template for live rates at checkout in Shippo. Use when you need to set a specific parcel template as the default for calculating shipping rates.
TOOL
Update Merchant
Tool to update an existing merchant in Shippo Platform API. Use when you need to modify merchant details such as name, email, or business information. This action requires Platform API authentication.
TOOL
Update Merchant Carrier Account
Tool to update a carrier account for a merchant in Shippo Platform API. Use when you need to modify merchant carrier account settings such as activation status, billing address, or UPS-specific parameters. Requires Platform API authentication with merchant context.
TOOL
Update Service Group
Tool to update an existing Shippo service group. Use when you need to modify service group details such as name, description, rate adjustment, or service levels.
TOOL
Update User Parcel Template
Tool to update an existing user parcel template with new weight and carrier template settings. Use when you need to modify the dimensions or weight of a previously created custom parcel template.
TOOL
Update Webhook
Tool to update an existing webhook in Shippo. Use when you need to modify webhook settings such as the event type, URL endpoint, activation status, or test mode flag.
TOOL
Validate Address
Tool to validate an address using the Shippo API. Use when you need to verify that a shipping address is valid and complete before creating a shipment.
TOOL
Validate Merchant Address
Tool to validate a merchant address using the Shippo Platform API. Use when you need to verify that a merchant's shipping address is valid and complete.