Retail Integration Bus Mappings Report Release: 13.0.0
Application Name: Retail Management System
Version 13.0.0
XML-Schema or Node Name:AllocDesc.xsd
Tag Name
Table Name
Column Name
API Req
Description
alloc_no
alloc_header
alloc_no
Yes
Contains the number that uniquely identifies the allocation within the system.
doc_type
n/a
n/a
Yes
Specifies the type of document. This value will always be 'A' to signify an allocation.
physical_wh
wh
physical_wh
Yes
The physical wh location where the allocation will originate.
wh
alloc_header
wh
Yes
Contains the number of the warehouse loaction where the allocation will originate.
item
alloc_header
item
Yes
Unique alphanumeric value that identifies the item.
pick_not_before_date
alloc_header
release_date
No
Contains the date on which the allocation should be released from the warehouse for delivery to the store locations.
pick_not_after_date
n/a
n/a
No
This value is calculated by adding code_detail.code desc for code 'DATE' and code_type 'DEFT' to alloc_header.release_date. If the allocation is closed, pick_not_after_date will be a day before pick_not_before_date.
order_type
alloc_header
order_type
No
This field identifies the order associated with the PO. Allocations created before PO approval will be marked as 'PREDIST' ordertypes. Allocations created after PO approval will be marked as 'PO' order types.
order_no
alloc_header
order_no
No
Contains the order number to which the allocation applies.
order_doc_type
n/a
n/a
Yes
This value will always be 'P'.
event
rpm_promo_event
prom_event_id
No
This field contains the event to which the promotion belongs to. This is an optional field that provides a method to group promotions together for tracking and reporting purposes.
event_description
rpm_promo_event
description
No
This field contains the description of the promotional event.
priority
n/a
n/a
Yes
A value which indicates the priority of an allocation. This value will always be 1.
ticket_type_id
item_ticket
ticket_type_id
No
This field contains a character string which uniquely identifies the ticket type which is associated with the item.
AllocDtl
*
*
*
*
context_type
alloc_header
context_type
No
This field holds the functional area code to which the transfer relates to for example Promotions. Valid value is: PROM - Promotion
context_value
alloc_header
context_value
No
The value for the context type
Application Name: Retail Management System
Version 13.0.0
XML-Schema or Node Name:AllocDtl
Tag Name
Table Name
Column Name
API Req
Description
physical_to_loc
alloc_detail
to_loc
Yes
This field contains the physical location to which the allocation is being sent. The loc_type field determinds if the location is a store or a warehouse.
to_loc
alloc_detail
to_loc
Yes
This field contains the location to which the allocation is being sent. The loc_type field determinds if the location is a store or a warehouse.
loc_type
item_loc
loc_type
Yes
This field contains the type of location in the loctaion field. Valid values are 'S'tore and 'W'arehouse.
qty_allocated
alloc_detail
qty_allocated
Yes
Contains the total number of items allocated.
price
item_loc
selling_unit_retail
No
This field holds the unit retail in the selling unit of measure for the item/zone combination. This field is stored in the local currency.
selling_uom
item_loc
selling_uom
No
This field holds the selling unit of measure for an item's single-unit retail.
priority
n/a
n/a
Yes
A value which indicates the priority of an allocation. This value will always be 1.
store_ord_mult
item_loc
store_ord_mult
Yes
This column contains the multiple in which the item needs to be shipped from a warehouse to the location.
AllocDtlTckt
*
*
*
*
in_store_date
alloc_detail
in_store_date
No
Date to be included in the ORMS publication to the RIB for communication to the warehouse. It indicates the date on which the freight needs to reach the location.
rush_flag
alloc_detail
rush_flag
No
It indicates that the item needs to be rushed to the location. It is to be included in the ORMS publication to the RIB for communication to the warehouse.
Application Name: Retail Management System
Version 13.0.0
XML-Schema or Node Name:AllocDtlTckt
Tag Name
Table Name
Column Name
API Req
Description
comp_item
packitem_breakout
item
Yes
Alphanumeric value that identifies the item within the pack.
comp_price
item_loc
selling_unit_retail
Yes
This field holds the unit retail in the selling unit of measure for the item/zone combination. This field is stored in the local currency.
comp_selling_uom
item_loc
selling_uom
Yes
This field holds the selling unit of measure for an item's single-unit retail.
RIB Mappings Report Release: 13.0.0
Retail Integration Bus Mappings Report Release: 13.0.0
Application Name: Retail Management System
Version 13.0.0
XML-Schema or Node Name:AllocRef.xsd
Tag Name
Table Name
Column Name
API Req
Description
alloc_no
alloc_header
alloc_no
Yes
Contains the number that uniquely identifies the allocation within the system.
doc_type
n/a
n/a
Yes
Specifies the type of document. This value will always be 'A' to signify an allocation.
physical_wh
wh
physical_wh
Yes
Contains the number of the physical warehouse location where the allocation will originate.
wh
alloc_header
wh
Yes
Contains the number of the warehouse location where the allocation will originate.
item
alloc_header
item
Yes
Unique alphanumeric value that identifies the item.
AllocDtlRef
*
*
*
*
Application Name: Retail Management System
Version 13.0.0
XML-Schema or Node Name:AllocDtlRef
Tag Name
Table Name
Column Name
API Req
Description
to_loc
alloc_detail
to_loc
Yes
This field contains the location to which the allocation is being sent. The loc_type field determines if the location is a store or a warehouse.
RIB Mappings Report Release: 13.0.0
Retail Integration Bus Mappings Report Release: 13.0.0
Application Name: Retail Management System
Version 13.0.0
XML-Schema or Node Name:AppointDesc.xsd
Tag Name
Table Name
Column Name
API Req
Description
from_location
appt_head
loc
Yes
The location to which the merchandise has been sent.
to_location
n/a
n/a
Yes
Not used by RMS.
appt_nbr
appt_head
appt
Yes
An RWMS-generated unique numerical identifier for an Appointment.
appt_start_ts
n/a
n/a
Yes
Not used by RMS.
appt_action_status
appt_head
status
Yes
The status of the Appointment. Valid values include: SC - Scheduled, MS - Modified Scheduled, AR - Arrived, CL - Closed.
AppointDtl
*
*
*
*
Application Name: Retail Management System
Version 13.0.0
XML-Schema or Node Name:AppointDtl
Tag Name
Table Name
Column Name
API Req
Description
item_id
appt_detail
item
Yes
The item shipped to the location under the Appt ID.
unit_qty
appt_detail
qty_appointed
Yes
The quantity of the item slated to be sent to the location.
po_nbr
appt_detail
doc
Yes
The Purchase Order/Transfer/Allocation corresponding to the shipped merchandise.
document_type
appt_detail
doc_type
Yes
The type of document corresponding to the shipped merchandise. Possible choices are 'P'urchase Order, 'T'ransfer and 'A'llocation.
asn_nbr
appt_detail
asn
No
This column will hold the Advance Shipping Notice number associated with the Appointment.
RIB Mappings Report Release: 13.0.0
Retail Integration Bus Mappings Report Release: 13.0.0
Application Name: Retail Management System
Version 13.0.0
XML-Schema or Node Name:AppointRef.xsd
Tag Name
Table Name
Column Name
API Req
Description
appt_nbr
appt_head
appt
Yes
An RWMS-generated unique numerical identifier for an Appointment. Appointment is created in a Warehouse system.
from_location
appt_head
loc
Yes
The location to which the merchandise has been sent.
AppointDtlRef
*
*
*
*
Application Name: Retail Management System
Version 13.0.0
XML-Schema or Node Name:AppointDtlRef
Tag Name
Table Name
Column Name
API Req
Description
item_id
appt_detail
item
Yes
The item shipped to the location under the Appt ID.
po_nbr
appt_detail
doc
Yes
The Purchase Order/Transfer/Allocation corresponding to the shipped merchandise.
asn_nbr
appt_detail
asn
No
This column will hold the Advance Shipping Notice number associated with the Appointment.
RIB Mappings Report Release: 13.0.0
Retail Integration Bus Mappings Report Release: 13.0.0
Application Name: Retail Management System
Version 13.0.0
XML-Schema or Node Name:ASNInDesc.xsd
Tag Name
Table Name
Column Name
API Req
Description
to_location
shipment
to_loc
Yes
Contains the location that the shipment will be delivered to.
from_location
n/a
n/a
Yes
Not used by RMS.
asn_nbr
shipment
asn
Yes
Holds the advance shipping notice number associated with a shipment.
asn_type
n/a
n/a
Yes
This field is used to determine the ship origin. If asn_type is 'C', ship_origin will be set to '6' (ASN UCC-128) upon insert to the SHIPMENT table. Otherwise, SHIP_ORIGIN is defaulted to '0' (ASN Shipment).
container_qty
n/a
n/a
Yes
Not used by RMS.
bol_nbr
shipment
ext_ref_no_in
No
Holds the transaction sequence number on the input message from the receiving PO or transfer process.
shipment_date
shipment
ship_date
Yes
This field contains the date the transfer or PO was shipped.
est_arr_date
shipment
est_arr_date
No
This field contains the estimated arrival date of a vendor PO shipment. It is updated by EDIUP856. It is used for vendor/lead time analysis.
ship_address1
n/a
n/a
No
Not used by RMS.
ship_address2
n/a
n/a
No
Not used by RMS.
ship_address3
n/a
n/a
No
Not used by RMS.
ship_address4
n/a
n/a
No
Not used by RMS.
ship_address5
n/a
n/a
No
Not used by RMS.
ship_city
n/a
n/a
No
Not used by RMS.
ship_state
n/a
n/a
No
Not used by RMS.
ship_zip
n/a
n/a
No
Not used by RMS.
ship_country_id
n/a
n/a
No
Not used by RMS.
trailer_nbr
n/a
n/a
No
Not used by RMS.
seal_nbr
n/a
n/a
No
Not used by RMS.
carrier_code
shipment
courier
No
Contains the courier that will deliver the shipment.
vendor_nbr
ordhead
supplier
Yes
This element is used to validate the order number(s) in ASNInPO (ASNInPO.po_nbr). The order number must be in the table ORDHEAD, in either the ORDER_NO column or VENDOR_ORDER_NO column.
ship_pay_method
ordhead
ship_pay_method
No
Used to validate the order number(s) in ASNInPO (ASNInPO.po_nbr). The ship_pay_method in the message must match the value of the order's SHIP_PAY_METHOD in RMS (ORDHEAD table.) If the message field is blank, the ORDHEAD value must be NULL.
ASNInPO
*
*
*
*
comments
n/a
n/a
No
Not used by RMS.
Application Name: Retail Management System
Version 13.0.0
XML-Schema or Node Name:ASNInPO
Tag Name
Table Name
Column Name
API Req
Description
po_nbr
shipment
order_no
Yes
Identifies the order number which relates to the goods delivered in the shipment. Validated against the ORDHEAD table, and also the SHIPMENT table if the message applies to an existing shipment.
doc_type
n/a
n/a
Yes
Not used by RMS.
not_after_date
ordhead
not_after_date
No
Contains the last date that delivery of the order will be accepted.
comments
n/a
n/a
No
Not used by RMS.
ASNInCtn
*
*
*
*
ASNInItem
*
*
*
*
Application Name: Retail Management System
Version 13.0.0
XML-Schema or Node Name:ASNInCtn
Tag Name
Table Name
Column Name
API Req
Description
final_location
carton
location
Yes
This will be the final destination of the carton. For a cross-dock order this will be the allocation location, otherwise it will be the direct to order location.
container_id
carton
carton
Yes
Holds the UCC-128 carton number.
container_weight
n/a
n/a
No
Not used by RMS.
container_length
n/a
n/a
No
Not used by RMS.
container_width
n/a
n/a
No
Not used by RMS.
container_height
n/a
n/a
No
Not used by RMS.
container_cube
n/a
n/a
No
Not used by RMS.
expedite_flag
n/a
n/a
No
Not used by RMS.
in_store_date
n/a
n/a
No
Not used by RMS.
rma_nbr
n/a
n/a
No
Not used by RMS.
tracking_nbr
n/a
n/a
No
Not used by RMS.
freight_charge
n/a
n/a
No
Not used by RMS.
master_container_id
n/a
n/a
No
Not used by RMS.
ASNInItem
*
*
*
*
comments
n/a
n/a
No
Not used by RMS.
Application Name: Retail Management System
Version 13.0.0
XML-Schema or Node Name:ASNInItem
Tag Name
Table Name
Column Name
API Req
Description
final_location
alloc_detail
to_loc
Yes
Required if the order's pre_mark_ind is 'Y'. Validated against the ALLOC_DETAIL table. There needs to be at least one allocation with the same ORDER_NO that is in the ASNIn message, and the same TO_LOC as the final_location.
item_id
shipsku
item
Yes
Unique identifier for the item. Either vpn, item_id, or ref_item must be specified in the message.
unit_qty
shipsku
qty_expected
Yes
Contains the number of items expected to be received based on the supplier's ASN for this Item/Shipment combination.
priority_level
n/a
n/a
No
Not used by RMS.
vpn
item_supplier
vpn
No
Used to find the Retek item number, found on the ITEM_SUPPLIER table. Either vpn, item_id, or ref_item must be specified in the message.
order_line_nbr
n/a
n/a
No
Not used by RMS.
lot_nbr
n/a
n/a
Yes
Not used by RMS.
ref_item
shipsku
ref_item
No
Contains a reference item to the item field. Either vpn, item_id, or ref_item must be specified in the message.
distro_nbr
n/a
n/a
Yes
Not used by RMS.
distro_doc_type
n/a
n/a
No
Not used by RMS.
container_qty
n/a
n/a
No
Not used by RMS.
comments
n/a
n/a
No
Not used by RMS.
RIB Mappings Report Release: 13.0.0
Retail Integration Bus Mappings Report Release: 13.0.0
Application Name: Retail Management System
Version 13.0.0
XML-Schema or Node Name:ASNInRef.xsd
Tag Name
Table Name
Column Name
API Req
Description
to_location
shipment
to_loc
Yes
Contains the location which the shipment was to be delivered to.
from_location
n/a
n/a
No
Not use by RMS.
asn_nbr
shipment
asn
Yes
Holds the advance shipping notice number associated with a shipment to be deleted.
RIB Mappings Report Release: 13.0.0
Retail Integration Bus Mappings Report Release: 13.0.0
Application Name: Retail Management System
Version 13.0.0
XML-Schema or Node Name:ASNOutDesc.xsd
Tag Name
Table Name
Column Name
API Req
Description
to_location
shipment
to_loc
Yes
Contains the location that the shipment will be delivered to.
from_location
shipment
from_loc
Yes
For transfer and allocation shipments, this field will hold the location from which the shipment was sourced.
asn_nbr
shipment
bol_no
No
Holds the bill of lading number associated with a shipment.
asn_type
n/a
n/a
No
Not used by RMS.
container_qty
shipment
no_boxes
No
Contains the number of boxes associated with the shipment.
bol_nbr
shipment
ext_ref_no_out
Yes
Holds the transaction sequence number on the message from the transfer shipment confirmation process.
shipment_date
shipment
ship_date
No
This field contains the date the transfer or PO was shipped.
est_arr_date
shipment
est_arr_date
No
This field contains the estimated arrival date of a vendor PO shipment. It is updated by EDIUP856. It is used for vendor/lead time analysis.
ship_address1
n/a
n/a
No
Not used by RMS.
ship_address2
n/a
n/a
No
Not used by RMS.
ship_address3
n/a
n/a
No
Not used by RMS.
ship_address4
n/a
n/a
No
Not used by RMS.
ship_address5
n/a
n/a
No
Not used by RMS.
ship_city
n/a
n/a
No
Not used by RMS.
ship_state
n/a
n/a
No
Not used by RMS.
ship_zip
n/a
n/a
No
Not used by RMS.
ship_country_id
n/a
n/a
No
Not used by RMS.
trailer_nbr
n/a
n/a
Yes
Not used by RMS.
seal_nbr
n/a
n/a
No
Not used by RMS.
carrier_code
shipment
courier
No
Contains the courier that will deliver the shipment.
transshipment_nbr
n/a
n/a
No
Not used by RMS.
ASNOutDistro
*
*
*
*
comments
shipment
comments
No
Contains any miscellaneous comments about the shipment.
Application Name: Retail Management System
Version 13.0.0
XML-Schema or Node Name:ASNOutDistro
Tag Name
Table Name
Column Name
API Req
Description
distro_nbr
shipsku
distro_no
Yes
Specifies the transfer or allocation number associated with the shipment/item/carton.
distro_doc_type
n/a
n/a
Yes
Specifies what the distro_nbr field corresponds to in RMS: V, D, and T specify transfer, A specifies Allocation.
customer_order_nbr
n/a
n/a
No
Not used by RMS.
consumer_direct
n/a
n/a
No
Not used by RMS.
ASNOutCtn
*
*
*
*
comments
n/a
n/a
No
Not used by RMS.
Application Name: Retail Management System
Version 13.0.0
XML-Schema or Node Name:ASNOutCtn
Tag Name
Table Name
Column Name
API Req
Description
final_location
n/a
n/a
No
Not used by RMS.
container_id
shipsku
carton
Yes
Identifies the UCC-128 carton number for shipments originating from the Advance Shipment Notification process as carton shipments. This field will be zero for all shipments that are not at a carton level.
container_weight
n/a
n/a
No
Not used by RMS.
container_length
n/a
n/a
No
Not used by RMS.
container_width
n/a
n/a
No
Not used by RMS.
container_height
n/a
n/a
No
Not used by RMS.
container_cube
n/a
n/a
No
Not used by RMS.
expedite_flag
n/a
n/a
No
Not used by RMS.
in_store_date
n/a
n/a
No
Not used by RMS.
rma_nbr
n/a
n/a
No
Not used by RMS.
tracking_nbr
n/a
n/a
No
Not used by RMS.
freight_charge
n/a
n/a
No
Not used by RMS.
master_container_id
n/a
n/a
No
Not used by RMS.
ASNOutItem
*
*
*
*
comments
n/a
n/a
No
Not used by RMS.
weight
shipsku
weight_expected
No
Actual weight shipped for the container.
weight_uom
shipsku
weight_expected_uom
No
Unit of measurement for weight (e.g. pounds, kilograms) that was shipped.
Application Name: Retail Management System
Version 13.0.0
XML-Schema or Node Name:ASNOutItem
Tag Name
Table Name
Column Name
API Req
Description
item_id
shipsku
item
Yes
Unique identifier for the item.
unit_qty
shipsku
qty_expected
Yes
Contains the number of items expected to be received based on the supplier's advance shipment notification for this item/shipment combination.
priority_level
n/a
n/a
No
Not used by RMS.
order_line_nbr
n/a
n/a
No
Not used by RMS.
lot_nbr
n/a
n/a
No
Not used by RMS.
final_location
n/a
n/a
No
Not used by RMS.
from_disposition
inv_status_codes
inv_status_code
No
This value is used to determine if the inventory is available or unavailable, based on the code's INV_STATUS value on the INV_STATUS_CODES table.
to_disposition
n/a
n/a
No
Not used by RMS.
voucher_number
n/a
n/a
No
Not used by RMS.
voucher_expiration_date
n/a
n/a
No
Not used by RMS.
container_qty
n/a
n/a
No
Not used by RMS.
comments
n/a
n/a
No
Not used by RMS.
unit_cost
n/a
n/a
No
Not used by RMS.
weight
shipsku
weight_expected
No
Actual weight shipped.
weight_uom
shipsku
weight_expected_uom
No
Unit of measurement for weight (e.g. pounds, kilograms) shipped.
RIB Mappings Report Release: 13.0.0
Retail Integration Bus Mappings Report Release: 13.0.0
Application Name: Retail Management System
Version 13.0.0
XML-Schema or Node Name:ATPDesc.xsd
Tag Name
Table Name
Column Name
API Req
Description
item
item_loc_soh
item
Yes
Unique alphanumeric value that identifies the item.
item_parent
item_loc_soh
item_parent
Yes
Alphanumeric value that uniquely identifies the item/group at the level above the item.
item_grandparent
item_loc_soh
item_grandparent
Yes
Alphanumeric value that uniquely identifies the item/group two levels above the item.
loc
item_loc_soh
loc
Yes
Number of the loction in which the item is to be found. This field may contain a store or a warehouse.
loc_type
item_loc_soh
loc_type
Yes
Type of location in the loc field. Valid values are 'S' for store or 'W' for Warehouse.
av_cost
item_loc_soh
av_cost
Yes
Calculated using the PO's extimated landing cost during PO receiving process if elc_ind = 'Y'. this field is stored in the local currency. Pack items will not have an average cost stored on item_loc. Stock of a pack item is valued at the compnent lev
unit_cost
item_loc_soh
unit_cost
Yes
If system_options.std_av_ind = 'A' and elc_ind = 'Y' then this field holds the estimated landed cost when item is initially set up. It is then updated with PO's estimated landed cost each time this item is received at this location. Otherwise, this fie
stock_on_hand
item_loc_soh
stock_on_hand
Yes
Current stock on hand for the item.
soh_update_datetime
item_loc_soh
soh_update_datetime
Yes
Date and time of most recent update to stock_on_hand.
last_hist_export_date
item_loc_soh
last_hist_export_date
Yes
This field contains most recent date up to which sales/issues have been exported to an external system for the item/store or item/warehouse combination.
in_transit_qty
item_loc_soh
in_transit_qty
Yes
All quantities of an item shipped bu not received on all transfers and allocations for the "destination" location.
pack_comp_intran
*
*
*
*
pack_comp_soh
item_loc_soh
pack_comp_soh
Yes
Current stock on hand for pack component item.
tsf_reserved_qty
item_loc_soh
tsf_reserved_qty
Yes
The sum of all requested quantities of an item that have not been shipped on all transfers and stand alone allocations for the "source" location.
pack_comp_resv
item_loc_soh
pack_comp_resv
Yes
The sum of all requested quantities of a component item that have not been shipped on all transfers and stand alone allocations for the "source" location.
tsf_expected_qty
item_loc_soh
tsf_expected_qty
Yes
The sum of all expected quantities of an item that have not been shipped on all transfers and stand alone allocations for the "desitination" location.
pack_comp_exp
item_loc_soh
pack_comp_exp
Yes
The sum of all expected quantities of a component item that have not been shipped on all transfers and stand alone allocations for the "destination" location.
rtv_qty
item_loc_soh
rtv_qty
Yes
All quantities approved but not shipped on all RTV's from inventory for an item/location. Will reduce stock on hand when RTV is shipped.
non_sellable_qty
item_loc_soh
non_sellable_qty
Yes
Total non-sellable quantity for an item/location (i.e. sum of inv_status_qty.qty for an item/location across all inventory status).
customer_resv
item_loc_soh
customer_resv
Yes
This will hold the number of units being reserved for customer orders.
customer_backorder
item_loc_soh
customer_backorder
Yes
This will hold the number of units held for customer back orders.
pack_comp_cust_resv
item_loc_soh
pack_comp_cust_resv
Yes
This will hold the number of packs being reserved for customer orders.
pack_comp_cust_back
item_loc_soh
pack_comp_cust_back
Yes
This will hold the number of packs held for customer back orders.
create_datetime
item_loc_soh
create_datetime
Yes
Date/time stamp of when the record was created. This date/time will be used in export processing. This value should only be populated on insert - it should never be updated
last_update_datetime
item_loc_soh
last_update_datetime
Yes
Holds the date time stamp of the most recent update by the last_update_id. This field is required by the database.
last_update_id
item_loc_soh
last_update_id
Yes
Hold the Oracle user-id of the user who most recently updated this record. This field is required by the database.
RIB Mappings Report Release: 13.0.0
Retail Integration Bus Mappings Report Release: 13.0.0
Application Name: Retail Management System
Version 13.0.0
XML-Schema or Node Name:BannerDesc.xsd
Tag Name
Table Name
Column Name
API Req
Description
banner_id
banner
banner_id
Yes
The number to uniquely identify a Banner.
banner_name
banner
banner_name
Yes
The name of the Banner for which channels are associated.
RIB Mappings Report Release: 13.0.0
Retail Integration Bus Mappings Report Release: 13.0.0
Application Name: Retail Management System
Version 13.0.0
XML-Schema or Node Name:BannerRef.xsd
Tag Name
Table Name
Column Name
API Req
Description
banner_id
banner
banner_id
Yes
The number to uniquely identify a Banner
RIB Mappings Report Release: 13.0.0
Retail Integration Bus Mappings Report Release: 13.0.0
Application Name: Retail Management System
Version 13.0.0
XML-Schema or Node Name:ChannelDesc.xsd
Tag Name
Table Name
Column Name
API Req
Description
channel_id
channels
channel_id
Yes
This column will contain the number that uniquely identifies the channel.
channel_name
channels
channel_name
Yes
Contains the name of the channel.
channel_type
channels
channel_type
Yes
Specifies the type of channel.
banner_id
channels
banner_id
Yes
The number to uniquely identify a Banner.
RIB Mappings Report Release: 13.0.0
Retail Integration Bus Mappings Report Release: 13.0.0
Application Name: Retail Management System
Version 13.0.0
XML-Schema or Node Name:ChannelRef.xsd
Tag Name
Table Name
Column Name
API Req
Description
channel_id
channels
channel_id
Yes
This column will contain the number that uniquely identifies the channel.
RIB Mappings Report Release: 13.0.0
Retail Integration Bus Mappings Report Release: 13.0.0
Application Name: Retail Management System
Version 13.0.0
XML-Schema or Node Name:CodeDtlDesc.xsd
Tag Name
Table Name
Column Name
API Req
Description
code_type
code_detail
code_type
Yes
This field will contain a valid code type for the row. the valid code types are defined on the CODE_HEAD table.
code
code_detail
code
Yes
This field contains the code used in Retek which must be decoded for display in the on-line forms.
code_desc
code_detail
code_desc
Yes
This field contains the description associated with the code and the code type.
required_ind
code_detail
required_ind
Yes
This field indicates whether or not the code is required. If the code is specified as required, then the user will not be able to delete the rows in the table for that code.
code_seq
code_detail
code_seq
Yes
This is a number used to order the elements so that they appear consistently when using them to populate a list.
RIB Mappings Report Release: 13.0.0
Retail Integration Bus Mappings Report Release: 13.0.0
Application Name: Retail Management System
Version 13.0.0
XML-Schema or Node Name:CodeDtlRef.xsd
Tag Name
Table Name
Column Name
API Req
Description
code_type
code_detail
code_type
Yes
This field will contain a valid code type for the row. The valid code types are defined on the CODE_HEAD table.
code
code_detail
code
Yes
This field contains the code used in Retek which must be decoded for display in the on-line forms.
RIB Mappings Report Release: 13.0.0
Retail Integration Bus Mappings Report Release: 13.0.0
Application Name: Retail Management System
Version 13.0.0
XML-Schema or Node Name:CodeHdrDesc.xsd
Tag Name
Table Name
Column Name
API Req
Description
code_type
code_head
code_type
Yes
This field contains the code tpe which will serve as a grouping mechansim for the multiple codes stored on the CODE_DETAIL table.
code_type_desc
code_head
code_type_desc
Yes
This field will contain the description of the code type.
RIB Mappings Report Release: 13.0.0
Retail Integration Bus Mappings Report Release: 13.0.0
Application Name: Retail Management System
Version 13.0.0
XML-Schema or Node Name:CodeHdrRef.xsd
Tag Name
Table Name
Column Name
API Req
Description
code_type
code_head
code_type
Yes
This field contains the code tpe which will serve as a grouping mechansim for the multiple codes stored on the CODE_DETAIL table.
RIB Mappings Report Release: 13.0.0
Retail Integration Bus Mappings Report Release: 13.0.0
Application Name: Retail Management System
Version 13.0.0
XML-Schema or Node Name:CogsDesc.xsd
Tag Name
Table Name
Column Name
API Req
Description
trans_date
tran_data
tran_date
Yes
Idenfies the date the transaction was created.
item
tran_data
item
Yes
Unique alphanumeric value that identifies the item. This value must be a valid item in RMS.
store
tran_data
location
Yes
Unique value representing the store where the cogs transaction occurred. This must be a valid store within RMS.
units
tran_data
units
Yes
Contains the number of units sold. This value is also used to update the stock on hand for the store.
header_media
tran_data
ref_no_1
Yes
Concatinated with line_media and put into ref_no_1 column of tran_data. Note that both fields header_media and line_media should be numeric.
line_media
tran_data
ref_no_1
Yes
Concatinated with header_media and put into ref_no_1 column of tran_data. Note that both fields header_media and line_media should be numeric.
reason_code
tran_code
ref_no_2
Yes
Valid values are 1 or 2.
supplier
n/a
n/a
No
Not used by RMS.
RIB Mappings Report Release: 13.0.0
Retail Integration Bus Mappings Report Release: 13.0.0
Application Name: Retail Management System
Version 13.0.0
XML-Schema or Node Name:COResCanDesc.xsd
Tag Name
Table Name
Column Name
API Req
Description
wh
item_loc_soh
loc
Yes
The location ID in which the customer reserve needs to be cancelled for the item. This field may contain a store or a warehouse.
item
item_loc_soh
item
Yes
Unique alphanumeric value that identifies the item.
cancelled_quantity
item_loc_soh
customer_resv
Yes
This will hold the number of units need to be cancelled for customer orders.
supplier
n/a
n/a
Yes
Not used by RMS.
direct_ship_ind
n/a
n/a
Yes
Not used by RMS.
RIB Mappings Report Release: 13.0.0
Retail Integration Bus Mappings Report Release: 13.0.0
Application Name: Retail Management System
Version 13.0.0
XML-Schema or Node Name:COResDesc.xsd
Tag Name
Table Name
Column Name
API Req
Description
wh
item_loc_soh
loc
Yes
The location ID in which the customer reserve needs to recorded for the item. This field may contain a store or a warehouse.
item
item_loc_soh
item
Yes
Unique alphanumeric value that identifies the item.
reserved_quantity
item_loc_soh
customer_resv
Yes
This will hold the number of units being reserved for customer orders.
supplier
n/a
n/a
Yes
Not used by RMS.
direct_ship_ind
n/a
n/a
Yes
Not used by RMS
RIB Mappings Report Release: 13.0.0
Retail Integration Bus Mappings Report Release: 13.0.0
Application Name: Retail Management System
Version 13.0.0
XML-Schema or Node Name:CostZnGrpDesc.xsd
Tag Name
Table Name
Column Name
API Req
Description
zone_group_id
cost_zone_group
zone_group_id
Yes
Contains the unique identifier for the cost zone group.
cost_level
cost_zone_group
cost_level
Yes
Specifies the pricing level of the cost zone group. Valid values are: 'L'ocation, 'C'orporate, and 'Z'one. There will only be one record with Corporate level pricing and only record with a Location cost level, but there can be multiple records with a
costzngrp_desc
cost_zone_group
description
Yes
Contains the description of the cost zone group.
CostZn
*
*
*
*
Application Name: Retail Management System
Version 13.0.0
XML-Schema or Node Name:CostZn
Tag Name
Table Name
Column Name
API Req
Description
zone_id
cost_zone
zone_id
Yes
Contains the unique zone identification number. If the cost level of the zone group is store, then the zone will be the store number.
costzngrp_desc
cost_zone
description
Yes
Contains the name of the zone. If the cost level of the zone group is store, then this column contains the store name.
currency_code
cost_zone
currency_code
Yes
Contains the currency code for the zone. Each zone will have a currency code attached to ensure that each store location associated with the zone shares the same currency.
base_cost_ind
cost_zone
base_cost_ind
Yes
Indicates whether or not this zone will be used as the default for the base cost zone. Valid values are Y and N.
CostZnGrpLoc
*
*
*
*
Application Name: Retail Management System
Version 13.0.0
XML-Schema or Node Name:CostZnGrpLoc
Tag Name
Table Name
Column Name
API Req
Description
location
cost_zone_group_loc
location
Yes
Contains the store or warehouse number in the zone. There must be exactly one record for every store and warehouse in every zone group.
loc_type
cost_zone_group_loc
loc_type
Yes
Specifies whether the location is a 'S'tore or 'W'arehouse.
RIB Mappings Report Release: 13.0.0
Retail Integration Bus Mappings Report Release: 13.0.0
Application Name: Retail Management System
Version 13.0.0
XML-Schema or Node Name:CostZnGrpRef.xsd
Tag Name
Table Name
Column Name
API Req
Description
zone_group_id
cost_zone_group
zone_group_id
Yes
Contains the unique identifier for the cost zone group.
CostZnRef
*
*
*
*
Application Name: Retail Management System
Version 13.0.0
XML-Schema or Node Name:CostZnRef
Tag Name
Table Name
Column Name
API Req
Description
zone_id
cost_zone_group
zone_id
Yes
Contains the unique zone identification number. If the cost level of the zone group is store, then the zone will be the store number.
CostZnGrpLocRef
*
*
*
*
Application Name: Retail Management System
Version 13.0.0
XML-Schema or Node Name:CostZnGrpLocRef
Tag Name
Table Name
Column Name
API Req
Description
location
cost_zone_group_loc
location
Yes
Contains the store or warehouse number in the zone. There must be exactly one record for every store and warehouse in every zone group.
loc_type
*
*
*
*
RIB Mappings Report Release: 13.0.0
Retail Integration Bus Mappings Report Release: 13.0.0
Application Name: Retail Management System
Version 13.0.0
XML-Schema or Node Name:CountryDesc.xsd
Tag Name
Table Name
Column Name
API Req
Description
country_id
country
country_id
Yes
The unique country identifier.
country_desc
country_desc
country_desc
Yes
The name of the country
RIB Mappings Report Release: 13.0.0
Retail Integration Bus Mappings Report Release: 13.0.0
Application Name: Retail Management System
Version 13.0.0
XML-Schema or Node Name:CountryRef.xsd
Tag Name
Table Name
Column Name
API Req
Description
country_id
country
country_id
Yes
The unique country identifier.
RIB Mappings Report Release: 13.0.0
Retail Integration Bus Mappings Report Release: 13.0.0
Application Name: Retail Management System
Version 13.0.0
XML-Schema or Node Name:CurrRateDesc.xsd
Tag Name
Table Name
Column Name
API Req
Description
from_currency
currency_rates
currency_code
Yes
Contains the currency code that the rate exchange is from.
to_currency
system_options
currency_code
Yes
Contains the currency code that the rate exchange is to. This must match the primary RMS currency system option.
conversion_date
currency_rates
effective_date
Yes
Date on which the currency rate became or will become active.
conversion_rate
currency_rates
exchange_rate
Yes
Contains the exchange rate for the specified currency/type/effective date combination.
user_conversion_type
currency_rates
exchange_type
Yes
Incoming conversion type (e.g. Consolidation, Operational, etc.) is translated to an exchange type code (C, O, etc) by reading the fif_currency_xref table.
RIB Mappings Report Release: 13.0.0
Retail Integration Bus Mappings Report Release: 13.0.0
Application Name: Retail Management System
Version 13.0.0
XML-Schema or Node Name:CustBOCanDesc.xsd
Tag Name
Table Name
Column Name
API Req
Description
wh
item_loc_soh
loc
Yes
The location ID in which the customer back order needs to be cancelled for the item. This field may contain a store or a warehouse.
item
item_loc_soh
item
Yes
Unique alphanumeric value that identifies the item.
cancelled_quantity
item_loc_soh
customer_backorder
Yes
This will hold the number of units need to be cancelled for customer back orders.
RIB Mappings Report Release: 13.0.0
Retail Integration Bus Mappings Report Release: 13.0.0
Application Name: Retail Management System
Version 13.0.0
XML-Schema or Node Name:CustBODesc.xsd
Tag Name
Table Name
Column Name
API Req
Description
wh
item_loc_soh
loc
Yes
The location ID in which the customer back order needs to recorded for the item. This field may contain a store or a warehouse.
item
item_loc_soh
item
Yes
Unique alphanumeric value that identifies the item.
backordered_quantity
item_loc_soh
customer_backorder
Yes
This will hold the number of units being reserved for customer back orders.
RIB Mappings Report Release: 13.0.0
Retail Integration Bus Mappings Report Release: 13.0.0
Application Name: Retail Management System
Version 13.0.0
XML-Schema or Node Name:CustBOToResDesc.xsd
Tag Name
Table Name
Column Name
API Req
Description
wh
item_loc_soh
loc
Yes
Number of the location in which the item is to be found. This field may contain a store or a warehouse.
item
item_loc_soh
item
Yes
Unique alphanumeric value that identifies the item.
backordered_quantity
item_loc_soh
customer_resv
Yes
This will hold the number of units to be adjusted from back order to reserve.
RIB Mappings Report Release: 13.0.0
Retail Integration Bus Mappings Report Release: 13.0.0
Application Name: Retail Management System
Version 13.0.0
XML-Schema or Node Name:CustResToBODesc.xsd
Tag Name
Table Name
Column Name
API Req
Description
wh
item_loc_soh
loc
Yes
Number of the location in which the item is to be found. This field may contain a store or a warehouse.
item
item_loc_soh
item
Yes
Unique alphanumeric value that identifies the item.
backordered_quantity
item_loc_soh
customer_resv
Yes
This will hold the number of units to be adjusted from reserve to back order.
RIB Mappings Report Release: 13.0.0
Retail Integration Bus Mappings Report Release: 13.0.0
Application Name: Retail Management System
Version 13.0.0
XML-Schema or Node Name:CustRetSaleDesc.xsd
Tag Name
Table Name
Column Name
API Req
Description
store
item_loc_soh
loc
Yes
The contains the non-stockholding location ID in which the item is being returned. This field may contain a store or a warehouse.
item
item_loc_soh
item
Yes
Unique alphanumeric value that identifies the item.
shipped_quantity
item_loc_soh
stock_on_hand
Yes
This holds the number of units that was returned.
wh
item_loc_soh
loc
Yes
This contains the stockholding location to which the item is to be returned.
RIB Mappings Report Release: 13.0.0
Retail Integration Bus Mappings Report Release: 13.0.0
Application Name: Retail Management System
Version 13.0.0
XML-Schema or Node Name:CustSaleDesc.xsd
Tag Name
Table Name
Column Name
API Req
Description
wh
item_loc_soh
loc
Yes
This contains the stockholding location to which the item is sold. This field may contain a store or a warehouse. The item and wh combination must be valid on the item_loc table.
store
item_loc_soh
loc
Yes
The contains the non-stockholding location ID in which the item is sold. This field may contain a store or a warehouse. The item and store combination must be valid on the item_loc table.
item
item_loc_soh
item
Yes
Unique alphanumeric value that identifies the item.
shipped_quantity
item_loc_soh
stock_on_hand
Yes
This will hold the number of units being sold for customer orders.
RIB Mappings Report Release: 13.0.0
Retail Integration Bus Mappings Report Release: 13.0.0
Application Name: Retail Management System
Version 13.0.0
XML-Schema or Node Name:DiffDesc.xsd
Tag Name
Table Name
Column Name
API Req
Description
diff_id
diff_ids
diff_id
Yes
This field will hold a unique number (identifier) of the differentiator.
diff_type
diff_ids
diff_type
Yes
This field holds a value of all possible differential types. Valid values are stored in the code_detail table with the code_type of 'DIFF'. Valid values are also found in the diff_type table.
diff_desc
diff_ids
diff_desc
Yes
Description of the differential ID.
industry_code
diff_ids
industry_code
No
A unique number that represents all possible combinations of sizes according to the National Retail Federation.
industry_subcode
diff_ids
industry_subgroup
No
A unique number that represents all different color range groups.
RIB Mappings Report Release: 13.0.0
Retail Integration Bus Mappings Report Release: 13.0.0
Application Name: Retail Management System
Version 13.0.0
XML-Schema or Node Name:DiffGrpDtlDesc.xsd
Tag Name
Table Name
Column Name
API Req
Description
diff_group_id
diff_group_detail
diff_group_id
Yes
Contains the differential group that the differential belongs to. This field must be a valid value on the diff_group_head table.
diff_id
diff_group_detail
diff_id
Yes
Contains the value of the differential that is included in the differential group. This field must be a valid value from the diff_ids table.
display_seq
diff_group_detail
display_seq
No
This field contains the display sequence for the differential.
RIB Mappings Report Release: 13.0.0
Retail Integration Bus Mappings Report Release: 13.0.0
Application Name: Retail Management System
Version 13.0.0
XML-Schema or Node Name:DiffGrpDtlRef.xsd
Tag Name
Table Name
Column Name
API Req
Description
diff_group_id
diff_group_detail
diff_group_id
Yes
Contains the value of the differential group that the differential belongs to. This field must be a valid value on the diff_group_head table.
diff_id
diff_group_detail
diff_id
Yes
Contains the value of the differential that is included in the differential group. This field must be a valid value from the diff_ids table.
RIB Mappings Report Release: 13.0.0
Retail Integration Bus Mappings Report Release: 13.0.0
Application Name: Retail Management System
Version 13.0.0
XML-Schema or Node Name:DiffGrpHdrDesc.xsd
Tag Name
Table Name
Column Name
API Req
Description
diff_group_id
diff_group_head
diff_group_id
Yes
This field holds a unique number (identifier) of the differential group.
diff_group_type
diff_group_head
diff_type
Yes
This field holds a value for differential types.
diff_group_desc
diff_group_head
diff_group_desc
Yes
This is the description of the differential group.
RIB Mappings Report Release: 13.0.0
Retail Integration Bus Mappings Report Release: 13.0.0
Application Name: Retail Management System
Version 13.0.0
XML-Schema or Node Name:DiffGrpRef.xsd
Tag Name
Table Name
Column Name
API Req
Description
diff_group_id
diff_group_head
diff_group_id
Yes
This field holds a unique number (identifier) of the differential group.
RIB Mappings Report Release: 13.0.0
Retail Integration Bus Mappings Report Release: 13.0.0
Application Name: Retail Management System
Version 13.0.0
XML-Schema or Node Name:DiffRef.xsd
Tag Name
Table Name
Column Name
API Req
Description
diff_id
diff_ids
diff_id
Yes
This field will hold a unique number (identifier) of the differentiator.