Create a modifier group

curl --request POST \
  --url https://api.dev.shadowchef.co/v1/partner/menus/modifier-groups \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": {
    "en": "Size",
    "id": "Ukuran"
  },
  "description": {
    "en": "Pick one"
  },
  "isEnabled": true,
  "visibilities": {
    "1": true
  },
  "min": 1,
  "max": 1,
  "fromAPI": true
}
'

const url = 'https://api.dev.shadowchef.co/v1/partner/menus/modifier-groups';
const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    title: {en: 'Size', id: 'Ukuran'},
    description: {en: 'Pick one'},
    isEnabled: true,
    visibilities: {'1': true},
    min: 1,
    max: 1,
    fromAPI: true
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "https://api.dev.shadowchef.co/v1/partner/menus/modifier-groups"

payload = {
    "title": {
        "en": "Size",
        "id": "Ukuran"
    },
    "description": { "en": "Pick one" },
    "isEnabled": True,
    "visibilities": { "1": True },
    "min": 1,
    "max": 1,
    "fromAPI": True
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

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

print(response.text)

package main

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

func main() {

	url := "https://api.dev.shadowchef.co/v1/partner/menus/modifier-groups"

	payload := strings.NewReader("{\n  \"title\": {\n    \"en\": \"Size\",\n    \"id\": \"Ukuran\"\n  },\n  \"description\": {\n    \"en\": \"Pick one\"\n  },\n  \"isEnabled\": true,\n  \"visibilities\": {\n    \"1\": true\n  },\n  \"min\": 1,\n  \"max\": 1,\n  \"fromAPI\": true\n}")

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

	req.Header.Add("Authorization", "Basic <encoded-value>")
	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))

}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.dev.shadowchef.co/v1/partner/menus/modifier-groups",
  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([
    'title' => [
        'en' => 'Size',
        'id' => 'Ukuran'
    ],
    'description' => [
        'en' => 'Pick one'
    ],
    'isEnabled' => true,
    'visibilities' => [
        '1' => true
    ],
    'min' => 1,
    'max' => 1,
    'fromAPI' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

{
  "request_id": "req_4d1b7e3f-1f06-4d3c-a14f-9c0b9f8a3e2c",
  "data": {
    "id": 1549
  }
}

{
  "request_id": "req_4d1b7e3f-...",
  "data": "<unknown>",
  "error": {
    "code": "request_invalid",
    "message": "<string>",
    "details": "<unknown>"
  }
}

POST

partner

menus

modifier-groups

Create a modifier group

curl --request POST \
  --url https://api.dev.shadowchef.co/v1/partner/menus/modifier-groups \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": {
    "en": "Size",
    "id": "Ukuran"
  },
  "description": {
    "en": "Pick one"
  },
  "isEnabled": true,
  "visibilities": {
    "1": true
  },
  "min": 1,
  "max": 1,
  "fromAPI": true
}
'

const url = 'https://api.dev.shadowchef.co/v1/partner/menus/modifier-groups';
const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    title: {en: 'Size', id: 'Ukuran'},
    description: {en: 'Pick one'},
    isEnabled: true,
    visibilities: {'1': true},
    min: 1,
    max: 1,
    fromAPI: true
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "https://api.dev.shadowchef.co/v1/partner/menus/modifier-groups"

