XML DictionaryVersion 3.0 Build 3 Copyright 2001, National Retail Federation. |
Note: Text and definitions in red denotes draft elements, synonyms, attributes and enumerations.
| Tag | Type | Definition |
|---|---|---|
| Associate | structure | A subType of RetailTransactionLineItem that records actions by Employees in a RetailTransactionSynonyms
Attributes
|
| DateTime | DateTime | When was the action performed |
| PersonName | struct | The name of the Associate in a parsed form (i.e. broken down into first, middle & last) |
| Tag | Type | Definition |
|---|---|---|
| Authorization | structure | Additional data used to record data about authorizations for Cheques, Credit Cards and Debit Cards. |
| RequestedAmount | currency | The amount authorization was requested for. |
| AuthorizationCode | string | |
| ReferenceNumber | string | |
| ProviderID | string | |
| AuthorizationDateTime | date | The Date & Time the authorization was performed. |
| AuthorizedChangeAmount | currency | The amount of change that has been authorized. |
| HostAuthorized | boolean | Was this authorization performed by an external authorization host? |
| AuthorizingTermID | string | A unique identifier for the Terminal that requested the authorization. |
| ForceOnLine | boolean | Was the authorization forced to be Online? |
| ElectronicSignature | boolean | Was the customer signature required as part of the authorization captured electronically? |
| PreAuthorizationFlag | boolean | Did this authorization happen before transaction was completed? Used in Pay-At-Pump systems in Forecourt segment. |
| Reversal | struct | Extra data from an original Authorization which is Reversed by the current Authorization |
| Tag | Type | Definition |
|---|---|---|
| Contact | structure | The contact person for the PurchaseOrder |
| ContactTypeCode | string | A code used to categorize different kinds of contact. |
| Effective Date | date | The start date of a PERSON's affiliation with an organization. |
| FunctionCode | string | A code to identify the major duty or responsibility of the contact. These codes relate to the UCC data element 366. |
| OrganizationPartyID | string | A unique, automatically assigned identity for a PARTY. |
| Party Role | string | A code that identifies a group of PARTY ROLES. This is used for subtyping the PARTY ROLEs. |
| PersonOrganizationAffilationTypeName | string | A name or label for a group of affiliations of people and organizations. For instance, this might be 'employment'. |
| PersonPartyID | string | A unique, automatically assigned identity for a PARTY. |
| Tag | Type | Definition |
|---|---|---|
| ContractInfo | structure | A structure defining an IXRetail contract. |
| ContractID | xs:string | A unique identifier for the contract |
| Description | xs:string | The a short description of the Contract |
| Schema | xs:uri | URI being a location of an XML Schema that defines the contract. |
| InformationSource | xs:uri | URI being a location of an XML Schema that describes the contract. |
| Tag | Type | Definition |
|---|---|---|
| CustomerAccountTenderLineItem | structure | A subType of RetailTransactionTenderLineItem that records a transaction being charged to a customerAccountSynonyms
|
| AccountNumber | string | The CustomerAccount the transaction is being charged againstAttributes
|
| BalanceForward | currency | The new balance of the CustomerAccount after the transaction has been charged against it |
| Tag | Type | Definition |
|---|---|---|
| Error | structure | |
| ErrorID | string | A unique identifier for the Error. |
| ErrorText | string | The actual error text |
| Tag | Type | Definition |
|---|---|---|
| Fleet | structure | Additional data used for Fleet Management, in the Forecourt segment of retail. |
| DriverID | string | A unique identifier for the driver of the vehicle being fueled. |
| VehicleID | string | A unique identifier for the vehicle being fueled. |
| TemporaryCar | boolean | Is the vehicle being filled, a temporary member of the fleet? |
| OdometerReading | integer | The odometer reading on the vehicle being fueled at the time of being fueled. |
| JobID | string | A unique identifier for the fuel transaction, provided by the customer.Synonyms
|
| Tag | Type | Definition |
|---|---|---|
| Hospitality | structure | Element containing hospitality information (e.g. TableNo, PartySize etc..) for a RetailTransaction conducted in a restaurant or bar |
| TableID | integer | Which table is the transaction conducted at |
| PartySize | integer | How many people were in the party at the table? |
| Tag | Type | Definition |
|---|---|---|
| ItemQualification | structure | cf. Qualification |
| Tag | Type | Definition |
|---|---|---|
| LoyaltyRedemption | structure | A subType of RetailTransactionLineItem that records the redemption of LoyaltyPoints & Vouchers previously awarded to the customer. |
| Voucher | struct | A special Voucher for a specific product or service, that is issued or redeemed as part of a CustomerLoyalty scheme. Not to be confused with a GiftCertificate which has a monetary value |
| Tag | Type | Definition |
|---|---|---|
| LoyaltyReward | structure | A subType of RetailTransactionLineItem that records gifts & other loyalty rewards given to the Customer as a consequence of a RetailTransaction |
| LoyaltyPointsAwarded | A kind of RetailTransaction LineItem that record the awarding of LoyaltyPoints as part of a purchaseAttributes
|
|
| PromotionID | integer | Which promotion triggered the gift or loyalty reward |
| ReasonCode | string | Reason for the gift or loyalty reward |
| Voucher | struct | A special Voucher for a specific product or service, that is issued or redeemed as part of a CustomerLoyalty scheme. Not to be confused with a GiftCertificate which has a monetary value |
| Tag | Type | Definition |
|---|---|---|
| OperatorByPassApproval | structure | What approval (e.g. Supervisor password) was performed to allow OperatorByPass |
| Tag | Type | Definition |
|---|---|---|
| OriginalTransaction | structure | The identifiers of another RetailTransaction that validates a MerchandiseReturnSynonyms
Attributes
|
| Tag | Type | Definition |
|---|---|---|
| PaymentCard | structure | Details about an ISO card used in tendering a transactionAttributes
|
| CardExpirationDate | string | The Card Expiration Date as encoded on Track 2 of the card |
| CardHolderName | string | The Card Holder Name as encoded on Track 3 of the card |
| Tag | Type | Definition |
|---|---|---|
| PersonName | structure | The name of the Associate in a parsed form (i.e. broken down into first, middle & last) |
| Tag | Type | Definition |
|---|---|---|
| PurchaseOrderTenderLineItem | structure | A subType of RetailTransactionTenderLineItem that records a transaction being completed with a PurchaseOrder supplied by the customerSynonyms
|
| PurchaseOrderID | string | The ID number on the PurchaseOrder provided by the customer |
| AuthorizedAmount | currency | The amount authorized on the PurchaseOrder provided by the customer |
| Contact | struct | The contact person for the PurchaseOrder |
| Date | Date | The Date on the PurchaseOrder provided by the customer |
| Tag | Type | Definition |
|---|---|---|
| Qualification | structure | Eligibilities can be qualified by various means not defined by ARTS or IXRetail e.g. Retailer & Manufacturer Coupons, Item Colors etc... Such qualifications are defined by Name/Value pairs, with an optional operator. Synonyms
|
| Name | string | |
| Value | string | |
| Operator | string |
| Tag | Type | Definition |
|---|---|---|
| QualificationInfo | structure | A structure defining ItemQualifications as part of an IXRetail contract. |
| AllowableType | xs:string | |
| AllowableValue | xs:string |
| Tag | Type | Definition |
|---|---|---|
| Receipt | structure | A document given to the customer as a proof of purchase or other transaction.Attributes
|
| HeaderText | string | A generic piece of descriptive text, normally printed at the top of a receipt |
| TrailerText | string | A generic piece of text, normally printed at the bottom of a receipt |
| PromotionText | string | Any valid XHTML normally promotional material that is printed at the bottom of a receipt |
| Issuer | element | The name of the organization that is issuing a receipt |
| Recipient | element | The Name and possibly Address of the person or organization the receipt is being issued to. |
| CopyTo | element | The Name and possibly Address of an extra person or organization the receipt is being copied to. |
| RelatedReceipt | string | The TransactionID from a related receipt. |
| TransactionDetail | abstract element | An abstract element which is defined in the XML Instance Document by referring to another XML Schema |
| RetailReference | struct | A structure containing the fields required to identify a RetailTransaction |
| MerchantID | string | The name of the Retail Enterprise that is issuing the receipt |
| PrintCode | string | The collection of characters that are printed on a receipt to denote the taxability (or other status) of the item |
| Tag | Type | Definition |
|---|---|---|
| RestrictionValidation | structure | When a transaction involves selling of restricted products (e.g. Firearms & Ammunition), how was the customer's eligibility for the restricted products validated?Attributes
|
| QuestionText | string | What question was asked as a part of the RestrictionValidation. |
| OperatorByPassFlag | boolean | Was the restriction by-passed by the Operator? |
| OperatorByPassApproval | struct | What approval (e.g. Supervisor password) was performed to allow OperatorByPass |
| QuestionAnswer | string | What is the answer to the question asked as part of the Restriction Validation process. |
| Tag | Type | Definition |
|---|---|---|
| RetailReference | structure | A structure containing the fields required to identify a RetailTransaction |
| TransactionNumber | ||
| MerchantID | string | The name of the Retail Enterprise that is issuing the receipt |
| Tag | Type | Definition |
|---|---|---|
| ReturnItem | structure | A subType of RetailTransactionLineItem that records the return of an itemAttributes
|
| Tag | Type | Definition |
|---|---|---|
| Reversal | structure | Extra data from an original Authorization which is Reversed by the current Authorization |
| OrigAmount | currency | The amount of the original Authorization being reversed |
| OrigApprovalCode | string | The ApprovalCode of the orignal Authorization being reversed. |
| OrigReferenceNumber | string | The ReferenceNumber of the original Authorization being reversed. |
| Tag | Type | Definition |
|---|---|---|
| Shipment | structure | |
| ShipmentTrackingID | string | Attributes
|
| ServiceLevel | string | Attributes
|
| Tag | Type | Definition |
|---|---|---|
| Shipping | structure | A subType of RetailTransactionLineItem that records different shipping, handling & insurance costs, that are included in the sale |
| Tag | Type | Definition |
|---|---|---|
| ShoppingCartItem | structure | An item in a ShoppingCart. |
| Tag | Type | Definition |
|---|---|---|
| TaxOverride | structure | A subType of tax exemption that changes the tax rate, rather than forgiving tax |
| TaxOverrideID | string | |
| OriginalTaxRuleID | string | The TaxRule that is being overriden. |
| OriginalTaxPercent | decimal | The tax rate percentage that is being overriden. |
| OriginalTaxAmount | currency | The tax amount that is being overriden. |
| Tag | Type | Definition |
|---|---|---|
| Voucher | structure | A special Voucher for a specific product or service, that is issued or redeemed as part of a CustomerLoyalty scheme. Not to be confused with a GiftCertificate which has a monetary value |
| VoucherID | string | A unique identifier for the Voucher |
| Tag | Type | Definition |
|---|---|---|
| Warning | structure | |
| WarningID | string | A unique identifier for the Warning. |
| WarningText | string | The actual warning text |