Get Recipes Linked to an Outlet

get

https://api.apicbase.com/api/v2/products/outlets/{outlet_id}/recipes/

Returns a list of recipes linked to a given outlet.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Recipes indirectly linked to an outlet because of being linked through a menu or as a subrcipe in a recipe that is linked are also shown.

Path Params

outlet_id

string

required

An outlet ID.

Query Params

page

string

A page number within the paginated result set.

ordering

string

A field to order results by.

name

string

A recipe name to query on.

uid

string

A UID (reference number) to query on.

persons

int32

The amount of servings.

persons__gt

int32

The amount of servings (greater than).

persons__lt

int32

The amount of servings (lower than).

tax

float

Filter on a tax rate.

tax__gt

float

Filter on a tax rate (greater than).

tax__lt

float

Filter on a tax rate (lower than).

current_sell_price

float

Filter on a sell price (exact).

current_sell_price__gt

float

Filter on a sell price (greater than).

current_sell_price__lt

float

Filter on a sell price (lower than).

created_date

date

Filter on a creation date (exact).

created_date__gt

date

Filter on a creation date (greater than).

created_date__lt

date

Filter on a creation date (lower than).

modified_date

date

Filter on a modification date (exact).

modified_date__gt

date

Filter on a modification date (greater than).

modified_date__lt

date

Filter on a modification date (lower than).

created_by

string

A user ID.

stockable

boolean

Filter recipes that are or are not stockable

original

string

A recipe ID. Filters on recipes that are clones of a given recipe.

net_weight

float

Filter on a weight (exact).

net_weight__gt

float

Filter on a weight (greater than).

net_weight__lt

float

Filter on a weight (lower than).

net_volume

float

Filter on a volume (exact).

net_volume__gt

float

Filter on a volume (greater than).

net_volume__lt

float

Filter on a volume (lower than).

prep_time

string

Filter on a preparation time duration (exact). Format is hh:mm:ss.

prep_time__gt

string

Filter on a preparation time duration (greater than). Format is hh:mm:ss.

prep_time__lt

string

Filter on a preparation time duration (lower than). Format is hh:mm:ss.

cooking_time

string

Filter on a cooking time duration (exact). Format is hh:mm:ss.

cooking_time__gt

string

Filter on a cooking time duration (greater than). Format is hh:mm:ss.

cooking_time__lt

string

Filter on a cooking time duration (lower than). Format is hh:mm:ss.

plating_time

string

Filter on a plating time duration (exact). Format is hh:mm:ss.

plating_time__gt

string

Filter on a plating time duration (greater than). Format is hh:mm:ss.

plating_time__lt

string

Filter on a plating time duration (lower than). Format is hh:mm:ss.

custom_fields

json

Filter on custom fields. Check reference guide for details.

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