Skip to main content
This walk-through assumes you have a klikit partner API key and secret already — your klikit integration contact issues them. If not, ping [email protected] and come back with the credentials.
1

Pick your environment

For everything below, set the base URL once. We’ll use the development environment.
BASE_URL="https://api.dev.shadowchef.co/v1/partner"
API_KEY="<your partner key>"
API_SECRET="<your partner secret>"
2

Verify your credentials

Hit a cheap, side-effect-free endpoint to confirm authentication works. GET /brands lists every brand under your business — it’s the smallest thing that requires real auth.
curl -sS -u "$API_KEY:$API_SECRET" "$BASE_URL/brands" | jq .
A 200 with a data array means you’re in. A 401 means the key / secret pair is wrong or revoked. A 403 means the credential is valid but lacks the brands:read scope — talk to your operator.
3

List recent orders

GET /orders returns the page of orders for your business, newest first. Page through with cursor (see List Orders).
curl -sS -u "$API_KEY:$API_SECRET" \
  "$BASE_URL/orders?limit=5" | jq '.data[] | {id, status, brand_id, branch_id, placed_at}'
Decode the status field via the OrderStatus reference.
4

Pull a menu

GET /menus has two modes:
  • With brand_id and branch_id — store-level snapshot (the payload that ships to aggregator marketplaces).
  • Without either — business-level tree (no store overrides applied).
# Business-level
curl -sS -u "$API_KEY:$API_SECRET" "$BASE_URL/menus" | jq '.menu.sections | length'

# Store-level
curl -sS -u "$API_KEY:$API_SECRET" \
  "$BASE_URL/menus?brand_id=123&branch_id=456" | jq '.menu.sections | length'
5

Stand up a webhook receiver

To consume events you host an endpoint and give the URL to your klikit operator. Walk through Webhooks overview next — it has copy-runnable Node and Python receivers that handle signature verification, idempotency, and acknowledgement correctly.

Authentication

HTTP Basic, key rotation, scope vocabulary.

Response envelope

The shape every success and every error shares.

Idempotency

When and how to use Idempotency-Key headers on writes.

Webhooks

Verify, dedupe, and acknowledge order events.