Actions32
Overview
This node integrates with the ShipStation API v2 to manage shipments and other related resources. Specifically, for the Shipment - List operation, it retrieves a list of shipments from a ShipStation account. This is useful for workflows that need to process, analyze, or report on shipment data, such as syncing shipment statuses, generating shipping reports, or automating fulfillment processes.
For example, you could use this node to:
- Retrieve all shipments within a certain date range or status.
- Paginate through shipments to process them in batches.
- Integrate shipment data into your CRM or ERP system.
Properties
| Name | Meaning |
|---|---|
| Options | Collection of optional parameters to control the listing behavior: |
| - Page | The page number of results to retrieve (used when not returning all). |
| - Page Size | Number of items per page to retrieve (used when not returning all). |
| - Return All | Boolean flag indicating whether to return all shipments by automatically paginating. |
Output
The output is an array of JSON objects representing shipments retrieved from ShipStation. Each item corresponds to one shipment's data as returned by the ShipStation API.
The structure of each shipment object matches the ShipStation API's shipment resource schema, including fields like shipment ID, order details, carrier info, status, and tracking numbers.
No binary data is output by this operation.
Dependencies
- Requires an API key credential for authenticating with the ShipStation API.
- Uses the ShipStation API v2 endpoints.
- Pagination is handled internally by the node when "Return All" is enabled.
- No additional environment variables are required beyond the API credentials.
Troubleshooting
- API Errors: If the ShipStation API returns an error (e.g., invalid credentials, rate limits), the node will throw an error with the message from the API. Ensure your API key is valid and has sufficient permissions.
- Pagination Limits: When "Return All" is enabled, the node fetches pages of up to 500 items until all shipments are retrieved. Large datasets may take longer to process.
- Invalid Parameters: Providing invalid page numbers or page sizes may result in empty responses or errors. Use sensible values (page ≥ 1, page size ≤ 1000).
- Unknown Operation: If the operation parameter is set incorrectly, the node throws an "Unknown operation" error.