Otter · JSON Structure

Public Api Order Reference Structure

An order reference.

Type: object Properties: 2 Required: 2
RestaurantOrder ManagementDeliveryOnline OrderingMenu ManagementAnalytics

OrderReference is a JSON Structure definition published by Otter, describing 2 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

externalIdentifiers storeId

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-structure/public-api-order-reference-structure.json",
  "name": "OrderReference",
  "description": "An order reference.",
  "type": "object",
  "properties": {
    "externalIdentifiers": {
      "$ref": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-order-external-identifiers-schema.json"
    },
    "storeId": {
      "type": "string",
      "description": "The identifier of the store.",
      "example": "ckdss-store-id"
    }
  },
  "required": [
    "externalIdentifiers",
    "storeId"
  ]
}