ActivationDateTime

ItemGroup

Not supported.

None

AllowPendingFlag

Item

Item can be sold in a pending transaction such as a layaway.

None

true or false.

true or false.

Item

Allows entry of a zero price by the POS user.

None

true or false.

AlternateId

AlternateId List

This element provides a single alternate identifier for the given item (such as a PLU number). More then one AlternateId is allowed within the AlternateIdList container element.cd

IdType - For the list of valid IdType values see the IdType attribute of ItemID element.

AlternateIdList

Item

This element provides for a list of alternate identifiers for the given item.

None

Amount

Permanent Price

A monetary value. For example, it can be used to specify a price or a tax. The monetary amount is in the base currency for the system.

None

Numeric value, with decimals allowed.

Attribute

AttributeLi st

This element provides a single product attribute for a given item. More than one Attribute is allowed within the AttributeList container element.

Action - for the list of valid actions see the action attribute of the element Item.

AttributeID

Attribute

Specifies an identifier for a product attribute. Essentially this is the name in a name value pair that makes up a product attribute.

None

AttributeList

Item or Level

Collection of attributes of the business entity described by the container element. Use is the same within either parent element.

None

AttributeValue

Attribute

The value of the product attribute. Essentially this is the value in a name value pair that makes up a product attribute.

None

Body

ItemMaint enance

Element of the XML document containing the information payload. All EPOS XML documents contain a header and a body section.

None

ConfirmReqiredFlag

Item

Provides for prompt for confirmation by the POS user when an item is sold or returned.

None

true or false

ContainedItemID

Pack if Pack under PackHierar chy

The itemID of an item that is contained within the pack (of items).

None

Cost

Item

This element defines the base cost, to the retailer, of the item, in the base currency of the store.

None

Numeric value, with decimals allowed.

DealAmount

Permanent Price

An amount associated with a specific pricing method. The pricing methods for which this element is used are LimitedQuantity, ReducedPricing, and GroupThreshhold.

None

Numeric value, with decimals allowed.

Deposit

Item

The deposit amount included in the item price.

None

Description

Item, Level, or Pack

This provides a description of the business entity in which it is contained. For example, item, level, or pack.

None

DiscountableFlag

Item

This flag indicates whether or not this item is eligible for discounts.

None

true or false

DiscountGroupID

Item

Specifies a configured discount that will be applied to the given item.

None

EffectiveBusinessDay Date

FuturePric e

This is the business date on which the future price takes effect.

None

FixedTax

Price, Permanent Price, FuturePric e, or MSRP

Defines a fixed tax amount associated with a given taxing authority. Use is the same within either parent element.

None

FoodStampEligibility

Item

Not implemented. Deprecated and marked for removal. Use RestrictionGroupId element.

None

true or false

FuturePrice

Permanent Price

Defines the price definition for an item that will take effect at a later time defined by the EffectiveBusinessDayDat e sub-element.

When importing future price data using MDI imports, it is required that both the current regular price and the future price be specified in the ItemMaintenance XML import file.

None

InventoryControlFlag

Item

None

true or false

Item

ItemGroup

This element contains all the information about a single item in the item maintenance XML document. A document can contain more than one item element.

Action - the action to be performed for this item. Options include:

"Add" (to add a new item)

Action - the action to be performed for this item. Options include: "Add" (to add a new item) "AddUpdate" (to add information or update information for an existing item)

"Update" (to update information for an existing item) "Delete" (to delete an existing item). (to add information or update information for an existing item)

"Update" (to update information for an existing item)

"Delete" (to delete an existing item).

ItemGroup

Body

Define a new item group section in the XML document body. There must be at least one ItemGoup element within the document body. This element is currently a placeholder reserved for future use.

None

ItemID

Item

Provides a unique identifier for an item.

IdType - The main form of identifier being used for this item. Options include: "SKU", "UPC", "PLU", "MFG", "ISBN", "GTIN" and "EAN".

ItemMaintenance

Outer-Mos t Element in Item Maintenan ce Document

Defines the boundaries of the item maintenance xml input document and the location of the relevant xml schema definition information.

xmlns - Specifies the namespace of the xml schema.

xmlns:xsi - Specifies the xsi standard namespace of the schema.

xsi:schema Location - Provides a name value pair consisting of a namespace followed by the path/ schema file separated by a space.

Version - Version number for this schema.

ItemType

Item

Not supported, reserved for future use.

None

While this is not supported it is recommended that, if present, the element should be set to "Stock".

Level

MerchandiseHierarchy

The merchandise hierarchy section allows specification of the retail hierarchy graph to which the item belongs. The preferred method is to specify the full hierarchy path (level node graph) for an item. However, the import will also except one if it is a hierarchy graph node at the level to which items are associated. The hierarchy nodes are not entered in the configurator and must be imported using the ItemHierarchyMaintenace import XML.

