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

# List shipments

`GET /api/v1/shipments`

Retrieve a paginated list of shipments

Enables developers to query shipments associated with their account, with filters and cursor-based pagination.

## Query parameters

- `limit` integer
- `after` string
- `before` string
- `ids` string[]
- `status` ShipmentStatus[]

## Response `200`

Paginated shipments response

- ShipmentsListResponse
  - `pageInfo` object, required
    - `endCursor` string
    - `startCursor` string
    - `hasPreviousPage` boolean, required
    - `hasNextPage` boolean, required
  - `data` Shipment[], required
    - union
      - union — Shipments that have tracking information (shipped, delayed, or delivered states)
        - ShippedShipment
          - `updatedAt` string, date-time, required
          - `createdAt` string, date-time, required
          - `marketplaceOrderId` string, required
          - `checkoutIntentId` string, required
          - `id` string, required
          - `trackingEvents` TrackingEvent[], required
            - `status` 'out_for_delivery' | 'delivered' | 'shipped' | 'canceled' | 'delayed' | 'ordered', required
            - `location` EventLocation, required
              - …
            - `timestamp` TrackingEventTimestamp, required
              - …
            - `description` string, nullable, required
          - `shippedAt` string, date-time, required
          - `tracking` ShipmentTracking, required
            - `carrierName` string, nullable
            - `number` string, nullable, required
            - `deliveryDate` DeliveryDate
              - …
            - `url` string, nullable
          - `externalId` string, required — The external ID is provided by the marketplace and matches the shipment to their system.
          - `status` 'shipped', required
        - DeliveredShipment
          - `updatedAt` string, date-time, required
          - `createdAt` string, date-time, required
          - `marketplaceOrderId` string, required
          - `checkoutIntentId` string, required
          - `id` string, required
          - `trackingEvents` TrackingEvent[], required
            - `status` 'out_for_delivery' | 'delivered' | 'shipped' | 'canceled' | 'delayed' | 'ordered', required
            - `location` EventLocation, required
              - …
            - `timestamp` TrackingEventTimestamp, required
              - …
            - `description` string, nullable, required
          - `shippedAt` string, date-time, required
          - `tracking` ShipmentTracking, required
            - `carrierName` string, nullable
            - `number` string, nullable, required
            - `deliveryDate` DeliveryDate
              - …
            - `url` string, nullable
          - `externalId` string, required — The external ID is provided by the marketplace and matches the shipment to their system.
          - `status` 'delivered', required
          - `deliveredAt` string, date-time, required
        - DelayedShipment
          - `updatedAt` string, date-time, required
          - `createdAt` string, date-time, required
          - `marketplaceOrderId` string, required
          - `checkoutIntentId` string, required
          - `id` string, required
          - `trackingEvents` TrackingEvent[], required
            - `status` 'out_for_delivery' | 'delivered' | 'shipped' | 'canceled' | 'delayed' | 'ordered', required
            - `location` EventLocation, required
              - …
            - `timestamp` TrackingEventTimestamp, required
              - …
            - `description` string, nullable, required
          - `shippedAt` string, date-time, required
          - `tracking` ShipmentTracking, required
            - `carrierName` string, nullable
            - `number` string, nullable, required
            - `deliveryDate` DeliveryDate
              - …
            - `url` string, nullable
          - `externalId` string, required — The external ID is provided by the marketplace and matches the shipment to their system.
          - `status` 'delayed', required
        - OutForDeliveryShipment
          - `updatedAt` string, date-time, required
          - `createdAt` string, date-time, required
          - `marketplaceOrderId` string, required
          - `checkoutIntentId` string, required
          - `id` string, required
          - `trackingEvents` TrackingEvent[], required
            - `status` 'out_for_delivery' | 'delivered' | 'shipped' | 'canceled' | 'delayed' | 'ordered', required
            - `location` EventLocation, required
              - …
            - `timestamp` TrackingEventTimestamp, required
              - …
            - `description` string, nullable, required
          - `shippedAt` string, date-time, required
          - `tracking` ShipmentTracking, required
            - `carrierName` string, nullable
            - `number` string, nullable, required
            - `deliveryDate` DeliveryDate
              - …
            - `url` string, nullable
          - `externalId` string, required — The external ID is provided by the marketplace and matches the shipment to their system.
          - `status` 'out_for_delivery', required
      - union — Shipments without tracking information
        - OrderedShipment
          - `updatedAt` string, date-time, required
          - `createdAt` string, date-time, required
          - `marketplaceOrderId` string, required
          - `checkoutIntentId` string, required
          - `id` string, required
          - `status` 'ordered', required
        - CanceledShipment
          - `updatedAt` string, date-time, required
          - `createdAt` string, date-time, required
          - `marketplaceOrderId` string, required
          - `checkoutIntentId` string, required
          - `id` string, required
          - `status` 'canceled', required

## Other responses

- `401` — Authentication Failed
- `404` — Not Found
- `422` — Validation Error

---

[API](https://skmtc.dev/rye-com/apis/universal-checkout-api.md) · [All operations](https://skmtc.dev/rye-com/apis/universal-checkout-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/rye-com/universal-checkout-api/revisions/175c7f9e090e/schema)