Fetch the menu tree (store-level or business-level)

curl --request GET \
  --url https://api.dev.shadowchef.co/v1/partner/menus \
  --header 'Authorization: Basic <encoded-value>'

const url = 'https://api.dev.shadowchef.co/v1/partner/menus';
const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

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

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Basic <encoded-value>")

	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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>"
  ],
]);

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

curl_close($curl);

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

{
  "request_id": "0af0f90815518ac157c838fd0e07ed5a",
  "data": {
    "menu": {
      "branchInfo": {
        "branchID": 1293,
        "brandID": 5297,
        "businessID": 398,
        "countryID": 4,
        "currencyCode": "IDR",
        "currencyID": 4,
        "currencySymbol": "",
        "languageCode": "id",
        "providerIDs": "1,6,9,11,16,17"
      },
      "sections": [
        {
          "id": 6825,
          "sequence": 1,
          "title": {
            "en": "Cimol Bojot AA Master Menu"
          },
          "description": {},
          "enabled": true,
          "image": "",
          "isMealForOne": false,
          "visibilities": {
            "1": true
          },
          "availableTimes": {
            "0": {
              "disabled": false,
              "slots": [
                {
                  "startTime": 0,
                  "endTime": 2359
                }
              ]
            },
            "1": {
              "disabled": false,
              "slots": [
                {
                  "startTime": 0,
                  "endTime": 2359
                }
              ]
            },
            "2": {
              "disabled": false,
              "slots": [
                {
                  "startTime": 0,
                  "endTime": 2359
                }
              ]
            },
            "3": {
              "disabled": false,
              "slots": [
                {
                  "startTime": 0,
                  "endTime": 2359
                }
              ]
            },
            "4": {
              "disabled": false,
              "slots": [
                {
                  "startTime": 0,
                  "endTime": 2359
                }
              ]
            },
            "5": {
              "disabled": false,
              "slots": [
                {
                  "startTime": 0,
                  "endTime": 2359
                }
              ]
            },
            "6": {
              "disabled": false,
              "slots": [
                {
                  "startTime": 0,
                  "endTime": 2359
                }
              ]
            }
          },
          "blackoutDates": null,
          "categories": [
            {
              "id": 39114,
              "sequence": 1,
              "title": {
                "en": "Cimol Bundling"
              },
              "description": {},
              "enabled": true,
              "alcBeverages": false,
              "blackoutDates": null,
              "consentMessage": {},
              "isAgeRestricted": false,
              "isGrabMealForOne": false,
              "isHalal": false,
              "isIdVerificationRequired": false,
              "isMealForOne": false,
              "visibilities": {
                "1": true
              },
              "items": [
                {
                  "id": 289370,
                  "sequence": 1,
                  "title": {
                    "en": "Cimol Bundling 1"
                  },
                  "description": {
                    "en": "Paket Bundling: - Cimol Bojot Porsi Kecil Isi ±100 Gram - Cimol Mozzarella Porsi Besar Isi 16 Pcs atau Cimol Ayam/Beef Porsi Besar Isi 14 Pcs"
                  },
                  "enabled": true,
                  "itemIsEnabled": true,
                  "isGrabMealForOne": false,
                  "isHalal": false,
                  "maxQuantityPerDay": 1,
                  "preparationTime": 0,
                  "skuID": "",
                  "stockEnabled": false,
                  "yieldCount": 1,
                  "vat": 0,
                  "allergenIDs": null,
                  "allergens": null,
                  "blackoutDates": null,
                  "groups": [],
                  "itemVisibilities": {
                    "1": true
                  },
                  "visibilities": {
                    "1": true
                  },
                  "oos": {
                    "available": true,
                    "snooze": null
                  },
                  "prices": {
                    "1": {
                      "IDR": {
                        "price": 25000,
                        "takeAwayPrice": 25000
                      }
                    }
                  },
                  "resources": []
                }
              ]
            }
          ]
        }
      ]
    }
  }
}

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

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

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

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

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

menus

Fetch the menu tree (store-level or business-level)

Returns a 4-level menu tree (sections → categories → items → modifier groups → modifiers) scoped to your credential’s business. Two modes, selected by whether you supply the store coordinates:

Store-level (`brand_id` + `branch_id` both present)

Returns the per-store snapshot served from the cached store_full_menus blob. Reflects every per-store override written via zoneStores plus the latest publishMenu. This is the same payload klikit ships to aggregator marketplaces.

The envelope is data.menu.branchInfo + data.menu.sections[]. Each section / category / item carries fields like isAvailable, stockEnabled, attachedWithStore derived from the store’s overrides.

Business-level (`brand_id` and `branch_id` both omitted)

Returns the business-level tree with no store overrides applied — the raw shape sitting in the sections / categories / items / modifier_groups tables before any store has populated.

partner-api assembles this on the fly by walking the four list endpoints in parallel and joining them client-side, so the payload is a superset of what those endpoints return:

listSections for the top of the tree (each section carries linkedCategories[] ids).
listCategories supplies the category records.
listItems supplies items (top-level
- modifier options — modifier options are items with onlyModifier: true).
listModifierGroups supplies the MG records.

The envelope is data.menu.businessInfo + data.menu.sections[]. Store-specific fields (isAvailable, attachedWithStore, …) are absent because there’s no store context.

Errors

Passing only one of brand_id / branch_id returns 400 request_invalid. Either both together (store mode) or neither (business mode).
Store-mode 404 when (brand_id, branch_id) doesn’t resolve to one of your business’s stores.

Both modes use the same menus:read scope.

GET

partner

menus

Fetch the menu tree (store-level or business-level)

curl --request GET \
  --url https://api.dev.shadowchef.co/v1/partner/menus \
  --header 'Authorization: Basic <encoded-value>'

