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 operation retrieves a paginated list of shipment rates filtered by a specific currency code for a given shipment. It is useful when you want to obtain shipping cost options in a particular currency, enabling comparison or selection of the best rate for your shipment.
Common scenarios:
- Displaying available shipping rates in a user’s preferred currency.
- Automating selection of shipment rates based on currency constraints.
- Integrating with e-commerce platforms to show shipping costs dynamically.
Example:
You have a shipment with ID abc123 and want to list all available shipping rates priced in USD, showing 25 results per page starting from page 1.
Properties
| Name | Meaning |
|---|---|
| Shipment Id | The unique identifier (Object ID) of the shipment for which to list rates. |
| Currency Code | ISO currency code (e.g., USD, EUR) to filter the shipment rates by currency. |
| Page | The page number of the paginated results to retrieve (default is 1). |
| Results | Number of results to return per page, with a maximum of 100. |
| SHIPPO API VERSION | Optional header to specify a non-default Shippo API version to use for this request. |
Output
The node outputs JSON data containing the list of shipment rates matching the specified shipment ID and currency code. The structure typically includes:
- An array of rate objects, each representing a shipping option with details such as:
- Rate amount and currency
- Provider information
- Estimated delivery time
- Service level description
If binary data were involved (e.g., labels), it would be summarized here, but this operation focuses on JSON rate data only.
Dependencies
- Requires an active API key credential for authenticating requests to the Shippo API.
- The node sends HTTP requests to the Shippo API endpoint at
https://api.goshippo.com. - Optionally supports specifying the Shippo API version via a custom header.
Troubleshooting
- Invalid Shipment Id: If the shipment ID does not exist or is malformed, the API will return an error. Verify the shipment ID before making the request.
- Unsupported Currency Code: Using an invalid or unsupported ISO currency code may result in empty results or errors.
- Pagination Limits: Requesting a page number beyond available pages will return empty results.
- API Version Header Issues: Specifying an incorrect API version string might cause unexpected errors; ensure the version matches Shippo's supported versions.
- Authentication Errors: Missing or invalid API credentials will prevent successful API calls.