Actions68
- Parcels Actions
- Shipments Actions
- Rates Actions
- Transactions Actions
- Customs Items Actions
- Tracking Status Actions
- Batches Actions
- Orders Actions
- Pickups Actions
- Service Groups Actions
- Customs Declarations Actions
- Refunds Actions
- Manifests Actions
- Carrier Accounts Actions
- Webhooks Actions
- Carrier Parcel Templates Actions
- User Parcel Templates Actions
- Rates At Checkout Actions
- Shippo Accounts Actions
- Addresses Actions
Overview
The "List Orders" operation of the Shippo node retrieves a paginated list of orders from the Shippo API. This is useful for workflows that need to process, analyze, or synchronize order data from various e-commerce platforms integrated with Shippo. For example, you might use this node to fetch recent orders for fulfillment automation, reporting, or inventory management.
Properties
| Name | Meaning |
|---|---|
| Page | The page number of results to retrieve (pagination). |
| Results | Number of orders to return per page, with a maximum of 100. |
| SHIPPO API VERSION | Optional header to specify a non-default Shippo API version to use. See Shippo's API versioning documentation for details. |
| Order Status | Filter orders by their status. Accepts an array of statuses to filter the results. |
| Shop App | Filter orders by the originating shop application. Options include Amazon, Bigcommerce, CSV Import, eBay, Etsy, Godaddy, Magento, Shippo, Shopify, Spreecommerce, Stripe Relay, Walmart, Weebly, WooCommerce. |
| Start Date | Filter orders placed after this date/time (ISO 8601 UTC format). Based on when the order was placed, not object creation time. |
| End Date | Filter orders placed before this date/time (ISO 8601 UTC format). Based on when the order was placed, not object creation time. |
Output
The node outputs JSON data representing the list of orders retrieved from Shippo. Each item in the output corresponds to an order object containing details such as order ID, status, placement date, and associated shop app. The structure directly reflects the Shippo API response for listing orders.
No binary data output is indicated for this operation.
Dependencies
- Requires an API key credential for authenticating with the Shippo API.
- The node sends requests to
https://api.goshippo.com. - Optionally supports specifying a custom Shippo API version via a request header.
- No other external dependencies are required.
Troubleshooting
Common issues:
- Invalid or missing API key will cause authentication errors.
- Requesting pages beyond available data may return empty results.
- Using invalid date formats for start_date or end_date filters can cause request failures.
- Specifying unsupported order statuses or shop apps may result in no matching orders.
Error messages:
- Authentication errors typically indicate problems with the API key; verify credentials.
- HTTP 400 errors often relate to malformed query parameters; check date formats and filter values.
- Rate limiting errors may occur if too many requests are made in a short period; implement retry logic or reduce request frequency.