arts standard xml poslog for foodservice technical specification v3.0.0 volume customer order entry...

IXRetail POSLog Foodservice Technical Specification

IXRetail POSLog For Foodservice Technical Specification

Volume 1 Customer Order Entry

Version 3.0.0 November 18, 2006 ARTS Standard Chairman: Moin Moinuddin Microsoft Authors: Autl Changela Xpient Solutions John Muhlberger Par Technologies Nick Scavanoe Accuvia Paul Gay Epson Richard Halter MIC Bob Bruce Control Products Charlie Souhrada NAFEM Dave Moorman PCMS Datafit Dave Van Horn SofTechnics Drew Seale Xformity Kazunori Hirano Toshibatec Japan Yasuo Sakami Foresight Frank May Microsoft Graham Hill PCMS Datafit

Copyright 2006 International XML Retail Cooperative. All rights reserved. Page 1 Verbatim reproduction and distribution of this document is permitted in any medium, provided this notice is preserved.

IXRetail POSLog Foodservice Technical Specification Vol 1 Customer Order Entry

Copyright National Retail Federation 2006. All rights reserved.

This document and translations of it may be copied and furnished to others, and derivative works that comment on or otherwise explain it or assist in its implementation may be prepared, copied, published and distributed, in whole or in part, without restriction of any kind, provided that the above copyright notice and this paragraph are included on all such copies and derivative works. However, this document itself may not be modified in any way, such as by removing the copyright notice or references to the NRF, ARTS, or its committees, except as needed for the purpose of developing ARTS standards using procedures approved by the NRF, or as required to translate it into languages other than English.

The limited permissions granted above are perpetual and will not be revoked by the National Retail Federation or its successors or assigns.



TABLE OF CONTENTS

1. INTRODUCTION ................................................................................................................................................8 1.1 Document Scope ....................................................................................................................................8 1.2 Referenced Documents ........................................................................................................................10

2. TYPOGRAPHICAL CONVENTIONS..............................................................................................................10 2.1 POS Transaction Status State Diagram ...............................................................................................11 2.2 Order Item Status .................................................................................................................................13 2.3 Data Hierarchy Diagram......................................................................................................................14 2.4 Conformance XML Instance Document..............................................................................................14

3. DESIGN DECISIONS........................................................................................................................................15 3.1 Generally Accepted Accounting Practices (GAAP)............................................................................16 3.2 Transaction Identification ....................................................................................................................17 3.3 Business Day Date ...............................................................................................................................18 3.4 Boolean Flags ......................................................................................................................................18 3.5 Default Currency..................................................................................................................................18 3.6 SequenceNumber Elements .................................................................................................................19 3.7 Sale, Return & Back-Order for Delivery or Pickup.............................................................................19 3.8 Combo and Recursion..........................................................................................................................20 3.9 Location of Pickup or Delivery Data...................................................................................................20 3.10 Retail Price Modifier, Transaction Level Discounts & Taxation ........................................................21

4. USE CASE: ITEM SALES.................................................................................................................................22 4.1 Scenario: One Behind, Normal Drive-Up Customer Order.................................................................24 4.2 Scenario: One Behind, Normal Drive-Up Customer Order with Taxes ..............................................29 4.3 Scenario: One Behind, Normal Drive Up Customer Order with Subtotal...........................................34 4.4 Scenario: Web Interface Sale to Store System ....................................................................................39 4.5 Scenario: Call Center Sale ...................................................................................................................42 4.6 Scenario: Kiosk Sale............................................................................................................................44

5. USE CASE: MODIFY SALES...........................................................................................................................47 5.1 Scenario: One Behind, Normal Drive Up Customer Order with Customer Changing the Order........48 5.2 Scenario: Add Modifiers to an Item ....................................................................................................56 5.3 Scenario: Add Special Instructions to an Item.....................................................................................58 5.4 Scenario: Add Serving Instructions to an Item....................................................................................60

6. USE CASE: C. O. D. (CASH ON DELIVERY) [ AKA P.O.D. PAYMENT ON DELIVERY]..................62 6.1 Scenario: Future Order with Partial Payment ......................................................................................62



6.2 Scenario: Occurrence of a C.O.D. Delivery Orders .........................................................................64 6.3 Scenario: Occurrence of a C.O.D. Catering Orders..........................................................................65 6.4 Scenario: Delivery to the Table ...........................................................................................................66 6.5 Scenario: Home Delivery Sale.............................................................................................................68 6.6 Scenario: Occurrence of a C.O.D. .......................................................................................................70 6.7 Scenario: Add C.O.D. Shipment..........................................................................................................74 6.8 Scenario: C. O. D. Completion............................................................................................................76 6.9 Scenario: C. O. D. Cancellation...........................................................................................................80 6.10 Scenario: Customer Order with Multiple Operators............................................................................83

7. USE CASE: CUSTOMER PICKS UP THE ORDER AT THE STORE ...........................................................85 7.1 Scenario: Call-In Order with Customer Picking Up the Order at the Store ........................................86 7.2 Scenario: Dine In and Pickup Order ....................................................................................................87

8. USE CASE: USE CASE: ITEM DISCOUNTS WITH OR WITHOUT TAX DISCOUNTING ......................89 8.1 Scenario: An item in an order has a Percentage discounts with tax discount applied to it if eaten in or if carried out 90 8.2 Scenario: An item in an order has a currency discounts with no tax discount applied if eaten in ......92 8.3 Scenario: Transaction Level Discount.................................................................................................94

9. USE CASE: MULTIPLE REVENUE CENTERS CUSTOMER ORDER TRANSACTIONS.........................96 9.1 Scenario: Multiple Revenue Centers Purchase at the Bar and Pay at the Table.............................97

10. USE CASE: SUSPENDING A TRANSACTION............................................................................................101 10.1 Scenario: Suspending a transaction ...................................................................................................102 10.2 Scenario: Delete Suspend Transaction ..............................................................................................103

