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.

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

Response body

object

count

integer

Defaults to 0

string

results

array of objects

results

object

name

string

description

string

subcategory

string

net_weight_unit

string

current_sell_price

object

recipe_class

string

category

string

season

string

prep_time_passive

string

composition

string

web_page

string

cuisine

string

remarks

string

preferred_uoms

array

preferred_uoms

cooking_time_passive

string

highly_perishable

string

main_stock_items

array

main_stock_items

target_profit_margin

string

plating_time

string

recipe_stage

string

difficulty

integer

Defaults to 0

sell_price_history

array

sell_price_history

modified_date

string

custom_fields

array of objects

custom_fields

object

name

string

value

string

name_translations

object

net_volume

string

net_weight

string

clones

array

clones

storage_conditions

string

url

string

tax

string

recipe_type

string

created_date

string

is_semi_finished_product

boolean

Defaults to true

persons

integer

Defaults to 0

cooking_time

string

is_stockable_recipe

boolean

Defaults to true

uid

string

recipe_type_other

string

prep_time

string

original

string

storage_conditions_translations

object

created_by

string

net_volume_unit

string

portion_pieces

string

shelf_life

object

carbon_footprint

object

carbon_footprint_per_portion

object

Language

Credentials

OAuth2


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.apicbase.com/api/v2/products/outlets/outlet_id/recipes/ \
3
     --header 'accept: application/json'


xxxxxxxxxx
306
}
1
{
2
  "count": 3,
3
  "next": null,
4
  "previous": null,
5
  "results": [
6
    {
7
      "name": "Carrot Cake",
8
      "description": "A delicious cake.",
9
      "subcategory": null,
10
      "net_weight_unit": "g",
11
      "id": "549990580860002",
12
      "current_sell_price": {
13
        "created": "2020-10-01 17:55:07.866442",
14
        "pricing": 6.5,
15
        "user_pk": 3475,
16
        "username": "john.doe@gmail.com"
17
      },
18
      "recipe_class": "dish",
19
      "category": null,
20
      "season": "all_seasons",
21
      "prep_time_passive": null,
22
      "composition": "<p><br></p>",
23
      "web_page": "https://app.apicbase.com/library/recipe/99808/",
24
      "cuisine": "English",
25
      "remarks": "<p>Include remarks here, if you like.</p>",

200200