NAiOS IconNAiOS Logo
Contacto
Volver al catálogo

Shippo

shippo

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

EcommerceWeb del proveedor
Acciones
95
Triggers
0
Autenticación
—
OAuth gestionado
Sí
Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (95)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Create Shippo AddressSHIPPO_CREATE_ADDRESSAcción

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.

Parámetros de entrada

  • zipstringObligatorio

    ZIP or postal code. Format varies by country (e.g., 94105 for US, SW1A 1AA for UK).

  • citystringObligatorio

    City name for the address. Required for most countries.

  • namestringObligatorio

    Full name of the person or business at this address. Required for shipping labels.

  • emailstring

    Contact email address. Used for shipping notifications and updates.

  • phonestring

    Contact phone number including country code. Format: +[country code] [number]. Recommended for delivery notifications.

  • statestringObligatorio

    State, province, or region code. Use 2-letter state codes for US addresses (e.g., CA, NY). Required for countries with states/provinces.

  • companystring

    Company or business name if this is a commercial address.

  • countrystringObligatorio

    2-letter ISO country code (e.g., US, GB, CA). Required field for all addresses.

  • street1stringObligatorio

    Primary street address line. Required field for all addresses.

  • street2string

    Secondary street address line for apartment, suite, or unit numbers.

  • street3string

    Third street address line for additional address details if needed.

  • metadatastring

    Custom metadata string to attach to this address for your own reference. Maximum 100 characters.

  • validateboolean

    Set to true to validate the address with the carrier before creating. Recommended to catch address errors early.

  • street_nostring

    Street number for countries that separate street number from street name.

  • is_residentialboolean

    Set to true if this is a residential address, false for commercial. Affects shipping rates and delivery options.

  • SHIPPO-API-VERSIONstring

    String used to pick a non-default API version to use. Leave empty to use the default version.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create BatchSHIPPO_CREATE_BATCHAcción

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.

Parámetros de entrada

  • metadatastring

    Custom metadata string for the batch (max 100 characters)

  • label_filetypestring

    Format for the shipping label (e.g., 'PDF', 'PNG', 'ZPLII'). If not specified, defaults to PDF.

  • batch_shipmentsobject[]Obligatorio

    List of shipments to include in the batch. Each shipment must contain address_from, address_to, and parcels.

  • shippo_api_versionstring

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

  • default_carrier_accountstringObligatorio

    Object ID of the carrier account to use for batch shipments. Must be a valid carrier account ID from /carrier_accounts endpoint.

  • default_servicelevel_tokenstringObligatorio

    Service level token for the shipment (e.g., 'usps_priority', 'canada_post_expedited_parcel')

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create Carrier AccountSHIPPO_CREATE_CARRIER_ACCOUNTAcción

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.

Parámetros de entrada

  • testboolean

    Whether this is a test account.

  • activebooleanObligatorio

    Whether the carrier account is active.

  • carrierstringObligatorio

    The carrier name to create an account for, e.g., 'ups'.

  • metadatastring

    Optional metadata string to associate with the carrier account.

  • account_idstringObligatorio

    Account identifier used to reference this carrier account. Must not be blank.

  • parametersobjectObligatorio

    Carrier-specific parameters required for account creation. For UPS, this includes billing address, contact information, and invoice details.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create Customs ItemSHIPPO_CREATE_CUSTOMS_ITEMAcción

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.

Parámetros de entrada

  • metadatastring

    Custom metadata string for storing additional information about the customs item.

  • quantityintegerObligatorio

    Quantity of this item in the shipment. Must be a positive integer.

  • sku_codestring

    Stock Keeping Unit code or product identifier for inventory tracking.

  • mass_unitstringObligatorio

    Unit of measurement for the weight. Common values: 'lb' (pounds), 'kg' (kilograms), 'oz' (ounces), 'g' (grams).

  • eccn_ear99string

    Export Control Classification Number (ECCN) or EAR99 designation for export control purposes.

  • net_weightstringObligatorio

    Net weight of the item (total weight for all units). Numeric string value.

  • descriptionstringObligatorio

    Text description of the item being shipped for customs purposes.

  • value_amountstringObligatorio

    Monetary value of the item. Numeric string with up to 2 decimal places.

  • tariff_numberstring

    Harmonized Tariff Schedule (HTS) code for the item. Used for customs classification.

  • origin_countrystringObligatorio

    Two-letter ISO 3166-1 alpha-2 country code of the item's origin country.

  • value_currencystringObligatorio

    Three-letter ISO 4217 currency code for the item value.

  • SHIPPO_API_VERSIONstring

    Optional API version to use for this request. If not specified, uses the default API version.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create Live RateSHIPPO_CREATE_LIVE_RATEAcción

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.

Parámetros de entrada

  • parcelarray

    Array of parcel objects or parcel template IDs. If not provided, dimensions are calculated from line items.

  • address_toanyObligatorio

    Destination address - either an address object ID string or a full address object

  • line_itemsobject[]Obligatorio

    Array of line item objects describing what is being shipped. At least one item is required.

  • address_fromany

    Origin address - either an address object ID string or a full address object. If not provided, uses default address from account settings.

  • shippo_api_versionstring

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

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create ManifestSHIPPO_CREATE_MANIFESTAcción

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.

Parámetros de entrada

  • address_fromstringObligatorio

    Object ID of the address the manifest will be sent from. Must be a valid address object ID.

  • transactionsstring[]

    List of transaction object IDs to be included in the manifest. Each ID must be a valid transaction object ID.

  • shipment_datestringObligatorio

    Date and time of the shipment in ISO 8601 format. This is the date that will be printed on the manifest.

  • async_manifestboolean

    If true, the manifest will be created asynchronously. If false or not specified, it will be created synchronously.

  • carrier_accountstringObligatorio

    Object ID of the carrier account to be used for this manifest. Must be a valid carrier account object ID.

  • shippo_api_versionstring

    String used to pick a non-default API version to use for this request.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create Merchant AddressSHIPPO_CREATE_MERCHANT_ADDRESSAcción

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.

