Shippo icon

Shippo

Interact with Shippo API

Actions68

Overview

This node interacts with the Shippo API to create a live shipping rate at checkout. It is designed to calculate real-time shipping rates based on specified origin and destination addresses, line items in the shipment, and optionally a parcel template. This functionality is useful for e-commerce platforms or logistics applications that need to provide customers with accurate shipping costs before completing a purchase.

Typical use cases include:

  • Calculating shipping costs dynamically during an online checkout process.
  • Comparing shipping rates from multiple carriers to offer the best option.
  • Automating shipping cost calculations in order management workflows.

Properties

Name Meaning
SHIPPO API VERSION Optional string to specify a non-default Shippo API version to use for the request.
Address From Object ID referencing an existing origin address in Shippo.
Address To Object ID referencing an existing destination address in Shippo. (Required)
Line Items JSON array of line item objects representing the contents of the shipment. (Required)
Parcel Object ID referencing an existing user parcel template in Shippo.

Output

The node outputs JSON data containing the live shipping rate information returned by the Shippo API. This typically includes details such as carrier name, service level, estimated delivery time, and cost. The output can be used downstream in workflows to display shipping options or to proceed with label creation.

No binary data output is indicated by the source code.

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 a custom Shippo API version via the input property.

Troubleshooting

  • Missing Required Fields: Ensure that "Address To" and "Line Items" are provided; these are mandatory.
  • Invalid Object IDs: The "Address From", "Address To", and "Parcel" fields expect valid Shippo object IDs. Invalid or non-existent IDs will cause API errors.
  • API Version Issues: Specifying an unsupported or incorrect API version string may result in request failures.
  • Authentication Errors: Verify that the Shippo API key credential is correctly set up and has necessary permissions.
  • JSON Parsing Errors: The "Line Items" field expects valid JSON. Malformed JSON will cause parsing errors.

Links and References

Discussion