---
title: "List Shipments"
method: GET
path: "/shipments"
tags: ["Shipments"]
---

# List Shipments

`GET /shipments`

Returns a paginated list of shipments for an account.

## Query parameters

- `account_id` string
- `status` 'unknown' | 'pre_transit' | 'in_transit' | 'out_for_delivery' | 'delivered' | 'available_for_pickup' | 'return_to_sender' | 'failure' | 'cancelled' | 'error'
- `payment_id` string[]
- `created_before` string
- `created_after` string
- `order` 'created_at'
- `direction` 'asc' | 'desc'
- `first` integer
- `after` string
- `last` integer
- `before` string

## Response `200`

excludes the created_after boundary row

- object
  - `data` Shipment[], required
    - `account_id` string, required — The account that owns this shipment, prefixed `biz_`.
    - `carrier` string, nullable, required — The shipping carrier detected for this shipment. Null until a tracking update identifies it.
    - `checkpoints` ShipmentCheckpoint[], required
      - `location` string, nullable, required — Where the carrier recorded the scan, such as `PHILADELPHIA, PA`. Null when the carrier sent none.
      - `message` string, nullable, required — Carrier's description of the scan, such as `Departed USPS Regional Facility`. Null when the carrier sent none.
      - `status` 'unknown' | 'pre_transit' | 'in_transit' | 'out_for_delivery' | 'delivered' | 'available_for_pickup' | 'return_to_sender' | 'failure' | 'cancelled' | 'error', required — Delivery status this carrier scan maps to.
      - `timestamp` string, nullable, required — When the carrier recorded the scan, as an ISO 8601 timestamp. Null when the carrier sent no scan time.
    - `created_at` string, required — The datetime the shipment was created (ISO 8601).
    - `id` string, required — Shipment ID, prefixed `ship_`.
    - `payment_id` string, required — The payment this shipment fulfills, prefixed `pay_`.
    - `status` 'unknown' | 'pre_transit' | 'in_transit' | 'out_for_delivery' | 'delivered' | 'available_for_pickup' | 'return_to_sender' | 'failure' | 'cancelled' | 'error', required — The current delivery status of this shipment.
    - `tracking_number` string, required — The carrier-assigned tracking number used to look up shipment progress.
    - `tracking_url` string, required — A customer-facing URL to track this shipment's progress.
    - `updated_at` string, required — The datetime the shipment was last updated (ISO 8601).
  - `page_info` object, required
    - `end_cursor` string, nullable, required
    - `has_next_page` boolean, required
    - `has_previous_page` boolean, required
    - `start_cursor` string, nullable, required

## Other responses

- `400` — Invalid Parameters
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Resource not found

---

[API](https://skmtc.net/whop/apis/whop-api.md) · [All operations](https://skmtc.net/whop/apis/whop-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/whop/whop-api/versions/db0883548bc5/schema)