Shippo icon

Shippo

Interact with Shippo API

Actions68

Overview

This node integrates with the Shippo API to create a tracking entry for a shipment. It allows users to submit a carrier name and a tracking number, optionally including metadata and specifying an API version. This is useful for logistics, e-commerce, or shipping workflows where tracking information needs to be programmatically created and managed.

Typical use cases include:

  • Automatically registering shipments with carriers after order fulfillment.
  • Tracking packages by creating tracking entries in Shippo to monitor delivery status.
  • Attaching custom metadata to shipments for internal tracking or reporting purposes.

Properties

Name Meaning
SHIPPO API VERSION Optional string to specify a non-default Shippo API version to use for the request. See Shippo's API versioning guide.
Carrier Required. The name of the shipment carrier (e.g., USPS, FedEx) whose tracking information you want to create.
Metadata Optional string (up to 100 characters) to attach any additional information to the tracking object.
Tracking Number Required. The tracking number provided by the carrier to track the shipment.

Output

The node outputs JSON data representing the newly created tracking object as returned by the Shippo API. This typically includes details such as the tracking status, carrier information, tracking number, and any metadata attached.

If the Shippo API supports binary data related to tracking (e.g., labels or documents), this node does not explicitly handle binary output based on the provided code and properties.

Dependencies

  • Requires an active Shippo API key credential configured in n8n to authenticate requests.
  • Uses the Shippo REST API endpoint at https://api.goshippo.com.
  • Optionally supports specifying a Shippo API version via a header.

Troubleshooting

  • Missing Required Fields: Ensure that both "Carrier" and "Tracking Number" are provided; otherwise, the API call will fail.
  • Invalid API Key or Authentication Errors: Verify that the Shippo API key credential is correctly set up and has necessary permissions.
  • Unsupported Carrier Names: Use valid carrier names recognized by Shippo; invalid names may cause errors.
  • API Version Issues: If specifying a custom API version, ensure it matches one supported by Shippo to avoid compatibility problems.
  • Metadata Length: Metadata strings longer than 100 characters may be rejected by the API.

Common error messages will generally come from the Shippo API and should be interpreted according to their documentation. Checking the response body for error details can help resolve issues.

Links and References

Discussion