Parámetros de entrada

  • zipstring

    ZIP or postal code. Format varies by country (e.g., 94117 for US, SW1A 1AA for UK). Required for purchase.

  • citystringObligatorio

    City name for the address. Required for purchase.

  • namestringObligatorio

    Full name of the person or business at this address. Required for purchase.

  • emailstring

    Contact email address. Used for notifications and updates.

  • phonestring

    Contact phone number including country code. Format: +[country code] [number].

  • statestring

    State, province, or region code. Use 2-letter state codes for US addresses (e.g., CA, NY). Required for purchase for some countries.

  • companystring

    Company or business name if this is a commercial address.

  • countrystringObligatorio

    2-letter ISO country code (e.g., US, GB, CA). Required field for all addresses.

  • street1stringObligatorio

    Primary street address line. Required for purchase.

  • street2string

    Secondary street address line for apartment, suite, or unit numbers.

  • metadatastring

    Custom metadata string to attach to this address for your own reference.

  • validateboolean

    Set to true to validate the address with the carrier before creating. Recommended to catch address errors early.

  • merchant_idstringObligatorio

    Object ID of the merchant to create the address for. This is the merchant's unique identifier in Shippo's system.

  • is_residentialboolean

    Set to true if this is a residential address, false for commercial. Affects shipping rates and delivery options.

  • SHIPPO-API-VERSIONstring

    String used to pick a non-default API version to use. Leave empty to use the default version.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create Merchant BatchSHIPPO_CREATE_MERCHANT_BATCHAcción

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.

Parámetros de entrada

  • metadatastring

    Custom metadata string to attach to the batch for your reference (max 100 characters).

  • merchant_idstringObligatorio

    Object ID of the merchant for whom to create the batch. This identifies which merchant account the batch belongs to.

  • label_filetypestringenum

    Label file format options.

    PNGPNG_2.3x7.5PDFPDF_2.3x7.5PDF_4x6PDF_4x8PDF_A4PDF_A6ZPLII
  • batch_shipmentsobject[]Obligatorio

    Array of BatchShipment objects containing shipment IDs to include in this batch. The response maintains the same order as the request array.

  • shippo_api_versionstring

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

  • default_carrier_accountstringObligatorio

    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_tokenstringObligatorio

    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.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create Merchant Carrier AccountSHIPPO_CREATE_MERCHANT_CARRIER_ACCOUNTAcción

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.

Parámetros de entrada

  • testboolean

    Whether this is a test account.

  • activebooleanObligatorio

    Whether the carrier account is active.

  • carrierstringObligatorio

    The carrier name to create an account for (e.g., 'ups').

  • metadatastring

    Optional metadata string to associate with the carrier account.

  • account_idstringObligatorio

    Account identifier. This field is required as input to the API, but is not used for UPS. Use the empty string for UPS.

  • parametersobjectObligatorio

    Carrier-specific parameters required for account creation. For UPS, this includes billing address, contact information, and invoice details.

  • merchant_idstringObligatorio

    Object ID of the merchant to create a carrier account for.

  • shippo_api_versionstring

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

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create Merchant Customs DeclarationSHIPPO_CREATE_MERCHANT_CUSTOMS_DECLARATIONAcción

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.

Parámetros de entrada

  • testboolean

    Indicates whether to create this in test mode. Use true for testing without affecting production data. Optional field.

  • itemsobject[]Obligatorio

    Array of customs items included in this declaration. At least one item is required.

  • notesstring

    Additional notes or instructions to be included in the customs declaration. Optional field.

  • aes_itnstring

    AES / ITN (Automated Export System / Internal Transaction Number) reference. Required if eel_pfc is 'AES_ITN'. Optional otherwise.

  • certifybooleanObligatorio

    Expresses that the certify_signer has provided all information of the customs declaration truthfully. Required field.

  • eel_pfcstring

    Export information - EEL (Exemption and Exclusion Legend) or PFC (Proof of Filing Citation) code. Optional field.

  • invoicestring

    Invoice reference number of the shipment. Optional field.

  • licensestring

    Export license reference of the shipment. Optional field.

  • incotermstring

    The incoterm reference of the shipment. Optional field.

  • metadatastring

    Custom metadata string, up to 100 characters. Use for storing your own reference data. Optional field.

  • disclaimerstring

    Disclaimer for the shipment and customs information. Optional field.

  • b13a_numberstring

    B13A number (Proof of Report, Summary ID, or Exemption Number). Must be provided if and only if b13a_filing_option is provided.

  • certificatestring

    Certificate reference of the shipment. Optional field.

  • merchant_idstringObligatorio

    Object ID of the merchant to create the customs declaration for. This is the merchant's unique identifier in Shippo's system.

  • contents_typestringObligatorioenum

    Type of contents being shipped. Required field. Valid values: DOCUMENTS, GIFT, SAMPLE, MERCHANDISE, HUMANITARIAN_DONATION, RETURN_MERCHANDISE, OTHER.

    DOCUMENTSGIFTSAMPLEMERCHANDISEHUMANITARIAN_DONATIONRETURN_MERCHANDISEOTHER
  • certify_signerstringObligatorio

    Name of the person responsible for the validity of all information provided in the customs declaration. Required field.

  • b13a_filing_optionstring

    B13A filing option for Canadian exports. Optional field.

  • commercial_invoicestring

    Commercial invoice reference. Optional field.

  • exporter_referencestring

    Exporter reference of an export shipment. Optional field.

  • importer_referencestring

    Importer reference of an import shipment. Optional field.

  • shippo_api_versionstring

    String used to pick a non-default API version to use. Leave empty to use the default version.

  • non_delivery_optionstringObligatorioenum

    Action to take if delivery fails. Required field. Valid values: 'RETURN' (return to sender), 'ABANDON' (dispose of package).

    ABANDONRETURN
  • contents_explanationstring

    Explanation of the type of goods being shipped. Required if contents_type is 'OTHER'. Optional otherwise.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create Merchant Customs ItemSHIPPO_CREATE_MERCHANT_CUSTOMS_ITEMAcción

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.