11. USE CASE: COMBO MEALS SALES ...........................................................................................................106 11.1 Scenario: Completed Combo Purchase..............................................................................................107 11.2 Scenario: Modifying an Entre Item with Equivalent Side Items .....................................................109 11.3 Scenario: Modifying Side Items without Additional Cost.................................................................111 11.4 Scenario: Modifying Items with Additional Cost..............................................................................115 11.5 Scenario: Combo Meal Removing Multiple Items ............................................................................118 11.6 Scenario: Combo Meal Containing Multiple Items, Some Added, Some Removed.........................121

12. USE CASE: MISCELLANEOUS ....................................................................................................................125 12.1 Scenario: Print Despatch Docket with Product Delivery...................................................................125 12.1.1 Alternate Scenario: Print Copy of Despatch Docket .......................................................................127 12.2 Scenario: Wild Party ......................................................................................................................128

13. USE CASE: TAXATION.................................................................................................................................131 13.1 Scenario: Some of the Items are Taxed and Others Are Not in the Same Transaction .....................131



14. DOCUMENT HISTORY..................................................................................................................................135 15. DOMAIN GLOSSARY....................................................................................................................................136 TABLE OF FIGURES

Figure 1 Retail Model for POS ................................................................................................................................................................... 9 Figure 2: POS Transaction Status State Diagram..................................................................................................................................... 13 Figure 3 Example Data Hierarchy Diagram ............................................................................................................................................. 14 Figure 4: Item Sale Customer Order Domain View ................................................................................................................................. 23 Figure 5: One Behind, Normal Drive-Up Customer Order Sample Flow Diagram ................................................................................. 24 Figure 6: One Behind, Normal Drive-Up Customer Order with Taxes Sample Flow Diagram .............................................................. 29 Figure 7: One Behind, Normal Drive Up Customer Order with Subtotal Sample Flow Diagram........................................................... 34 Figure 8: One Behind, Normal Drive Up Order with Customer Changing the Order Domain View ...................................................... 47 Figure 9: One Behind, Normal Drive Up Order with Customer Changing the Order Sample Flow Diagram......................................... 49 Figure 10: Add Modifiers to an Item Receipt Example............................................................................................................................ 56 Figure 11: Add Special Instructions to an Item Receipt Example............................................................................................................ 59 Figure 12: COD Domain View................................................................................................................................................................. 62 Figure 13: Sale to be Delivered Receipt Example .................................................................................................................................... 68 Figure 14: Occurrence of a COD Domain View ...................................................................................................................................... 72 Figure 15: Add COD Shipment Domain View......................................................................................................................................... 75 Figure 16 : COD Completion.................................................................................................................................................................... 78 Figure 17 : COD Cancellation Domain View........................................................................................................................................... 81 Figure 18: Customer Pickup Domain View.............................................................................................................................................. 85 Figure 19: Discounts with or with Tax Discounting Domain View ......................................................................................................... 89 Figure 20: Purchase at the Bar and Pay at the Table Domain View......................................................................................................... 96 Figure 21: Purchase at the Bar and Pay at the Table Receipts.................................................................................................................. 97 Figure 22: Suspending a Transaction Domain View .............................................................................................................................. 101 Figure 23 Combo Domain View............................................................................................................................................................. 106 Figure 24: Modifying an Entre Item with Equivalent Side Items Receipt Example ............................................................................ 109 Figure 25: Modifying Side Items Receipt Example ............................................................................................................................... 112 Figure 26: Modifying Items Receipt Example........................................................................................................................................ 116 Figure 27: Combo Meal Removing Multiple Items Receipt Example ................................................................................................... 118 Figure 28: Combo Meal Containing Multiple Items, Some Added, Some Removed Receipt Example................................................ 121



Figure 29: Print Despatch Docket Domain View ................................................................................................................................... 126 Figure 30: Wild Party Domain View .................................................................................................................................................. 130 Figure 31 Some of the Items are Taxed and Others Are Not in the Same Transaction Domain View .................................................. 133 TABLE OF XML SAMPLES

1-04-01a Conformance XML Instance Document Normal Drive-Up - Send Item Hamburger ......................................................... 25 1-04-01b Conformance XML Instance Document - Normal Drive-Up - Send Item Add French Fries................................................ 26 1-04-01c Conformance XML Instance Document - Normal Drive-Up - Send Item Add Drink with total and tax.............................. 26 1-04-01d Conformance XML Instance Document - Normal Drive-Up - Customer picks up the food and a POSLog Retail Transaction

is created. .......................................................................................................................................................................................... 27 1-04-02a Conformance XML Instance Document - Customer Order with Taxes - Send Item Hamburger with Tax .......................... 30 1-04-02b Conformance XML Instance Document - Customer Order with Taxes - Send Item Add French Fries with Tax ................ 31 1-04-02c Conformance XML Instance Document - Customer Order with Taxes - Send Item Add Drink with total and tax.............. 31 1-04-02d Conformance XML Instance Document - Customer Order with Taxes - Customer picks up the food and a POSLog Retail

Transaction is created. ...................................................................................................................................................................... 32 1-04-03a Conformance XML Instance Document - Customer Order with Subtotal - Send Item Hamburger ...................................... 35 1-04-03b Conformance XML Instance Document - Customer Order with Subtotal - Send Subtotal with tax........................................ 36 1-04-03c Conformance XML Instance Document - Customer Order with Subtotal - Send Item Drink............................................... 36 1-04-03d Conformance XML Instance Document - Customer Order with Subtotal - Send Item on Store Ice Cream......................... 37 1-04-03e Conformance XML Instance Document - Customer Order with Subtotal - Customer picks up the food and a POSLog Retail

