Returns the list of Product's Inventory objects

get

https://qa2.revelup.com/inventoryx/api/inventory/Product/

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

establishment

integer

required

ID of Estabishment object related to the Inventory object

user

integer

required

ID of User object. Will be used as creator of inventory if inventory does not yet exists for returned products

search_query

string

Search within product name, barcode, sku

product_class

string

ProductClass object ID OR "none" to filter on "None" product class

vendor

integer

Vendor object ID

inactive

boolean

Defaults to false

By default this resource will return only active inventories.

display_untracked

boolean

Defaults to false

By default this resource will return only tracked inventories.

limit

integer

Defaults to 1000

Amount of objects to return per query. This amount must be lower than 1000 to avoid high server load. The default limit may change in the future.

offset

integer

Defaults to 0

Offset value for returned resources. Used in conjunction with the limit parameter to return resources in "pages".

Responses

400

Bad request. Usually caused by invalid request body.

401

Authentication error - make sure the API key & secret is valid, active and provided in the "API-AUTHENTICATION" header.

200Resource successfully retrieved.