Skip to main content
POST
{micro_service_base_url}
/
inventory
/
stores
/
{store_id}
/
modifier-groups
/
{modifier_group_id}
/
options
Create Modifier Group Options
curl --request POST \
  --url 'https://api.example.com/{{micro_service_base_url}}/inventory/stores/{{store_id}}/modifier-groups/{{modifier_group_id}}/options' \
  --header 'Content-Type: application/json' \
  --data '
{
  "options": [
    {}
  ]
}
'
import requests

url = "https://api.example.com/{{micro_service_base_url}}/inventory/stores/{{store_id}}/modifier-groups/{{modifier_group_id}}/options"

payload = { "options": [{}] }
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({options: [{}]})
};

fetch('https://api.example.com/{{micro_service_base_url}}/inventory/stores/{{store_id}}/modifier-groups/{{modifier_group_id}}/options', 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/{{modifier_group_id}}/options",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'options' => [
[

]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.example.com/{{micro_service_base_url}}/inventory/stores/{{store_id}}/modifier-groups/{{modifier_group_id}}/options"

payload := strings.NewReader("{\n \"options\": [\n {}\n ]\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.example.com/{{micro_service_base_url}}/inventory/stores/{{store_id}}/modifier-groups/{{modifier_group_id}}/options")
.header("Content-Type", "application/json")
.body("{\n \"options\": [\n {}\n ]\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/{{micro_service_base_url}}/inventory/stores/{{store_id}}/modifier-groups/{{modifier_group_id}}/options")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"options\": [\n {}\n ]\n}"

response = http.request(request)
puts response.read_body
{
  "options": [
    {
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "external_id": "<string>",
      "id": "<string>",
      "store_item_id": "<string>",
      "modifier_group_id": "<string>",
      "price": "<string>",
      "status": "<string>",
      "precedence": 123,
      "default_qty": 123,
      "deletedAt": "<string>"
    }
  ]
}
This endpoint creates new options within an existing modifier group. Each option represents a specific choice that customers can make when customizing their order, such as “Small”, “Medium”, “Large” for a size modifier group.
Options must be associated with existing store items and modifier groups.

Path Parameters

store_id
string
required
The unique identifier of the store
modifier_group_id
string
required
The unique identifier of the modifier group

Body

options
array
required
Array of modifier option objects to create

Request Example

[
  {
    "store_item_id": "3e3e0adb-5555-4832-9632-8bb71d861281",
    "modifier_group_id": "{{modifier_group_id}}",
    "price": 0,
    "status": "active"
  }
]

Response

options
array
Array of created modifier option objects

Response Example

[
  {
    "createdAt": "2024-04-24T07:41:30.249Z",
    "updatedAt": "2024-04-24T07:41:30.249Z",
    "external_id": "ac873a62-7370-488f-9f09-d83d4ca932d8",
    "id": "1000008",
    "store_item_id": "3e3e0adb-5555-4832-9632-8bb71d861281",
    "modifier_group_id": "1000000",
    "price": "0.00",
    "status": "active",
    "precedence": 0,
    "default_qty": 0,
    "deletedAt": null
  }
]
Set price to 0 for options that don’t add extra cost. Use positive values for premium options or add-ons.
Ensure the store_item_id exists in your inventory before creating the option.