v1

latestOpenAPI 3.1.02026-07-24700152.8 KB

List available supplies

Provides a list of Supplies for the specified company. Creation of Supplies can only be performed in the application.

get/supplies

Query parameters

company_idinteger

Fetch supplies associated with the specified Breezeway company ID (cross-company access required)

limitinteger

Number of records returned per page

pageinteger

The page to return

sort_bystring

Field to sort results by

sort_orderstring

Order to sort results in ('asc' or 'desc')

Response

200

limitinteger

pageinteger

total_pagesinteger

total_resultsinteger

Example response

{
  "limit": 100,
  "page": 1,
  "results": [
    {
      "company_id": 4,
      "created_at": "2022-06-23T13:17:12",
      "id": 54471,
      "low_stock_alert": true,
      "low_stock_count": 50,
      "name": "Batteries",
      "size": "AA",
      "stock_count": 9983,
      "supply_category_id": 236,
      "type_stock_status": {
        "code": "in_stock",
        "name": "In Stock"
      },
      "unit_cost": 7,
      "updated_at": "2022-06-28T11:52:27"
    }
  ],
  "total_pages": 1,
  "total_results": 1
}