/api/v1/consumables
GET
/api/v1/consumables
const url = 'https://example.com/api/v1/consumables?locationId=2489E9AD-2EE2-8E00-8EC9-32D5F69181C0&state=low&limit=20';const options = {method: 'GET'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url 'https://example.com/api/v1/consumables?locationId=2489E9AD-2EE2-8E00-8EC9-32D5F69181C0&state=low&limit=20'Parameters
Section titled “Parameters”Query Parameters
Section titled “Query Parameters”locationId
required
string format: uuid
state
string
placeId
string format: uuid
limit
integer
cursor
string
Responses
Section titled “Responses”Default Response
Media typeapplication/json
object
items
required
Array<object>
object
thing
required
object
id
required
string format: uuid
locationId
required
string format: uuid
shortCode
required
string | null
name
required
string | null
type
required
quantity
required
number
lifecycle
required
string
derivedState
required
Array<string>
path
required
Array<object>
object
id
required
string format: uuid
name
required
string
kind
required
string
isUnplaced
required
boolean
shortCode
string | null
containerThumbUrl
required
string | null
thumbUrl
required
string | null
lastSeenAt
required
string | null
isContainer
required
boolean
minQuantity
required
number
low
required
boolean
next_cursor
required
string | null
Example
{ "items": [ { "thing": { "derivedState": [ "uncertain" ], "path": [ { "kind": "place" } ] } } ]}