---
title: "List Inventory Orders"
method: GET
path: "/inventory/orders"
tags: ["InventoryOrders"]
---

# List Inventory Orders

`GET /inventory/orders`

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

## Query parameters

- `site_id` string, uuid, required
- `purchase_order_number` string
- `page` integer
- `per_page` integer

## Response `200`

The inventory orders were successfully retrieved

- object
  - `data` InventoryOrder[], required
    - `id` string, uuid, required — The ID of the inventory order.
    - `status` 'draft' | 'submitted' | 'received', required — The status of the inventory order.
    - `purchase_order_number` string — The purchase order number for this inventory order.
    - `supplier_id` string, uuid, required — The ID of the supplier for this inventory order.
    - `supplier_name` string, required — The name of the supplier for this inventory order.
    - `supplier_email` string, required — An email address for the supplier of this inventory order.
    - `subtotal` integer, required — The subtotal of the order in the lowest denomination for this order's currency.
    - `currency` string, required — The currency of the inventory order.
    - `item_count` integer, required — The total number of items in the inventory order.
    - `items_added` boolean, required — Whether items have been added to the order.
    - `created_by_id` string, uuid, nullable, required — The ID of the user who created the inventory order.
    - `site_id` string, uuid, required — The ID of the site this inventory order belongs to.
    - `organisation_id` string, uuid, required — The ID of the organisation this inventory order belongs to.
    - `created_at` string, date-time, required — The date and time the inventory order was created.
    - `updated_at` string, date-time, required — The date and time the inventory order was last updated.
    - `submitted_at` string, date-time, nullable, required — The date and time the inventory order was submitted.
    - `last_submitted_at` string, date-time, nullable, required — The date and time the inventory order was last submitted.
  - `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)