Reference

Create Shippo Address

Store sender or recipient addresses in Shippo for use in shipping labels and transactions, with optional carrier validation to ensure delivery accuracy.

Create Merchant Address

Set up a new shipping address for your merchant account, enabling you to ship orders from multiple locations or update your business address on file.

Get Address

Retrieves the complete details of a saved address from your Shippo account using its unique ID. This lets you quickly access stored customer or business addresses without re-entering information.

Get Merchant Address

Retrieves stored merchant address details from your Shippo account using the merchant and address identifiers, allowing you to access and verify your shipping locations.

Create Batch

Create multiple shipping labels at once for bulk orders, saving time and potentially reducing per-label costs by processing shipments together with the same carrier.

Create Merchant Batch

Organize and process multiple shipments together by creating a batch for your merchant account, enabling efficient bulk shipping operations and reduced per-shipment costs.

Get Merchant Batch

Retrieve details about a specific shipment batch you've created, including its status, contents, and shipping information. This helps you track and manage bulk shipping operations efficiently.

Create Carrier Account

Register shipping carrier credentials (like UPS, FedEx, or DHL) with Shippo to enable discounted shipping rates and streamlined label creation for your orders.

Create Merchant Carrier Account

Set up shipping carrier accounts for your business to enable automated label printing and shipment tracking across multiple carriers like FedEx, UPS, and USPS.

Get Carrier Account

Retrieve detailed information about a specific shipping carrier account, including its settings and current status. This helps you verify account configurations and troubleshoot shipping issues.

Get Carrier Registration Status

Check whether your carrier accounts (like USPS, FedEx, or UPS) are properly authenticated and ready to use for shipping. This helps ensure you can actually process shipments without unexpected failures.

Get Merchant Carrier Account

Retrieve detailed information about a specific carrier account linked to your merchant profile, including account settings and carrier details. Use this to verify carrier configurations and access account-specific shipping parameters.

Get Merchant Carrier Registration Status

Check whether your merchant account has successfully registered or connected with a specific carrier, helping you verify your shipping setup is complete and ready to use.

Create Customs Item

Define the contents, value, and origin details of items in your international shipments to meet customs requirements. This ensures smooth customs clearance when shipping products across borders.

Create Merchant Customs Declaration

Creates a customs declaration for international shipments, enabling merchants to properly document goods being shipped across borders.

Create Merchant Customs Item

Create customs declaration items for your international shipments by defining product details like description, quantity, value, and origin country. This helps ensure smooth customs clearance and compliance when shipping products across borders.

Get Customs Declaration

Retrieve detailed information about a specific customs declaration, including itemized goods, certifications, and shipping details for international shipments. Essential for verifying customs documentation accuracy before packages cross borders.

Get customs item

Retrieves details about a specific customs item that you've previously created for international shipments, allowing you to view declared values, descriptions, and quantities for customs compliance.

Get Merchant Customs Declaration

Retrieve detailed information about a specific customs declaration you've created for international shipments, allowing you to verify compliance details and declaration history.

Get Merchant Customs Item

Retrieve details about a specific customs item you've saved for your international shipments, allowing you to access pre-configured product information for cross-border orders.

Create Manifest

Create a shipping manifest document that consolidates multiple shipments for a carrier to scan and process at pickup, streamlining bulk shipping operations.

Get Merchant Manifest

Retrieve detailed information about a shipping manifest you've created, including status, contents, and submission details. This helps you track and verify what has been included in your manifest submission to carriers.

Get Merchant

Retrieve detailed information about a merchant account on the Shippo platform using their unique identifier, allowing you to access account settings and configuration details.

Create Merchant Order

Create a new order in your Shippo merchant account with customer details and shipping information. This enables you to programmatically generate orders that can be tracked and fulfilled through Shippo's platform.

Create Order

Create a new order in Shippo to register shipments for processing with recipient details and tracking information. Use this when you need to set up orders for fulfillment and generate shipping labels.

Get Merchant Order

Retrieve detailed information about a specific customer order from your Shippo account using the merchant and order IDs, allowing you to access order status, items, and shipping details.

Create Parcel

Define package dimensions and weight in Shippo to calculate accurate shipping rates and generate labels for your orders. This creates the parcel specifications needed before you can finalize shipments.

Create Merchant Parcel

Create a new parcel record with specific dimensions and weight for your shipping operations. This lets you standardize package specifications so you can quickly generate accurate shipping quotes and labels.

Create User Parcel Template

Save frequently-used package configurations with preset dimensions and weight so you can quickly generate accurate shipping rates and labels without entering details repeatedly.

Delete Default Parcel Template

Removes your default parcel template configuration, allowing you to reset shipping settings or switch to different packaging standards for your store.

Delete User Parcel Template

Remove a custom parcel template from your shipping configuration when it's no longer needed, helping keep your shipping profiles organized and current.

Get Carrier Parcel Template

Retrieve detailed dimensions and specifications for a standardized carrier package type to ensure accurate shipping cost calculations and proper package sizing. This helps you understand what box sizes and weight limits are available from your chosen carriers.

Get Default Parcel Template

Retrieve your default parcel template settings to understand the standard dimensions and weight specifications used for shipping calculations and checkout displays.

Get Merchant Parcel

Retrieve detailed information about a specific parcel stored in your Shippo account, including dimensions, weight, and packaging details. Use this to verify parcel specifications before shipping or to access parcel data for order fulfillment.

Create Live Rate

Get real-time shipping rates from multiple carriers for a specific shipment based on origin, destination, and package details. This helps you find the cheapest and fastest shipping options before finalizing an order.

Get Merchant Rate

Retrieve detailed shipping rate information for a merchant's shipment, including pricing and carrier details to make informed shipping decisions. This helps you compare costs and service levels before finalizing a shipment.

