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

# Sendcloud

> Create shipping labels, list shipments, compare carrier shipping options, and track parcels via the Sendcloud multi-carrier shipping API

## At a glance

* **Availability**: Experimental ([how to enable](/cloud/integrations)).
* **Auth**: Basic auth.
* **Connection**: HTTP Basic auth with `SENDCLOUD_PUBLIC_KEY` as the username and `SENDCLOUD_SECRET_KEY` as the password.
* **Docs**: [https://sendcloud.dev/docs/getting-started/authentication](https://sendcloud.dev/docs/getting-started/authentication)

## Credentials

Set these per environment. See [Connect an integration](/cloud/integrations).

| Variable               | Required | Description                                                                                                                               |
| ---------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| `SENDCLOUD_PUBLIC_KEY` | Yes      | Sendcloud API public key, used as the HTTP Basic username [Docs](https://sendcloud.dev/docs/getting-started/how-to-create-your-api-keys). |
| `SENDCLOUD_SECRET_KEY` | Yes      | Sendcloud API secret key, used as the HTTP Basic password [Docs](https://sendcloud.dev/docs/getting-started/how-to-create-your-api-keys). |

## Setup

1. **Create a Sendcloud account**: Sign up at [https://app.sendcloud.com](https://app.sendcloud.com) - a free plan is available and is enough to test the API against your own account.
2. **Create API keys**: In the Sendcloud panel open Settings → Integrations ([https://app.sendcloud.com/v2/settings/integrations/manage](https://app.sendcloud.com/v2/settings/integrations/manage)), find 'Sendcloud API' in the list, click Connect, and give the integration a name. You receive a public key and a secret key.
3. **Store the keys**: Add SENDCLOUD\_PUBLIC\_KEY and SENDCLOUD\_SECRET\_KEY to your .env file. The API uses HTTP Basic auth with the public key as username and the secret key as password.
4. **Verify access**: Run the List Shipments tool. An empty data array is a valid response for a new account.

* Always use API v3 ([https://panel.sendcloud.sc/api/v3/](https://panel.sendcloud.sc/api/v3/)...) for new integrations - Sendcloud is migrating integrations from v2 to v3
* Creating a shipment announces it to the carrier and may incur label costs; configure a sender address in the panel first
* List Shipping Options is a POST request but is read-only - it only calculates available options and quotes

Provider API reference: [https://sendcloud.dev](https://sendcloud.dev)

## Tools

| Tool                  | Access | Description                                                                                                                                                                                    |
| --------------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| List Shipments        | Read   | List shipments (parcels) in the Sendcloud account with optional filters such as order number, tracking number, or update time                                                                  |
| Get Shipment          | Read   | Get a single shipment with its parcels, addresses, tracking numbers, and label documents                                                                                                       |
| Create Shipment       | Write  | Create and announce a shipment synchronously, generating a shipping label for one or more parcels                                                                                              |
| List Shipping Options | Read   | List available carrier shipping options (methods) for a given route and parcel, optionally with price quotes                                                                                   |
| Get Tracking          | Read   | Get the current status and recent tracking events of a parcel by its carrier tracking number                                                                                                   |
| Cancel Shipment       | Write  | Cancel an announced shipment and its label before carrier collection - the undo for a mis-announced (cost-incurring) label; cancellation is no longer possible once the carrier has the parcel |

## Example prompts

* Track a Sendcloud parcel by its tracking number and summarize its current status and latest events.
* List my most recent Sendcloud shipments and flag any that look stuck or undelivered.
* Given an origin, destination, and parcel size, list the available Sendcloud shipping options with quotes and recommend the cheapest suitable one.