# Shippo

Shipping API for e-commerce merchants to create labels, track packages, and manage shipping operations.

- **Category:** ecommerce
- **Auth:** API_KEY, OAUTH2
- **Composio Managed App Available?** Yes
- **Tools:** 95
- **Triggers:** 0
- **Slug:** `SHIPPO`
- **Version:** 20260227_00

## Tools

### Create Shippo Address

**Slug:** `SHIPPO_CREATE_ADDRESS`

Tool to create a new address in Shippo. Use when you need to store sender or recipient addresses for shipping labels and transactions. Addresses can be validated against carrier databases before creation by setting validate=true.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Batch

**Slug:** `SHIPPO_CREATE_BATCH`

Tool to create a batch of shipments for bulk label purchasing. Use when you need to process multiple shipments at once with the same carrier and service level. Requires a valid carrier account ID from your Shippo account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `metadata` | string | No | Custom metadata string for the batch (max 100 characters) |
| `label_filetype` | string | No | Format for the shipping label (e.g., 'PDF', 'PNG', 'ZPLII'). If not specified, defaults to PDF. |
| `batch_shipments` | array | Yes | List of shipments to include in the batch. Each shipment must contain address_from, address_to, and parcels. |
| `shippo_api_version` | string | No | String used to pick a non-default API version to use |
| `default_carrier_account` | string | Yes | Object ID of the carrier account to use for batch shipments. Must be a valid carrier account ID from /carrier_accounts endpoint. |
| `default_servicelevel_token` | string | Yes | Service level token for the shipment (e.g., 'usps_priority', 'canada_post_expedited_parcel') |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Carrier Account

**Slug:** `SHIPPO_CREATE_CARRIER_ACCOUNT`

Tool to create a new carrier account in Shippo. Use when you need to register carrier credentials for shipping operations. This action requires detailed billing and contact information, and for UPS accounts specifically, the user must agree to UPS terms and conditions.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Customs Item

**Slug:** `SHIPPO_CREATE_CUSTOMS_ITEM`

Create a new customs item for international shipments. Customs items are required for customs declarations when shipping internationally. Use this action to define the contents, value, and origin of items being shipped across international borders.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Live Rate

**Slug:** `SHIPPO_CREATE_LIVE_RATE`

Tool to generate live shipping rates from multiple carriers for a given shipment. Use when you need real-time pricing for shipping from origin to destination with specific items. Returns available rates with costs and delivery estimates.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Manifest

**Slug:** `SHIPPO_CREATE_MANIFEST`

Tool to create a new shipping manifest with Shippo. Use when you need to generate a manifest document for a carrier with multiple shipments that need to be scanned at pickup.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Merchant Address

**Slug:** `SHIPPO_CREATE_MERCHANT_ADDRESS`

Tool to create a new address for a merchant using Shippo's Platform API. Use when you need to add an address to a merchant's account for shipping operations. This endpoint is part of the Platform API and requires a merchant ID.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Merchant Batch

**Slug:** `SHIPPO_CREATE_MERCHANT_BATCH`

Tool to create a batch for a merchant using the Shippo Platform API. Use when you need to create bulk shipment batches for a specific merchant account. Requires valid merchant ID, carrier account, and shipment IDs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `metadata` | string | No | Custom metadata string to attach to the batch for your reference (max 100 characters). |
| `merchant_id` | string | Yes | Object ID of the merchant for whom to create the batch. This identifies which merchant account the batch belongs to. |
| `label_filetype` | string ("PNG" | "PNG_2.3x7.5" | "PDF" | "PDF_2.3x7.5" | "PDF_4x6" | "PDF_4x8" | "PDF_A4" | "PDF_A6" | "ZPLII") | No | Label file format options. |
| `batch_shipments` | array | Yes | Array of BatchShipment objects containing shipment IDs to include in this batch. The response maintains the same order as the request array. |
| `shippo_api_version` | string | No | String used to pick a non-default API version to use. If not specified, the default API version will be used. |
| `default_carrier_account` | string | Yes | 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. |
| `default_servicelevel_token` | string | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Merchant Carrier Account

**Slug:** `SHIPPO_CREATE_MERCHANT_CARRIER_ACCOUNT`

Tool to create a carrier account for a merchant using the Shippo Platform API. Use when you need to register carrier credentials for a specific merchant in a platform integration scenario.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Merchant Customs Declaration

**Slug:** `SHIPPO_CREATE_MERCHANT_CUSTOMS_DECLARATION`

Tool to create a new customs declaration for a merchant using Shippo's Platform API. Use when you need to create a customs declaration for international shipments on behalf of a merchant. This endpoint is part of the Platform API and requires a merchant ID.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Merchant Customs Item

**Slug:** `SHIPPO_CREATE_MERCHANT_CUSTOMS_ITEM`

Tool to create a new customs item for a merchant using Shippo's Platform API. Use when you need to create customs items for a merchant's international shipments. This endpoint is part of the Platform API and requires a merchant ID.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Merchant Order

**Slug:** `SHIPPO_CREATE_MERCHANT_ORDER`

Tool to create an order for a merchant using the Shippo Platform API. Use when you need to create an order on behalf of a merchant account with recipient address and order details.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Merchant Parcel

**Slug:** `SHIPPO_CREATE_MERCHANT_PARCEL`

