Shippo icon

Shippo

Interact with Shippo API

Actions68

Overview

The "List Parcels" operation of the Shippo node retrieves a paginated list of parcel objects from the Shippo API. This is useful for users who want to view or process multiple parcels in batches, such as in shipping workflows where you need to manage or analyze shipments in bulk.

Typical use cases include:

  • Fetching parcels to display in a dashboard.
  • Processing parcels for batch label creation or shipment tracking.
  • Integrating parcel data into other systems like inventory or order management.

Properties

Name Meaning
Page The page number of results to retrieve. Useful for pagination when there are many parcels.
Results The number of parcel records to return per page. Maximum allowed is 100.
SHIPPO API VERSION Optional header to specify a non-default version of the Shippo API to use for this request.

Output

The node outputs JSON data representing the list of parcels retrieved from the Shippo API. Each item in the output corresponds to a parcel object with details such as dimensions, weight, and metadata as defined by the Shippo API.

If binary data were involved (e.g., labels), it would be indicated here, but this operation only returns JSON parcel data.

Dependencies

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

Troubleshooting

  • Invalid API Key or Authentication Errors: Ensure the Shippo API key credential is correctly set up and has proper permissions.
  • Pagination Issues: If no results appear, verify that the Page and Results parameters are within valid ranges and that parcels exist on those pages.
  • API Version Header Misuse: Providing an incorrect or unsupported API version string may cause errors; omit this field if unsure.
  • Rate Limits: Shippo enforces rate limits; excessive requests may result in temporary blocking.

Links and References

Discussion