Shippo icon

Shippo

Interact with Shippo API

Actions68

Overview

This node interacts with the Shippo API to list Shippo accounts. It is useful for retrieving paginated lists of accounts associated with your Shippo API key, which can be helpful for managing multiple accounts or integrating account data into workflows. For example, you might use this node to fetch all Shippo accounts in batches for reporting or synchronization purposes.

Properties

Name Meaning
Page The page number of results to retrieve (pagination control).
Results The number of results to return per page, with a maximum of 100.
SHIPPO API VERSION Optional header string to specify a non-default Shippo API version to use for the request. See Shippo API docs.

Output

The node outputs JSON data representing the list of Shippo accounts retrieved from the API. The structure typically includes an array of account objects with their details such as account ID, name, and other metadata as provided by Shippo. There is no indication that binary data is returned by this operation.

Dependencies

  • Requires a valid Shippo API key credential configured in n8n.
  • Connects to the Shippo API endpoint at https://api.goshippo.com.
  • Optionally supports specifying a custom Shippo API version via a request header.

Troubleshooting

  • Invalid API Key or Authentication Errors: Ensure the Shippo API key credential is correctly set up and has the necessary permissions.
  • Pagination Issues: If no results are returned, verify that the Page and Results parameters are within valid ranges and that there are accounts available on those pages.
  • API Version Header Misuse: Providing an incorrect or unsupported API version string may cause errors; consult Shippo's API versioning documentation to use valid versions.
  • Rate Limits: Shippo API rate limits may cause request failures; handle retries or backoff accordingly.

Links and References

Discussion