---
title: "List Purchase Orders"
method: GET
path: "/purchase-orders"
tags: ["purchase_order"]
---

# List Purchase Orders

`GET /purchase-orders`

## Request

- Base URL: `https://app.zenventory.com/rest`
- URL: `https://app.zenventory.com/rest/purchase-orders`
- Auth: none declared

Get a list of purchase orders based on search parameters.

## Query parameters

- `orderNumber` string
- `warehouseId` integer
- `warehouseName` string
- `supplierId` integer
- `supplierName` string
- `clientId` integer
- `clientName` string
- `open` boolean
- `completed` boolean
- `draft` boolean
- `deleted` boolean
- `createdFrom` string, date-time
- `createdTo` string, date-time
- `orderBy` '' | 'id' | 'orderNumber' | 'createdDate' | 'preparedDate' | 'requiredByDate' | 'userField1' | 'userField2' | 'userField3'
- `orderDir` 'asc' | 'desc'
- `page` integer
- `perPage` integer

## Response `200`

Success

- PurchaseOrderList
  - `purchaseOrders` PurchaseOrder[]
    - `id` integer
    - `orderNumber` string
    - `supplier` SupplierCompact
      - `id` integer
      - `name` string
    - `warehouse` WarehouseCompact
      - `id` integer
      - `name` string
    - `client` ClientCompact
      - `id` integer
      - `name` string
    - `user` UserCompact
      - `id` integer
      - `name` string
    - `draft` boolean
    - `completed` boolean
    - `deleted` boolean
    - `createdDate` string, date-time
    - `preparedDate` string, date-time
    - `requiredByDate` string, date
    - `projectNumber` string
    - `notes` string
    - `shipMethod` string
    - `terms` string
    - `userField1` string
    - `userField2` string
    - `userField3` string
    - `items` PurchaseOrderItem[]
      - `id` integer
      - `itemId` integer
      - `sku` string
      - `description` string
      - `quantity` integer
      - `uom` string
      - `unitCost` number
  - `meta` PaginationMeta
    - `count` integer: Total number of objects in the result set.
    - `page` integer: The page of the result set in the response.
    - `perPage` integer: Number of objects per page.
    - `totalPages` integer: Total number of pages in the result set.

---

[API](https://skmtc.dev/zenventory/apis/zenventory-rest-api.md) · [All operations](https://skmtc.dev/zenventory/apis/zenventory-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/zenventory/apis/zenventory-rest-api/revisions/b40aa340773b?raw)