Actions32
Overview
The node integrates with the ShipStation API v2, enabling users to manage shipping batches among other resources. Specifically, for the Batch resource and the Process operation, this node allows you to trigger the processing of a batch by its ID. This is useful in scenarios where you have created or updated a batch of shipments and want to initiate their processing within ShipStation.
Practical examples include:
- Automating the workflow to process shipment batches after creation.
- Integrating batch processing into larger order fulfillment pipelines.
- Triggering batch processing as part of scheduled or event-driven automation.
Properties
| Name | Meaning |
|---|---|
| ID | The unique identifier of the batch to be processed. This is required to specify which batch the process operation should act upon. |
Output
The output JSON contains the response data from the ShipStation API after attempting to process the specified batch. It typically includes details about the batch's processing status or any relevant metadata returned by the API.
No binary data output is produced by this operation.
Example output structure (simplified):
{
"batchId": "string",
"status": "string",
"processedDate": "string",
...
}
Dependencies
- Requires an API key credential for authenticating with the ShipStation API.
- The node depends on the ShipStation API service endpoint
/v2/batches/{id}/process. - No additional environment variables are explicitly required beyond the API credentials.
Troubleshooting
Common issues:
- Invalid or missing batch ID: Ensure the "ID" property is correctly set to a valid batch identifier.
- Authentication errors: Verify that the API key credential is correctly configured and has sufficient permissions.
- API rate limits or network issues: These can cause request failures; retry logic or error handling may be necessary.
Error messages:
- Errors returned from the ShipStation API are caught and handled by the node. If an error occurs, it will either throw an exception or return an error object in the output if "Continue On Fail" is enabled.
- Typical error messages might indicate invalid IDs, unauthorized access, or server errors. Review the message content for guidance and check API credentials and input parameters accordingly.