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

# List Item

`GET /inventory/items/list`

## Query parameters

- `page` integer, nullable
- `per_page` integer, nullable
- `sort_by` string, nullable
- `sort_direction` 'asc' | 'desc', nullable
- `location_id` string, nullable
- `ids` string[], nullable — List of item IDs to filter by
- `name` string, nullable — Name of the item
- `category` string, nullable — Category of the item
- `price_range` integer[], nullable — Price range [min, max]
- `is_archived` boolean, nullable — Archived status of the item
- `is_physical` boolean, nullable — Physical status of the item

## Headers

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

## Response `200`

Successful Response

- PageItemDetail
  - `data` ItemDetail[], required
    - `id` string — Unique identifier for the item
    - `name` string, required — Name of the item
    - `brandName` string, nullable — Optional brand name of the item
    - `description` string, nullable — Optional description of the item
    - `price` integer, required — Price of the item in cents
    - `category` string, nullable — Category name (references category.name)
    - `unit` 'AMPOULES' | 'APPLICATORS' | 'BOTTLES' | 'BOXES' | 'CAPSULES' | 'CUPS' | 'DOSES' | 'G_PER_ML' | 'GRAMS' | 'IU' | 'IU_PER_ML' | 'OUNCES' | 'FLUID_OUNCES' | 'KG' | 'KITS' | 'LITERS' | 'MCG' | 'MG' | 'MG_PER_ML' | 'ML' | 'MMOL' | 'MICROGRAM_PER_ML' | 'PACKS' | 'PAIRS' | 'PATCHES' | 'PERCENTAGE' | 'PIECES' | 'POUCHES' | 'ROLLS' | 'SACHETS' | 'SHEETS' | 'SPRAYS' | 'STRIPS' | 'SYRINGES' | 'TABLETS' | 'TABLETS_PER_DAY' | 'TESTS' | 'TUBES' | 'UNITS' | 'VIALS' | 'TREATMENTS' | 'SESSIONS' | 'PULSES' | 'JOULES' | 'CENTIMETERS' | 'THREAD_COUNT' | 'INJECTIONS' | 'WRINKLE_UNITS' | 'POUNDS' | 'FEET' | 'INCHES'
    - `isPhysical` boolean — Whether the item is physical
    - `isArchived` boolean — Whether the item is archived
    - `internalNotes` string, nullable — Optional internal notes for the item
    - `taxable` boolean — Whether the item is subject to taxes
    - `sortOrder` integer, nullable — Optional sort order for the item
    - `allowCustomPricing` boolean — Whether custom pricing is allowed for this item
    - `type` 'ITEM' | 'PRODUCT' | 'MEDICATION' | 'SERVICE' | 'PACKAGE' | 'MEMBERSHIP'
    - `stocks` ItemStockDetail[], nullable — Optional linked stocks for the item
      - `itemId` string, required — ID of the item
      - `stockId` string, required — ID of the stock
      - `quantityUsed` number, required — Quantity of the item
      - `stock` Stock, required
        - `id` string — Unique identifier for the stock
        - `name` string, required — Name of the stock
        - `description` string, nullable — Optional description of the stock
        - `notes` string, nullable — Notes about the stock
        - `category` string, nullable — Category name (references category.name)
        - `unit` 'AMPOULES' | 'APPLICATORS' | 'BOTTLES' | 'BOXES' | 'CAPSULES' | 'CUPS' | 'DOSES' | 'G_PER_ML' | 'GRAMS' | 'IU' | 'IU_PER_ML' | 'OUNCES' | 'FLUID_OUNCES' | 'KG' | 'KITS' | 'LITERS' | 'MCG' | 'MG' | 'MG_PER_ML' | 'ML' | 'MMOL' | 'MICROGRAM_PER_ML' | 'PACKS' | 'PAIRS' | 'PATCHES' | 'PERCENTAGE' | 'PIECES' | 'POUCHES' | 'ROLLS' | 'SACHETS' | 'SHEETS' | 'SPRAYS' | 'STRIPS' | 'SYRINGES' | 'TABLETS' | 'TABLETS_PER_DAY' | 'TESTS' | 'TUBES' | 'UNITS' | 'VIALS' | 'TREATMENTS' | 'SESSIONS' | 'PULSES' | 'JOULES' | 'CENTIMETERS' | 'THREAD_COUNT' | 'INJECTIONS' | 'WRINKLE_UNITS' | 'POUNDS' | 'FEET' | 'INCHES', required
        - `isArchived` boolean — Whether the stock is archived
        - `shipments` ShipmentOutput[], nullable — Shipments in the stock
          - `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
    - `usageCount` integer, nullable, required — Number of times this item has been used
  - `total` integer, required

## 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)