Get List Of Modifier Groups
curl --request GET \
--globoff \
--url 'https://api.example.com/{{micro_service_base_url}}/inventory/stores/{{store_id}}/modifier-groups/'import requests
url = "https://api.example.com/{{micro_service_base_url}}/inventory/stores/{{store_id}}/modifier-groups/"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/{{micro_service_base_url}}/inventory/stores/{{store_id}}/modifier-groups/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/{{micro_service_base_url}}/inventory/stores/{{store_id}}/modifier-groups/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/{{micro_service_base_url}}/inventory/stores/{{store_id}}/modifier-groups/"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/{{micro_service_base_url}}/inventory/stores/{{store_id}}/modifier-groups/")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/{{micro_service_base_url}}/inventory/stores/{{store_id}}/modifier-groups/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"modifier_groups": [
{
"id": "<string>",
"name": "<string>",
"min_quantity": 123,
"max_quantity": 123,
"precedence": 123,
"option_type": "<string>",
"max_free_options": 123,
"max_options_qty": 123,
"status": "<string>",
"linked_options": "<string>",
"linked_items": "<string>"
}
]
}Modifiers
Get List Of Modifier Groups
This endpoint retrieves a list of all modifier groups for a specific store, with options for filtering, searching, and pagination.
GET
{micro_service_base_url}
/
inventory
/
stores
/
{store_id}
/
modifier-groups
/
Get List Of Modifier Groups
curl --request GET \
--globoff \
--url 'https://api.example.com/{{micro_service_base_url}}/inventory/stores/{{store_id}}/modifier-groups/'import requests
url = "https://api.example.com/{{micro_service_base_url}}/inventory/stores/{{store_id}}/modifier-groups/"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/{{micro_service_base_url}}/inventory/stores/{{store_id}}/modifier-groups/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/{{micro_service_base_url}}/inventory/stores/{{store_id}}/modifier-groups/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/{{micro_service_base_url}}/inventory/stores/{{store_id}}/modifier-groups/"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/{{micro_service_base_url}}/inventory/stores/{{store_id}}/modifier-groups/")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/{{micro_service_base_url}}/inventory/stores/{{store_id}}/modifier-groups/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"modifier_groups": [
{
"id": "<string>",
"name": "<string>",
"min_quantity": 123,
"max_quantity": 123,
"precedence": 123,
"option_type": "<string>",
"max_free_options": 123,
"max_options_qty": 123,
"status": "<string>",
"linked_options": "<string>",
"linked_items": "<string>"
}
]
}This endpoint returns a comprehensive list of modifier groups configured for your store. You can filter by status, search by name, and control the ordering of results to find specific modifier groups quickly.
This endpoint provides an overview of all your customization options, helping you manage and organize your menu modifiers effectively.
Path Parameters
string
required
The unique identifier of the store
Query Parameters
number
default:0
Number of records to skip for pagination
string
Search term to filter modifier groups by name
string
default:"ASC"
Sort order for results. Values: “ASC” or “DESC”
string
Filter by modifier group status. Values: “active” or “inactive”
Response
array
Array of modifier group objects
Show Modifier Group Object
Show Modifier Group Object
string
Unique identifier for the modifier group
string
Name of the modifier group
number
Minimum number of options customer must select
number
Maximum number of options customer can select
number
Display order precedence
string
Type of options in this group
number
Maximum number of free options allowed
number
Maximum quantity for each option
string
Current status of the modifier group
string
Comma-separated list of linked option names
string
Comma-separated list of linked item names
Response Example
[
{
"id": "1000054",
"name": "Choose your Sandwich Type",
"min_quantity": 1,
"max_quantity": 1,
"precedence": 0,
"option_type": "Customization",
"max_free_options": 0,
"max_options_qty": null,
"status": "active",
"linked_options": "Small,Large,Wrap",
"linked_items": "Build Your Own Sandwich,Build Your Own Sandwich,Build Your Own Sandwich"
},
{
"id": "1000055",
"name": "Choice of Meat",
"min_quantity": 1,
"max_quantity": 1,
"precedence": 0,
"option_type": "Customization",
"max_free_options": 0,
"max_options_qty": null,
"status": "active",
"linked_options": "Egg Salad,Roast Beef,Honey Ham,Turkey,Salami,Crandberry Walnut Chicken Salad,In-Store Made Chicken Salad,Buffalo Style Chicken Salad,Tuna Salad",
"linked_items": "Build Your Own Sandwich,Build Your Own Sandwich,Build Your Own Sandwich,Build Your Own Sandwich,Build Your Own Sandwich,Build Your Own Sandwich,Build Your Own Sandwich,Build Your Own Sandwich,Build Your Own Sandwich"
}
]
Use the search_string parameter to quickly find specific modifier groups by name. The status filter helps you view only active or inactive groups.
The linked_options and linked_items fields provide a quick overview of what’s connected to each modifier group without needing additional API calls.

