Get Stock Item Updates for Outlet

get

https://api.apicbase.com/api/v2/inventory/outlets/{outlet_id}/event_logs/

Lists inventory update log entries for stock items in a given outlet.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Returns a comprehensive history of stock updates for all stock items in a given outlet.

Providing a date or a range of dates to filter on is mandatory. If a range of dates is provided, it may not exceed 31 days.

For transfer events returned by this endpoint, the destination_outlet attribute provides information about the outlet that received the transfer.

🚧
Results are not guaranteed to be ordered by default.
Use the ?ordering query param to specify a field to order results by. Refer to the documentation page about pagination to learn more about this filter.
All fields returned by this endpoint, except for nested objects, are valid ordering options. Results can also be ordered in reverse order by adding a minus sign (-) before the name of the field.

Path Params

outlet_id

string

required

An outlet's ID.

Query Params

event_date__date

date

Filter by the inventory event date (YYYY-MM-DD). Required if no event_date__date__gte/lte range is provided.

event_date__date__gte

date

Start of the inventory event date range (YYYY-MM-DD). Must be used together with event_date__date__lte.

event_date__date__lte

date

End of the inventory event date range (YYYY-MM-DD). Must be used together with event_date__date__gte.

event_date__time

string

Filter by the inventory event time (HH:MM:SS).

event_date__time__gte

string

Filter inventory events occurring at or after this time (HH:MM:SS).

event_date__time__lte

string

Filter inventory events occurring at or before this time (HH:MM:SS).

modified_date__date

date

Filter by event modification date (YYYY-MM-DD).

modified_date__date__gte

date

Filter events modified on or after this date (YYYY-MM-DD).

modified_date__date__lte

date

Filter events modified on or before this date (YYYY-MM-DD).

modified_date__time

string

Filter by updated time (HH:MM:SS).

modified_date__time__gte

string

Filter events modified at or after this time (HH:MM:SS).

modified_date__time__lte

string

Filter events modified at or before this time (HH:MM:SS).

created_date__date

date

Filter by event creation date (YYYY-MM-DD).

created_date__date__gte

date

Filter events created on or after this date (YYYY-MM-DD).

created_date__date__lte

date

Filter events created on or before this date (YYYY-MM-DD).

created_date__time

string

Filter by event creation time (HH:MM:SS).

created_date__time__gte

string

Filter events created at or after this time (HH:MM:SS).

created_date__time__lte

string

Filter events created at or before this time (HH:MM:SS).

stock_item_ids

string

Comma separated list of stock item IDs to filter.

base_stock_item_ids

string

Comma separated list of stock item IDs to filter.

ingredient_ids

string

Comma separated list of ingredient IDs to filter.

destination_outlet_ids

string

Comma separated list of destination outlet IDs to filter (transfer events).

source_recipe_ids

string

Comma separated list of source recipe IDs to filter.

ingredient_accounting_category

string

Filter by ingredient accounting category (case-insensitive).

ingredient_category

string

Filter by ingredient category (case-insensitive).

ingredient_subcategory

string

Filter by ingredient subcategory (case-insensitive).

event_type

string

enum

Filter by inventory event type.

Allowed:

event_type__in

string

enum

Comma separated list of inventory event types to filter.

Allowed:

stock_value

number

Filter by stock value of the event.

stock_value__gt

number

Filter events with stock value greater than this amount.

stock_value__lt

number

Filter events with stock value less than this amount.

quantity

number

Filter by quantity of the stock item in the event.

quantity__gt

number

Filter events with quantity greater than this amount.

quantity__lt

number

Filter events with quantity less than this amount.

result_stock_value

number

Filter by resulting stock value.

result_stock_value__gt

number

Filter logs with resulting stock value greater than this amount.

result_stock_value__lt

number

Filter logs with resulting stock value less than this amount.

result_quantity

number

Filter by resulting quantity.

result_quantity__gt

number

Filter logs with resulting quantity greater than this amount.

result_quantity__lt

number

Filter logs with resulting quantity less than this amount.

Response

Language

Credentials

OAuth2

Loading…

Response

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

application/json

Results are not guaranteed to be ordered by default.

200200