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 or modified. Prefix with - for descending order. Values outside this list are ignored and the default ordering is used.

name

string

A stock item name to query on.

id__in

string

A comma-separated list of stock item IDs. Returns the stock items in the list.

created_by

string

Part of the email address of the user who created the stock item. Case-insensitive partial match.

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. Matches any GTIN in the item's gtin_list.

modified_date__date

date

Filter on a modification date (exact). Format YYYY-MM-DD.

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

string

^\d{2}:\d{2}:\d{2}$

Filter on a modification time of day (exact). Format HH:MM:SS.

modified_date__time__gte

string

^\d{2}:\d{2}:\d{2}$

Filter on a modification time of day (greater than or equal). Format HH:MM:SS.

modified_date__time__lte

string

^\d{2}:\d{2}:\d{2}$

Filter on a modification time of day (lower than or equal). Format HH:MM:SS.

gtin__in

string

A comma-separated list of GTIN/EAN values. Returns stock items carrying any of them.

page_size

int32

≤ 200

Number of results per page. Values above 200 are capped at 200.

fields

string

A comma-separated list of fields to return. Unknown field names are ignored.

base_stock_item_unit_id

string

A stock item ID. Returns the stock items whose base stock item is this one.

Responses

404

The requested page is out of range.

Language

Credentials

OAuth2

Loading…

Response

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

application/json

200200