Shippo icon

Shippo

Interact with Shippo API

Actions68

Overview

This node interacts with the Shippo API to list shipment rates for a specified shipment. It is useful when you want to retrieve available shipping rate options for a particular shipment, enabling you to compare prices and services before selecting one. Practical examples include automating shipping workflows in e-commerce platforms or logistics systems where you need to fetch and display shipping options dynamically.

Properties

Name Meaning
Shipment Id The unique identifier (Object ID) of the shipment for which you want to list rates. This is required.
Page The page number of results to retrieve, useful for paginated responses. Defaults to 1.
Results The number of rate results to return per page, with a maximum of 100. Defaults to 25.
SHIPPO API VERSION Optional header to specify a non-default version of the Shippo API to use. Useful for accessing newer or legacy API features.

Output

The node outputs JSON data containing the list of shipment rates retrieved from the Shippo API. Each item typically includes details such as carrier, service level, cost, estimated delivery time, and other relevant shipping rate information. This output can be used downstream in workflows to select a shipping option or display rate comparisons.

No binary data output is indicated by the source code.

Dependencies

  • Requires an active Shippo API key credential configured in n8n.
  • Connects to the Shippo API endpoint at https://api.goshippo.com.
  • Supports optional API versioning via a custom header.

Troubleshooting

  • Missing or invalid Shipment Id: Ensure the Shipment Id provided exists and is correctly formatted; otherwise, the API will return an error.
  • API authentication errors: Verify that the Shippo API key credential is correctly set up and has necessary permissions.
  • Pagination issues: If requesting pages beyond available data, the response may be empty; adjust the Page and Results parameters accordingly.
  • API version mismatch: Using an unsupported API version string in the SHIPPO API VERSION property may cause unexpected errors; consult Shippo's API versioning documentation.

Links and References

Discussion