Downloading E-Commerce Offer Files (EOFR)
Purpose: Use the Download E-Commerce Offer Files menu option to select offer, source, and item-related information for download to the web storefront. Typically, this type of information changes periodically.
You can download all three types of information at once, or selected types as needed.
Type of download: The setting of the Generate E-Commerce Offer Tables (M29) system control value defines the output of the e-commerce offer download.
• If this system control value is selected, the e-commerce offer download (EOFR) populates the E-Commerce Offer Staging tables; see Offer-Related Table Extract Summary.
• If this system control value is unselected, the e-commerce offer download (EOFR) generates the E-Commerce Product Web XML File (ProductWeb).
File storage API exports enabled? If the Generate E-Commerce Offer Tables (M29) system control value is unselected and the FILE_STORAGE_EXPORTS_ENABLED property is set to true, the e-commerce offer download creates a zip file in the OMS-ECOMMERCE container of the FILE_STORAGE table. The zip file contains the E-Commerce Product Web XML File (ProductWeb). You can use the file storage API to download the file. See the File Storage API for background. Otherwise, if the file storage API is not enabled for exports, the file is created in the ECOMMERCE_DIRECTORY_PATH in Working with Admin Properties (CPRP) defines the location on the application server where the system downloads the E-Commerce Product Web XML file.
Additional downloads: Other downloads available for the e-commerce interface are:
• static tables
• item availability and item changes
For more information: See:
• Downloading E-Commerce Static Tables (ESTF) for an overview of the download process related to the e-commerce interface, including the additional downloads.
• the E-Commerce Integration Manual for information on the storefront database schema.
In this chapter:
• Process E-Commerce Downloads Screen
• Offer-Related Table Extract Summary
• E-Commerce Product Web XML File (ProductWeb)
Process E-Commerce Downloads Screen
How to display this screen: Enter EOFR in the Fast path field at the top of any menu, or select Download E-Commerce Offer Tables from a menu.
Note: All records in each related table for your company will be selected for download, unless noted otherwise in the field descriptions.
Field |
Description |
Offers |
Indicates whether to include the selected offer information in the e-commerce offer download for subsequent transfer to the web storefront. Only the offer(s) you enter at this screen will be included. Valid values are: Selected (default) = download the selected offer(s). Unselected = do not download the offer(s). |
Sources |
Indicates whether to include source codes associated with the selected offer in the e-commerce offer download for subsequent transfer to the web storefront. Only source codes associated with the offer you enter at the From offer field will be included. Valid values are: Selected (default) = include source codes associated with the selected offer. Unselected = do not include source codes. |
All items |
Indicates whether to include all items, SKUs, and all other related offer information in the e-commerce offer download for subsequent transfer to the web storefront. All items related to the offer(s) you enter at this screen will be included. Valid values are: Selected (default) = include item-related information for all items associated with the selected offer(s). Unselected = do not include item-related information for all items. Select either this field or the New items field, but not both. If you select both fields, the following message displays: Either All Items or New Items can be processed but not both. |
New items |
Indicates whether to include only new items in the e-commerce offer download for subsequent transfer to the web storefront. Only items related to the offer(s) you enter at this screen and which have not previously been extracted will be selected. Valid values are: Selected = The e-commerce offer download includes item-related information for only new items associated with the selected offer(s); only items which have not been previously extracted are included in the download. When you submit the download, the system updates the Ecommerce Extract Date field in the Item Offer table with the date of the extract; the system uses this field to determine whether the item has previously been included in an e-commerce offer download. Unselected (default) = do restrict extract of item-related information to only new items. Select either this field or the All items field, but not both. If you select both fields, the following message displays: Either All Items or New Items can be processed but not both. |
Indicates whether to include the latest future price for an item or SKU in the selected offer(s), or the most current price that is not in the future. Valid values are: Selected = include the latest future prices for items and SKUs in the selected offer(s). Future prices are those whose Effective dates are later than the current date. If there are no future prices for an item or SKU, the job includes the latest current price (the most current price whose Effective date is not in the future). Unselected (default) = include the most current price for items and SKUs in the selected offer(s), as long as the prices’ Effective dates are not later than the current date. If there are no prices for an item or SKU except for future prices, the job does not include the item or SKU in the extract. |
|
Indicates whether to include all SKU Offers and SKU Prices, regardless of whether they are different from the Item offer and Item Price. Valid values are: Selected = include all existing SKU Offer and SKU Price information, even if it is identical to the corresponding Item Offer and Item Price information. Unselected (default) = include SKU Offer and SKU Price information only if it differs from the Item Offer and Item Price information: • SKU Price information is updated only if the SKU Price differs from the Item Price. Note: The SKU Price is included only if the regular price differs from the Item Price. If the Associate price alone differs, then the SKU Price record is not selected for extract. • SKU Offer information is updated only if the special handling or gift wrap information for the SKU Offer is different from the Item Offer. • This field displays only if the Generate E-Commerce Offer Tables (M29) system control value is selected. |
|
Offer |
Enter one or more offers to download to the web storefront. As you enter each offer, its description, start date, and end date are displayed below. You must specify at least one offer. Only the offer(s) you enter and tables associated with the selected offer(s) will be included in the extract. Offer codes are defined in and validated against the Offer table. See Working with Offers (WOFR). Alphanumeric, 3 positions; required. |
Description |
The description of an offer you have specified for download to the web storefront. Alphanumeric, 30 positions; display-only. |
Start date |
The first date when the selected offer is effective for processing orders. From the Offer date range specified for the offer. Numeric, 6 positions (in user date format); display-only. |
End date |
The last date when the selected offer is effective for processing orders. From the Offer date range specified for the offer. Numeric, 6 positions (in user date format); display-only. |
Instructions:
1. |
Optionally reset any of the fields to exclude related information from selection. |
Note: Select either the All items field or the New items field. You cannot select both fields. |
|
2. |
Use the Offer field to specify at least one offer to include in the extract. The system validates each entry, and displays the offer’s description and effective dates below after each. |
3. |
Select OK. The system validates your entries and highlights any fields you need to correct. Correct any fields and select OK again. |
4. |
Select Submit to submit the extract. The system displays the following message: E-Commerce download submitted to batch. Also, the system submits the job ECOMM_OFR, which extracts the selected information for download. |
5. |
The setting of the Generate E-Commerce Offer Tables (M29) system control value defines the output of the e-commerce offer download. • If this system control value is selected, the e-commerce offer download (EOFR) populates the E-Commerce Offer Staging tables; see Offer-Related Table Extract Summary for a listing of the information included in the extract. • If this system control value is unselected, the e-commerce offer download (EOFR) generates the E-Commerce Product Web XML File (ProductWeb). Note: If an active procedure exists, the system does not generate the ProductWeb file and instead writes an error message to the Application Log. |
Offer-Related Table Extract Summary
Purpose: This table provides a summary of the tables and fields included in the offer table extract, and how they map to the e-commerce staging tables. The system populates these tables when you submit the e-commerce offer download and the Generate E-Commerce Offer Tables (M29) system control value is selected.
Information included: The e-commerce offer download adds new information to the staging tables if the tables have not been cleared since the last download; it does not update records once they are extracted to the staging tables. However, once the records are downloaded to the web storefront and cleared from the staging tables, changes to existing records are eligible to be extracted to the staging tables and passed to the storefront.
Removing items and offers: Use the Removing Offers and Items from Download (ERMV) menu option to specify offers, items, or SKUs that are no longer active on the web storefront, so that you do not continue sending periodic updates.
All SKUs included? SKU-level information is included in the extract only if there is a SKU Offer and SKU Price record. For example, you can use the Creating Item/SKU Offers (MISO) menu option to create SKU Offers and SKU Prices for an item when you add it to a new offer. SKU-level offer and price information is included in the extract if you select the All SKU offers option when generating the extract; otherwise, SKU Offers are included only when they differ from the item-level information, such as a special handling or price that differs from the Item Offer or Item Price setting.
Future prices? The Future prices field on the Process E-Commerce Downloads screen controls whether to download the most current prices whose Effective dates are not in the future, or the latest prices whose Effective dates are later than the current date. If you would like to download both current and future prices, you can run the download job twice, resetting this field as needed.
Example: AB100 BLUE LRGE has the following prices set up for the selected offer(s):
Date |
Quantity |
Price |
1/1 |
1 |
10.00 |
1/1 |
5 |
9.00 |
1/10 |
1 |
10.50 |
2/1 |
1 |
8.50 |
2/1 |
5 |
7.50 |
3/1 |
1 |
7.00 |
3/1 |
5 |
6.99 |
1. The current date is 1/15. If you run the extract job with the Future prices field unselected, the job selects the following prices: |
||
1/1 |
5 |
9.00 (most recent price for this quantity not greater than current date) |
1/10 |
1 |
10.50 (most recent price for this quantity not greater than the current date) |
2. The current date is 1/15. If you run the extract job with the Future prices field selected, the job selects the following prices: |
||
3/1 |
1 |
7.00 (latest future price for this quantity) |
3/1 |
5 |
6.99 (latest future price for this quantity) |
Note: • Item or SKU prices are included in the following extract tables (see Offer-Related Table Extract Summary for more information): - EC Item Breakpoint (EXIPRC): includes single-unit and multi-unit prices at the item level - EC Offer Item Link (EXIOFL): includes single-unit prices at the item level - EC Offer SKU Link (EXSOFL): includes single-unit prices at the SKU level - EC SKU Breakpoint (EXSPRC): includes single-unit and multi-unit prices at the SKU level • If you run the extract job with the Future prices field selected, but there is no future price for the item or SKU, the job extracts the most recent price instead. • If you run the extract job with the Future prices field unselected, but there is no current price for an item or SKU and just a future price, the extract omits the item or SKU prices from the extract, with the exception of the EC Offer Item Link table; this table includes a record for the item with a price of 0. |
||
Note: Clear the records from each target table before running the extract to make sure that you capture the most up-to-date information from Order Management System, as the extract process does not always write updated information in the extract table if there is already an existing record.
Selection for download: All item-related information (such as hazard codes and e-commerce categories) are selected for download only if they are assigned to items that are selected for download.
OROMS Table |
Staging Table |
Fields |
Additional Information |
If you select the Offer field at the Process E-Commerce Downloads screen: |
|||
Offer (MSOFFR) |
EC Offer (EXOFFR) |
Company code Offer code Description Start date End date |
Only the offer(s) you indicate at the screen is/are selected. |
If you select the Sources field at the Process E-Commerce Downloads screen: |
|||
Source (MSSRC) |
EC Source (EXSRCE) |
Company code Source code Source code description Discount percentage Offer |
|
If you select the Items or New Items field at the Process E-Commerce Downloads screen: |
|||
Long SKU Class (INLSKC) OR Retail Class (INRTCP) |
EC Class (EXCLAS) |
Company code Long SKU department code Long SKU class code Long SKU class description |
A long SKU class is selected for download only if it is assigned to an item selected for download, and the item is also assigned a long SKU department. The same long SKU class can be downloaded multiple times, if it is paired with different long SKU departments. See Working with Long SKU Classes (WLSC). Note: If you select the Use Retail Integration (H26) system control value, the interface uses the Retail Class table to populate the EC Class table. |
Item Coordinate (INITCO) |
EC Cross-Sell (EXCSEL) |
Company code Item code Cross-sell item code Cross-sell description Coordinate sequence Coordinate type |
An item coordinate is selected for download only if the primary item (Note: not necessarily the coordinate item) is selected for download. Also, only the first 50 positions of the item coordinate description (a 70-position field) is included in the Cross-sell description. |
Long SKU Department (INLSKD) |
EC Department (EXDEPT) |
Company code Long SKU department code Long SKU department description |
|
Shipper/Item (OESHIM) |
EC Extra Shipping (EXSCIT) |
Company code Ship via code Item code Extra shipping charge |
|
Hazard (INHZRD) |
EC Hazard (EXHAZA) |
Company code Hazard code Hazard description |
|
EC Item (EXITEM) |
Company code Item code Item description Height Length Width Selling quantity Shipping weight Unit of measure code Vendor number Second language description SKU? (0=N, 1=Y) Active on web? (0=N, 1=Y) Long SKU department Long SKU class Long SKU category Hazard code User fields 1 through 4 Status |
Each non-SKU’d item associated with a selected offer(s) (that is, there is an item/offer assignment) is selected for download. SKU’d items are also included in the selection if they have item/offer assignments. See the Create Item Screen for field descriptions. Note: The Active on web? flag is not currently used. |
|
Item Offer (INIOFR) |
EC Item (EXITEM) |
Allow gift wrap? (0=N, 1=Y) |
See the Create Item Offer Screen. |
SKU (INSKU) |
EC Item (EXITEM) |
List price |
The Original price in the EC Item table is from the highest List price for all SKUs. |
Item Price (INIPRC) |
EC Item Breakpoint (EXIPRC) |
Company code Offer code Item code Breakpoint quantity Price |
You set up a price breakpoint for a quantity of 1 when you create an item/offer assignment and specify a price. You can also specify additional price breakpoints for larger quantities. The extract includes the latest current or future price (based on the Future prices field), for each item-level quantity breakpoint. See: • above under Downloading E-Commerce Offer Files (EOFR) for a discussion of current or future prices • the Create Item Offer Screen for information on assigning items to offers at item creation Assigning Items/SKUs to Offers for information on working with item/offer assignment, including working with quantity price breaks |
Item Offer (INIOFR) |
EC Offer Item Link (EXIOFL) |
Company code Offer code Item code Price (single unit) Special handling price Item alias Gift wrap price Custom special handling format code |
The extract includes the latest current or future price (based on the Future prices field), for each single-unit item-level price. See: • above under Downloading E-Commerce Offer Files (EOFR) for a discussion of current or future prices • the Create Item Offer Screen for information on assigning items to offers at item creation |
SKU Offer (INSKOF) |
EC Offer SKU Link (EXSOFL) |
Company code Offer code Item code Short SKU Price (single-unit) Special handling price Gift wrap price Custom special handling format code |
A SKU/offer is selected for download only if the special handling or gift wrap information differs from the item/offer, or if you select the All SKU offers option when generating the extract. The extract includes the latest current or future price (based on the Future prices field), for each single-unit SKU-level price. See: • above under Downloading E-Commerce Offer Files (EOFR) for a discussion of current or future prices • the Create SKU Offer Screen for information on assigning SKUs to offers Note: The Short SKU is stored in the SKU table and is a 7-position number used to identify SKUs and items. You can view the short SKU on display screens in Work with Items (MITM) and Inventory Inquiry (DINI). See Create Item (Base Information) Screen. |
SKU (INSKU) |
EC SKU (EXSKU) |
Company code Item code Short SKU (assigned by the system at SKU creation) SKU code SKU description SKU element 1 through 3 SKU element 1 through 3 description Restrict orders? (0=N, 1=Y) User fields 1 through 5 Soldout control code Status UPC codes (first two) |
A SKU is selected for download only if it has a SKU/offer selected for download (because it differs from the item/offer, as described above). Non-SKU’d items are also selected for download in this table. Note: The Short SKU is stored in the SKU table and is a 7-position number used to identify SKUs and items. You can view the short SKU on display screens in Work with Items (MITM) and Inventory Inquiry (DINI). See the Create Item (Base Information) Screen or the Create SKU 1 of 2 (With Overrides) Screen and the Create SKU 2 of 2 (With Overrides) Screen. |
SKU Price (INSPRC) |
EC SKU Breakpoint (EXSPRC) |
Company code Offer code Item code Short SKU (assigned by the system at SKU creation) Breakpoint quantity Price |
A SKU price is selected for download only if the SKU-level offer price differs from the Item Offer price, or if you select the All SKU offers option when generating the extract). The extract includes the latest current or future price (based on the Future prices field), for each SKU-level quantity breakpoint. See: • above under Downloading E-Commerce Offer Files (EOFR) for a discussion of current or future prices • Note above for information on Short SKUs • the Create SKU Offer Screen for information on assigning SKUs to offers Assigning Items/SKUs to Offers for information on working with item/offer assignment, including working with quantity price breaks |
Keyword (INKWDP) |
EC Keyword (EXKEYW) |
Company code Item code Keyword |
|
Page Letter Alias (INPLAL) |
EC Alias Item (EXITMA) |
Company code Item code Offer Alias item |
Order Management System includes all item aliases for an item for the offer selected in the e-commerce download. |
Item Ship Via Override (INISVO) |
EC Item Ship Via Override (EXISVO) |
Company code Item number Shipping code |
Order Management System only populates this table if records exist in the Item Ship Via Override table for an item. See Working with Item Ship Via Overrides. |
E-Commerce Product Web XML File (ProductWeb)
Purpose: The E-Commerce Product Web XML file (ProductWeb) contains item offer information for the offers selected to download on the Process E-Commerce Downloads Screen. The system generates this file when Downloading E-Commerce Offer Files (EOFR) if the Generate E-Commerce Offer Tables (M29) system control value is unselected.
Depending on whether the file storage API is enabled for exports:
• If file storage API exports enabled: If the FILE_STORAGE_EXPORTS_ENABLED property is set to true, the e-commerce offer download creates a zip file in the OMS-ECOMMERCE container of the FILE_STORAGE table. The zip file contains the E-Commerce Product Web XML File (ProductWeb). You can use the file storage API to download the file. See the File Storage API for background.
• If file storage API exports not enabled: Otherwise, if the file storage API is not enabled for exports, the file is created in the ECOMMERCE_DIRECTORY_PATH in Working with Admin Properties (CPRP) defines the location on the application server where the system downloads the E-Commerce Product Web XML file. An example of the directory is /domain/conf/OMSFiles/WebData/, where domain is the WebLogic domain directory for Order Management System. Note: If an ECOMMERCE_DIRECTORY_PATH is not valid or is blank, or the specified folder does not exist, the system does not generate the ProductWeb file and writes an error message to the Application log.
Name of file: The name of the file is ProductWeb_999_YYMMDDHHMMSS.xml, where 999 is the company code where you submitted the e-commerce offer download and YYMMDDHHMMSS is the date and time when the download occurred. When the file storage API is enabled, the file is saved in a zip file with the same name except for the .zip extension.
XML version: The ECOMMERCE_PRODUCT_XML_VERSION in Working with Customer Properties (PROP) defines the XML version of the ProductWeb XML file.
ECommerce extract date: For each item offer included in the ProductWeb XML file, the system updates the ECommerce Extract Date field in the Item Offer table with the date when the e-commerce offer download was submitted. The system uses this date if you select to include only new items in the e-commerce offer download to determine which items are new and which items have previously been downloaded.
Application log: The system writes any messages related to the e-commerce offer download to the Application Log.
Active procedure: The system creates an active procedure while the ProductWeb file is generated; once the e-commerce offer download process completes, the system clears the active procedure.
Sample message: See Sample E-Commerce Product Web XML Message (ProductWeb) for a sample message.
Note: The system includes all tags in the file, even if the tag is blank.
Attribute Name |
Type |
Length |
Comments |
Header |
|||
CompanyCode |
numeric |
3 |
The code for the company where the e-commerce download was submitted. |
Offer The offers selected to download on the Process E-Commerce Downloads Screen. |
|||
Offer |
alpha |
3 |
A code for the offer included in the e-commerce download. From Offer Number in the Offer table. |
OfferDescription |
alpha |
30 |
A description of the offer. From Offer Description in the Offer table. |
Currency |
alpha |
3 |
The currency for orders you process for this offer when using alternate currency pricing. From Ofr Currency Code in the Offer table. |
StartDate |
numeric |
8 |
The start date, in MMDDYYYY format, for the prices you define for this offer. Orders entered prior to the start date and after the end date will not use these prices. From Start Date in the Offer table. |
EndDate |
numeric |
8 |
The end date, in MMDDYYYY format, for the prices you define for this offer. Orders entered prior to the start date and after the end date will not use these prices. From Offer Stop Date in the Offer table. |
SourceCode The source codes selected to download on the Process E-Commerce Downloads Screen. |
|||
SourceCode |
alpha |
9 |
The source code associated with the offer. From Src Source Code in the Source table. |
SrcDescription |
alpha |
30 |
A description of the source code. From Src Description in the Source table. |
DisPercentage |
numeric |
5.2 |
A discount for orders assigned to this source code. This discount does not apply to orders with a Use Item Cost, No Charge, or No Charge/No Cost pricing method, or to order lines with a price override reason code applied. This discount is applied in addition to any discounts resulting from other pricing methods. The discount is calculated during Order Entry or Order Maintenance. This discount applies only to items with a Y in the Discountable field in the Item or SKU table. From Src Discount in the Source table. |
Offer |
alpha |
3 |
A code for the offer associated with the source code. From Offer Number in the Source table. |
Item The items defined for the offer. • If All items was selected on the Process E-Commerce Downloads Screen, the system includes all items assigned to at least one of the selected offers. • If New items was selected on the Process E-Commerce Downloads Screen, the system includes only items assigned to at least one of the selected offers and whose Ecommerce Extract Date field in the Item Offer table is blank. |
|||
ItemNumber |
alpha |
12 |
A code for an item defined in the offer. From Itm Number in the Item table. |
Description |
alpha |
40 |
A description of the item. From Description in the Item table. |
AllowSKUs |
alpha |
1 |
Indicates whether the item is available in various styles, such as color, size, etc. Valid values are: Y = This item has SKUs associated with it. N = There are no SKUs associated with this item. From Allow SKUs in the Item table. |
Height |
numeric |
3 |
The height measurement for an item. The Height, Length, and Width values determine the cubic volume of an item. From Item Height in the Item table. |
Length |
numeric |
3 |
The length measurement for an item. The Height, Length, and Width values determine the cubic volume of an item. From Item Length in the Item table. |
Width |
numeric |
3 |
The width measurement for an item. The Height, Length, and Width values determine the cubic volume of an item. From Width in the Item table. |
SellQty |
numeric |
5 |
The selling quantity defines the required order quantity (or multiple of) for this item. For example, an item may be stocked in single units, but must be sold in quantities of 6 (or 12, or 18, etc.). From Selling Qty in the Item table. |
ShipWeight |
numeric |
7.3 |
The actual shipping weight of the item. From Ship Weight in the Item table. |
UnitOfMeasure |
alpha |
3 |
A standard by which an item is sold. Typical units of measure include: • EA = each • IN = inches • C12 = case of 12 From Unit Of Measure in the Item table. |
VendorNumber |
numeric |
7 |
A user-defined code that represents the vendor or supplier of an item. From Vendor # in the Item table. |
DescSecondLanguage |
alpha |
40 |
From Itm Second Language Desc in the Item table. |
Department |
numeric |
4 |
A code used to group items into departments for reporting purposes. From LSD Department in the Item table. |
DepartmentDesc |
alpha |
30 |
A description of the long SKU department. From Description in the Long SKU Department table. |
Class |
numeric |
4 |
A code you can use to group items into classes for reporting purposes. From Item Class in the Item table. |
ClassDesc |
alpha |
30 |
A description of the item class. From Item Class Description in the Item Class table. |
HazardCode |
numeric |
2 |
A code used to categorize the item as a hazardous material that requires special storage and handling. From Haz Code in the Item table. |
HazardDesc |
alpha |
40 |
A description of the hazard code. From Description in the Hazard table. |
ItemStatus |
alpha |
1 |
A code that represents an item’s status, such as discontinued or active. From Item Status in the Item table. |
Discountable |
alpha |
1 |
Determines whether the item is eligible for a discount percent during order entry. Y = The item is eligible for a percent discount. N = The item is not eligible for a percent discount. From the Itm Allow P Discount field in the Item table. |
NonInventory |
alpha |
1 |
Indicates whether inventory levels are maintained for the item. Valid values are: Y = This is a non-inventory item. N = This is a regular item that will be tracked. From Non-inventory in the Item table. |
SVCType |
alpha |
1 |
A code that indicates the item is a stored value card, and whether the stored value card is a physical or virtual card. blank = The item is not a stored value card. P = The item is a physical stored value card. E = The item is a physical stored value card and, as soon as the stored value card is processed through billing, the system sends an email notification to the recipient card holder, notifying the customer that a stored value card has been purchased and is in the process of being delivered. V = The item is a virtual (non-physical) stored value card. From Itm SVC Type in the Item table. |
DropShip |
alpha |
1 |
Indicates whether you ship the item from your warehouse, or have your vendor ship it to the customer directly. Y (drop ship) = When a customer orders the item, you order the item from your vendor and the vendor ships it directly to your customer. N (non-drop ship) = You ship the item from your warehouse. From Drop Ship Item in the Item table. |
Oversize |
alpha |
1 |
Determines whether the item is considered an oversized item. Y = The item is oversized. N = The item is not oversized. From Itm Oversize Flag in the Item table. |
ShipAlone |
alpha |
1 |
Indicates how to ship the item. S = The item must ship by itself, and each unit prints on its own pick slip. blank = The item can ship with other items. From Ship Alone in the Item table. |
Set |
alpha |
1 |
Indicates whether the item is a set item. Y = the item is a set item (the Kit type for the item is Set). N = the item is not a set item. From Kit type in the Item table. |
OROBEligible |
alpha |
1 |
Y = Include this item when you send item and inventory information to Oracle Retail Order Broker; also, the item is eligible to be sent to the Order Broker on brokered backorders, store pickup, or ship-for-pickup orders. N = Do not include this item when you send item and inventory information to Oracle Retail Order Broker; also, the item is not eligible to be sent to the Order Broker on brokered backorders, store pickup, or ship-for-pickup orders. |
UserField1 |
alpha |
10 |
A user-defined field for the item. From User Field 1 in the Item table. |
UserField2 |
alpha |
10 |
A user-defined field for the item. From User Field 2 in the Item table. |
UserField3 |
alpha |
10 |
A user-defined field for the item. From User Field 3 in the Item table. |
UserField4 |
alpha |
10 |
A user-defined field for the item. From User Field 4 in the Item table. |
ItemOffer One or more offers is included for each item. |
|||
ItemOffer |
alpha |
3 |
A code that represents the offer where the item is advertised. From Offer Number in the Item Offer table. |
ItemPrice |
numeric |
7.2 |
The standard price for the item in the offer. From Standard Price in the Item Offer table. |
EffectiveDate |
numeric |
7 |
The date the price becomes valid for the item offer, in MMDDYYYY format. From Effective Date in the Item Price table. |
GiftWrap |
alpha |
1 |
Indicates if gift wrapping is available for the item in the offer. Y = The item can be gift wrapped. N = The item cannot be gift wrapped in this offer. From Gift Wrap Flag in the Item Offer table. |
GiftWrapPrice |
numeric |
7.2 |
The price in the offer for gift wrapping the item. From Gift Wrap Price in the Item Offer table. |
PersonalizationPrice |
numeric |
7.2 |
The price to charge the customer for special handling. From S H Price in the Item Offer table. |
PersonalizationCode |
alpha |
1 |
Indicates if the item is eligible for special handling in the offer. Y = The item is eligible for special handling in the offer. N = The item is not eligible for special handling in the offer. From Special Handling in the Item Offer table. |
FreightExempt |
alpha |
1 |
Indicates whether the item is exempt from freight in this offer. Y = The item is exempt from freight; a record exists in the Freight Exempt file for this item and offer. N = The item is not exempt from freight in this offer. |
ItemPrice If Future prices is selected on the Process E-Commerce Downloads Screen, the system includes the most current item price for each quantity (price with an effective date equal to or earlier than the current date) and all future prices (prices with an effective date greater than the current date). If Future prices is unselected on the Process E-Commerce Downloads Screen, the system includes the most current price for each quantity (price with an effective date equal to or earlier than the current date). Example: An item contains the following prices: qty 1, 12/01/15, 90.00 (past price) qty 1, 12/08/15, 80.00 (most current price for a quantity of 1) qty 1, 12/10/15, 75.00 (future price) qty 2, 12/01/15, 80.00 (past price) qty 2, 12/08/15, 70.00 (mist current price for a quantity of 2) qty 2, 12/10/15, 65.00 (future price)
If Future prices is selected, the system includes the following prices: qty 1, 12/08/15, 80.00 (most current price for a quantity of 1) qty 1, 12/10/15, 75.00 (future price) qty 2, 12/08/15, 70.00 (mist current price for a quantity of 2) qty 2, 12/10/15, 65.00 (future price)
If Future prices is unselected, the system includes the following prices: qty 1, 12/08/15, 80.00 (most current price for a quantity of 1) qty 2, 12/08/15, 70.00 (mist current price for a quantity of 2) |
|||
Qty |
numeric |
7 |
The quantity of the item that the customer must order to receive the price. From Qty in the Item Price table. |
Price |
numeric |
7.2 |
The price at which the item is sold. From Price in the Item Price table. |
EffectiveDate |
numeric |
8 |
The date, in MMDDYYYY format, the price or quantity break discount becomes valid. From Effective Date in the Item Price table. |
ItemAlias |
|||
AliasNumber |
alpha |
12 |
The alternate item code for the actual item. From ECA Alias Item in the EC Alias Item table. |
SKU At least one SKU element is included for each item since information is included at the SKU level even for non-SKUed items. |
|||
ShortSKU |
numeric |
7 |
The short SKU number defined for the SKU, used to identify the SKU. From Short SKU in the SKU table. |
SKUCode |
alpha |
14 |
The SKU code for the item, such as style, color, and/or size. The system separates each SKU code with a single space, for example: RED SML WMNS. From SKU Code in the SKU table. |
SKUDescription |
alpha |
40 |
A description of the SKU. From Description in the SKU table. |
SKUElement1Code |
alpha |
4 |
A code representing a SKU element, such as blue (color) or small (size). From SEO Code in the SKU table. |
SKUElement1Desc |
alpha |
10 |
A description of the SKU element, such as navy blue. From Element 1 Desc in the SKU Element 1 table. |
SKUElement2Code |
alpha |
4 |
A code representing a SKU element, such as blue (color) or small (size). From SEW Code in the SKU table. |
SKUElement2Desc |
alpha |
10 |
A description of the SKU element, such as navy blue. From Element 2 Desc in the SKU Element 2 table. |
SKUElement3Code |
alpha |
4 |
A code representing a SKU element, such as blue (color) or small (size). From Set Code in the SKU table. |
SKUElement3Desc |
alpha |
10 |
A description of the SKU element, such as navy blue. From Element 3 Desc in the SKU Element 3 table. |
ItemSKU |
alpha |
27 |
The item number and SKU codes using the full field lengths, separated by a space. The system does not include any extra space at the end; for example, if the SKU code for item REGULAR is RED, the ItemSKU is REGULAR RED. Item number is 12 positions. SKU code is 14 positions. |
RestrictOrders |
alpha |
1 |
Defines whether you can accept an order for the SKU and whether demand is captured. Y = you cannot accept an order for the item/SKU. N or blank = you can accept an order for the item/SKU. From Restrict Orders in the SKU table. |
RetailReference |
numeric |
15 |
The retail reference number assigned to the SKU. From Retail Reference # in the SKU table. |
Category |
alpha |
4 |
A code assigned to the SKU to classify and group like items for use in item relationships and compatibility. From SKU ITC Category in the SKU table. |
SKUStatus |
alpha |
1 |
The status of the item, such as discontinued. From SKU IST Item Status in the SKU table. |
SoldOutCode |
alpha |
2 |
The soldout control code specified for the SKU. From SLC Code in the SKU table. |
SoldOutType |
alpha |
1 |
Indicates whether the system sells out the SKU immediately. 1 = Sell out immediately, regardless of available on-hand stock. 2 = Include on order quantity in the soldout calculation. 3 = Exclude on order quantity in the soldout calculation. From Status in the Soldout Control table. |
SKUCost |
numeric |
11.4 |
The cost of the SKU, based on the costing method defined in the Costing Method (A25) system control value. If set to STANDARD, from the SKU Standard Cost in the SKU table. If set to AVERAGE, from the SKU Average Cost in the SKU table. If set to FIFO, from the SKU FIFO Cost in the SKU table. |
SKUOriginalPrice |
numeric |
7.2 |
The original price for the SKU. From List Price in the SKU table. |
UserField1 |
alpha |
10 |
A user-defined field for the SKU. From User Field 1 in the SKU table. |
UserField2 |
alpha |
10 |
A user-defined field for the SKU. From User Field 2 in the SKU table. |
UserField3 |
alpha |
10 |
A user-defined field for the SKU. From User Field 3 in the SKU table. |
UserField4 |
alpha |
5 |
A user-defined field for the SKU. From User Field 4 in the SKU table. |
UserField5 |
alpha |
5 |
A user-defined field for the SKU. From User Field 5 in the SKU table. |
SKUOffer All SKU offers defined for the offers selected for e-commerce download are included, regardless of whether the information differs from the item offer or not. |
|||
SKUOffer |
alpha |
3 |
A code that represents the offer where the SKU is advertised. From Offer Number in the SKU Offer table. |
SKUPrice |
numeric |
7.2 |
The price at which the SKU is sold in the offer. From Price in the SKU Price table. |
EffectiveDate |
numeric |
7 |
The date the price becomes valid, in MMDDYYYY format. From Effective Date in the SKU Price table. |
GiftWrap |
alpha |
1 |
Indicates if the SKU is eligible for gift wrap. Y = The SKU is eligible for gift wrap. N = The SKU is not eligible for gift wrap. From Gift Wrap Flag in the SKU Offer table. |
GiftWrapCost |
numeric |
7.2 |
The price for gift wrapping the SKU. From Gift Wrap Price in the SKU Offer table. |
PersonalizationPrice |
numeric |
7.2 |
The price to charge the customer for special handling. From S H Price in the SKU Offer table. |
PersonalizationCode |
alpha |
1 |
Indicates if the SKU is eligible for any type of special handling in the offer. Y = The SKU is eligible for special handling. N = The SKU is not eligible for special handling. From Special Handling Flag in the SKU Offer table. |
SKUPrice One or more SKU prices are included for each SKU offer. |
|||
Qty |
numeric |
7 |
The quantity of the SKU the customer must order to receive the discounted price. From Qty in the SKU Price table. |
Price |
numeric |
7.2 |
The price at which the SKU is sold in the offer. From Price in the SKU Price table. |
EffectiveDate |
numeric |
7 |
The date the price or quantity break becomes valid, in MMDDYYYY format. From Effective Date in the SKU Price table. |
UPCCode |
|||
UPCCode |
alpha |
14 |
The UPC code defined for the SKU. From UPC in the Item UPC table. |
SetComponent Included only if ECI SET is Y for the item. |
|||
SKUCode |
alpha |
14 |
The SKU associated with the set component. From SKU Code in the Set Detail table. |
SetQty |
numeric |
5 |
The number of units of the item to include in one set. From Qty in the Set Details table. |
SetCompItemNumber |
alpha |
12 |
A component item of the set item. From Set Comp Item Number in the Set Details table. |
SetCompSKUCode |
alpha |
14 |
The SKU of the component item. From Set Comp SKU Code in the Set Details table. |
CrossSellCoordinate Included only if a record exists in the Cross-Sell table for the item. |
|||
CrossSellItem |
alpha |
12 |
The related item coordinated to the primary item for cross-selling purposes. From ICN Coordinate Item in the Item Coordinate table. |
CrossSellDesc |
alpha |
70 |
The persuasive or descriptive message to display for the coordinate item. From ICN Message in the Item Coordinate table. |
CoordinateSequence |
numeric |
3 |
The sequence number assigned to the item coordinate type, indicating the sequence in which the Display Coordinate Items window displays coordinate items assigned to this type in order entry. From ICN Sequence in the Item Coordinate table. |
CoordinateType |
alpha |
2 |
A code representing a type of item coordinate, such as mandatory or optional. From ICN Coordinate Type in the Item Coordinate table. |
Keyword Included only if a record exists in the Keyword table for the item. |
|||
Keyword |
alpha |
20 |
The word you wish to include or exclude as a keyword, based on the keyword type. From KWD Keyword Exclusion in the Keyword table. |
ShipViaOverride Included only if a record exists in the Item Ship Via Override table for the item. |
|||
ShippingCode |
numeric |
2 |
The code for a shipper you can select as a ship via override for the item. Ship via codes are defined in and validated against the Ship Via table. From Via Ship Via Code in the Item Ship Via Override table. |
ExtraShipping Included only if a record exists in the Shipper Item table for the item. |
|||
ExtraShippingCode |
alpha |
12 |
The code for the item associated with the extra shipping cost. From Via Ship Via Code in the Shipper Item table. |
ExtraShippingCost |
numeric |
5.2 |
The extra charge that is added to orders for this item. From SIT Extra Charge in the Shipper Item table. |
Sample E-Commerce Product Web XML Message (ProductWeb)
A sample of the E-Commerce Product Web XML message (ProductWeb) is presented below.
<?xml version="1.0" encoding="UTF-8"?>
<Header CompanyCode="7">
<Offers>
<Offer EndDate="07312019" StartDate="07012015" Currency="" OfferDescription="MAIN OFFER" Offer="OFR"/>
</Offers>
<SourceCodes>
<SourceCode Offer="OFR" DiscPercentage="5.00" SrcDescription="MAIN SOURCE" SourceCode="SOURCE"/>
</SourceCodes>
<Items>
<Item UserField4="USERFIELD4" UserField3="USERFIELD3" UserField2="USERFIELD2" UserField1="USERFIELD1" OROBEligible="Y" Set="N" ShipAlone="" NonInventory="N" Oversize="N" DropShip="N" SVCType="" Discountable="Y" ItemStatus="1" HazardDesc="1 HAZARD CODE" HazardCode="1" ClassDesc="1 ITEM CLASS" Class="1" DepartmentDesc="7777 LONG SKU DEPARTMENT" Department="7777" DescSecondLanguage="ITEM SECOND LANGUAGE DESCRIPTION" VendorNumber="7" UnitOfMeasure="EA" ShipWeight="5.000" SellQty="3" Width="6" Length="24" Height="12" AllowSKUs="N" Description="ITEM DESCRIPTION" ItemNumber="ITEM">
<ItemOffers>
<ItemOffer FreightExempt="N" PersonalizationCode="MO" PersonalizationPrice="5.00" GiftWrapPrice="5.00" GiftWrap="Y" EffectiveDate="12012015" ItemPrice="90.00" ItemOffer="OFR">
<ItemPrices>
<ItemPrice EffectiveDate="12012015" Price="90.00" Qty="1"/>
<ItemPrice EffectiveDate="12012015" Price="75.00" Qty="2"/>
<ItemPrice EffectiveDate="12102015" Price="80.00" Qty="1"/>
</ItemPrices>
<ItemAliases>
<ItemAlias AliasNumber="AITEM"/>
</ItemAliases>
</ItemOffer>
</ItemOffers>
<SKUs>
<SKU UserField4="USER4" UserField3="USERFIELD3" UserField2="USERFIELD2" UserField1="USERFIELD1" UserField5="USER5" SkuOriginalPrice="100.00" SkuCost="40.00" SoldOutType="" SoldOutCode="" SkuStatus="" RetailReference="12012015" RestrictOrders="N" ItemSku="ITEM" SkuElement3Desc="" SkuElement3Code="" SkuElement2Desc="" SkuElement2Code="" SkuElement1Desc="" SkuElement1Code="" SkuDescription="" Category="ICAT" SkuCode="" ShortSku="115">
<SKUOffers/>
<UPCCodes>
<UPCCode code="12011510"/>
</UPCCodes>
</SKU>
</SKUs>
<CrossSellCoordinates>
<CrossSellCoordinate CoordinateType="" CoordinateSequence="0" CrossSellDesc="Item Coordinate Message for primary item ITEM and coordinate item SKU" CrossSellItem="SKU"/>
</CrossSellCoordinates>
<Keywords>
<Keyword Keyword="DESCRIPTION"/>
<Keyword Keyword="ITEM"/>
</Keywords>
<ShipViaOverrides>
<ShipViaOverride ShippingCode="1"/>
</ShipViaOverrides>
<ExtraShippings>
<ExtraShipping ExtraShippingCost="5.00" ExtraShippingCode="1"/>
</ExtraShippings>
</Item>
<Item UserField4="" UserField3="" UserField2="" UserField1="" OROBEligible="Y" Set="Y" ShipAlone="" NonInventory="N" Oversize="N" DropShip="N" SVCType="" Discountable="Y" ItemStatus="" HazardDesc="" HazardCode="0" ClassDesc="" Class="" DepartmentDesc="" Department="0" DescSecondLanguage="SET SECOND LANGUAGE DESCRIPTION" VendorNumber="0" UnitOfMeasure="EA" ShipWeight="0.000" SellQty="0" Width="0" Length="0" Height="0" AllowSKUs="N" Description="SET ITEM" ItemNumber="SET">
<ItemOffers>
<ItemOffer FreightExempt="N" PersonalizationCode="" PersonalizationPrice="0.00" GiftWrapPrice="0.00" GiftWrap="N" EffectiveDate="11242015" ItemPrice="100.00" ItemOffer="OFR">
<ItemPrices>
<ItemPrice EffectiveDate="11242015" Price="100.00" Qty="1"/>
</ItemPrices>
<ItemAliases/>
</ItemOffer>
</ItemOffers>
<SKUs>
<SKU UserField4="" UserField3="" UserField2="" UserField1="" UserField5="" SkuOriginalPrice="0.00" SkuCost="0.00" SoldOutType="" SoldOutCode="" SkuStatus="" RetailReference="0" RestrictOrders="N" ItemSku="SET" SkuElement3Desc="" SkuElement3Code="" SkuElement2Desc="" SkuElement2Code="" SkuElement1Desc="" SkuElement1Code="" SkuDescription="" Category="" SkuCode="" ShortSku="7">
<SKUOffers/>
</SKU>
</SKUs>
<SetComponents>
<SetComponent SkuCode="" SetCompSkuCode="" SetCompItemNumber="SETCOMP1" SetQty="1"/>
<SetComponent SkuCode="" SetCompSkuCode="RED" SetCompItemNumber="SETCOMP2SKU" SetQty="1"/>
</SetComponents>
<CrossSellCoordinates/>
<Keywords>
<Keyword Keyword="ITEM"/>
<Keyword Keyword="SET"/>
</Keywords>
<ShipViaOverrides/>
<ExtraShippings/>
</Item>
<Item UserField4="USERFIELD4" UserField3="USERFIELD3" UserField2="USERFIELD2" UserField1="USERFIELD1" OROBEligible="Y" Set="N" ShipAlone="" NonInventory="N" Oversize="N" DropShip="N" SVCType="" Discountable="Y" ItemStatus="1" HazardDesc="" HazardCode="0" ClassDesc="1 ITEM CLASS" Class="1" DepartmentDesc="7777 LONG SKU DEPARTMENT" Department="7777" DescSecondLanguage="" VendorNumber="7" UnitOfMeasure="EA" ShipWeight="5.000" SellQty="1" Width="12" Length="12" Height="12" AllowSKUs="Y" Description="SKU ITEM DESCRIPTION" ItemNumber="SKU">
<ItemOffers>
<ItemOffer FreightExempt="N" PersonalizationCode="" PersonalizationPrice="0.00" GiftWrapPrice="0.00" GiftWrap="N" EffectiveDate="10202015" ItemPrice="50.00" ItemOffer="OFR">
<ItemPrices>
<ItemPrice EffectiveDate="10202015" Price="50.00" Qty="1"/>
</ItemPrices>
<ItemAliases/>
</ItemOffer>
</ItemOffers>
<SKUs>
<SKU UserField4="USER4" UserField3="USERFIELD3" UserField2="USERFIELD2" UserField1="USERFIELD1" UserField5="USER5" SkuOriginalPrice="150.00" SkuCost="45.00" SoldOutType="" SoldOutCode="" SkuStatus="" RetailReference="0" RestrictOrders="N" ItemSku="SKU RED" SkuElement3Desc="" SkuElement3Code="" SkuElement2Desc="" SkuElement2Code="" SkuElement1Desc="BERRY RED" SkuElement1Code="RED" SkuDescription="RED SKU" Category="ICAT" SkuCode="RED" ShortSku="5">
<SKUOffers>
<SKUOffer PersonalizationCode="MO" PersonalizationPrice="5.00" GiftWrap="Y" EffectiveDate="12012015" GiftWrapCost="5.00" SkuPrice="100.00" SkuOffer="OFR">
<SKUPrices>
<SKUPrice EffectiveDate="12012015" Price="100.00" Qty="1"/>
<SKUPrice EffectiveDate="12052015" Price="70.00" Qty="2"/>
<SKUPrice EffectiveDate="12102015" Price="70.00" Qty="1"/>
</SKUPrices>
</SKUOffer>
</SKUOffers>
<UPCCodes>
<UPCCode code="12011511"/>
</UPCCodes>
</SKU>
<SKU UserField4="" UserField3="" UserField2="" UserField1="" UserField5="" SkuOriginalPrice="0.00" SkuCost="0.00" SoldOutType="" SoldOutCode="" SkuStatus="" RetailReference="0" RestrictOrders="N" ItemSku="SKU BLUE SML WMNS" SkuElement3Desc="WOMENS" SkuElement3Code="WMNS" SkuElement2Desc="SMALL" SkuElement2Code="SML" SkuElement1Desc="DENIM BLUE" SkuElement1Code="BLUE" SkuDescription="BLUE SML WMNS SKU DESCRIPTION" Category="" SkuCode="BLUE SML WMNS" ShortSku="118">
<SKUOffers/>
</SKU>
<SKU UserField4="" UserField3="" UserField2="" UserField1="" UserField5="" SkuOriginalPrice="0.00" SkuCost="0.00" SoldOutType="" SoldOutCode="" SkuStatus="" RetailReference="0" RestrictOrders="N" ItemSku="SKU GRN SML WMNS" SkuElement3Desc="WOMENS" SkuElement3Code="WMNS" SkuElement2Desc="SMALL" SkuElement2Code="SML" SkuElement1Desc="JADE GREEN" SkuElement1Code="GRN" SkuDescription="GRN SML WMSN SKU DESCRIPTION" Category="" SkuCode="GRN SML WMNS" ShortSku="119">
<SKUOffers/>
</SKU>
<SKU UserField4="" UserField3="" UserField2="" UserField1="" UserField5="" SkuOriginalPrice="0.00" SkuCost="0.00" SoldOutType="" SoldOutCode="" SkuStatus="" RetailReference="0" RestrictOrders="N" ItemSku="SKU RED SML WMNS" SkuElement3Desc="WOMENS" SkuElement3Code="WMNS" SkuElement2Desc="SMALL" SkuElement2Code="SML" SkuElement1Desc="BERRY RED" SkuElement1Code="RED" SkuDescription="RED SML WMNS SKU DESCRIPTION" Category="" SkuCode="RED SML WMNS" ShortSku="117">
<SKUOffers/>
</SKU>
<SKU UserField4="" UserField3="" UserField2="" UserField1="" UserField5="" SkuOriginalPrice="0.00" SkuCost="0.00" SoldOutType="" SoldOutCode="" SkuStatus="" RetailReference="0" RestrictOrders="N" ItemSku="SKU YELW SML WMNS" SkuElement3Desc="WOMENS" SkuElement3Code="WMNS" SkuElement2Desc="SMALL" SkuElement2Code="SML" SkuElement1Desc="SUN YELLOW" SkuElement1Code="YELW" SkuDescription="YELW SML WMNS SKU DESCRIPTION" Category="" SkuCode="YELW SML WMNS" ShortSku="120">
<SKUOffers/>
</SKU>
</SKUs>
<CrossSellCoordinates/>
<Keywords>
<Keyword Keyword="DESCRIPTION"/>
<Keyword Keyword="ITEM"/>
<Keyword Keyword="SKU"/>
</Keywords>
<ShipViaOverrides/>
<ExtraShippings>
<ExtraShipping ExtraShippingCost="5.00" ExtraShippingCode="1"/>
</ExtraShippings>
</Item>
</Items>
</Header>
| Downloading E-Commerce Static Tables (ESTF) | Contents | SCVs | Search | Glossary | Reports | Solutions | XML | Index | Removing Offers and Items from Download (ERMV) |
EOFR OMSCS 18.1 April 2019 OTN