Paytronix · JSON Structure

Online Ordering Api Order Input Structure

OrderInput schema from Paytronix Online Ordering API

Type: object Properties: 6 Required: 3
RestaurantLoyaltyGift CardsOnline OrderingGuest EngagementPaymentsMessaging

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

Properties

restaurantId items customer orderMethod tip deliveryAddress

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/paytronix/refs/heads/main/json-structure/online-ordering-api-order-input-structure.json",
  "name": "OrderInput",
  "description": "OrderInput schema from Paytronix Online Ordering API",
  "type": "object",
  "properties": {
    "restaurantId": {
      "type": "string",
      "example": "4b96f1bafc9f100ca79231ef"
    },
    "items": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/OrderItem"
      }
    },
    "customer": {
      "$ref": "#/components/schemas/Customer"
    },
    "orderMethod": {
      "type": "string",
      "enum": [
        "in_store",
        "online_web",
        "online_app",
        "call_in",
        "call_center",
        "drive_through"
      ],
      "example": "online_app"
    },
    "tip": {
      "type": "double",
      "example": 3.0
    },
    "deliveryAddress": {
      "$ref": "#/components/schemas/DeliveryAddress"
    }
  },
  "required": [
    "restaurantId",
    "items",
    "customer"
  ]
}