ItsaCheckmate · Schema

OrderConfirmation

Confirmation that an order was accepted into the POS.

RestaurantPoint Of SaleOnline OrderingDeliveryMenusOrdersIntegration

Properties

Name Type Description
order_id string ItsaCheckmate order identifier.
external_id string Originating platform order identifier.
status string Order acceptance status.
pos_reference string Reference assigned by the POS system.
View JSON Schema on GitHub

JSON Schema

marketplace-api-order-confirmation-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/itsacheckmate/refs/heads/main/json-schema/marketplace-api-order-confirmation-schema.json",
  "title": "OrderConfirmation",
  "description": "Confirmation that an order was accepted into the POS.",
  "type": "object",
  "properties": {
    "order_id": {
      "type": "string",
      "description": "ItsaCheckmate order identifier."
    },
    "external_id": {
      "type": "string",
      "description": "Originating platform order identifier."
    },
    "status": {
      "type": "string",
      "description": "Order acceptance status.",
      "enum": [
        "accepted",
        "rejected",
        "pending"
      ]
    },
    "pos_reference": {
      "type": "string",
      "description": "Reference assigned by the POS system."
    }
  }
}