CLcloudkitchens
manager_menu_endpoints

Bootstrap menus for a store

Rate limit: 2 requests per minute.

post/manager/menu/v1/bootstrap

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

templateNamestring required

Name for the bootstrapped template menu

externalServiceSlugstring required

The external service from which to bootstrap menu data

enableTemplateboolean nullable

Whether or not to enable the template at the bootstrapped store

stationIdstring nullable

The id of the station to which to assign bootstrapped items, unnecessary for brick and mortar

posSlugstring nullable

The slug for the POS to connect to

Example request

{
  "templateName": "My Store's Menu",
  "externalServiceSlug": "ubereats-api",
  "stationId": "9cc4bb5e-bc97-40d9-af28-c02ef1483610",
  "posSlug": "pos-slug"
}

Response

The menu will be bootstrapped.

jobType'UPSERT' | 'PUBLISH' | 'UPDATE_AVAILABILITY' | 'SYNC' | 'UNKNOWN'

Type of job.

publishJobStateMenuJobPublishState nullable

Only present if the MenuJobType is PUBLISH. Contains a map of MenuPublishTarget services to their corresponding statuses.

Example response

{
  "jobType": "PUBLISH",
  "publishJobState": {
    "rappi": {
      "status": "FAILED",
      "message": "Failed to publish menu due to error ..."
    }
  }
}

Changes

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