Otter · Schema

RequestStateInfo

Request state details

RestaurantOrder ManagementDeliveryOnline OrderingMenu ManagementAnalytics

Properties

Name Type Description
startedAt string The time at which the request was started.
state object
status object
finishedAt string The time at which the request was completed.
action array List of request actions.
error object
View JSON Schema on GitHub

JSON Schema

public-api-request-state-info-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "RequestStateInfo",
  "description": "Request state details",
  "$id": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-request-state-info-schema.json",
  "type": "object",
  "properties": {
    "startedAt": {
      "type": "string",
      "nullable": true,
      "description": "The time at which the request was started.",
      "format": "date-time",
      "example": "2007-12-03T10:15:30+01:00"
    },
    "state": {
      "$ref": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-request-state-schema.json"
    },
    "status": {
      "$ref": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-status-schema.json"
    },
    "finishedAt": {
      "type": "string",
      "nullable": true,
      "description": "The time at which the request was completed.",
      "format": "date-time",
      "example": "2007-12-03T10:15:30+01:00"
    },
    "action": {
      "type": "array",
      "minItems": 0,
      "description": "List of request actions.",
      "items": {
        "$ref": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-request-action-schema.json"
      }
    },
    "error": {
      "nullable": true,
      "$ref": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-storefront-error-schema.json"
    }
  }
}