Shippo icon

Shippo

Interact with Shippo API

Actions68

Overview

This node interacts with the Shippo API to list carrier accounts associated with a user's Shippo account. It allows users to retrieve detailed information about their configured shipping carriers, optionally including service levels and filtering by specific carriers or account IDs. This is useful for logistics automation, shipment management, or integrating shipping data into workflows.

Practical examples:

  • Fetch all carrier accounts to display available shipping options in an e-commerce backend.
  • Filter carrier accounts by a specific carrier (e.g., "Fedex") to manage shipments only through that carrier.
  • Paginate through large sets of carrier accounts when managing multiple shipping providers.

Properties

Name Meaning
Service Levels Boolean option to append the service_levels property to each returned carrier account.
Carrier Filter results by a specific carrier. Options include Airterra, Fedex, UPS, USPS, DHL, and many more.
Account Id Filter results by a specific carrier account ID (string).
Page The page number to select for paginated results (number).
Results Number of results to return per page (max 100, default 5) (number).
SHIPPO API VERSION Optional string to specify a non-default Shippo API version via request header.

Output

The node outputs JSON data representing a list of carrier accounts. Each item typically includes details such as carrier name, account ID, and optionally service levels if requested. The output structure corresponds directly to the Shippo API response for listing carrier accounts.

No binary data output is indicated.

Dependencies

  • Requires an API key credential for authenticating with the Shippo API.
  • The node sends requests to https://api.goshippo.com.
  • Optionally supports specifying a custom Shippo API version via a header.

Troubleshooting

  • Authentication errors: Ensure the API key credential is correctly configured and has necessary permissions.
  • Invalid filter values: Using unsupported carrier names or invalid account IDs may result in empty responses or errors.
  • Pagination issues: Requesting pages beyond available data will return empty results; verify total pages before requesting.
  • API version mismatch: Specifying an incorrect or unsupported API version string may cause request failures; consult Shippo API documentation for valid versions.

Links and References

Discussion