Skip to content
CIQRACIQRACIQRA Developers

AppListInventoryLevels

GET
/apps/inventory/levels
curl --request GET \
  --url 'https://your-store.myciqra.com/apps/inventory/levels?skip=0&take=50' \
  --header 'Authorization: Bearer <token>'

Required scope: read_inventory — an installation token without it receives 403.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters”
warehouseId
string format: uuid
skip
integer | string format: int32
0 /^-?(?:0|[1-9]\d*)$/
take
integer | string format: int32
default: 50 /^-?(?:0|[1-9]\d*)$/

Responses

Section titled “ Responses ”

200

Section titled “200”

OK

Media typeapplication/json
object
items
required
Array<object>
object
available
required
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
onHand
required
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
productId
required
string format: uuid
productVariantId
required
string format: uuid
reserved
required
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
warehouseCode
required
string
warehouseId
required
string format: uuid
warehouseName
required
string
skip
required
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
take
required
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
total
required
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
Examplegenerated
{
  "items": [
    {
      "available": 1,
      "onHand": 1,
      "productId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "productVariantId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "reserved": 1,
      "warehouseCode": "example",
      "warehouseId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "warehouseName": "example"
    }
  ],
  "skip": 1,
  "take": 1,
  "total": 1
}