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

> ## Agent Instructions
> Treat these docs and the Whop MCP server as the source of truth for Whop API behavior. Don't infer endpoint behavior from marketing pages.
> MCP server: connect https://mcp.whop.com/mcp (streamable HTTP, browser sign-in, no API key in the client config) to search these docs and read or change live Whop data. Setup: https://docs.whop.com/developer/guides/ai_and_mcp.md
> Whop CLI: install with `curl -fsSL https://whop.com/install.sh | sh` to scaffold, run, and deploy Whop apps and websites. It acts on production, not the sandbox. Overview: https://docs.whop.com/cli/overview.md Agent mode: https://docs.whop.com/cli/agent-mode.md
> Hosting: Whop serves a site or app from the build `whop apps deploy` uploads, with rollbacks, secrets, and server logs. Guide: https://docs.whop.com/developer/websites/hosting.md
> Plugins: in Claude Code, run `/plugin marketplace add whopio/plugins`, then `/plugin install whop@whop`. Guide: https://docs.whop.com/developer/guides/plugins/claude-code.md Every agent tool: https://docs.whop.com/developer/ai/overview.md
> Environments: build and test in the sandbox (API `https://sandbox-api.whop.com/api/v1`, keys at https://sandbox.whop.com/dashboard/developer, SDK environment `Sandbox`; no real money). Production (API `https://api.whop.com/api/v1`, keys at https://whop.com/dashboard/developer, SDK environment `Production`, the SDK default) moves real money, so use it only at launch. The two share no accounts, keys, products, or webhooks, and their keys look identical: never mix them. Sandbox guide: https://docs.whop.com/developer/guides/sandbox.md Comparison: https://docs.whop.com/developer/quickstart.md
> API: send `Authorization: Bearer <API_KEY>` from your server only, and pin a dated version with the `Api-Version-Date` header. OpenAPI spec: https://api.whop.com/api/v1/openapi.json
> Which API: build on the Current API, whose pages live under https://docs.whop.com/api-reference/ (start at https://docs.whop.com/api-reference/overview.md). Pages under /api-reference/legacy/ are the Legacy API. Use one only when https://docs.whop.com/api-reference/stability.md lists the resource as Legacy-only.

# API Shipments

> Un Shipment associe un numéro de suivi de transporteur à un paiement et suit le colis de la création de l'étiquette jusqu'à la livraison, en exposant le statut de livraison actuel et une URL de suivi destinée au client.

Utilisez l'API Shipments pour lister les expéditions d'un compte, en récupérer une par son ID ou par le paiement qu'elle honore, associer un numéro de suivi à un paiement et mettre à jour le numéro de suivi d'une expédition existante.

## Endpoints

| Endpoint | Requête |
| - | - |
| [Lister les expéditions](https://docs.whop.com/fr/api-reference/shipments/list-shipments.md) | GET `/shipments` |
| [Récupérer une expédition](https://docs.whop.com/fr/api-reference/shipments/retrieve-shipment.md) | GET `/shipments/{id}` |
| [Créer une expédition](https://docs.whop.com/fr/api-reference/shipments/create-shipment.md) | POST `/shipments` |
| [Rechercher une expédition](https://docs.whop.com/fr/api-reference/shipments/look-up-shipment.md) | POST `/shipments/lookup` |
| [Mettre à jour une expédition](https://docs.whop.com/fr/api-reference/shipments/update-shipment.md) | PATCH `/shipments/{id}` |

## Attributs

**id** `string` *required*

ID de l'expédition, préfixé par `ship_`.

**account\_id** `string` *required*

Le compte propriétaire de cette expédition, préfixé par `biz_`.

**carrier** `string | null` *required*

Le transporteur détecté pour cette expédition. Null jusqu'à ce qu'une mise à
jour de suivi l'identifie.

**checkpoints** `object[]` *required*

Historique des scans du transporteur pour cette expédition, du plus ancien au plus récent. Vide jusqu'à ce que le transporteur signale son premier scan.

> [accordion] Propriétés
>
> **location** `string | null` *required*
>
> Lieu où le transporteur a enregistré le scan, par exemple `PHILADELPHIA, PA`.
> Null si le transporteur n'en a envoyé aucun.
>
> **message** `string | null` *required*
>
> Description du scan par le transporteur, par exemple `Departed USPS Regional Facility`.
> Null si le transporteur n'en a envoyé aucune.
>
> **status** `string` *required*
>
> Statut de livraison correspondant à ce scan du transporteur.
>
> Options disponibles : `unknown`, `pre_transit`, `in_transit`, `out_for_delivery`, `delivered`, `available_for_pickup`, `return_to_sender`, `failure`, `cancelled`, `error`
>
> **timestamp** `string | null` *required*
>
> Date à laquelle le transporteur a enregistré le scan, sous forme d'horodatage ISO 8601. Null si le transporteur n'a envoyé aucune heure de scan.

**created\_at** `string` *required*

Date et heure de création de l'expédition (ISO 8601).

**payment\_id** `string` *required*

Le paiement honoré par cette expédition, préfixé par `pay_`.

**status** `string` *required*

Le statut de livraison actuel de cette expédition.

Options disponibles : `unknown`, `pre_transit`, `in_transit`, `out_for_delivery`, `delivered`, `available_for_pickup`, `return_to_sender`, `failure`, `cancelled`, `error`

**tracking\_number** `string` *required*

Le numéro de suivi attribué par le transporteur, utilisé pour consulter la progression de l'expédition.

**tracking\_url** `string` *required*

Une URL destinée au client pour suivre la progression de cette expédition.

**updated\_at** `string` *required*

Date et heure de la dernière mise à jour de l'expédition (ISO 8601).

```json Shipment theme={null}
{
	"id": "ship_xxxxxxxxxxxxxx",
	"account_id": "biz_xxxxxxxxxxxxxx",
	"payment_id": "pay_xxxxxxxxxxxxxx",
	"carrier": "ups",
	"tracking_number": "1Z999AA10123456784",
	"tracking_url": "https://track.aftership.com/xxxxxxxxxxxxxxxxxx",
	"status": "in_transit",
	"checkpoints": [
		{
			"status": "in_transit",
			"message": "Picked up",
			"location": "PHILADELPHIA, PA",
			"timestamp": "2026-09-15T16:42:00.000Z"
		}
	],
	"created_at": "2026-09-15T14:30:00.000Z",
	"updated_at": "2026-09-15T16:45:10.000Z"
}
```


## Related topics

- [Create shipment](https://docs.whop.com/fr/api-reference/legacy/shipments/create-shipment.md)
- [List shipments](https://docs.whop.com/fr/api-reference/legacy/shipments/list-shipments.md)
- [Retrieve shipment](https://docs.whop.com/fr/api-reference/legacy/shipments/retrieve-shipment.md)