Transaction is created. ...................................................................................................................................................................... 38 1-04-04a Conformance XML Instance Document Customer Order thru Web Interface Sale To Store System................................... 40 1-04-04b Conformance XML Instance Document Web Interface Sale to Store System Final Retail Transaction............................... 41 1-04-05a Conformance XML Instance Document Call Center Order with Tender .............................................................................. 43 1-04-05b Conformance XML Instance Document Retail Transaction to Record Call Center Order ................................................... 44 1-04-06a Conformance XML Instance Document Kiosk Customer Order ........................................................................................... 45 1-04-06b Conformance XML Instance Document Kiosk Retail Transaction ....................................................................................... 46 1-05-01a Conformance XML Instance Document Customer Changing the Order Send Item Hamburger................................. 50 1-05-01b Conformance XML Instance Document Customer Changing the Order Send Item French Fries .............................. 51 1-05-01c Conformance XML Instance Document Customer Changing the Order Store Order Send Item Drink with total

and tax............................................................................................................................................................................................... 51 1-05-01d Conformance XML Instance Document Customer Changing the Order Recall Order remove FF add tater tots ....... 52 1-05-01e Conformance XML Instance Document Customer Changing the Order Customer picks up the food and a POSLog

Retail Transaction is created............................................................................................................................................................. 53



1-05-02a Conformance XML Instance Document Customer Order Add Modifiers to an Item.......................................................... 57 1-05-03 Conformance XML Instance Document - Add Special Instructions to an Item ......................................................................... 60 1-05-03 Conformance XML Instance Document - Add Special Instructions to an Item ......................................................................... 61 1-06-01 Conformance XML Instance Document Future Order with Partial Payment .......................................................................... 63 1-06-02 Conformance XML Instance Document Telephone Order with Payment On Delivery ........................................................ 64 1-06-03 Conformance XML Instance Document Catering Orders...................................................................................................... 66 1-06-04 Conformance XML Instance Document Delivery to the Table ............................................................................................. 67 1-06-05 Conformance XML Instance Document Delivery Sale ........................................................................................................... 69 1-06-06 Conformance XML Instance Document Occurrence of a COD .............................................................................................. 73 1-06-07 Conformance XML Instance Document Add COD Shipment................................................................................................. 76 1-06-08 Conformance XML Instance Document COD Completion...................................................................................................... 79 1-06-09 Conformance XML Instance Document COD Cancellation.................................................................................................... 82 1-06-10 Conformance XML Instance Document Customer Order with Multiple Operators.............................................................. 83 1-07-01 Conformance XML Instance Document Call-In Order with Customer Picking Up the Order at the Store ............................ 86 1-07-02 Conformance XML Instance Document Dine In and Pickup Order........................................................................................ 87 1-08-01 Conformance XML Instance Document Percentage discounts with tax applied to carry out ............................................... 90 1-08-02 Conformance XML Instance Document Percentage discounts with no tax discount applied ............................................ 92 1.08.03 Conformance XML Instance Document Transaction Level Discount ..................................................................................... 94 1-09-01a Conformance XML Instance Document Purchase at the Bar ................................................................................................ 98 1-09-01b Conformance XML Instance Document Pay at the Table ...................................................................................................... 99 1-10-01 Conformance XML Instance Document Suspending a Transaction....................................................................................... 103 1-10-02 Conformance XML Instance Document Delete Suspended Transaction............................................................................... 104 1-11-01 Conformance XML Instance Document Completed Combo Purchase ............................................................................... 107 1-11-02 Conformance XML Instance Document Modifying an Entre Item with Equivalent Side Items ....................................... 110 1-11-03 Conformance XML Instance Document Modifying Side Items without Additional Cost .................................................. 113 1-11-04 Conformance XML Instance Document Modifying Items with Additional Cost................................................................ 117 1-11-05 Conformance XML Instance Document Combo Meal Removing Multiple Items.............................................................. 119 1-11-06 Conformance XML Instance Document Combo Meal Containing Multiple Items, Some Added, Some Removed........... 122 1-12-01 Conformance XML Instance Document Print Despatch Docket ......................................................................................... 126 1-12-01b Conformance XML Instance Document Print Despatch Docket Domain View ................................................................. 128 1-12-02 Conformance XML Instance Document Wild Party ........................................................................................................ 131 1-13-01 Conformance XML Instance Document Some of the Items are Taxed and Others Are Not in the Same Transaction....... 134



1. INTRODUCTION

1.1 Document Scope The IXRetail POSLog describes the various interfaces that a Point of Service device (or system) uses to report the results of its activities to other systems in the retail enterprise. POSLog includes many different kinds of transactions and events.

The IXRetail POSLog Schema consists of a single XML Schema that defines the set of all possible transactions & events that can be sent by a POS to another system. Because the complete set is so large, this document describes only Customer Order Transactions (i.e. Transactions where one or more items are sold or returned). Customer Order Transactions are the incremental steps

This volume of the POSLog Technical Specification deals with Customer Orders. Basically Customer Orders are interim steps towards delivery of the item(s) and collection of the tender. At which time the Customer Order becomes a Retail Transaction. A Customer Order becomes a Retail Transaction when two criteria are met: 1. The items are delivered to the customer 2. The Transaction is tendered.



Figure 1 Retail Model for POS



1.2 Referenced Documents International System of Units Produced and managed by the Bureau International des Poids et Mesures located at http://www.bipm.fr

IXRetail IXRetail POSLog Charter, Version 2.00

IXRetail Extending Schemas Technical Report

IXRetail XML Best Practices

IXRetail XML Dictionary

IXRetail POSLog Schema, Version 2.3

IXRetail POSLog Domain Model, Version 2.3

International Standards Organization ISO 7812-7816 Based Card Numbers and the Domain Name System (DNS)

ISO-8601: Time and Date formats

ISO-3166-1: Country Codes

ISO-4217: Currency Codes

ISO-639-1: Language Codes

2. TYPOGRAPHICAL CONVENTIONS

The following typographical and diagramming conventions are used in this document.



2.1 POS Transaction Status State Diagram



In Process

Waste

Voided Tendered

Canceled

Delivered

Totaled

Subtotal

Start

Finished

Projection

Revision

Failed

Returned

Replaced

Suspend

SuspenDelete



Figure 2: POS Transaction Status State Diagram Transaction status identifies the various states in which a transaction can exist.

Cancel Cancel is used to designate a transaction line or entire transaction that was reversed PRIOR to the finishing of a transaction but after items were sent to the kitchen.