Tool to create a new parcel for a merchant using Shippo's Platform API. Use when you need to define package dimensions for a merchant's shipping operations. This endpoint is part of the Platform API and requires a merchant ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `test` | boolean | No | Indicates whether the object should be created in test mode. Set to true for testing without affecting production data. |
| `extra` | object | No | Extra options for the parcel. |
| `width` | string | Yes | 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` | string | Yes | 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` | string | Yes | 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` | string | Yes | Weight of the parcel. Up to six digits in front and four digits after the decimal separator are accepted. |
| `metadata` | string | No | A string of up to 100 characters that can be filled with any additional information you want to attach to the object. |
| `template` | 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") | No | Pre-defined parcel templates for common carrier packages. |
| `mass_unit` | string ("g" | "kg" | "lb" | "oz") | Yes | The unit used for weight. |
| `merchant_id` | string | Yes | Object ID of the merchant to create the parcel for. This is the merchant's unique identifier in Shippo's system. |
| `distance_unit` | string ("cm" | "in" | "ft" | "m" | "mm" | "yd") | Yes | The measure unit used for length, width and height. Required if template is not specified. |
| `SHIPPO-API-VERSION` | string | No | String used to pick a non-default API version to use. Leave empty to use the default version. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Merchant Refund

**Slug:** `SHIPPO_CREATE_MERCHANT_REFUND`

Tool to create a refund for a merchant using the Shippo Platform API. Use when you need to refund a transaction for a specific merchant account. Requires valid merchant ID and transaction ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `async` | boolean | No | 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. |
| `merchant_id` | string | Yes | Object ID of the merchant for whom to create the refund. This identifies which merchant account the refund belongs to. |
| `transaction` | string | Yes | 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. |
| `shippo_api_version` | string | No | String used to pick a non-default API version to use. If not specified, the default API version will be used. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Merchant Shipment

**Slug:** `SHIPPO_CREATE_MERCHANT_SHIPMENT`

Tool to create a new shipment for a merchant using Shippo's Platform API. Use when you need to create a shipment with origin/destination addresses and parcel details to get shipping rates. This endpoint is part of the Platform API and requires a merchant ID.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Merchant Transaction

**Slug:** `SHIPPO_CREATE_MERCHANT_TRANSACTION`

Tool to create a shipping label transaction for a merchant using the Shippo Platform API. Use when you need to purchase a shipping label for a specific merchant account using an existing rate ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `rate` | string | Yes | 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. |
| `async` | boolean | No | 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. |
| `metadata` | string | No | A string of up to 100 characters that can be filled with any additional information you want to attach to the transaction object. |
| `merchant_id` | string | Yes | Object ID of the merchant for whom to create the transaction. This identifies which merchant account the transaction belongs to. |
| `label_file_type` | string ("PNG" | "PNG_2.3x7.5" | "PDF" | "PDF_2.3x7.5" | "PDF_4x6" | "PDF_4x8" | "PDF_A4" | "PDF_A6" | "ZPLII") | No | Label file format options. |
| `shippo_api_version` | string | No | String used to pick a non-default API version to use. If not specified, the default API version will be used. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Order

**Slug:** `SHIPPO_CREATE_ORDER`

Tool to create a new order in Shippo. Use when you need to register an order for shipment processing. The order must include a recipient address and placement timestamp. Line items can be provided for detailed tracking, or a total weight can be specified.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `notes` | string | No | Additional notes or instructions for the order. |
| `weight` | string | No | Total weight of the order. Required if line_items are not provided. |
| `currency` | string | No | Currency code for order prices (e.g., 'USD'). |
| `placed_at` | string | Yes | ISO 8601 timestamp when the order was placed by the customer. |
| `total_tax` | string | No | Total tax amount for the order. |
| `line_items` | array | No | List of items included in this order. |
| `to_address` | object | Yes | Recipient shipping address for the order. |
| `total_price` | string | No | Total price including shipping and taxes. |
| `weight_unit` | string ("lb" | "oz" | "g" | "kg") | No | Unit of weight measurement for the total order weight. |
| `from_address` | object | No | Origin/sender address for the order. If not provided, uses account default. |
| `order_number` | string | No | Unique order identifier from your system for reference. |
| `order_status` | string | No | Current status of the order (e.g., 'PAID', 'PROCESSING', 'SHIPPED'). |
| `shipping_cost` | string | No | Shipping cost charged to the customer. |
| `subtotal_price` | string | No | Subtotal price before shipping and taxes. |
| `shipping_method` | string | No | Shipping method selected by the customer. |
| `shipping_cost_currency` | string | No | Currency code for the shipping cost. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Parcel

**Slug:** `SHIPPO_CREATE_PARCEL`

Tool to create a new parcel in Shippo with dimensions and weight specifications. Use when you need to define package dimensions for shipping rate calculations or label generation. The parcel object is required to create shipments and obtain shipping rates.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Refund

**Slug:** `SHIPPO_CREATE_REFUND`

Tool to create a refund for a Shippo transaction. Use when you need to refund a previously created shipping label or transaction.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `async` | boolean | No | 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. |
| `transaction` | string | Yes | 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. |
| `shippo_api_version` | string | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Service Group

**Slug:** `SHIPPO_CREATE_SERVICE_GROUP`

Tool to create a new Shippo service group with specified pricing model and carrier service levels. Use when you need to configure a custom shipping rate group for checkout display.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Shipment

**Slug:** `SHIPPO_CREATE_SHIPMENT`

Tool to create a new shipment with Shippo. Use when you need to generate shipping rates for a package by providing origin and destination addresses and parcel details.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Register Tracking Webhook

**Slug:** `SHIPPO_CREATE_TRACK`

Tool to register a tracking webhook for a shipment. Use when you need to start tracking a shipment using its carrier and tracking number. This creates a tracking object that will receive updates about the shipment's status and location.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `carrier` | string | Yes | 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. |
| `metadata` | string | No | 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. |
| `tracking_number` | string | Yes | 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'. |
| `SHIPPO-API-VERSION` | string | No | String used to pick a non-default API version to use. Leave empty to use the default version. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Transaction

**Slug:** `SHIPPO_CREATE_TRANSACTION`

Tool to create a shipping label transaction with Shippo. Use when you need to purchase a shipping label either from an existing rate ID or by specifying shipment details directly.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `rate` | string | No | 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. |
| `async` | boolean | No | 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. |
| `metadata` | string | No | A string of up to 100 characters that can be filled with any additional information you want to attach to the transaction object. |
| `shipment` | string | No | 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. |
| `carrier_account` | string | No | 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. |
| `label_file_type` | string ("PDF" | "PDF_4x6" | "PNG" | "ZPLII") | No | File format for the shipping label. |
| `servicelevel_token` | string | No | 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'. |
| `shippo_api_version` | string | No | Optional API version string to use for this request. If not specified, the default API version will be used. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create User Parcel Template

**Slug:** `SHIPPO_CREATE_USER_PARCEL_TEMPLATE`

Tool to create a new user parcel template in Shippo with preset dimensions and weight specifications. Use when you need to define reusable package configurations for shipping rate calculations or label generation. User parcel templates can be based on carrier templates with custom weights.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `weight` | string | No | Weight of the parcel. Up to six digits in front and four digits after the decimal separator are accepted. |
| `template` | string | No | 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. |
| `weight_unit` | string | No | Unit of measurement for weight (e.g., 'lb' for pounds, 'kg' for kilograms, 'oz' for ounces, 'g' for grams). |
| `shippo_api_version` | string | No | String used to pick a non-default API version to use. If not specified, the default API version will be used. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Shippo Webhook

**Slug:** `SHIPPO_CREATE_WEBHOOK`

Tool to create a new webhook subscription in Shippo. Use when you need to register an endpoint to receive real-time notifications for shipping events such as tracking updates, transaction creation, or batch processing. Webhooks enable automated workflows by pushing event data to your application as events occur.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | The client-owned URL where webhook notifications will be sent. Must be less than 200 characters and use HTTPS protocol for security. |
| `event` | string ("track_updated" | "transaction_created" | "transaction_updated" | "batch_created" | "batch_purchased" | "all") | Yes | 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. |
| `is_test` | boolean | No | Whether this is a test webhook. Set to true for testing purposes. Defaults to false if not specified. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Default Parcel Template

**Slug:** `SHIPPO_DELETE_DEFAULT_PARCEL_TEMPLATE`

Tool to clear the current default parcel template. Use when you need to remove the default parcel template configuration for live rates at checkout.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `SHIPPO_API_VERSION` | string | No | String used to pick a non-default API version to use |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete User Parcel Template

**Slug:** `SHIPPO_DELETE_USER_PARCEL_TEMPLATE`

Tool to delete a user-created parcel template. Use when you need to remove a custom parcel template that is no longer needed.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `shippo_api_version` | string | No | String used to pick a non-default API version to use. If not specified, the default API version will be used. |
| `user_parcel_template_object_id` | string | Yes | Object ID of the user parcel template to delete. This is the unique identifier returned when the template was created or listed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Webhook

**Slug:** `SHIPPO_DELETE_WEBHOOK`

Tool to delete a specific webhook from Shippo. Use when you need to remove a webhook that is no longer needed or needs to be reconfigured.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `webhook_id` | string | Yes | Object ID of the webhook to delete. This is the unique identifier returned when creating a webhook. |
| `shippo_api_version` | string | No | String used to pick a non-default API version to use. Leave empty to use the default version. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Address

**Slug:** `SHIPPO_GET_ADDRESS`

Tool to retrieve a previously created address from Shippo. Use when you need to get the details of an existing address using its object ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `address_id` | string | Yes | Object ID of the address to retrieve |
| `shippo_api_version` | string | No | String used to pick a non-default API version to use. If not specified, the default API version will be used. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Carrier Account

**Slug:** `SHIPPO_GET_CARRIER_ACCOUNT`

Tool to retrieve a carrier account by its ID. Use when you need to get details about a specific carrier account configuration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `carrier_account_id` | string | Yes | Object ID of the carrier account to retrieve. |
| `shippo_api_version` | string | No | String used to pick a non-default API version to use. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Carrier Parcel Template

**Slug:** `SHIPPO_GET_CARRIER_PARCEL_TEMPLATE`

Tool to retrieve a specific carrier parcel template by its token. Use when you need to get detailed dimensions and specifications for a standardized carrier package type.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `shippo_api_version` | string | No | String used to pick a non-default API version to use |
| `carrier_parcel_template_token` | string | Yes | The unique string representation of the carrier parcel template |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Carrier Registration Status

**Slug:** `SHIPPO_GET_CARRIER_REGISTRATION_STATUS`

Tool to retrieve carrier registration status from Shippo. Use when you need to check the registration or authentication status of a carrier account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `carrier` | string | Yes | Filter by specific carrier (e.g., 'ups', 'fedex', 'usps', 'dhl_express') |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Customs Declaration

**Slug:** `SHIPPO_GET_CUSTOMS_DECLARATION`

Tool to retrieve a customs declaration by its ID. Use when you need to fetch details about a specific customs declaration including items, certifications, and shipping information.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | The page number you want to select |
| `shippo_api_version` | string | No | String used to pick a non-default API version to use |
| `customs_declaration_id` | string | Yes | Object ID of the customs declaration to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get customs item

**Slug:** `SHIPPO_GET_CUSTOMS_ITEM`

Tool to retrieve a customs item from Shippo. Use when you need to fetch details about a previously created customs declaration for international shipments.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | The page number you want to select. Use this for pagination if the API returns multiple pages of results. |
| `customs_item_id` | string | Yes | Object ID of the customs item to retrieve. |
| `shippo_api_version` | string | No | String used to pick a non-default API version to use. Only use this if you need a specific API version. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Default Parcel Template

**Slug:** `SHIPPO_GET_DEFAULT_PARCEL_TEMPLATE`

Tool to retrieve the current default parcel template for live rates at checkout. Use when you need to view the default parcel dimensions and weight settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `shippo_api_version` | string | No | String used to pick a non-default API version to use. If not specified, the default API version will be used. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Merchant

**Slug:** `SHIPPO_GET_MERCHANT`

Tool to retrieve a merchant from the Shippo Platform API. Use when you need to get the details of an existing merchant using their object ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `merchant_id` | string | Yes | Object ID of the merchant to retrieve |
| `shippo_api_version` | string | No | String used to pick a non-default API version to use. If not specified, the default API version will be used. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Merchant Address

**Slug:** `SHIPPO_GET_MERCHANT_ADDRESS`

Tool to retrieve a merchant address from Shippo Platform API. Use when you need to get the details of an existing merchant address using merchant ID and address ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `address_id` | string | Yes | Object ID of the address to retrieve |
| `merchant_id` | string | Yes | Object ID of the merchant whose address to retrieve |
| `shippo_api_version` | string | No | String used to pick a non-default API version to use. If not specified, the default API version will be used. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Merchant Batch

**Slug:** `SHIPPO_GET_MERCHANT_BATCH`

Tool to retrieve a batch for a merchant from the Shippo Platform API. Use when you need to get details of an existing batch using merchant and batch IDs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `batch_id` | string | Yes | Object ID of the batch |
| `merchant_id` | string | Yes | Object ID of the merchant |
| `shippo_api_version` | string | No | String used to pick a non-default API version to use. If not specified, the default API version will be used. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Merchant Carrier Account

**Slug:** `SHIPPO_GET_MERCHANT_CARRIER_ACCOUNT`

Tool to retrieve a carrier account for a merchant using the Shippo Platform API. Use when you need to get details about a specific carrier account associated with a merchant on the platform.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `merchant_id` | string | Yes | Object ID of the merchant whose carrier account to retrieve. |
| `carrier_account_id` | string | Yes | Object ID of the carrier account to retrieve. |
| `shippo_api_version` | string | No | String used to pick a non-default API version to use. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Merchant Carrier Registration Status

**Slug:** `SHIPPO_GET_MERCHANT_CARRIER_REGISTRATION_STATUS`

Tool to retrieve carrier registration status for a specific merchant using Shippo's Platform API. Use when you need to check if a merchant has registered or connected a carrier account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `carrier` | string ("ups" | "usps" | "canada_post") | Yes | The carrier to check registration status for. Must be one of: ups, usps, or canada_post. |
| `merchant_id` | string | Yes | Object ID of the merchant. This is the merchant's unique identifier in Shippo's Platform API system. |
| `SHIPPO-API-VERSION` | string | No | String used to pick a non-default API version to use. Leave empty to use the default version. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Merchant Customs Declaration

**Slug:** `SHIPPO_GET_MERCHANT_CUSTOMS_DECLARATION`

Tool to retrieve a specific customs declaration for a merchant using Shippo's Platform API. Use when you need to fetch details about a merchant's customs declaration for international shipments.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | The page number you want to select for paginated results |
| `merchant_id` | string | Yes | Object ID of the merchant whose customs declaration you want to retrieve. This is the merchant's unique identifier in Shippo's system. |
| `shippo_api_version` | string | No | String used to pick a non-default API version to use. Leave empty to use the default version. |
| `customs_declaration_id` | string | Yes | Object ID of the customs declaration to retrieve. Use this to fetch a specific declaration by its unique identifier. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Merchant Customs Item

**Slug:** `SHIPPO_GET_MERCHANT_CUSTOMS_ITEM`

Tool to retrieve a customs item for a merchant using the Shippo Platform API. Use when you need to fetch details about a specific customs item for a merchant's international shipments.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | The page number you want to select |
| `merchant_id` | string | Yes | Object ID of the merchant whose customs item you want to retrieve |
| `customs_item_id` | string | Yes | Object ID of the customs item to retrieve |
| `shippo_api_version` | string | No | String used to pick a non-default API version to use |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Merchant Manifest

**Slug:** `SHIPPO_GET_MERCHANT_MANIFEST`

Tool to retrieve a manifest for a merchant from the Shippo Platform API. Use when you need to get details of an existing manifest using merchant and manifest IDs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `manifest_id` | string | Yes | Object ID of the manifest to retrieve |
| `merchant_id` | string | Yes | Object ID of the merchant |
| `shippo_api_version` | string | No | String used to pick a non-default API version to use. If not specified, the default API version will be used. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Merchant Order

**Slug:** `SHIPPO_GET_MERCHANT_ORDER`

Tool to retrieve an order for a merchant from the Shippo Platform API. Use when you need to get details of an existing order using merchant and order IDs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `order_id` | string | Yes | Object ID of the order to retrieve |
| `merchant_id` | string | Yes | Object ID of the merchant |
| `shippo_api_version` | string | No | String used to pick a non-default API version to use. If not specified, the default API version will be used. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Merchant Parcel

**Slug:** `SHIPPO_GET_MERCHANT_PARCEL`

Tool to retrieve a parcel for a merchant from the Shippo Platform API. Use when you need to fetch details of a parcel that belongs to a specific merchant.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `parcel_id` | string | Yes | Object ID of the parcel to retrieve |
| `merchant_id` | string | Yes | Object ID of the merchant |
| `shippo_api_version` | string | No | String used to pick a non-default API version to use. If not specified, the default API version will be used. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Merchant Rate

**Slug:** `SHIPPO_GET_MERCHANT_RATE`

Tool to retrieve a specific shipping rate for a merchant using the Shippo Platform API. Use when you need to fetch detailed rate information for a merchant's shipment, including pricing, carrier details, and service level.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `rate_id` | string | Yes | Object ID of the rate to retrieve. This is a unique identifier for the rate. |
| `merchant_id` | string | Yes | Object ID of the merchant whose rate to retrieve. This is a unique identifier for the merchant on the Shippo Platform. |
| `shippo_api_version` | string | No | String used to pick a non-default API version to use. If not specified, the default API version will be used. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Merchant Refund

**Slug:** `SHIPPO_GET_MERCHANT_REFUND`

Tool to retrieve a merchant refund from Shippo Platform API. Use when you need to get the details or status of a specific refund for a merchant.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `refund_id` | string | Yes | Object ID of the refund to retrieve |
| `merchant_id` | string | Yes | Object ID of the merchant whose refund to retrieve |
| `shippo_api_version` | string | No | String used to pick a non-default API version to use. If not specified, the default API version will be used. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Merchant Shipment

**Slug:** `SHIPPO_GET_MERCHANT_SHIPMENT`

Tool to retrieve a shipment for a merchant from the Shippo Platform API. Use when you need to fetch details of a shipment that belongs to a specific merchant.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `merchant_id` | string | Yes | Object ID of the merchant |
| `shipment_id` | string | Yes | Object ID of the shipment to retrieve |
| `shippo_api_version` | string | No | String used to pick a non-default API version to use. If not specified, the default API version will be used. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Merchant Tracking Status

**Slug:** `SHIPPO_GET_MERCHANT_TRACK`

Tool to retrieve tracking status for a merchant from Shippo Platform API. Use when you need to get the current status, location, and history of a package for a specific merchant using carrier and tracking number.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `carrier` | string | Yes | 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. |
| `merchant_id` | string | Yes | Object ID of the merchant whose tracking to retrieve |
| `tracking_number` | string | Yes | Tracking number to track. The format varies by carrier (e.g., USPS: 9205590164917312751089, Shippo test: SHIPPO_DELIVERED). |
| `shippo_api_version` | string | No | String used to pick a non-default API version to use. If not specified, the default API version will be used. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Merchant Transaction

**Slug:** `SHIPPO_GET_MERCHANT_TRANSACTION`

Tool to retrieve a shipping label transaction for a merchant from the Shippo Platform API. Use when you need to get the details of an existing transaction for a merchant including tracking information, label URLs, and transaction status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `merchant_id` | string | Yes | Object ID of the merchant |
| `transaction_id` | string | Yes | Object ID of the transaction to retrieve |
| `shippo_api_version` | string | No | String used to pick a non-default API version to use. If not specified, the default API version will be used. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Order

**Slug:** `SHIPPO_GET_ORDER`

Tool to retrieve an order from Shippo. Use when you need to fetch details about a specific order including shipping addresses, line items, and transactions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `order_id` | string | Yes | Object ID of the order to retrieve. |
| `shippo_api_version` | string | No | String used to pick a non-default API version to use. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Parcel

**Slug:** `SHIPPO_GET_PARCEL`

Tool to retrieve a parcel by its ID. Use when you need to fetch details of an existing parcel object including dimensions, weight, and metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `parcel_id` | string | Yes | Object ID of the parcel to retrieve. |
| `shippo_api_version` | string | No | String used to pick a non-default API version to use. If not specified, the default API version will be used. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Rate

**Slug:** `SHIPPO_GET_RATE`

Tool to retrieve a specific shipping rate by its ID. Use when you need to fetch detailed rate information including pricing, carrier details, and service level.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `rate_id` | string | Yes | Object ID of the rate to retrieve. This is a unique identifier for the rate. |
| `shippo_api_version` | string | No | String used to pick a non-default API version to use. If not specified, the default API version will be used. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Refund

**Slug:** `SHIPPO_GET_REFUND`

Tool to retrieve a refund by its ID from Shippo. Use when you need to check the status or details of a specific refund transaction. Requires the refund_id which is obtained when creating a refund.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `refund_id` | string | Yes | Object ID of the refund to retrieve. This is a unique identifier returned when creating a refund. |
| `shippo_api_version` | string | No | String used to pick a non-default API version to use. Optional header parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Shipment

**Slug:** `SHIPPO_GET_SHIPMENT`

Tool to retrieve a shipment by its ID. Use when you need to fetch details about a specific shipment including addresses, parcels, rates, and status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `shipment_id` | string | Yes | Object ID of the shipment to retrieve |
| `shippo_api_version` | string | No | String used to pick a non-default API version to use |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Shippo Account

**Slug:** `SHIPPO_GET_SHIPPO_ACCOUNT`

Tool to retrieve a Shippo Account from the Shippo Platform API. Use when you need to get the details of an existing Shippo Account using its object ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `shippo_account_id` | string | Yes | Object ID of the Shippo Account to retrieve |
| `shippo_api_version` | string | No | String used to pick a non-default API version to use. If not specified, the default API version will be used. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Tracking Status

**Slug:** `SHIPPO_GET_TRACK`

Tool to retrieve tracking status for a shipment from Shippo. Use when you need to get the current status, location, and history of a package using its carrier and tracking number.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `carrier` | string | Yes | 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` | string | Yes | Tracking number to track. The format varies by carrier (e.g., USPS: 9205590164917312751089, Shippo test: SHIPPO_DELIVERED). |
| `shippo_api_version` | string | No | String used to pick a non-default API version to use. If not specified, the default API version will be used. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Transaction