Create Merchant Refund

Process refunds for shipping transactions directly through your merchant account, enabling you to quickly reverse charges when needed.

Create Refund

Initiate a refund for a previously purchased shipping label or transaction, recovering the shipping costs paid. Use this when a shipment is cancelled, returned, or no longer needed.

Get Merchant Refund

Retrieve detailed information and current status of a specific refund for your shipments, including refund amount, date, and processing status. Use this to track the financial impact of returned orders and verify refund completions.

Create Service Group

Organize your shipping carriers and services into custom groups with specific pricing models to streamline checkout and offer tailored shipping options to customers.

Create Shipment

Creates a new shipment and generates shipping rates by specifying the origin and destination addresses along with package details. This helps you find the most cost-effective shipping options before sending items to customers.

Create Merchant Shipment

Creates a new shipment record with pickup and delivery addresses plus package details, enabling you to retrieve available shipping rates and options for an order.

Get Merchant Shipment

Retrieve detailed information about a specific shipment, including tracking status, carrier information, and delivery updates for your orders.

Get Merchant Tracking Status

Retrieve real-time tracking status and location information for packages shipped through your account, including delivery history and current status. This helps you provide accurate updates to customers and monitor shipment progress.

Register Tracking Webhook

Monitor your shipments in real-time by setting up automatic tracking updates for a package using its carrier and tracking number, so you stay informed when orders arrive at each delivery milestone.

Create Transaction

Purchase a shipping label for your orders by selecting a shipping rate or providing shipment details directly, enabling you to generate carrier-ready labels instantly.

Create Merchant Transaction

Purchase a shipping label for your merchant account by selecting a specific rate quote, enabling you to fulfill orders with tracked shipments.

Get Merchant Transaction

Retrieve detailed information about a specific shipping label transaction, including tracking numbers, label URLs, and current status. This helps you track order fulfillment and provide customers with shipping updates.

Create Shippo Webhook

Set up automated notifications for shipping events like tracking updates and transaction confirmations that are delivered directly to your application in real-time.

Delete Webhook

Remove a webhook from your Shippo account when you no longer need event notifications or want to reconfigure how shipping updates are delivered to your systems.

Get Order

Tool to retrieve an order from Shippo.

Get Parcel

Tool to retrieve a parcel by its ID.

Get Rate

Tool to retrieve a specific shipping rate by its ID.

Get Refund

Tool to retrieve a refund by its ID from Shippo.

Get Shipment

Tool to retrieve a shipment by its ID.

Get Shippo Account

Tool to retrieve a Shippo Account from the Shippo Platform API.

Get Tracking Status

Tool to retrieve tracking status for a shipment from Shippo.

Get Transaction

Tool to retrieve a shipping label transaction by its ID.

Get User Parcel Template

Tool to retrieve a specific user-created parcel template by its object ID.

Get Webhook

Tool to retrieve a specific webhook subscription from Shippo.

List Addresses

Tool to list all addresses in the Shippo account with pagination support.

List Carrier Accounts

Tool to list all carrier accounts configured in the Shippo account with pagination support.

List Carrier Parcel Templates

Tool to list all carrier parcel templates available for creating shipments.

List Customs Declarations

Tool to list all customs declarations in the Shippo account with pagination support.

List Customs Items

Tool to list all customs items with pagination support.

List Manifests

Tool to list all shipping manifests from Shippo.

List Merchant Addresses

Tool to list all addresses for a specific merchant using the Shippo Platform API.

List Merchant Carrier Accounts

Tool to list all carrier accounts for a specific merchant using the Shippo Platform API.

List Merchant Customs Declarations

Tool to list all customs declarations for a specific merchant using the Shippo Platform API.

List Merchant Customs Items

Tool to list all customs items for a specific merchant using the Shippo Platform API.

List Merchant Manifests

Tool to list all manifests for a specific merchant using Shippo's Platform API.

List Merchant Parcels

Tool to list all parcels for a specific merchant using the Shippo Platform API.

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.

List Merchant Shipments

Tool to list all shipments for a specific merchant using Shippo's Platform API.

List Merchant Transactions

Tool to list all shipping label transactions for a merchant using the Shippo Platform API.

List Merchants

Tool to list all merchants using the Shippo Platform API with pagination support.

List Orders

Tool to list all orders in the Shippo account with pagination support.

List Refunds

Tool to retrieve a list of all refunds from Shippo.

List Service Groups

Tool to retrieve all service groups configured in Shippo.

List Shipment Rates

Tool to retrieve available shipping rates for a specific shipment.

List Shipment Rates by Currency

Tool to retrieve available shipping rates for a specific shipment filtered by currency code.

List Shipments

Tool to list all shipments in the Shippo account with pagination support.

List Shippo Accounts

Tool to list all Managed Shippo Accounts.

List User Parcel Templates

Tool to list all user-created parcel templates.

Purchase Merchant Batch

Tool to purchase a batch for a merchant via the Shippo Platform API.

Remove Shipments From Batch

Tool to remove shipments from a batch for a merchant using the Shippo Platform API.

Update Carrier Account

Tool to update an existing carrier account in Shippo.

Update Default Parcel Template

Tool to update the default parcel template for live rates at checkout in Shippo.

Update Merchant

Tool to update an existing merchant in Shippo Platform API.

Update Merchant Carrier Account

Tool to update a carrier account for a merchant in Shippo Platform API.

Update Service Group

Tool to update an existing Shippo service group.

Update User Parcel Template

Tool to update an existing user parcel template with new weight and carrier template settings.

Update Webhook

Tool to update an existing webhook in Shippo.

Validate Address

Tool to validate an address using the Shippo API.

Validate Merchant Address

Tool to validate a merchant address using the Shippo Platform API.