Delivered A transaction that has ownership of the listed items transferred to the customer Failed A transaction that has problems forcing non-completion. Finished A completed transaction, i.e tendered and delivered. InProcess Items entered during a one-behind or on-the-fly order entry mode. Projection A projection of the items needed for a given time period. Used in analyzing the needs, both manpower and

inventory, for the store. Replaced This transaction replaced another transaction. Typically used to correct a problem with the original transaction. Returned Indicates this is transaction is returned. Revision This transaction is a revision of the original transaction. Subtotal Indicates an intermediate total is calculated prior to finishing. Suspended A transaction that has been stored to be recalled at a later point by the same or different POS during a customer

order. A suspended transaction must be recalled to be changed. SuspendDelete Deletes a transaction after it has been stored. This has potential inventory implications because food

preparations may have begun. Tendered Indicated the transaction was tendered. Totaled The final total prior to tendering. Void Designates a transaction line or entire transaction that was reversed as part of a finalized retail transaction, i.e. tendered

and delivered. Waste reports this transaction as waste.

2.2 Order Item Status Individual items on a customer order can be in various stats prior to completion of the order.

Hold The item has been entered but dont start preparation. Dispatch Prepare the item now. Sent The item has previously been dispatched to the kitchen and prepared. Delivered The item has been delivered to the customer. Cancel The item was cancelled after being entered and dispatched to be prepared. Void The item was voided after the retail transaction was created.



2.3 Data Hierarchy Diagram The following Data Hierarchy Diagram shows following typographical conventions for the data hierarchy diagrams in this document:

Some data elements can be present in an XML instance document at more than one level, the multiple connections are shown in blue, it is expected that any single XML instance document will make use of only one of the options shown.

Figure 3 Example Data Hierarchy Diagram 2.4 Conformance XML Instance Document The following Conformance XML Instance Document document is shows the following typographical conventions for the Conformance XML Instance Document in this document:



The XML fragments are a complete XML instance document showing all schema and name space declarations and used in the conformance test program.

The XML elements in red are interesting features of this particular XML fragment. WWW Server2 2001-09-11 8876


3.1 Generally Accepted Accounting Practices (GAAP) IXRetail has chosen to default to GAAP and make all amounts positive with the use, either adding money to the till or taking money out of the till, being determined in context of the particular instance document.



3.2 Transaction Identification Reading from the ARTS Logical Data Model the natural key for a transaction performed at a POS (or other workstation) is composed of four data elements: RetailStoreID, WorkstationID, BusinessDayDate and SequenceNumber.

The intent of the data model is to allow each Cash Register, POS or other workstation to assign sequence numbers to transactions independently of all other systems, and may re-start numbering transactions from zero every day. If a POS restarts the set of sequence numbers from zero more than once per day then extra effort will be required to lengthen the stream of sequence numbers to provide a unique identifier for each transaction.

Therefore the mandatory data elements required to identify a transaction within the POSLog Schema are:

RetailStoreID WorkstationID SequenceNumber At least one of BusinessDayDate, BeginDateTime, EndDateTime or DateTime.

The following extract from the POSLog Schema highlights the four mandatory fields of the transaction header in red, the remaining fields in the transaction header are optional. A particular implementation may choose to make some of these optional fields mandatory.



3.3 Business Day Date

The hours when most businesses in a given locality are in operation or open for business. The conventional business day is from 8 A.M. until 5 P.M. Yet individual businesses may have hours that differ from others or a business may choose staggered schedules. In a 24-hour operation, a business day typically commences at some early morning time and continues through until roughly the same time the following day. (E.g. the business day of 12-April may commence at 7:00 am on 12th April, and continue through until 6:59 am on 13th April). The purpose of this is to allow the retailer to move day-end activities to a slow period typically early in the morning.

3.4 Boolean Flags The POSLog Schema defines the following set of Boolean flags as part of the transaction header:

CancelFlag: Records the fact that the entire transaction was cancelled before tender. TrainingModeFlag: Records the fact that the transaction was performed while the POS was being used to train a new

employee, the transaction typically does not to have any impact on the financial or inventory aspects of the business. OfflineFlag: Records the fact that the transaction was performed while the POS was offline from any in-store servers, and that

therefore some data that may normally be included in a transaction may not be present. OutsideSalesFlag: Records the fact that the transaction was performed on a POS Outside the store. This flag particularly

applies to the forecourt (gas station) segment where some POS are installed outside the store either as part of or beside the fuel dispensers.

As these flags will be false in most transactions and line items, the schemas have defined them to be optional. It is intended that omitting any of these flags is the equivalent of including the flag with a false value. 3.5 Default Currency It is intended that most transactions will express all monetary amounts in an assumed default currency that is agreed between sender & receiver.

In some circumstances, a single stream or batch of transactions may include transactions that express monetary amounts in differing currencies; in these cases the optional element in the transaction header shall denote the default currency for that single transaction.

Note: The POSLog Schema defines any currency amount that can reasonably be expressed in a currency other than the default currency to have an Attribute CurrencyCode that overrides the transaction (or batch) default currency.



3.6 SequenceNumber Elements The following repeating elements within the context of a RetailTransaction are defined with a mandatory SequenceNumber element:

LineItem OperatorBypassApproval RetailPriceModifier Tax

While it is arguable that the order of such a repeating item in an XML instance document implies a sequence number, the POSLog Schema includes mandatory SequenceNumber elements for the following reasons:

Many line items refer to other line items in the same transaction, e.g. A Voids line item voids another line item, Sale & Return of deposit items may be linked to another line item. It was felt that merely including an element linking to an implied line item sequence number was insufficient. An implied line item sequence number, does not clear up ambiguities like are line items numbered from zero or one?

All of the repeating items that are defined will at some stage are saved in a database. Normal data integrity rules, require such items to be assigned an identifying sequence number, it is felt that placing an explicit SequenceNnumber element on such data elements at source is a safer practice.

Inclusion of explicit SequenceNumber elements, allows fraud-detection and other audit systems to verify that batches of Retail Transactions are being sent properly without holes or duplications in the SequenceNumbers.