Parámetros de entrada

  • metadatastring

    Custom metadata string for storing additional information about the customs item. Optional field.

  • quantityintegerObligatorio

    Quantity of this item in the shipment. Must be a positive integer. Required field.

  • sku_codestring

    The stock keeping unit value of this item. Optional field for inventory tracking.

  • mass_unitstringObligatorioenum

    Unit of measurement for the weight. Required field. Valid values: 'g' (grams), 'kg' (kilograms), 'lb' (pounds), 'oz' (ounces).

    gkglboz
  • eccn_ear99string

    Export Control Classification Number (ECCN) or EAR99 designation for export control purposes. Optional field.

  • net_weightstringObligatorio

    Net weight of the item (total weight for all units). Numeric string value. Required field.

  • descriptionstringObligatorio

    Text description of the item being shipped for customs purposes. Required field.

  • merchant_idstringObligatorio

    Object ID of the merchant to create the customs item for. This is the merchant's unique identifier in Shippo's system.

  • value_amountstringObligatorio

    Monetary value of the item. Numeric string with up to 2 decimal places. Required field.

  • tariff_numberstring

    Harmonized Tariff Schedule (HTS) code for the item. Used for customs classification. Optional field.

  • origin_countrystringObligatorio

    Two-letter ISO 3166-1 alpha-2 country code of the item's origin country. Required field.

  • value_currencystringObligatorio

    Three-letter ISO 4217 currency code for the item value. Required field.

  • SHIPPO-API-VERSIONstring

    String used to pick a non-default API version to use. Leave empty to use the default version.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create Merchant OrderSHIPPO_CREATE_MERCHANT_ORDERAcción

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.

Parámetros de entrada

  • notesstring

    Custom buyer- or seller-provided notes about the order.

  • weightstringObligatorio

    Total weight of the order.

  • currencystring

    Currency of the total_price and total_tax amounts. Required if total_price is provided.

  • placed_atstringObligatorio

    ISO 8601 timestamp when the order was placed by the customer (e.g., '2026-02-12T15:30:00Z').

  • total_taxstring

    Total tax amount paid by the buyer for this order.

  • line_itemsobject[]

    Array of line item objects representing the items in this order.

  • to_addressobjectObligatorio

    Recipient shipping address for the order. Must include name, street, city, state, zip, and country.

  • merchant_idstringObligatorio

    Object ID of the merchant for whom to create the order. This identifies which merchant account the order belongs to.

  • total_pricestring

    Total amount paid by the buyer for this order.

  • weight_unitstringObligatorioenum

    Unit of weight measurement for the order (lb, oz, g, kg).

    lbozgkg
  • from_addressobject

    Address information for order.

  • order_numberstring

    Alphanumeric identifier for the order used by the seller/buyer. This identifier doesn't need to be unique.

  • order_statusstringenum

    Order status values.

    UNKNOWNAWAITPAYPAIDREFUNDEDPARTIALLY_FULFILLEDSHIPPED
  • shipping_coststring

    Amount paid by the buyer for shipping. This amount can be different from the price the seller will actually pay for shipping.

  • subtotal_pricestring

    Subtotal price before shipping and taxes.

  • shipping_methodstring

    Shipping method (carrier + service or other free text description) chosen by the buyer.

  • shippo_api_versionstring

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

  • shipping_cost_currencystring

    Currency of the shipping_cost amount. Required if shipping_cost is provided.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create Merchant ParcelSHIPPO_CREATE_MERCHANT_PARCELAcción

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.

Parámetros de entrada

  • testboolean

    Indicates whether the object should be created in test mode. Set to true for testing without affecting production data.

  • extraobject

    Extra options for the parcel.

  • widthstringObligatorio

    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.

  • heightstringObligatorio

    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.

  • lengthstringObligatorio

    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.

  • weightstringObligatorio

    Weight of the parcel. Up to six digits in front and four digits after the decimal separator are accepted.

  • metadatastring

    A string of up to 100 characters that can be filled with any additional information you want to attach to the object.

  • templatestringenum

    Pre-defined parcel templates for common carrier packages.

    FedEx_Box_10kgFedEx_Box_25kgFedEx_Box_Extra_Large_1FedEx_Box_Extra_Large_2FedEx_Box_Large_1FedEx_Box_Large_2FedEx_Box_Medium_1FedEx_Box_Medium_2FedEx_Box_Small_1FedEx_Box_Small_2FedEx_EnvelopeFedEx_Padded_Pak+59
  • mass_unitstringObligatorioenum

    The unit used for weight.

    gkglboz
  • merchant_idstringObligatorio

    Object ID of the merchant to create the parcel for. This is the merchant's unique identifier in Shippo's system.

  • distance_unitstringObligatorioenum

    The measure unit used for length, width and height. Required if template is not specified.

    cminftmmmyd
  • SHIPPO-API-VERSIONstring

    String used to pick a non-default API version to use. Leave empty to use the default version.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create Merchant RefundSHIPPO_CREATE_MERCHANT_REFUNDAcción

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.

Parámetros de entrada

  • asyncboolean

    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_idstringObligatorio

    Object ID of the merchant for whom to create the refund. This identifies which merchant account the refund belongs to.

  • transactionstringObligatorio

    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_versionstring

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

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create Merchant ShipmentSHIPPO_CREATE_MERCHANT_SHIPMENTAcción

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.

Parámetros de entrada

  • asyncboolean

    Set to true to process the shipment asynchronously. Default is false for synchronous processing.

  • extraobject

    Extra options and services for the shipment.

  • parcelsobject[]Obligatorio

    Array of parcel objects with dimensions and weight. Required field. Must contain at least one parcel.

  • metadatastring

    Custom metadata string to attach to this shipment for your own reference (up to 100 characters).

  • MerchantIdstringObligatorio

    Object ID of the merchant to create the shipment for. This is the merchant's unique identifier in Shippo's system.

  • address_toobjectObligatorio

    Recipient/destination address information. Required field.

  • address_fromobjectObligatorio

    Sender/origin address information. Required field.

  • shipment_datestring

    Date the shipment will be tendered to the carrier in ISO 8601 format. If not provided, defaults to current date.

  • address_returnobject

    Address information for shipment origin, destination, or return.

  • SHIPPO-API-VERSIONstring

    String used to pick a non-default API version to use. Leave empty to use the default version.

  • customs_declarationstring

    Customs declaration object ID for international shipments. Required for international shipments.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create Merchant TransactionSHIPPO_CREATE_MERCHANT_TRANSACTIONAcción

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.

Parámetros de entrada

  • ratestringObligatorio

    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.

  • asyncboolean

    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.

  • metadatastring

    A string of up to 100 characters that can be filled with any additional information you want to attach to the transaction object.

  • merchant_idstringObligatorio

    Object ID of the merchant for whom to create the transaction. This identifies which merchant account the transaction belongs to.

  • label_file_typestringenum

    Label file format options.

    PNGPNG_2.3x7.5PDFPDF_2.3x7.5PDF_4x6PDF_4x8PDF_A4PDF_A6ZPLII
  • shippo_api_versionstring

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

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create OrderSHIPPO_CREATE_ORDERAcción

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.

