Skip to content
Docs
Select language:English

/api/v1/reports/inventory

POST
/api/v1/reports/inventory
curl --request POST \
  --url https://example.com/api/v1/reports/inventory \
  --header 'Content-Type: application/json' \
  --data '{ "scope": { "locationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }, "filters": { "placeIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "typeIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "tagIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "thingIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "includeEnded": true, "includeTrashed": true }, "include": { "photos": true, "qr": true, "money": true }, "locale": "en", "digits": "western", "email": true }'

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
scope
required
Any of:
object
locationId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
filters
object
placeIds
Array<string>
<= 100 items
typeIds
Array<string>
<= 100 items
tagIds
Array<string>
<= 100 items
thingIds
Array<string>
<= 2000 items
includeEnded
boolean
includeTrashed
boolean
include
object
photos
boolean
qr
boolean
money
boolean
locale
string
Allowed values: en ar
digits
string
Allowed values: western eastern
email
boolean

Responses

Section titled “Responses”

202

Section titled “202”

Default Response

Media typeapplication/json
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
status
required
string
Allowed values: queued
expiresAt
required
string
Example
{
  "status": "queued"
}