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
This node interacts with the Shippo API to perform operations related to shipping batches. Specifically, the "Purchase Batch" operation allows users to purchase a shipping batch by providing the batch's unique identifier. This is useful in scenarios where multiple shipments are grouped into a batch for streamlined processing and payment.
Practical examples include:
- Automating the purchase of shipping labels for a batch of orders.
- Integrating batch shipment purchasing into an e-commerce fulfillment workflow.
- Managing bulk shipping operations efficiently by handling batches instead of individual shipments.
Properties
| Name | Meaning |
|---|---|
| Batch Id | The unique object ID of the batch you want to purchase. This is required to identify which batch to process. |
| SHIPPO API VERSION | Optional header string to specify a non-default version of the Shippo API to use for this request. Useful for version control. |
Output
The node outputs JSON data representing the result of the batch purchase operation. This typically includes details about the purchased batch such as status, transaction IDs, and any relevant metadata returned by the Shippo API.
If the operation involves binary data (e.g., shipping labels or documents), it would be included in the output accordingly, but based on the provided code and properties, the primary output is JSON structured data describing the purchased batch.
Dependencies
- Requires an active Shippo API key credential configured in n8n to authenticate requests.
- Depends on the Shippo REST API endpoint at
https://api.goshippo.com. - Optionally supports specifying the API version via a custom header.
Troubleshooting
- Invalid Batch Id: If the provided batch ID does not exist or is malformed, the API will return an error. Ensure the batch ID is correct and corresponds to an existing batch.
- Authentication Errors: Missing or invalid API credentials will cause authentication failures. Verify that the API key is correctly set up in n8n credentials.
- API Version Issues: Specifying an unsupported or incorrect API version in the optional header may lead to unexpected errors. Use the default version unless a specific version is required.
- Network or Connectivity Problems: Ensure that n8n can reach the Shippo API endpoint without firewall or proxy issues.