**Slug:** `SHIPPO_GET_TRANSACTION`

Tool to retrieve a shipping label transaction by its ID. Use when you need to get the details of an existing transaction including tracking information, label URLs, and transaction status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `transaction_id` | string | Yes | Object ID of the transaction to retrieve |
| `shippo_api_version` | string | No | String used to pick a non-default API version to use. If not specified, the default API version will be used. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get User Parcel Template

**Slug:** `SHIPPO_GET_USER_PARCEL_TEMPLATE`

Tool to retrieve a specific user-created parcel template by its object ID. Use when you need to get dimensions and specifications for a custom parcel template.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `shippo_api_version` | string | No | String used to pick a non-default API version to use. If not specified, the default API version will be used. |
| `user_parcel_template_object_id` | string | Yes | Object ID of the user parcel template to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Webhook

**Slug:** `SHIPPO_GET_WEBHOOK`

Tool to retrieve a specific webhook subscription from Shippo. Use when you need to get the details of an existing webhook using its object ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `webhook_id` | string | Yes | Object ID of the webhook to retrieve. This is the unique identifier returned when creating a webhook. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Addresses

**Slug:** `SHIPPO_LIST_ADDRESSES`

Tool to list all addresses in the Shippo account with pagination support. Use when you need to retrieve stored addresses for shipment creation or management.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | The page number you want to select |
| `results` | integer | No | The number of results to return per page (max 100) |
| `SHIPPO_API_VERSION` | string | No | String used to pick a non-default API version to use |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Carrier Accounts

