> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/shippo.md).

# Shippo

Create shipments, compare rates, buy labels, validate addresses, and track packages.

## Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector | Authentication |
| --------- | -------------- |
| Shippo    | API Token      |

### Shippo

Connect to Shippo to create shipments, buy labels, and track packages.

#### Set up in Shippo

1. Prepare the Shippo account or service that the workflow will access. Grant access to the required resources and operations.
2. **API Token:** Create a test token in Shippo under Settings > API, then paste it here.

#### Set up in StackAI

1. Open **Settings → Connections**, add a connection, and select **Shippo**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field | Required | What to enter                                                                                                                            |
| ------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| API Token     | Yes      | Create a test token in Shippo under Settings > API, then paste it here. [Provider instructions](https://apps.goshippo.com/settings/api). |

### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

## Use an action

1. Add the required **Shippo** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

## Actions

### Create Shipment

Create a domestic shipment and request carrier rates.

#### Inputs

| Field                       | Type            | Required | Description                                                                                                                        |
| --------------------------- | --------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| Sender Name                 | string          | Yes      | Name on the return address.                                                                                                        |
| Sender Street               | string          | Yes      | First line of the sender address.                                                                                                  |
| Sender City                 | string          | Yes      |                                                                                                                                    |
| Sender State or Province    | string          | No       | State or province when required by the country.                                                                                    |
| Sender Postal Code          | string          | Yes      |                                                                                                                                    |
| Sender Country              | string          | Yes      | Two-letter sender country code. Default: US.                                                                                       |
| Sender Phone                | string          | No       | Phone number for carrier delivery questions.                                                                                       |
| Sender Email                | string          | No       |                                                                                                                                    |
| Recipient Name              | string          | Yes      |                                                                                                                                    |
| Recipient Street            | string          | Yes      |                                                                                                                                    |
| Recipient City              | string          | Yes      |                                                                                                                                    |
| Recipient State or Province | string          | No       | Recipient state or province code, e.g. 'CA'. Required for US, CA, and AU addresses.                                                |
| Recipient Postal Code       | string          | Yes      |                                                                                                                                    |
| Recipient Country           | string          | Yes      | Two-letter recipient country code; must match the sender. Default: US.                                                             |
| Recipient Phone             | string          | No       | Phone number for carrier delivery questions.                                                                                       |
| Recipient Email             | string          | No       |                                                                                                                                    |
| Parcel Length               | number          | Yes      |                                                                                                                                    |
| Parcel Width                | number          | Yes      |                                                                                                                                    |
| Parcel Height               | number          | Yes      |                                                                                                                                    |
| Dimension Unit              | select (string) | Yes      | One of 'in', 'cm', 'mm', 'm', 'ft', or 'yd'. Available values: Inches, Centimeters, Millimeters, Meters, Feet, Yards. Default: in. |
| Parcel Weight               | number          | Yes      |                                                                                                                                    |
| Weight Unit                 | select (string) | Yes      | One of 'lb', 'oz', 'kg', or 'g'. Available values: Pounds, Ounces, Kilograms, Grams. Default: lb.                                  |
| Residential Address         | boolean         | No       | Whether the destination is a home address. Default: false.                                                                         |

#### Outputs

| Field       | Type          | Description |
| ----------- | ------------- | ----------- |
| Shipment ID | string        |             |
| Status      | string        |             |
| Rates       | object\_array |             |
| Messages    | object\_array |             |
| Test Mode   | boolean       |             |

### Buy Shipping Label

Buy a shipping label from a selected rate, with confirmation for live postage.

#### Inputs

| Field                 | Type            | Required | Description                                                                                           |
| --------------------- | --------------- | -------- | ----------------------------------------------------------------------------------------------------- |
| Shipping Rate         | string          | Yes      | Carrier rate to purchase.                                                                             |
| Label Format          | select (string) | No       | File format and size for the label. Available values: PDF, PDF 4 x 6, PNG, ZPL II. Default: PDF\_4x6. |
| Metadata              | string          | No       | Internal reference stored with the label.                                                             |
| Confirm Live Purchase | boolean         | No       | Confirm a billable label purchase when using a live token. Default: false.                            |

#### Outputs

| Field           | Type          | Description |
| --------------- | ------------- | ----------- |
| Transaction ID  | string        |             |
| Status          | string        |             |
| Label URL       | string        |             |
| Tracking Number | string        |             |
| Tracking URL    | string        |             |
| Messages        | object\_array |             |
| Test Mode       | boolean       |             |

### Track Shipment

Get the latest carrier tracking status and history.

#### Inputs

| Field           | Type   | Required | Description                           |
| --------------- | ------ | -------- | ------------------------------------- |
| Carrier         | string | Yes      | Shippo carrier token for the package. |
| Tracking Number | string | Yes      | Complete carrier tracking number.     |

#### Outputs

| Field             | Type          | Description |
| ----------------- | ------------- | ----------- |
| Carrier           | string        |             |
| Tracking Number   | string        |             |
| Status            | string        |             |
| Status Details    | string        |             |
| Status Date       | string        |             |
| Estimated Arrival | string        |             |
| Tracking History  | object\_array |             |

### Validate Address

Validate a US or international delivery address.

#### Inputs

| Field                     | Type   | Required | Description                                              |
| ------------------------- | ------ | -------- | -------------------------------------------------------- |
| Street Address            | string | Yes      |                                                          |
| Apartment, Suite, or Unit | string | No       |                                                          |
| City                      | string | No       |                                                          |
| State or Province         | string | No       |                                                          |
| Postal Code               | string | No       |                                                          |
| Country                   | string | Yes      | ISO 3166-1 alpha-2 country code, e.g. 'US'. Default: US. |
| Recipient Name            | string | No       |                                                          |
| Organization              | string | No       |                                                          |

#### Outputs

| Field               | Type          | Description |
| ------------------- | ------------- | ----------- |
| Valid               | boolean       |             |
| Validation Result   | string        |             |
| Reasons             | string\_array |             |
| Suggested Changes   | string\_array |             |
| Recommended Address | object        |             |

### Get Shipping Rates

Get carrier rates for a shipment.

#### Inputs

| Field         | Type    | Required | Description                                                     |
| ------------- | ------- | -------- | --------------------------------------------------------------- |
| Shipment ID   | string  | Yes      | Shipment whose carrier rates should be returned.                |
| Currency      | string  | No       | Three-letter ISO 4217 currency code, e.g. 'USD'. Default: USD.  |
| Limit         | integer | No       | Maximum rates to return. Minimum: 1. Maximum: 500. Default: 25. |
| Starting Page | integer | No       | Page from which to resume. Minimum: 1. Default: 1.              |

#### Outputs

| Field          | Type          | Description                                         |
| -------------- | ------------- | --------------------------------------------------- |
| Shipping Rates | object\_array | Available carrier services and prices.              |
| Next Page      | integer       | Page to use for the next call, or empty at the end. |

## Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/shippo.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
