Shippo icon

Shippo

Interact with Shippo API

Actions68

Overview

This node interacts with the Shippo API to list carrier parcel templates. It allows users to retrieve a filtered list of parcel templates associated with shipping carriers, which can be useful for managing and selecting predefined parcel sizes and types when creating shipments.

Common scenarios include:

  • Fetching all available parcel templates to display in a UI for selection.
  • Filtering parcel templates by user-specific or enabled status to streamline options.
  • Narrowing down parcel templates to those belonging to a specific carrier.

Practical example:
A logistics company wants to show only enabled parcel templates from a particular carrier to their shipping department, ensuring that only valid and approved parcel sizes are used for shipment creation.

Properties

Name Meaning
Include Filter parcel templates by:
- All (all templates)
- User (templates created by the user)
- Enabled (templates currently enabled)
Carrier Filter parcel templates by a specific carrier name or identifier (string input)
SHIPPO API VERSION Optional header to specify a non-default Shippo API version to use for the request

Output

The node outputs JSON data representing the list of carrier parcel templates retrieved from the Shippo API. Each item in the output typically includes details about a parcel template such as dimensions, weight limits, carrier association, and status (enabled/disabled).

If binary data were involved (e.g., images or documents), it would be summarized here, but this node focuses on JSON data only.

Dependencies

  • Requires an active Shippo API key credential configured in n8n for authentication.
  • Depends on the Shippo REST API endpoint https://api.goshippo.com.
  • Optionally supports specifying the Shippo API version via a custom header.

Troubleshooting

  • Invalid API Key or Authentication Errors: Ensure the Shippo API key credential is correctly set up and has necessary permissions.
  • Empty Results: Check filter parameters like "Include" and "Carrier" to ensure they match existing parcel templates.
  • API Version Issues: If using a custom API version, verify that the version string is correct and supported by Shippo.
  • Network or Connectivity Problems: Confirm that n8n can reach the Shippo API endpoint without firewall or proxy issues.

Links and References

Discussion