Modifiers

13 API calls in this section.

Create Modifier Group

Restaurant Menu / Modifiers

POST/restaurant/modifier-groups

Send a bearer token in the Authorization header for an authenticated OnDi user session.

Request

curl

1curl --request POST "$ONDI_BASE_URL/restaurant/modifier-groups" \2  --header "Authorization: Bearer {{access_token}}" \3  --header "Content-Type: application/json" \4  --data '{5  "location_id": "{{location_id}}",6  "name": {7    "en": "Sauces"8  },9  "required": false,10  "min_select": 0,11  "max_select": 2,12  "active": true,13  "options": [14    {15      "name": {16        "en": "Ketchup"17      },18      "price_delta": 0,19      "allows_quantity": false,20      "active": true21    },22    {23      "name": {24        "en": "Mayo"25      },26      "price_delta": 0.2,27      "allows_quantity": false,28      "active": true29    }30  ]31}'

Request body

json

1{2  "location_id": "{{location_id}}",3  "name": {4    "en": "Sauces"5  },6  "required": false,7  "min_select": 0,8  "max_select": 2,9  "active": true,10  "options": [11    {12      "name": {13        "en": "Ketchup"14      },15      "price_delta": 0,16      "allows_quantity": false,17      "active": true18    },19    {20      "name": {21        "en": "Mayo"22      },23      "price_delta": 0.2,24      "allows_quantity": false,25      "active": true26    }27  ]28}

Request body fields

location_idExample

string

Example field from the request body.

nameExample

object

Example field from the request body.

name.enExample

string

Example field from the request body.

requiredExample

boolean

Example field from the request body.

min_selectExample

number

Example field from the request body.

max_selectExample

number

Example field from the request body.

activeExample

boolean

Example field from the request body.

optionsExample

array<object>

Example field from the request body.

options.nameExample

object

Example field from the request body.

options.name.enExample

string

Example field from the request body.

options.price_deltaExample

number

Example field from the request body.

options.allows_quantityExample

boolean

Example field from the request body.

options.activeExample

boolean

Example field from the request body.

Headers

AuthorizationOptional

header string

Bearer {{access_token}}

Responses

No response example is available for this endpoint yet.

Update Modifier Group (with options upsert)

Restaurant Menu / Modifiers

PUT/restaurant/modifier-groups/:id

Send a bearer token in the Authorization header for an authenticated OnDi user session.

Request

curl

1curl --request PUT "$ONDI_BASE_URL/restaurant/modifier-groups/:id" \2  --header "Authorization: Bearer {{access_token}}" \3  --header "Content-Type: application/json" \4  --data '{5  "name": {6    "en": "Sauces"7  },8  "required": true,9  "min_select": 1,10  "max_select": 2,11  "active": true,12  "options": [13    {14      "id": "{{option_id_1}}",15      "name": {16        "en": "Ketchup"17      },18      "price_delta": 0.1,19      "allows_quantity": false,20      "active": true21    },22    {23      "name": {24        "en": "BBQ"25      },26      "price_delta": 0.3,27      "allows_quantity": false,28      "active": true29    }30  ]31}'

Request body

json

1{2  "name": {3    "en": "Sauces"4  },5  "required": true,6  "min_select": 1,7  "max_select": 2,8  "active": true,9  "options": [10    {11      "id": "{{option_id_1}}",12      "name": {13        "en": "Ketchup"14      },15      "price_delta": 0.1,16      "allows_quantity": false,17      "active": true18    },19    {20      "name": {21        "en": "BBQ"22      },23      "price_delta": 0.3,24      "allows_quantity": false,25      "active": true26    }27  ]28}

Path parameters

idRequired

path string

Request body fields

nameExample

object

Example field from the request body.

name.enExample

string

Example field from the request body.

requiredExample

boolean

Example field from the request body.

min_selectExample

number

Example field from the request body.

max_selectExample

number

Example field from the request body.

activeExample

boolean

Example field from the request body.

optionsExample

array<object>

Example field from the request body.

options.idExample

string

Example field from the request body.

