Modifiers

13 API calls in this section.

Create Modifier Group

Restaurant Menu / Modifiers

POST/restaurant/modifier-groups

Create a group of product choices, such as extras or preparation options, with selection limits and optional initial choices.

Headers

Parameter	Type	Description
Authorization	string	Example: Bearer {{access_token}}

Body parameters

Parameter	Type	Description
location_id	string	—
name	object	—
name.en	string	—
required	boolean	—
min_select	number	—
max_select	number	—
active	boolean	—
options	array<object>	—
options.name	object	—
options.name.en	string	—
options.price_delta	number	—
options.allows_quantity	boolean	—

Show 1 more body fields

Additional body parameters

Parameter	Type	Description
options.active	boolean	—

Staging

Request

curl

1curl --globoff --request POST "https://staging-api.ondi.io/functions/v1/restaurant/modifier-groups" \2  --header "Authorization: Bearer ${ONDI_ACCESS_TOKEN}" \3  --header "Content-Type: application/json" \4  --data-raw '{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}'

Replace {{placeholders}} with your own values before sending.

Response examples

No saved response example. Use Try it to inspect a staging response.

Update Modifier Group (with options upsert)

Restaurant Menu / Modifiers

PUT/restaurant/modifier-groups/:id

Change a modifier group’s name or selection rules, and create or update its supplied options.

Path parameters

Parameter	Type	Description
idRequired	string	Dynamic path value from the request URL. Dynamic path value from the request URL.

Headers

Parameter	Type	Description
Authorization	string	Example: Bearer {{access_token}}

Body parameters

Parameter	Type	Description
name	object	—
name.en	string	—
required	boolean	—
min_select	number	—
max_select	number	—
active	boolean	—
options	array<object>	—
options.id	string	—
options.name	object	—
options.name.en	string	—
options.price_delta	number	—
options.allows_quantity	boolean	—

Show 1 more body fields

Additional body parameters

Parameter	Type	Description
options.active	boolean	—

Staging

Request

curl

1curl --globoff --request PUT "https://staging-api.ondi.io/functions/v1/restaurant/modifier-groups/${ID}" \2  --header "Authorization: Bearer ${ONDI_ACCESS_TOKEN}" \3  --header "Content-Type: application/json" \4  --data-raw '{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}'

Replace {{placeholders}} with your own values before sending.

Response examples

No saved response example. Use Try it to inspect a staging response.

Create Modifier Option

Restaurant Menu / Modifiers

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

Add a choice to a modifier group, including its price adjustment and quantity behavior.

Path parameters

Parameter	Type	Description
groupIdRequired	string	Dynamic path value from the request URL. Dynamic path value from the request URL.

Headers

Parameter	Type	Description
Authorization	string	Example: Bearer {{access_token}}

Body parameters

Parameter	Type	Description
name	object	—
name.en	string	—
price_delta	number	—
allows_quantity	boolean	—
active	boolean	—

Staging

Request

curl

1curl --globoff --request POST "https://staging-api.ondi.io/functions/v1/restaurant/modifier-groups/${GROUPID}/options" \2  --header "Authorization: Bearer ${ONDI_ACCESS_TOKEN}" \3  --header "Content-Type: application/json" \4  --data-raw '{5  "name": {6    "en": "Ketchup"7  },8  "price_delta": 0,9  "allows_quantity": false,10  "active": true11}'

Response examples

No saved response example. Use Try it to inspect a staging response.

Update Modifier Option

Restaurant Menu / Modifiers

PUT/restaurant/modifier-options/:id

Change a modifier choice’s name, price adjustment, availability or quantity behavior.

Path parameters

Parameter	Type	Description
idRequired	string	Dynamic path value from the request URL. Dynamic path value from the request URL.

Headers

Parameter	Type	Description
Authorization	string	Example: Bearer {{access_token}}

Body parameters

Parameter	Type	Description
name	object	—
name.en	string	—
price_delta	number	—
allows_quantity	boolean	—
active	boolean	—

Staging

Request

curl

1curl --globoff --request PUT "https://staging-api.ondi.io/functions/v1/restaurant/modifier-options/${ID}" \2  --header "Authorization: Bearer ${ONDI_ACCESS_TOKEN}" \3  --header "Content-Type: application/json" \4  --data-raw '{5  "name": {6    "en": "Ketchup"7  },8  "price_delta": 0.25,9  "allows_quantity": true,10  "active": true11}'

Response examples

No saved response example. Use Try it to inspect a staging response.

Link Group to Product

Restaurant Menu / Modifiers

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

Make a modifier group available on a product and set its display order.

Path parameters

Parameter	Type	Description
productIdRequired	string	Dynamic path value from the request URL. Dynamic path value from the request URL.
groupIdRequired	string	Dynamic path value from the request URL. Dynamic path value from the request URL.

Headers

Parameter	Type	Description
Authorization	string	Example: Bearer {{access_token}}

Body parameters

Parameter	Type	Description
sort_order	number	—

Staging

Request

curl

1curl --globoff --request POST "https://staging-api.ondi.io/functions/v1/restaurant/products/${PRODUCTID}/modifier-groups/${GROUPID}" \2  --header "Authorization: Bearer ${ONDI_ACCESS_TOKEN}" \3  --header "Content-Type: application/json" \4  --data-raw '{5  "sort_order": 06}'

Response examples

No saved response example. Use Try it to inspect a staging response.

Unlink Group from Product

Restaurant Menu / Modifiers

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

Remove the relationship between a product and a modifier group.

Path parameters

Parameter	Type	Description
productIdRequired	string	Dynamic path value from the request URL. Dynamic path value from the request URL.
groupIdRequired	string	Dynamic path value from the request URL. Dynamic path value from the request URL.

