Third Party Webhooks Content

Contents of the requests on third party webhooks

post
TYPE : MENU

https://yourwebhook/for_type_menu
Service for receiving the menu from the POS.
Request
Response
Request
Headers
Content-type
optional
string
application/json
auth-anton-x
required
string
sha256 Hash code of the body request using the webhook secret key.
Body Parameters
external_store_id
required
string
ID store on third party platform
language
required
string
Language of Store: es_EC, es_CO, es_MX
modifier_groups
required
array
modifier_groups[]
items
required
array
items[] Store items
categories
required
array
categories[] Store categories
menus
required
array
menus[] Stores Menus
Response
201: Created
Cake successfully retrieved.
{ "message": "ANY MESSAGE"}
409: Conflict
Could not find a cake matching this query.
{ "message": "ERROR MESSAGE"}
menus
schedules
periods
menus

param

type

description

name

string

name of the menu

category_external_ids

string[]

Ids of the menu categories on the POS

schedules

Schedule[]

Availability of all menu items on a specified day of week

identifier

string

menu id

schedules

param

type

description

day_of_week

enum(string)

monday, tuesday, wednesday, thursday, friday, saturday, sunday

periods

Periods[]

Sale time periods per day

periods

param

type

description

start

string

Menu availability start time (hh:mm)

end

string

Menu availability end time (hh:mm)

Category Object

category
dataItem
category

param

type

description

external_id

string

Id category on the POS

name

string

Category name to be displayed

data_items

dataItem[]

Data of the items(products) of this category in the POS

dataItem

The price of the item will only be replaced at this level when the categories are in different menus.

param

type

description

item_external_id

string

Id item on the POS (this must be the same defined in the external_id of the Item)

price

object (optional)

{ value: 5000 }

Item Object

item
price
item

param

type

description

external_id

string

Id item on the POS

name

string

Item name to be displayed

image_url

string (optional)

Url item image

schedules

schedules[]

Item availability on a specified day of week(override schedule menu)

price

price

Specifies the price to charge for ordering the item

data_modifier_groups

dataModifierGroups[]

Data of the modifier groups of this item in the POS

price

Price should always be integer value (never decilmals), include decimals in the integer value.

Example: $10.30, it would be 1030

If your currency does not handle decimals, you must add 2 zeros to the end of the integer value.

Example: 12000 COP, it would be 1200000

param

type

description

value

number

Price of the item

promotion_value

number(optional)

Promotional price of the item

ModifierGroup Object

ModifierGroup
Quantity
DataOption
ModifierGroup

param

type

description

external_id

string

Id modifier group on the POS

name

string

Modifier group name to be displayed

quantity

Quantity

Rules when selecting options in this modifier group

data_options

dataOptions[]

Modifier group options

Quantity

param

type

description

min_quantity

integer

Minimum quantity allowed (inclusive). Cannot be negative.

max_quantity

integer

Maximum quantity allowed (inclusive). Must be greater than the min_quantity

DataOption

param

type

description

item_external_id

string

Id item on the POS (this must be the same defined in the external_id of the Item)

price

Price (optional)

Override the price of the item in this context

quantity

Quantity (optional)

Rules when selecting this item option

post
TYPE: ORDER_STATUS

https://yourwebhook/for_type_order_status
Service where receive the status of order from the POS: REJECT - ACCEPT
Request
Response
Request
Headers
optional
string
sha256 hash code of the body request using the webhook secret key
Content-type
optional
string
application/json
Body Parameters
message
optional
string
a message when and order is rejected
status
required
string
ENUM: ACCEPT REJECT
order_id
required
string
Id order on the third party platform
Response
204: No Content
{"message": "ANY MESSAGE"}
409: Conflict
{"message": "ERROR MESSAGE"}