**Slug:** `SHIPPO_LIST_CARRIER_ACCOUNTS`

Tool to list all carrier accounts configured in the Shippo account with pagination support. Use when you need to retrieve carrier accounts for shipment creation or management.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | The page number you want to select |
| `results` | integer | No | The number of results to return per page (max 100) |
| `SHIPPO_API_VERSION` | string | No | String used to pick a non-default API version to use |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Carrier Parcel Templates

**Slug:** `SHIPPO_LIST_CARRIER_PARCEL_TEMPLATES`

Tool to list all carrier parcel templates available for creating shipments. Use when you need to retrieve standardized parcel dimensions provided by carriers like FedEx, USPS, UPS, etc.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `carrier` | string | No | Filter templates by specific carrier name (e.g., 'fedex', 'usps', 'ups') |
| `include` | string ("all" | "user" | "enabled") | No | Filter templates by type: 'all' returns all templates, 'user' returns only user-created templates, 'enabled' returns only enabled templates |
| `shippo_api_version` | string | No | String used to pick a non-default API version to use |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Customs Declarations

**Slug:** `SHIPPO_LIST_CUSTOMS_DECLARATIONS`

Tool to list all customs declarations in the Shippo account with pagination support. Use when you need to retrieve customs declarations for international shipments.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | The page number you want to select |
| `results` | integer | No | The number of results to return per page (max 100) |
| `SHIPPO_API_VERSION` | string | No | String used to pick a non-default API version to use |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Customs Items

