Get Stock Items

get

https://api.apicbase.com/api/v2/products/stock_items/

Returns a list of stock items in the library.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

page

int32

A page number within the paginated result set.

ordering

string

A field to order results by.

name

string

A stock item name to query on.

id__in

array of strings

A list of stock item IDs. Filters on the stock items specified in the list.

id__in

created_by

string

A user ID.

ingredient

string

An ingredient ID. Filters on stock items belonging to this ingredient.

count_outlet

string

An outlet ID. Filters on stock items that can be counted in this outlet.

stockable

boolean

Filter on stock items that are/are not stockable.

weighted

boolean

Filter on stock items that are/are not weighted.

gtin

string

Filter on GTIN/EAN.

modified_date

date

Filter on a modification date (exact).

modified_date__date__gte

date

Filter on a modification date (greater than or equal).

modified_date__date__lte

date

Filter on a modification date (lower than or equal).

modified_date__time

date

Filter on a modification datetime (exact).

modified_date__time__gte

date

Filter on a modification datetime (greater than or equal).

modified_date__time__lte

date

Filter on a modification datetime (lower than or equal).

gtin_list

array of strings

Filter on GTIN/EAN list.

gtin_list

Response

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200