Shippo icon

Shippo

Interact with Shippo API

Actions68

Overview

This node interacts with the Shippo API to list customs declarations. It is useful for users who need to retrieve paginated lists of customs declaration records, such as logistics companies, e-commerce platforms, or shipping service providers managing international shipments. For example, a user can fetch customs declarations page by page to display in an admin dashboard or to process them further in an automated workflow.

Properties

Name Meaning
Page The page number of results to retrieve. Useful for pagination when there are many customs declarations.
Results Number of customs declaration records to return per page. Maximum is 100; default is 5.
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 a list of customs declarations retrieved from the Shippo API. Each item in the output corresponds to a customs declaration record with its associated details as provided by the API. There is no binary data output.

Dependencies

  • Requires an API key credential for authenticating with the Shippo API.
  • The node sends requests to https://api.goshippo.com.
  • Optionally supports specifying the API version via a custom header.
  • No additional external dependencies beyond the Shippo API and n8n's HTTP request capabilities.

Troubleshooting

  • Common issues:

    • Invalid or missing API key will cause authentication errors.
    • Requesting a page number beyond available pages may return empty results.
    • Specifying an unsupported API version string could lead to unexpected errors or fallback to default API behavior.
    • Exceeding the maximum allowed results per page (over 100) might result in validation errors.
  • Error messages:

    • Authentication failures typically indicate invalid credentials; verify the API key setup.
    • Rate limiting errors from the Shippo API suggest too many requests in a short time; implement retries or backoff.
    • Validation errors on query parameters mean input values should be checked for correctness (e.g., positive integers for page and results).

Links and References

Discussion