---
title: "List Shipments"
method: GET
path: "/inventory/shipments/list"
tags: ["provider", "inventory"]
---

# List Shipments

`GET /inventory/shipments/list`

List shipments with optional filtering.

## Query parameters

- `page` integer, nullable
- `per_page` integer, nullable
- `sort_by` string, nullable
- `sort_direction` 'asc' | 'desc', nullable
- `location_id` string, nullable — Optional ID of the location
- `ids` string[], nullable — Optional list of IDs of the shipments
- `stock_id` string, nullable — Optional ID of the stock
- `supplier_id` string, nullable — Optional ID of the supplier
- `sku` string, nullable — Optional SKU (Stock Keeping Unit)
- `lot_number` string, nullable — Optional lot number of the shipment
- `remaining_quantity` number[], nullable — Optional remaining quantity of the shipment

## Headers

- `TENANT` string, required
- `API-KEY` string, required

## Response `200`

Successful Response

- ShipmentOutput[]
  - `id` string — Unique identifier for the shipment
  - `stockId` string, required — ID of the stock
  - `supplierId` string, required — ID of the supplier
  - `locationId` string, required — ID of the location where the shipment was delivered
  - `lotNumber` string, nullable — Optional lot number of the shipment
  - `expiryDate` string, date-time, nullable — Optional expiry date of the shipment
  - `sku` string, nullable — Optional SKU (Stock Keeping Unit)
  - `quantity` number, required — Total quantity
  - `remainingQuantity` number, required — Remaining quantity
  - `cost` integer, nullable — Cost of the shipment in cents
  - `supplier` Supplier
    - `id` string — Unique identifier for the supplier
    - `name` string, required — Name of the supplier
    - `description` string, nullable — Optional description of the supplier
    - `website` string, nullable — Optional website of the supplier
    - `email` string, nullable — Optional email of the supplier
    - `preferredContactMethod` string, nullable — Optional preferred contact method
    - `phoneNumber` string, nullable — Optional phone number of the supplier
    - `addressLineOne` string, nullable — Optional first line of address
    - `addressLineTwo` string, nullable — Optional second line of address
    - `city` string, nullable — Optional city
    - `state` string, nullable — Optional state or province
    - `zipCode` string, nullable — Optional ZIP or postal code
    - `country` string, nullable — Optional country
    - `isArchived` boolean — Whether the supplier is archived
  - `createdDate` string, date-time, nullable — Date and time the shipment was created
  - `note` string, nullable — Optional note for inventory log when updating shipment
  - `locationName` string, nullable, required — Get the location name from the related location object

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.dev/decodahealth/apis/decoda-api.md) · [All operations](https://skmtc.dev/decodahealth/apis/decoda-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/decodahealth/decoda-api/revisions/4939a65a89d2/schema)