Shippo icon

Shippo

Interact with Shippo API

Actions68

Overview

This node interacts with the Shippo API to retrieve tracking information for a given shipment. Specifically, the "Get Track" operation under the "Tracking Status" resource allows users to input a carrier name and a tracking number to fetch the current status and details of a package in transit.

Common scenarios where this node is beneficial include:

  • E-commerce platforms wanting to automatically update order statuses based on shipment tracking.
  • Customer support workflows that need quick access to shipment status without leaving the system.
  • Logistics and fulfillment automation to monitor packages and trigger alerts or follow-ups.

For example, an online store could use this node to check the delivery status of orders shipped via different carriers by providing the carrier name and tracking number, then update the order status accordingly.

Properties

Name Meaning
Tracking Number The unique tracking number assigned to the shipment by the carrier.
Carrier The name of the shipping carrier handling the package (e.g., USPS, FedEx, DHL).
SHIPPO API VERSION Optional header to specify a non-default version of the Shippo API to use for the request.

Output

The node outputs JSON data containing detailed tracking information retrieved from the Shippo API. This typically includes fields such as:

  • Current status of the shipment (e.g., in transit, delivered).
  • History of tracking events with timestamps and locations.
  • Carrier-specific details about the shipment.

If the shipment has associated binary data (such as labels or documents), the node would handle it accordingly, but based on the provided code and properties, the primary output is structured JSON tracking data.

Dependencies

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

Troubleshooting

  • Invalid Tracking Number or Carrier: If the tracking number or carrier name is incorrect or unsupported, the API may return errors or empty results. Verify the inputs are accurate.
  • Authentication Errors: Missing or invalid API credentials will cause authentication failures. Ensure the API key is correctly set up in n8n credentials.
  • API Version Issues: Specifying an unsupported or deprecated API version in the optional header might lead to unexpected errors. Use the default or consult Shippo's API versioning documentation.
  • Network or Rate Limits: Network connectivity issues or exceeding Shippo's rate limits can cause request failures. Check network status and API usage quotas.

Links and References

Discussion