Parámetros de entrada

  • notesstring

    Additional notes or instructions for the order.

  • weightstring

    Total weight of the order. Required if line_items are not provided.

  • currencystring

    Currency code for order prices (e.g., 'USD').

  • placed_atstringObligatorio

    ISO 8601 timestamp when the order was placed by the customer.

  • total_taxstring

    Total tax amount for the order.

  • line_itemsobject[]

    List of items included in this order.

  • to_addressobjectObligatorio

    Recipient shipping address for the order.

  • total_pricestring

    Total price including shipping and taxes.

  • weight_unitstringenum

    Unit of weight measurement for the total order weight.

    lbozgkg
  • from_addressobject

    Origin/sender address for the order. If not provided, uses account default.

  • order_numberstring

    Unique order identifier from your system for reference.

  • order_statusstring

    Current status of the order (e.g., 'PAID', 'PROCESSING', 'SHIPPED').

  • shipping_coststring

    Shipping cost charged to the customer.

  • subtotal_pricestring

    Subtotal price before shipping and taxes.

  • shipping_methodstring

    Shipping method selected by the customer.

  • shipping_cost_currencystring

    Currency code for the shipping cost.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create ParcelSHIPPO_CREATE_PARCELAcción

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.

Parámetros de entrada

  • testboolean

    Indicates whether the object should be created in test mode. Set to true for testing without affecting production data.

  • extraobject

    Extra options for the parcel.

  • widthstringObligatorio

    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.

  • heightstringObligatorio

    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.

  • lengthstringObligatorio

    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.

  • weightstringObligatorio

    Weight of the parcel. Up to six digits in front and four digits after the decimal separator are accepted.

  • metadatastring

    A string of up to 100 characters that can be filled with any additional information you want to attach to the object.

  • templatestring

    Parcel template ID. If template is passed, length, width, height, and distance_unit are not required.

  • mass_unitstringObligatorioenum

    The unit used for weight. Required if template is not specified.

    gkglboz
  • distance_unitstringObligatorioenum

    The measure unit used for length, width and height. Required if template is not specified.

    cminftmmmyd

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create RefundSHIPPO_CREATE_REFUNDAcción

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

Parámetros de entrada

  • asyncboolean

    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.

  • transactionstringObligatorio

    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_versionstring

    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.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create Service GroupSHIPPO_CREATE_SERVICE_GROUPAcción

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.

Parámetros de entrada

  • namestringObligatorio

    Name of the service group. Used to identify the group in the dashboard and API responses.

  • typestringObligatorioenum

    Pricing model for the service group: FLAT_RATE (fixed price), FREE_SHIPPING (no charge), or RATE_ADJUSTMENT (percentage adjustment).

    FLAT_RATEFREE_SHIPPINGRATE_ADJUSTMENT
  • flat_ratestring

    Fixed shipping rate as a decimal string (e.g., '15.00'). Required when type is FLAT_RATE.

  • descriptionstringObligatorio

    Description of the service group explaining its purpose or use case.

  • service_levelsobject[]Obligatorio

    List of carrier service levels to include in this group. Each service level requires an account_object_id and service_level_token.

  • rate_adjustmentinteger

    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_currencystring

    Three-letter ISO currency code for flat_rate (e.g., 'USD', 'EUR'). Required when flat_rate is provided.

  • shippo_api_versionstring

    Optional API version to use for this request. If not specified, the default API version will be used.

  • free_shipping_threshold_minstring

    Minimum order value as decimal string to qualify for free shipping (e.g., '50.00'). Used with FREE_SHIPPING type.

  • free_shipping_threshold_currencystring

    Three-letter ISO currency code for free_shipping_threshold_min. Required when free_shipping_threshold_min is provided.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create ShipmentSHIPPO_CREATE_SHIPMENTAcción

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.

Parámetros de entrada

  • asyncboolean

    Whether to process shipment asynchronously. Set to false for synchronous rate generation.

  • extraobject

    Additional parameters for shipment-specific features such as insurance and signature confirmation

  • parcelsobject[]Obligatorio

    List of parcels included in the shipment. Must contain at least one parcel.

  • metadatastring

    Optional metadata string to attach to the shipment (up to 100 characters)

  • address_toobjectObligatorio

    Destination address for the shipment

  • address_fromobjectObligatorio

    Origin address for the shipment

  • shipment_datestring

    Date the shipment will be shipped (ISO 8601 format)

  • address_returnobject

    Address model for shipment origin and destination.

  • shippo_api_versionstring

    API version to use for this request

  • customs_declarationstring

    Object ID of the customs declaration for international shipments

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Register Tracking WebhookSHIPPO_CREATE_TRACKAcción

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.

Parámetros de entrada

  • carrierstringObligatorio

    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.

  • metadatastring

    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_numberstringObligatorio

    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-VERSIONstring

    String used to pick a non-default API version to use. Leave empty to use the default version.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create TransactionSHIPPO_CREATE_TRANSACTIONAcción

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.

Parámetros de entrada

  • ratestring

    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.

  • asyncboolean

    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.

  • metadatastring

    A string of up to 100 characters that can be filled with any additional information you want to attach to the transaction object.

  • shipmentany

    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_accountstring

    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_typestringenum

    File format for the shipping label.

    PDFPDF_4x6PNGZPLII
  • servicelevel_tokenstring

    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_versionstring

    Optional API version string to use for this request. If not specified, the default API version will be used.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create User Parcel TemplateSHIPPO_CREATE_USER_PARCEL_TEMPLATEAcción

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.

Parámetros de entrada

  • weightstring

    Weight of the parcel. Up to six digits in front and four digits after the decimal separator are accepted.

  • templatestring

    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_unitstring

    Unit of measurement for weight (e.g., 'lb' for pounds, 'kg' for kilograms, 'oz' for ounces, 'g' for grams).

  • shippo_api_versionstring

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

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create Shippo WebhookSHIPPO_CREATE_WEBHOOKAcción

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.

