> ## Documentation Index
> Fetch the complete documentation index at: https://docs.fetchhive.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Shippo

> Shippo helps you create shipping labels, track packages, and manage shipping operations via your connected account.

Use Shippo when you need shipping data for orders, labels, or tracking. It works well after a checkout, order update, or fulfillment step.

## Configuration

| Option | Required | Description |
| - | - | - |
| Name | No | Label for the step in the workflow canvas. |
| Authentication | Yes | The connected Shippo account to use for this step. |
| Action | Yes | The Shippo action to perform (for example Create address, Get address, Validate address, Create parcel). |
| Arguments | Yes | Per-action form fields generated from the action's schema. Each text field has an **Insert Variable** button for injecting `{{placeholder}}` values. A **Raw JSON** tab is available for advanced usage. |
| When the step fails | No | Controls whether the workflow should **Terminate Workflow** or **Continue** if this step fails. |

Before you configure this step, connect Shippo in **Integrations** for your workspace using the sign-in flow. If no active connection is available, the step shows a warning with a link to **Integrations** instead of the account selector.

## Arguments form

When you select an action, the **Arguments** section renders a form driven by the action's input schema. Fields that refer to existing records include dropdown pickers.

Switch to the **Raw JSON** tab when you prefer to write the full arguments object by hand. Changes in either tab stay in sync.

## Common actions

| Action | Description |
| - | - |
| **Create address** | Create a new address in Shippo. |
| **Get address** | Retrieve a previously created address. |
| **Validate address** | Check whether an address is valid. |
| **Create parcel** | Create a parcel with dimensions and weight. |
| **Get parcel** | Retrieve a parcel by its ID. |
| **Create shipment** | Create a new shipment with origin, destination, and parcels. |
| **Get shipment** | Retrieve a shipment by its ID. |
| **List shipment rates** | List available shipping rates for a shipment. |
| **Create transaction** | Purchase a shipping label transaction. |
| **Get transaction** | Retrieve a shipping label transaction by its ID. |
| **Register tracking webhook** | Register a tracking webhook for a shipment. |
| **Get tracking status** | Retrieve tracking status for a shipment. |
| **Create order** | Create a new order in Shippo. |
| **Get order** | Retrieve an order from Shippo. |
| **List orders** | List all orders in the account. |

Destructive actions, such as deleting records, are not available in the workflow action picker.

## Output

This step stores the Shippo response as the step output. The shape of the response depends on the action.

Use the full output reference in later steps:

```text theme={null}
{{STEP_IDENTIFIER.output}}
```

## Example

1. Open **Integrations** and connect Shippo if you have not already done that.
2. Add a **Shippo** step to your workflow.
3. Select a connected account in **Authentication**.
4. Choose **Create address** in **Action**.
5. Fill in the required fields. Use **Insert Variable** to reference an earlier step's output for any field value.
6. Click **Run** in the step header to test the action, then review the returned payload in **Output**.

## Use cases

### Create a shipping label

1. Create address
2. Create parcel
3. Create shipment
4. List shipment rates

### Track an order shipment

1. Create track
2. Get tracking status
3. Get transaction

### Process a new order

1. Create order
2. Get order
3. Create shipment
4. Create transaction

## Notes

* This step depends on a connected Shippo integration in your workspace.
* The workflow action picker shows a curated set of actions. Agents with the Shippo tool can use more of them.
* The sign-in screen may show third-party authorization branding.

## Using Shippo as an Agent Tool

You can also add Shippo as a tool in the **Agent Editor**. Open the agent, click **Add tool**, and select **Shippo**. In the tool settings panel, choose the connected account the agent should use. The agent calls Shippo actions when they are relevant to the conversation.

See also: [Integrations](https://docs.fetchhive.com/workspace/integrations.md), [Creating and Editing](https://docs.fetchhive.com/workflows/creating-and-editing.md), and [Testing and Iteration](https://docs.fetchhive.com/workflows/testing-and-iteration.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.