const url = 'https://api.dev.shadowchef.co/v1/partner/menus';
const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

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

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Basic <encoded-value>")

	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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>"
  ],
]);

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

curl_close($curl);

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

{
  "request_id": "0af0f90815518ac157c838fd0e07ed5a",
  "data": {
    "menu": {
      "branchInfo": {
        "branchID": 1293,
        "brandID": 5297,
        "businessID": 398,
        "countryID": 4,
        "currencyCode": "IDR",
        "currencyID": 4,
        "currencySymbol": "",
        "languageCode": "id",
        "providerIDs": "1,6,9,11,16,17"
      },
      "sections": [
        {
          "id": 6825,
          "sequence": 1,
          "title": {
            "en": "Cimol Bojot AA Master Menu"
          },
          "description": {},
          "enabled": true,
          "image": "",
          "isMealForOne": false,
          "visibilities": {
            "1": true
          },
          "availableTimes": {
            "0": {
              "disabled": false,
              "slots": [
                {
                  "startTime": 0,
                  "endTime": 2359
                }
              ]
            },
            "1": {
              "disabled": false,
              "slots": [
                {
                  "startTime": 0,
                  "endTime": 2359
                }
              ]
            },
            "2": {
              "disabled": false,
              "slots": [
                {
                  "startTime": 0,
                  "endTime": 2359
                }
              ]
            },
            "3": {
              "disabled": false,
              "slots": [
                {
                  "startTime": 0,
                  "endTime": 2359
                }
              ]
            },
            "4": {
              "disabled": false,
              "slots": [
                {
                  "startTime": 0,
                  "endTime": 2359
                }
              ]
            },
            "5": {
              "disabled": false,
              "slots": [
                {
                  "startTime": 0,
                  "endTime": 2359
                }
              ]
            },
            "6": {
              "disabled": false,
              "slots": [
                {
                  "startTime": 0,
                  "endTime": 2359
                }
              ]
            }
          },
          "blackoutDates": null,
          "categories": [
            {
              "id": 39114,
              "sequence": 1,
              "title": {
                "en": "Cimol Bundling"
              },
              "description": {},
              "enabled": true,
              "alcBeverages": false,
              "blackoutDates": null,
              "consentMessage": {},
              "isAgeRestricted": false,
              "isGrabMealForOne": false,
              "isHalal": false,
              "isIdVerificationRequired": false,
              "isMealForOne": false,
              "visibilities": {
                "1": true
              },
              "items": [
                {
                  "id": 289370,
                  "sequence": 1,
                  "title": {
                    "en": "Cimol Bundling 1"
                  },
                  "description": {
                    "en": "Paket Bundling: - Cimol Bojot Porsi Kecil Isi ±100 Gram - Cimol Mozzarella Porsi Besar Isi 16 Pcs atau Cimol Ayam/Beef Porsi Besar Isi 14 Pcs"
                  },
                  "enabled": true,
                  "itemIsEnabled": true,
                  "isGrabMealForOne": false,
                  "isHalal": false,
                  "maxQuantityPerDay": 1,
                  "preparationTime": 0,
                  "skuID": "",
                  "stockEnabled": false,
                  "yieldCount": 1,
                  "vat": 0,
                  "allergenIDs": null,
                  "allergens": null,
                  "blackoutDates": null,
                  "groups": [],
                  "itemVisibilities": {
                    "1": true
                  },
                  "visibilities": {
                    "1": true
                  },
                  "oos": {
                    "available": true,
                    "snooze": null
                  },
                  "prices": {
                    "1": {
                      "IDR": {
                        "price": 25000,
                        "takeAwayPrice": 25000
                      }
                    }
                  },
                  "resources": []
                }
              ]
            }
          ]
        }
      ]
    }
  }
}

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

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

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

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

{
  "request_id": "req_4d1b7e3f-...",
  "data": "<unknown>",
  "error": {
    "code": "downstream_unavailable",
    "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.

Query Parameters

brand_id

integer

Brand id of the target store. Required when branch_id is also passed. Omit (along with branch_id) to read the business-level tree.

Required range: x >= 1

branch_id

integer

Branch id of the target store. Required when brand_id is also passed. Omit (along with brand_id) to read the business-level tree.

Required range: x >= 1

string

Optional IANA timezone used to compute availability flags.

Example:

"Asia/Singapore"

Response

Menu tree. The example below is one section / one category / one item sliced verbatim from a prod store-mode response (brand 5297, branch 1293). Business-mode responses share the same shape and key names but with a much larger tree (no trimming applied server-side); the full payload weighs in at several MB on real businesses, so partners should expect to stream-parse if pulling business mode.

The data.menu payload is a recursive tree:

menu
├── branchInfo            store-level metadata (currency, language)
└── sections[]
    └── categories[]
        └── items[]
            └── groups[]          modifier GROUPS (e.g. "Size")
                └── modifiers[]   modifier OPTIONS (e.g. "Large")
                    └── groups[]  nested groups, for stacked modifiers

On the wire the modifier-group key is groups; modifier options are under modifiers. A modifier (option) carries the same shape as a regular item — id, title, price, visibilities, image, plus its own groups array, so combos like pizza → size → toppings nest naturally. Map your SKUs to the id you see at each level.

Most fields are language maps keyed by locale code ({"en": "...", "id": "..."}) so the same payload serves multiple storefronts.

request_id

string

required

Example:

"req_4d1b7e3f-..."

data

object

Endpoint-specific payload on success.

Show child attributes

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

Fetch the menu tree (store-level or business-level)

Store-level (`brand_id` + `branch_id` both present)

Business-level (`brand_id` and `branch_id` both omitted)

Errors

Authorizations

Query Parameters

Response