3.7 Sale, Return & Back-Order for Delivery or Pickup The line items involved in recording the actual sale or return of merchandise come in three major flavors, with each flavor having potentially another three sub-flavors. The complete set is currently:

ItemSale: The item is being sold to the customer, and they are taking it with them. SaleForDelivery: The item is being sold to the customer and the store will deliver it at some later time. SaleForPickup: The item is being sold to the customer they will pick it up from some location at some later time.

The Schema defines these line items as explicit data elements, rather than as an abstract Sale line item with a set of attributes denoting the applicable flavor because:

The set of possible attributes gets confusing as each variation is added.



Each line item has extra data elements that may be required for that line item and are optional or not required in others. e.g. Delivery or Pickup elements: It is not possible to make such elements required, based on a particular value or values in a set of attributes.

All flavors of Sale are defined as extensions of a base complex-type RetailTransactionItem.

3.8 Combo and Recursion The POSLog Schema includes a mechanism for recording omissions, additions and substitutions that are made to a Combo Item when such is being sold. A Combo item is a collection of items that is priced & sold as a single item, but which is exploded into its constituent items for the purposes of tracking inventory.

The data element was defined to have a list of elements which come in the same Sale, and Return flavors previously discussed. Each member has an Action attribute that denotes how the combo member affects the combo. Possible values of the Action attribute are:

IsPartOf: The item is a pre-defined member of the combo, and has no effect on the price of the combo. Many implementations may not explicitly include these combo members in a transaction, although if the combo member has special delivery or pickup instructions then that would be a reason for including these combo members.

AddsTo: The item is not defined to be a member of the combo, but is added to the combo for this transaction. The , & elements record how the inclusion of this combo member affects the price of the combo.

IsRemovedFrom: The item is normally part of the combo, but is removed from the combofor this transaction. The , & elements record how the removal of this combomember affects the price of the combo.

The recursive definition of a comboand its members allows complex taxation, delivery & pickup and price modification rules to be applied to individual members of a combofor a particular transaction.

3.9 Location of Pickup or Delivery Data When an item being sold or returned has to be picked up or delivered, extra data about pickup and delivery address, date & time has to be recorded in the transaction. The schema allows such information to be included in the transaction in two places:

Transaction Header: All items sold for delivery in the transaction are to be delivered to the same address, at the same time. The data is only recorded once in the transaction header. The existence of SaleForDelivery flavored line items cannot make the inclusion of the delivery data at the transaction header mandatory.



Line Item Items: Each item sold for delivery in the transaction can be delivered to a different address, at a different time. When all items are to be delivered to the same address at the same time, the data is repeated in each line item. The delivery data can be made mandatory at the line item level.

Although the POSLog Schema allows Pickup & Delivery data to be recorded at both locations in an XML Instance document, it is expected that a particular implementation will make use of only one, depending on the policies of the business concerned.

3.10 Retail Price Modifier, Transaction Level Discounts & Taxation When an item is sold for a price that is different from the regular lookup price, the price modification of that item may be recorded in one or more RetailPriceModifier elements. The RetailPriceModifier element records:

Percentage Discounts & Surcharges: Add or subtract a percentage of the unit price to the item. Monetary Amount Discounts & Surcharges: Add or subtract a monetary amount to the item. Monetary Amount Replacement: No discount or surcharge, simply heres a new price.

The RetailPriceModifer element includes a SequenceNumber, to record the order in which multiple retail price modifications were performed on the unit price of a particular line item.

In the normal sequence of events, once all price modifications have been applied to the unit price, the taxation rules are applied to calculate the amount of tax to be collected. The tax collected may then be reported per line item, per transaction, or both.

A common historical practice is to apply discounts at the transaction total level. When such transaction level discounts are applied across the entire transaction, two assumptions are being made.

The discount is applied equally across all items in the transaction. All items in the transaction are taxed at exactly the same rate.

Unfortunately in many instances neither of these assumptions stands true. In modern systems, transaction level discounts are in fact applied to particular line items based on complex rules set by the business. Examples of such complex rules include: Highest Price Item, Highest Margin Item, Highest & Lowest Taxed Items, etc.

The POSLog Schema includes both a element at the Line Item level that is used for recording transaction level discounts, and a element in the complex-type that is used for recording item level discounts and price modifications, to allow maximum flexibility.



Because of the difficulties of having Back-Office and corporate systems reproduce the exact discount & taxation calculations that were performed by the POS, the POSLog Schema includes elements that allow such calculations to be performed once and once only by the POS, and then reported to and used by all other store systems.

4. USE CASE: ITEM SALES

Customer Orders split a transaction into intermediate steps prior to finalization (that is, delivery and tender). For example, when one dines at a restaurant, the drinks are taken first and entered into the POS. The order is stored and the drinks are delivered. The customers then order their main course. At which time these are entered into the POS and sent to the kitchen. Finally after the customer finishes their meal, they pay and the transaction is finalized.

In a drive thru environment, the customer orders at the first window, pays at the second and picks up their food at the third. Each of these steps is an intermediate step in the Customer Order.

Or in a pizza environment, the customer calls in their order and has it delivered to their home. This is functionally equivalent in the retail world to a customer ordering a piano to be delivered from the factory.



Data Hierarchy Diagram This use case deals with this area of the schema

Figure 4: Item Sale Customer Order Domain View



4.1 Scenario: One Behind, Normal Drive-Up Customer Order Taxes are Not Available Until Subtotal, Store, or Total. NOTE: this order is not tendered.

Brief Description

D riv e s u p a n ds ta r ts o rd e r

C u s to m e r

O rd e r H a m b u rg e r

O C BH a m b u rg e r $ 5 .0 0

S u b to ta l $ 5 .0 0

O rd e r F re n c h F r ie s

O C BH a m b u rg e r $ 5 .0 0F re n c h F r ie s $ 1 .0 0

S u b to ta l $ 6 .0 0

O rd e r D r in k

T h ro u g h w ith O rd e rO rd e r G e ts S to re d

