Appearance
Shippo
Create shipments, compare carrier rates, and generate shipping labels with the Shippo API.
| Detail | Value |
|---|---|
| Category | Logistics |
| Base URL | https://api.goshippo.com |
| Authentication | API Key |
| Endpoints | 4 |
| Connector key | shippo |
Using Shippo in a workflow
- Go to Connections and click New Connection.
- Pick Shippo from the marketplace.
- Enter your credentials (see Authentication above for what's expected).
- In a workflow, drop an API Call node and select this connection.
- Pick the operation you need from the Operation dropdown — the full list is below.
Available endpoints
| Endpoint | Summary |
|---|---|
POST /shipments | Create a shipment |
GET /shipments/{id} | Get shipment details |
POST /transactions | Create a shipping label |
GET /rates | List shipping rates |
Each endpoint is documented in full below. Use the outline on the right to jump to one.
POST /shipments
Create a shipment
| Detail | Value |
|---|---|
| Operation ID | logistics.createShipment |
| Method | POST |
| Path | /shipments |
Parameters
No parameters.
Request Body
| Field | Type |
|---|---|
address_from | object |
address_to | object |
parcels | array |
Using this endpoint in a workflow
- Add an API Call node to your workflow.
- Pick your Shippo connection from the Connection dropdown.
- In the Operation dropdown, select
logistics.createShipment. - Fill in the parameter fields that appear. Use
{{...}}to reference upstream values.
Required fields are marked — fill them or the call will fail at runtime.
What it returns
The API Call node writes the response to the workflow context:
{
status: 200,
success: true,
data: { ...response body from the API... },
latencyMs: 142
}Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Shippo API reference.
GET /shipments/{id}
Get shipment details
| Detail | Value |
|---|---|
| Operation ID | logistics.getShipment |
| Method | GET |
| Path | /shipments/{id} |
Parameters
| Name | Location | Type | Required |
|---|---|---|---|
id | path | string | Yes |
Using this endpoint in a workflow
- Add an API Call node to your workflow.
- Pick your Shippo connection from the Connection dropdown.
- In the Operation dropdown, select
logistics.getShipment. - Fill in the parameter fields that appear. Use
{{...}}to reference upstream values.
Required fields are marked — fill them or the call will fail at runtime.
What it returns
The API Call node writes the response to the workflow context:
{
status: 200,
success: true,
data: { ...response body from the API... },
latencyMs: 142
}Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Shippo API reference.
POST /transactions
Create a shipping label
| Detail | Value |
|---|---|
| Operation ID | logistics.createLabel |
| Method | POST |
| Path | /transactions |
Parameters
No parameters.
Request Body
| Field | Type |
|---|---|
rate | string |
label_file_type | string |
Using this endpoint in a workflow
- Add an API Call node to your workflow.
- Pick your Shippo connection from the Connection dropdown.
- In the Operation dropdown, select
logistics.createLabel. - Fill in the parameter fields that appear. Use
{{...}}to reference upstream values.
Required fields are marked — fill them or the call will fail at runtime.
What it returns
The API Call node writes the response to the workflow context:
{
status: 200,
success: true,
data: { ...response body from the API... },
latencyMs: 142
}Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Shippo API reference.
GET /rates
List shipping rates
| Detail | Value |
|---|---|
| Operation ID | logistics.listRates |
| Method | GET |
| Path | /rates |
Parameters
| Name | Location | Type | Required |
|---|---|---|---|
shipment | query | string | No |
Using this endpoint in a workflow
- Add an API Call node to your workflow.
- Pick your Shippo connection from the Connection dropdown.
- In the Operation dropdown, select
logistics.listRates. - Fill in the parameter fields that appear. Use
{{...}}to reference upstream values.
What it returns
The API Call node writes the response to the workflow context:
{
status: 200,
success: true,
data: { ...response body from the API... },
latencyMs: 142
}Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Shippo API reference.