ping_endpoints

Ping the system

Rate limit: 8 requests per minute.

get/v1/ping

Request

Base URL
https://partners.tryotter.com
Auth
OAuth 2
Authorization code/v1/auth/oauth2/authorize
Client credentials
Token URL/v1/auth/token
Scopesping
TypeScript
https://skmtc.dev/cloudkitchens/apis/otter-api/docs/v1/ping/get.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-Echo-Errorstring

The error message to be returned by the endpoint, for testing purposes.

Example:ping test error message

Response

The ping was successfully received.

responsestring

A text response.

currentTimestring date-time

The current timestamp.

Example response

{
  "response": "pong",
  "currentTime": "2007-12-03T09:15:30.000Z"
}

Changes

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