Skip to main content
Shippo logo
  • Category: ecommerce
  • Auth: API_KEY, OAUTH2
  • Composio-managed OAuth available? Yes
  • Tools: 95
  • Triggers: 0
  • Slug: SHIPPO
  • Version: 20261101_00

Tools

Slug: 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

string
required
ZIP or postal code. Format varies by country (e.g., 94105 for US, SW1A 1AA for UK).
string
required
City name for the address. Required for most countries.
string
required
Full name of the person or business at this address. Required for shipping labels.
string
Contact email address. Used for shipping notifications and updates.
string
Contact phone number including country code. Format: +[country code] [number]. Recommended for delivery notifications.
string
required
State, province, or region code. Use 2-letter state codes for US addresses (e.g., CA, NY). Required for countries with states/provinces.
string
Company or business name if this is a commercial address.
string
required
2-letter ISO country code (e.g., US, GB, CA). Required field for all addresses.
string
required
Primary street address line. Required field for all addresses.
string
Secondary street address line for apartment, suite, or unit numbers.
string
Third street address line for additional address details if needed.
string
Custom metadata string to attach to this address for your own reference. Maximum 100 characters.
boolean
Set to true to validate the address with the carrier before creating. Recommended to catch address errors early.
string
Street number for countries that separate street number from street name.
boolean
Set to true if this is a residential address, false for commercial. Affects shipping rates and delivery options.
string
String used to pick a non-default API version to use. Leave empty to use the default version.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Custom metadata string for the batch (max 100 characters)
string
Format for the shipping label (e.g., ‘PDF’, ‘PNG’, ‘ZPLII’). If not specified, defaults to PDF.
array
required
List of shipments to include in the batch. Each shipment must contain address_from, address_to, and parcels.
string
String used to pick a non-default API version to use
string
required
Object ID of the carrier account to use for batch shipments. Must be a valid carrier account ID from /carrier_accounts endpoint.
string
required
Service level token for the shipment (e.g., ‘usps_priority’, ‘canada_post_expedited_parcel’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

boolean
Whether this is a test account.
boolean
required
Whether the carrier account is active.
string
required
The carrier name to create an account for, e.g., ‘ups’.
string
Optional metadata string to associate with the carrier account.
string
required
Account identifier used to reference this carrier account. Must not be blank.
object
required
Carrier-specific parameters required for account creation. For UPS, this includes billing address, contact information, and invoice details.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Custom metadata string for storing additional information about the customs item.
integer
required
Quantity of this item in the shipment. Must be a positive integer.
string
Stock Keeping Unit code or product identifier for inventory tracking.
string
required
Unit of measurement for the weight. Common values: ‘lb’ (pounds), ‘kg’ (kilograms), ‘oz’ (ounces), ‘g’ (grams).
string
Export Control Classification Number (ECCN) or EAR99 designation for export control purposes.
string
required
Net weight of the item (total weight for all units). Numeric string value.
string
required
Text description of the item being shipped for customs purposes.
string
required
Monetary value of the item. Numeric string with up to 2 decimal places.
string
Harmonized Tariff Schedule (HTS) code for the item. Used for customs classification.
string
required
Two-letter ISO 3166-1 alpha-2 country code of the item’s origin country.
string
required
Three-letter ISO 4217 currency code for the item value.
string
Optional API version to use for this request. If not specified, uses the default API version.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
Array of parcel objects or parcel template IDs. If not provided, dimensions are calculated from line items.
string
required
Destination address - either an address object ID string or a full address object
array
required
Array of line item objects describing what is being shipped. At least one item is required.
string
Origin address - either an address object ID string or a full address object. If not provided, uses default address from account settings.
string
String used to pick a non-default API version to use

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Object ID of the address the manifest will be sent from. Must be a valid address object ID.
array
List of transaction object IDs to be included in the manifest. Each ID must be a valid transaction object ID.
string
required
Date and time of the shipment in ISO 8601 format. This is the date that will be printed on the manifest.
boolean
If true, the manifest will be created asynchronously. If false or not specified, it will be created synchronously.
string
required
Object ID of the carrier account to be used for this manifest. Must be a valid carrier account object ID.
string
String used to pick a non-default API version to use for this request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
ZIP or postal code. Format varies by country (e.g., 94117 for US, SW1A 1AA for UK). Required for purchase.
string
required
City name for the address. Required for purchase.
string
required
Full name of the person or business at this address. Required for purchase.
string
Contact email address. Used for notifications and updates.
string
Contact phone number including country code. Format: +[country code] [number].
string
State, province, or region code. Use 2-letter state codes for US addresses (e.g., CA, NY). Required for purchase for some countries.
string
Company or business name if this is a commercial address.
string
required
2-letter ISO country code (e.g., US, GB, CA). Required field for all addresses.
string
required
Primary street address line. Required for purchase.
string
Secondary street address line for apartment, suite, or unit numbers.
string
Custom metadata string to attach to this address for your own reference.
boolean
Set to true to validate the address with the carrier before creating. Recommended to catch address errors early.
string
required
Object ID of the merchant to create the address for. This is the merchant’s unique identifier in Shippo’s system.
boolean
Set to true if this is a residential address, false for commercial. Affects shipping rates and delivery options.
string
String used to pick a non-default API version to use. Leave empty to use the default version.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Custom metadata string to attach to the batch for your reference (max 100 characters).
string
required
Object ID of the merchant for whom to create the batch. This identifies which merchant account the batch belongs to.
string ("PNG" | "PNG_2.3x7.5" | "PDF" | "PDF_2.3x7.5" | "PDF_4x6" | "PDF_4x8" | "PDF_A4" | "PDF_A6" | "ZPLII")
Label file format options.
array
required
Array of BatchShipment objects containing shipment IDs to include in this batch. The response maintains the same order as the request array.
string
String used to pick a non-default API version to use. If not specified, the default API version will be used.
string
required
ID of the Carrier Account object to use as the default for all shipments in this batch. The carrier account can be overridden on a per-shipment basis.
string
required
Token of the service level to use as the default for all shipments in this batch (e.g., ‘usps_priority’, ‘usps_ground_advantage’). Can be overridden per shipment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

boolean
Whether this is a test account.
boolean
required
Whether the carrier account is active.
string
required
The carrier name to create an account for (e.g., ‘ups’).
string
Optional metadata string to associate with the carrier account.
string
required
Account identifier. This field is required as input to the API, but is not used for UPS. Use the empty string for UPS.
object
required
Carrier-specific parameters required for account creation. For UPS, this includes billing address, contact information, and invoice details.
string
required
Object ID of the merchant to create a carrier account for.
string
String used to pick a non-default API version to use. If not specified, the default API version will be used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

boolean
Indicates whether to create this in test mode. Use true for testing without affecting production data. Optional field.
array
required
Array of customs items included in this declaration. At least one item is required.
string
Additional notes or instructions to be included in the customs declaration. Optional field.
string
AES / ITN (Automated Export System / Internal Transaction Number) reference. Required if eel_pfc is ‘AES_ITN’. Optional otherwise.
boolean
required
Expresses that the certify_signer has provided all information of the customs declaration truthfully. Required field.
string
Export information - EEL (Exemption and Exclusion Legend) or PFC (Proof of Filing Citation) code. Optional field.
string
Invoice reference number of the shipment. Optional field.
string
Export license reference of the shipment. Optional field.
string
The incoterm reference of the shipment. Optional field.
string
Custom metadata string, up to 100 characters. Use for storing your own reference data. Optional field.
string
Disclaimer for the shipment and customs information. Optional field.
string
B13A number (Proof of Report, Summary ID, or Exemption Number). Must be provided if and only if b13a_filing_option is provided.
string
Certificate reference of the shipment. Optional field.
string
required
Object ID of the merchant to create the customs declaration for. This is the merchant’s unique identifier in Shippo’s system.
string ("DOCUMENTS" | "GIFT" | "SAMPLE" | "MERCHANDISE" | "HUMANITARIAN_DONATION" | "RETURN_MERCHANDISE" | "OTHER")
required
Type of contents being shipped. Required field. Valid values: DOCUMENTS, GIFT, SAMPLE, MERCHANDISE, HUMANITARIAN_DONATION, RETURN_MERCHANDISE, OTHER.
string
required
Name of the person responsible for the validity of all information provided in the customs declaration. Required field.
string
B13A filing option for Canadian exports. Optional field.
string
Commercial invoice reference. Optional field.
string
Exporter reference of an export shipment. Optional field.
string
Importer reference of an import shipment. Optional field.
string
String used to pick a non-default API version to use. Leave empty to use the default version.
string ("ABANDON" | "RETURN")
required
Action to take if delivery fails. Required field. Valid values: ‘RETURN’ (return to sender), ‘ABANDON’ (dispose of package).
string
Explanation of the type of goods being shipped. Required if contents_type is ‘OTHER’. Optional otherwise.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Custom metadata string for storing additional information about the customs item. Optional field.
integer
required
Quantity of this item in the shipment. Must be a positive integer. Required field.
string
The stock keeping unit value of this item. Optional field for inventory tracking.
string ("g" | "kg" | "lb" | "oz")
required
Unit of measurement for the weight. Required field. Valid values: ‘g’ (grams), ‘kg’ (kilograms), ‘lb’ (pounds), ‘oz’ (ounces).
string
Export Control Classification Number (ECCN) or EAR99 designation for export control purposes. Optional field.
string
required
Net weight of the item (total weight for all units). Numeric string value. Required field.
string
required
Text description of the item being shipped for customs purposes. Required field.
string
required
Object ID of the merchant to create the customs item for. This is the merchant’s unique identifier in Shippo’s system.
string
required
Monetary value of the item. Numeric string with up to 2 decimal places. Required field.
string
Harmonized Tariff Schedule (HTS) code for the item. Used for customs classification. Optional field.
string
required
Two-letter ISO 3166-1 alpha-2 country code of the item’s origin country. Required field.
string
required
Three-letter ISO 4217 currency code for the item value. Required field.
string
String used to pick a non-default API version to use. Leave empty to use the default version.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Custom buyer- or seller-provided notes about the order.
string
required
Total weight of the order.
string
Currency of the total_price and total_tax amounts. Required if total_price is provided.
string
required
ISO 8601 timestamp when the order was placed by the customer (e.g., ‘2026-02-12T15:30:00Z’).
string
Total tax amount paid by the buyer for this order.
array
Array of line item objects representing the items in this order.
object
required
Recipient shipping address for the order. Must include name, street, city, state, zip, and country.
string
required
Object ID of the merchant for whom to create the order. This identifies which merchant account the order belongs to.
string
Total amount paid by the buyer for this order.
string ("lb" | "oz" | "g" | "kg")
required
Unit of weight measurement for the order (lb, oz, g, kg).
object
Address information for order.
string
Alphanumeric identifier for the order used by the seller/buyer. This identifier doesn’t need to be unique.
string ("UNKNOWN" | "AWAITPAY" | "PAID" | "REFUNDED" | "PARTIALLY_FULFILLED" | "SHIPPED")
Order status values.
string
Amount paid by the buyer for shipping. This amount can be different from the price the seller will actually pay for shipping.
string
Subtotal price before shipping and taxes.
string
Shipping method (carrier + service or other free text description) chosen by the buyer.
string
String used to pick a non-default API version to use. If not specified, the default API version will be used.
string
Currency of the shipping_cost amount. Required if shipping_cost is provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

boolean
Indicates whether the object should be created in test mode. Set to true for testing without affecting production data.
object
Extra options for the parcel.
string
required
Width of the parcel. Up to six digits in front and four digits after the decimal separator are accepted. Required if template is not specified.
string
required
Height of the parcel. Up to six digits in front and four digits after the decimal separator are accepted. Required if template is not specified.
string
required
Length of the parcel. Up to six digits in front and four digits after the decimal separator are accepted. Required if template is not specified.
string
required
Weight of the parcel. Up to six digits in front and four digits after the decimal separator are accepted.
string
A string of up to 100 characters that can be filled with any additional information you want to attach to the object.
string ("FedEx_Box_10kg" | "FedEx_Box_25kg" | "FedEx_Box_Extra_Large_1" | "FedEx_Box_Extra_Large_2" | "FedEx_Box_Large_1" | "FedEx_Box_Large_2" | "FedEx_Box_Medium_1" | "FedEx_Box_Medium_2" | "FedEx_Box_Small_1" | "FedEx_Box_Small_2" | "FedEx_Envelope" | "FedEx_Padded_Pak" | "FedEx_Pak_1" | "FedEx_Pak_2" | "FedEx_Tube" | "FedEx_XL_Pak" | "UPS_Box_10kg" | "UPS_Box_25kg" | "UPS_Express_Box" | "UPS_Express_Box_Large" | "UPS_Express_Box_Medium" | "UPS_Express_Box_Small" | "UPS_Express_Envelope" | "UPS_Express_Hard_Pak" | "UPS_Express_Legal_Envelope" | "UPS_Express_Pak" | "UPS_Express_Tube" | "UPS_Laboratory_Pak" | "UPS_MI_BPM" | "UPS_MI_BPM_Flat" | "UPS_MI_BPM_Parcel" | "UPS_MI_First_Class" | "UPS_MI_Flat" | "UPS_MI_Irregular" | "UPS_MI_Machinable" | "UPS_MI_MEDIA_MAIL" | "UPS_MI_Parcel_Post" | "UPS_MI_Priority" | "UPS_MI_Standard_Flat" | "UPS_Pad_Pak" | "UPS_Pallet" | "USPS_FlatRateCardboardEnvelope" | "USPS_FlatRateEnvelope" | "USPS_FlatRateGiftCardEnvelope" | "USPS_FlatRateLegalEnvelope" | "USPS_FlatRatePaddedEnvelope" | "USPS_FlatRateWindowEnvelope" | "USPS_IrregularParcel" | "USPS_LargeFlatRateBoardGameBox" | "USPS_LargeFlatRateBox" | "USPS_APOFlatRateBox" | "USPS_LargeVideoFlatRateBox" | "USPS_MediumFlatRateBox1" | "USPS_MediumFlatRateBox2" | "USPS_RegionalRateBoxA1" | "USPS_RegionalRateBoxA2" | "USPS_RegionalRateBoxB1" | "USPS_RegionalRateBoxB2" | "USPS_SmallFlatRateBox" | "USPS_SmallFlatRateEnvelope" | "USPS_SoftPack" | "DHLeC_Irregular" | "DHLeC_SM_Flats" | "couriersplease_500g_satchel" | "couriersplease_1kg_satchel" | "couriersplease_3kg_satchel" | "couriersplease_5kg_satchel" | "Fastway_Australia_Satchel_A2" | "Fastway_Australia_Satchel_A3" | "Fastway_Australia_Satchel_A4" | "Fastway_Australia_Satchel_A5")
Pre-defined parcel templates for common carrier packages.
string ("g" | "kg" | "lb" | "oz")
required
The unit used for weight.
string
required
Object ID of the merchant to create the parcel for. This is the merchant’s unique identifier in Shippo’s system.
string ("cm" | "in" | "ft" | "m" | "mm" | "yd")
required
The measure unit used for length, width and height. Required if template is not specified.
string
String used to pick a non-default API version to use. Leave empty to use the default version.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

boolean
Whether to process the refund asynchronously. Set to true for async processing (refund will be queued), or false for synchronous processing (immediate response). Default is false.
string
required
Object ID of the merchant for whom to create the refund. This identifies which merchant account the refund belongs to.
string
required
Object ID of the Transaction to be refunded. This is the unique identifier for a previously created transaction. The transaction must be eligible for refund.
string
String used to pick a non-default API version to use. If not specified, the default API version will be used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

boolean
Set to true to process the shipment asynchronously. Default is false for synchronous processing.
object
Extra options and services for the shipment.
array
required
Array of parcel objects with dimensions and weight. Required field. Must contain at least one parcel.
string
Custom metadata string to attach to this shipment for your own reference (up to 100 characters).
string
required
Object ID of the merchant to create the shipment for. This is the merchant’s unique identifier in Shippo’s system.
object
required
Recipient/destination address information. Required field.
object
required
Sender/origin address information. Required field.
string
Date the shipment will be tendered to the carrier in ISO 8601 format. If not provided, defaults to current date.
object
Address information for shipment origin, destination, or return.
string
String used to pick a non-default API version to use. Leave empty to use the default version.
string
Customs declaration object ID for international shipments. Required for international shipments.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Object ID of the Rate object for which a label should be obtained. Use this field when you already have a rate ID from a shipment. Note that only rates not older than 7 days can be purchased.
boolean
Whether to process the transaction asynchronously. Set to false for synchronous processing (wait for label creation), or true for async (transaction will be queued). Default is false.
string
A string of up to 100 characters that can be filled with any additional information you want to attach to the transaction object.
string
required
Object ID of the merchant for whom to create the transaction. This identifies which merchant account the transaction belongs to.
string ("PNG" | "PNG_2.3x7.5" | "PDF" | "PDF_2.3x7.5" | "PDF_4x6" | "PDF_4x8" | "PDF_A4" | "PDF_A6" | "ZPLII")
Label file format options.
string
String used to pick a non-default API version to use. If not specified, the default API version will be used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Additional notes or instructions for the order.
string
Total weight of the order. Required if line_items are not provided.
string
Currency code for order prices (e.g., ‘USD’).
string
required
ISO 8601 timestamp when the order was placed by the customer.
string
Total tax amount for the order.
array
List of items included in this order.
object
required
Recipient shipping address for the order.
string
Total price including shipping and taxes.
string ("lb" | "oz" | "g" | "kg")
Unit of weight measurement for the total order weight.
object
Origin/sender address for the order. If not provided, uses account default.
string
Unique order identifier from your system for reference.
string
Current status of the order (e.g., ‘PAID’, ‘PROCESSING’, ‘SHIPPED’).
string
Shipping cost charged to the customer.
string
Subtotal price before shipping and taxes.
string
Shipping method selected by the customer.
string
Currency code for the shipping cost.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPPO_CREATE_PARCELCreates a Shippo parcel with dimensions and weight for shipping rate calculations or label generation.

Input Parameters

boolean
Indicates whether the object should be created in test mode. Set to true for testing without affecting production data.
object
Extra options for the parcel.
string
required
Width of the parcel. Up to six digits in front and four digits after the decimal separator are accepted. Required if template is not specified.
string
required
Height of the parcel. Up to six digits in front and four digits after the decimal separator are accepted. Required if template is not specified.
string
required
Length of the parcel. Up to six digits in front and four digits after the decimal separator are accepted. Required if template is not specified.
string
required
Weight of the parcel. Up to six digits in front and four digits after the decimal separator are accepted.
string
A string of up to 100 characters that can be filled with any additional information you want to attach to the object.
string
Parcel template ID. If template is passed, length, width, height, and distance_unit are not required.
string ("g" | "kg" | "lb" | "oz")
required
The unit used for weight. Required if template is not specified.
string ("cm" | "in" | "ft" | "m" | "mm" | "yd")
required
The measure unit used for length, width and height. Required if template is not specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

boolean
Whether to process the refund asynchronously. Set to true for async processing (refund will be queued), or false for synchronous processing (immediate response). Default is false.
string
required
Object ID of the Transaction to be refunded. This is the unique identifier for a previously created transaction. The transaction must be eligible for refund.
string
Optional API version string to use for this request. Allows picking a non-default API version. If not specified, the default API version will be used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Name of the service group. Used to identify the group in the dashboard and API responses.
string ("FLAT_RATE" | "FREE_SHIPPING" | "RATE_ADJUSTMENT")
required
Pricing model for the service group: FLAT_RATE (fixed price), FREE_SHIPPING (no charge), or RATE_ADJUSTMENT (percentage adjustment).
string
Fixed shipping rate as a decimal string (e.g., ‘15.00’). Required when type is FLAT_RATE.
string
required
Description of the service group explaining its purpose or use case.
array
required
List of carrier service levels to include in this group. Each service level requires an account_object_id and service_level_token.
integer
Percentage adjustment to apply to carrier rates (e.g., 10 for 10% markup, -5 for 5% discount). Required when type is RATE_ADJUSTMENT.
string
Three-letter ISO currency code for flat_rate (e.g., ‘USD’, ‘EUR’). Required when flat_rate is provided.
string
Optional API version to use for this request. If not specified, the default API version will be used.
string
Minimum order value as decimal string to qualify for free shipping (e.g., ‘50.00’). Used with FREE_SHIPPING type.
string
Three-letter ISO currency code for free_shipping_threshold_min. Required when free_shipping_threshold_min is provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

boolean
Whether to process shipment asynchronously. Set to false for synchronous rate generation.
object
Additional parameters for shipment-specific features such as insurance and signature confirmation
array
required
List of parcels included in the shipment. Must contain at least one parcel.
string
Optional metadata string to attach to the shipment (up to 100 characters)
object
required
Destination address for the shipment
object
required
Origin address for the shipment
string
Date the shipment will be shipped (ISO 8601 format)
object
Address model for shipment origin and destination.
string
API version to use for this request
string
Object ID of the customs declaration for international shipments

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Name of the carrier to track the shipment with. Examples include ‘usps’, ‘fedex’, ‘ups’, ‘dhl’, ‘shippo’. See Shippo Carriers documentation for the full list of supported carriers.
string
A string of up to 100 characters to attach additional information to the tracking object. Useful for storing order IDs, customer references, or other contextual data.
string
required
The tracking number provided by the carrier. This is the unique identifier for the shipment you want to track. For testing, use ‘SHIPPO_DELIVERED’ with carrier ‘shippo’.
string
String used to pick a non-default API version to use. Leave empty to use the default version.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Object ID of the Rate object for which a label should be obtained. Use this field when you already have a rate ID from a shipment. Required if shipment, carrier_account, and servicelevel_token are not provided. Note that only rates not older than 7 days can be purchased.
boolean
Whether to process the transaction asynchronously. Set to false for synchronous processing (wait for label creation), or true for async (transaction will be queued). Default is false.
string
A string of up to 100 characters that can be filled with any additional information you want to attach to the transaction object.
string
Shipment object ID (string) or shipment object (dict). Use this field to create a transaction without first creating a rate. Must be used together with carrier_account and servicelevel_token. Cannot be used with rate field.
string
Object ID of the carrier account to be used for this transaction. Required when using shipment field instead of rate. Must be used together with shipment and servicelevel_token.
string ("PDF" | "PDF_4x6" | "PNG" | "ZPLII")
File format for the shipping label.
string
Service level token for the carrier. Required when using shipment field. Must be used together with shipment and carrier_account. Examples include ‘usps_priority’, ‘fedex_ground’, ‘ups_next_day_air’.
string
Optional API version string to use for this request. If not specified, the default API version will be used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Weight of the parcel. Up to six digits in front and four digits after the decimal separator are accepted.
string
A carrier parcel template token to use as a basis for this user parcel template. When provided, dimensions will be copied from the carrier preset.
string
Unit of measurement for weight (e.g., ‘lb’ for pounds, ‘kg’ for kilograms, ‘oz’ for ounces, ‘g’ for grams).
string
String used to pick a non-default API version to use. If not specified, the default API version will be used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The client-owned URL where webhook notifications will be sent. Must be less than 200 characters and use HTTPS protocol for security.
string ("track_updated" | "transaction_created" | "transaction_updated" | "batch_created" | "batch_purchased" | "all")
required
The event type to subscribe to. Use ‘track_updated’ for tracking updates, ‘transaction_created’ or ‘transaction_updated’ for transaction events, ‘batch_created’ or ‘batch_purchased’ for batch events, or ‘all’ as a catch-all for all events.
boolean
Whether this is a test webhook. Set to true for testing purposes. Defaults to false if not specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPPO_DELETE_DEFAULT_PARCEL_TEMPLATETool to clear the current default parcel template. Use when you need to remove the default parcel template configuration for live rates at checkout.

Input Parameters

string
String used to pick a non-default API version to use

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
String used to pick a non-default API version to use. If not specified, the default API version will be used.
string
required
Object ID of the user parcel template to delete. This is the unique identifier returned when the template was created or listed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPPO_DELETE_WEBHOOKTool 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.

Input Parameters

string
required
Object ID of the webhook to delete. This is the unique identifier returned when creating a webhook.
string
String used to pick a non-default API version to use. Leave empty to use the default version.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPPO_GET_ADDRESSTool to retrieve a previously created address from Shippo. Use when you need to get the details of an existing address using its object ID.

Input Parameters

string
required
Object ID of the address to retrieve
string
String used to pick a non-default API version to use. If not specified, the default API version will be used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPPO_GET_CARRIER_ACCOUNTTool to retrieve a carrier account by its ID. Use when you need to get details about a specific carrier account configuration.

Input Parameters

string
required
Object ID of the carrier account to retrieve.
string
String used to pick a non-default API version to use.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPPO_GET_CARRIER_PARCEL_TEMPLATETool 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.

Input Parameters

string
String used to pick a non-default API version to use
string
required
The unique string representation of the carrier parcel template

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPPO_GET_CARRIER_REGISTRATION_STATUSRetrieves carrier registration status for UPS, USPS, or Canada Post in the Shippo account.

Input Parameters

string
required
Filter by specific carrier (e.g., ‘ups’, ‘fedex’, ‘usps’, ‘dhl_express’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPPO_GET_CUSTOMS_DECLARATIONTool 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.

Input Parameters

integer
The page number you want to select
string
String used to pick a non-default API version to use
string
required
Object ID of the customs declaration to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPPO_GET_CUSTOMS_ITEMRetrieve a previously created customs item by its object ID, including its description, quantity, weight, value, and origin.

Input Parameters

integer
The page number you want to select. Use this for pagination if the API returns multiple pages of results.
string
required
Object ID of the customs item to retrieve.
string
String used to pick a non-default API version to use. Only use this if you need a specific API version.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
String used to pick a non-default API version to use. If not specified, the default API version will be used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPPO_GET_MERCHANTTool 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.

Input Parameters

string
required
Object ID of the merchant to retrieve
string
String used to pick a non-default API version to use. If not specified, the default API version will be used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Object ID of the address to retrieve
string
required
Object ID of the merchant whose address to retrieve
string
String used to pick a non-default API version to use. If not specified, the default API version will be used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Object ID of the batch
string
required
Object ID of the merchant
string
String used to pick a non-default API version to use. If not specified, the default API version will be used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPPO_GET_MERCHANT_CARRIER_ACCOUNTTool 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.

Input Parameters

string
required
Object ID of the merchant whose carrier account to retrieve.
string
required
Object ID of the carrier account to retrieve.
string
String used to pick a non-default API version to use.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("ups" | "usps" | "canada_post")
required
The carrier to check registration status for. Must be one of: ups, usps, or canada_post.
string
required
Object ID of the merchant. This is the merchant’s unique identifier in Shippo’s Platform API system.
string
String used to pick a non-default API version to use. Leave empty to use the default version.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
The page number you want to select for paginated results
string
required
Object ID of the merchant whose customs declaration you want to retrieve. This is the merchant’s unique identifier in Shippo’s system.
string
String used to pick a non-default API version to use. Leave empty to use the default version.
string
required
Object ID of the customs declaration to retrieve. Use this to fetch a specific declaration by its unique identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPPO_GET_MERCHANT_CUSTOMS_ITEMTool 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.

Input Parameters

integer
The page number you want to select
string
required
Object ID of the merchant whose customs item you want to retrieve
string
required
Object ID of the customs item to retrieve
string
String used to pick a non-default API version to use

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Object ID of the manifest to retrieve
string
required
Object ID of the merchant
string
String used to pick a non-default API version to use. If not specified, the default API version will be used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Object ID of the order to retrieve
string
required
Object ID of the merchant
string
String used to pick a non-default API version to use. If not specified, the default API version will be used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Object ID of the parcel to retrieve
string
required
Object ID of the merchant
string
String used to pick a non-default API version to use. If not specified, the default API version will be used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Object ID of the rate to retrieve. This is a unique identifier for the rate.
string
required
Object ID of the merchant whose rate to retrieve. This is a unique identifier for the merchant on the Shippo Platform.
string
String used to pick a non-default API version to use. If not specified, the default API version will be used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Object ID of the refund to retrieve
string
required
Object ID of the merchant whose refund to retrieve
string
String used to pick a non-default API version to use. If not specified, the default API version will be used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Object ID of the merchant
string
required
Object ID of the shipment to retrieve
string
String used to pick a non-default API version to use. If not specified, the default API version will be used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Name of the carrier of the shipment to track. Examples: usps, fedex, ups, dhl_express, shippo. See Shippo documentation for full list of supported carriers.
string
required
Object ID of the merchant whose tracking to retrieve
string
required
Tracking number to track. The format varies by carrier (e.g., USPS: 9205590164917312751089, Shippo test: SHIPPO_DELIVERED).
string
String used to pick a non-default API version to use. If not specified, the default API version will be used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Object ID of the merchant
string
required
Object ID of the transaction to retrieve
string
String used to pick a non-default API version to use. If not specified, the default API version will be used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPPO_GET_ORDERTool to retrieve an order from Shippo. Use when you need to fetch details about a specific order including shipping addresses, line items, and transactions.

Input Parameters

string
required
Object ID of the order to retrieve.
string
String used to pick a non-default API version to use.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Object ID of the parcel to retrieve.
string
String used to pick a non-default API version to use. If not specified, the default API version will be used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPPO_GET_RATERetrieves a shipping rate by ID, including pricing, carrier details and service level. Rates older than 390 days are not returned.

Input Parameters

string
required
Object ID of the rate to retrieve. This is a unique identifier for the rate.
string
String used to pick a non-default API version to use. If not specified, the default API version will be used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Object ID of the refund to retrieve. This is a unique identifier returned when creating a refund.
string
String used to pick a non-default API version to use. Optional header parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPPO_GET_SHIPMENTRetrieves a shipment by ID, including addresses, parcels, rates, and status. Shipments older than 390 days are not returned.

Input Parameters

string
required
Object ID of the shipment to retrieve
string
String used to pick a non-default API version to use

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPPO_GET_SHIPPO_ACCOUNTRetrieve a managed Shippo account by its object ID using the Shippo API.

Input Parameters

string
required
Object ID of the Shippo Account to retrieve
string
String used to pick a non-default API version to use. If not specified, the default API version will be used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Name of the carrier of the shipment to track. Examples: usps, fedex, ups, dhl_express, shippo. See Shippo documentation for full list of supported carriers.
string
required
Tracking number to track. The format varies by carrier (e.g., USPS: 9205590164917312751089, Shippo test: SHIPPO_DELIVERED).
string
String used to pick a non-default API version to use. If not specified, the default API version will be used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Object ID of the transaction to retrieve
string
String used to pick a non-default API version to use. If not specified, the default API version will be used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
String used to pick a non-default API version to use. If not specified, the default API version will be used.
string
required
Object ID of the user parcel template to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPPO_GET_WEBHOOKTool to retrieve a specific webhook subscription from Shippo. Use when you need to get the details of an existing webhook using its object ID.

Input Parameters

string
required
Object ID of the webhook to retrieve. This is the unique identifier returned when creating a webhook.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPPO_LIST_ADDRESSESTool to list all addresses in the Shippo account with pagination support. Use when you need to retrieve stored addresses for shipment creation or management.

Input Parameters

integer
The page number you want to select
integer
The number of results to return per page (max 100)
string
String used to pick a non-default API version to use

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPPO_LIST_CARRIER_ACCOUNTSTool 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.

Input Parameters

integer
The page number you want to select
integer
The number of results to return per page (max 100)
string
String used to pick a non-default API version to use

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Filter templates by specific carrier name (e.g., ‘fedex’, ‘usps’, ‘ups’)
string ("all" | "user" | "enabled")
Filter templates by type: ‘all’ returns all templates, ‘user’ returns only user-created templates, ‘enabled’ returns only enabled templates
string
String used to pick a non-default API version to use

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPPO_LIST_CUSTOMS_DECLARATIONSTool to list all customs declarations in the Shippo account with pagination support. Use when you need to retrieve customs declarations for international shipments.

Input Parameters

integer
The page number you want to select
integer
The number of results to return per page (max 100)
string
String used to pick a non-default API version to use

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPPO_LIST_CUSTOMS_ITEMSList customs items with pagination support for reviewing items used in international shipments.

Input Parameters

integer
The page number you want to select
integer
The number of results to return per page (max 100)
string
String used to pick a non-default API version to use

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPPO_LIST_MANIFESTSTool 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.

Input Parameters

integer
The page number you want to select. Must be greater than or equal to 1.
integer
The number of results to return per page. Must be between 1 and 100.
string
String used to pick a non-default API version to use for this request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPPO_LIST_MERCHANT_ADDRESSESTool to list all addresses for a specific merchant using the Shippo Platform API. Use when you need to retrieve merchant addresses with pagination support.

Input Parameters

integer
The page number you want to select
integer
The number of results to return per page (max 100)
string
required
Object ID of the merchant whose addresses you want to list
string
String used to pick a non-default API version to use

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPPO_LIST_MERCHANT_CARRIER_ACCOUNTSTool 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.

Input Parameters

integer
The page number you want to select
integer
The number of results to return per page (max 100)
string
required
Object ID of the merchant whose carrier accounts to list
string
String used to pick a non-default API version to use

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPPO_LIST_MERCHANT_CUSTOMS_DECLARATIONSTool 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.

Input Parameters

integer
The page number you want to select
integer
The number of results to return per page (max 100)
string
required
Object ID of the merchant whose customs declarations you want to list
string
String used to pick a non-default API version to use

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPPO_LIST_MERCHANT_CUSTOMS_ITEMSTool 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.

Input Parameters

integer
The page number you want to select
integer
The number of results to return per page (max 100)
string
required
Object ID of the merchant whose customs items you want to list
string
String used to pick a non-default API version to use

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
The page number you want to select. Must be greater than or equal to 1.
integer
The number of results to return per page. Must be between 1 and 100. Maximum is 100.
string
required
Object ID of the merchant to retrieve manifests for. This is the unique identifier for the merchant account.
string
String used to pick a non-default API version to use for this request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPPO_LIST_MERCHANT_PARCELSTool to list all parcels for a specific merchant using the Shippo Platform API. Use when you need to retrieve merchant parcels with pagination support.

Input Parameters

integer
The page number you want to select
integer
The number of results to return per page (max 100)
string
required
Object ID of the merchant whose parcels you want to list
string
String used to pick a non-default API version to use

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPPO_LIST_MERCHANTSTool to list all merchants using the Shippo Platform API with pagination support. Use when you need to retrieve merchant accounts in a platform context.

Input Parameters

integer
The page number you want to select
integer
The number of results to return per page (max 100)
string
String used to pick a non-default API version to use

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPPO_LIST_MERCHANT_SHIPMENT_RATES_BY_CURRENCYTool 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.

Input Parameters

integer
The page number you want to select
integer
The number of results to return per page (max 100)
string
required
Object ID of the merchant
string
required
Object ID of the shipment to retrieve rates for
string
required
ISO currency code to filter rates by (e.g., USD, EUR, GBP)
string
String used to pick a non-default API version to use

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
The page number you want to select. Must be greater than or equal to 1.
integer
The number of results to return per page. Must be between 1 and 100. Maximum is 100.
string
required
Object ID of the merchant to retrieve shipments for. This is the unique identifier for the merchant account.
string
String used to pick a non-default API version to use for this request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPPO_LIST_MERCHANT_TRANSACTIONSTool 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.

Input Parameters

integer
The page number you want to select
integer
The number of results to return per page (max 100)
string
required
Object ID of the merchant to retrieve transactions for
string
String used to pick a non-default API version to use

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPPO_LIST_ORDERSTool 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.

Input Parameters

integer
The page number you want to select
integer
The number of results to return per page (max 100)
string
String used to pick a non-default API version to use

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPPO_LIST_REFUNDSTool 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.

Input Parameters

integer
Page number for pagination (1-indexed). Use to navigate through multiple pages of results.
integer
Number of refund records to return per page (default 10). Controls page size for pagination.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
String used to pick a non-default API version to use. If not provided, the default API version will be used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPPO_LIST_SHIPMENT_RATESRetrieves a page of available shipping rates for a shipment to compare carrier pricing and service options. Rates for shipments older than 390 days are not returned.

Input Parameters

integer
The page number you want to select
integer
The number of results to return per page (max 100)
string
required
Object ID of the shipment to retrieve rates for
string
String used to pick a non-default API version to use

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
The page number you want to select
integer
The number of results to return per page (max 100)
string
required
Object ID of the shipment to retrieve rates for
string
required
ISO currency code to filter rates by (e.g., USD, EUR, GBP)
string
String used to pick a non-default API version to use

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPPO_LIST_SHIPMENTSLists shipments in the Shippo account with pagination, for viewing shipment records and status. Shipment objects older than 390 days are not returned.

Input Parameters

integer
The page number you want to select
integer
The number of results to return per page (max 100)
string
String used to pick a non-default API version to use

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPPO_LIST_SHIPPO_ACCOUNTSTool 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.

Input Parameters

integer
Page number for pagination. Use to retrieve subsequent pages of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
String used to pick a non-default API version to use. If not specified, the default API version will be used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Object ID of the batch to purchase
string
required
Object ID of the merchant
string
String used to pick a non-default API version to use. If not specified, the default API version will be used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Object ID of the batch from which to remove shipments
string
required
Object ID of the merchant who owns the batch
array
required
Array of shipment object IDs to remove from the batch. Each ID must be a valid shipment identifier.
string
String used to pick a non-default API version to use. If not specified, the default API version will be used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

boolean
Whether the carrier account should be active or inactive. Set to true to enable, false to disable.
string
required
The carrier name/identifier (e.g., ‘usps’, ‘ups’, ‘fedex’, ‘dhl_express’, ‘lso’). This field is required.
string
required
The carrier account identifier. This field is required.
object
Optional carrier-specific parameters as key-value pairs. The structure varies by carrier.
string
required
Object ID of the carrier account to update (e.g., ‘2bf70116c96f40159b54c16f022586c7’).
string
Optional string to specify a non-default API version to use for this request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the parcel template to set as default. This should be the ID of an existing parcel template in your Shippo account.
string
Optional string used to pick a non-default API version to use. If not provided, the default API version will be used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPPO_UPDATE_MERCHANTTool 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.

Input Parameters

string
required
The merchant’s email address. This field is required.
string
required
The merchant’s last name. This field is required.
string
required
The merchant’s first name. This field is required.
string
required
Object ID of the merchant to update (e.g., ‘5d23a7d95cef472fbdf4758dd7564f48’).
string
required
The merchant’s business/company name. This field is required.
string
Optional string to specify a non-default API version to use for this request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

boolean
Whether the carrier account should be active or inactive. Set to true to enable, false to disable.
string
required
The carrier name/identifier (e.g., ‘ups’, ‘usps’, ‘fedex’). This field is required.
string
required
The carrier account identifier. This field is required.
object
required
Carrier-specific parameters. For UPS, includes billing address, account details, and invoice information.
string
required
Object ID of the merchant (e.g., ‘5d23a7d95cef472fbdf4758dd7564f48’).
string
required
Object ID of the carrier account to update (e.g., ‘15c67bc9e2694e7c896c8d995d313442’).
string
Optional string to specify a non-default API version to use for this request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPPO_UPDATE_SERVICE_GROUPTool 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.

Input Parameters

string
Name of the service group
string
Type of service group (e.g., FLAT_RATE, LIVE_RATE)
string
Flat rate amount (used when type is FLAT_RATE)
boolean
Whether the service group is active
string
required
The object ID of the service group being updated
string
Description of the service group
array
Array of service level configurations to associate with this group
integer
Rate adjustment value as percentage (e.g., 10 for 10% increase, -5 for 5% decrease)
string
Currency for the flat rate (ISO 4217 currency code)
string
Minimum amount for free shipping threshold
string
Currency for free shipping threshold (ISO 4217 currency code)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The weight of the parcel. Up to six digits in front and four digits after the decimal separator are accepted.
string
required
The token of a carrier parcel template (e.g., USPS_FlatRateEnvelope, USPS_FlatRatePaddedEnvelope, FedExBox). This specifies the carrier’s predefined package type.
string
required
The unit of weight measurement (e.g., lb for pounds, kg for kilograms, oz for ounces, g for grams).
string
String used to pick a non-default API version to use. If not specified, the default API version will be used.
string
required
Object ID of the user parcel template to update. This is the unique identifier of an existing user parcel template.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPPO_UPDATE_WEBHOOKUpdate an existing Shippo webhook by ID, supplying its event type, URL, activation status, and test mode together.

Input Parameters

string
required
The webhook URL endpoint where notifications will be sent. Must be a valid HTTPS URL.
string ("batch_created" | "transaction_created" | "transaction_updated" | "track_updated" | "batch_updated" | "all")
required
The webhook event type to listen for. Use ‘all’ to receive all event types.
boolean
required
Whether the webhook should be active or inactive. Set to true to enable, false to disable.
boolean
required
Whether this is a test webhook. Set to true for testing, false for production.
string
required
Object ID of the webhook to update (e.g., ‘7c190fc9a7e1473dbf59c861b535e3d5’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Object ID of the address to validate. This is the unique identifier returned when an address was created.
string
Optional API version string to use a non-default API version. If not provided, the default API version will be used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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.

Input Parameters

string
required
Object ID of the address to validate. This is the unique identifier of the address object to be validated.
string
required
Object ID of the merchant. This is the unique identifier for the merchant whose address you want to validate.
string
Optional API version string to use a non-default API version. If not specified, the default API version will be used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not