SNsnipeitapp

/consumables

Changed on

Return a listing of consumables

get/consumables

Request

  • Base URL
    https://develop.snipeitapp.com/api/v1
  • URL
    https://develop.snipeitapp.com/api/v1/consumables
  • Auth
    none required

Query parameters

namestring

Consumable name

limitinteger

Specify the number of results you wish to return

offsetinteger

Offset to use

searchstring

A text string to search the assets data for

order_numberstring

Return only assets associated with a specific order number

sortstring

Specify the column name you wish to sort by

orderstring

Specify the order (asc or desc) you wish to order by on your sort column

expandstring

Whether to include detailed information on categories, etc (true) or just the text name (false)

category_idinteger

Category ID to filter by

company_idinteger

Company ID to filter by

manufacturer_idinteger

Manufacturer ID to filter by

Response

200

totalinteger

Example response

{
  "total": 3,
  "rows": [
    {
      "id": 1,
      "name": "Cardstock (White)",
      "category": {
        "id": 10,
        "name": "Printer Paper"
      },
      "company": {
        "id": 3,
        "name": "Frami-Gleichner"
      },
      "item_no": "39662828",
      "manufacturer": {
        "id": 10,
        "name": "Avery"
      },
      "remaining": 10,
      "order_number": "39883338",
      "purchase_cost": "24.42",
      "purchase_date": {
        "date": "2018-01-20",
        "formatted": "2018-01-20"
      },
      "qty": 10,
      "created_at": {
        "datetime": "2018-10-09 19:09:21",
        "formatted": "2018-10-09 07:09 PM"
      },
      "updated_at": {
        "datetime": "2018-10-15 20:04:07",
        "formatted": "2018-10-15 08:04 PM"
      },
      "user_can_checkout": true,
      "available_actions": {
        "checkout": true,
        "checkin": true,
        "update": true,
        "delete": true
      }
    }
  ]
}

Changes