---
title: "List Inventory Products"
method: GET
path: "/inventory/products"
tags: ["InventoryProducts"]
---

# List Inventory Products

`GET /inventory/products`

This endpoint retrieves a list of all the inventory products for the given site.

## Query parameters

- `site_id` string, uuid, required
- `supplier_ids` string, uuid
- `category_ids` string, uuid
- `brand_ids` string, uuid
- `query` string
- `page` integer
- `per_page` integer

## Response `200`

The inventory products were successfully retrieved

- object
  - `data` InventoryProduct[], required
    - `id` string, uuid, required — The ID of the inventory product.
    - `name` string, required — The name of the inventory product.
    - `description` string, nullable, required — A description of the inventory product.
    - `sku` string, nullable, required — A stock keeping unit (SKU) for the inventory product.
    - `barcode` string, nullable, required — A barcode for the inventory product.
    - `average_cost` integer, required — The average cost of the inventory product in the lowest denomination for this product's currency.
    - `currency` string, required — The currency of the inventory product.
    - `reorder_level` integer, nullable, required — The quantity of this inventory product which should be reordered.
    - `stock_level` number, required — The quantity of this stock at the site.
    - `stock_value` integer, required — The total value of this stock at the site in the lowest denomination for this product's currency.
    - `brand_id` string, uuid, nullable, required — The ID of the brand this inventory product belongs to.
    - `brand` InventoryBrand
      - `id` string, uuid, required — The ID of the inventory brand.
      - `name` string, required — The name of the inventory brand.
      - `site_id` string, uuid, nullable, required — The ID of the site the inventory brand belongs to.
      - `organisation_id` string, uuid, required — The ID of the organisation the inventory brand belongs to.
    - `category_id` string, uuid, nullable, required — The ID of the category this inventory product belongs to.
    - `category` InventoryCategory
      - `id` string, uuid, required — The ID of the inventory category.
      - `name` string, required — The name of the inventory category.
      - `site_id` string, uuid, nullable, required — The ID of the site the inventory category belongs to.
      - `organisation_id` string, uuid, required — The ID of the organisation the inventory category belongs to.
      - `order` integer, required — The display order of the inventory category within its site. Lower values are shown first. Set via the reorder endpoint.
    - `site_id` string, uuid, required — The ID of the site this inventory product belongs to.
    - `organisation_id` string, uuid, required — The ID of the organisation this inventory product belongs to.
  - `meta` PaginationMeta, required — Counts and positional information for the current page of a list response. Use `current_page` and `last_page` to drive pagination UI, `total` for result counts, and `per_page` to confirm the page size the server actually applied (which may differ from the requested value when capped).
    - `from` integer, required — The item number from which this results set starts from
    - `to` integer, required — The item number from which this results set ends at
    - `total` integer, required — The total number of results
    - `current_page` integer, required — The current page number
    - `last_page` integer, required — The page number of the last result set
    - `per_page` integer, required — The number of results per page
    - `path` string, required — The path of this api request
  - `links` PaginationLinks, required — Hypermedia navigation links for paging through a list response. Each property is a fully-qualified URL that preserves the original query string (filters, sort, page size) and only swaps the `page` parameter. `next` and `prev` are `null` at the ends of the result set; `first` and `last` are always present.
    - `first` string, required — The url of the first page for the paginated results set
    - `next` string, nullable, required — The url of the next page for the paginated results set
    - `prev` string, nullable, required — The url of the previous page for the paginated results set
    - `last` string, required — The url of the last page for the paginated results set

## Other responses

- `401` — The user is unauthenticated

---

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