options.nameExample

object

Example field from the request body.

options.name.enExample

string

Example field from the request body.

options.price_deltaExample

number

Example field from the request body.

options.allows_quantityExample

boolean

Example field from the request body.

options.activeExample

boolean

Example field from the request body.

Headers

AuthorizationOptional

header string

Bearer {{access_token}}

Responses

No response example is available for this endpoint yet.

Create Modifier Option

Restaurant Menu / Modifiers

POST/restaurant/modifier-groups/:groupId/options

Send a bearer token in the Authorization header for an authenticated OnDi user session.

Request

curl

1curl --request POST "$ONDI_BASE_URL/restaurant/modifier-groups/:groupId/options" \2  --header "Authorization: Bearer {{access_token}}" \3  --header "Content-Type: application/json" \4  --data '{5  "name": {6    "en": "Ketchup"7  },8  "price_delta": 0,9  "allows_quantity": false,10  "active": true11}'

Request body

json

1{2  "name": {3    "en": "Ketchup"4  },5  "price_delta": 0,6  "allows_quantity": false,7  "active": true8}

Path parameters

groupIdRequired

path string

Request body fields

nameExample

object

Example field from the request body.

name.enExample

string

Example field from the request body.

price_deltaExample

number

Example field from the request body.

allows_quantityExample

boolean

Example field from the request body.

activeExample

boolean

Example field from the request body.

Headers

AuthorizationOptional

header string

Bearer {{access_token}}

Responses

No response example is available for this endpoint yet.

Update Modifier Option

Restaurant Menu / Modifiers

PUT/restaurant/modifier-options/:id

Send a bearer token in the Authorization header for an authenticated OnDi user session.

Request

curl

1curl --request PUT "$ONDI_BASE_URL/restaurant/modifier-options/:id" \2  --header "Authorization: Bearer {{access_token}}" \3  --header "Content-Type: application/json" \4  --data '{5  "name": {6    "en": "Ketchup"7  },8  "price_delta": 0.25,9  "allows_quantity": true,10  "active": true11}'

Request body

json

1{2  "name": {3    "en": "Ketchup"4  },5  "price_delta": 0.25,6  "allows_quantity": true,7  "active": true8}

Path parameters

idRequired

path string

Request body fields

nameExample

object

Example field from the request body.

name.enExample

string

Example field from the request body.

price_deltaExample

number

Example field from the request body.

allows_quantityExample

boolean

Example field from the request body.

activeExample

boolean

Example field from the request body.

Headers

AuthorizationOptional

header string

Bearer {{access_token}}

Responses

No response example is available for this endpoint yet.

Link Group to Product

Restaurant Menu / Modifiers

POST/restaurant/products/:productId/modifier-groups/:groupId

Send a bearer token in the Authorization header for an authenticated OnDi user session.

Request

curl

1curl --request POST "$ONDI_BASE_URL/restaurant/products/:productId/modifier-groups/:groupId" \2  --header "Authorization: Bearer {{access_token}}" \3  --header "Content-Type: application/json" \4  --data '{5  "sort_order": 06}'

Request body

json

1{2  "sort_order": 03}

Path parameters

productIdRequired

path string

groupIdRequired

path string

Request body fields

sort_orderExample

number

Example field from the request body.

Headers

AuthorizationOptional

header string

Bearer {{access_token}}

Responses

No response example is available for this endpoint yet.

Unlink Group from Product

Restaurant Menu / Modifiers

DELETE/restaurant/products/:productId/modifier-groups/:groupId

Send a bearer token in the Authorization header for an authenticated OnDi user session.

Request

curl

1curl --request DELETE "$ONDI_BASE_URL/restaurant/products/:productId/modifier-groups/:groupId" \2  --header "Authorization: Bearer {{access_token}}"

Path parameters

productIdRequired

path string

groupIdRequired

path string

Headers

AuthorizationOptional

header string

Bearer {{access_token}}

Responses

No response example is available for this endpoint yet.

Get Modifier Group (with options)

Restaurant Menu / Modifiers

GET/restaurant/modifier-groups/:id

