Shipping API for e-commerce merchants to create labels, track packages, and manage shipping operations.
Shipping API for e-commerce merchants to create labels, track packages, and manage shipping operations. On Nagent, Shippo is exposed as a fully-configurable ecommerce integration that any agent can call — 95 actions, and API_KEY, OAUTH2 authentication. No code is required to wire Shippo into your workflow — connect it once via the External Integrations panel and reuse it across every agent you build.
Agent builders use Shippo to automate the kinds of tasks ecommerce teams previously handled manually. Concrete examples — each one is a single agent step in Nagent — include:
Every action and trigger is paired with a structured input/output schema (visible in the sections below), so when you wire Shippo into Helix — our agentic agent builder — the editor knows exactly what each step expects and produces. Configure once, deploy anywhere across your Nagent agents.
Every operation an agent can call against Shippo, with input parameters and output schema. Drop these into any step of an agent built in Helix.
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
ZIP or postal code. Format varies by country (e.g., 94105 for US, SW1A 1AA for UK).
City name for the address. Required for most countries.
Full name of the person or business at this address. Required for shipping labels.
Contact email address. Used for shipping notifications and updates.
Contact phone number including country code. Format: +\[country code\] \[number\]. Recommended for delivery notifications.
State, province, or region code. Use 2-letter state codes for US addresses (e.g., CA, NY). Required for countries with states/provinces.
Company or business name if this is a commercial address.
2-letter ISO country code (e.g., US, GB, CA). Required field for all addresses.
Primary street address line. Required field for all addresses.
Secondary street address line for apartment, suite, or unit numbers.
Third street address line for additional address details if needed.
Custom metadata string to attach to this address for your own reference. Maximum 100 characters.
Set to true to validate the address with the carrier before creating. Recommended to catch address errors early.
Street number for countries that separate street number from street name.
Set to true if this is a residential address, false for commercial. Affects shipping rates and delivery options.
String used to pick a non-default API version to use. Leave empty to use the default version.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SHIPPO_CREATE_BATCHTool to create a batch of shipments for bulk label purchasing. Use when you need to process multiple shipments at once with the same carrier and service level. Requires a valid carrier account ID from your Shippo account.
Input parameters
Custom metadata string for the batch (max 100 characters)
Format for the shipping label (e.g., 'PDF', 'PNG', 'ZPLII'). If not specified, defaults to PDF.
List of shipments to include in the batch. Each shipment must contain address_from, address_to, and parcels.
String used to pick a non-default API version to use
Object ID of the carrier account to use for batch shipments. Must be a valid carrier account ID from /carrier_accounts endpoint.
Service level token for the shipment (e.g., 'usps_priority', 'canada_post_expedited_parcel')
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SHIPPO_CREATE_CARRIER_ACCOUNTTool to create a new carrier account in Shippo. Use when you need to register carrier credentials for shipping operations. This action requires detailed billing and contact information, and for UPS accounts specifically, the user must agree to UPS terms and conditions.
Input parameters
Whether this is a test account.
Whether the carrier account is active.
The carrier name to create an account for, e.g., 'ups'.
Optional metadata string to associate with the carrier account.
Account identifier used to reference this carrier account. Must not be blank.
Carrier-specific parameters required for account creation. For UPS, this includes billing address, contact information, and invoice details.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Custom metadata string for storing additional information about the customs item.
Quantity of this item in the shipment. Must be a positive integer.
Stock Keeping Unit code or product identifier for inventory tracking.
Unit of measurement for the weight. Common values: 'lb' (pounds), 'kg' (kilograms), 'oz' (ounces), 'g' (grams).
Export Control Classification Number (ECCN) or EAR99 designation for export control purposes.
Net weight of the item (total weight for all units). Numeric string value.
Text description of the item being shipped for customs purposes.
Monetary value of the item. Numeric string with up to 2 decimal places.
Harmonized Tariff Schedule (HTS) code for the item. Used for customs classification.
Two-letter ISO 3166-1 alpha-2 country code of the item's origin country.
Three-letter ISO 4217 currency code for the item value.
Optional API version to use for this request. If not specified, uses the default API version.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SHIPPO_CREATE_LIVE_RATETool to generate live shipping rates from multiple carriers for a given shipment. Use when you need real-time pricing for shipping from origin to destination with specific items. Returns available rates with costs and delivery estimates.
Input parameters
Array of parcel objects or parcel template IDs. If not provided, dimensions are calculated from line items.
Destination address - either an address object ID string or a full address object
Array of line item objects describing what is being shipped. At least one item is required.
Origin address - either an address object ID string or a full address object. If not provided, uses default address from account settings.
String used to pick a non-default API version to use
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SHIPPO_CREATE_MANIFESTTool to create a new shipping manifest with Shippo. Use when you need to generate a manifest document for a carrier with multiple shipments that need to be scanned at pickup.
Input parameters
Object ID of the address the manifest will be sent from. Must be a valid address object ID.
List of transaction object IDs to be included in the manifest. Each ID must be a valid transaction object ID.
Date and time of the shipment in ISO 8601 format. This is the date that will be printed on the manifest.
If true, the manifest will be created asynchronously. If false or not specified, it will be created synchronously.
Object ID of the carrier account to be used for this manifest. Must be a valid carrier account object ID.
String used to pick a non-default API version to use for this request.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
ZIP or postal code. Format varies by country (e.g., 94117 for US, SW1A 1AA for UK). Required for purchase.
City name for the address. Required for purchase.
Full name of the person or business at this address. Required for purchase.
Contact email address. Used for notifications and updates.
Contact phone number including country code. Format: +\[country code\] \[number\].
State, province, or region code. Use 2-letter state codes for US addresses (e.g., CA, NY). Required for purchase for some countries.
Company or business name if this is a commercial address.
2-letter ISO country code (e.g., US, GB, CA). Required field for all addresses.
Primary street address line. Required for purchase.
Secondary street address line for apartment, suite, or unit numbers.
Custom metadata string to attach to this address for your own reference.
Set to true to validate the address with the carrier before creating. Recommended to catch address errors early.
Object ID of the merchant to create the address for. This is the merchant's unique identifier in Shippo's system.
Set to true if this is a residential address, false for commercial. Affects shipping rates and delivery options.
String used to pick a non-default API version to use. Leave empty to use the default version.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Custom metadata string to attach to the batch for your reference (max 100 characters).
Object ID of the merchant for whom to create the batch. This identifies which merchant account the batch belongs to.
Label file format options.
Array of BatchShipment objects containing shipment IDs to include in this batch. The response maintains the same order as the request array.
String used to pick a non-default API version to use. If not specified, the default API version will be used.
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.
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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SHIPPO_CREATE_MERCHANT_CARRIER_ACCOUNTTool to create a carrier account for a merchant using the Shippo Platform API. Use when you need to register carrier credentials for a specific merchant in a platform integration scenario.
Input parameters
Whether this is a test account.
Whether the carrier account is active.
The carrier name to create an account for (e.g., 'ups').
Optional metadata string to associate with the carrier account.
Account identifier. This field is required as input to the API, but is not used for UPS. Use the empty string for UPS.
Carrier-specific parameters required for account creation. For UPS, this includes billing address, contact information, and invoice details.
Object ID of the merchant to create a carrier account for.
String used to pick a non-default API version to use. If not specified, the default API version will be used.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Indicates whether to create this in test mode. Use true for testing without affecting production data. Optional field.
Array of customs items included in this declaration. At least one item is required.
Additional notes or instructions to be included in the customs declaration. Optional field.
AES / ITN (Automated Export System / Internal Transaction Number) reference. Required if eel_pfc is 'AES_ITN'. Optional otherwise.
Expresses that the certify_signer has provided all information of the customs declaration truthfully. Required field.
Export information - EEL (Exemption and Exclusion Legend) or PFC (Proof of Filing Citation) code. Optional field.
Invoice reference number of the shipment. Optional field.
Export license reference of the shipment. Optional field.
The incoterm reference of the shipment. Optional field.
Custom metadata string, up to 100 characters. Use for storing your own reference data. Optional field.
Disclaimer for the shipment and customs information. Optional field.
B13A number (Proof of Report, Summary ID, or Exemption Number). Must be provided if and only if b13a_filing_option is provided.
Certificate reference of the shipment. Optional field.
Object ID of the merchant to create the customs declaration for. This is the merchant's unique identifier in Shippo's system.
Type of contents being shipped. Required field. Valid values: DOCUMENTS, GIFT, SAMPLE, MERCHANDISE, HUMANITARIAN_DONATION, RETURN_MERCHANDISE, OTHER.
Name of the person responsible for the validity of all information provided in the customs declaration. Required field.
B13A filing option for Canadian exports. Optional field.
Commercial invoice reference. Optional field.
Exporter reference of an export shipment. Optional field.
Importer reference of an import shipment. Optional field.
String used to pick a non-default API version to use. Leave empty to use the default version.
Action to take if delivery fails. Required field. Valid values: 'RETURN' (return to sender), 'ABANDON' (dispose of package).
Explanation of the type of goods being shipped. Required if contents_type is 'OTHER'. Optional otherwise.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Custom metadata string for storing additional information about the customs item. Optional field.
Quantity of this item in the shipment. Must be a positive integer. Required field.
The stock keeping unit value of this item. Optional field for inventory tracking.
Unit of measurement for the weight. Required field. Valid values: 'g' (grams), 'kg' (kilograms), 'lb' (pounds), 'oz' (ounces).
Export Control Classification Number (ECCN) or EAR99 designation for export control purposes. Optional field.
Net weight of the item (total weight for all units). Numeric string value. Required field.
Text description of the item being shipped for customs purposes. Required field.
Object ID of the merchant to create the customs item for. This is the merchant's unique identifier in Shippo's system.
Monetary value of the item. Numeric string with up to 2 decimal places. Required field.
Harmonized Tariff Schedule (HTS) code for the item. Used for customs classification. Optional field.
Two-letter ISO 3166-1 alpha-2 country code of the item's origin country. Required field.
Three-letter ISO 4217 currency code for the item value. Required field.
String used to pick a non-default API version to use. Leave empty to use the default version.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Custom buyer- or seller-provided notes about the order.
Total weight of the order.
Currency of the total_price and total_tax amounts. Required if total_price is provided.
ISO 8601 timestamp when the order was placed by the customer (e.g., '2026-02-12T15:30:00Z').
Total tax amount paid by the buyer for this order.
Array of line item objects representing the items in this order.
Recipient shipping address for the order. Must include name, street, city, state, zip, and country.
Object ID of the merchant for whom to create the order. This identifies which merchant account the order belongs to.
Total amount paid by the buyer for this order.
Unit of weight measurement for the order (lb, oz, g, kg).
Address information for order.
Alphanumeric identifier for the order used by the seller/buyer. This identifier doesn't need to be unique.
Order status values.
Amount paid by the buyer for shipping. This amount can be different from the price the seller will actually pay for shipping.
Subtotal price before shipping and taxes.
Shipping method (carrier + service or other free text description) chosen by the buyer.
String used to pick a non-default API version to use. If not specified, the default API version will be used.
Currency of the shipping_cost amount. Required if shipping_cost is provided.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Indicates whether the object should be created in test mode. Set to true for testing without affecting production data.
Extra options for the parcel.
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.
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.
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.
Weight of the parcel. Up to six digits in front and four digits after the decimal separator are accepted.
A string of up to 100 characters that can be filled with any additional information you want to attach to the object.
Pre-defined parcel templates for common carrier packages.
The unit used for weight.
Object ID of the merchant to create the parcel for. This is the merchant's unique identifier in Shippo's system.
The measure unit used for length, width and height. Required if template is not specified.
String used to pick a non-default API version to use. Leave empty to use the default version.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
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.
Object ID of the merchant for whom to create the refund. This identifies which merchant account the refund belongs to.
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 used to pick a non-default API version to use. If not specified, the default API version will be used.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Set to true to process the shipment asynchronously. Default is false for synchronous processing.
Extra options and services for the shipment.
Array of parcel objects with dimensions and weight. Required field. Must contain at least one parcel.
Custom metadata string to attach to this shipment for your own reference (up to 100 characters).
Object ID of the merchant to create the shipment for. This is the merchant's unique identifier in Shippo's system.
Recipient/destination address information. Required field.
Sender/origin address information. Required field.
Date the shipment will be tendered to the carrier in ISO 8601 format. If not provided, defaults to current date.
Address information for shipment origin, destination, or return.
String used to pick a non-default API version to use. Leave empty to use the default version.
Customs declaration object ID for international shipments. Required for international shipments.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
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.
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.
A string of up to 100 characters that can be filled with any additional information you want to attach to the transaction object.
Object ID of the merchant for whom to create the transaction. This identifies which merchant account the transaction belongs to.
Label file format options.
String used to pick a non-default API version to use. If not specified, the default API version will be used.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Additional notes or instructions for the order.
Total weight of the order. Required if line_items are not provided.
Currency code for order prices (e.g., 'USD').
ISO 8601 timestamp when the order was placed by the customer.
Total tax amount for the order.
List of items included in this order.
Recipient shipping address for the order.
Total price including shipping and taxes.
Unit of weight measurement for the total order weight.
Origin/sender address for the order. If not provided, uses account default.
Unique order identifier from your system for reference.
Current status of the order (e.g., 'PAID', 'PROCESSING', 'SHIPPED').
Shipping cost charged to the customer.
Subtotal price before shipping and taxes.
Shipping method selected by the customer.
Currency code for the shipping cost.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SHIPPO_CREATE_PARCELTool to create a new parcel in Shippo with dimensions and weight specifications. Use when you need to define package dimensions for shipping rate calculations or label generation. The parcel object is required to create shipments and obtain shipping rates.
Input parameters
Indicates whether the object should be created in test mode. Set to true for testing without affecting production data.
Extra options for the parcel.
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.
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.
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.
Weight of the parcel. Up to six digits in front and four digits after the decimal separator are accepted.
A string of up to 100 characters that can be filled with any additional information you want to attach to the object.
Parcel template ID. If template is passed, length, width, height, and distance_unit are not required.
The unit used for weight. Required if template is not specified.
The measure unit used for length, width and height. Required if template is not specified.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
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.
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.
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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SHIPPO_CREATE_SERVICE_GROUPTool to create a new Shippo service group with specified pricing model and carrier service levels. Use when you need to configure a custom shipping rate group for checkout display.
Input parameters
Name of the service group. Used to identify the group in the dashboard and API responses.
Pricing model for the service group: FLAT_RATE (fixed price), FREE_SHIPPING (no charge), or RATE_ADJUSTMENT (percentage adjustment).
Fixed shipping rate as a decimal string (e.g., '15.00'). Required when type is FLAT_RATE.
Description of the service group explaining its purpose or use case.
List of carrier service levels to include in this group. Each service level requires an account_object_id and service_level_token.
Percentage adjustment to apply to carrier rates (e.g., 10 for 10% markup, -5 for 5% discount). Required when type is RATE_ADJUSTMENT.
Three-letter ISO currency code for flat_rate (e.g., 'USD', 'EUR'). Required when flat_rate is provided.
Optional API version to use for this request. If not specified, the default API version will be used.
Minimum order value as decimal string to qualify for free shipping (e.g., '50.00'). Used with FREE_SHIPPING type.
Three-letter ISO currency code for free_shipping_threshold_min. Required when free_shipping_threshold_min is provided.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Whether to process shipment asynchronously. Set to false for synchronous rate generation.
Additional parameters for shipment-specific features such as insurance and signature confirmation
List of parcels included in the shipment. Must contain at least one parcel.
Optional metadata string to attach to the shipment (up to 100 characters)
Destination address for the shipment
Origin address for the shipment
Date the shipment will be shipped (ISO 8601 format)
Address model for shipment origin and destination.
API version to use for this request
Object ID of the customs declaration for international shipments
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
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.
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.
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 used to pick a non-default API version to use. Leave empty to use the default version.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SHIPPO_CREATE_TRANSACTIONTool to create a shipping label transaction with Shippo. Use when you need to purchase a shipping label either from an existing rate ID or by specifying shipment details directly.
Input parameters
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.
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.
A string of up to 100 characters that can be filled with any additional information you want to attach to the transaction object.
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.
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.
File format for the shipping label.
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'.
Optional API version string to use for this request. If not specified, the default API version will be used.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Weight of the parcel. Up to six digits in front and four digits after the decimal separator are accepted.
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.
Unit of measurement for weight (e.g., 'lb' for pounds, 'kg' for kilograms, 'oz' for ounces, 'g' for grams).
String used to pick a non-default API version to use. If not specified, the default API version will be used.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
The client-owned URL where webhook notifications will be sent. Must be less than 200 characters and use HTTPS protocol for security.
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.
Whether this is a test webhook. Set to true for testing purposes. Defaults to false if not specified.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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 used to pick a non-default API version to use
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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 used to pick a non-default API version to use. If not specified, the default API version will be used.
Object ID of the user parcel template to delete. This is the unique identifier returned when the template was created or listed.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Object ID of the webhook to delete. This is the unique identifier returned when creating a webhook.
String used to pick a non-default API version to use. Leave empty to use the default version.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Object ID of the address to retrieve
String used to pick a non-default API version to use. If not specified, the default API version will be used.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Object ID of the carrier account to retrieve.
String used to pick a non-default API version to use.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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 used to pick a non-default API version to use
The unique string representation of the carrier parcel template
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SHIPPO_GET_CARRIER_REGISTRATION_STATUSTool to retrieve carrier registration status from Shippo. Use when you need to check the registration or authentication status of a carrier account.
Input parameters
Filter by specific carrier (e.g., 'ups', 'fedex', 'usps', 'dhl_express')
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
The page number you want to select
String used to pick a non-default API version to use
Object ID of the customs declaration to retrieve
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SHIPPO_GET_CUSTOMS_ITEMTool to retrieve a customs item from Shippo. Use when you need to fetch details about a previously created customs declaration for international shipments.
Input parameters
The page number you want to select. Use this for pagination if the API returns multiple pages of results.
Object ID of the customs item to retrieve.
String used to pick a non-default API version to use. Only use this if you need a specific API version.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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 used to pick a non-default API version to use. If not specified, the default API version will be used.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Object ID of the merchant to retrieve
String used to pick a non-default API version to use. If not specified, the default API version will be used.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Object ID of the address to retrieve
Object ID of the merchant whose address to retrieve
String used to pick a non-default API version to use. If not specified, the default API version will be used.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Object ID of the batch
Object ID of the merchant
String used to pick a non-default API version to use. If not specified, the default API version will be used.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Object ID of the merchant whose carrier account to retrieve.
Object ID of the carrier account to retrieve.
String used to pick a non-default API version to use.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SHIPPO_GET_MERCHANT_CARRIER_REGISTRATION_STATUSTool to retrieve carrier registration status for a specific merchant using Shippo's Platform API. Use when you need to check if a merchant has registered or connected a carrier account.
Input parameters
The carrier to check registration status for. Must be one of: ups, usps, or canada_post.
Object ID of the merchant. This is the merchant's unique identifier in Shippo's Platform API system.
String used to pick a non-default API version to use. Leave empty to use the default version.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
The page number you want to select for paginated results
Object ID of the merchant whose customs declaration you want to retrieve. This is the merchant's unique identifier in Shippo's system.
String used to pick a non-default API version to use. Leave empty to use the default version.
Object ID of the customs declaration to retrieve. Use this to fetch a specific declaration by its unique identifier.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
The page number you want to select
Object ID of the merchant whose customs item you want to retrieve
Object ID of the customs item to retrieve
String used to pick a non-default API version to use
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Object ID of the manifest to retrieve
Object ID of the merchant
String used to pick a non-default API version to use. If not specified, the default API version will be used.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Object ID of the order to retrieve
Object ID of the merchant
String used to pick a non-default API version to use. If not specified, the default API version will be used.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Object ID of the parcel to retrieve
Object ID of the merchant
String used to pick a non-default API version to use. If not specified, the default API version will be used.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Object ID of the rate to retrieve. This is a unique identifier for the rate.
Object ID of the merchant whose rate to retrieve. This is a unique identifier for the merchant on the Shippo Platform.
String used to pick a non-default API version to use. If not specified, the default API version will be used.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Object ID of the refund to retrieve
Object ID of the merchant whose refund to retrieve
String used to pick a non-default API version to use. If not specified, the default API version will be used.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Object ID of the merchant
Object ID of the shipment to retrieve
String used to pick a non-default API version to use. If not specified, the default API version will be used.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
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.
Object ID of the merchant whose tracking to retrieve
Tracking number to track. The format varies by carrier (e.g., USPS: 9205590164917312751089, Shippo test: SHIPPO_DELIVERED).
String used to pick a non-default API version to use. If not specified, the default API version will be used.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Object ID of the merchant
Object ID of the transaction to retrieve
String used to pick a non-default API version to use. If not specified, the default API version will be used.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Object ID of the order to retrieve.
String used to pick a non-default API version to use.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SHIPPO_GET_PARCELTool to retrieve a parcel by its ID. Use when you need to fetch details of an existing parcel object including dimensions, weight, and metadata.
Input parameters
Object ID of the parcel to retrieve.
String used to pick a non-default API version to use. If not specified, the default API version will be used.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SHIPPO_GET_RATETool to retrieve a specific shipping rate by its ID. Use when you need to fetch detailed rate information including pricing, carrier details, and service level.
Input parameters
Object ID of the rate to retrieve. This is a unique identifier for the rate.
String used to pick a non-default API version to use. If not specified, the default API version will be used.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Object ID of the refund to retrieve. This is a unique identifier returned when creating a refund.
String used to pick a non-default API version to use. Optional header parameter.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SHIPPO_GET_SHIPMENTTool to retrieve a shipment by its ID. Use when you need to fetch details about a specific shipment including addresses, parcels, rates, and status.
Input parameters
Object ID of the shipment to retrieve
String used to pick a non-default API version to use
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SHIPPO_GET_SHIPPO_ACCOUNTTool to retrieve a Shippo Account from the Shippo Platform API. Use when you need to get the details of an existing Shippo Account using its object ID.
Input parameters
Object ID of the Shippo Account to retrieve
String used to pick a non-default API version to use. If not specified, the default API version will be used.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
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.
Tracking number to track. The format varies by carrier (e.g., USPS: 9205590164917312751089, Shippo test: SHIPPO_DELIVERED).
String used to pick a non-default API version to use. If not specified, the default API version will be used.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Object ID of the transaction to retrieve
String used to pick a non-default API version to use. If not specified, the default API version will be used.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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 used to pick a non-default API version to use. If not specified, the default API version will be used.
Object ID of the user parcel template to retrieve.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Object ID of the webhook to retrieve. This is the unique identifier returned when creating a webhook.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
The page number you want to select
The number of results to return per page (max 100)
String used to pick a non-default API version to use
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
The page number you want to select
The number of results to return per page (max 100)
String used to pick a non-default API version to use
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Filter templates by specific carrier name (e.g., 'fedex', 'usps', 'ups')
Filter templates by type: 'all' returns all templates, 'user' returns only user-created templates, 'enabled' returns only enabled templates
String used to pick a non-default API version to use
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
The page number you want to select
The number of results to return per page (max 100)
String used to pick a non-default API version to use
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SHIPPO_LIST_CUSTOMS_ITEMSTool to list all customs items with pagination support. Use when you need to retrieve customs declarations for international shipments.
Input parameters
The page number you want to select
The number of results to return per page (max 100)
String used to pick a non-default API version to use
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
The page number you want to select. Must be greater than or equal to 1.
The number of results to return per page. Must be between 1 and 100.
String used to pick a non-default API version to use for this request.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
The page number you want to select
The number of results to return per page (max 100)
Object ID of the merchant whose addresses you want to list
String used to pick a non-default API version to use
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
The page number you want to select
The number of results to return per page (max 100)
Object ID of the merchant whose carrier accounts to list
String used to pick a non-default API version to use
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
The page number you want to select
The number of results to return per page (max 100)
Object ID of the merchant whose customs declarations you want to list
String used to pick a non-default API version to use
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
The page number you want to select
The number of results to return per page (max 100)
Object ID of the merchant whose customs items you want to list
String used to pick a non-default API version to use
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
The page number you want to select. Must be greater than or equal to 1.
The number of results to return per page. Must be between 1 and 100. Maximum is 100.
Object ID of the merchant to retrieve manifests for. This is the unique identifier for the merchant account.
String used to pick a non-default API version to use for this request.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
The page number you want to select
The number of results to return per page (max 100)
Object ID of the merchant whose parcels you want to list
String used to pick a non-default API version to use
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
The page number you want to select
The number of results to return per page (max 100)
String used to pick a non-default API version to use
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
The page number you want to select
The number of results to return per page (max 100)
Object ID of the merchant
Object ID of the shipment to retrieve rates for
ISO currency code to filter rates by (e.g., USD, EUR, GBP)
String used to pick a non-default API version to use
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
The page number you want to select. Must be greater than or equal to 1.
The number of results to return per page. Must be between 1 and 100. Maximum is 100.
Object ID of the merchant to retrieve shipments for. This is the unique identifier for the merchant account.
String used to pick a non-default API version to use for this request.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
The page number you want to select
The number of results to return per page (max 100)
Object ID of the merchant to retrieve transactions for
String used to pick a non-default API version to use
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
The page number you want to select
The number of results to return per page (max 100)
String used to pick a non-default API version to use
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Page number for pagination (1-indexed). Use to navigate through multiple pages of results.
Number of refund records to return per page (default 10). Controls page size for pagination.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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 used to pick a non-default API version to use. If not provided, the default API version will be used.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SHIPPO_LIST_SHIPMENT_RATESTool to retrieve available shipping rates for a specific shipment. Use when you need to compare carrier pricing and service options for a shipment.
Input parameters
The page number you want to select
The number of results to return per page (max 100)
Object ID of the shipment to retrieve rates for
String used to pick a non-default API version to use
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SHIPPO_LIST_SHIPMENT_RATES_BY_CURRENCYTool to retrieve available shipping rates for a specific shipment filtered by currency code. Use when you need to compare carrier pricing in a specific currency (e.g., USD, EUR, GBP).
Input parameters
The page number you want to select
The number of results to return per page (max 100)
Object ID of the shipment to retrieve rates for
ISO currency code to filter rates by (e.g., USD, EUR, GBP)
String used to pick a non-default API version to use
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SHIPPO_LIST_SHIPMENTSTool to list all shipments in the Shippo account with pagination support. Use when you need to retrieve shipment records, check shipment status, or manage shipping operations.
Input parameters
The page number you want to select
The number of results to return per page (max 100)
String used to pick a non-default API version to use
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Page number for pagination. Use to retrieve subsequent pages of results.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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 used to pick a non-default API version to use. If not specified, the default API version will be used.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Object ID of the batch to purchase
Object ID of the merchant
String used to pick a non-default API version to use. If not specified, the default API version will be used.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Object ID of the batch from which to remove shipments
Object ID of the merchant who owns the batch
Array of shipment object IDs to remove from the batch. Each ID must be a valid shipment identifier.
String used to pick a non-default API version to use. If not specified, the default API version will be used.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Whether the carrier account should be active or inactive. Set to true to enable, false to disable.
The carrier name/identifier (e.g., 'usps', 'ups', 'fedex', 'dhl_express', 'lso'). This field is required.
The carrier account identifier. This field is required.
Optional carrier-specific parameters as key-value pairs. The structure varies by carrier.
Object ID of the carrier account to update (e.g., '2bf70116c96f40159b54c16f022586c7').
Optional string to specify a non-default API version to use for this request.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
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.
Optional string used to pick a non-default API version to use. If not provided, the default API version will be used.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
The merchant's email address. This field is required.
The merchant's last name. This field is required.
The merchant's first name. This field is required.
Object ID of the merchant to update (e.g., '5d23a7d95cef472fbdf4758dd7564f48').
The merchant's business/company name. This field is required.
Optional string to specify a non-default API version to use for this request.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SHIPPO_UPDATE_MERCHANT_CARRIER_ACCOUNTTool to update a carrier account for a merchant in Shippo Platform API. Use when you need to modify merchant carrier account settings such as activation status, billing address, or UPS-specific parameters. Requires Platform API authentication with merchant context.
Input parameters
Whether the carrier account should be active or inactive. Set to true to enable, false to disable.
The carrier name/identifier (e.g., 'ups', 'usps', 'fedex'). This field is required.
The carrier account identifier. This field is required.
Carrier-specific parameters. For UPS, includes billing address, account details, and invoice information.
Object ID of the merchant (e.g., '5d23a7d95cef472fbdf4758dd7564f48').
Object ID of the carrier account to update (e.g., '15c67bc9e2694e7c896c8d995d313442').
Optional string to specify a non-default API version to use for this request.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Name of the service group
Type of service group (e.g., FLAT_RATE, LIVE_RATE)
Flat rate amount (used when type is FLAT_RATE)
Whether the service group is active
The object ID of the service group being updated
Description of the service group
Array of service level configurations to associate with this group
Rate adjustment value as percentage (e.g., 10 for 10% increase, -5 for 5% decrease)
Currency for the flat rate (ISO 4217 currency code)
Minimum amount for free shipping threshold
Currency for free shipping threshold (ISO 4217 currency code)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SHIPPO_UPDATE_USER_PARCEL_TEMPLATETool to update an existing user parcel template with new weight and carrier template settings. Use when you need to modify the dimensions or weight of a previously created custom parcel template.
Input parameters
The weight of the parcel. Up to six digits in front and four digits after the decimal separator are accepted.
The token of a carrier parcel template (e.g., USPS_FlatRateEnvelope, USPS_FlatRatePaddedEnvelope, FedExBox). This specifies the carrier's predefined package type.
The unit of weight measurement (e.g., lb for pounds, kg for kilograms, oz for ounces, g for grams).
String used to pick a non-default API version to use. If not specified, the default API version will be used.
Object ID of the user parcel template to update. This is the unique identifier of an existing user parcel template.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SHIPPO_UPDATE_WEBHOOKTool to update an existing webhook in Shippo. Use when you need to modify webhook settings such as the event type, URL endpoint, activation status, or test mode flag.
Input parameters
The webhook URL endpoint where notifications will be sent. Must be a valid HTTPS URL.
The webhook event type to listen for. Use 'all' to receive all event types.
Whether the webhook should be active or inactive. Set to true to enable, false to disable.
Whether this is a test webhook. Set to true for testing, false for production.
Object ID of the webhook to update (e.g., '7c190fc9a7e1473dbf59c861b535e3d5').
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SHIPPO_VALIDATE_ADDRESSTool to validate an address using the Shippo API. Use when you need to verify that a shipping address is valid and complete before creating a shipment.
Input parameters
Object ID of the address to validate. This is the unique identifier returned when an address was created.
Optional API version string to use a non-default API version. If not provided, the default API version will be used.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Object ID of the address to validate. This is the unique identifier of the address object to be validated.
Object ID of the merchant. This is the unique identifier for the merchant whose address you want to validate.
Optional API version string to use a non-default API version. If not specified, the default API version will be used.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
No publicly available marketplace agent is found using this tool yet. There are 87 agents privately built on Nagent that already use Shippo.
Build on Nagent
Connect Shippo to any Nagent agent in minutes — no API key management, no boilerplate. Just configure and deploy.
The five questions agent builders ask before adopting a new integration.
Open the External Integrations panel inside Nagent (app.nagent.ai/externalIntegration), find Shippo, and click "Connect Now." You'll authenticate with API_KEY, OAUTH2 — Nagent handles credential storage and refresh automatically. Once connected, Shippo is available to any agent in your workspace.
No. Nagent provides no-code integration for every tool. Once Shippo is connected, you configure its 95 actions directly in the agent builder UI — no API calls, no boilerplate, no schema management.
Helix — Nagent's agentic agent builder — lets you drop Shippo steps into any workflow visually. Pick an action (e.g., one of those listed above), fill in the inputs (Helix knows the required vs. optional schema for each parameter), and connect it to upstream/downstream steps. Triggers run as the entry point of an agent, so when a Shippo event fires, the agent kicks off automatically.
Every Shippo action and trigger ships with a fully-typed schema — input parameters with name, type, required flag, and description, plus the output payload shape. The schemas are documented in the sections above. Helix uses these schemas to validate your configuration at build time and to type-check the data flowing between steps.
Yes. While Shippo ships with 95 pre-built ecommerce actions, you can layer custom logic around them inside Helix — pre/post-processing steps, conditional branches, retries, or stitching Shippo together with other connected tools. For deeper customization, talk to our team about Nagent's Agentic AI Lab — forward-deployed engineers who build Shippo-based workflows tailored to your business.