Actions32
Overview
This node interacts with the ShipStation API v2 to manage batches of shipments and related entities. Specifically, the Batch - List operation retrieves a list of batch records from ShipStation. It supports pagination and can return either a single page of results or all available batches.
Typical use cases include:
- Retrieving batches of shipments for processing or review.
- Automating workflows that need to handle multiple shipment batches.
- Integrating batch data into other systems for reporting or fulfillment.
For example, you might use this node to fetch all shipment batches created in your ShipStation account to trigger further automation like printing labels or updating order statuses.
Properties
| Name | Meaning |
|---|---|
| Options | Collection of optional parameters to control the listing behavior: |
| Page | Page number to retrieve (default: 1) |
| Page Size | Number of items per page (default: 50) |
| Return All | Boolean flag to return all results across all pages instead of just one page |
Output
The output is an array of JSON objects representing batches retrieved from ShipStation. Each item corresponds to a batch record as returned by the ShipStation API.
The json field contains the batch data structure, which typically includes batch identifiers, status, creation date, and other metadata relevant to shipment batches.
No binary data output is produced by this operation.
Dependencies
- Requires an API key credential for authenticating with the ShipStation API.
- The node uses internal services for API requests, error handling, and pagination.
- No additional environment variables are explicitly required beyond the API credential.
Troubleshooting
Common issues:
- API authentication failures due to invalid or missing API credentials.
- Pagination parameters out of range or invalid causing empty or partial results.
- Network or API service errors leading to request failures.
Error messages:
- Errors returned from the ShipStation API are caught and rethrown with descriptive messages.
- If the API returns an error object, it is handled and surfaced clearly.
- If "Unknown operation" error appears, verify that the Resource is set to "Batch" and Operation to "List".
Resolutions:
- Ensure valid API credentials are configured in n8n.
- Adjust pagination options if too many or no results are returned.
- Use the "Return All" option carefully to avoid very large data loads that may impact performance.