**Slug:** `SHIPPO_LIST_CUSTOMS_ITEMS`

Tool to list all customs items with pagination support. Use when you need to retrieve customs declarations for international shipments.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | The page number you want to select |
| `results` | integer | No | The number of results to return per page (max 100) |
| `SHIPPO-API-VERSION` | string | No | String used to pick a non-default API version to use |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Manifests

**Slug:** `SHIPPO_LIST_MANIFESTS`

Tool to list all shipping manifests from Shippo. Use when you need to retrieve a paginated list of manifests with optional filtering by page number and results per page.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Merchant Addresses

**Slug:** `SHIPPO_LIST_MERCHANT_ADDRESSES`

Tool to list all addresses for a specific merchant using the Shippo Platform API. Use when you need to retrieve merchant addresses with pagination support.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | The page number you want to select |
| `results` | integer | No | The number of results to return per page (max 100) |
| `merchant_id` | string | Yes | Object ID of the merchant whose addresses you want to list |
| `shippo_api_version` | string | No | String used to pick a non-default API version to use |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Merchant Carrier Accounts

**Slug:** `SHIPPO_LIST_MERCHANT_CARRIER_ACCOUNTS`

Tool to list all carrier accounts for a specific merchant using the Shippo Platform API. Use when you need to retrieve carrier accounts configured for a merchant in a platform context.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | The page number you want to select |
| `results` | integer | No | The number of results to return per page (max 100) |
| `merchant_id` | string | Yes | Object ID of the merchant whose carrier accounts to list |
| `shippo_api_version` | string | No | String used to pick a non-default API version to use |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Merchant Customs Declarations

