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

> Shipment는 결제에 운송사 추적 번호를 연결하고, 라벨 생성부터 배송 완료까지 패키지를 추적하며, 현재 배송 상태와 고객용 추적 URL을 제공합니다.

Shipments API를 사용하면 계정의 배송 목록을 조회하고, ID 또는 배송이 이행하는 결제로 배송을 조회하고, 결제에 추적 번호를 연결하고, 기존 배송의 추적 번호를 업데이트할 수 있습니다.

## 엔드포인트

| 엔드포인트 | 요청 |
| - | - |
| [배송 목록 조회](https://docs.whop.com/ko/api-reference/shipments/list-shipments.md) | GET `/shipments` |
| [배송 조회](https://docs.whop.com/ko/api-reference/shipments/retrieve-shipment.md) | GET `/shipments/{id}` |
| [배송 생성](https://docs.whop.com/ko/api-reference/shipments/create-shipment.md) | POST `/shipments` |
| [배송 찾기](https://docs.whop.com/ko/api-reference/shipments/look-up-shipment.md) | POST `/shipments/lookup` |
| [배송 업데이트](https://docs.whop.com/ko/api-reference/shipments/update-shipment.md) | PATCH `/shipments/{id}` |

## 속성

**id** `string` *required*

`ship_` 접두사가 붙은 배송 ID입니다.

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

이 배송을 소유한 계정으로, `biz_` 접두사가 붙습니다.

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

이 배송에 대해 감지된 운송사입니다. 추적 업데이트로 운송사가 식별되기 전까지는
null입니다.

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

이 배송의 운송사 스캔 기록으로, 가장 오래된 스캔이 먼저 나옵니다. 운송사가 첫 스캔을 보고하기 전까지는 비어 있습니다.

> [accordion] 속성
>
> **location** `string | null` *required*
>
> 운송사가 스캔을 기록한 위치로, 예를 들어 `PHILADELPHIA, PA`입니다. 운송사가
> 위치를 보내지 않으면 null입니다.
>
> **message** `string | null` *required*
>
> 운송사의 스캔 설명으로, 예를 들어 `Departed USPS Regional Facility`입니다.
> 운송사가 설명을 보내지 않으면 null입니다.
>
> **status** `string` *required*
>
> 이 운송사 스캔이 대응되는 배송 상태입니다.
>
> 사용 가능한 옵션: `unknown`, `pre_transit`, `in_transit`, `out_for_delivery`, `delivered`, `available_for_pickup`, `return_to_sender`, `failure`, `cancelled`, `error`
>
> **timestamp** `string | null` *required*
>
> 운송사가 스캔을 기록한 시각으로, ISO 8601 타임스탬프입니다. 운송사가 스캔 시각을 보내지 않으면 null입니다.

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

배송이 생성된 일시입니다(ISO 8601).

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

이 배송이 이행하는 결제로, `pay_` 접두사가 붙습니다.

**status** `string` *required*

이 배송의 현재 배송 상태입니다.

사용 가능한 옵션: `unknown`, `pre_transit`, `in_transit`, `out_for_delivery`, `delivered`, `available_for_pickup`, `return_to_sender`, `failure`, `cancelled`, `error`

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

배송 진행 상황을 조회하는 데 사용되는 운송사 지정 추적 번호입니다.

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

이 배송의 진행 상황을 추적할 수 있는 고객용 URL입니다.

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

배송이 마지막으로 업데이트된 일시입니다(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"
}
```