Headers

Parameter	Type	Description
Authorization	string	Example: Bearer {{access_token}}

Staging

Request

curl

1curl --globoff --request DELETE "https://staging-api.ondi.io/functions/v1/restaurant/products/${PRODUCTID}/modifier-groups/${GROUPID}" \2  --header "Authorization: Bearer ${ONDI_ACCESS_TOKEN}"

Response examples

No saved response example. Use Try it to inspect a staging response.

Get Modifier Group (with options)

Restaurant Menu / Modifiers

GET/restaurant/modifier-groups/:id

Read a modifier group together with the choices customers can select.

Path parameters

Parameter	Type	Description
idRequired	string	Dynamic path value from the request URL. Dynamic path value from the request URL.

Headers

Parameter	Type	Description
Authorization	string	Example: Bearer {{access_token}}

Staging

Request

curl

1curl --globoff --request GET "https://staging-api.ondi.io/functions/v1/restaurant/modifier-groups/${ID}" \2  --header "Authorization: Bearer ${ONDI_ACCESS_TOKEN}"

Response examples

No saved response example. Use Try it to inspect a staging response.

List Modifier Groups (with options, by location)

Restaurant Menu / Modifiers

GET/restaurant/locations/{{location_id}}/modifier-groups

Browse a location’s modifier groups and their options before linking them to products.

Path parameters

Parameter	Type	Description
location_idRequired	string	Variable used inside the request path. Variable used inside the request path.

Query parameters

Parameter	Type	Description
page	string	Example: {{page}}
limit	string	Example: {{limit}}

Headers

Parameter	Type	Description
Authorization	string	Example: Bearer {{access_token}}

Staging

Request

curl

1curl --globoff --request GET "https://staging-api.ondi.io/functions/v1/restaurant/locations/${LOCATION_ID}/modifier-groups?page=${PAGE}&limit=${LIMIT}" \2  --header "Authorization: Bearer ${ONDI_ACCESS_TOKEN}"

Response examples

No saved response example. Use Try it to inspect a staging response.

Get Product Modifier Groups (with options)

Restaurant Menu / Modifiers

GET/restaurant/products/:productId/modifier-groups

Load the modifier groups and choices linked to one product.

Path parameters

Parameter	Type	Description
productIdRequired	string	Dynamic path value from the request URL. Dynamic path value from the request URL.

Query parameters

Parameter	Type	Description
page	string	Example: 1
limit	string	Example: 20

Headers

Parameter	Type	Description
Authorization	string	Example: Bearer {{access_token}}

Staging

Request

curl

1curl --globoff --request GET "https://staging-api.ondi.io/functions/v1/restaurant/products/${PRODUCTID}/modifier-groups?page=1&limit=20" \2  --header "Authorization: Bearer ${ONDI_ACCESS_TOKEN}"

Response examples

No saved response example. Use Try it to inspect a staging response.

Delete Modifier Group

Restaurant Menu / Modifiers

DELETE/restaurant/modifier-groups/:id

Remove a modifier group from the restaurant’s configuration.

Path parameters

Parameter	Type	Description
idRequired	string	Dynamic path value from the request URL. Dynamic path value from the request URL.

Headers

Parameter	Type	Description
Authorization	string	Example: Bearer {{access_token}}

Staging

Request

curl

1curl --globoff --request DELETE "https://staging-api.ondi.io/functions/v1/restaurant/modifier-groups/${ID}" \2  --header "Authorization: Bearer ${ONDI_ACCESS_TOKEN}"

Response examples

No saved response example. Use Try it to inspect a staging response.

Get Modifier Option

Restaurant Menu / Modifiers

GET/restaurant/modifier-options/:id

Read the details of one modifier choice before displaying or editing it.

Path parameters

Parameter	Type	Description
idRequired	string	Dynamic path value from the request URL. Dynamic path value from the request URL.

Headers

Parameter	Type	Description
Authorization	string	Example: Bearer {{access_token}}

Staging

Request

curl

1curl --globoff --request GET "https://staging-api.ondi.io/functions/v1/restaurant/modifier-options/${ID}" \2  --header "Authorization: Bearer ${ONDI_ACCESS_TOKEN}"

Response examples

No saved response example. Use Try it to inspect a staging response.

List Modifier Options (by group)

Restaurant Menu / Modifiers

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

Browse the choices belonging to one modifier group.

Path parameters

Parameter	Type	Description
groupIdRequired	string	Dynamic path value from the request URL. Dynamic path value from the request URL.

Query parameters

Parameter	Type	Description
page	string	Example: {{page}}
limit	string	Example: {{limit}}

Headers

Parameter	Type	Description
Authorization	string	Example: Bearer {{access_token}}

Staging

Request

curl

1curl --globoff --request GET "https://staging-api.ondi.io/functions/v1/restaurant/modifier-groups/${GROUPID}/options?page=${PAGE}&limit=${LIMIT}" \2  --header "Authorization: Bearer ${ONDI_ACCESS_TOKEN}"

Response examples

No saved response example. Use Try it to inspect a staging response.

Delete Modifier Option

Restaurant Menu / Modifiers

DELETE/restaurant/modifier-options/:id

Remove a choice from its modifier group.

Path parameters

Parameter	Type	Description
idRequired	string	Dynamic path value from the request URL. Dynamic path value from the request URL.

Headers

Parameter	Type	Description
Authorization	string	Example: Bearer {{access_token}}

Staging

Request

curl

1curl --globoff --request DELETE "https://staging-api.ondi.io/functions/v1/restaurant/modifier-options/${ID}" \2  --header "Authorization: Bearer ${ONDI_ACCESS_TOKEN}"

Response examples

No saved response example. Use Try it to inspect a staging response.