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 "Get Batch" operation in the Batches resource allows users to retrieve detailed information about a specific batch object from the Shippo API. This node is useful when you want to fetch the status, contents, or metadata of a particular batch shipment or processing group identified by its unique batch ID.
Common scenarios include:
- Tracking the progress or status of a batch shipment.
- Retrieving batch details for reporting or auditing purposes.
- Integrating batch data into workflows that require conditional logic based on batch state.
For example, after creating a batch of shipments, you might use this node to periodically check the batch's status until all shipments are processed.
Properties
| Name | Meaning |
|---|---|
| Batch Id | The unique identifier (Object ID) of the batch you want to retrieve. |
| Page | The page number of results to select if the batch data supports pagination. Defaults to 1. |
| Results | Number of results to return per page, with a maximum of 100 and default of 5. |
| SHIPPO API VERSION | Optional header string to specify a non-default version of the Shippo API to use for this request. |
Output
The node outputs JSON data representing the batch object retrieved from the Shippo API. This includes all relevant batch details such as batch status, creation date, associated shipments, and any metadata provided by the API.
If the batch data includes multiple items and pagination is used, the output will reflect the selected page and number of results as specified in the input properties.
This node does not output binary data.
Dependencies
- Requires an active connection to the Shippo API using an API key credential.
- The node sends requests to
https://api.goshippo.com. - Optionally supports specifying the API version via a custom header.
- No additional external dependencies beyond the Shippo API and proper authentication.
Troubleshooting
- Invalid Batch Id: If the provided Batch Id does not exist or is malformed, the API will likely return a 404 or error response. Verify the Batch Id is correct.
- Authentication Errors: Ensure the API key credential is valid and has permissions to access batch data.
- Pagination Issues: Requesting a page number or results count outside the allowed range may cause errors or empty responses. Use sensible values (page ≥ 1, results ≤ 100).
- API Version Header: Specifying an unsupported API version string may lead to unexpected errors. Refer to Shippo’s API versioning documentation before using this option.