CLcloudkitchens
storefront_endpoints

Notify about store availability change

Rate limit: 16 requests per minute.

post/v1/storefront/availability

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
X-Event-Idstring

Optional unique identifier of the event that this callback refers to.

Example:cf0ce51b-d74e-40d3-b177-1925ab4edc0c

Request body

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.

statusChangedAtstring date-time nullable

The time when the store changed to the current state.

Example request

{
  "statusChangedAt": "2007-12-03T09:15:30.000Z",
  "eventResultMetadata": {
    "additionalInformation": "Completed without problems.",
    "operationFinishedAt": "2007-12-03T09:15:30.000Z"
  }
}

Response

The store availability change was successfully processed

Changes

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