Parámetros de entrada

  • urlstringObligatorio

    The client-owned URL where webhook notifications will be sent. Must be less than 200 characters and use HTTPS protocol for security.

  • eventstringObligatorioenum

    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.

    track_updatedtransaction_createdtransaction_updatedbatch_createdbatch_purchasedall
  • is_testboolean

    Whether this is a test webhook. Set to true for testing purposes. Defaults to false if not specified.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete Default Parcel TemplateSHIPPO_DELETE_DEFAULT_PARCEL_TEMPLATEAcción

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

Parámetros de entrada

  • SHIPPO_API_VERSIONstring

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

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete User Parcel TemplateSHIPPO_DELETE_USER_PARCEL_TEMPLATEAcción

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

Parámetros de entrada

  • shippo_api_versionstring

    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_idstringObligatorio

    Object ID of the user parcel template to delete. This is the unique identifier returned when the template was created or listed.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete WebhookSHIPPO_DELETE_WEBHOOKAcción

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.

Parámetros de entrada

  • webhook_idstringObligatorio

    Object ID of the webhook to delete. This is the unique identifier returned when creating a webhook.

  • shippo_api_versionstring

    String used to pick a non-default API version to use. Leave empty to use the default version.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get AddressSHIPPO_GET_ADDRESSAcción

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.

Parámetros de entrada

  • address_idstringObligatorio

    Object ID of the address to retrieve

  • shippo_api_versionstring

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

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Carrier AccountSHIPPO_GET_CARRIER_ACCOUNTAcción

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

Parámetros de entrada

  • carrier_account_idstringObligatorio

    Object ID of the carrier account to retrieve.

  • shippo_api_versionstring

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

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Carrier Parcel TemplateSHIPPO_GET_CARRIER_PARCEL_TEMPLATEAcción

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.

Parámetros de entrada

  • shippo_api_versionstring

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

  • carrier_parcel_template_tokenstringObligatorio

    The unique string representation of the carrier parcel template

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Carrier Registration StatusSHIPPO_GET_CARRIER_REGISTRATION_STATUSAcción

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

Parámetros de entrada

  • carrierstringObligatorio

    Filter by specific carrier (e.g., 'ups', 'fedex', 'usps', 'dhl_express')

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Customs DeclarationSHIPPO_GET_CUSTOMS_DECLARATIONAcción

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.

Parámetros de entrada

  • pageinteger

    The page number you want to select

  • shippo_api_versionstring

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

  • customs_declaration_idstringObligatorio

    Object ID of the customs declaration to retrieve

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get customs itemSHIPPO_GET_CUSTOMS_ITEMAcción

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

Parámetros de entrada

  • pageinteger

    The page number you want to select. Use this for pagination if the API returns multiple pages of results.

  • customs_item_idstringObligatorio

    Object ID of the customs item to retrieve.

  • shippo_api_versionstring

    String used to pick a non-default API version to use. Only use this if you need a specific API version.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Default Parcel TemplateSHIPPO_GET_DEFAULT_PARCEL_TEMPLATEAcción

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.

Parámetros de entrada

  • shippo_api_versionstring

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

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get MerchantSHIPPO_GET_MERCHANTAcción

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.

Parámetros de entrada

  • merchant_idstringObligatorio

    Object ID of the merchant to retrieve

  • shippo_api_versionstring

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

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Merchant AddressSHIPPO_GET_MERCHANT_ADDRESSAcción

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.

Parámetros de entrada

  • address_idstringObligatorio

    Object ID of the address to retrieve

  • merchant_idstringObligatorio

    Object ID of the merchant whose address to retrieve

  • shippo_api_versionstring

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

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Merchant BatchSHIPPO_GET_MERCHANT_BATCHAcción

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.

Parámetros de entrada

  • batch_idstringObligatorio

    Object ID of the batch

  • merchant_idstringObligatorio

    Object ID of the merchant

  • shippo_api_versionstring

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

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Merchant Carrier AccountSHIPPO_GET_MERCHANT_CARRIER_ACCOUNTAcción

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.

Parámetros de entrada

  • merchant_idstringObligatorio

    Object ID of the merchant whose carrier account to retrieve.

  • carrier_account_idstringObligatorio

    Object ID of the carrier account to retrieve.

  • shippo_api_versionstring

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

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Merchant Carrier Registration StatusSHIPPO_GET_MERCHANT_CARRIER_REGISTRATION_STATUSAcción

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.

Parámetros de entrada

  • carrierstringObligatorioenum

    The carrier to check registration status for. Must be one of: ups, usps, or canada_post.

    upsuspscanada_post
  • merchant_idstringObligatorio

    Object ID of the merchant. This is the merchant's unique identifier in Shippo's Platform API system.

  • SHIPPO-API-VERSIONstring

    String used to pick a non-default API version to use. Leave empty to use the default version.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Merchant Customs DeclarationSHIPPO_GET_MERCHANT_CUSTOMS_DECLARATIONAcción

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.

Parámetros de entrada

  • pageinteger

    The page number you want to select for paginated results

  • merchant_idstringObligatorio

    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_versionstring

    String used to pick a non-default API version to use. Leave empty to use the default version.

  • customs_declaration_idstringObligatorio

    Object ID of the customs declaration to retrieve. Use this to fetch a specific declaration by its unique identifier.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Merchant Customs ItemSHIPPO_GET_MERCHANT_CUSTOMS_ITEMAcción

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.

Parámetros de entrada

  • pageinteger

    The page number you want to select

  • merchant_idstringObligatorio

    Object ID of the merchant whose customs item you want to retrieve

  • customs_item_idstringObligatorio

    Object ID of the customs item to retrieve

  • shippo_api_versionstring

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

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Merchant ManifestSHIPPO_GET_MERCHANT_MANIFESTAcción

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.

Parámetros de entrada

  • manifest_idstringObligatorio

    Object ID of the manifest to retrieve

  • merchant_idstringObligatorio

    Object ID of the merchant

  • shippo_api_versionstring

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

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Merchant OrderSHIPPO_GET_MERCHANT_ORDERAcción

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.

Parámetros de entrada

  • order_idstringObligatorio

    Object ID of the order to retrieve

  • merchant_idstringObligatorio

    Object ID of the merchant

  • shippo_api_versionstring

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

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Merchant ParcelSHIPPO_GET_MERCHANT_PARCELAcción

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.

