Shippo icon

Shippo

Interact with Shippo API

Actions68

Overview

This node interacts with the Shippo API to retrieve details about a specific customs item. It is useful in scenarios where you need to fetch detailed information about a customs item by its unique identifier, such as when managing international shipping documentation or verifying customs data before shipment.

Practical examples include:

  • Retrieving customs item details to display in a shipping dashboard.
  • Validating customs item information before creating shipping labels.
  • Automating customs data retrieval for integration with other logistics systems.

Properties

Name Meaning
Customs Item Id The unique object ID of the customs item to retrieve. This is required to specify which customs item to get.
Page The page number to select if the response supports pagination (optional).
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 customs item retrieved from the Shippo API. This includes all available details about the customs item such as description, quantity, value, weight, and any other metadata provided by Shippo.

If the API supports binary data for customs items (not indicated here), it would be summarized accordingly, but based on the code and properties, the output is purely JSON.

Dependencies

  • Requires an active Shippo API key credential configured in n8n to authenticate requests.
  • Depends on the Shippo REST API endpoint https://api.goshippo.com.
  • Optionally uses the SHIPPO-API-VERSION header to specify API versioning.

Troubleshooting

  • Missing or invalid Customs Item Id: The node requires a valid customs item ID; ensure this is correctly provided.
  • Authentication errors: Verify that the Shippo API key credential is correctly set up and has necessary permissions.
  • API version issues: If specifying a custom API version via SHIPPO-API-VERSION, ensure the version string is valid and supported by Shippo.
  • Pagination handling: If multiple pages exist, ensure the Page property is set correctly to navigate through results.
  • Network or API downtime: Check network connectivity and Shippo service status if requests fail unexpectedly.

Links and References

Discussion