---
title: "Returns a list of shipments"
method: GET
path: "/shipments"
tags: ["Shipments"]
---

# Returns a list of shipments

`GET /shipments`

Get all shipments

## Query parameters

- `createdTime` object
- `updatedTime` object
- `endingBefore` string
- `startingAfter` string
- `limit` integer
- `ids` string[]

## Response `200`

200 OK

- object
  - `hasMore` boolean — Indicates whether or not there are more elements available after this set. If false this set represents the end of the list.
  - `data` Shipment[]
    - `id` string — The unique identifier of a shipment.
    - `createdTime` string, date-time — Time when the shipment was created.
    - `fulfillmentOrderId` string — The identifier of the fulfillment order.
    - `fulfillmentOrderUpstreamId` string — The upstream identifier of the fulfillment order.
    - `shippingChoiceId` string — The shipping method.
    - `trackingCompanyId` string, nullable — The unique identifier of the tracking or carrier company.
    - `trackingCompany` string — The name of the tracking or carrier company.
    - `trackingNumber` string — The tracking number provided by the carrier company.
    - `trackingUrl` string — The URL of the fulfillment tracking page.
    - `items` ShipmentItem[]
      - `id` string — The unique identifier of a shipment item.
      - `fulfillmentOrderItemId` string — The identifier of the line item.
      - `fulfillmentOrderItemUpstreamId` string — The upstream identifier of the line item.
      - `inventoryItemId` string — The identifier of the inventory item.
      - `partNumber` string — The manufacturer part number.
      - `quantity` number — The quantity of this item.
      - `trackingUrls` Tracking[]
        - `trackingNumber` string, nullable — The tracking identifier provided by the carrier.
        - `trackingUrl` string, nullable — The URL of the tracking page provided by the carrier.
      - `unitAttributes` ShipmentUnitAttributes[]
        - `serialNumber` string, nullable — .
        - `imeiNumber` string, nullable — .
        - `simCardNumber` string, nullable — .
    - `liveMode` boolean — Has the value true if the object exists in live mode or the value false if the object exists in test mode.

## Other responses

- `400` — 400 Bad Request
- `401` — 401 Unauthorized
- `403` — 403 Forbidden
- `405` — 405 Method Not Allowed
- `406` — 406 Not Acceptable
- `408` — 408 Request Timeout
- `429` — 429 Too Many Requests
- `500` — 500 Internal Server Error
- `502` — 502 Bad Gateway Error
- `503` — 503 Service Unavailable Error
- `504` — 504 Gateway Timeout Error

---

[API](https://skmtc.net/digitalriver/apis/digital-river-api-reference.md) · [All operations](https://skmtc.net/digitalriver/apis/digital-river-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/digitalriver/digital-river-api-reference/revisions/f21981db32be/schema)