Parámetros de entrada

  • parcel_idstringObligatorio

    Object ID of the parcel to retrieve

  • merchant_idstringObligatorio

    Object ID of the merchant

  • shippo_api_versionstring

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

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Merchant RateSHIPPO_GET_MERCHANT_RATEAcción

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.

Parámetros de entrada

  • rate_idstringObligatorio

    Object ID of the rate to retrieve. This is a unique identifier for the rate.

  • merchant_idstringObligatorio

    Object ID of the merchant whose rate to retrieve. This is a unique identifier for the merchant on the Shippo Platform.

  • shippo_api_versionstring

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

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Merchant RefundSHIPPO_GET_MERCHANT_REFUNDAcción

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.

Parámetros de entrada

  • refund_idstringObligatorio

    Object ID of the refund to retrieve

  • merchant_idstringObligatorio

    Object ID of the merchant whose refund to retrieve

  • shippo_api_versionstring

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

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Merchant ShipmentSHIPPO_GET_MERCHANT_SHIPMENTAcción

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.

Parámetros de entrada

  • merchant_idstringObligatorio

    Object ID of the merchant

  • shipment_idstringObligatorio

    Object ID of the shipment to retrieve

  • shippo_api_versionstring

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

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Merchant Tracking StatusSHIPPO_GET_MERCHANT_TRACKAcción

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.

Parámetros de entrada

  • carrierstringObligatorio

    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_idstringObligatorio

    Object ID of the merchant whose tracking to retrieve

  • tracking_numberstringObligatorio

    Tracking number to track. The format varies by carrier (e.g., USPS: 9205590164917312751089, Shippo test: SHIPPO_DELIVERED).

  • shippo_api_versionstring

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

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Merchant TransactionSHIPPO_GET_MERCHANT_TRANSACTIONAcción

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.

Parámetros de entrada

  • merchant_idstringObligatorio

    Object ID of the merchant

  • transaction_idstringObligatorio

    Object ID of the transaction to retrieve

  • shippo_api_versionstring

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

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get OrderSHIPPO_GET_ORDERAcción

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.

Parámetros de entrada

  • order_idstringObligatorio

    Object ID of the order to retrieve.

  • shippo_api_versionstring

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

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get ParcelSHIPPO_GET_PARCELAcción

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.

Parámetros de entrada

  • parcel_idstringObligatorio

    Object ID of the parcel to retrieve.

  • shippo_api_versionstring

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

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get RateSHIPPO_GET_RATEAcción

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.

Parámetros de entrada

  • rate_idstringObligatorio

    Object ID of the rate to retrieve. This is a unique identifier for the rate.

  • shippo_api_versionstring

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

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get RefundSHIPPO_GET_REFUNDAcción

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.

Parámetros de entrada

  • refund_idstringObligatorio

    Object ID of the refund to retrieve. This is a unique identifier returned when creating a refund.

  • shippo_api_versionstring

    String used to pick a non-default API version to use. Optional header parameter.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get ShipmentSHIPPO_GET_SHIPMENTAcción

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.

Parámetros de entrada

  • shipment_idstringObligatorio

    Object ID of the shipment to retrieve

  • shippo_api_versionstring

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

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Shippo AccountSHIPPO_GET_SHIPPO_ACCOUNTAcción

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.

Parámetros de entrada

  • shippo_account_idstringObligatorio

    Object ID of the Shippo Account to retrieve

  • shippo_api_versionstring

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

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Tracking StatusSHIPPO_GET_TRACKAcción

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.

Parámetros de entrada

  • carrierstringObligatorio

    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_numberstringObligatorio

    Tracking number to track. The format varies by carrier (e.g., USPS: 9205590164917312751089, Shippo test: SHIPPO_DELIVERED).

  • shippo_api_versionstring

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

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get TransactionSHIPPO_GET_TRANSACTIONAcción

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.

Parámetros de entrada

  • transaction_idstringObligatorio

    Object ID of the transaction to retrieve

  • shippo_api_versionstring

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

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get User Parcel TemplateSHIPPO_GET_USER_PARCEL_TEMPLATEAcción

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.

Parámetros de entrada

  • shippo_api_versionstring

    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_idstringObligatorio

    Object ID of the user parcel template to retrieve.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get WebhookSHIPPO_GET_WEBHOOKAcción

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.

Parámetros de entrada

  • webhook_idstringObligatorio

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

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List AddressesSHIPPO_LIST_ADDRESSESAcción

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.

Parámetros de entrada

  • pageinteger

    The page number you want to select

  • resultsinteger

    The number of results to return per page (max 100)

  • SHIPPO_API_VERSIONstring

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

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Carrier AccountsSHIPPO_LIST_CARRIER_ACCOUNTSAcción

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.

Parámetros de entrada

  • pageinteger

    The page number you want to select

  • resultsinteger

    The number of results to return per page (max 100)

  • SHIPPO_API_VERSIONstring

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

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Carrier Parcel TemplatesSHIPPO_LIST_CARRIER_PARCEL_TEMPLATESAcción

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.

Parámetros de entrada

  • carrierstring

    Filter templates by specific carrier name (e.g., 'fedex', 'usps', 'ups')

  • includestringenum

    Filter templates by type: 'all' returns all templates, 'user' returns only user-created templates, 'enabled' returns only enabled templates

    alluserenabled
  • shippo_api_versionstring

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

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Customs DeclarationsSHIPPO_LIST_CUSTOMS_DECLARATIONSAcción

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

Parámetros de entrada

  • pageinteger

    The page number you want to select

  • resultsinteger

    The number of results to return per page (max 100)

  • SHIPPO_API_VERSIONstring

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

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Customs ItemsSHIPPO_LIST_CUSTOMS_ITEMSAcción

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

Parámetros de entrada

  • pageinteger

    The page number you want to select

  • resultsinteger

    The number of results to return per page (max 100)

  • SHIPPO-API-VERSIONstring

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

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List ManifestsSHIPPO_LIST_MANIFESTSAcción

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.

Parámetros de entrada

  • pageinteger

    The page number you want to select. Must be greater than or equal to 1.

  • resultsinteger

    The number of results to return per page. Must be between 1 and 100.

  • shippo_api_versionstring

    String used to pick a non-default API version to use for this request.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Merchant AddressesSHIPPO_LIST_MERCHANT_ADDRESSESAcción

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.

