> ## 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 de Shipments

> Un Shipment asocia un número de seguimiento del transportista a un pago y sigue el paquete desde la creación de la etiqueta hasta la entrega, mostrando el estado de entrega actual y una URL de seguimiento para el cliente.

Usa la API de Shipments para listar los envíos de una cuenta, obtener uno por su ID o por el pago que cumple, asociar un número de seguimiento a un pago y actualizar el número de seguimiento de un envío existente.

## Endpoints

| Endpoint | Solicitud |
| - | - |
| [Listar Shipments](https://docs.whop.com/es/api-reference/shipments/list-shipments.md) | GET `/shipments` |
| [Obtener Shipment](https://docs.whop.com/es/api-reference/shipments/retrieve-shipment.md) | GET `/shipments/{id}` |
| [Crear Shipment](https://docs.whop.com/es/api-reference/shipments/create-shipment.md) | POST `/shipments` |
| [Buscar Shipment](https://docs.whop.com/es/api-reference/shipments/look-up-shipment.md) | POST `/shipments/lookup` |
| [Actualizar Shipment](https://docs.whop.com/es/api-reference/shipments/update-shipment.md) | PATCH `/shipments/{id}` |

## Atributos

**id** `string` *required*

ID del envío, con el prefijo `ship_`.

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

La cuenta propietaria de este envío, con el prefijo `biz_`.

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

El transportista detectado para este envío. Es null hasta que una actualización de seguimiento
lo identifica.

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

Historial de escaneos del transportista para este envío, del escaneo más antiguo al más reciente. Vacío hasta que el transportista informa su primer escaneo.

> [accordion] Propiedades
>
> **location** `string | null` *required*
>
> Dónde registró el transportista el escaneo, como `PHILADELPHIA, PA`. Es null cuando el
> transportista no envió ninguno.
>
> **message** `string | null` *required*
>
> Descripción del escaneo por parte del transportista, como `Departed USPS Regional Facility`.
> Es null cuando el transportista no envió ninguna.
>
> **status** `string` *required*
>
> Estado de entrega al que corresponde este escaneo del transportista.
>
> Opciones disponibles: `unknown`, `pre_transit`, `in_transit`, `out_for_delivery`, `delivered`, `available_for_pickup`, `return_to_sender`, `failure`, `cancelled`, `error`
>
> **timestamp** `string | null` *required*
>
> Cuándo registró el transportista el escaneo, como marca de tiempo ISO 8601. Es null cuando el transportista no envió la hora del escaneo.

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

La fecha y hora en que se creó el envío (ISO 8601).

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

El pago que cumple este envío, con el prefijo `pay_`.

**status** `string` *required*

El estado de entrega actual de este envío.

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

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

El número de seguimiento asignado por el transportista que se usa para consultar el progreso del envío.

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

Una URL para el cliente con la que seguir el progreso de este envío.

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

La fecha y hora en que se actualizó el envío por última vez (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"
}
```