**Slug:** `SHIPPO_LIST_MERCHANT_CUSTOMS_DECLARATIONS`

Tool to list all customs declarations for a specific merchant using the Shippo Platform API. Use when you need to retrieve merchant customs declarations for international shipments.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | The page number you want to select |
| `results` | integer | No | The number of results to return per page (max 100) |
| `merchant_id` | string | Yes | Object ID of the merchant whose customs declarations you want to list |
| `shippo_api_version` | string | No | String used to pick a non-default API version to use |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Merchant Customs Items

**Slug:** `SHIPPO_LIST_MERCHANT_CUSTOMS_ITEMS`

Tool to list all customs items for a specific merchant using the Shippo Platform API. Use when you need to retrieve merchant customs items for international shipments.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | The page number you want to select |
| `results` | integer | No | The number of results to return per page (max 100) |
| `merchant_id` | string | Yes | Object ID of the merchant whose customs items you want to list |
| `shippo_api_version` | string | No | String used to pick a non-default API version to use |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Merchant Manifests

**Slug:** `SHIPPO_LIST_MERCHANT_MANIFESTS`

Tool to list all manifests for a specific merchant using Shippo's Platform API. Use when you need to retrieve manifests for a merchant account with optional pagination.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Merchant Parcels

**Slug:** `SHIPPO_LIST_MERCHANT_PARCELS`