Parámetros de entrada

  • pageinteger

    The page number you want to select

  • resultsinteger

    The number of results to return per page (max 100)

  • merchant_idstringObligatorio

    Object ID of the merchant whose addresses you want to list

  • shippo_api_versionstring

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

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Merchant Carrier AccountsSHIPPO_LIST_MERCHANT_CARRIER_ACCOUNTSAcción

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.

Parámetros de entrada

  • pageinteger

    The page number you want to select

  • resultsinteger

    The number of results to return per page (max 100)

  • merchant_idstringObligatorio

    Object ID of the merchant whose carrier accounts to list

  • shippo_api_versionstring

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

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Merchant Customs DeclarationsSHIPPO_LIST_MERCHANT_CUSTOMS_DECLARATIONSAcción

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.

Parámetros de entrada

  • pageinteger

    The page number you want to select

  • resultsinteger

    The number of results to return per page (max 100)

  • merchant_idstringObligatorio

    Object ID of the merchant whose customs declarations you want to list

  • shippo_api_versionstring

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

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Merchant Customs ItemsSHIPPO_LIST_MERCHANT_CUSTOMS_ITEMSAcción

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.

Parámetros de entrada

  • pageinteger

    The page number you want to select

  • resultsinteger

    The number of results to return per page (max 100)

  • merchant_idstringObligatorio

    Object ID of the merchant whose customs items you want to list

  • shippo_api_versionstring

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

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Merchant ManifestsSHIPPO_LIST_MERCHANT_MANIFESTSAcción

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.

Parámetros de entrada

  • pageinteger

    The page number you want to select. Must be greater than or equal to 1.

  • resultsinteger

    The number of results to return per page. Must be between 1 and 100. Maximum is 100.

  • merchant_idstringObligatorio

    Object ID of the merchant to retrieve manifests for. This is the unique identifier for the merchant account.

  • shippo_api_versionstring

    String used to pick a non-default API version to use for this request.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Merchant ParcelsSHIPPO_LIST_MERCHANT_PARCELSAcción

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.

Parámetros de entrada

  • pageinteger

    The page number you want to select

  • resultsinteger

    The number of results to return per page (max 100)

  • merchant_idstringObligatorio

    Object ID of the merchant whose parcels you want to list

  • shippo_api_versionstring

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

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List MerchantsSHIPPO_LIST_MERCHANTSAcción

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.

Parámetros de entrada

  • pageinteger

    The page number you want to select

  • resultsinteger

    The number of results to return per page (max 100)

  • SHIPPO_API_VERSIONstring

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

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Merchant Shipment Rates by CurrencySHIPPO_LIST_MERCHANT_SHIPMENT_RATES_BY_CURRENCYAcción

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.

Parámetros de entrada

  • pageinteger

    The page number you want to select

  • resultsinteger

    The number of results to return per page (max 100)

  • merchant_idstringObligatorio

    Object ID of the merchant

  • shipment_idstringObligatorio

    Object ID of the shipment to retrieve rates for

  • currency_codestringObligatorio

    ISO currency code to filter rates by (e.g., USD, EUR, GBP)

  • shippo_api_versionstring

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

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Merchant ShipmentsSHIPPO_LIST_MERCHANT_SHIPMENTSAcción

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.

Parámetros de entrada

  • pageinteger

    The page number you want to select. Must be greater than or equal to 1.

  • resultsinteger

    The number of results to return per page. Must be between 1 and 100. Maximum is 100.

  • merchant_idstringObligatorio

    Object ID of the merchant to retrieve shipments for. This is the unique identifier for the merchant account.

  • shippo_api_versionstring

    String used to pick a non-default API version to use for this request.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Merchant TransactionsSHIPPO_LIST_MERCHANT_TRANSACTIONSAcción

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.

Parámetros de entrada

  • pageinteger

    The page number you want to select

  • resultsinteger

    The number of results to return per page (max 100)

  • merchant_idstringObligatorio

    Object ID of the merchant to retrieve transactions for

  • SHIPPO_API_VERSIONstring

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

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List OrdersSHIPPO_LIST_ORDERSAcción

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.

Parámetros de entrada

  • pageinteger

    The page number you want to select

  • resultsinteger

    The number of results to return per page (max 100)

  • SHIPPO_API_VERSIONstring

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

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List RefundsSHIPPO_LIST_REFUNDSAcción

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.

Parámetros de entrada

  • pageinteger

    Page number for pagination (1-indexed). Use to navigate through multiple pages of results.

  • resultsinteger

    Number of refund records to return per page (default 10). Controls page size for pagination.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Service GroupsSHIPPO_LIST_SERVICE_GROUPSAcción

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.

Parámetros de entrada

  • shippo_api_versionstring

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

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Shipment RatesSHIPPO_LIST_SHIPMENT_RATESAcción

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

Parámetros de entrada

  • pageinteger

    The page number you want to select

  • resultsinteger

    The number of results to return per page (max 100)

  • ShipmentIdstringObligatorio

    Object ID of the shipment to retrieve rates for

  • SHIPPO_API_VERSIONstring

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

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Shipment Rates by CurrencySHIPPO_LIST_SHIPMENT_RATES_BY_CURRENCYAcción

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).

Parámetros de entrada

  • pageinteger

    The page number you want to select

  • resultsinteger

    The number of results to return per page (max 100)

  • ShipmentIdstringObligatorio

    Object ID of the shipment to retrieve rates for

  • CurrencyCodestringObligatorio

    ISO currency code to filter rates by (e.g., USD, EUR, GBP)

  • SHIPPO_API_VERSIONstring

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

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List ShipmentsSHIPPO_LIST_SHIPMENTSAcción

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.

Parámetros de entrada

  • pageinteger

    The page number you want to select

  • resultsinteger

    The number of results to return per page (max 100)

  • SHIPPO_API_VERSIONstring

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

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Shippo AccountsSHIPPO_LIST_SHIPPO_ACCOUNTSAcción

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.

Parámetros de entrada

  • pageinteger

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

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List User Parcel TemplatesSHIPPO_LIST_USER_PARCEL_TEMPLATESAcción

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.

Parámetros de entrada

  • shippo_api_versionstring

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

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Purchase Merchant BatchSHIPPO_PURCHASE_MERCHANT_BATCHAcción

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.

