Sync business-level changes to existing store menus

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

Push the named sections to each (brand, branch) store.

Two read-this-first behaviours:

Overlap check. A non-empty sections[<id>].availableTimes triggers an overlap check against schedules already attached to the store; a collision returns 400 request_invalid. The simplest opt-out is to send availableTimes: {} — the menu service then falls back to the section's business-level schedule.
Persisted fields. Sync deliberately keeps the store's existing overrides for a few fields (defaults listed under PersistFieldOnSync) — so a stock store-only schedule edit isn't blown away when you ship an unrelated business-level change. To overwrite one of those fields from the business-level value, include its name in fieldIncludeOnSync. Example:
```
{ "fieldIncludeOnSync": ["availableTimes"] }
```
subtracts availableTimes from the persist list so the store-section schedule is overwritten with the section's current business-level availableTimes.

After sync, the partner-facing getMenu response reads from a cached blob — call publishMenu afterwards to rebuild it (and to ship the change to provider marketplaces).

stores

object[]

required

Show child attributes

sections

object

required

Section-id keyed object. Each value carries display order + per-store schedule overrides.

Show child attributes

fieldIncludeOnSync

string[]

Field names to exclude from the persist list — i.e. force-overwrite the store's existing override with the business-level value. Common picks: availableTimes, isEnabled, visibilities, blackoutDates for sections.

persistFieldOnSync

object

Explicit per-level persist allowlist. If you set this, the menu service replaces the default list wholesale — usually you want to leave this unset and use fieldIncludeOnSync instead.

Show child attributes

Response

Success — payload wrapped in the canonical Envelope.

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