---
title: "Suspend menu entities targets for a store"
method: POST
path: "/manager/menu/v1/menus/entities/availability/suspend"
tags: ["manager_menu_endpoints"]
---

# Suspend menu entities targets for a store

`POST /manager/menu/v1/menus/entities/availability/suspend`

## Request

- Base URL: `https://partners.tryotter.com`
- URL: `https://partners.tryotter.com/manager/menu/v1/menus/entities/availability/suspend`
- Auth: OAuth 2
  - Authorization code: `/v1/auth/oauth2/authorize`
  - Client credentials
  - Token URL: `/v1/auth/token` scopes: `manager.menus`
- TypeScript: <https://skmtc.dev/cloudkitchens/apis/otter-api/docs/manager/menu/v1/menus/entities/availability/suspend/post.ts> (a function with typed inputs; its response is checked against the schema)

Rate limit: 16 requests per minute.

## Headers

- `X-Store-Id` string, 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).

## Request body

- SuspendItemsRequest
  - `entityIds` string[], required: Entity IDs to suspend. These should be the IDs as you represent them in your system.
  - `note` string, required: The reason you are suspending the items.
  - `status` SuspensionStatus, required: The type of suspension this will be.
    - `isIndefinite` boolean, required: True if the suspension is indefinite
    - `suspendedUntil` string, date-time, nullable: ISO-8601 timestamp representing the time the saleStatus value is supposed to change to FOR_SALE. Set only when current saleStatus value is TEMPORARILY_NOT_FOR_SALE. E.g.: 2020-11-23T21:33:51Z, 2007-12-03T10:15:30+01:00

## Response `202`

The suspend menu entities will be processed.

- MenuAsynchronousJob: The job created to process the menu request.
  - `jobReference` JobReference: The job reference.
    - `id` string, uuid: Unique identifier of the job.
    - `status` 'PENDING' | 'FAILED' | 'SUCCESS' | 'UNKNOWN': The status of the job.
  - `jobType` 'UPSERT' | 'PUBLISH' | 'UPDATE_AVAILABILITY' | 'SYNC' | 'UNKNOWN': Type of job.
  - `publishJobState` MenuJobPublishState, nullable: Only present if the MenuJobType is PUBLISH. Contains a map of MenuPublishTarget services to their corresponding statuses.

## Other responses

- `400`: The request is malformed.
- `401`: Invalid authorization.
- `403`: Authorization not valid for the requested resource.
- `404`: Resource not found.
- `422`: The request body is not valid.

---

[API](https://skmtc.dev/cloudkitchens/apis/otter-api.md) - [All operations](https://skmtc.dev/cloudkitchens/apis/otter-api/llms.txt) - [OpenAPI document](https://skmtc.dev/cloudkitchens/apis/otter-api/revisions/4c868194a467?raw)