Parámetros de entrada

  • batch_idstringObligatorio

    Object ID of the batch to purchase

  • merchant_idstringObligatorio

    Object ID of the merchant

  • shippo_api_versionstring

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

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Remove Shipments From BatchSHIPPO_REMOVE_SHIPMENTS_FROM_BATCHAcción

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.

Parámetros de entrada

  • batch_idstringObligatorio

    Object ID of the batch from which to remove shipments

  • merchant_idstringObligatorio

    Object ID of the merchant who owns the batch

  • shipment_idsstring[]Obligatorio

    Array of shipment object IDs to remove from the batch. Each ID must be a valid shipment identifier.

  • shippo_api_versionstring

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

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update Carrier AccountSHIPPO_UPDATE_CARRIER_ACCOUNTAcción

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.

Parámetros de entrada

  • activeboolean

    Whether the carrier account should be active or inactive. Set to true to enable, false to disable.

  • carrierstringObligatorio

    The carrier name/identifier (e.g., 'usps', 'ups', 'fedex', 'dhl_express', 'lso'). This field is required.

  • account_idstringObligatorio

    The carrier account identifier. This field is required.

  • parametersobject

    Optional carrier-specific parameters as key-value pairs. The structure varies by carrier.

  • carrier_account_idstringObligatorio

    Object ID of the carrier account to update (e.g., '2bf70116c96f40159b54c16f022586c7').

  • shippo_api_versionstring

    Optional string to specify a non-default API version to use for this request.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update Default Parcel TemplateSHIPPO_UPDATE_DEFAULT_PARCEL_TEMPLATEAcción

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.

Parámetros de entrada

  • object_idstringObligatorio

    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-VERSIONstring

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

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update MerchantSHIPPO_UPDATE_MERCHANTAcción

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.

Parámetros de entrada

  • emailstringObligatorio

    The merchant's email address. This field is required.

  • last_namestringObligatorio

    The merchant's last name. This field is required.

  • first_namestringObligatorio

    The merchant's first name. This field is required.

  • merchant_idstringObligatorio

    Object ID of the merchant to update (e.g., '5d23a7d95cef472fbdf4758dd7564f48').

  • merchant_namestringObligatorio

    The merchant's business/company name. This field is required.

  • shippo_api_versionstring

    Optional string to specify a non-default API version to use for this request.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update Merchant Carrier AccountSHIPPO_UPDATE_MERCHANT_CARRIER_ACCOUNTAcción

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.

Parámetros de entrada

  • activeboolean

    Whether the carrier account should be active or inactive. Set to true to enable, false to disable.

  • carrierstringObligatorio

    The carrier name/identifier (e.g., 'ups', 'usps', 'fedex'). This field is required.

  • account_idstringObligatorio

    The carrier account identifier. This field is required.

  • parametersobjectObligatorio

    Carrier-specific parameters. For UPS, includes billing address, account details, and invoice information.

  • merchant_idstringObligatorio

    Object ID of the merchant (e.g., '5d23a7d95cef472fbdf4758dd7564f48').

  • carrier_account_idstringObligatorio

    Object ID of the carrier account to update (e.g., '15c67bc9e2694e7c896c8d995d313442').

  • shippo_api_versionstring

    Optional string to specify a non-default API version to use for this request.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update Service GroupSHIPPO_UPDATE_SERVICE_GROUPAcción

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.

Parámetros de entrada

  • namestring

    Name of the service group

  • typestring

    Type of service group (e.g., FLAT_RATE, LIVE_RATE)

  • flat_ratestring

    Flat rate amount (used when type is FLAT_RATE)

  • is_activeboolean

    Whether the service group is active

  • object_idstringObligatorio

    The object ID of the service group being updated

  • descriptionstring

    Description of the service group

  • service_levelsobject[]

    Array of service level configurations to associate with this group

  • rate_adjustmentinteger

    Rate adjustment value as percentage (e.g., 10 for 10% increase, -5 for 5% decrease)

  • flat_rate_currencystring

    Currency for the flat rate (ISO 4217 currency code)

  • free_shipping_threshold_minstring

    Minimum amount for free shipping threshold

  • free_shipping_threshold_currencystring

    Currency for free shipping threshold (ISO 4217 currency code)

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update User Parcel TemplateSHIPPO_UPDATE_USER_PARCEL_TEMPLATEAcción

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.

Parámetros de entrada

  • weightstringObligatorio

    The weight of the parcel. Up to six digits in front and four digits after the decimal separator are accepted.

  • templatestringObligatorio

    The token of a carrier parcel template (e.g., USPS_FlatRateEnvelope, USPS_FlatRatePaddedEnvelope, FedExBox). This specifies the carrier's predefined package type.

  • weight_unitstringObligatorio

    The unit of weight measurement (e.g., lb for pounds, kg for kilograms, oz for ounces, g for grams).

  • shippo_api_versionstring

    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_idstringObligatorio

    Object ID of the user parcel template to update. This is the unique identifier of an existing user parcel template.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update WebhookSHIPPO_UPDATE_WEBHOOKAcción

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.

Parámetros de entrada

  • urlstringObligatorio

    The webhook URL endpoint where notifications will be sent. Must be a valid HTTPS URL.

  • eventstringObligatorioenum

    The webhook event type to listen for. Use 'all' to receive all event types.

    batch_createdtransaction_createdtransaction_updatedtrack_updatedbatch_updatedall
  • activebooleanObligatorio

    Whether the webhook should be active or inactive. Set to true to enable, false to disable.

  • is_testbooleanObligatorio

    Whether this is a test webhook. Set to true for testing, false for production.

  • webhook_idstringObligatorio

    Object ID of the webhook to update (e.g., '7c190fc9a7e1473dbf59c861b535e3d5').

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Validate AddressSHIPPO_VALIDATE_ADDRESSAcción

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.

Parámetros de entrada

  • address_idstringObligatorio

    Object ID of the address to validate. This is the unique identifier returned when an address was created.

  • shippo_api_versionstring

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

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Validate Merchant AddressSHIPPO_VALIDATE_MERCHANT_ADDRESSAcción

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.

Parámetros de entrada

  • address_idstringObligatorio

    Object ID of the address to validate. This is the unique identifier of the address object to be validated.

  • merchant_idstringObligatorio

    Object ID of the merchant. This is the unique identifier for the merchant whose address you want to validate.

  • shippo_api_versionstring

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

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not