Shippo icon

Shippo

Interact with Shippo API

Actions68

Overview

This node interacts with the Shippo API to retrieve details of a specific user parcel template by its unique Object ID. It is useful when you need to fetch predefined parcel templates associated with a user account, for example, to review or reuse shipping package configurations in automated workflows.

Practical examples include:

  • Automatically retrieving parcel template details before creating a shipment.
  • Validating or displaying parcel template information within a workflow.
  • Integrating with other systems that require parcel dimension and packaging data stored in Shippo.

Properties

Name Meaning
User Parcel Template Object Id The unique identifier (Object ID) of the user parcel template you want to retrieve. This is required.
SHIPPO API VERSION Optional header to specify a non-default version of the Shippo API to use for this request. See Shippo's API versioning guide for details.

Output

The node outputs JSON data representing the user parcel template object retrieved from Shippo. This typically includes fields such as dimensions, weight, template name, and other metadata related to the parcel template.

No binary data output is produced by this node.

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 supports specifying the API version via a custom header.

Troubleshooting

  • Invalid Object ID: If the provided User Parcel Template Object Id does not exist or is malformed, the API will return an error. Verify the ID is correct.
  • Authentication errors: Ensure the Shippo API key credential is valid and has necessary permissions.
  • API version issues: Using an unsupported or incorrect API version string may cause request failures. Refer to Shippo’s API versioning documentation.
  • Network or connectivity problems: Check network access to api.goshippo.com.

Common error messages usually come directly from the Shippo API and should be interpreted according to their documentation.

Links and References

Discussion