account_pairing_endpoints

Update store status

Update the status of a store that already completed the onboarding process. Rate limit: 2 requests per minute.

put/v1/stores/status

Request

Base URL
https://partners.tryotter.com
Auth
OAuth 2
Authorization code/v1/auth/oauth2/authorize
Client credentials
Token URL/v1/auth/token
Scopesstores.manage
TypeScript
https://skmtc.dev/cloudkitchens/apis/otter-api/docs/v1/stores/status/put.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

Request body

status'ACTIVE' | 'SUSPENDED' | 'INVALID' required

The new status of the store. ACTIVE: store ready to perform operations again; SUSPENDED: temporarily disables the store; INVALID: current credentials will no longer work, new credentials needed.

messagestring nullable

Optional message to explain the reason of the status update.

Example request

{
  "status": "SUSPENDED",
  "message": "Authentication is failing with current credentials.  Suspending store while the retry process is in progress."
}

Response

The store status was successfully updated.

Changes

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