CLcloudkitchens
manager_menu_endpoints

Publish menus to targets for a store

Rate limit: 2 requests per minute.

post/manager/menu/v1/menus/publish

Request

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

menuPublishTargetsstring[]

MenuPublishTargets to publish to.

Example request

{
  "menuPublishTargets": [
    "doordash",
    "ubereats"
  ]
}

Response

The menu publish will be processed.

requestSubmittedboolean

Whether the request was submitted or not.

jobIdstring uuid nullable

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

Example response

{
  "menuPublishTargets": {
    "menuPublishTargets": {
      "rappi": {
        "status": "PUBLISH_IN_PROGRESS"
      }
    }
  }
}

Changes

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