Get async menu job status

Rate limit: 8 requests per minute.

get/v1/menus/jobs/{jobId}

Request

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

Path parameters

jobIdstring required

The unique identifier of the job.

Example:295f76b4-5725-4bf5-a8ab-97943dbdc3b4

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

Response

The menu async job status.

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.