Shippo icon

Shippo

Interact with Shippo API

Actions68

Overview

This node interacts with the Shippo API to list transactions. It allows users to retrieve a paginated list of transaction records filtered by various criteria such as rate ID, object status, and tracking status. This is useful for logistics, e-commerce, or shipping management workflows where you need to monitor or analyze shipment transactions programmatically.

Practical examples include:

  • Fetching all successful transactions for reconciliation.
  • Filtering transactions currently in transit to update delivery dashboards.
  • Retrieving refunded transactions for customer service follow-up.

Properties

Name Meaning
Rate Filter transactions by a specific rate ID (string).
Object Status Filter transactions by their status. Options: WAITING, QUEUED, SUCCESS, ERROR, REFUNDED, REFUNDPENDING, REFUNDREJECTED.
Tracking Status Filter transactions by tracking status. Options: UNKNOWN, PRE TRANSIT, TRANSIT, DELIVERED, RETURNED, FAILURE.
Page The page number of results to retrieve (number).
Results Number of results per page to return (max 100) (number).
SHIPPO API VERSION Optional header to specify a non-default Shippo API version to use (string).

Output

The node outputs JSON data representing a list of transactions matching the specified filters and pagination settings. Each transaction object typically includes details such as transaction ID, status, rate information, tracking status, and other metadata returned by the Shippo API.

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

Dependencies

  • Requires an API key credential for authenticating with the Shippo API.
  • Network access to https://api.goshippo.com.
  • Optional configuration of the Shippo API version via a custom header.

Troubleshooting

  • Common issues:
    • Invalid or missing API key will cause authentication errors.
    • Requesting pages beyond available results may return empty arrays.
    • Using unsupported filter values may result in API errors or no results.
  • Error messages:
    • Authentication failures: Check that the API key credential is correctly configured.
    • Rate limit exceeded: Wait and retry later or reduce request frequency.
    • Invalid parameter errors: Verify that filter values conform to allowed options.

Links and References

Discussion