Send a bearer token in the Authorization header for an authenticated OnDi user session.

Request

curl

1curl --request GET "$ONDI_BASE_URL/restaurant/modifier-groups/:id" \2  --header "Authorization: Bearer {{access_token}}"

Path parameters

idRequired

path string

Headers

AuthorizationOptional

header string

Bearer {{access_token}}

Responses

No response example is available for this endpoint yet.

List Modifier Groups (with options, by location)

Restaurant Menu / Modifiers

GET/restaurant/locations/{{location_id}}/modifier-groups?page={{page}}&limit={{limit}}

Send a bearer token in the Authorization header for an authenticated OnDi user session.

Request

curl

1curl --request GET "$ONDI_BASE_URL/restaurant/locations/{{location_id}}/modifier-groups?page={{page}}&limit={{limit}}" \2  --header "Authorization: Bearer {{access_token}}"

Path parameters

location_idRequired

path string

Variable used inside the request path.

Query parameters

pageOptional

query string

{{page}}

limitOptional

query string

{{limit}}

Headers

AuthorizationOptional

header string

Bearer {{access_token}}

Responses

No response example is available for this endpoint yet.

Get Product Modifier Groups (with options)

Restaurant Menu / Modifiers

GET/restaurant/products/:productId/modifier-groups?page=1&limit=20

Send a bearer token in the Authorization header for an authenticated OnDi user session.

Request

curl

1curl --request GET "$ONDI_BASE_URL/restaurant/products/:productId/modifier-groups?page=1&limit=20" \2  --header "Authorization: Bearer {{access_token}}"

Path parameters

productIdRequired

path string

Query parameters

pageOptional

query string

1

limitOptional

query string

20

Headers

AuthorizationOptional

header string

Bearer {{access_token}}

Responses

No response example is available for this endpoint yet.

Delete Modifier Group

Restaurant Menu / Modifiers

DELETE/restaurant/modifier-groups/:id

Send a bearer token in the Authorization header for an authenticated OnDi user session.

Request

curl

1curl --request DELETE "$ONDI_BASE_URL/restaurant/modifier-groups/:id" \2  --header "Authorization: Bearer {{access_token}}"

Path parameters

idRequired

path string

Headers

AuthorizationOptional

header string

Bearer {{access_token}}

Responses

No response example is available for this endpoint yet.

Get Modifier Option

Restaurant Menu / Modifiers

GET/restaurant/modifier-options/:id

Send a bearer token in the Authorization header for an authenticated OnDi user session.

Request

curl

1curl --request GET "$ONDI_BASE_URL/restaurant/modifier-options/:id" \2  --header "Authorization: Bearer {{access_token}}"

Path parameters

idRequired

path string

Headers

AuthorizationOptional

header string

Bearer {{access_token}}

Responses

No response example is available for this endpoint yet.

List Modifier Options (by group)

Restaurant Menu / Modifiers

GET/restaurant/modifier-groups/:groupId/options?page={{page}}&limit={{limit}}

Send a bearer token in the Authorization header for an authenticated OnDi user session.

Request

curl

1curl --request GET "$ONDI_BASE_URL/restaurant/modifier-groups/:groupId/options?page={{page}}&limit={{limit}}" \2  --header "Authorization: Bearer {{access_token}}"

Path parameters

groupIdRequired

path string

Query parameters

pageOptional

query string

{{page}}

limitOptional

query string

{{limit}}

Headers

AuthorizationOptional

header string

Bearer {{access_token}}

Responses

No response example is available for this endpoint yet.

Delete Modifier Option

Restaurant Menu / Modifiers

DELETE/restaurant/modifier-options/:id

Send a bearer token in the Authorization header for an authenticated OnDi user session.

Request

curl

1curl --request DELETE "$ONDI_BASE_URL/restaurant/modifier-options/:id" \2  --header "Authorization: Bearer {{access_token}}"

Path parameters

idRequired

path string

Headers

AuthorizationOptional

header string

Bearer {{access_token}}

Responses

No response example is available for this endpoint yet.