Shippo icon

Shippo

Interact with Shippo API

Actions68

Overview

This node interacts with the Shippo API to list shipments. It is useful for retrieving paginated lists of shipment records, optionally filtered by creation date and time. Typical use cases include syncing shipment data from Shippo into other systems, monitoring recent shipments, or processing batches of shipment information for reporting or automation workflows.

For example, you might use this node to:

  • Fetch the first 25 shipments created after a specific date.
  • Retrieve subsequent pages of shipment data using page tokens.
  • Limit results per page to optimize performance or meet API constraints.

Properties

Name Meaning
Page Token The page token for paginated results; used to fetch the next set of results in a multi-page list.
Page The page number to select when listing shipments.
Results Number of results to return per page (maximum 100).
Object Created Gt Filter shipments created greater than the specified date and time.
Object Created Gte Filter shipments created greater than or equal to the specified date and time.
Object Created Lt Filter shipments created less than the specified date and time.
Object Created Lte Filter shipments created less than or equal to the specified date and time.
SHIPPO API VERSION Optional header to specify a non-default Shippo API version to use.

Output

The node outputs JSON data representing the list of shipments retrieved from the Shippo API. This typically includes an array of shipment objects with their details such as shipment IDs, addresses, statuses, and timestamps.

If pagination is used, the output may also contain metadata like next page tokens to facilitate fetching additional pages.

The node does not output binary data.

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 request header.

Troubleshooting

  • Invalid API Key or Authentication Errors: Ensure that the API key credential is correctly configured and has appropriate permissions.
  • Pagination Issues: If no results are returned or pagination tokens do not work, verify that the correct page token or page number is provided.
  • Date Filters Not Working: Confirm that date/time strings are in the expected format accepted by the Shippo API.
  • API Version Header Misuse: Using an unsupported API version string may cause errors; check Shippo's API versioning documentation for valid values.

Links and References

Discussion