> ## 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.

# Shipments API

> Een Shipment koppelt een trackingnummer van een vervoerder aan een betaling en volgt het pakket van het aanmaken van het label tot de levering, met de huidige leveringsstatus en een tracking-URL voor de klant.

Gebruik de Shipments API om de zendingen van een account weer te geven, er een op te halen via het ID of de betaling die ermee wordt afgehandeld, een trackingnummer aan een betaling te koppelen en het trackingnummer van een bestaande zending bij te werken.

## Endpoints

| Endpoint | Verzoek |
| - | - |
| [Shipments weergeven](https://docs.whop.com/nl/api-reference/shipments/list-shipments.md) | GET `/shipments` |
| [Shipment ophalen](https://docs.whop.com/nl/api-reference/shipments/retrieve-shipment.md) | GET `/shipments/{id}` |
| [Shipment aanmaken](https://docs.whop.com/nl/api-reference/shipments/create-shipment.md) | POST `/shipments` |
| [Shipment opzoeken](https://docs.whop.com/nl/api-reference/shipments/look-up-shipment.md) | POST `/shipments/lookup` |
| [Shipment bijwerken](https://docs.whop.com/nl/api-reference/shipments/update-shipment.md) | PATCH `/shipments/{id}` |

## Attributen

**id** `string` *required*

Shipment-ID, met prefix `ship_`.

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

Het account dat eigenaar is van deze zending, met prefix `biz_`.

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

De vervoerder die voor deze zending is gedetecteerd. Null totdat een
trackingupdate de vervoerder identificeert.

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

Scangeschiedenis van de vervoerder voor deze zending, oudste scan eerst. Leeg totdat de vervoerder de eerste scan meldt.

> [accordion] Eigenschappen
>
> **location** `string | null` *required*
>
> Waar de vervoerder de scan heeft geregistreerd, zoals `PHILADELPHIA, PA`. Null
> als de vervoerder niets heeft doorgegeven.
>
> **message** `string | null` *required*
>
> Beschrijving van de scan door de vervoerder, zoals `Departed USPS Regional
>           	Facility`. Null als de vervoerder niets heeft doorgegeven.
>
> **status** `string` *required*
>
> Leveringsstatus waaraan deze scan van de vervoerder is gekoppeld.
>
> Beschikbare opties: `unknown`, `pre_transit`, `in_transit`, `out_for_delivery`, `delivered`, `available_for_pickup`, `return_to_sender`, `failure`, `cancelled`, `error`
>
> **timestamp** `string | null` *required*
>
> Wanneer de vervoerder de scan heeft geregistreerd, als ISO 8601-tijdstempel. Null als de vervoerder geen scantijd heeft doorgegeven.

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

De datum en tijd waarop de zending is aangemaakt (ISO 8601).

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

De betaling die met deze zending wordt afgehandeld, met prefix `pay_`.

**status** `string` *required*

De huidige leveringsstatus van deze zending.

Beschikbare opties: `unknown`, `pre_transit`, `in_transit`, `out_for_delivery`, `delivered`, `available_for_pickup`, `return_to_sender`, `failure`, `cancelled`, `error`

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

Het door de vervoerder toegewezen trackingnummer waarmee de voortgang van de
zending wordt opgezocht.

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

Een URL voor de klant om de voortgang van deze zending te volgen.

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

De datum en tijd waarop de zending voor het laatst is bijgewerkt (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/nl/api-reference/legacy/shipments/create-shipment.md)
- [List shipments](https://docs.whop.com/nl/api-reference/legacy/shipments/list-shipments.md)
- [Retrieve shipment](https://docs.whop.com/nl/api-reference/legacy/shipments/retrieve-shipment.md)