payload = {
    "title": {
        "en": "Size",
        "id": "Ukuran"
    },
    "description": { "en": "Pick one" },
    "isEnabled": True,
    "visibilities": { "1": True },
    "min": 1,
    "max": 1,
    "fromAPI": True
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

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

print(response.text)

package main

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

func main() {

	url := "https://api.dev.shadowchef.co/v1/partner/menus/modifier-groups"

	payload := strings.NewReader("{\n  \"title\": {\n    \"en\": \"Size\",\n    \"id\": \"Ukuran\"\n  },\n  \"description\": {\n    \"en\": \"Pick one\"\n  },\n  \"isEnabled\": true,\n  \"visibilities\": {\n    \"1\": true\n  },\n  \"min\": 1,\n  \"max\": 1,\n  \"fromAPI\": true\n}")

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

	req.Header.Add("Authorization", "Basic <encoded-value>")
	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))

}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.dev.shadowchef.co/v1/partner/menus/modifier-groups",
  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([
    'title' => [
        'en' => 'Size',
        'id' => 'Ukuran'
    ],
    'description' => [
        'en' => 'Pick one'
    ],
    'isEnabled' => true,
    'visibilities' => [
        '1' => true
    ],
    'min' => 1,
    'max' => 1,
    'fromAPI' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

{
  "request_id": "req_4d1b7e3f-1f06-4d3c-a14f-9c0b9f8a3e2c",
  "data": {
    "id": 1549
  }
}

{
  "request_id": "req_4d1b7e3f-...",
  "data": "<unknown>",
  "error": {
    "code": "request_invalid",
    "message": "<string>",
    "details": "<unknown>"
  }
}

Authorizations

Authorization

string

header

required

Authorization: Basic base64(partner_key:secret_key).

Credentials are issued by a klikit operator. The plaintext secret_key is shown once at issuance and cannot be retrieved later — store it securely. If lost, ask your operator to rotate the secret to receive a new one. The old secret stops working immediately on rotation; there is no overlap window.

Body

application/json

title

object

required

Locale-keyed text. Keys are ISO 639-1 codes (en, id, ja, ...). Use whichever key matches your storefront; klikit ships a value for every locale your business is configured for.

Show child attributes

Example:

{ "en": "Margherita", "id": "Margherita" }

max

integer

required

Maximum number of modifiers a customer may pick. Required.

description

object

Locale-keyed text. Keys are ISO 639-1 codes (en, id, ja, ...). Use whichever key matches your storefront; klikit ships a value for every locale your business is configured for.

Show child attributes

Example:

{ "en": "Margherita", "id": "Margherita" }

isEnabled

boolean

default:true

visibilities

object

Per-provider visibility flag. Keys are provider ids (as strings) from GET /v1/partner/providers. Set a provider's value to true to publish on that channel. Providers absent from the map default to hidden.

Klikit's own marketplace is provider id "1".

Show child attributes

Example:

{ "1": true, "6": true }

min

integer

default:0

Minimum number of modifiers a customer must pick.

fromAPI

boolean

default:true

Response

Modifier group created. data.id is the modifier-group id.

Canonical response wrapper. Every response — success or error — carries the request_id so you can quote one id to klikit support to correlate a request end-to-end.

request_id

string

required

Example:

"req_4d1b7e3f-..."

data

any

Endpoint-specific payload on success.

error

object

Machine-readable error code + human message. The code is stable across releases — switch on code in your client code rather than parsing the message text.

Common codes you will encounter as a partner:

Code	HTTP	Meaning
`auth_missing`	401	Authorization header absent / malformed
`auth_invalid_credential`	401	partner_key or secret_key did not verify
`auth_revoked`	403	Credential is revoked
`auth_forbidden`	403	Credential not authorized for the requested scope
`request_invalid`	400	Body / query parameters failed validation
`request_missing_idempotency_key`	400	Write endpoint called without `Idempotency-Key`
`request_invalid_range`	400	Date range > 90 days
`resource_not_found`	404	Order / store / mapping does not exist
`resource_unmapped`	404	Stock / availability call referenced an unknown SKU
`state_invalid_transition`	409	Order PATCH not allowed by current state
`state_idempotency_conflict`	409	Same Idempotency-Key reused with a different body
`rate_limit_exceeded`	429	Per-credential rate cap hit
`downstream_unavailable`	502	An internal klikit dependency is unreachable

Show child attributes

Get started

Core concepts

Webhooks

Reference receivers

API reference

Create a modifier group

Authorizations

Body

Response