ItsaCheckmate · JSON Structure

Marketplace Api Order Structure

An order to submit into the POS.

Type: object Properties: 7 Required: 2
RestaurantPoint Of SaleOnline OrderingDeliveryMenusOrdersIntegration

Order is a JSON Structure definition published by ItsaCheckmate, describing 7 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

external_id order_source group_order customer items totals payment_status

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/itsacheckmate/refs/heads/main/json-structure/marketplace-api-order-structure.json",
  "name": "Order",
  "description": "An order to submit into the POS.",
  "type": "object",
  "required": [
    "external_id",
    "items"
  ],
  "properties": {
    "external_id": {
      "type": "string",
      "description": "Identifier of the order in the originating ordering platform."
    },
    "order_source": {
      "type": "string",
      "description": "Ordering platform the order originated from."
    },
    "group_order": {
      "type": "boolean",
      "description": "Whether this is a group order placed by multiple individuals together.",
      "default": false
    },
    "customer": {
      "title": "Customer",
      "type": "object",
      "description": "Customer who placed the order.",
      "properties": {
        "name": {
          "type": "string",
          "description": "Customer name."
        },
        "phone": {
          "type": "string",
          "description": "Customer phone number in E.164 format."
        }
      }
    },
    "items": {
      "type": "array",
      "description": "Line items in the order.",
      "items": {
        "title": "OrderItem",
        "type": "object",
        "description": "A single line item in an order.",
        "properties": {
          "id": {
            "type": "string",
            "description": "Menu item identifier."
          },
          "name": {
            "type": "string",
            "description": "Item name."
          },
          "quantity": {
            "type": "int64",
            "description": "Quantity ordered."
          },
          "price": {
            "type": "int64",
            "description": "Unit price in the smallest currency unit (cents)."
          }
        }
      }
    },
    "totals": {
      "title": "OrderTotals",
      "type": "object",
      "description": "Monetary totals for an order, in the smallest currency unit (cents).",
      "properties": {
        "subtotal": {
          "type": "int64",
          "description": "Sum of line items before tax."
        },
        "tax": {
          "type": "int64",
          "description": "Tax amount."
        },
        "total": {
          "type": "int64",
          "description": "Grand total charged."
        }
      }
    },
    "payment_status": {
      "type": "string",
      "description": "Payment status of the order.",
      "enum": [
        "paid",
        "unpaid",
        "refunded"
      ]
    }
  }
}