Publish the menu to providers + refresh the store snapshot
Two effects on success:
- Rebuilds the cached
store_full_menusblob thatgetMenureads from. Without this, business-level edits that were pushed viasyncMenuToStoreswon’t be visible to the partner-facing read endpoint. - Ships the current snapshot to each
providerIDschannel (klikit is1; the rest come fromlistProviders).
Use scheduledAt (UTC) to defer the publish. The response’s
data.success / data.failed counters tell you how many of
the requested stores landed.
Authorizations
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
Trigger a publish for a set of (brand, branch) stores. Side effects on success:
- Rebuilds the cached
store_full_menusblob thatgetMenureads from — without this, recent biz-level edits aren't visible to the partner-facing read endpoint even aftersyncMenuToStores. - Ships the menu to each provider id in
providerIDs(klikit is1; pull the rest fromlistProviders).
Use scheduledAt (UTC) to defer the publish; absent or zero
means "publish now".
Response
Publish queued / completed.
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.
"req_4d1b7e3f-..."
Endpoint-specific payload on success.
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: