Otter · JSON Structure

Public Api Order External Identifiers Structure

The external identifiers.

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

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

Properties

id friendlyId source sourceType sourceExternalIdentifiers

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-external-identifiers-structure.json",
  "name": "OrderExternalIdentifiers",
  "description": "The external identifiers.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique ID for the order that was placed.",
      "example": "69f60a06-c335-46d9-b5a1-97f1a211c514"
    },
    "friendlyId": {
      "type": "string",
      "description": "ID used for driver pickup and restaurant management.",
      "example": "ABCDE"
    },
    "source": {
      "type": "string",
      "nullable": true,
      "description": "Describes the source of the order, typically from a food ordering marketplace.",
      "example": "ubereats"
    },
    "sourceType": {
      "type": "string",
      "nullable": true,
      "description": "source type of the order",
      "enum": [
        "POINT_OF_SALE",
        "ORDERING_MARKETPLACE",
        "AGGREGATOR",
        "CUSTOMER_INTERACTION"
      ],
      "example": "POINT_OF_SALE"
    },
    "sourceExternalIdentifiers": {
      "nullable": true,
      "$ref": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-source-external-identifiers-schema.json"
    }
  },
  "required": [
    "friendlyId",
    "id"
  ]
}