Paytronix · JSON Structure

Online Ordering Api Order Structure

Order schema from Paytronix Online Ordering API

Type: object Properties: 10
RestaurantLoyaltyGift CardsOnline OrderingGuest EngagementPaymentsMessaging

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

Properties

id restaurantId items customer orderMethod tip total status deliveryAddress createdAt

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-structure.json",
  "name": "Order",
  "description": "Order schema from Paytronix Online Ordering API",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "example": "5f1c2d3e4a5b6c7d8e9f0a1b"
    },
    "restaurantId": {
      "type": "string",
      "example": "4b96f1bafc9f100ca79231ef"
    },
    "items": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/OrderItem"
      }
    },
    "customer": {
      "$ref": "#/components/schemas/Customer"
    },
    "orderMethod": {
      "type": "string",
      "example": "online_app"
    },
    "tip": {
      "type": "double",
      "example": 3.0
    },
    "total": {
      "type": "double",
      "example": 22.0
    },
    "status": {
      "type": "string",
      "enum": [
        "created",
        "submitted",
        "paid",
        "in_progress",
        "completed",
        "cancelled"
      ],
      "example": "submitted"
    },
    "deliveryAddress": {
      "$ref": "#/components/schemas/DeliveryAddress"
    },
    "createdAt": {
      "type": "datetime"
    }
  }
}