Synchronize store menu with POS menu

This endpoint is used to synchronize the store menu with the connected POS.

post/v1/menus/menu-sync

Request

Base URL
https://partners.tryotter.com
Auth
OAuth 2
Authorization code/v1/auth/oauth2/authorize
Client credentials
Token URL/v1/auth/token
Scopesmenus.sync
TypeScript
https://skmtc.dev/cloudkitchens/apis/otter-api/docs/v1/menus/menu-sync/post.ts
A function with typed inputs. Its response is checked against the schema.

Headers

X-Store-Idstring required

The unique identifier of the store in your app. This ID, along with the Application ID, will be used to match the correct store when performing operations. It cannot be longer than 255 characters and must only contain printable ASCII characters. During on-boarding, this ID will be similar to onboarding:905bb725-b141-4a9b-832a-1f254f772c94 (where the UUID is the Internal Store ID). During off-boarding, this field will be filled with the last known Store ID, or with an empty string, in case none is found. In that case, please fall back to the provided internalStoreId (a.k.a. Sku-Sku ID).

Example:partner-store-unique-identifier

Request body

shouldPublishChangesboolean nullable

Whether or not to publish changes to external services after bulk resolution.

useCustomOptionsboolean nullable

If true, use customBulkResolutionOptions instead of menu configuration.

Response

The Menu Sync will be processed.

jobIdstring uuid nullable

Only present if the request succeeds. Job ID to check on the status with the MenuAsyncJob endpoint.

Changes

No recorded changes to this operation across all 1 revision of this API.