Retail Integration Bus Mappings Report
Release: 13.0.1
Application Name: Retail
Merchandising System
Version 13.0.1
XML-Schema or Node
Name:XItemLocDesc.xsd
Tag Name
Table Name
Column Name
API Req
Description
item
item_loc
item
Yes
The identifier
for the item.
hier_level
*
*
Yes
The level of the
organizational hierarchy to which the hier_value field pertains. Valid
values are CH (chain), AR (area), RE (region), DI (district), S (store),
and W (warehouse).
XItemLocDtl
*
*
Yes
Child
node.
Application Name: Retail
Merchandising System
Version 13.0.1
XML-Schema or Node
Name:XItemLocDtl
Tag Name
Table Name
Column Name
API Req
Description
hier_value
*
*
Yes
The same value
as in the hier_level field.
primary_supp
item_loc
primary_supp
No
The primary
supplier for the item at the location. If not populated on a create
message this will default from the primary supplier on the ITEM_SUPPLIER
table.
primary_cntry
item_loc
primary_cntry
No
The primary
country for the item at the location. If not populated on a create message
this will default from the primary country on the ITEM_SUPP_COUNTRY table.
local_item_desc
item_loc
local_item_desc
No
Local
description for the item at the location. If not populated on the message
this will default from the ITEM_MASTER table.
status
item_loc
status
Yes
The status of
the item at the location. This value must be 'A' (active) on a create
message. On a modify messge it can be 'I' (inactive), 'C' (discontinued),
or 'D' (deleted).
store_ord_mult
item_loc
store_ord_mult
No
The unit type of
the item shipped from the warehouse to the location. Valid values are C
(cases), I (inners), and E (eaches). Eaches will default if left null on a
create message.
receive_as_type
item_loc
receive_as_type
No
The unit in
which the warehouse will receive goods. Valid values are E (eaches) and P
(pack). This field only applies to buyer packs. If the item is not a buyer
pack this field should be null.
taxable_ind
item_loc
taxable_ind
No
Indicates if the
item is taxable at the location. Valid values are 'Y' and 'N'. If not
populated on the message it will default to 'Y'.
ti
item_loc
ti
No
Number of
shipping units (cases) that make up one tier of a pallet. Multiply TI x HI
to get total number of cases for a pallet.
hi
item_loc
hi
No
Number of tiers
that make up a complete pallet (height). Multiply TI x HI to get total
number of cases for a pallet.
daily_waste_pct
item_loc
daily_waste_pct
No
Average
percentage lost from inventory on a daily basis due to natural
wastage.
local_short_desc
item_loc
local_short_desc
No
The local short
description of the item. Will default to the item's short description.
Will be downloaded to the POS.
XItemLocTrt
*
*
*
Child
node.
Application Name: Retail
Merchandising System
Version 13.0.1
XML-Schema or Node
Name:XItemLocTrt
Tag Name
Table Name
Column Name
API Req
Description
launch_date
item_loc_traits
launch_date
No
The date the
item should first be sold at the location. Value will be downloaded to the
POS. No internal processing occurs from this field.
qty_key_options
item_loc_traits
qty_key_options
No
Determines
whether the qty key on a POS should be used for this item at the location.
Valid values are in the code_type 'RPO'. Current values include 'R -
required', 'P - Prohibited', and 'O - Optional'. Additional values can be
added to the code type
manual_price_entry
item_loc_traits
manual_price_entry
No
Determines
whether the price can/should be entered manually on a POS for this item at
the location. Valid values are in the code_type 'RPO'. Current values
include 'R - required', 'P - Prohibited', and 'O - Optional'. Additional
values can be added.
deposit_code
item_loc_traits
deposit_code
No
Indicates
whether a deposit is associated with this item at the location. Values are
in the code_type 'DEPO'. The only processing in RMS is downloading it to
the POS
food_stamp_ind
item_loc_traits
food_stamp_ind
No
Indicates
whether the item is approved for food stamps at the location. This value
will be downloaded to the POS.
wic_ind
item_loc_traits
wic_ind
No
Indicates
whether the item is approved for WIC at the location. This value will be
downloaded to the POS.
proportional_tare_pct
item_loc_traits
proportional_tare_pct
No
For items sold
by weight, this is the proportion of the total weight of a unit of an item
that is packaging.
fixed_tare_value
item_loc_traits
fixed_tare_value
No
Holds the weight
of the packaging in items sold by weight at the location; i.e. if the tare
item is bulk candy, this is weight of the bag and twist tie). The only
processing RMS does is to download it to POS.
fixed_tare_uom
item_loc_traits
fixed_tare_uom
No
Holds the unit
of measure value associated with the tare value. The only processing RMS
does involving the fixed tare value and UOM is downloading it to the POS.
Fixed tare is not subtracted from items sold by weight when sales are
uploaded to RMS, etc
reward_eligible_ind
item_loc_traits
reward_eligible_ind
No
Holds whether
the item is legally valid for various types of bonus point/award programs
at the location. This value will be downloaded to the POS.
natl_brand_comp_item
item_loc_traits
natl_brand_comp_item
No
Holds the
nationally branded item to which you would like to compare the current
item. This nationally branded item must exist as an item in RMS (i.e. on
the item_master table).
return_policy
item_loc_traits
return_policy
No
The return
policy for the item at the location. Valid values are in the code_type
'RETP'. This value will be downloaded to the POS.
stop_sale_ind
item_loc_traits
stop_sale_ind
No
Indicates that
sale of the item should be stopped immediately at the location (i.e. in
case of recall etc). This value will be downloaded to the
POS.
elect_mkt_clubs
item_loc_traits
elect_mtk_clubs
No
Code for the
marketing clubs to which the item belongs at the location. Valid values
are in the code_type 'MTKC'.
report_code
item_loc_traits
report_code
No
Code to
determine which reports the location should run. Values are in the code
type 'REPC'.
req_shelf_life_on_selection
item_loc_traits
req_shelf_life_on_selection
No
Holds the
required shelf life for an item on selection in days. This field is not
required. No RMS processing is based on the value in this field. It is
clients responsibility to communicate this value to external systems that
may need it.
req_shelf_life_on_receipt
item_loc_traits
req_shelf_life_on_receipt
No
Holds the
required shelf life for an item on receipt in days. This field is not
required. No RMS processing is based on the value in this field. It is
clients responsibility to communicate this value to external systems that
may need it for processing
ib_shelf_life
item_loc_traits
ib_shelf_life
No
The Investment
Buy-specific shelf life for the item/location
store_reorderable_ind
item_loc_traits
store_reorderable_ind
No
A code (Y or N)
to indicate whether the store may re-order the item. Will default to N. No
RMS processing is based on the value in this field. It is clients
responsibility to communicate this value to external systems.
rack_size
item_loc_traits
rack_size
No
Indicates the
rack size that should be used for the item. Valid values for the field are
in the code_type 'RACK'. No RMS processing is based on the value in this
field. It is clients responsibility to communicate to external
systems.
full_pallet_item
item_loc_traits
full_pallet_item
No
A code (Y or N)
to indicate whether a store must reorder an item in full pallets only.
Will default to N. No RMS processing is based on the value in this field.
It is clients responsibility to communicate to external
systems.
in_store_market_basket
item_loc_traits
in_store_market_basket
No
The in store
market basket code for this item/location. Valid values for the field are
in the code_type 'STMB'. No RMS processing is based on the value in this
field. It is clients responsibility to communicate this value to external
systems.
storage_location
item_loc_traits
storage_location
No
Holds the
current storage location or bin number for the item at the location. No
RMS processing is based on the value in this field. It is clients
responsibility to communicate this value to external systems that may need
it for processing.
alt_storage_location
item_loc_traits
alt_storage_location
No
Holds the
preferred alternate storage location or bin number for the item at the
location. No RMS processing is based on the value in this field. It is
clients responsibility to communicate this value to external systems that
may need it for processing
returnable_ind
item_loc_traits
returnable_ind
No
This field will
contain a value of 'Y'es when the item can be returned to the
location
refundable_ind
item_loc_traits
refundable_ind
No
This field will
contain a value of 'Y'es when the item is refundable at the
location.
back_order_ind
item_loc_traits
back_order_ind
No
This field will
contain a value of 'Y'es when the item can be back ordered to the
location
create_datetime
item_loc_traits
create_datetime
No
The the time and
date of record creation.
last_update_id
item_loc_traits
last_update_id
No
The user id of
the last user to update the record.
last_update_datetime
item_loc_traits
last_update_datetime
No
The time and
date of the last update of the record.