Get menu

get https://api.kitchenhub.app/v2/stores/{store_id}/menu/

Retrive store's menu from Kitchenhub.
This menu is "source of truth", which will be uploaded to all Store's connected Integrations

Responses

Response body

object

required

partner_id

string

required

Id menu from the client

name

string

required

The name of the menu to be displayed

description

string

Menu description

media_url

string

The URL where the image file can be downloaded.

partner_categories

array of strings

Defaults to

        List of partner categories ids, which belongs to this menu.
        Categories will be displayed in UI in the same order they are listed here.

Partner categories

categories

array of objects

required

Categories*

object

partner_id

string

required

Partner category id. Filled in manually

title

string

required

The displayed name for the category

description

string

Category Description

is_deactivated

boolean

Defaults to false

Boolean field which show if category is deactivated. Client can also specify the time when category is deactivated

deactivation_start_date

date-time

Date since category is deactivated (format year-month-dayThour:minute:second.msecZ)

deactivation_end_date

date-time

Date till category is deactivated (format year-month-dayThour:minute:second.msecZ)

media_url

string

            The URL where the image file can be downloaded.
            The image you have selected will be transformed to fit provider requirements
            (we recommend to keep at least 1024 px each side). If provider expects specific aspect-ratio,
            white borders can be added to fit this requirement.

partner_items

array of strings

Defaults to

        All of the partner IDs for the menu items that belongs to this category.
        Items will be displayed in UI in the same order they are listed here.

Partner items

partner_availability

string

Partner ID of availability, which is connected with this category(opening hours of the restaurant)

items

array of objects

required

Items*

object

partner_id

string

required

Partner item id

name

string

required

The display name of the menu item

description

string

Item description

internal_notes

string

Additional information about item cooking

is_deactivated

boolean

Defaults to false

        Boolean field which show if item is deactivated.
        Client can also specify the time when item is deactivated

deactivation_start_date

date-time

Date since item is deactivated (format year-month-dayThour:minute:second.msecZ)

deactivation_end_date

date-time

Date till item is deactivated (format year-month-dayThour:minute:second.msecZ)

media_url

string

The URL where the image file can be downloaded.

price

number

≥ 0

Defaults to 0

The cost of this item. This field should be a positive number.

original_price

number

≥ 0

The cost of the item for pickup. This price does not include delivery charges. This field should be a positive number.

prices_customization

object

Custom price information for selected providers. Contains mapping of provider_id to prices. This field can be skipped, but cannot contain a null value.

min_amount

integer

≥ 1

Defaults to 1

Default minimum quantity that can be ordered of this item. Default value - 1

max_amount

integer

Defaults to 3

Default maximum quantity that can be ordered of this item. Default value - 3

partner_availability

string

Partner ID of availability, which is connected with this item (opening hours of the restaurant)

partner_modifiers

array of strings

Defaults to

        All of the partner IDs for the menu modifiers that belongs to this item.
        Modifiers will be displayed in UI in the same order they are listed here.

Partner modifiers

tax_rate

number

        Extra tax which may be added to some items on top of regular sales tax. Must be between 0 and 1.

modifiers

array of objects

required

Modifiers*

object

partner_id

string

required

Partner modifier id. Filled in manually

name

string

required

The displayed name for the modifier or size

is_required

boolean

Defaults to false

A boolean field that indicates that the modifier is required or not

min_options

integer

Defaults to 0

Min number of options which customer select.

max_options

integer

Defaults to 3

Max number of options which customer select.

default_options

array of strings

Defaults to

The options ids, if any, that are selected by default for this modifier

Default options

partner_options

array of strings

Defaults to

        All of the partner IDs for the menu options that belongs to this modifier.
        Options will be displayed in UI in the same order they are listed here.

Partner options

type

string

Defaults to variation

    The type of modifier it can be size or variation.
    Min and max options will be ignored if modifier type is 'size'.

options

array of objects

required

Options*

object

partner_id

string

required

Partner option id.

name

string

required

The displayed name for the option or size

price

number

≥ 0

Defaults to 0

The cost of this option

original_price

number

≥ 0

prices_customization

object

Custom price information for selected providers. Contains mapping of provider_id to prices. This field can be skipped, but cannot contain a null value.

tax_rate

number

        Extra tax which may be added to some options on top of regular sales tax.. Must be between 0 and 1.

description

string

Option description

is_deactivated

boolean

Defaults to false

Boolean field which show if option is deactivated. Client can also specify the time when option is deactivated

deactivation_start_date

date-time

Date since option is deactivated (format year-month-dayThour:minute:second.msecZ)

deactivation_end_date

date-time

Date till option is deactivated (format year-month-dayThour:minute:second.msecZ)

partner_modifiers

array of strings

Defaults to

            Option's nested modifiers.
            Maximum nesting level = 3.

Partner modifiers

availabilities

array of objects

required

Availabilities*

object

partner_id

string

required

Partner availability id. Filled in manually

rules

array of objects

required

Rules*

object

days_of_week

array

required

List of days of the week (MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY)

Days of week*

start_time

string

required

Time after which item is available in 24-hour HH:MM:SS format

end_time

string

required

Time after which item is not available in 24-hour HH:MM:SS format

Language

Credentials

Header


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.kitchenhub.app/v2/stores/store_id/menu/ \
3
     --header 'accept: application/json'

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

application/json

200Success Response

401Unauthorized

403Forbidden

404Menu not found

500Server error