Tool to list all parcels for a specific merchant using the Shippo Platform API. Use when you need to retrieve merchant parcels with pagination support.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | The page number you want to select |
| `results` | integer | No | The number of results to return per page (max 100) |
| `merchant_id` | string | Yes | Object ID of the merchant whose parcels you want to list |
| `shippo_api_version` | string | No | String used to pick a non-default API version to use |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Merchants

**Slug:** `SHIPPO_LIST_MERCHANTS`

Tool to list all merchants using the Shippo Platform API with pagination support. Use when you need to retrieve merchant accounts in a platform context.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | The page number you want to select |
| `results` | integer | No | The number of results to return per page (max 100) |
| `SHIPPO_API_VERSION` | string | No | String used to pick a non-default API version to use |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Merchant Shipment Rates by Currency

**Slug:** `SHIPPO_LIST_MERCHANT_SHIPMENT_RATES_BY_CURRENCY`

Tool to retrieve available shipping rates for a merchant's shipment filtered by currency code using the Shippo Platform API. Use when you need to compare carrier pricing in a specific currency for a merchant's shipment.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | The page number you want to select |
| `results` | integer | No | The number of results to return per page (max 100) |
| `merchant_id` | string | Yes | Object ID of the merchant |
| `shipment_id` | string | Yes | Object ID of the shipment to retrieve rates for |
| `currency_code` | string | Yes | ISO currency code to filter rates by (e.g., USD, EUR, GBP) |
| `shippo_api_version` | string | No | String used to pick a non-default API version to use |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Merchant Shipments

**Slug:** `SHIPPO_LIST_MERCHANT_SHIPMENTS`

Tool to list all shipments for a specific merchant using Shippo's Platform API. Use when you need to retrieve shipments for a merchant account with optional pagination.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Merchant Transactions

**Slug:** `SHIPPO_LIST_MERCHANT_TRANSACTIONS`

Tool to list all shipping label transactions for a merchant using the Shippo Platform API. Use when you need to retrieve shipping labels created for a specific merchant with pagination support.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | The page number you want to select |
| `results` | integer | No | The number of results to return per page (max 100) |
| `merchant_id` | string | Yes | Object ID of the merchant to retrieve transactions for |
| `SHIPPO_API_VERSION` | string | No | String used to pick a non-default API version to use |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Orders

**Slug:** `SHIPPO_LIST_ORDERS`

Tool to list all orders in the Shippo account with pagination support. Use when you need to retrieve customer orders for creating shipments or managing order fulfillment.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | The page number you want to select |
| `results` | integer | No | The number of results to return per page (max 100) |
| `SHIPPO_API_VERSION` | string | No | String used to pick a non-default API version to use |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Refunds

**Slug:** `SHIPPO_LIST_REFUNDS`

Tool to retrieve a list of all refunds from Shippo. Use when you need to view refund history, check refund statuses, or audit reimbursements for unused shipping labels. Supports pagination for large result sets.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Service Groups

**Slug:** `SHIPPO_LIST_SERVICE_GROUPS`

Tool to retrieve all service groups configured in Shippo. Use when you need to view available shipping service groups, their configurations, rates, and service levels.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `shippo_api_version` | string | No | String used to pick a non-default API version to use. If not provided, the default API version will be used. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Shipment Rates

**Slug:** `SHIPPO_LIST_SHIPMENT_RATES`

Tool to retrieve available shipping rates for a specific shipment. Use when you need to compare carrier pricing and service options for a shipment.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | The page number you want to select |
| `results` | integer | No | The number of results to return per page (max 100) |
| `ShipmentId` | string | Yes | Object ID of the shipment to retrieve rates for |
| `SHIPPO_API_VERSION` | string | No | String used to pick a non-default API version to use |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Shipment Rates by Currency

**Slug:** `SHIPPO_LIST_SHIPMENT_RATES_BY_CURRENCY`

Tool to retrieve available shipping rates for a specific shipment filtered by currency code. Use when you need to compare carrier pricing in a specific currency (e.g., USD, EUR, GBP).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | The page number you want to select |
| `results` | integer | No | The number of results to return per page (max 100) |
| `ShipmentId` | string | Yes | Object ID of the shipment to retrieve rates for |
| `CurrencyCode` | string | Yes | ISO currency code to filter rates by (e.g., USD, EUR, GBP) |
| `SHIPPO_API_VERSION` | string | No | String used to pick a non-default API version to use |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Shipments

**Slug:** `SHIPPO_LIST_SHIPMENTS`

Tool to list all shipments in the Shippo account with pagination support. Use when you need to retrieve shipment records, check shipment status, or manage shipping operations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | The page number you want to select |
| `results` | integer | No | The number of results to return per page (max 100) |
| `SHIPPO_API_VERSION` | string | No | String used to pick a non-default API version to use |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Shippo Accounts

**Slug:** `SHIPPO_LIST_SHIPPO_ACCOUNTS`

Tool to list all Managed Shippo Accounts. Use when you need to retrieve all Shippo Accounts associated with your platform account. Supports pagination for large result sets.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination. Use to retrieve subsequent pages of results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List User Parcel Templates

**Slug:** `SHIPPO_LIST_USER_PARCEL_TEMPLATES`

