Sign in
InventoryOrders

List Inventory Orders

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

get/inventory/orders

Query parameters

site_idstring uuid required

Filter inventory products by site.

purchase_order_numberstring

A search query to filter inventory orders by the purchase order number.

pageinteger

The page to retrieve results from

per_pageinteger

The number of results to return per page

Response

The inventory orders were successfully retrieved

Example response

{
  "data": [
    {
      "purchase_order_number": "PO123",
      "supplier_name": "Elemis",
      "supplier_email": "orders@example.com",
      "subtotal": 2000,
      "currency": "gbp",
      "item_count": 10,
      "created_at": "2024-06-01T12:00:00Z",
      "updated_at": "2024-06-01T12:00:00Z",
      "submitted_at": "2024-06-01T12:00:00Z",
      "last_submitted_at": "2024-06-02T12:00:00Z"
    }
  ],
  "meta": {
    "from": 1,
    "to": 2,
    "total": 2,
    "current_page": 1,
    "last_page": 2,
    "per_page": 15,
    "path": "http://example.com/api"
  },
  "links": {
    "first": "http://example.com?page=1",
    "next": "https://example.com?page=3",
    "prev": "https://example.com?page=1",
    "last": "https://example.com?page=4"
  }
}

Changes