O C BH a m b u rg e r $ 5 .0 0F re n c h F r ie s $ 1 .0 0D r in k $ 3 .0 0

S u to ta l $ 9 .0 0T a x $ 0 .4 5T o ta l $ 9 .4 5

S e n d I te m(h a m b u rg e r)

S e n d I te m (F re n c hF rie s )

S e n d S to re d w ithI te m (D r in k ) a n dT o ta l N o d ec o n ta in in g T a x

O rd e r s e n t 1 b e h in d

Figure 5: One Behind, Normal Drive-Up Customer Order Sample Flow Diagram

3 order transactions are created, one for each item, the hamburger, the drink, the French fries, when it is ordered and sent one-behind. That is, when item 2 is entered, item 1 is sent to the order confirmation board (OCB) Pre-Conditions

Post-Conditions Customer pays when they pick up their order. At that point the retail transaction is created showing the entire transaction.



Data 3 order transactions are created, one for each item, the hamburger, the drink, the French fries, when it is ordered and sent one-behind. That is, when item 2 is entered, item 1 is sent to the order confirmation board (OCB)

NODES Covered by This Use Case POSLog POSLogTransaction CustomerOrderTransaction POSLogRetailTransaction RetailTransactionLineItem RetailTransactionSale RetailTransactionItem RetailTransactionTax RetailTransactionTotal

1-04-01a Conformance XML Instance Document Normal Drive-Up - Send Item Hamburger In one-behind mode, this Hamburger XML Document is sent when the French fries are entered. HighStreet POS5 4294967295 2001-08-13T09:01:00 John 1 123 Dispatch 5.00



1-04-01b Conformance XML Instance Document - Normal Drive-Up - Send Item Add French Fries This French Fries XML Document is sent when the drink is entered. HighStreet POS5 4294967295 2001-08-13T09:01:00 John 2 2345 Dispatch 1.00

1-04-01c Conformance XML Instance Document - Normal Drive-Up - Send Item Add Drink with total and tax This Drink with Total and Tax XML Document is sent when the order is stored. HighStreet POS5 4294967295 2001-08-13T09:01:00 John 3


IXRetail POSLog Foodservice Technical Specification Vol 1 Customer Order Entry 2345 Dispatch 3.00 4 .45 7 9.45

1-04-01d Conformance XML Instance Document - Normal Drive-Up - Customer picks up the food and a POSLog Retail Transaction is created. This Retail Transaction XML Document is created at the end of the order when the items are delivered and the order is paid. HighStreet POS5 4294967295 2001-08-13T09:01:00 John 1 123 5.00 2


IXRetail POSLog Foodservice Technical Specification Vol 1 Customer Order Entry 2345 1.00 3 2345 3.00 4 .45 7 9.45



4.2 Scenario: One Behind, Normal Drive-Up Customer Order with Taxes Brief Description This scenario shows a running total and taxes are calculated and reported as each item is added.

Drives up and starts order

Customer

Order Hamburger

OCBHamburger $5.00

Tax $0.25Total $5.25

Order French Fries

OCBHamburger $5.00French Fries $1.00


Order Drink

Through with OrderOrder Gets Stored

OCBHamburger $5.00French Fries $1.00Drink $3.00


Send Item Node (Hamburger) with Tax

Send Stored with Item Node (Drink) and Total Node containing Tax

Send Item Node (French Fries) with Tax

Order sent 1 behind

Figure 6: One Behind, Normal Drive-Up Customer Order with Taxes Sample Flow Diagram



Pre-Conditions Post-Conditions Data NODES Covered by This Use Case POSLog POSLogTransaction CustomerOrderTransaction POSLogRetailTransaction RetailTransactionLineItem RetailTransactionSale RetailTransactionItem RetailTransactionTax RetailTransactionTotal

1-04-02a Conformance XML Instance Document - Customer Order with Taxes - Send Item Hamburger with Tax HighStreet POS5 4294967295 2001-08-13T09:01:00 John 1 123 Dispatch 5.00 2 .25 5



1-04-02b Conformance XML Instance Document - Customer Order with Taxes - Send Item Add French Fries with Tax HighStreet POS5 4294967295 2001-08-13T09:01:00 John 3 2345 Dispatch 1.00 4 .30 5

1-04-02c Conformance XML Instance Document - Customer Order with Taxes - Send Item Add Drink with total and tax


IXRetail POSLog Foodservice Technical Specification Vol 1 Customer Order Entry HighStreet POS5 4294967295 2001-08-13T09:01:00 John 5 2345 Dispatch 3.00 6 .45 7 9.45

1-04-02d Conformance XML Instance Document - Customer Order with Taxes - Customer picks up the food and a POSLog Retail Transaction is created. HighStreet POS5 4294967295 2001-08-13T09:01:00 John 1


IXRetail POSLog Foodservice Technical Specification Vol 1 Customer Order Entry 123 5.00 2 2345 1.00 3 2345 3.00 4 .45 7 9.45



4.3 Scenario: One Behind, Normal Drive Up Customer Order with Subtotal Brief Description

Drives up andstarts order

Custom er

Order Ham burger

OCBHam burger $5.00

Subtotal $5.00

Order French Fries

Order Drink

Through with OrderOrder Gets S tored

OCBHam burger $5.00French Fries $1.00

Sutotal $6.00Tax $0.35Total $6.35

OCBHam burger $5.00Tater Tots $0.75Drink $3.00Ice Cream $1.00


Send Item Node(Ham burger)

Send Item Node(Drink)

Send Subtotal withItem Node (FrenchFries) and TotalNode containingTax

Order sent 1 behind

Subtotal KeyPressed

Order Ice Cream

OCBHam burger $5.00Tater Tots $0.75Drink $3.00

Sutotal $8.75

Send S tored withItem Node (IceCream ) and TotalNode containingTax

Nothing gets sentbecause it's 1 behind

Figure 7: One Behind, Normal Drive Up Customer Order with Subtotal Sample Flow Diagram



Pre-Conditions Post-Conditions Data NODES Covered by This Use Case POSLog POSLogTransaction CustomerOrderTransaction POSLogRetailTransaction RetailTransactionLineItem RetailTransactionSale RetailTransactionItem RetailTransactionTax RetailTransactionTotal

1-04-03a Conformance XML Instance Document - Customer Order with Subtotal - Send Item Hamburger HighStreet POS5 4294967295 2001-08-13T09:01:00 John 1 123 Dispatch 5.00



1-04-03b Conformance XML Instance Document - Customer Order with Subtotal - Send Subtotal with tax HighStreet POS5 4294967295 2001-08-13T09:01:00 John 2 2345 Dispatch 1.00 3 .35 7 6.35

1-04-03c Conformance XML Instance Document - Customer Order with Subtotal - Send Item Drink HighStreet POS5 4294967295 2001-08-13T09:01:00 John


IXRetail POSLog Foodservice Technical Specification Vol 1 Customer Order Entry 4 2345 Dispatch 3.00

1-04-03d Conformance XML Instance Document - Customer Order with Subtotal - Send Item on Store Ice Cream HighStreet POS5 4294967295 2001-08-13T09:01:00 John 5 9876 Dispatch 1.00 6 .45 7 9.75 10.20



1-04-03e Conformance XML Instance Document - Customer Order with Subtotal - Customer picks up the food and a POSLog Retail Transaction is created. HighStreet POS5 4294967295 2001-08-13T09:01:00 John 1 123 5.00 2 2345 1.00 3 2345 3.00 4


IXRetail POSLog Foodservice Technical Specification Vol 1 Customer Order Entry 9876 1.00 5 .45 7 10.20 4.4 Scenario: Web Interface Sale to Store System Order Entry and Order Payment (via credit card or other approved method) are preformed by the customer via web interface to the store system. Brief Description Product is entered into the system by the customer thru a Web Interface. The transaction is Stored/Saved until the customer arrives on-site to pick up the order or until the order is devired to the customer. At that time, the order is recalled and re-opened on the same or on a different terminal, by the same or a different operator. If/when order entry is completed; Payment is made by cash, credit card/debit/gift card, house charge or other. If applicable, a cash or charge Tip may be added to the transaction total. The order is completed, and Product Delivered is done. When the process is completed, the order is closed and archived. Taxing rules are determined based on appropriate Taxation parameters. Inventory usage is determined based on appropriate recipe usage including off-premises packaging. Scenario Description Suzy orders a cheese pizza from Mamma Lous Web Site to be delivered to her home. Pre-Conditions



Post-Conditions Assumptions Multiple registers dont matter as the order originated from the web

Data NODES Covered by This Use Case POSLog POSLogTransaction CustomerOrderTransaction POSLogRetailTransaction RetailTransactionLineItem RetailTransactionSaleForDelivery RetailTransactionItem RetailTransactionTax RetailTransactionTotal RetailTransactionCustomer

1-04-04a Conformance XML Instance Document Customer Order thru Web Interface Sale To Store System. Mamma Lou's Web Site 125 1 56786578 Sent 13.11


IXRetail POSLog Foodservice Technical Specification Vol 1 Customer Order Entry 12341234 Suzy 125 E North Street Mid-America Oklahoma 77777

1-04-04b Conformance XML Instance Document Web Interface Sale to Store System Final Retail Transaction. Mamma Lou's Web Site 125 1 56786578 13.11 2 13.11 12341234 Suzy 125 E North Street Mid-America Oklahoma 77777


IXRetail POSLog Foodservice Technical Specification Vol 1 Customer Order Entry 4.5 Scenario: Call Center Sale Order entry and payment (via credit card or other approved method) are preformed by the customer at a Call Center. Brief Description The Call Center routes the order to the appropriate store for Order Processing and Product Delivery to the store system. The transaction is Stored/Saved into the store POS System until the customer arrives on-site to pick up the order. Product Delivery is performed at a store based terminal. Product is entered into the system via the Call Center interface to the in-store system; Payment is made by credit card, house charge or other means. If applicable, a cash or charge Tip may be added to the transaction total. When the customer arrives at the store, the order is recalled on Terminal B by an Operator A. If needed, additional product can be added to or changes made to the order. If/when order entry is completed, Product Delivered is done. When the process is completed, the order is archived. Taxing rules are determined based on appropriate Taxation parameters. Inventory usage is determined based on appropriate recipe usage including off-premises packaging. Capture the name of the call center in case of multiple call centers

Scenario Description Joe calls in a pizza to the pizza call center and pays for it with a credit card. The call center routes the order to Harrys Pizza Parlor. Then tell Joe to where to pick up the pizza. Pre-Conditions Post-Conditions Data NODES Covered by This Use Case POSLog POSLogTransaction CustomerOrderTransaction POSLogRetailTransaction RetailTransactionLineItem



RetailTransactionSale RetailTransactionItem RetailTransactionTax RetailTransactionTender TenderCreditDebit TenderAuthorization RetailTransactionTotal

1-04-05a Conformance XML Instance Document Call Center Order with Tender Harry's Pizza Call Center 125 1 56786578 Sent 13.11 2 13.11 465346 1234567890



1-04-05b Conformance XML Instance Document Retail Transaction to Record Call Center Order Harry's Pizza POS5 125 1 56786578 13.11 2 13.11 465346 1234567890 4.6 Scenario: Kiosk Sale Order entry and payment (via credit card or other approved method) are preformed by the customer at a Kiosk in the store lobby. Brief Description The Kiosk is part of the in-store POS system deriving menu item names, pricing, tax tables etc from the POS systems database in real time or via database download from the POS system. Product Delivery is performed by an operator at the front counter. Product is entered into the system via the Call Center interface to the in-store system; Payment is made by credit card, house charge or other means. If applicable, a cash or charge Tip may be added to the transaction total. When the customer arrives at the store, the



