Otter · JSON Structure

Public Api Customer Item Modification Structure

One modification to apply. Exactly one of quantityUpdated, priceAdjusted, or itemAdded must be set.

Type: object Properties: 3
RestaurantOrder ManagementDeliveryOnline OrderingMenu ManagementAnalytics

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

Properties

quantityUpdated priceAdjusted itemAdded

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-customer-item-modification-structure.json",
  "name": "CustomerItemModification",
  "description": "One modification to apply. Exactly one of quantityUpdated, priceAdjusted, or itemAdded must be set.",
  "type": "object",
  "properties": {
    "quantityUpdated": {
      "$ref": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-quantity-updated-modification-schema.json",
      "description": "Change quantity for existing item(s). Set quantity to 0 to remove."
    },
    "priceAdjusted": {
      "$ref": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-order-price-adjusted-modification-schema.json",
      "description": "Adjust order subtotal (positive = up charge, negative = refund)."
    },
    "itemAdded": {
      "$ref": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-item-added-modification-schema.json",
      "description": "Add a new item to the order."
    }
  },
  "oneOf": [
    {
      "required": [
        "quantityUpdated"
      ]
    },
    {
      "required": [
        "priceAdjusted"
      ]
    },
    {
      "required": [
        "itemAdded"
      ]
    }
  ]
}