Tool to list all user-created parcel templates. Use when you need to retrieve custom parcel dimensions and configurations that were created by the user.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `shippo_api_version` | string | No | String used to pick a non-default API version to use. If not specified, the default API version will be used. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Purchase Merchant Batch

**Slug:** `SHIPPO_PURCHASE_MERCHANT_BATCH`

Tool to purchase a batch for a merchant via the Shippo Platform API. Use when you need to purchase a previously created batch of shipments. The batch must be in VALID status before it can be purchased.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `batch_id` | string | Yes | Object ID of the batch to purchase |
| `merchant_id` | string | Yes | Object ID of the merchant |
| `shippo_api_version` | string | No | String used to pick a non-default API version to use. If not specified, the default API version will be used. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Shipments From Batch

**Slug:** `SHIPPO_REMOVE_SHIPMENTS_FROM_BATCH`

Tool to remove shipments from a batch for a merchant using the Shippo Platform API. Use when you need to remove one or more shipments from an existing batch before purchase or during batch management.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `batch_id` | string | Yes | Object ID of the batch from which to remove shipments |
| `merchant_id` | string | Yes | Object ID of the merchant who owns the batch |
| `shipment_ids` | array | Yes | Array of shipment object IDs to remove from the batch. Each ID must be a valid shipment identifier. |
| `shippo_api_version` | string | No | String used to pick a non-default API version to use. If not specified, the default API version will be used. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Carrier Account

**Slug:** `SHIPPO_UPDATE_CARRIER_ACCOUNT`

Tool to update an existing carrier account in Shippo. Use when you need to modify carrier account settings such as activation status, account credentials, or carrier-specific parameters.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Default Parcel Template

**Slug:** `SHIPPO_UPDATE_DEFAULT_PARCEL_TEMPLATE`

Tool to update the default parcel template for live rates at checkout in Shippo. Use when you need to set a specific parcel template as the default for calculating shipping rates.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `object_id` | string | Yes | 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. |
| `SHIPPO-API-VERSION` | string | No | Optional string used to pick a non-default API version to use. If not provided, the default API version will be used. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Merchant

**Slug:** `SHIPPO_UPDATE_MERCHANT`

Tool to update an existing merchant in Shippo Platform API. Use when you need to modify merchant details such as name, email, or business information. This action requires Platform API authentication.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | The merchant's email address. This field is required. |
| `last_name` | string | Yes | The merchant's last name. This field is required. |
| `first_name` | string | Yes | The merchant's first name. This field is required. |
| `merchant_id` | string | Yes | Object ID of the merchant to update (e.g., '5d23a7d95cef472fbdf4758dd7564f48'). |
| `merchant_name` | string | Yes | The merchant's business/company name. This field is required. |
| `shippo_api_version` | string | No | Optional string to specify a non-default API version to use for this request. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Merchant Carrier Account

**Slug:** `SHIPPO_UPDATE_MERCHANT_CARRIER_ACCOUNT`

Tool to update a carrier account for a merchant in Shippo Platform API. Use when you need to modify merchant carrier account settings such as activation status, billing address, or UPS-specific parameters. Requires Platform API authentication with merchant context.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Service Group

**Slug:** `SHIPPO_UPDATE_SERVICE_GROUP`

Tool to update an existing Shippo service group. Use when you need to modify service group details such as name, description, rate adjustment, or service levels.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Name of the service group |
| `type` | string | No | Type of service group (e.g., FLAT_RATE, LIVE_RATE) |
| `flat_rate` | string | No | Flat rate amount (used when type is FLAT_RATE) |
| `is_active` | boolean | No | Whether the service group is active |
| `object_id` | string | Yes | The object ID of the service group being updated |
| `description` | string | No | Description of the service group |
| `service_levels` | array | No | Array of service level configurations to associate with this group |
| `rate_adjustment` | integer | No | Rate adjustment value as percentage (e.g., 10 for 10% increase, -5 for 5% decrease) |
| `flat_rate_currency` | string | No | Currency for the flat rate (ISO 4217 currency code) |
| `free_shipping_threshold_min` | string | No | Minimum amount for free shipping threshold |
| `free_shipping_threshold_currency` | string | No | Currency for free shipping threshold (ISO 4217 currency code) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update User Parcel Template

**Slug:** `SHIPPO_UPDATE_USER_PARCEL_TEMPLATE`

Tool to update an existing user parcel template with new weight and carrier template settings. Use when you need to modify the dimensions or weight of a previously created custom parcel template.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Webhook

**Slug:** `SHIPPO_UPDATE_WEBHOOK`

Tool to update an existing webhook in Shippo. Use when you need to modify webhook settings such as the event type, URL endpoint, activation status, or test mode flag.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Validate Address

**Slug:** `SHIPPO_VALIDATE_ADDRESS`

Tool to validate an address using the Shippo API. Use when you need to verify that a shipping address is valid and complete before creating a shipment.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `address_id` | string | Yes | Object ID of the address to validate. This is the unique identifier returned when an address was created. |
| `shippo_api_version` | string | No | Optional API version string to use a non-default API version. If not provided, the default API version will be used. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Validate Merchant Address

**Slug:** `SHIPPO_VALIDATE_MERCHANT_ADDRESS`

Tool to validate a merchant address using the Shippo Platform API. Use when you need to verify that a merchant's shipping address is valid and complete.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `address_id` | string | Yes | Object ID of the address to validate. This is the unique identifier of the address object to be validated. |
| `merchant_id` | string | Yes | Object ID of the merchant. This is the unique identifier for the merchant whose address you want to validate. |
| `shippo_api_version` | string | No | Optional API version string to use a non-default API version. If not specified, the default API version will be used. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |