Otter · JSON Structure

Public Api Exposed Third Party Info Structure

Information about a third party service that is exposed to the another service. Usually, this is used to expose an POS ID to an OFO.

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

ExposedThirdPartyInfo 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

externalId externalServiceSlug

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-exposed-third-party-info-structure.json",
  "name": "ExposedThirdPartyInfo",
  "description": "Information about a third party service that is exposed to the another service. Usually, this is used to expose an POS ID to an OFO.",
  "type": "object",
  "properties": {
    "externalId": {
      "type": "string",
      "description": "The identifier that exists in the third party system. ",
      "example": "da0e4e94-5670-4175-897a-3b7dde45bed5"
    },
    "externalServiceSlug": {
      "type": "string",
      "description": "The slug of the third party service.",
      "example": "tasty-bbq"
    }
  },
  "required": [
    "externalId",
    "externalServiceSlug"
  ]
}