Id - The hierarchy level identification code in which the provided hierarchy graph node is defined.

The levels are alphanumeric values and must match a hierarchy node identifier in the item hierarchy at the level specified.

Level

Item

Allows for the definition of price information for different variants of item characteristics represented by a LevelID. Additional information that can be defined in the Level element include product attributes, alternate description, and prompt for price flag.

LevelID - A level identifier defied by the retailer.

Action - for the list of valid actions see the action attribute of the element Item.

LinkedItemId

LinkedItemList

The identifier of another item to which this item is linked. This referenced linked item (LinkedItemID) is linked to the current item (ItemID) when the current item is sold or returned.

IdType - for the list of valid IdType values see the IdType attribute of the ItemID element.

LinkedItemList

Item

This section allows you to link additional items to this item.You link two items together if they must be sold or returned together. Note that the list of linked items is currently limited to one item.

None

Add: See example under

<LinkedItemId>

MaximumQuantity

Item

Defines the maximum number of an item that can be purchased in a given transaction.

None

MaxPrice

Item

This is the maximum price allowed for by manual adjustment.

None

MerchandiseHierarchy

Item

Defines a node in the lowest level of the merchandise hierarchy to which the item is associated. The hierarchy nodes are not entered in the configurator and must be imported using the ItemHierarchyMaintenan ce import XML.

None

Add: See example under

<Level> for MerchandiseHierarchy

MinimumQuantity

Item

Defines the minimum number of an item that can be purchased in a given transaction.

None

MinPrice

Item

This is the minimum price allowed for by manual adjustment.

MixmatchGroup

Permanent Price, FuturePric e, Price, or MSRP

Identifies the mix match group to which the item is associated. Use is the same within any parent element.

None

MSRP

Item

Manufacturers Suggested Retail Price for the item.

None

Pack

Item

Not supported.

None

PackQuantity

Pack

Not supported.

None

PackHierarchy

Item

This element allows you to define the Packed and Contained relationship for the Bottle and Deposit feature.

PackQuantityFlag

Pack

Not supported.

None

true or false

PermanentPrice

Price (If the Price element occurs under the Item element as the parent).

This element allows for the definition of the permanent pricing information for the given item.

None

Price

Item

This section allows you to define detailed pricing information for the given base item.

RequireUseOfThisPrice

(optional) - Indicates whether a local price change should be overwritten with any new pricing information . Allowed value is true or false.

Price

Level

Defines the pricing information for the item level.

Action - for the list of valid actions see the action attribute of the element Item.

PriceEntryRequiredFlag

Item

This flag indicates if a price must be manually entered for the given base item.

None

true or false

PriceEntryRequiredFlag

Level

This flag indicates that the price must be manually entered for a level item.

None

true or false

PriceMethod

Permanent Price, FuturePric e, Price, or MSRP

This element determines the pricing method to be used for this item. Note that, if this element is not present in the file, the pricing method is assumed to be "UnitPrice". Use is the same within any parent element.

None

One of the following defined options:

PriceOverridableFlag

Item

This flag indicates whether the set price for this item can be manually overridden or not.

None

true or false

PriceVerifyFlag

Item

This flag specifies whether or not a price prompt is displayed and accepted or altered as desired.

None

true or false

PrintMsrp

Item

Specifies whether or not the MSRP is printed on the receipt.

None

true or false

QuantityRequiredFlag

Item

This flag indicates if a quantity must be entered for this item. If false, then the UnitOfMeasure is countable. If true, then UnitOfMeasure is assumed to be "unit". Unit is a well known configuration of unit of measure defined in the Configurator.

None

true or false

Quantity

Permanent Price, FuturePrice, Price, or MSRP

The Quantity represents a quantity that is part of the price definition. As an example in a 3 for the price of 1, this is the "3". For the "BasePlusOne" and "HighestPrice" pricing methods, the quantity is often called a multiple. For other pricing types, this represents a quantity threshold. Use is the same within any parent element.

None

QuantityAllowedFlag

Item

This flag indicates if a quantity can be entered for this item.

Note: If false, then all entries of the particular item must be made individually.

None

true or false

RequiredDataType

SellRequiredInfo or ReturnRequiredInfo

An identifier used to link a given item for input of the sell required information or return required information. Use is the same within either parent element.

None

RestrictionGroupID

Item

This element allows specification of the restriction group to which this item belongs.

An example of a restriction group would be minimum age limit for purchase. Not currently supported.

None

ReturnableFlag

Item

This flag indicates if this item can be returned after purchase.

None

true or false

ReturnCustomerProfileID

Item

Identifies the customer profile that should be used to look up this customer for the item when doing a return.

None

ReturnDateEligibilityID

Item

Identifies a configured date eligibility rule that is applied when doing an item return.

None

ReturnDocument

Item

