Otter · JSON Structure

Public Api Custom Bulk Resolution Options Structure

CustomBulkResolutionOptions schema from Public API (Otter Public API).

Type: object Properties: 15
RestaurantOrder ManagementDeliveryOnline OrderingMenu ManagementAnalytics

CustomBulkResolutionOptions is a JSON Structure definition published by Otter, describing 15 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

updateNames updatePrices updateDescriptions createUnmatchedEntities deleteMissingEntities bootstrapPhotosToEntities copyEntityPaths updateItemSuspensionStatus updateHours assignItemsToLocations unassignItemsFromLocations updateMenuOrganization updateItemArrangement updateModifierGroupRules updateTaxes

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-custom-bulk-resolution-options-structure.json",
  "name": "CustomBulkResolutionOptions",
  "description": "CustomBulkResolutionOptions schema from Public API (Otter Public API).",
  "type": "object",
  "properties": {
    "updateNames": {
      "type": "boolean",
      "description": "Update the linked entity's names to match the linked external entity's.",
      "example": true
    },
    "updatePrices": {
      "type": "boolean",
      "description": "Update the linked entity's price to match the linked external entity's.",
      "example": true
    },
    "updateDescriptions": {
      "type": "boolean",
      "description": "Update the linked entity's description to match the linked external entity's.",
      "example": true
    },
    "createUnmatchedEntities": {
      "type": "boolean",
      "description": "Create unmatched external entities in the menu.",
      "example": true
    },
    "deleteMissingEntities": {
      "type": "boolean",
      "description": "Delete entities that are missing external links.",
      "example": true
    },
    "bootstrapPhotosToEntities": {
      "type": "boolean",
      "description": "Bootstrap linked item photos.",
      "example": true
    },
    "copyEntityPaths": {
      "type": "boolean",
      "description": "Copies the entity paths from the external menu.",
      "example": true
    },
    "updateItemSuspensionStatus": {
      "type": "boolean",
      "description": "Update Item suspension status.",
      "example": true
    },
    "updateHours": {
      "type": "boolean",
      "description": "Update menu hours.",
      "example": true
    },
    "assignItemsToLocations": {
      "type": "boolean",
      "description": "If an item exists at a location in the POS, it will automatically be assigned to that location.",
      "example": true
    },
    "unassignItemsFromLocations": {
      "type": "boolean",
      "description": "If an item is removed from a location in the POS, it will automatically be unassigned from that location.",
      "example": true
    },
    "updateMenuOrganization": {
      "type": "boolean",
      "description": "The organization of modifiers into modifier groups, modifier groups into items and items into categories will be replicated from the POS menu.",
      "example": true
    },
    "updateItemArrangement": {
      "type": "boolean",
      "description": "The arrangement of menu products as displayed in your POS will be replicated.",
      "example": true
    },
    "updateModifierGroupRules": {
      "type": "boolean",
      "description": "Update modifier group selection rules.",
      "example": true
    },
    "updateTaxes": {
      "type": "boolean",
      "description": "Update taxes.",
      "example": true
    }
  }
}