ItsaCheckmate · JSON Structure

Marketplace Api Order Confirmation Structure

Confirmation that an order was accepted into the POS.

Type: object Properties: 4
RestaurantPoint Of SaleOnline OrderingDeliveryMenusOrdersIntegration

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

Properties

order_id external_id status pos_reference

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-confirmation-structure.json",
  "name": "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."
    }
  }
}