Shippo
Your Toolhouse AI Worker can connect to Shippo using 95 specialized tools.
Auth Connection
This service requires an auth connection to use its tools. You can set this up in your Toolhouse dashboard under Auth Connections.
Tools (95)
Shippo Create Address
Shippo Create AddressIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
zip
string
✅
"94105"
ZIP or postal code. Format varies by country (e.g., 94105 for US, SW1A 1AA for UK).
city
string
✅
"San Francisco"
City name for the address. Required for most countries.
name
string
✅
"John Doe"
Full name of the person or business at this address. Required for shipping labels.
email
string
"john.doe@example.com"
Contact email address. Used for shipping notifications and updates.
phone
string
"+1 555-123-4567"
Contact phone number including country code. Format: +[country code] [number]. Recommended for delivery notifications.
state
string
✅
"CA"
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
"Acme Corp"
Company or business name if this is a commercial address.
country
string
✅
"US"
2-letter ISO country code (e.g., US, GB, CA). Required field for all addresses.
street1
string
✅
"123 Main St"
Primary street address line. Required field for all addresses.
street2
string
"Apt 4B"
Secondary street address line for apartment, suite, or unit numbers.
street3
string
"Building C"
Third street address line for additional address details if needed.
metadata
string
"customer_id:12345"
Custom metadata string to attach to this address for your own reference. Maximum 100 characters.
validate
boolean
—
Set to true to validate the address with the carrier before creating. Recommended to catch address errors early.
street_no
string
"123"
Street number for countries that separate street number from street name.
is_residential
boolean
—
Set to true if this is a residential address, false for commercial. Affects shipping rates and delivery options.
SHIPPO-API-VERSION
string
"2018-02-08"
String used to pick a non-default API version to use. Leave empty to use the default version.
Shippo Create Batch
Shippo Create BatchIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
metadata
string
—
Custom metadata string for the batch (max 100 characters)
label_filetype
string
—
Format for the shipping label (e.g., 'PDF', 'PNG', 'ZPLII'). If not specified, defaults to PDF.
batch_shipments
array
✅
—
List of shipments to include in the batch. Each shipment must contain address_from, address_to, and parcels.
shippo_api_version
string
—
String used to pick a non-default API version to use
default_carrier_account
string
✅
"17641e416b62415ea39c24ec354e2560"
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
✅
"canada_post_expedited_parcel"
Service level token for the shipment (e.g., 'usps_priority', 'canada_post_expedited_parcel')
Shippo Create Carrier Account
Shippo Create Carrier AccountIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
test
boolean
true
Whether this is a test account.
active
boolean
✅
true
Whether the carrier account is active.
carrier
string
✅
"ups"
The carrier name to create an account for, e.g., 'ups'.
metadata
string
"UPS Test Account"
Optional metadata string to associate with the carrier account.
account_id
string
✅
"ups_account_001"
Account identifier used to reference this carrier account. Must not be blank.
parameters
object
✅
—
Carrier-specific parameters required for account creation. For UPS, this includes billing address, contact information, and invoice details.
Shippo Create Customs Item
Shippo Create Customs ItemIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
metadata
string
"Internal reference: 2024-Q1"
Custom metadata string for storing additional information about the customs item.
quantity
integer
✅
1
Quantity of this item in the shipment. Must be a positive integer.
sku_code
string
"TSHIRT-BLK-M"
Stock Keeping Unit code or product identifier for inventory tracking.
mass_unit
string
✅
"lb"
Unit of measurement for the weight. Common values: 'lb' (pounds), 'kg' (kilograms), 'oz' (ounces), 'g' (grams).
eccn_ear99
string
"EAR99"
Export Control Classification Number (ECCN) or EAR99 designation for export control purposes.
net_weight
string
✅
"0.4"
Net weight of the item (total weight for all units). Numeric string value.
description
string
✅
"T-Shirt"
Text description of the item being shipped for customs purposes.
value_amount
string
✅
"20.00"
Monetary value of the item. Numeric string with up to 2 decimal places.
tariff_number
string
"6109.10.0012"
Harmonized Tariff Schedule (HTS) code for the item. Used for customs classification.
origin_country
string
✅
"US"
Two-letter ISO 3166-1 alpha-2 country code of the item's origin country.
value_currency
string
✅
"USD"
Three-letter ISO 4217 currency code for the item value.
SHIPPO_API_VERSION
string
"2018-02-08"
Optional API version to use for this request. If not specified, uses the default API version.
Shippo Create Live Rate
Shippo Create Live RateIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
parcel
array
—
Array of parcel objects or parcel template IDs. If not provided, dimensions are calculated from line items.
address_to
—
✅
{"zip":"94117","city":"San Francisco","name":"John Doe","state":"CA","country":"US","street1":"215 Clayton St"}
Destination address - either an address object ID string or a full address object
line_items
array
✅
—
Array of line item objects describing what is being shipped. At least one item is required.
address_from
—
{"zip":"90001","city":"Los Angeles","name":"Sender Name","state":"CA","country":"US","street1":"123 Main St"}
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
"2018-02-08"
String used to pick a non-default API version to use
Shippo Create Manifest
Shippo Create ManifestIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
address_from
string
✅
"3fcac87c5f844987953d067409d37c2c"
Object ID of the address the manifest will be sent from. Must be a valid address object ID.
transactions
array
["87e558af5d1d4bc985867f053d380dc6"]
List of transaction object IDs to be included in the manifest. Each ID must be a valid transaction object ID.
shipment_date
string
✅
"2026-02-12T13:40:54Z"
Date and time of the shipment in ISO 8601 format. This is the date that will be printed on the manifest.
async_manifest
boolean
true
If true, the manifest will be created asynchronously. If false or not specified, it will be created synchronously.
carrier_account
string
✅
"b499f1a7f43743289c4fc1c56e81aae7"
Object ID of the carrier account to be used for this manifest. Must be a valid carrier account object ID.
shippo_api_version
string
"2018-02-08"
String used to pick a non-default API version to use for this request.
Shippo Create Merchant Address
Shippo Create Merchant AddressIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
zip
string
"94117"
ZIP or postal code. Format varies by country (e.g., 94117 for US, SW1A 1AA for UK). Required for purchase.
city
string
✅
"San Francisco"
City name for the address. Required for purchase.
name
string
✅
"Shwan Ippotle"
Full name of the person or business at this address. Required for purchase.
email
string
"shippotle@goshippo.com"
Contact email address. Used for notifications and updates.
phone
string
"+1 555 341 9393"
Contact phone number including country code. Format: +[country code] [number].
state
string
"CA"
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
"Shippo"
Company or business name if this is a commercial address.
country
string
✅
"US"
2-letter ISO country code (e.g., US, GB, CA). Required field for all addresses.
street1
string
✅
"215 Clayton St."
Primary street address line. Required for purchase.
street2
string
"Apt 4B"
Secondary street address line for apartment, suite, or unit numbers.
metadata
string
"Customer ID 123456"
Custom metadata string to attach to this address for your own reference.
validate
boolean
true
Set to true to validate the address with the carrier before creating. Recommended to catch address errors early.
merchant_id
string
✅
"5d23a7d95cef472fbdf4758dd7564f48"
Object ID of the merchant to create the address for. This is the merchant's unique identifier in Shippo's system.
is_residential
boolean
true
Set to true if this is a residential address, false for commercial. Affects shipping rates and delivery options.
SHIPPO-API-VERSION
string
"2018-02-08"
String used to pick a non-default API version to use. Leave empty to use the default version.
Shippo Create Merchant Batch
Shippo Create Merchant BatchIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
metadata
string
"Test Batch via API"
Custom metadata string to attach to the batch for your reference (max 100 characters).
merchant_id
string
✅
"5d23a7d95cef472fbdf4758dd7564f48"
Object ID of the merchant for whom to create the batch. This identifies which merchant account the batch belongs to.
label_filetype
string
"PDF_4x6"
Label file format options.
batch_shipments
array
✅
—
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
"2018-02-08"
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
✅
"b499f1a7f43743289c4fc1c56e81aae7"
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
✅
"usps_ground_advantage"
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.
Shippo Create Merchant Carrier Account
Shippo Create Merchant Carrier AccountIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
test
boolean
true
Whether this is a test account.
active
boolean
✅
true
Whether the carrier account is active.
carrier
string
✅
"ups"
The carrier name to create an account for (e.g., 'ups').
metadata
string
"Test UPS Account Verification"
Optional metadata string to associate with the carrier account.
account_id
string
✅
""
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
✅
—
Carrier-specific parameters required for account creation. For UPS, this includes billing address, contact information, and invoice details.
merchant_id
string
✅
"5d23a7d95cef472fbdf4758dd7564f48"
Object ID of the merchant to create a carrier account for.
shippo_api_version
string
"2018-02-08"
String used to pick a non-default API version to use. If not specified, the default API version will be used.
Shippo Create Merchant Customs Declaration
Shippo Create Merchant Customs DeclarationIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
test
boolean
true
Indicates whether to create this in test mode. Use true for testing without affecting production data. Optional field.
items
array
✅
—
Array of customs items included in this declaration. At least one item is required.
notes
string
"Handle with care"
Additional notes or instructions to be included in the customs declaration. Optional field.
aes_itn
string
"X20140131123456"
AES / ITN (Automated Export System / Internal Transaction Number) reference. Required if eel_pfc is 'AES_ITN'. Optional otherwise.
certify
boolean
✅
true
Expresses that the certify_signer has provided all information of the customs declaration truthfully. Required field.
eel_pfc
string
"NOEEI_30_37_a"
Export information - EEL (Exemption and Exclusion Legend) or PFC (Proof of Filing Citation) code. Optional field.
invoice
string
"#123123"
Invoice reference number of the shipment. Optional field.
license
string
"LIC-12345"
Export license reference of the shipment. Optional field.
incoterm
string
"DDU"
The incoterm reference of the shipment. Optional field.
metadata
string
"Order ID #123123"
Custom metadata string, up to 100 characters. Use for storing your own reference data. Optional field.
disclaimer
string
—
Disclaimer for the shipment and customs information. Optional field.
b13a_number
string
—
B13A number (Proof of Report, Summary ID, or Exemption Number). Must be provided if and only if b13a_filing_option is provided.
certificate
string
"CERT-67890"
Certificate reference of the shipment. Optional field.
merchant_id
string
✅
"5d23a7d95cef472fbdf4758dd7564f48"
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
✅
"MERCHANDISE"
Type of contents being shipped. Required field. Valid values: DOCUMENTS, GIFT, SAMPLE, MERCHANDISE, HUMANITARIAN_DONATION, RETURN_MERCHANDISE, OTHER.
certify_signer
string
✅
"Shawn Ippotle"
Name of the person responsible for the validity of all information provided in the customs declaration. Required field.
b13a_filing_option
string
—
B13A filing option for Canadian exports. Optional field.
commercial_invoice
string
—
Commercial invoice reference. Optional field.
exporter_reference
string
—
Exporter reference of an export shipment. Optional field.
importer_reference
string
—
Importer reference of an import shipment. Optional field.
shippo_api_version
string
"2018-02-08"
String used to pick a non-default API version to use. Leave empty to use the default version.
non_delivery_option
string
✅
"RETURN"
Action to take if delivery fails. Required field. Valid values: 'RETURN' (return to sender), 'ABANDON' (dispose of package).
contents_explanation
string
"T-Shirt purchase"
Explanation of the type of goods being shipped. Required if contents_type is 'OTHER'. Optional otherwise.
Shippo Create Merchant Customs Item
Shippo Create Merchant Customs ItemIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
metadata
string
"Order ID 123454"
Custom metadata string for storing additional information about the customs item. Optional field.
quantity
integer
✅
1
Quantity of this item in the shipment. Must be a positive integer. Required field.
sku_code
string
"HM-123"
The stock keeping unit value of this item. Optional field for inventory tracking.
mass_unit
string
✅
"g"
Unit of measurement for the weight. Required field. Valid values: 'g' (grams), 'kg' (kilograms), 'lb' (pounds), 'oz' (ounces).
eccn_ear99
string
"EAR99"
Export Control Classification Number (ECCN) or EAR99 designation for export control purposes. Optional field.
net_weight
string
✅
"5"
Net weight of the item (total weight for all units). Numeric string value. Required field.
description
string
✅
"T-Shirt"
Text description of the item being shipped for customs purposes. Required field.
merchant_id
string
✅
"5d23a7d95cef472fbdf4758dd7564f48"
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
✅
"200"
Monetary value of the item. Numeric string with up to 2 decimal places. Required field.
tariff_number
string
"6109.10.0012"
Harmonized Tariff Schedule (HTS) code for the item. Used for customs classification. Optional field.
origin_country
string
✅
"US"
Two-letter ISO 3166-1 alpha-2 country code of the item's origin country. Required field.
value_currency
string
✅
"USD"
Three-letter ISO 4217 currency code for the item value. Required field.
SHIPPO-API-VERSION
string
"2018-02-08"
String used to pick a non-default API version to use. Leave empty to use the default version.
Shippo Create Merchant Order
Shippo Create Merchant OrderIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
notes
string
"Test order for verification"
Custom buyer- or seller-provided notes about the order.
weight
string
✅
"2.5"
Total weight of the order.
currency
string
"USD"
Currency of the total_price and total_tax amounts. Required if total_price is provided.
placed_at
string
✅
"2026-02-12T15:30:00Z"
ISO 8601 timestamp when the order was placed by the customer (e.g., '2026-02-12T15:30:00Z').
total_tax
string
"4.50"
Total tax amount paid by the buyer for this order.
line_items
array
—
Array of line item objects representing the items in this order.
to_address
object
✅
—
Recipient shipping address for the order. Must include name, street, city, state, zip, and country.
merchant_id
string
✅
"5d23a7d95cef472fbdf4758dd7564f48"
Object ID of the merchant for whom to create the order. This identifies which merchant account the order belongs to.
total_price
string
"49.99"
Total amount paid by the buyer for this order.
weight_unit
string
✅
"lb"
Unit of weight measurement for the order (lb, oz, g, kg).
from_address
object
—
Address information for order.
order_number
string
"#TEST-2024"
Alphanumeric identifier for the order used by the seller/buyer. This identifier doesn't need to be unique.
order_status
string
"PAID"
Order status values.
shipping_cost
string
"10.00"
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
"35.49"
Subtotal price before shipping and taxes.
shipping_method
string
"USPS Priority Mail"
Shipping method (carrier + service or other free text description) chosen by the buyer.
shippo_api_version
string
"2018-02-08"
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
"USD"
Currency of the shipping_cost amount. Required if shipping_cost is provided.
Shippo Create Merchant Parcel
Shippo Create Merchant ParcelIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
test
boolean
true
Indicates whether the object should be created in test mode. Set to true for testing without affecting production data.
extra
object
—
Extra options for the parcel.
width
string
✅
"5"
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
✅
"5"
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
✅
"5"
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
✅
"2"
Weight of the parcel. Up to six digits in front and four digits after the decimal separator are accepted.
metadata
string
"Order #12345"
A string of up to 100 characters that can be filled with any additional information you want to attach to the object.
template
string
"USPS_LargeFlatRateBox"
Pre-defined parcel templates for common carrier packages.
mass_unit
string
✅
"lb"
The unit used for weight.
merchant_id
string
✅
"5d23a7d95cef472fbdf4758dd7564f48"
Object ID of the merchant to create the parcel for. This is the merchant's unique identifier in Shippo's system.
distance_unit
string
✅
"in"
The measure unit used for length, width and height. Required if template is not specified.
SHIPPO-API-VERSION
string
"2018-02-08"
String used to pick a non-default API version to use. Leave empty to use the default version.
Shippo Create Merchant Refund
Shippo Create Merchant RefundIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
async
boolean
false
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
✅
"5d23a7d95cef472fbdf4758dd7564f48"
Object ID of the merchant for whom to create the refund. This identifies which merchant account the refund belongs to.
transaction
string
✅
"915d94940ea54c3a80cbfa328722f5a1"
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
"2018-02-08"
String used to pick a non-default API version to use. If not specified, the default API version will be used.
Shippo Create Merchant Shipment
Shippo Create Merchant ShipmentIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
async
boolean
true
Set to true to process the shipment asynchronously. Default is false for synchronous processing.
extra
object
—
Extra options and services for the shipment.
parcels
array
✅
—
Array of parcel objects with dimensions and weight. Required field. Must contain at least one parcel.
metadata
string
"Customer ID 123456"
Custom metadata string to attach to this shipment for your own reference (up to 100 characters).
MerchantId
string
✅
"5d23a7d95cef472fbdf4758dd7564f48"
Object ID of the merchant to create the shipment for. This is the merchant's unique identifier in Shippo's system.
address_to
object
✅
—
Recipient/destination address information. Required field.
address_from
object
✅
—
Sender/origin address information. Required field.
shipment_date
string
"2021-03-22T12:00:00Z"
Date the shipment will be tendered to the carrier in ISO 8601 format. If not provided, defaults to current date.
address_return
object
—
Address information for shipment origin, destination, or return.
SHIPPO-API-VERSION
string
"2018-02-08"
String used to pick a non-default API version to use. Leave empty to use the default version.
customs_declaration
string
"adcfdddf8ec64b84ad22772bce3ea37a"
Customs declaration object ID for international shipments. Required for international shipments.
Shippo Create Merchant Transaction
Shippo Create Merchant TransactionIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
rate
string
✅
"6b56d8994b3140ceb2301a06e9259b22"
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
—
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
—
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
✅
"5d23a7d95cef472fbdf4758dd7564f48"
Object ID of the merchant for whom to create the transaction. This identifies which merchant account the transaction belongs to.
label_file_type
string
"PDF"
Label file format options.
shippo_api_version
string
"2018-02-08"
String used to pick a non-default API version to use. If not specified, the default API version will be used.
Shippo Create Order
Shippo Create OrderIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
notes
string
"Leave at front door"
Additional notes or instructions for the order.
weight
string
"1.5"
Total weight of the order. Required if line_items are not provided.
currency
string
"USD"
Currency code for order prices (e.g., 'USD').
placed_at
string
✅
"2026-02-12T13:39:40.607Z"
ISO 8601 timestamp when the order was placed by the customer.
total_tax
string
"4.50"
Total tax amount for the order.
line_items
array
—
List of items included in this order.
to_address
object
✅
—
Recipient shipping address for the order.
total_price
string
"59.99"
Total price including shipping and taxes.
weight_unit
string
"lb"
Unit of weight measurement for the total order weight.
from_address
object
—
Origin/sender address for the order. If not provided, uses account default.
order_number
string
"TEST-ORDER-001"
Unique order identifier from your system for reference.
order_status
string
"PAID"
Current status of the order (e.g., 'PAID', 'PROCESSING', 'SHIPPED').
shipping_cost
string
"5.50"
Shipping cost charged to the customer.
subtotal_price
string
"49.99"
Subtotal price before shipping and taxes.
shipping_method
string
"Ground"
Shipping method selected by the customer.
shipping_cost_currency
string
"USD"
Currency code for the shipping cost.
Shippo Create Parcel
Shippo Create ParcelIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
test
boolean
true
Indicates whether the object should be created in test mode. Set to true for testing without affecting production data.
extra
object
—
Extra options for the parcel.
width
string
✅
"8"
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
✅
"6"
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
✅
"10"
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
✅
"2"
Weight of the parcel. Up to six digits in front and four digits after the decimal separator are accepted.
metadata
string
"Order #12345"
A string of up to 100 characters that can be filled with any additional information you want to attach to the object.
template
string
—
Parcel template ID. If template is passed, length, width, height, and distance_unit are not required.
mass_unit
string
✅
"lb"
The unit used for weight. Required if template is not specified.
distance_unit
string
✅
"in"
The measure unit used for length, width and height. Required if template is not specified.
Shippo Create Refund
Shippo Create RefundIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
async
boolean
false
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
✅
"915d94940ea54c3a80cbfa328722f5a1"
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
"2018-02-08"
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.
Shippo Create Service Group
Shippo Create Service GroupIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
name
string
✅
"Standard Shipping"
Name of the service group. Used to identify the group in the dashboard and API responses.
type
string
✅
—
Pricing model for the service group: FLAT_RATE (fixed price), FREE_SHIPPING (no charge), or RATE_ADJUSTMENT (percentage adjustment).
flat_rate
string
"15.00"
Fixed shipping rate as a decimal string (e.g., '15.00'). Required when type is FLAT_RATE.
description
string
✅
"Standard ground shipping for domestic orders"
Description of the service group explaining its purpose or use case.
service_levels
array
✅
—
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
10
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
"USD"
Three-letter ISO currency code for flat_rate (e.g., 'USD', 'EUR'). Required when flat_rate is provided.
shippo_api_version
string
"2018-02-08"
Optional API version to use for this request. If not specified, the default API version will be used.
free_shipping_threshold_min
string
"50.00"
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
"USD"
Three-letter ISO currency code for free_shipping_threshold_min. Required when free_shipping_threshold_min is provided.
Shippo Create Shipment
Shippo Create ShipmentIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
async
boolean
—
Whether to process shipment asynchronously. Set to false for synchronous rate generation.
extra
object
—
Additional parameters for shipment-specific features such as insurance and signature confirmation
parcels
array
✅
—
List of parcels included in the shipment. Must contain at least one parcel.
metadata
string
—
Optional metadata string to attach to the shipment (up to 100 characters)
address_to
object
✅
—
Destination address for the shipment
address_from
object
✅
—
Origin address for the shipment
shipment_date
string
"2023-12-25T10:30:00Z"
Date the shipment will be shipped (ISO 8601 format)
address_return
object
—
Address model for shipment origin and destination.
shippo_api_version
string
—
API version to use for this request
customs_declaration
string
—
Object ID of the customs declaration for international shipments
Shippo Create Track
Shippo Create TrackIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
carrier
string
✅
"usps"
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
"Order 000123"
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
✅
"9205590164917312751089"
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
"2018-02-08"
String used to pick a non-default API version to use. Leave empty to use the default version.
Shippo Create Transaction
Shippo Create TransactionIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
rate
string
"ec9f0d3adc9441449c85d315f0997fd5"
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
—
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
—
A string of up to 100 characters that can be filled with any additional information you want to attach to the transaction object.
shipment
—
—
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
"a4391cd4ab974f478f55dc08b5c8e3b3"
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"
File format for the shipping label.
servicelevel_token
string
"usps_priority"
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
"2018-02-08"
Optional API version string to use for this request. If not specified, the default API version will be used.
Shippo Create User Parcel Template
Shippo Create User Parcel TemplateIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
weight
string
"1.5"
Weight of the parcel. Up to six digits in front and four digits after the decimal separator are accepted.
template
string
"USPS_FlatRateEnvelope"
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
"lb"
Unit of measurement for weight (e.g., 'lb' for pounds, 'kg' for kilograms, 'oz' for ounces, 'g' for grams).
shippo_api_version
string
"2018-02-08"
String used to pick a non-default API version to use. If not specified, the default API version will be used.
Shippo Create Webhook
Shippo Create WebhookIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
url
string
✅
"https://webhook.site/test-endpoint"
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"
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
—
Whether this is a test webhook. Set to true for testing purposes. Defaults to false if not specified.
Shippo Delete Default Parcel Template
Shippo Delete Default Parcel TemplateIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
SHIPPO_API_VERSION
string
—
String used to pick a non-default API version to use
Shippo Delete User Parcel Template
Shippo Delete User Parcel TemplateIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
shippo_api_version
string
"2018-02-08"
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
✅
"83ce1cff0df54caabe60c1c1fe1f441c"
Object ID of the user parcel template to delete. This is the unique identifier returned when the template was created or listed.
Shippo Delete Webhook
Shippo Delete WebhookIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
webhook_id
string
✅
"e1e7db3cf09c4e9e84da09ae404dd0f6"
Object ID of the webhook to delete. This is the unique identifier returned when creating a webhook.
shippo_api_version
string
"2018-02-08"
String used to pick a non-default API version to use. Leave empty to use the default version.
Shippo Get Address
Shippo Get AddressIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
address_id
string
✅
"e5377baf22634afc82d07db99981db52"
Object ID of the address to retrieve
shippo_api_version
string
"2018-02-08"
String used to pick a non-default API version to use. If not specified, the default API version will be used.
Shippo Get Carrier Account
Shippo Get Carrier AccountIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
carrier_account_id
string
✅
"2bf70116c96f40159b54c16f022586c7"
Object ID of the carrier account to retrieve.
shippo_api_version
string
"2018-02-08"
String used to pick a non-default API version to use.
Shippo Get Carrier Parcel Template
Shippo Get Carrier Parcel TemplateIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
shippo_api_version
string
"2018-02-08"
String used to pick a non-default API version to use
carrier_parcel_template_token
string
✅
"FedEx_Tube"
The unique string representation of the carrier parcel template
Shippo Get Carrier Registration Status
Shippo Get Carrier Registration StatusIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
carrier
string
✅
"ups"
Filter by specific carrier (e.g., 'ups', 'fedex', 'usps', 'dhl_express')
Shippo Get Customs Declaration
Shippo Get Customs DeclarationIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
page
integer
1
The page number you want to select
shippo_api_version
string
"2018-02-08"
String used to pick a non-default API version to use
customs_declaration_id
string
✅
"5b39ca5aa12248649f43423f909a9643"
Object ID of the customs declaration to retrieve
Shippo Get Customs Item
Shippo Get Customs ItemIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
page
integer
1
The page number you want to select. Use this for pagination if the API returns multiple pages of results.
customs_item_id
string
✅
"a29c057124b645fead6d08f2ae6889a1"
Object ID of the customs item to retrieve.
shippo_api_version
string
"2018-02-08"
String used to pick a non-default API version to use. Only use this if you need a specific API version.
Shippo Get Default Parcel Template
Shippo Get Default Parcel TemplateIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
shippo_api_version
string
"2018-02-08"
String used to pick a non-default API version to use. If not specified, the default API version will be used.
Shippo Get Merchant
Shippo Get MerchantIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
merchant_id
string
✅
"5d23a7d95cef472fbdf4758dd7564f48"
Object ID of the merchant to retrieve
shippo_api_version
string
"2018-02-08"
String used to pick a non-default API version to use. If not specified, the default API version will be used.
Shippo Get Merchant Address
Shippo Get Merchant AddressIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
address_id
string
✅
"a2e71ee8ca194b3a831513a241ca8a7b"
Object ID of the address to retrieve
merchant_id
string
✅
"5d23a7d95cef472fbdf4758dd7564f48"
Object ID of the merchant whose address to retrieve
shippo_api_version
string
"2018-02-08"
String used to pick a non-default API version to use. If not specified, the default API version will be used.
Shippo Get Merchant Batch
Shippo Get Merchant BatchIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
batch_id
string
✅
"dad25a76c83045648752a52ba5f3ec94"
Object ID of the batch
merchant_id
string
✅
"5d23a7d95cef472fbdf4758dd7564f48"
Object ID of the merchant
shippo_api_version
string
"2018-02-08"
String used to pick a non-default API version to use. If not specified, the default API version will be used.
Shippo Get Merchant Carrier Account
Shippo Get Merchant Carrier AccountIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
merchant_id
string
✅
"5d23a7d95cef472fbdf4758dd7564f48"
Object ID of the merchant whose carrier account to retrieve.
carrier_account_id
string
✅
"15c67bc9e2694e7c896c8d995d313442"
Object ID of the carrier account to retrieve.
shippo_api_version
string
"2018-02-08"
String used to pick a non-default API version to use.
Shippo Get Merchant Carrier Registration Status
Shippo Get Merchant Carrier Registration StatusIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
carrier
string
✅
"ups"
The carrier to check registration status for. Must be one of: ups, usps, or canada_post.
merchant_id
string
✅
"5d23a7d95cef472fbdf4758dd7564f48"
Object ID of the merchant. This is the merchant's unique identifier in Shippo's Platform API system.
SHIPPO-API-VERSION
string
"2018-02-08"
String used to pick a non-default API version to use. Leave empty to use the default version.
Shippo Get Merchant Customs Declaration
Shippo Get Merchant Customs DeclarationIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
page
integer
1
The page number you want to select for paginated results
merchant_id
string
✅
"5d23a7d95cef472fbdf4758dd7564f48"
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
"2018-02-08"
String used to pick a non-default API version to use. Leave empty to use the default version.
customs_declaration_id
string
✅
"78a8b320305c4dacbfcc4fc822c02964"
Object ID of the customs declaration to retrieve. Use this to fetch a specific declaration by its unique identifier.
Shippo Get Merchant Customs Item
Shippo Get Merchant Customs ItemIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
page
integer
1
The page number you want to select
merchant_id
string
✅
"5d23a7d95cef472fbdf4758dd7564f48"
Object ID of the merchant whose customs item you want to retrieve
customs_item_id
string
✅
"d63cf3dd281147f8a4989fb3c4338463"
Object ID of the customs item to retrieve
shippo_api_version
string
"2018-02-08"
String used to pick a non-default API version to use
Shippo Get Merchant Manifest
Shippo Get Merchant ManifestIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
manifest_id
string
✅
"9374e27c88e341c2ae6948c20dbdc307"
Object ID of the manifest to retrieve
merchant_id
string
✅
"5d23a7d95cef472fbdf4758dd7564f48"
Object ID of the merchant
shippo_api_version
string
"2018-02-08"
String used to pick a non-default API version to use. If not specified, the default API version will be used.
Shippo Get Merchant Order
Shippo Get Merchant OrderIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
order_id
string
✅
"f3abc66dd5534662a2433c6c4f6e3696"
Object ID of the order to retrieve
merchant_id
string
✅
"5d23a7d95cef472fbdf4758dd7564f48"
Object ID of the merchant
shippo_api_version
string
"2018-02-08"
String used to pick a non-default API version to use. If not specified, the default API version will be used.
Shippo Get Merchant Parcel
Shippo Get Merchant ParcelIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
parcel_id
string
✅
"1715d67e09dc4ddc9c1a95744d509641"
Object ID of the parcel to retrieve
merchant_id
string
✅
"5d23a7d95cef472fbdf4758dd7564f48"
Object ID of the merchant
shippo_api_version
string
"2018-02-08"
String used to pick a non-default API version to use. If not specified, the default API version will be used.
Shippo Get Merchant Rate
Shippo Get Merchant RateIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
rate_id
string
✅
"1abf06920ba14e19ab1c7e16612ac8d7"
Object ID of the rate to retrieve. This is a unique identifier for the rate.
merchant_id
string
✅
"5d23a7d95cef472fbdf4758dd7564f48"
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
"2018-02-08"
String used to pick a non-default API version to use. If not specified, the default API version will be used.
Shippo Get Merchant Refund
Shippo Get Merchant RefundIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
refund_id
string
✅
"f0069de164b247048ef10b7afcc65843"
Object ID of the refund to retrieve
merchant_id
string
✅
"5d23a7d95cef472fbdf4758dd7564f48"
Object ID of the merchant whose refund to retrieve
shippo_api_version
string
"2018-02-08"
String used to pick a non-default API version to use. If not specified, the default API version will be used.
Shippo Get Merchant Shipment
Shippo Get Merchant ShipmentIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
merchant_id
string
✅
"5d23a7d95cef472fbdf4758dd7564f48"
Object ID of the merchant
shipment_id
string
✅
"09530dfacad54c9aa6f9149fa3b53e48"
Object ID of the shipment to retrieve
shippo_api_version
string
"2018-02-08"
String used to pick a non-default API version to use. If not specified, the default API version will be used.
Shippo Get Merchant Track
Shippo Get Merchant TrackIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
carrier
string
✅
"usps"
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
✅
"5d23a7d95cef472fbdf4758dd7564f48"
Object ID of the merchant whose tracking to retrieve
tracking_number
string
✅
"9205590164917312751089"
Tracking number to track. The format varies by carrier (e.g., USPS: 9205590164917312751089, Shippo test: SHIPPO_DELIVERED).
shippo_api_version
string
"2018-02-08"
String used to pick a non-default API version to use. If not specified, the default API version will be used.
Shippo Get Merchant Transaction
Shippo Get Merchant TransactionIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
merchant_id
string
✅
"5d23a7d95cef472fbdf4758dd7564f48"
Object ID of the merchant
transaction_id
string
✅
"87e558af5d1d4bc985867f053d380dc6"
Object ID of the transaction to retrieve
shippo_api_version
string
"2018-02-08"
String used to pick a non-default API version to use. If not specified, the default API version will be used.
Shippo Get Order
Shippo Get OrderIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
order_id
string
✅
"849630360f914ee1b87fa8d9493ceb34"
Object ID of the order to retrieve.
shippo_api_version
string
"2018-02-08"
String used to pick a non-default API version to use.
Shippo Get Parcel
Shippo Get ParcelIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
parcel_id
string
✅
"84cefb77abb84e4d96dde9f79565547f"
Object ID of the parcel to retrieve.
shippo_api_version
string
"2018-02-08"
String used to pick a non-default API version to use. If not specified, the default API version will be used.
Shippo Get Rate
Shippo Get RateIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
rate_id
string
✅
"0763d77e314747738c86bd3bb945f090"
Object ID of the rate to retrieve. This is a unique identifier for the rate.
shippo_api_version
string
"2018-02-08"
String used to pick a non-default API version to use. If not specified, the default API version will be used.
Shippo Get Refund
Shippo Get RefundIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
refund_id
string
✅
"7315577334ce4791b852d666a99d64bf"
Object ID of the refund to retrieve. This is a unique identifier returned when creating a refund.
shippo_api_version
string
"2018-02-08"
String used to pick a non-default API version to use. Optional header parameter.
Shippo Get Shipment
Shippo Get ShipmentIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
shipment_id
string
✅
"2e8d97bd5f794c6088b3286e59eec63e"
Object ID of the shipment to retrieve
shippo_api_version
string
"2018-02-08"
String used to pick a non-default API version to use
Shippo Get Shippo Account
Shippo Get Shippo AccountIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
shippo_account_id
string
✅
"5d23a7d95cef472fbdf4758dd7564f48"
Object ID of the Shippo Account to retrieve
shippo_api_version
string
"2018-02-08"
String used to pick a non-default API version to use. If not specified, the default API version will be used.
Shippo Get Track
Shippo Get TrackIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
carrier
string
✅
"usps"
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
✅
"9205590164917312751089"
Tracking number to track. The format varies by carrier (e.g., USPS: 9205590164917312751089, Shippo test: SHIPPO_DELIVERED).
shippo_api_version
string
"2018-02-08"
String used to pick a non-default API version to use. If not specified, the default API version will be used.
Shippo Get Transaction
Shippo Get TransactionIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
transaction_id
string
✅
"33476e51675c48f0993228ab224571ec"
Object ID of the transaction to retrieve
shippo_api_version
string
"2018-02-08"
String used to pick a non-default API version to use. If not specified, the default API version will be used.
Shippo Get User Parcel Template
Shippo Get User Parcel TemplateIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
shippo_api_version
string
"2018-02-08"
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
✅
"a893020642b146dfb51bc7f1570bffcd"
Object ID of the user parcel template to retrieve.
Shippo Get Webhook
Shippo Get WebhookIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
webhook_id
string
✅
"7c190fc9a7e1473dbf59c861b535e3d5"
Object ID of the webhook to retrieve. This is the unique identifier returned when creating a webhook.
Shippo List Addresses
Shippo List AddressesIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
page
integer
1
The page number you want to select
results
integer
10
The number of results to return per page (max 100)
SHIPPO_API_VERSION
string
"2018-02-08"
String used to pick a non-default API version to use
Shippo List Carrier Accounts
Shippo List Carrier AccountsIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
page
integer
1
The page number you want to select
results
integer
10
The number of results to return per page (max 100)
SHIPPO_API_VERSION
string
"2018-02-08"
String used to pick a non-default API version to use
Shippo List Carrier Parcel Templates
Shippo List Carrier Parcel TemplatesIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
carrier
string
"fedex"
Filter templates by specific carrier name (e.g., 'fedex', 'usps', 'ups')
include
string
"all"
Filter templates by type: 'all' returns all templates, 'user' returns only user-created templates, 'enabled' returns only enabled templates
shippo_api_version
string
"2018-02-08"
String used to pick a non-default API version to use
Shippo List Customs Declarations
Shippo List Customs DeclarationsIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
page
integer
1
The page number you want to select
results
integer
10
The number of results to return per page (max 100)
SHIPPO_API_VERSION
string
"2018-02-08"
String used to pick a non-default API version to use
Shippo List Customs Items
Shippo List Customs ItemsIntegration name: SHIPPO_LIST_CUSTOMS_ITEMS
Tool to list all customs items with pagination support. Use when you need to retrieve customs declarations for international shipments.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
page
integer
1
The page number you want to select
results
integer
25
The number of results to return per page (max 100)
SHIPPO-API-VERSION
string
"2018-02-08"
String used to pick a non-default API version to use
Shippo List Manifests
Shippo List ManifestsIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
page
integer
1
The page number you want to select. Must be greater than or equal to 1.
results
integer
25
The number of results to return per page. Must be between 1 and 100.
shippo_api_version
string
"2018-02-08"
String used to pick a non-default API version to use for this request.
Shippo List Merchant Addresses
Shippo List Merchant AddressesIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
page
integer
1
The page number you want to select
results
integer
10
The number of results to return per page (max 100)
merchant_id
string
✅
"5d23a7d95cef472fbdf4758dd7564f48"
Object ID of the merchant whose addresses you want to list
shippo_api_version
string
"2018-02-08"
String used to pick a non-default API version to use
Shippo List Merchant Carrier Accounts
Shippo List Merchant Carrier AccountsIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
page
integer
1
The page number you want to select
results
integer
10
The number of results to return per page (max 100)
merchant_id
string
✅
"5d23a7d95cef472fbdf4758dd7564f48"
Object ID of the merchant whose carrier accounts to list
shippo_api_version
string
"2018-02-08"
String used to pick a non-default API version to use
Shippo List Merchant Customs Declarations
Shippo List Merchant Customs DeclarationsIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
page
integer
1
The page number you want to select
results
integer
10
The number of results to return per page (max 100)
merchant_id
string
✅
"5d23a7d95cef472fbdf4758dd7564f48"
Object ID of the merchant whose customs declarations you want to list
shippo_api_version
string
"2018-02-08"
String used to pick a non-default API version to use
Shippo List Merchant Customs Items
Shippo List Merchant Customs ItemsIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
page
integer
1
The page number you want to select
results
integer
10
The number of results to return per page (max 100)
merchant_id
string
✅
"5d23a7d95cef472fbdf4758dd7564f48"
Object ID of the merchant whose customs items you want to list
shippo_api_version
string
"2018-02-08"
String used to pick a non-default API version to use
Shippo List Merchant Manifests
Shippo List Merchant ManifestsIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
page
integer
1
The page number you want to select. Must be greater than or equal to 1.
results
integer
25
The number of results to return per page. Must be between 1 and 100. Maximum is 100.
merchant_id
string
✅
"5d23a7d95cef472fbdf4758dd7564f48"
Object ID of the merchant to retrieve manifests for. This is the unique identifier for the merchant account.
shippo_api_version
string
"2018-02-08"
String used to pick a non-default API version to use for this request.
Shippo List Merchant Parcels
Shippo List Merchant ParcelsIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
page
integer
1
The page number you want to select
results
integer
10
The number of results to return per page (max 100)
merchant_id
string
✅
"5d23a7d95cef472fbdf4758dd7564f48"
Object ID of the merchant whose parcels you want to list
shippo_api_version
string
"2018-02-08"
String used to pick a non-default API version to use
Shippo List Merchants
Shippo List MerchantsIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
page
integer
1
The page number you want to select
results
integer
10
The number of results to return per page (max 100)
SHIPPO_API_VERSION
string
"2018-02-08"
String used to pick a non-default API version to use
Shippo List Merchant Shipment Rates By Currency
Shippo List Merchant Shipment Rates By CurrencyIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
page
integer
1
The page number you want to select
results
integer
10
The number of results to return per page (max 100)
merchant_id
string
✅
"5d23a7d95cef472fbdf4758dd7564f48"
Object ID of the merchant
shipment_id
string
✅
"3dc461e6e89b46c792de6e8a1f7d1f55"
Object ID of the shipment to retrieve rates for
currency_code
string
✅
"USD"
ISO currency code to filter rates by (e.g., USD, EUR, GBP)
shippo_api_version
string
"2018-02-08"
String used to pick a non-default API version to use
Shippo List Merchant Shipments
Shippo List Merchant ShipmentsIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
page
integer
1
The page number you want to select. Must be greater than or equal to 1.
results
integer
25
The number of results to return per page. Must be between 1 and 100. Maximum is 100.
merchant_id
string
✅
"5d23a7d95cef472fbdf4758dd7564f48"
Object ID of the merchant to retrieve shipments for. This is the unique identifier for the merchant account.
shippo_api_version
string
"2018-02-08"
String used to pick a non-default API version to use for this request.
Shippo List Merchant Transactions
Shippo List Merchant TransactionsIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
page
integer
1
The page number you want to select
results
integer
10
The number of results to return per page (max 100)
merchant_id
string
✅
"5d23a7d95cef472fbdf4758dd7564f48"
Object ID of the merchant to retrieve transactions for
SHIPPO_API_VERSION
string
"2018-02-08"
String used to pick a non-default API version to use
Shippo List Orders
Shippo List OrdersIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
page
integer
1
The page number you want to select
results
integer
10
The number of results to return per page (max 100)
SHIPPO_API_VERSION
string
"2018-02-08"
String used to pick a non-default API version to use
Shippo List Refunds
Shippo List RefundsIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
page
integer
1
Page number for pagination (1-indexed). Use to navigate through multiple pages of results.
results
integer
10
Number of refund records to return per page (default 10). Controls page size for pagination.
Shippo List Service Groups
Shippo List Service GroupsIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
shippo_api_version
string
"2018-02-08"
String used to pick a non-default API version to use. If not provided, the default API version will be used.
Shippo List Shipment Rates
Shippo List Shipment RatesIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
page
integer
1
The page number you want to select
results
integer
10
The number of results to return per page (max 100)
ShipmentId
string
✅
"09530dfacad54c9aa6f9149fa3b53e48"
Object ID of the shipment to retrieve rates for
SHIPPO_API_VERSION
string
"2018-02-08"
String used to pick a non-default API version to use
Shippo List Shipment Rates By Currency
Shippo List Shipment Rates By CurrencyIntegration name: 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).
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
page
integer
1
The page number you want to select
results
integer
10
The number of results to return per page (max 100)
ShipmentId
string
✅
"09530dfacad54c9aa6f9149fa3b53e48"
Object ID of the shipment to retrieve rates for
CurrencyCode
string
✅
"USD"
ISO currency code to filter rates by (e.g., USD, EUR, GBP)
SHIPPO_API_VERSION
string
"2018-02-08"
String used to pick a non-default API version to use
Shippo List Shipments
Shippo List ShipmentsIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
page
integer
1
The page number you want to select
results
integer
10
The number of results to return per page (max 100)
SHIPPO_API_VERSION
string
"2018-02-08"
String used to pick a non-default API version to use
Shippo List Shippo Accounts
Shippo List Shippo AccountsIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
page
integer
1
Page number for pagination. Use to retrieve subsequent pages of results.
Shippo List User Parcel Templates
Shippo List User Parcel TemplatesIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
shippo_api_version
string
"2018-02-08"
String used to pick a non-default API version to use. If not specified, the default API version will be used.
Shippo Purchase Merchant Batch
Shippo Purchase Merchant BatchIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
batch_id
string
✅
"03d8d2eb0f2742289039b3860d8708ff"
Object ID of the batch to purchase
merchant_id
string
✅
"5d23a7d95cef472fbdf4758dd7564f48"
Object ID of the merchant
shippo_api_version
string
"2018-02-08"
String used to pick a non-default API version to use. If not specified, the default API version will be used.
Shippo Remove Shipments From Batch
Shippo Remove Shipments From BatchIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
batch_id
string
✅
"b8e539f23d9f4f7285133cb2d9b37424"
Object ID of the batch from which to remove shipments
merchant_id
string
✅
"5d23a7d95cef472fbdf4758dd7564f48"
Object ID of the merchant who owns the batch
shipment_ids
array
✅
["b98561ec61664cd48a956f0cd04aad4a","c12345ab67890cd12e345f67890ab123"]
Array of shipment object IDs to remove from the batch. Each ID must be a valid shipment identifier.
shippo_api_version
string
"2018-02-08"
String used to pick a non-default API version to use. If not specified, the default API version will be used.
Shippo Update Carrier Account
Shippo Update Carrier AccountIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
active
boolean
true
Whether the carrier account should be active or inactive. Set to true to enable, false to disable.
carrier
string
✅
"usps"
The carrier name/identifier (e.g., 'usps', 'ups', 'fedex', 'dhl_express', 'lso'). This field is required.
account_id
string
✅
"shippo_shippocommon_account"
The carrier account identifier. This field is required.
parameters
object
{"postal_code":"94102","account_number":"12345"}
Optional carrier-specific parameters as key-value pairs. The structure varies by carrier.
carrier_account_id
string
✅
"2bf70116c96f40159b54c16f022586c7"
Object ID of the carrier account to update (e.g., '2bf70116c96f40159b54c16f022586c7').
shippo_api_version
string
"2018-02-08"
Optional string to specify a non-default API version to use for this request.
Shippo Update Default Parcel Template
Shippo Update Default Parcel TemplateIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
object_id
string
✅
"b958d3690bb04bb8b2986724872750f5"
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
"2018-02-08"
Optional string used to pick a non-default API version to use. If not provided, the default API version will be used.
Shippo Update Merchant
Shippo Update MerchantIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
email
string
✅
"partnerships@usefulagents.com"
The merchant's email address. This field is required.
last_name
string
✅
"Dean"
The merchant's last name. This field is required.
first_name
string
✅
"Madeline"
The merchant's first name. This field is required.
merchant_id
string
✅
"5d23a7d95cef472fbdf4758dd7564f48"
Object ID of the merchant to update (e.g., '5d23a7d95cef472fbdf4758dd7564f48').
merchant_name
string
✅
"Useful Agents LLC"
The merchant's business/company name. This field is required.
shippo_api_version
string
"2018-02-08"
Optional string to specify a non-default API version to use for this request.
Shippo Update Merchant Carrier Account
Shippo Update Merchant Carrier AccountIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
active
boolean
true
Whether the carrier account should be active or inactive. Set to true to enable, false to disable.
carrier
string
✅
"ups"
The carrier name/identifier (e.g., 'ups', 'usps', 'fedex'). This field is required.
account_id
string
✅
"test_account_123"
The carrier account identifier. This field is required.
parameters
object
✅
—
Carrier-specific parameters. For UPS, includes billing address, account details, and invoice information.
merchant_id
string
✅
"5d23a7d95cef472fbdf4758dd7564f48"
Object ID of the merchant (e.g., '5d23a7d95cef472fbdf4758dd7564f48').
carrier_account_id
string
✅
"15c67bc9e2694e7c896c8d995d313442"
Object ID of the carrier account to update (e.g., '15c67bc9e2694e7c896c8d995d313442').
shippo_api_version
string
"2018-02-08"
Optional string to specify a non-default API version to use for this request.
Shippo Update Service Group
Shippo Update Service GroupIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
name
string
"Updated Live Rate Group"
Name of the service group
type
string
"LIVE_RATE"
Type of service group (e.g., FLAT_RATE, LIVE_RATE)
flat_rate
string
"5.00"
Flat rate amount (used when type is FLAT_RATE)
is_active
boolean
true
Whether the service group is active
object_id
string
✅
"d3244cf4b0fe485bb0318003d723926e"
The object ID of the service group being updated
description
string
"Updated description for testing"
Description of the service group
service_levels
array
[{"account_object_id":"17641e416b62415ea39c24ec354e2560","service_level_token":"canada_post_expedited_parcel"}]
Array of service level configurations to associate with this group
rate_adjustment
integer
10
Rate adjustment value as percentage (e.g., 10 for 10% increase, -5 for 5% decrease)
flat_rate_currency
string
"USD"
Currency for the flat rate (ISO 4217 currency code)
free_shipping_threshold_min
string
"50.00"
Minimum amount for free shipping threshold
free_shipping_threshold_currency
string
"USD"
Currency for free shipping threshold (ISO 4217 currency code)
Shippo Update User Parcel Template
Shippo Update User Parcel TemplateIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
weight
string
✅
"2.0"
The weight of the parcel. Up to six digits in front and four digits after the decimal separator are accepted.
template
string
✅
"USPS_FlatRateEnvelope"
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
✅
"lb"
The unit of weight measurement (e.g., lb for pounds, kg for kilograms, oz for ounces, g for grams).
shippo_api_version
string
"2018-02-08"
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
✅
"489577e2a65742f08b8745b56f4d3179"
Object ID of the user parcel template to update. This is the unique identifier of an existing user parcel template.
Shippo Update Webhook
Shippo Update WebhookIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
url
string
✅
"https://example.com/shippo-webhook"
The webhook URL endpoint where notifications will be sent. Must be a valid HTTPS URL.
event
string
✅
"track_updated"
The webhook event type to listen for. Use 'all' to receive all event types.
active
boolean
✅
true
Whether the webhook should be active or inactive. Set to true to enable, false to disable.
is_test
boolean
✅
true
Whether this is a test webhook. Set to true for testing, false for production.
webhook_id
string
✅
"7c190fc9a7e1473dbf59c861b535e3d5"
Object ID of the webhook to update (e.g., '7c190fc9a7e1473dbf59c861b535e3d5').
Shippo Validate Address
Shippo Validate AddressIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
address_id
string
✅
"d549f712606345419b36e3bc8ba81483"
Object ID of the address to validate. This is the unique identifier returned when an address was created.
shippo_api_version
string
"2018-02-08"
Optional API version string to use a non-default API version. If not provided, the default API version will be used.
Shippo Validate Merchant Address
Shippo Validate Merchant AddressIntegration name: 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.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
address_id
string
✅
"2fa4ab66944a4aa882e46eadaee4d4df"
Object ID of the address to validate. This is the unique identifier of the address object to be validated.
merchant_id
string
✅
"5d23a7d95cef472fbdf4758dd7564f48"
Object ID of the merchant. This is the unique identifier for the merchant whose address you want to validate.
shippo_api_version
string
"2018-02-08"
Optional API version string to use a non-default API version. If not specified, the default API version will be used.