Shippo

Interact with Shippo API

Actions68

Parcels Actions
- Create Parcel
- Get Parcel
- List Parcels
Shipments Actions
- List Shipments
- Create Shipment
- Get Shipment
Rates Actions
- Get Rate
- List Shipment Rates
- List Shipment Rates By Currency Code
Transactions Actions
- List Transactions
- Create Transaction
- Get Transaction
Customs Items Actions
- List Customs Items
- Create Customs Item
- Get Customs Item
Tracking Status Actions
- Create Track
- Get Track
Batches Actions
- Create Batch
- Get Batch
- Add Shipments To Batch
- Purchase Batch
- Remove Shipments From Batch
Orders Actions
- List Orders
- Create Order
- Get Order
Pickups Actions
- Create Pickup
Service Groups Actions
- List Service Groups
- Create Service Group
- Update Service Group
- Delete Service Group
Customs Declarations Actions
- List Customs Declarations
- Create Customs Declaration
- Get Customs Declaration
Refunds Actions
- Create Refund
- List Refunds
- Get Refund
Manifests Actions
- List Manifests
- Create Manifest
- Get Manifest
Carrier Accounts Actions
- List Carrier Accounts
- Create Carrier Account
- Get Carrier Account
- Update Carrier Account
- Initiate Oauth 2 Signin
- Register Carrier Account
- Get Carrier Registration Status
Webhooks Actions
- Get Webhook
- Update Webhook
- Delete Webhook
Carrier Parcel Templates Actions
- List Carrier Parcel Templates
- Get Carrier Parcel Template
User Parcel Templates Actions
- List User Parcel Templates
- Create User Parcel Template
- Delete User Parcel Template
- Get User Parcel Template
- Update User Parcel Template
Rates At Checkout Actions
- Create Live Rate
- Get Default Parcel Template
- Update Default Parcel Template
- Delete Default Parcel Template
Shippo Accounts Actions
- List Shippo Accounts
- Create Shippo Account
- Get Shippo Account
- Update Shippo Account
Addresses Actions
- List Addresses
- Create Address
- Get Address
- Validate Address

Overview

This node operation allows you to add shipments to an existing batch in the Shippo system. It is useful for managing multiple shipments collectively, such as when preparing a group of parcels for dispatch or organizing shipments for bulk processing. For example, if you have several shipments ready to be sent out and want to consolidate them under one batch for easier tracking and label generation, this operation facilitates that by adding shipment details to a specified batch.

Properties

Name	Meaning
Batch Id	The unique identifier (Object ID) of the batch to which shipments will be added. This is required to specify the target batch.
SHIPPO API VERSION	Optional header string to specify a non-default version of the Shippo API to use for the request. Useful if you need to access features or behaviors specific to a particular API version.
Body	JSON object containing detailed shipment information to add to the batch. This includes nested fields such as addresses (from, to, return), customs declarations, carrier accounts, parcels with extra details like COD and insurance, and various shipment-specific metadata.

Output

The output of this operation is a JSON object representing the updated batch with the newly added shipments included. The structure reflects the batch's current state after modification, typically including shipment details, batch metadata, and status information.

If binary data is returned (not indicated here), it would generally represent files such as shipping labels or manifests, but this operation primarily deals with JSON shipment data.

Dependencies

Requires an active connection to the Shippo API.
An API key credential for authenticating requests to Shippo must be configured in n8n.
The base URL for API requests is https://api.goshippo.com.
Optionally, the user can specify a custom API version via the SHIPPO API VERSION property.

Troubleshooting

Invalid Batch Id: If the provided batch ID does not exist or is malformed, the API will likely return an error indicating the batch was not found. Verify the batch ID before making the request.
Malformed JSON Body: The body must be valid JSON matching the expected schema. Errors may occur if required shipment fields are missing or incorrectly formatted.
Authentication Errors: Ensure the API key credential is correctly set up and has sufficient permissions.
API Version Issues: Specifying an unsupported or deprecated API version might cause unexpected errors. Use the default or verify supported versions from Shippo documentation.
Network or Rate Limits: Network connectivity issues or exceeding Shippo API rate limits can cause failures; check network status and API usage quotas.