Source: https://restauranttechnologynetwork.com/technical-documents

Order

Properties

Name Description Type Required Generic Enum Ignore
@type string false ${prop.ignore}
OrderID A globally unique identifier for the order. string false ${prop.ignore}
OrderNumber A unique identifier for the order in the ordering system (e.g. number printed on a receipt).. string false ${prop.ignore}
OrderStatus Assigned Type: ms-0100:OrderStatus_Enum OrderStatus_Enum false ${prop.ignore}
OrderTime The date\/time that the order was placed. string false ${prop.ignore}
PromiseDateTime The date\/time that the order was promised to be ready. string false ${prop.ignore}
LocationIdentifier Assigned Type: ms-0100:Location_ID LocationIdentifier false ${prop.ignore}
Customer Assigned Type: ms-0100:Customer Customer_MS0100 false ${prop.ignore}
OrderItem array false OrderItem --- ${prop.ignore}
Total Assigned Type: ms-0200:Total Total false ${prop.ignore}
Promotion array false Promotion --- ${prop.ignore}
Destination array false Reference --- ${prop.ignore}
ChannelDescription A description of the channel where the order originated. string false ${prop.ignore}
OrderItemCount The number of order items contained within this order. This field may be used to validate all order items have been received. integer false ${prop.ignore}
PackingList array false PackingList --- ${prop.ignore}
OrderState Assigned Type: ms-0300:OrderState_Enum OrderState_Enum false ${prop.ignore}
Party Assigned Type: pf1:Party Party false ${prop.ignore}
OrderSource Assigned Type: ms-0200:OrderSource OrderSource false ${prop.ignore}
OrderTracking Assigned Type: ms-0200:OrderTracking OrderTracking false ${prop.ignore}
Payment array false Payment --- ${prop.ignore}
ExtensionPoint ExtensionPoint false ${prop.ignore}
{
  "@type" : "string",
  "orderID" : "string",
  "orderNumber" : "string",
  "orderStatus" : {
    "value" : { },
    "extension" : "string"
  },
  "orderTime" : "string",
  "promiseDateTime" : "string",
  "locationIdentifier" : {
    "@type" : "string",
    "guid" : "string"
  },
  "customer" : {
    "@type" : "string",
    "personName" : { },
    "extensionPoint" : { }
  },
  "orderItem" : [ {
    "@type" : "string",
    "customer" : { },
    "seatNumber" : [ "string" ],
    "tableNumber" : "string",
    "orderItemState" : [ { } ],
    "extensionPoint" : { }
  } ],
  "total" : {
    "@type" : "string",
    "currency" : { },
    "surcharge" : [ { } ],
    "tax" : [ { } ],
    "itemPrice" : "number",
    "context" : [ "string" ],
    "discount" : [ { } ],
    "gratuity" : "number",
    "taxExemptInd" : "boolean",
    "extensionPoint" : { }
  },
  "promotion" : [ {
    "@type" : "string",
    "promotionCode" : "string",
    "description" : "string",
    "extensionPoint" : { }
  } ],
  "destination" : [ {
    "id" : "string",
    "name" : "string",
    "sourceSystem" : "string"
  } ],
  "channelDescription" : "string",
  "orderItemCount" : "integer",
  "packingList" : [ {
    "@type" : "string",
    "itemName" : "string",
    "quantity" : "integer",
    "extensionPoint" : { }
  } ],
  "orderState" : {
    "value" : { },
    "extension" : "string"
  },
  "party" : {
    "@type" : "string",
    "partyName" : "string",
    "partyDescription" : "string",
    "customer" : [ { } ],
    "totalInParty" : "integer",
    "seatingType" : [ { } ],
    "partyRequests" : [ { } ],
    "partyMix" : [ { } ],
    "contact" : { },
    "extensionPoint" : { }
  },
  "orderSource" : {
    "value" : { },
    "extension" : "string"
  },
  "orderTracking" : {
    "@type" : "string",
    "orderOriginationLocationCategory" : { },
    "orderOriginationLocation" : { },
    "dataEntryDetails" : [ { } ],
    "orderOriginResponsibility" : { },
    "extensionPoint" : { }
  },
  "payment" : [ {
    "@type" : "string",
    "amount" : "number",
    "currencyCode" : { },
    "tip" : "number",
    "gratuity" : "number",
    "tenderType" : { },
    "cardType" : { },
    "tenderDescription" : "string",
    "authorizationCode" : "string",
    "cardEntryType" : { },
    "customerName" : "string",
    "lastFour" : "string",
    "firstSix" : "string",
    "accountNumber" : "string",
    "tenderPresenceInd" : "boolean",
    "depositInd" : "boolean",
    "extensionPoint" : { }
  } ],
  "extensionPoint" : { }
}