Catalog

Where this is in the panel

Menu & products → Menu & products
Menu & products → Product categories
Menu & products → Addon groups
Menu & products → Addons
Menu & products → Campaigns
Menu & products → Coupons
Menu & products → Recipes
Menu & products → Languages & translations
Menu & products → Orders

get /v1/product-categories

List product categories

categories.read

post /v1/product-categories

Create a category

categories.write

get /v1/product-categories/{category}

Get one category

categories.read

patch /v1/product-categories/{category}

Update a category

categories.write

delete /v1/product-categories/{category}

Delete a category

categories.write

get /v1/products

List products

products.read

post /v1/products

Create a product

products.write

get /v1/products/{product}

Get one product

products.read

patch /v1/products/{product}

Update a product

products.write

delete /v1/products/{product}

Delete a product

products.write

get /v1/recipes

List recipes

recipes.read

post /v1/recipes

Create a recipe

recipes.write

get /v1/recipes/{recipe}

Get one recipe

recipes.read

patch /v1/recipes/{recipe}

Update a recipe

recipes.write

delete /v1/recipes/{recipe}

Delete a recipe

recipes.write

get /v1/languages

List menu languages

languages.read

post /v1/languages

Add a language

languages.write

get /v1/languages/{language}

Get one language

languages.read

patch /v1/languages/{language}

Update a language

languages.write

delete /v1/languages/{language}

Remove a language

languages.write

get /v1/orders

List orders

orders.read

post /v1/orders

Record a sale

orders.write

get /v1/orders/{order}

Get one order

orders.read

post /v1/orders/{order}/refund

Refund an order

orders.refund

post /v1/orders/{order}/adjustments

Refund or write off a completed order

orders.refund

post /v1/orders/{order}/cancel

Cancel an unpaid order

orders.refund

post /v1/orders/{order}/pay

Collect payment for a kiosk order

orders.payment

post /v1/orders/{order}/deliver

Hand an order to the customer

orders.write

get /v1/pos/tables

Tables of the branch with their open bills

tables.read

post /v1/pos/tables/{table}/open

Open a table

tables.write

get /v1/pos/dining-sessions/{session}

Get a table bill

tables.read

patch /v1/pos/dining-sessions/{session}

Link a customer to a table bill

tables.write

post /v1/pos/dining-sessions/{session}/orders

Send a round to the table

tables.write

post /v1/pos/dining-sessions/{session}/settle

Settle a table bill

tables.write orders.payment

post /v1/pos/dining-sessions/{session}/close

Close a table without orders

tables.write

post /v1/pos/dining-sessions/{session}/merge

Move or merge a table bill

tables.write

post /v1/pos/order-items/{item}/cancel

Cancel an item already sent to a table

tables.write

get /v1/pos/kiosks

Kiosks paired with the branch

pos.cashiers.read

get /v1/pos/updates

Check for a Windows POS update

pos.cashiers.read

get /v1/pos/updates/{release}/download

Download a Windows POS package

pos.cashiers.read

get /v1/pos/cashiers

Cashiers who can sign in at a till

pos.cashiers.read

post /v1/orders/{order}/kitchen-status

Move an order through the kitchen

kitchen.write

get /v1/kitchen/orders

Kitchen board of one branch

orders.read

get /v1/board/orders

Customer-facing order board

orders.read

get /v1/menu

The sellable menu of one branch

products.read

get /v1/addon-groups

List addon groups

addons.read

post /v1/addon-groups

Create an addon group

addons.write

get /v1/addon-groups/{group}

Get one addon group

addons.read

patch /v1/addon-groups/{group}

Update an addon group

addons.write

delete /v1/addon-groups/{group}

Delete an addon group

addons.write

get /v1/addons

List addons

addons.read

post /v1/addons

Create an addon

addons.write

get /v1/addons/{addon}

Get one addon

addons.read

patch /v1/addons/{addon}

Update an addon

addons.write

delete /v1/addons/{addon}

Delete an addon

addons.write

get /v1/campaigns

List campaigns

campaigns.read

post /v1/campaigns

Create a campaign

campaigns.write

get /v1/campaigns/{campaign}

Get one campaign

campaigns.read

patch /v1/campaigns/{campaign}

Update a campaign

campaigns.write

delete /v1/campaigns/{campaign}

Delete a campaign

campaigns.write

get /v1/coupons

List coupons

coupons.read

post /v1/coupons

Create a coupon

coupons.write

get /v1/coupons/{coupon}

Get one coupon

coupons.read

patch /v1/coupons/{coupon}

Update a coupon

coupons.write

delete /v1/coupons/{coupon}

Delete a coupon

coupons.write

Where this is in the panel

Endpoints