This element allows you to specify a document that must be printed when this item is returned (for example, a customer reason card). These documents are defined in the Configurator.

None

The ReturnDocument element is a string that contains a series of triplets defining the return document contents. The syntax is as follows:

[DocumentName, Destination,Timing]

Where:

DocumentName is the Document ID defined in the Configurator.. Destination is one of:

Receipt - the default, receipt printer.

Slip - the default slip printer.

Journal - the default, journal printer.

Popup - the POS user interface pop-up window.

EJV - the document is archived to the POS transaction log and is available for viewing via the electronic journal viewer.

LPT - the default LPT printer.

Info - the POS user interface information window.

Detail - the POS user interface detail window.

ScrnRcpt - the POS user on screen receipt.

Prompt - The POS user interface prompt window.

Instruction - the POS user interface instruction window.

System - The POS user interface system window.

ReturnDocument cont’d.

Timing is one of:

EOT - The Document is triggered at the end of a transaction and is composed using the entire transaction detail.

Now - The Documentis triggered immediately and contains only information relating to the current function. For example, the details of the Item Sale, but not the entire Transaction.

Later - The Document is triggered at the end of a transaction and contains only information relating to the current function. For example, the details of the Item Sale, but not the entire Transaction.

Note that Document Names, Destinations, and Timings are case sensitive.

Multiple occurrences are allowed. For example, [DocumentName1,Destinati on,Timing] [DocumentName2,Destinati on,Timing] [DocumentName3,Destinati on,Timing].

ReturnRequiredInfo

Item

Specifies a list of data types required for returning this item.

None

SellableFlag

Item

This flag indicates whether this item can be sold. An example of a non-sellable item might be an item that has been recently recalled or scheduled to be pulled from shelves.

None

true or false

SellCustomerProfileID

Item

Identifies the customer profile that should be used to look up this customer for the item when doing a sale.

None

SellDateEligibilityID

Item

Identifies a configured date eligibility rule that is applied when doing an item sale.

None

SellDocument

Item

This element provides for specification of a document that must be printed when this item is sold (for example, a warranty card). These documents are defined in the Configurator.

The SellDocument element is a string that contains a series of triplets defining the return document contents. The syntax is as follows:

[DocumentName, Destination,Timing]

Where:

DocumentName is the Document ID defined in the Configurator.. Destination is one of:

Receipt - the default, receipt printer.

Slip - the default slip printer.

Journal - the default, journal printer.

Popup - the POS user interface pop-up window.

EJV - the document is archived to the POS transaction log and is available for viewing via the electronic journal viewer.

LPT - the default LPT printer.

Info - the POS user interface information window.

Detail - the POS user interface detail window.

ScrnRcpt - the POS user on screen receipt.

Prompt - The POS user interface prompt window.

Instruction - the POS user interface instruction window.

System - The POS user interface system window.

SellDocument cont’d.

Timing is one of: EOT - The Document is triggered at the end of a transaction and is composed using the entire transaction detail.

Now - The Document is triggered immediately and contains only information relating to the current function. For example, the details of the Item Sale, but not the entire Transaction.

Later - The Document is triggered at the end of a transaction and contains only information relating to the current function. For example, the details of the Item Sale, but not the entire Transaction.

Note that Document Names, Destinations, and Timings are case sensitive.

Multiple occurrences are allowed. For example, [DocumentName1,Destinati on,Timing] [DocumentName2,Destinati on,Timing] [DocumentName3,Destinati on,Timing].

SellMaximumQuantity

Item

The limit on the number of a given item that can "cross the counter" within an entire transaction. This includes both sells and returns.

None

SellRequiredInfo

Item

Specifies a list of data types required for selling this item.

None

SerializedFlag

Item

This flag allows for a prompt for a serial number. This is deprecated. Use <SellRequirednfo> instead.

None

true or false

Sign

Permanent Price or FuturePrice

This element indicates whether the amount to be applied is positive (such as when a customer buys a stock item) or negative (such as when a customer returns bottles for a deposit refund). Use is the same within either parent element.

None

One of the following:

SuspendableFlag

Item

Indicates the item can or cannot be included in a suspended transaction.

None

TaxAuthorityID

FixedTax

Identifier for a tax authority associated with the sale of this item.

None

TaxGroupID

Item

This element specifies the tax group which applies to this item. Tax groups are defined in the Configurator.

None

UnitOfMeasure

Item

The unit of measure by which this item is sold. Must match a unit of measure as defined in the configuration.

None

UseDepartmentSettingsFlag

Item

Use the item type attributes such as tax group, liked item, and attributes. Use those in the linked department rather than those associated with the item.

None

true or false

WeighableFlag

Item

This flag indicates that the item must be weighed. Currently not supported.

None

true or false

WICEligibility - Women with infants and children.

Item

This flag indicates whether this item is a WIC (women with infants and children) subsidy. For future use, currently not supported.

None

true or false