- Category: ecommerce
- Auth: API_KEY, OAUTH2
- Composio-managed OAuth available? Yes
- Tools: 95
- Triggers: 0
- Slug:
SHIPPO - Version: 20261101_00
Tools
Create Shippo Address
Create Shippo Address
SHIPPO_CREATE_ADDRESSTool 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.Input Parameters
Output
Create Batch
Create Batch
SHIPPO_CREATE_BATCHCreates a batch of shipments for bulk label purchasing using a default carrier account and service level. Batch creation is asynchronous; retrieve the batch later to check shipment validity.Input Parameters
Output
Create Carrier Account
Create Carrier Account
SHIPPO_CREATE_CARRIER_ACCOUNTCreates a carrier account in Shippo to register credentials for shipping operations. The request uses a UPS-specific parameter structure with detailed billing and contact information and UPS terms acceptance.Input Parameters
Output
Create Customs Item
Create Customs Item
SHIPPO_CREATE_CUSTOMS_ITEMCreate 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.Input Parameters
Output
Create Live Rate
Create Live Rate
SHIPPO_CREATE_LIVE_RATERequest checkout shipping options for a destination and line items based on configured service groups. Returns available options with costs and transit estimates when available; an omitted origin address uses the account’s default.Input Parameters
Output
Create Manifest
Create Manifest
SHIPPO_CREATE_MANIFESTCreate a shipping manifest for a carrier account and shipment date, producing a document carriers can scan to accept multiple packages. Specify transaction IDs to include, or omit them to have Shippo automatically assign all applicable transactions. Creation can be requested synchronously or asynchronously.Input Parameters
Output
Create Merchant Address
Create Merchant Address
SHIPPO_CREATE_MERCHANT_ADDRESSTool 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.Input Parameters
Output
Create Merchant Batch
Create Merchant Batch
SHIPPO_CREATE_MERCHANT_BATCHTool 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.Input Parameters
Output
Create Merchant Carrier Account
Create Merchant Carrier Account
SHIPPO_CREATE_MERCHANT_CARRIER_ACCOUNTCreate a carrier account for a merchant using the Shippo Platform API, with UPS-specific credential and billing parameters.Input Parameters
Output
Create Merchant Customs Declaration
Create Merchant Customs Declaration
SHIPPO_CREATE_MERCHANT_CUSTOMS_DECLARATIONTool 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.Input Parameters
Output
Create Merchant Customs Item
Create Merchant Customs Item
SHIPPO_CREATE_MERCHANT_CUSTOMS_ITEMTool 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.Input Parameters
Output
Create Merchant Order
Create Merchant Order
SHIPPO_CREATE_MERCHANT_ORDERTool 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.Input Parameters
Output
Create Merchant Parcel
Create Merchant Parcel
SHIPPO_CREATE_MERCHANT_PARCELTool 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.Input Parameters
Output
Create Merchant Refund
Create Merchant Refund
SHIPPO_CREATE_MERCHANT_REFUNDTool 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.Input Parameters
Output
Create Merchant Shipment
Create Merchant Shipment
SHIPPO_CREATE_MERCHANT_SHIPMENTTool 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.Input Parameters
Output
Create Merchant Transaction
Create Merchant Transaction
SHIPPO_CREATE_MERCHANT_TRANSACTIONTool 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.Input Parameters
Output
Create Order
Create Order
SHIPPO_CREATE_ORDERTool 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.Input Parameters
Output
Create Parcel
Create Parcel
SHIPPO_CREATE_PARCELCreates a Shippo parcel with dimensions and weight for shipping rate calculations or label generation.Input Parameters
Output
Create Refund
Create Refund
SHIPPO_CREATE_REFUNDTool to create a refund for a Shippo transaction. Use when you need to refund a previously created shipping label or transaction.Input Parameters
Output
Create Service Group
Create Service Group
SHIPPO_CREATE_SERVICE_GROUPCreates a Shippo service group for checkout with specified carrier service levels and a pricing model. The tool accepts flat-rate and free-shipping types, but does not accept the live-rate type.Input Parameters
Output
Create Shipment
Create Shipment
SHIPPO_CREATE_SHIPMENTTool 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.Input Parameters
Output
Register Tracking Webhook
Register Tracking Webhook
SHIPPO_CREATE_TRACKTool 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.Input Parameters
Output
Create Transaction
Create Transaction
SHIPPO_CREATE_TRANSACTIONCreate a Shippo transaction to purchase a shipping label using an existing rate ID, or shipment input together with a carrier account and service level token. Purchasable rates must be less than seven days old. The transaction status indicates whether the label was successfully created; a successful transaction can include a label URL and tracking details when available.Input Parameters
Output
Create User Parcel Template
Create User Parcel Template
SHIPPO_CREATE_USER_PARCEL_TEMPLATETool 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.Input Parameters
Output
Create Shippo Webhook
Create Shippo Webhook
SHIPPO_CREATE_WEBHOOKTool 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.Input Parameters
Output
Delete Default Parcel Template
Delete Default Parcel Template
Delete User Parcel Template
Delete User Parcel Template
SHIPPO_DELETE_USER_PARCEL_TEMPLATETool to delete a user-created parcel template. Use when you need to remove a custom parcel template that is no longer needed.Input Parameters
Output
Delete Webhook
Delete Webhook
Get Address
Get Address
Get Carrier Account
Get Carrier Account
Get Carrier Parcel Template
Get Carrier Parcel Template
Get Carrier Registration Status
Get Carrier Registration Status
Get Customs Declaration
Get Customs Declaration
Get customs item
Get customs item
SHIPPO_GET_CUSTOMS_ITEMRetrieve a previously created customs item by its object ID, including its description, quantity, weight, value, and origin.Input Parameters
Output
Get Default Parcel Template
Get Default Parcel Template
SHIPPO_GET_DEFAULT_PARCEL_TEMPLATETool 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.Input Parameters
Output
Get Merchant
Get Merchant
Get Merchant Address
Get Merchant Address
SHIPPO_GET_MERCHANT_ADDRESSTool 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.Input Parameters
Output
Get Merchant Batch
Get Merchant Batch
SHIPPO_GET_MERCHANT_BATCHTool 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.Input Parameters
Output
Get Merchant Carrier Account
Get Merchant Carrier Account
Get Merchant Carrier Registration Status
Get Merchant Carrier Registration Status
SHIPPO_GET_MERCHANT_CARRIER_REGISTRATION_STATUSRetrieves carrier registration status for a merchant through Shippo’s Platform API. Supports UPS, USPS, and Canada Post.Input Parameters
Output
Get Merchant Customs Declaration
Get Merchant Customs Declaration
SHIPPO_GET_MERCHANT_CUSTOMS_DECLARATIONTool 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.Input Parameters
Output
Get Merchant Customs Item
Get Merchant Customs Item
Get Merchant Manifest
Get Merchant Manifest
SHIPPO_GET_MERCHANT_MANIFESTTool 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.Input Parameters
Output
Get Merchant Order
Get Merchant Order
SHIPPO_GET_MERCHANT_ORDERTool 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.Input Parameters
Output
Get Merchant Parcel
Get Merchant Parcel
SHIPPO_GET_MERCHANT_PARCELTool 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.Input Parameters
Output
Get Merchant Rate
Get Merchant Rate
SHIPPO_GET_MERCHANT_RATETool 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.Input Parameters
Output
Get Merchant Refund
Get Merchant Refund
SHIPPO_GET_MERCHANT_REFUNDTool 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.Input Parameters
Output
Get Merchant Shipment
Get Merchant Shipment
SHIPPO_GET_MERCHANT_SHIPMENTTool 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.Input Parameters
Output
Get Merchant Tracking Status
Get Merchant Tracking Status
SHIPPO_GET_MERCHANT_TRACKTool 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.Input Parameters
Output
Get Merchant Transaction
Get Merchant Transaction
SHIPPO_GET_MERCHANT_TRANSACTIONTool 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.Input Parameters
Output
Get Order
Get Order
Get Parcel
Get Parcel
SHIPPO_GET_PARCELRetrieves an existing parcel by object ID, including dimensions, weight and metadata. Parcel IDs associated with unpurchased shipments or rates do not return parcel details.Input Parameters
Output
Get Rate
Get Rate
Get Refund
Get Refund
SHIPPO_GET_REFUNDTool 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.Input Parameters
Output
Get Shipment
Get Shipment
Get Shippo Account
Get Shippo Account
Get Tracking Status
Get Tracking Status
SHIPPO_GET_TRACKTool 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.Input Parameters
Output
Get Transaction
Get Transaction
SHIPPO_GET_TRANSACTIONTool 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.Input Parameters
Output
Get User Parcel Template
Get User Parcel Template
SHIPPO_GET_USER_PARCEL_TEMPLATETool 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.Input Parameters
Output
Get Webhook
Get Webhook
List Addresses
List Addresses
List Carrier Accounts
List Carrier Accounts
List Carrier Parcel Templates
List Carrier Parcel Templates
SHIPPO_LIST_CARRIER_PARCEL_TEMPLATESTool 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.Input Parameters
Output
List Customs Declarations
List Customs Declarations
List Customs Items
List Customs Items
List Manifests
List Manifests
List Merchant Addresses
List Merchant Addresses
List Merchant Carrier Accounts
List Merchant Carrier Accounts
List Merchant Customs Declarations
List Merchant Customs Declarations
List Merchant Customs Items
List Merchant Customs Items
List Merchant Manifests
List Merchant Manifests
SHIPPO_LIST_MERCHANT_MANIFESTSTool 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.Input Parameters
Output
List Merchant Parcels
List Merchant Parcels
List Merchants
List Merchants
List Merchant Shipment Rates by Currency
List Merchant Shipment Rates by Currency
List Merchant Shipments
List Merchant Shipments
SHIPPO_LIST_MERCHANT_SHIPMENTSTool 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.Input Parameters
Output
List Merchant Transactions
List Merchant Transactions
List Orders
List Orders
List Refunds
List Refunds
List Service Groups
List Service Groups
SHIPPO_LIST_SERVICE_GROUPSTool to retrieve all service groups configured in Shippo. Use when you need to view available shipping service groups, their configurations, rates, and service levels.Input Parameters
Output
List Shipment Rates
List Shipment Rates
List Shipment Rates by Currency
List Shipment Rates by Currency
SHIPPO_LIST_SHIPMENT_RATES_BY_CURRENCYRetrieves shipment rates priced in a specified currency; rates for shipments older than 390 days are not returned. Requesting a different currency re-queues the shipment, and converted rates become available when its status is SUCCESS.Input Parameters
Output
List Shipments
List Shipments
List Shippo Accounts
List Shippo Accounts
List User Parcel Templates
List User Parcel Templates
SHIPPO_LIST_USER_PARCEL_TEMPLATESTool to list all user-created parcel templates. Use when you need to retrieve custom parcel dimensions and configurations that were created by the user.Input Parameters
Output
Purchase Merchant Batch
Purchase Merchant Batch
SHIPPO_PURCHASE_MERCHANT_BATCHTool 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.Input Parameters
Output
Remove Shipments From Batch
Remove Shipments From Batch
SHIPPO_REMOVE_SHIPMENTS_FROM_BATCHTool 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.Input Parameters
Output
Update Carrier Account
Update Carrier Account
SHIPPO_UPDATE_CARRIER_ACCOUNTTool 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.Input Parameters
Output
Update Default Parcel Template
Update Default Parcel Template
SHIPPO_UPDATE_DEFAULT_PARCEL_TEMPLATETool 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.Input Parameters
Output
Update Merchant
Update Merchant
Update Merchant Carrier Account
Update Merchant Carrier Account
SHIPPO_UPDATE_MERCHANT_CARRIER_ACCOUNTUpdates a merchant’s carrier account through the Shippo Platform API, including activation status and UPS-specific billing and account parameters. The request requires a full set of UPS-style account parameters.Input Parameters
Output
Update Service Group
Update Service Group
Update User Parcel Template
Update User Parcel Template
SHIPPO_UPDATE_USER_PARCEL_TEMPLATESubmit an update to a user parcel template by ID with a carrier template token and weight settings. The request does not supply the name and dimensions required by Shippo’s documented update schema, so it may be rejected.Input Parameters
Output
Update Webhook
Update Webhook
SHIPPO_UPDATE_WEBHOOKUpdate an existing Shippo webhook by ID, supplying its event type, URL, activation status, and test mode together.Input Parameters
Output
Validate Address
Validate Address
SHIPPO_VALIDATE_ADDRESSValidate an existing Shippo address by its object ID, returning address details and validation results. Use to check a shipping address before creating a shipment.Input Parameters
Output
Validate Merchant Address
Validate Merchant Address
SHIPPO_VALIDATE_MERCHANT_ADDRESSTool 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.