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

# List shipments

`GET /v1/shipments`

## Request

- Base URL: `https://api.noerrands.com/c/ship`
- URL: `https://api.noerrands.com/c/ship/v1/shipments`
- Auth: HTTP bearer

List this account's labels newest first, with a cursor for paging; free and read-only.

## Query parameters

- `limit` integer
- `cursor` string: Opaque cursor from a previous next_cursor.

## Response `200`

Success.

- object
  - `items` object[], required
    - `shipment_id` string, required: Opaque id, "sh_...". Use it with get_shipment.
    - `kind` 'outbound' | 'return', required
    - `status` 'unknown' | 'pre_transit' | 'in_transit' | 'out_for_delivery' | 'delivered' | 'available_for_pickup' | 'return_to_sender' | 'failure' | 'cancelled' | 'error', required: The carrier's tracking status. pre_transit means the label exists and nothing has been scanned yet.
    - `carrier` string, required
    - `service` string, required
    - `tracking_code` string, required
    - `label_url` string, uri: The printable PDF label. Gone after the retention window.
    - `qr_code_url` string, uri: USPS QR code image. The human shows it at a post office counter and the clerk prints the label.
    - `tracking_url` string, uri: The carrier's public tracking page.
    - `est_delivery_date` string
    - `credits_charged_cents` integer, required: Net credits this label cost: zero once a refund has been confirmed.
    - `refund_status` 'none' | 'submitted' | 'refunded' | 'rejected', required: none, or after void_label: submitted (waiting on the carrier), refunded (credits are back), rejected (the label was used or too old).
    - `from` object, required: A US postal address as stored. After the 30-day retention window only city, state and the first 3 ZIP digits remain; name, company and street lines are permanently removed.
      - `name` string: Recipient or sender name, 1-40 characters.
      - `company` string: Optional company line, up to 40 characters.
      - `line1` string: Street address, up to 64 characters.
      - `line2` string: Apartment, suite, or unit, up to 64 characters.
      - `city` string, required
      - `state` string, required: Two-letter US state code.
      - `zip` string: ZIP code, 5 digits or ZIP+4 -- or just the first 3 digits once redacted.
      - `country` 'US': US only in v0.
    - `to` object, required: A US postal address as stored. After the 30-day retention window only city, state and the first 3 ZIP digits remain; name, company and street lines are permanently removed.
      - `name` string: Recipient or sender name, 1-40 characters.
      - `company` string: Optional company line, up to 40 characters.
      - `line1` string: Street address, up to 64 characters.
      - `line2` string: Apartment, suite, or unit, up to 64 characters.
      - `city` string, required
      - `state` string, required: Two-letter US state code.
      - `zip` string: ZIP code, 5 digits or ZIP+4 -- or just the first 3 digits once redacted.
      - `country` 'US': US only in v0.
    - `created_at` string, date-time, required
  - `next_cursor` string

## Other responses

- `400`: invalid_request
- `401`: unauthorized. Carries WWW-Authenticate: Bearer resource_metadata="..."
- `403`: forbidden_scope: a write tool called with a read-only key.
- `404`: not_found
- `429`: rate_limited
- `502`: provider_error

---

[API](https://skmtc.dev/noerrands/apis/no-errands-ship-api.md) · [All operations](https://skmtc.dev/noerrands/apis/no-errands-ship-api/llms.txt) · [OpenAPI document](https://skmtc.dev/noerrands/apis/no-errands-ship-api/revisions/f0615c6bd5d8?raw)