---
title: "Notify about store availability change"
method: POST
path: "/v1/storefront/availability"
tags: ["storefront_endpoints"]
---

# Notify about store availability change

`POST /v1/storefront/availability`

## Request

- Base URL: `https://partners.tryotter.com`
- URL: `https://partners.tryotter.com/v1/storefront/availability`
- Auth: OAuth 2
  - Authorization code: `/v1/auth/oauth2/authorize`
  - Client credentials
  - Token URL: `/v1/auth/token` scopes: `storefront.store_availability`
- TypeScript: <https://skmtc.dev/cloudkitchens/apis/otter-api/docs/v1/storefront/availability/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).
- `X-Event-Id` string: Optional unique identifier of the event that this callback refers to.

## Request body

- StoreAvailabilityEventResult: The current state of a store.
  - `storeState` 'OPEN' | 'OFF_HOUR' | 'SERVICE_PROVIDER_PAUSED' | 'OPERATOR_PAUSED' | 'SERVICE_PROVIDER_PAUSED_COURIERS_UNAVAILABLE' | 'STORE_UNAVAILABLE' | 'HOLIDAY_HOUR' | 'MENU_UNAVAILABLE' | 'SERVICE_PROVIDER_PAUSED_MISCONFIGURED' | 'OPEN_FOR_PICKUP_ONLY' | 'OPEN_FOR_DELIVERY_ONLY' | 'CLOSED_FOR_UNDETERMINED_REASON', nullable: Represents the current state of a store.
  - `statusChangedAt` string, date-time, nullable: The time when the store changed to the current state.
  - `eventResultMetadata` EventResultMetadata, nullable: Information about the result of a storefront event.
    - `operationStatus` 'SUCCEEDED' | 'INTERNAL_ERROR' | 'AUTHENTICATION_FAILURE' | 'AUTHORIZATION_FAILURE' | 'UNKNOWN_FAILURE' | 'INVALID_STORE_STATE' | 'INVALID_STORE_CONFIGURATION' | 'OPERATION_NOT_SUPPORTED' | 'IGNORED_ALREADY_IN_REQUESTED_STATE' | 'INVALID_REQUEST': Status of the operation requested by an event.
    - `additionalInformation` string, nullable: Additional details about the event result, if available.
    - `operationFinishedAt` string, date-time: Time when the processing of the event finished.

## Response `204`

The store availability change was successfully processed

## 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)