Shippo icon

Shippo

Interact with Shippo API

Actions68

Overview

This node integrates with the Shippo API to create customs declarations. Customs declarations are essential documents required for international shipping, detailing the contents, value, and other relevant information about a shipment. This node is beneficial for e-commerce platforms, logistics companies, or any business that needs to automate the generation of customs paperwork when shipping goods internationally.

Practical examples include:

  • Automatically generating customs declarations when creating international shipments.
  • Streamlining compliance with customs regulations by ensuring all necessary data is included.
  • Reducing manual entry errors by programmatically creating declarations based on order data.

Properties

Name Meaning
SHIPPO API VERSION Optional string to specify a non-default version of the Shippo API to use for the request. See Shippo's API versioning guide.

Output

The node outputs JSON data representing the created customs declaration as returned by the Shippo API. This typically includes details such as the declaration ID, status, contents description, declared value, currency, and other metadata related to the customs document.

If the node supports binary data output (not indicated in the provided code), it would represent associated files or documents related to the customs declaration, but this is not evident here.

Dependencies

  • Requires an active Shippo API key credential configured in n8n for authentication.
  • Connects to the Shippo API endpoint at https://api.goshippo.com.
  • Optionally uses the SHIPPO-API-VERSION header to select a specific API version if provided.

Troubleshooting

  • Invalid or missing API key: Ensure the Shippo API key credential is correctly set up in n8n.
  • Incorrect API version header: If specifying SHIPPO-API-VERSION, verify the version string matches one supported by Shippo.
  • Network issues: Confirm that n8n can reach the Shippo API endpoint without firewall or proxy restrictions.
  • API errors from Shippo: Check the response message for details; common issues include invalid payload structure or missing required fields in the customs declaration data.

Links and References

Discussion