Notify the result of a pause request event

Rate limit: 8 requests per minute.

post/v1/storefront/pause

Request

Base URL
https://partners.tryotter.com
Auth
OAuth 2
Authorization code/v1/auth/oauth2/authorize
Client credentials
Token URL/v1/auth/token
Scopesstorefront.store_pause_unpause
TypeScript
https://skmtc.dev/cloudkitchens/apis/otter-api/docs/v1/storefront/pause/post.ts
A function with typed inputs. Its response is checked against the schema.

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 required

Unique identifier of the event that this callback refers to.

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

Request body

closureIdstring

ID required to unpause a store, if available

Example request

{
  "closureId": "4109d2c9-8bc5-413c-af3e-1c92aa381e41",
  "eventResultMetadata": {
    "additionalInformation": "Completed without problems.",
    "operationFinishedAt": "2007-12-03T09:15:30.000Z"
  }
}

Response

The pause store event result was successfully processed

Changes

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