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 allows you to create a shipping transaction using the Shippo API. A transaction in Shippo represents the purchase of a shipping label for a specific rate, enabling you to generate and print shipping labels for packages.
Common scenarios where this node is beneficial include:
- Automating label creation in e-commerce workflows after an order is placed.
- Integrating with multiple carriers via Shippo to streamline shipping processes.
- Generating shipping labels dynamically based on selected shipping rates.
For example, after calculating shipping rates for an order, you can use this node to purchase the label for the chosen rate and retrieve the label file for printing or emailing.
Properties
| Name | Meaning |
|---|---|
| SHIPPO API VERSION | Optional string to specify a non-default Shippo API version to use for the request. Useful if you want to target a specific API version different from the default. |
| Async | Boolean flag indicating whether the transaction should be processed asynchronously (true) or synchronously (false). |
| Label File Type | Format of the shipping label to be generated. Options include: PNG, PNG 2.3x7.5, PDF, PDF 2.3x7.5, PDF 4x6, PDF 4x8, PDF A4, PDF A5, PDF A6, ZPLII. If left empty, the default format set in the Shippo dashboard is used. |
| Metadata | Optional string for attaching metadata to the transaction. Can be used to store additional information relevant to your workflow. |
| Rate | Required. The ID of the shipping rate to purchase. This identifies which carrier and service level to use for the shipment. |
| Order | Optional string representing an order identifier associated with the transaction. |
Output
The node outputs JSON data representing the created transaction object returned by the Shippo API. This includes details such as:
- Transaction status (e.g., success, error)
- Shipping label URL(s) in the requested format
- Tracking number and carrier information
- Any messages or errors related to the transaction
If the label file is available, it will be accessible via URLs included in the output JSON. The node does not output binary data directly but provides links to download or display the label files.
Dependencies
- Requires an active Shippo account and an API key credential configured in n8n.
- The node communicates with the Shippo REST API at
https://api.goshippo.com. - No additional external dependencies beyond the Shippo API and proper authentication.
Troubleshooting
- Missing or invalid Rate ID: The "Rate" property is required. Ensure you provide a valid shipping rate ID obtained from a previous rate query.
- API version issues: Specifying an unsupported or incorrect API version in "SHIPPO API VERSION" may cause errors. Use only supported versions as per Shippo documentation.
- Label format unsupported: Selecting an unsupported label file type might result in errors or defaulting to the dashboard setting.
- Async flag confusion: Setting "Async" to false means the node waits for the transaction to complete synchronously, which might increase execution time.
- Authentication errors: Ensure the API key credential is correctly set up and has permissions to create transactions.
- Network or API errors: Check network connectivity and Shippo service status if requests fail unexpectedly.