order is recalled on Terminal B by an Operator A. If needed, additional product can be added to or changes made to the order. If/when order entry is completed, Product Delivered is done. When the process is completed, the order is archived. Taxing rules are determined based on appropriate Taxation parameters. Inventory usage is determined based on appropriate recipe usage including off-premises packaging. Scenario Description Dillon walks up to the kiosk located in the deli lobby and orders a ham and cheese sandwich for which he pays with cash. He then walks to the check out line where he picks up his sandwich. Pre-Conditions Post-Conditions Data NODES Covered by This Use Case POSLog POSLogTransaction CustomerOrderTransaction POSLogRetailTransaction RetailTransactionLineItem RetailTransactionSale RetailTransactionItem RetailTransactionTax RetailTransactionTender RetailTransactionTotal

1-04-06a Conformance XML Instance Document Kiosk Customer Order Harry's Pizza Kiosk 1 125 1


IXRetail POSLog Foodservice Technical Specification Vol 1 Customer Order Entry 56786578 Dispatch 13.11

1-04-06b Conformance XML Instance Document Kiosk Retail Transaction When the previously paid for Order is picked up, it becomes a Retail Transaction. Harry's Pizza Kiosk 1 125 1 56786578 13.11 2 13.11 465346 1234567890



5. USE CASE: MODIFY SALES

Data Hierarchy Diagram This use case deals with this area of the schema

Figure 8: One Behind, Normal Drive Up Order with Customer Changing the Order Domain View



5.1 Scenario: One Behind, Normal Drive Up Customer Order with Customer Changing the Order Brief Description The customer orders Sandwich A and then changes his mind to want Sandwich B. The order taker cancels Sandwich A and enters Sandwich B before the order is totaled. The effect is as if Sandwich A was never entered in the sale other than the currency value of the Item cancels for that operator is increased by the currency value of Sanswich A for tracking purposes.



Drives up andstarts order

Customer

Order Hamburger

OCBHamburger $5.00

Subtotal $5.00

Order French Fries

OCBHamburger $5.00French Fries $1.00

Subtotal $6.00

Order Drink

Through with OrderOrder Gets Stored

OCBHamburger $5.00French Fries $1.00Drink $3.00

Sutotal $9.00Tax $0.45Total $9.45Customer Changes

Mind

Order Taker recallsorder

Customer changesFrench Fries to

Tater Tots

OCBHamburger $5.00Tater Tots $0.75Drink $3.00


Send Item Node(Hamburger)

Send Item Node(French Fries)

Send Stored withItem Node (Drink)and Total Nodecontaining Tax

Send Item withvoid for FrenchFries and Add forTater Tots

Send Total withTotal Nodecotaining Tax

Recall the order

Order sent 1 behind

Figure 9: One Behind, Normal Drive Up Order with Customer Changing the Order Sample Flow Diagram



Brief Description Pre-Conditions Post-Conditions

Data NODES Covered by This Use Case POSLog POSLogTransaction CustomerOrderTransaction POSLogRetailTransaction RetailTransactionLineItem RetailTransactionSale RetailTransactionItem RetailTransactionTax RetailTransactionTotal

1-05-01a Conformance XML Instance Document Customer Changing the Order Send Item Hamburger HighStreet POS5 4294967295 2001-08-13T09:01:00 John 1 123 Sent 5.00



1-05-01b Conformance XML Instance Document Customer Changing the Order Send Item French Fries HighStreet POS5 4294967295 2001-08-13T09:01:00 John 2 2345 Sent 1.00

1-05-01c Conformance XML Instance Document Customer Changing the Order Store Order Send Item Drink with total and tax HighStreet POS5 4294967295 2001-08-13T09:01:00 John


IXRetail POSLog Foodservice Technical Specification Vol 1 Customer Order Entry 3 2345 Sent 3.00 4 .45 7 9.45

1-05-01d Conformance XML Instance Document Customer Changing the Order Recall Order remove FF add tater tots HighStreet POS5 4294967295 2001-08-13T09:01:00 John 5 2


IXRetail POSLog Foodservice Technical Specification Vol 1 Customer Order Entry 6 Yummy Sent .75 7 .45 7 8 .40 7 9.15

1-05-01e Conformance XML Instance Document Customer Changing the Order Customer picks up the food and a POSLog Retail Transaction is created. Assuming one wants to track every change HighStreet POS5 4294967295


IXRetail POSLog Foodservice Technical Specification Vol 1 Customer Order Entry 2001-08-13T09:01:00 John 1 123 5.00 2 2345 1.00 3 2345 3.00 4 .45 7 5 2345 1.00


IXRetail POSLog Foodservice Technical Specification Vol 1 Customer Order Entry 2 6 Yummy .75 7 .45 7 8 .40 7 9.15



5.2 Scenario: Add Modifiers to an Item Brief Description Suzy wants to add Pickles and Onions to her order. Note these dont add to the price

Richard's DeliOklahoma City, Ok

10/25/200011:49AM

Order #10006

Sub Total 3.55Tax .25Total 3.80

Tendered 3.80

Hamburger 3.55+ Pickles+ Onions

Figure 10: Add Modifiers to an Item Receipt Example

Pre-Conditions Post-Conditions Data NODES Covered by This Use Case POSLog POSLogTransaction CustomerOrderTransaction POSLogRetailTransaction RetailTransactionLineItem



RetailTransactionSale RetailTransactionItem ItemType RetailTransactionTax RetailTransactionTender RetailTransactionTotal

1-05-02a Conformance XML Instance Document Customer Order Add Modifiers to an Item Richards Deli POS5 10006 2000-10-25T11:49:00 John 1 01234567890123 Hold 3.55 2345 0 6789 0


IXRetail POSLog Foodservice Technical Specification Vol 1 Customer Order Entry 2 .25 7 3 3.80

5.3 Scenario: Add Special Instructions to an Item Brief Description The prep instruction is specific to an individual item.

Deli Sandwich (*) cut in half

Ribeye (*) well done

Fillet (*) medium (*) butterfly

Scenario Description Hirano-san entered Richards Deli and ordered a well-done ribeye.



Figure 11: Add Special Instructions to an Item Receipt Example Pre-Conditions Post-Conditions Data NOD