Oracle® Retail Enterprise Inventory Cloud Service Administration Guide Release 22.1.103.0 F52084-02 |
|
Previous |
Next |
SIOCS needs merchandising foundation data (stores, items, initial inventory positions, suppliers, and so on) in order to function.
Initial inventory data seeding is applicable for new or fresh full SIOCS installation. After the initial set of data is seeded into SIOCS, subsequent inventory changes are communicated via Oracle Retail Integration Cloud Service.
Data Seeding from Merchandising Foundation Cloud Service
When SIOCS and MFCS (Merchandising Foundation Cloud Service) are co-deployed in the same database Container, the data seeding process import data from the MFCS database into SIOCS database, and this seeding is a MDI-Based data seeding.
Standalone Data Seeding
In SIOCS standalone installation, SIOCS provides standalone data seeding to seed external data into SIOCS. See Standalone Data Seeding for details.
This section contains the following:
Merchandising Data Integration (MDI) Based Data Seeding process is seeding foundation data from a co-deployed MFCS (Merchandising Foundation Cloud Service) database into SIOCS.
Data Seeding contains 39 modules, and are grouped into nine (9) groups based on dependency and functionality. See Table G-1, "Data Seeding Process Flow Dependencies List" for details.
Data seeding can be used for a variety of use cases:
Loading just the Foundation data from Merchandising
Loading all stores data
Loading a single store data
Table 2-1 Initial Data Loading Groups
Group Number | Data Group | Module | Description |
---|---|---|---|
2 |
Item |
Item Header |
Initial Data Loading Groups |
2 |
Item CFA |
Import item custom flexible attribute data. |
|
2 |
Item Translation |
Import item description translation data. |
|
3 |
Item Image |
Import item image URL data. |
|
3 |
Item UDA |
Import item User Defined Attribute data. |
|
1 |
Item Hierarchy |
Import item merchandise hierarchy data, for example, department, class and subclasses. |
|
3 |
Pack Item |
Import item pack item component data. |
|
3 |
Related Item |
Import related item type data. |
|
4 |
Related Item Detail |
Import related item detail data. |
|
2 |
Miscellaneous |
Differentiator |
Import item differentiation data. |
1 |
Differentiator Type |
Import item differentiator type data, for example, color, size, and so on. |
|
1 |
Transfer Zone |
Import transfer zone data. |
|
1 |
UDA |
Import User Defined Attribute data. |
|
2 |
UDA Values |
Import User Defined Attribute Value data. |
|
1 |
UOM Class |
Import Unit Of Measure class data. |
|
2 |
UOM Conversion |
Import Unit Of Measure conversion data. |
|
Store |
Store Item Stock |
Import store item stock record data. Can be run by a store, or list of stores. |
|
5 |
Store |
Import store data. Can be run by a store, or list of stores. |
|
5 |
Store Address |
Import store address data. Can be run by a store, or list of stores. |
|
6 |
Store Item |
Import store item data. Can be run by a store, or list of stores. |
|
7 |
Store Item CFA |
Import store item custom defined attributes. |
|
7 |
Store Item Stock |
Import store item stock data. |
|
8 |
Store Item Price |
Import store item price data. Can be run by a store, or list of stores. |
|
9 |
Store Item Price History |
Import store item price history data. Can be run by a store, or list of stores. |
|
9 |
Store UIN Admin Item |
Import UIN admin item foundation data. Only applicable if UIN is enabled for the store. Can be run by a store, or list of stores. |
|
4 |
Supplier |
Item Supplier Country Dimension |
Import item supplier country dimension data. |
4 |
Item Supplier Manufacturer Country |
Import item supplier manufacture country data. |
|
4 |
Item Supplier Country |
Import item supplier country data. |
|
4 |
Item Supplier UOM |
Import item supplier UOM data. |
|
4 |
Item Supplier |
Import item supplier data. |
|
1 |
Partner |
Importer partner data. |
|
1 |
Partner Address |
Import partner address data. |
|
Partner Item |
Import partner item data. |
||
2 |
Supplier Organization Unit |
Import supplier organization unit data. |
|
1 |
Supplier |
Import supplier data. |
|
1 |
Supplier Address |
Import supplier address data. |
|
1 |
Supplier CFA |
Import supplier custom flex attributes |
|
1 |
Warehouse |
Warehouse |
Import warehouse data. |
1 |
Warehouse Address |
Import warehouse address data. |
|
3 |
Warehouse Item |
Import warehouse item data. |
Typically, data seeding on fresh installed SIOCS environment.
Data seeding modules are grouped into 9 data groups:
See Appendix I-1 Data Seeding Module and Database Table Mappings for additional information.
Prior to running data seeding, the following requirements must be met:
MFCS database is installed
MFCS foundation data setup are completed
MFCS and SIOCS are installed in the same pluggable database with different schemas
User need to have following Application roles assigned in IDCS or OCI IAM:
{ SIOCS Primary APP}.admin_users for example,
RGBU_SIOCS_CFS_EICS.admin_users
{SIOCS Primary APP}.batch_users for example,
RGBU_SIOCS_CFS_EICS.batch_users
Table 2-2 Security Permissions for Initial Data Loading
Name | Description |
---|---|
Access Initial Data Load |
With this permission the user will have access to the Initial Data Load screen. Without this permission the user will not have access to the Initial Data Load screen. |
Submit Initial Data Load |
With this permission the user will have the permission to submit seed. Without this permission, the Submit Seed button will be disabled for the user. |
Delete Initial Data Load |
With this permission the user will have the permission to delete seeded data. Without this permission, the Delete Seed button will be disabled for the user. |
To seed initial inventory foundation data from sourcing system directly into destination application tables, an application implementation consultant must perform the following configuration steps:
Login SIOCS Application as a user who are assigned proper app roles and security permissions, see App Roles and Security Permission Section for details.
To seed data from co-deployed Merchandising data integration shared database, set system configuration values as shown below:
Set Enable Merchandising data integration shared database to Yes.
Set Initial Data Load Seed to Yes.
Set Initial Seed Foundation to Yes.
Set Initial Data Load Seed Foundation Data to Yes.
To start the initial data loading, perform following steps:
Login SIOCS Application as app admin user.
Navigate to Admin - Technical Maintenance - Initial Data Loading Screen.
Filter the modules by execution group, start with group 1.
Select the module group, then click Submit Seed button.
Note: To run data seeding for store related groups, user will need to select sourcing stores using Select Store button. |
Once modules for selected group are completed, then proceed to the next group.
To view data loading log for the selected module:
Click the executed module record from the module list panel.
Scroll down to the Executions panel to view execution details for the selected module.
To view data loading execution details:
Click the executed module record from the module list panel.
Select record in the Execution panel.
Click the ID link to navigate to the Execution Detail screen.
In the event of failures, you may need to re-run the data seeding after correcting the errors.
To re-run data seeding:
Select the module, then click the Delete Data button.
After delete process to complete, select the module, then click Submit Seed button.
Verify data seeded into SIOCS application tables without error.
Set Initial Data Load Seed to No.
Set Initial Seed Foundation to No.
Set Initial Data Load Seed Foundation Data to No.
Note: For stores which need to be rolled out by phases, the value can be set back to Yes before loading another set of stores, and set to No after all stores are seeded from sourcing system. |
Table 2-3 Data Seeding MFCS-SIOCS View Mappings
Seeding Module | SIOCS Target Table | SIOCS View | MFCS1 |
---|---|---|---|
Differentiator Type |
DIFFERENTIATOR_TYPE |
IDLV_DIFFERENTIATOR_TYPE |
V_RMS_SIM_DIFF_TYPE |
Differentiator |
DIFFERENTIATOR |
IDLV_DIFFERENTIATOR |
V_RMS_SIM_DIFF |
Item |
ITEM |
IDLV_ITEM |
V_RMS_SIM_ITEM_MASTER |
Item CFA |
ITEM_CFA |
IDLV_ITEM_CFA |
V_RMS_SIM_ITEM_MASTER_CFA_EXT |
Item Description Translation |
ITEM_DESCRIPTION |
IDLV_ITEM_DESCRIPTION |
V_RMS_SIM_ITEM_MASTER_TL |
Item Image |
ITEM_IMAGE |
IDLV_ITEM_IMAGE |
V_RMS_SIM_ITEM_IMAGE |
Item Supp Country Dim |
SUPPLIER_ITEM_COUNTRY_DIM |
IDLV_SUPPLIER_ITEM_COUNTRY_DIM |
V_RMS_SIM_ITEM_SUPP_CTRY_DIM |
Item Supp Man. Country |
SUPPLIER_ITEM_MANUFACTURE |
IDLV_SUPPLIER_ITEM_MANUFACTURE |
V_RMS_SIM_ITEM_SUPP_MANU_CTRY |
Item Supp Country |
SUPPLIER_ITEM_COUNTRY |
IDLV_SUPPLIER_ITEM_COUNTRY |
V_RMS_SIM_ITEM_SUPP_CTRY |
Item Supplier |
SUPPLIER_ITEM |
IDLV_SUPPLIER_ITEM |
V_RMS_SIM_ITEM_SUPPLIER |
Item Supplier UOM |
SUPPLIER_ITEM_UOM |
IDLV_SUPPLIER_ITEM_UOM |
V_RMS_SIM_ITEM_SUPP_UOM |
Item UDA |
ITEM_UDA |
IDLV_ITEM_UDA |
V_RMS_SIM_UDA_ITEM_DATE V_RMS_SIM_UDA_ITEM_FF V_RMS_SIM_UDA_ITEM_LOV |
Merch Hier |
ITEM_HIERARCHY |
IDLV_ITEM_HIER |
V_RMS_SIM_MERCH_HIER |
Pack Item |
ITEM_COMPONENT |
IDLV_ITEM_COMPONENT |
V_RMS_SIM_PACKITEM |
Partner |
PARTNER |
IDLV_PARTNER |
V_RMS_SIM_EXTERNAL_FINISHER |
Partner Address |
ADDRESS |
IDLV_ADDRESS |
V_RMS_SIM_ADDR |
Partner Item |
PARTNER_ITEM |
IDLV_PARTNER_ITEM |
V_RMS_SIM_ITEM_LOC (loc_type = 'E' --external finisher) |
Partner Org Unit |
SUPPLIER_ORGANIZATION |
IDLV_SUPPLIER_ORGANIZATION |
V_RMS_SIM_PARTNER_ORG_UNIT |
Price History |
ITEM_PRICE_HISTORY |
IDLV_STORE_ITEM_PRICE_HIST |
V_RMS_SIM_PRICE_HIST |
Related Item |
RELATED_ITEM_TYPE |
IDLV_RELATED_ITEM_TYPE |
V_RMS_SIM_RELATED_ITEM_HEAD |
Related Item Detail |
RELATED_ITEM |
IDLV_RELATED_ITEM |
V_RMS_SIM_RELATED_ITEM_DETAIL |
Store |
STORE |
IDLV_STORE |
V_RMS_SIM_STORE |
Store Address |
ADDRESS |
IDLV_ADDRESS |
V_RMS_SIM_ADDR |
Store Item |
STORE_ITEM |
IDLV_STORE_ITEM |
V_RMS_SIM_STORE_ITEM V_RMS_SIM_REPL_ITEM_LOC |
Store Uin Admin Item |
STORE_UIN_ADMIN_ITEM |
IDLV_STORE_UIN_ADMIN_ITEM |
V_RMS_SIM_STORE_ITEM |
Store Item CFA |
STORE_ITEM_CFA |
IDLV_STORE_ITEM_CFA |
V_RMS_SIM_ITEM_LOC_CFA_EXT |
Store Item Price |
ITEM_PRICE |
IDLV_STORE_ITEM_PRICE |
V_RMS_SIM_ITEM_LOC |
Store Item Stock |
STORE_ITEM_STOCK STORE_ITEM_STOCK_NONSELL |
IDLV_STORE_ITEM_STOCK IDLV_STORE_ITEM_STOCK_NONSELL |
V_RMS_SIM_STORE_ITEM_SOH |
Supplier |
SUPPLIER |
IDLV_SUPPLIER |
V_RMS_SIM_SUPS |
Supplier CFA |
SUPPLIER_CFA |
IDLV_SUPPLIER_CFA |
V_RMS_SIM_SUPS_CFA_EXT |
Supplier Address |
ADDRESS |
IDLV_ADDRESS |
V_RMS_SIM_ADDR |
Transfer Zone |
STORE_TRANSFER_ZONE |
IDLV_TRANSFER_ZONE |
V_RMS_SIM_TSFZONE |
UDA |
UDA |
IDLV_UDA |
V_RMS_SIM_UDA |
UDA LOV |
UDA LOV |
IDLV_UDA_LOV |
V_RMS_SIM_UDA_VALUES |
UOM Class |
UOM_CLASS |
IDLV_UOM_CLASS |
V_RMS_SIM_UOM_CLASS |
UOM Conversion |
UOM_CONVERSION |
IDLV_UOM_CONVERSION |
V_RMS_SIM_UOM_CONVERSION |
Warehouse |
WAREHOUSEWAREHOUSE_VIRTUAL |
IDLV_WAREHOUSE IDLV_WAREHOUSE_VIRTUAL |
V_RMS_SIM_WH |
Warehouse Address |
ADDRESS |
IDLV_ADDRESS |
V_RMS_SIM_ADDR |
Warehouse Item Address |
WAREHOUSE_ITEM |
IDLV_WAREHOUSE_ITEM |
V_RMS_SIM_ITEM_LOC |
1MFCS view: only applicable for data seeding source is MFCS on a co-deployed Oracle PDB.
This section contains the following:
Data seeding in a SIOCS Standalone installation is achieved by uploading data in CSV (comma-separated values) files to Object Storage via FTS (File Transfer Service). The Initial Foundation Data File Import and Initial Store Data File Import batch jobs then download the relevant files from Object Storage (see Data Seeding Modules) and import the data into SIOCS.
The Initial Data Load UI (see Data Seeding from Merchandising Foundation Cloud Service) can be re-used in a SIOCS Standalone installation to view the status of each Data Seeding Module (see below), view any errors associated with the processing of files for that module, and to Delete Data for that module.
Note: The Submit Seed button will be disabled in a SIOCS Standalone installation: data seeding will be initiated by running the Initial Foundation Data File Import and Initial Store Data File Import batch jobs from the Job Admin UI (see Batches). |
Table 2-4 System Admin Parameters
Option | Description | Default Value | Topic | Type |
---|---|---|---|---|
Initial Data Load Seed |
Determines if data seeding is enabled. |
No |
Admin |
Boolean |
Initial Data Load Seed Foundation Data |
Determines if data seeding of foundation data is enabled. |
No |
Admin |
Boolean |
Initial Data Load Seed Store Data |
Determines if data seeding of store data is enabled. Yes: Store Data will be available for data seeding. No: Store Data will not be available for data seeding. |
No |
Admin |
Boolean |
Initial Data Load Fail Limit |
The maximum number of errors to ignore before processing of a file is terminated. |
0 |
Batch |
Integer |
Initial Data Load Chunk Log Limit |
The maximum number of errors to log when processing a file - this value should be greater than the Initial Data Load Fail Limit. |
10 |
Batch |
Integer |
Initial Data Load Chunk Limit |
The maximum number of records to insert into the DB in a single batch update. |
1000 |
Batch |
Integer |
Set the Initial Data Load Seed and Initial Data Load Seed Foundation Data options to Yes.
Upload the relevant foundation data files to the imports folder in Object Storage via FTS.
Run the Initial Foundation Data File Import batch job: the batch job will download the foundation data files from Object Storage, parse the files and insert the data into the staging tables, merge/upsert the data from the staging tables into the SIOCS master tables, upload any failed files/records to the rejects folder, and any successful files/records to the archives folder, in Object Storage.
Wait for the batch job to finish then check the Job Execution (Job Admin UI) and Execution Detail (Initial Data Load UI) screens for any errors. If the number of errors exceeds the Initial Data Load Fail Limit the entire file will be rejected and uploaded to the rejects folder in Object Storage. If the number of errors does not exceed the Initial Data Load Fail Limit, the erroneous records will be uploaded to the rejects folder, and the successful records to the archives folder in Object Storage.
Note: For performance reasons, the batch job will zip any files > 10 MB before uploading to Object Storage. |
Correct any errors and repeat steps 2 to 4 until there are no errors and all the foundation data has been imported.
Note: It is not necessary to delete data for a module before re-importing data for that module: the batch job uses a merge/upsert when copying data from the staging tables to the SIOCS master tables. |
Set the Initial Data Load Seed Foundation Data option to No and the Initial Data Load Seed Store Data option to Yes.
Upload the relevant store data files to the imports folder in Object Storage via FTS.
Run the Initial Store Data File Import batch job: the batch job follows the same flow as the Initial Foundation Data File Import batch job but for store data.
Wait for the batch job to finish then check the Job Execution (Job Admin UI) and Execution Detail (Initial Data Load UI) screens for any errors.
Correct any errors and repeat steps 7 to 9 until there are no errors and all the store data has been imported.
Set the Initial Data Load Seed and Initial Data Load Seed Store Data options to No.
Data seeding modules are grouped into 5 data groups:
Table 2-5 Initial Data Loading Groups
Data Group | Module | Description |
---|---|---|
Item |
Item |
Item data. |
Item CFA |
Item custom flexible attribute data. |
|
Item Component |
Pack item component data. |
|
Item Description |
Item description data. |
|
Item Hierarchy |
Item merchandise hierarchy data, for example, department, class and subclasses. |
|
Item Image |
Item image URL data. |
|
Item UDA |
Item user defined attribute data. |
|
Related Item |
Related item detail data. |
|
Related Item Type |
Related item type data. |
|
Miscellaneous |
Differentiator |
Item differentiation data. |
Differentiator Type |
Item differentiation type data, such as style, color, size, and so on. |
|
Transfer Zone |
Transfer zone data. |
|
UDA |
User defined attribute data. |
|
UDA LOV |
User defined attribute list of values data. |
|
UOM Class |
Unit of measure class data. |
|
UOM Conversion |
Unit of measure conversion data. |
|
Store |
Store |
Store data. |
Store Address |
Store address data. |
|
Store Item |
Store item data. |
|
Store Item CFA |
Store item custom flexible attribute data. |
|
Store Item Price |
Store item price data. |
|
Store Item Price History |
Store item price history data. |
|
Store Item Stock |
Store item stock record data. |
|
Store UIN Admin Item |
Store UIN (Unique Identification Number) admin item data. |
|
Supplier |
Partner |
Partner data. |
Partner Address |
Partner address data. |
|
Partner Item |
Partner item data. |
|
Supplier |
Supplier data. |
|
Supplier Address |
Supplier address data. |
|
Supplier CFA |
Supplier custom flexible attribute data. |
|
Supplier Item |
Supplier item data. |
|
Supplier Item Country |
Supplier item country data. |
|
Supplier Item Country Dimension |
Supplier item country dimension data. |
|
Supplier Item Manufacturer |
Supplier item country manufacture data. |
|
Supplier Organization |
Supplier organization unit data. |
|
Supplier UOM |
Supplier UOM data. |
|
Warehouse |
Warehouse |
Warehouse data. |
Warehouse Address |
Warehouse address data. |
|
Warehouse Item |
Warehouse item data. |
The data for the Miscellaneous, Item, Supplier and Warehouse data group modules are imported by the Initial Foundation Data File Import batch job. The data for the Store data group modules are imported by the Initial Store Data File Import batch job. All foundation data should be imported prior to importing any store data. Due to referential integrity constraints (see File Layouts) the batch jobs process the data in the order shown above (for example, the Supplier Item module cannot be imported prior to the Supplier and Item modules, and the Item module cannot be imported prior to the Item Hierarchy module); as such the files for each module should be uploaded to Object Storage and imported in a similar order (or all at the same time). To import data for a group of Stores, upload all the data for those Stores to Object Storage, then run the Initial Store Data File Import batch job. To import data for a single Store, upload all the data for that Store to Object Storage, then run the Initial Store Data File Import batch job. Alternatively, the Initial Store Data File Import batch job can be run for a single Store by entering the Store ID in the Job Admin UI and adding the Store ID to the corresponding filename(s) (vide infra).
All files should be in CSV (comma-separated values) format, with either a ".csv" or ".dat" filename extension. The batch jobs also support zipped files which will be extracted upon download and processed individually. Empty or blank fields within a record will be considered null. String fields containing a comma or double quote must be quoted (with double quotes), a double quote in a field must be represented by 2 double quote characters. Line breaks within quoted fields are not supported. The filename format is IDL-[MODULENAME]-XXXX.csv(/dat/zip). Files contained within .zip files must adhere to the same filename format. To run the Initial Store Data File Import batch job for a particular Store, the filename format is IDL-[MODULENAME]-[STOREID]-XXXX.csv(/dat/zip). Any files which do not adhere to the filename format will not be downloaded or processed. Files > 500MB will be rejected: the file should be split into smaller files and uploaded as a .zip file. It is recommended to not edit the .csv files in Excel as this can lead to formatting issues.
The file layout for each module is described below:
Table 2-6 Differentiator Type File Layout
Field Name | Description | Required | Type |
---|---|---|---|
ID |
The unique identifier of the differentiator type. |
Yes |
VARCHAR2 (10) |
DESCRIPTION |
The description of the differentiator type. |
Yes |
VARCHAR2 (255) |
Example CSV File
IDL-DIFFERENTIATORTYPE-*.csv
1,DESCRIPTION FOR DIFFERENTIATOR TYPE 1
Table 2-7 Item Hierarchy File Layout
Field Name | Description | Required | Type |
---|---|---|---|
DEPARTMENT_ID |
The department identifier. |
No |
NUMBER (12, 0) |
DEPARTMENT_NAME |
The name of the department. |
No |
VARCHAR2 (360) |
CLASS_ID |
The class identifier. |
No |
NUMBER (12, 0) |
CLASS_NAME |
The name of the class. |
No |
VARCHAR2 (360) |
SUBCLASS_ID |
The subclass identifier. |
No |
NUMBER (12, 0) |
SUBCLASS_NAME |
The name of the subclass. |
No |
VARCHAR2 (360) |
STATUS |
The status of the item hierarchy - A (Active) or D (Deleted). |
Yes |
VARCHAR2 (1) |
The unique key comprises the DEPARTMENT_ID, CLASS_ID and SUBCLASS_ID fields.
Example CSV File
IDL-ITEMHIERARCHY-*.csv
1,Department 1,1,Class 1,1,Subclass 1,A
Table 2-8 Partner File Layout
Field Name | Description | Required | Type |
---|---|---|---|
ID |
The unique identifier of the partner. |
Yes |
NUMBER (10, 0) |
NAME |
The name of the partner. |
No |
VARCHAR2 (240) |
CURRENCY_CODE |
The ISO 4217 currency code of the partner. |
No |
VARCHAR2 (3) |
LOCALE_ID |
The locale identifier of the partner - see Supported Locales. |
No |
NUMBER (6) |
STATUS |
The status of the partner - A (Active) or I (Inactive). |
No |
VARCHAR2 (1) |
CONTACT_NAME |
The contact name. |
No |
VARCHAR2 (120) |
CONTACT_PHONE |
The contact phone number. |
No |
VARCHAR2 (20) |
CONTACT_FAX |
The contact fax number. |
No |
VARCHAR2 (20) |
CONTACT_TELEX |
The contact telex number. |
No |
VARCHAR2 (20) |
CONTACT_EMAIL |
The contact email address. |
No |
VARCHAR2 (100) |
MANUFACTURER_ID |
The manufacturer's tax identification number. |
No |
VARCHAR2 (18) |
PRINCIPAL_COUNTRY_ID |
The ISO 3166 2- (or 3-) letter country code to which the partner is assigned. |
No |
VARCHAR2 (3) |
TAX_ID |
The unique tax identification number of the partner. |
No |
VARCHAR2 (18) |
PAYMENT_TERMS |
The payment terms of the partner. |
No |
VARCHAR2 (20) |
IMPORT_COUNTRY_ID |
The ISO 3166 2- (or 3-) letter country code of the Import Authority. |
No |
VARCHAR2 (3) |
IMPORT_PRIMARY |
Flag that indicates if an Import Authority is the primary Import Authority for an import country - Y or N. |
No |
VARCHAR2 (1) |
ORGANIZATION_UNIT_ID |
The organization unit identifier of the partner. |
No |
VARCHAR2 (15) |
VALUE_ADDED_TAX_REGION |
The VAT region of the partner. |
No |
VARCHAR2 (20) |
TRANSFER_ENTITY_ID |
The transfer entity identifier of the partner. |
No |
VARCHAR2 (20) |
Example CSV File
IDL-PARTNER-*.csv
1,Partner 1,GBP,1,A,Contact Name 1,Contact Phone 1,Contact Fax 1,Contact Telex 1,Contact Email 1,Manufacturer ID 1,GB,123456789012345678,Payment Terms 1,US,Y,Org Unit ID 1,VAT Region 1,Transfer Entity ID 1
Table 2-9 Supplier File Layout
Field Name | Description | Required | Type |
---|---|---|---|
ID |
The unique identifier of the supplier. |
Yes |
NUMBER (10, 0) |
DUNS_NUMBER |
The Dun and Bradstreet number to identify the supplier. |
No |
VARCHAR2 (9) |
NAME |
The name of the supplier. |
No |
VARCHAR2 (240) |
STATUS |
The status of the supplier - A (Active) or I (Inactive). |
No |
VARCHAR2 (1) |
LOCALE_LANGUAGE |
The ISO 3166 language to which the supplier is assigned - see Supported Locales. |
No |
VARCHAR2 (3) |
LOCALE_COUNTRY |
The ISO 3166 2- (or 3-) letter country code to which the supplier is assigned. |
No |
VARCHAR2 (3) |
CURRENCY_CODE |
The ISO 4217 currency code of the supplier. |
No |
VARCHAR2 (3) |
RETURN_ALLOWED |
Flag indicating if the supplier will accept returns - Y or N. |
No |
VARCHAR2 (1) |
AUTHORIZATION_REQUIRED |
Flag indicating if returns must be accompanied by an authorization number - Y or N. |
No |
VARCHAR2 (1) |
PO_CREATE_ALLOWED |
Flag indicating if purchase orders can be created - Y or N. |
No |
VARCHAR2 (1) |
VENDOR_CHECK |
Flag indicating if orders from this supplier will require vendor control - Y or N. |
No |
VARCHAR2 (1) |
VENDOR_CHECK_PERCENT |
The percentage of items per receipt that will be marked for vendor checking. |
No |
NUMBER (12, 4) |
PARENT_ID |
The identifier of the parent supplier. |
No |
VARCHAR2 (128) |
QUANTITY_LEVEL |
The supplier order quantity level - CA (Case) or EA (Each). |
Yes |
VARCHAR2 (6) |
TAX_ID |
The unique tax identification number of the supplier. |
No |
VARCHAR2 (18) |
DELIVERY_DISCREPANCY_TYPE |
The delivery discrepancy type - 0 (Allow), 1 (Overage) or 2 (Restricted). |
No |
NUMBER (2, 0) |
Example CSV File
IDL-SUPPLIER-*.csv
1,1111,Supplier 1,A,en,GB,GBP,Y,N,Y,Y,12345678.1234,Parent Of 1,CA,1234,0
Table 2-10 Transfer Zone File Layout
Field Name | Description | Required | Type |
---|---|---|---|
TRANSFER_ZONE |
The unique identifier of the transfer zone. |
Yes |
VARCHAR2 (128) |
DESCRIPTION |
The description of the transfer zone. |
Yes |
VARCHAR2 (255) |
Example CSV File
IDL-TRANSFERZONE-*.csv
1,DESCRIPTION FOR TRANSFER ZONE 1
Table 2-11 UDA File Layout
Field Name | Description | Required | Type |
---|---|---|---|
ID |
The unique identifier of the user defined attribute. |
Yes |
NUMBER (5, 0) |
TYPE |
The type of user defined attribute - FF, DT or LV. |
Yes |
VARCHAR2 (2) |
DESCRIPTION |
The description of the user defined attribute. |
Yes |
VARCHAR2 (120) |
PRINT_TICKET |
Flag indicating if item tickets should be printed for this user defined attribute - Y or N. |
Yes |
VARCHAR2 (1) |
PRINT_LABEL |
Flag indicating if item labels should be printed for this user defined attribute - Y or N. |
Yes |
VARCHAR2 (1) |
Example CSV File
IDL-UDA-*.csv
1,FF,DESCRIPTION FOR 1,Y,Y
Table 2-12 UOM Class File Layout
Field Name | Description | Required | Type |
---|---|---|---|
UOM |
The unique identifier of the unit of measure. |
Yes |
VARCHAR2 (4) |
UOM_CLASS |
The type of unit of measure - AREA, DIMEN, LVOL, MASS, MISC, PACK, QTY or VOL. |
Yes |
VARCHAR2 (6) |
DESCRIPTION |
The description of the unit of measure. |
Yes |
VARCHAR2 (120) |
Example CSV File
IDL-UOMCLASS-*.csv
g,MASS,DESCRIPTION FOR 'GRAM'
Table 2-13 Warehouse File Layout
Field Name | Description | Required | Type |
---|---|---|---|
ID |
The unique identifier of the warehouse. |
Yes |
NUMBER (10, 0) |
NAME |
The name of the warehouse. |
Yes |
VARCHAR2 (150) |
ORGANIZATION_UNIT_ID |
The organization unit identifier of the warehouse. |
No |
VARCHAR2 (15) |
LOCALE_COUNTRY |
The ISO 3166 2- (or 3-) letter country code. |
No |
VARCHAR2 (3) |
CURRENCY_CODE |
The ISO 4217 currency code of the warehouse. |
No |
VARCHAR2 (40) |
PHYSICAL_WH |
The identifier of the physical warehouse corresponding to the warehouse. |
Yes |
NUMBER (10, 0) |
PRIMARY_VWH |
The identifier of the primary virtual warehouse corresponding to the warehouse. |
No |
NUMBER (10, 0) |
NAME_SECONDARY |
The secondary name of the warehouse. |
No |
VARCHAR2 (150) |
STOCKHOLDING_IND |
Flag indicating if the warehouse is a stock holding location. |
No |
VARCHAR2 (1) |
DUNS_NUMBER |
The Dun and Bradstreet number to identify the location. |
No |
VARCHAR2 (4) |
TSF_ENTITY_ID |
The transfer entity identifier of the warehouse. |
No |
NUMBER (10, 0) |
INBOUND_HANDLING_DAYS |
The number of days that the warehouse requires to receive any item and get it to the shelf so that it is ready to pick. |
No |
NUMBER (2, 0) |
CHANNEL_ID |
The channel identifier of the warehouse. |
No |
NUMBER (4, 0) |
CHANNEL_NAME |
The name of the channel. |
No |
VARCHAR2 (120) |
FINISHER_IND |
Flag indicating if the warehouse is a finisher - Y or N. |
No |
VARCHAR2 (1) |
|
The email address of the warehouse. |
No |
VARCHAR2 (100) |
All records in this file will be used to populate the WAREHOUSE_VIRTUAL (Virtual Warehouse) table. Records where the ID and PHYSICAL_WH match will be used to populate the WAREHOUSE (Physical Warehouse) table with a subset of the fields: ID, NAME, ORGANIZATION_UNIT_ID, LOCALE_COUNTRY and CURRENCY_CODE.
Example CSV File
IDL-WAREHOUSE-*.csv
1,Virtual Warehouse 1,Org Unit ID 1,GB,GBP,1,11,Secondary Name 1,Y,D&B NUM 1,LOC1,1234567890,96,1234,CHANNEL 1234,N,warehouse1@abc.com
Table 2-14 Differentiator File Layout
Field Name | Description | Required | Type |
---|---|---|---|
ID |
The unique identifier of the differentiator. |
Yes |
VARCHAR2 (10) |
DESCRIPTION |
The description of the differentiator. |
Yes |
VARCHAR2 (255) |
DIFF_TYPE_ID |
The unique identifier of the differentiator type - this references the ID column in the DIFFERENTIATOR_TYPE table. |
No |
VARCHAR2 (10) |
Example CSV File
IDL-DIFFERENTIATOR-*.csv
1,DESCRIPTION FOR DIFFERENTIATOR 1,1
Table 2-15 Item File Layout
Field Name | Description | Required | Type |
---|---|---|---|
ITEM_ID |
The unique identifier of the item |
Yes |
VARCHAR2 (25) |
ITEM_TYPE |
The type of item - 0 (Item), 15 (Simple Pack), 20 (Complex Pack), 25 (Simple Breakable Pack) or 30 (Complex Breakable Pack). |
Yes |
NUMBER (2, 0) |
DEPARTMENT_ID |
The department identifier - references the DEPARTMENT_ID column in the ITEM_HIERARCHY table. |
No |
NUMBER (12, 0) |
CLASS_ID |
The class identifier - references the CLASS_ID column in the ITEM_HIERARCHY table. |
No |
NUMBER (12, 0) |
SUBCLASS_ID |
The subclass identifier - references the SUBCLASS_ID column in the ITEM_HIERARCHY table. |
No |
NUMBER (12, 0) |
SHORT_DESCRIPTION |
The short description of the item. |
No |
VARCHAR2 (255) |
LONG_DESCRIPTION |
The long description of the item. |
No |
VARCHAR2 (400) |
DIFFERENTIATOR_1 |
The identifier of the first differentiator of the item. |
No |
VARCHAR2 (10) |
DIFFERENTIATOR_2 |
The identifier of the second differentiator of the item. |
No |
VARCHAR2 (10) |
DIFFERENTIATOR_3 |
The identifier of the third differentiator of the item. |
No |
VARCHAR2 (10) |
DIFFERENTIATOR_4 |
The identifier of the fourth differentiator of the item. |
No |
VARCHAR2 (10) |
STATUS |
The status of the item - ' ' (None), A (Active), C (Discontinued), I (Inactive), D (Deleted), Q (Auto-stocked) or N (Non-ranged). |
No |
VARCHAR2 (1) |
ORDER_AS_TYPE |
Indicates if a pack item is receivable at the component level or at the pack level (for a buyer pack only). |
No |
VARCHAR2 (1) |
PARENT_ITEM_ID |
The unique identifier of the parent item. |
No |
VARCHAR2 (25) |
TRANSACTION_LEVEL |
Number indicating which of the three levels transactions occur for the item's group. |
No |
NUMBER |
ITEM_LEVEL |
Number indicating which of the three levels the item resides. |
No |
NUMBER |
SELLABLE |
Flag indicating if the item may be sold as a unit - Y or N. |
Yes |
VARCHAR2 (1) |
ORDERABLE |
Flag indicating if the item may be ordered from a supplier - Y or N. |
Yes |
VARCHAR2 (1) |
PACKAGE_UNIT_OF_MEASURE |
The unit of measure associated with the package size. |
No |
VARCHAR2 (4) |
PACKAGE_SIZE |
The size of the product printed on any packaging. |
No |
NUMBER (12, 4) |
UNIT_OF_MEASURE |
The unit of measure. |
Yes |
VARCHAR2 (4) |
CASE_SIZE |
The default number of items that are contained in a case. |
No |
NUMBER (12, 4) |
BARCODE_FORMAT |
The barcode format for the item. |
No |
VARCHAR2 (4) |
BARCODE_PREFIX |
The barcode prefix for the item. |
No |
NUMBER (9, 0) |
TICKET_TYPE_CODE |
The ticket type code for the item. |
No |
VARCHAR2 (6) |
EACH_TO_UOM_FACTOR |
The conversion factor between an "Each" and the standard unit of measure. |
No |
NUMBER (20, 10) |
WASTE_TYPE |
Identifies the wastage type as either sales or spoilage wastage - SL (sales) or SP (spoilage). |
No |
VARCHAR2 (6) |
WASTE_PERCENT |
Average percent of wastage for the item over its shelf life. |
No |
NUMBER (12, 4) |
WASTE_PERCENT_DEFAULT |
Default daily wastage percent for spoilage type wastage items. |
No |
NUMBER (12, 4) |
ESTIMATE_SOH_FOR_PACK |
Indicates if a notional simple pack item's inventory should be displayed in packs - Y or N. |
Yes |
VARCHAR2 (1) |
RETAIL_ZONE_ID |
The unique identifier of the retail pricing strategy associated with the item. |
No |
VARCHAR2 (128) |
IS_PRIMARY |
Flag indicating if the sub-transaction level item is designated as the primary sub-transaction level item - Y or N. |
No |
VARCHAR2 (1) |
BRAND |
The brand associated with the item. |
No |
VARCHAR2 (30) |
MANU_SUGGESTED_RETAIL_PRICE |
The manufacturer's recommended retail price for the item. |
No |
NUMBER (12, 4) |
MANU_SUGGESTED_RETAIL_CURRENCY |
The ISO 4217 currency code of the manufacturer's retail price. |
No |
VARCHAR2 (3) |
INVENTORIABLE |
Flag indicating if the item is inventoriable - Y or N. |
Yes |
VARCHAR2 (1) |
SHIP_ALONE |
Flag indicating if the item should be shipped to the customer as a separate package - Y or N. |
No |
VARCHAR2 (1) |
BRAND_DESCRIPTION |
The description of the brand associated with the item. |
No |
VARCHAR2 (120) |
Example CSV File
IDL-ITEM-*.csv
1,0,1,1,1,SHORT_DESC,LONG_DESC,1,2,3,4,A,N,4,1,3,Y,N,kg,12345678.1234,kg,1,UPCA,22,TT,1,SL,33.33,16.66,Y,RETAIL_ZONE_ID,N,BRAND,4.99,GBP,Y,N,BRAND_DESC
Table 2-16 Partner Address File Layout
Field Name | Description | Required | Type |
---|---|---|---|
EXTERNAL_ID |
The external identifier of the address. |
Yes |
VARCHAR2 (25) |
PARTNER_ID |
The unique identifier of the partner - forms a unique key together with the EXTERNAL_ID field. |
Yes |
NUMBER (10, 0) |
ADDRESS_TYPE |
The type of address - 01 (Business), 02 (Postal), 03 (Returns), 04 (Order), 05 (Invoice), 06 (Remittance), 07 (Billing), 08 (Delivery) or 09 (External). |
Yes |
VARCHAR2 (2) |
IS_PRIMARY |
Flag indicating if this is the primary address - Y or N. |
Yes |
VARCHAR2 (1) |
ADDRESS_LINE_1 |
The first line of the address. |
No |
VARCHAR2 (240) |
ADDRESS_LINE_2 |
The second line of the address. |
No |
VARCHAR2 (240) |
ADDRESS_LINE_3 |
The third line of the address. |
No |
VARCHAR2 (240) |
CITY |
The city. |
No |
VARCHAR2 (120) |
STATE |
The state. |
No |
VARCHAR2 (3) |
COUNTRY_ID |
The ISO 3166 2- (or 3-) letter country code. |
No |
VARCHAR2 (3) |
POSTAL_CODE |
The postal code. |
No |
VARCHAR2 (30) |
CONTACT_NAME |
The contact name. |
No |
VARCHAR2 (120) |
CONTACT_PHONE |
The contact phone number. |
No |
VARCHAR2 (20) |
CONTACT_FAX |
The contact fax number. |
No |
VARCHAR2 (20) |
CONTACT_EMAIL |
The contact email address. |
No |
VARCHAR2 (100) |
COUNTY |
The county. |
No |
VARCHAR2 (250) |
Example CSV File
IDL-PARTNERADDR-*.csv
1,1,01,Y,Line 1,Line 2,Line 3,City,MN,USA,Postcode,Contact Name,Contact_Phone,Contact_Fax,Contact_Email,County
Table 2-17 Supplier Address File Layout
Field Name | Description | Required | Type |
---|---|---|---|
EXTERNAL_ID |
The external identifier of the address. |
Yes |
VARCHAR2 (25) |
SUPPLIER_ID |
The unique identifier of the supplier - forms a unique key together with the EXTERNAL_ID field. |
Yes |
NUMBER (10, 0) |
ADDRESS_TYPE |
The type of address - 01 (Business), 02 (Postal), 03 (Returns), 04 (Order), 05 (Invoice), 06 (Remittance), 07 (Billing), 08 (Delivery) or 09 (External). |
Yes |
VARCHAR2 (2) |
IS_PRIMARY |
Flag indicating if this is the primary address - Y or N. |
Yes |
VARCHAR2 (1) |
ADDRESS_LINE_1 |
The first line of the address. |
No |
VARCHAR2 (240) |
ADDRESS_LINE_2 |
The second line of the address. |
No |
VARCHAR2 (240) |
ADDRESS_LINE_3 |
The third line of the address. |
No |
VARCHAR2 (240) |
CITY |
The city. |
No |
VARCHAR2 (120) |
STATE |
The state. |
No |
VARCHAR2 (3) |
COUNTRY_ID |
The ISO 3166 2- (or 3-) letter country code. |
No |
VARCHAR2 (3) |
POSTAL_CODE |
The postal code. |
No |
VARCHAR2 (30) |
CONTACT_NAME |
The contact name. |
No |
VARCHAR2 (120) |
CONTACT_PHONE |
The contact phone number. |
No |
VARCHAR2 (20) |
CONTACT_FAX |
The contact fax number. |
No |
VARCHAR2 (20) |
CONTACT_EMAIL |
The contact email address. |
No |
VARCHAR2 (100) |
COUNTY |
The county. |
No |
VARCHAR2 (250) |
Example CSV File
IDL-SUPPLIERADDR-*.csv
1,1,01,Y,Line 1,Line 2,Line 3,City,MN,USA,Postcode,Contact Name,Contact_Phone,Contact_Fax,Contact_Email,County
Table 2-18 Supplier CFA File Layout
Field Name | Description | Required | Type |
---|---|---|---|
SUPPLIER_ID |
The unique identifier of the supplier - this references the ID column in the SUPPLIER table. |
Yes |
NUMBER (10, 0) |
NAME |
The name of the custom flex attribute - forms the primary key together with the SUPPLIER_ID field. |
Yes |
VARCHAR2 (30) |
VALUE |
The value of the custom flex attribute. |
No |
VARCHAR2 (250) |
VALUE_DATE |
The date value of the custom flex attribute in "yyyy-MM-dd" format. |
No |
DATE |
Example CSV File
IDL-SUPPLIERCFA-*.csv
2,Name 2,Value 2,
3,Name 3,,2021-10-06
Table 2-19 Supplier Organization File Layout
Field Name | Description | Required | Type |
---|---|---|---|
SUPPLIER_ID |
The unique identifier of the supplier - this references the ID column in the SUPPLIER table. |
Yes |
NUMBER (10, 0) |
ORGANIZATION_UNIT_ID |
The organization unit identifier - forms a unique key together with the SUPPLIER_ID field. |
Yes |
VARCHAR2 (15) |
Example CSV File
IDL-SUPPLIERORGANIZATION-*.csv
1,Org 1
Table 2-20 UDA LOV File Layout
Field Name | Description | Required | Type |
---|---|---|---|
UDA_ID |
The unique identifier of the user defined attribute - this references the ID column in the UDA table. |
Yes |
NUMBER (5, 0) |
LOV_ID |
The identifier for the LV (List of Values) user defined attribute value - forms the primary key together with the UDA_ID field. |
Yes |
VARCHAR2 (25) |
DESCRIPTION |
The description of the user defined attribute value. |
Yes |
VARCHAR2 (250) |
Example CSV File
IDL-UDALOV-*.csv
3,LOV_1,DESCRIPTION FOR LOV_1
Table 2-21 UOM Conversion File Layout
Field Name | Description | Required | Type |
---|---|---|---|
FROM_UOM |
The unit of measure to convert from - this references the UOM column in the UOM_CLASS table. |
Yes |
VARCHAR2 (4) |
TO_UOM |
The unit of measure to convert to - this references the UOM column in the UOM_CLASS table, and forms the primary key together with the FROM_UOM field. |
Yes |
VARCHAR2 (4) |
FACTOR |
The factor to apply when converting the unit of measure. |
Yes |
NUMBER (20, 10) |
Example CSV File
IDL-UOMCONVERSION-*.csv
g,lb,453.592
Table 2-22 Warehouse Address File Layout
Field Name | Description | Required | Type |
---|---|---|---|
EXTERNAL_ID |
The external identifier of the address. |
Yes |
VARCHAR2 (25) |
SUPPLIER_ID |
The unique identifier of the warehouse - forms a unique key together with the EXTERNAL_ID field. |
Yes |
NUMBER (10, 0) |
ADDRESS_TYPE |
The type of address - 01 (Business), 02 (Postal), 03 (Returns), 04 (Order), 05 (Invoice), 06 (Remittance), 07 (Billing), 08 (Delivery) or 09 (External). |
Yes |
VARCHAR2 (2) |
IS_PRIMARY |
Flag indicating if this is the primary address - Y or N. |
Yes |
VARCHAR2 (1) |
ADDRESS_LINE_1 |
The first line of the address. |
No |
VARCHAR2 (240) |
ADDRESS_LINE_2 |
The second line of the address. |
No |
VARCHAR2 (240) |
ADDRESS_LINE_3 |
The third line of the address. |
No |
VARCHAR2 (240) |
CITY |
The city. |
No |
VARCHAR2 (120) |
STATE |
The state. |
No |
VARCHAR2 (3) |
COUNTRY_ID |
The ISO 3166 2- (or 3-) letter country code. |
No |
VARCHAR2 (3) |
POSTAL_CODE |
The postal code. |
No |
VARCHAR2 (30) |
CONTACT_NAME |
The contact name. |
No |
VARCHAR2 (120) |
CONTACT_PHONE |
The contact phone number. |
No |
VARCHAR2 (20) |
CONTACT_FAX |
The contact fax number. |
No |
VARCHAR2 (20) |
CONTACT_EMAIL |
The contact email address. |
No |
VARCHAR2 (100) |
COUNTY |
The county. |
No |
VARCHAR2 (250) |
Example CSV File
IDL-WAREHOUSEADDR-*.csv
1,1,01,Y,Line 1,Line 2,Line 3,City,MN,USA,Postcode,Contact Name,Contact_Phone,Contact_Fax,Contact_Email,County
Table 2-23 Item CFA File Layout
Field Name | Description | Required | Type |
---|---|---|---|
ITEM_ID |
The unique identifier of the item - this references the ITEM_ID column in the ITEM table. |
Yes |
VARCHAR2 (25) |
NAME |
The name of the custom flex attribute - forms the primary key together with the ITEM_ID field. |
Yes |
VARCHAR2 (30) |
VALUE |
The value of the custom flex attribute. |
No |
VARCHAR2 (250) |
VALUE_DATE |
The date value of the custom flex attribute in "yyyy-MM-dd" format. |
No |
DATE |
Example CSV File
IDL-ITEMCFA-*.csv
2,Name 2,Value 2,
3,Name 3,,2021-10-06
Table 2-24 Item Component File Layout
Field Name | Description | Required | Type |
---|---|---|---|
ITEM_ID |
The unique identifier of the pack item - references the ITEM_ID column in the ITEM table. |
Yes |
VARCHAR2 (25) |
COMPONENT_ITEM_ID |
The unique identifier of the component item - references the ITEM_ID column in the ITEM table and forms the primary key together with the ITEM_ID field. |
Yes |
VARCHAR2 (25) |
QUANTITY |
The quantity of the component item in the pack item. |
Yes |
NUMBER (12, 4) |
Example CSV File
IDL-ITEMCOMPONENT-*.csv
1,11,1.11
Table 2-25 Item Description File Layout
Field Name | Description | Required | Type |
---|---|---|---|
ITEM_ID |
The unique identifier of the pack item - references the ITEM_ID column in the ITEM table. |
Yes |
VARCHAR2 (25) |
LOCALE_ID |
The unique identifier of the locale - references the ID column in the TRANSLATION_LOCALE table and forms the primary key together with the ITEM_ID field - see Supported Locales. |
Yes |
NUMBER (12, 0) |
DESCRIPTION |
The description of the item. |
Yes |
VARCHAR2 (255) |
SHORT_DESCRIPTION |
The short description of the item. |
Yes |
VARCHAR2 (250) |
SECONDARY_DESCRIPTION |
The secondary description of the item. |
No |
VARCHAR2 (250) |
LOCALE lANGUAGE |
The ISO 3166 language code - references the LANUGAGE column in the TRANSLATION_LOCALE table - see Supported Locales. |
Yes |
VARCHAR2 (6) |
LOCALE_DESCRIPTION |
The description of the locale. |
No |
VARCHAR2 (120) |
Example CSV File
IDL-ITEMDESCRIPTION-*.csv
1,1,Description 1,Short Description 1,Secondary Description 1,en,English
Table 2-26 Item Image File Layout
Field Name | Description | Required | Type |
---|---|---|---|
ITEM_ID |
The unique identifier of the pack item - references the ITEM_ID column in the ITEM table. |
Yes |
VARCHAR2 (25) |
DISPLAY_SEQUENCE |
The display sequence order of images associated to the item. |
Yes |
NUMBER (2, 0) |
IMAGE_URL |
The URL of the item image. |
Yes |
VARCHAR2 (1000) |
IMAGE_NAME |
The name of the item image - forms a unique key together with the ITEM_ID field. |
Yes |
VARCHAR2 (120) |
IMAGE_SIZE_CODE |
The type of item image. Valid values are defined as members of IITD code type - T (Thumbnail), H (High), M (Medium) or L (Low). |
Yes |
VARCHAR2 (6) |
Example CSV File
IDL-ITEMIMAGE-*.csv
1,99,http://somewhere.com/someimage1.gif,Image1.gif,T
Table 2-27 Item UDA File Layout
Field Name | Description | Required | Type |
---|---|---|---|
ITEM_ID |
The unique identifier of the item - references the ITEM_ID column in the ITEM table. |
Yes |
VARCHAR2 (25) |
UDA_ID |
The unique identifier of the user defined attribute - references the ID column in the UDA table and forms a unique key along with the ITEM_ID field. |
Yes |
NUMBER (5, 0) |
UDA_DATE |
The value, in 'yyyy-MM-dd HH:mm:ss' format, for DT (Date) user defined attributes. |
No |
DATE |
UDA_TEXT |
The value for FF (Text) user defined attributes. |
No |
VARCHAR2 (250) |
UDA_VALUE |
The value for LOV (List of Values) user defined attributes. |
No |
VARCHAR2 (25) |
Example CSV File
IDL-ITEMUDA-*.csv
1,1,2021-10-01 12:34:56,FF1,LOV1
Table 2-28 Partner Item File Layout
Field Name | Description | Required | Type |
---|---|---|---|
ITEM_ID |
The unique identifier of the item - references the ITEM_ID column in the ITEM table. |
Yes |
VARCHAR2 (25) |
PARTNER_ID |
The unique identifier of the partner - this references the ID column in the PARTNER table and forms the primary key together with the ITEM_ID field. |
Yes |
NUMBER (10, 0) |
STATUS |
The status of the item - ' ' (None), A (Active), C (Discontinued), I (Inactive), D (Deleted), Q (Auto-stocked) or N (Non-ranged). |
No |
VARCHAR2 (2) |
Example CSV File
IDL-PARTNERITEM-*.csv
1,1,A
Table 2-29 Related Item Type File Layout
Field Name | Description | Required | Type |
---|---|---|---|
ITEM_ID |
The unique identifier of the item - references the ITEM_ID column in the ITEM table. |
Yes |
VARCHAR2 (25) |
RELATIONSHIP_ID_EXTERNAL |
The external identifier of the relationship type - forms the primary key together with the ITEM_ID field. |
Yes |
NUMBER (20, 0) |
RELATIONSHIP_NAME |
The name of the relationship type. |
No |
VARCHAR2 (120) |
RELATIONSHIP_TYPE |
The relationship type - RLTD (Related), SUBS (Substitute), UPSL (Upsell) or CSSL (Crosssell). |
Yes |
VARCHAR2 (6) |
MANDATORY_IND |
Flag indicating if the relationship is mandatory - Y or N. |
Yes |
VARCHAR2 (1) |
Example CSV File
IDL-RELATEDITEMTYPE-*.csv
1,1,Related,RLTD,N
Table 2-30 Supplier Item File Layout
Field Name | Description | Required | Type |
---|---|---|---|
ITEM_ID |
The unique identifier of the item - references the ITEM_ID column in the ITEM table. |
Yes |
VARCHAR2 (25) |
SUPPLIER_ID |
The unique identifier of the supplier - this references the ID column in the SUPPLIER table and forms the primary key together with the ITEM_ID field. |
Yes |
NUMBER (10, 0) |
VENDOR_PRODUCT_NUMBER |
The vendor product number. |
No |
VARCHAR2 (256) |
IS_PRIMARY |
Flag indicating if the supplier is the primary supplier for this item - Y or N. |
No |
VARCHAR2 (3) |
Example CSV File
IDL-SUPPLIERITEM-*.csv
1,1,1,Y
Table 2-31 Warehouse Item File Layout
Field Name | Description | Required | Type |
---|---|---|---|
ITEM_ID |
The unique identifier of the item - references the ITEM_ID column in the ITEM table. |
Yes |
VARCHAR2 (25) |
WAREHOUSE_ID |
The unique identifier of the warehouse - this references the ID column in the WAREHOUSE table and forms the primary key together with the ITEM_ID field. |
Yes |
NUMBER (10, 0) |
STATUS |
The status of the warehouse item - ' ' (None), A (Active), C (Discontinued), I (Inactive), D (Deleted), Q (Auto-stocked) or N (Non-ranged). |
Yes |
VARCHAR2 (2) |
QUANTITY_TOTAL |
The total quantity of the warehouse item. |
Yes |
NUMBER (12, 4) |
QUANTITY_RESERVED |
The reserved quantity of the warehouse item. |
Yes |
NUMBER (12, 4) |
QUANTITY_UNAVAILABLE |
The unavailable quantity of the warehouse item. |
Yes |
NUMBER (12, 4) |
QUANTITY_IN_TRANSIT |
The in transit quantity of the warehouse item. |
Yes |
NUMBER (12, 4) |
STANDARD_UOM |
The standard unit of measure of the warehouse item. |
No |
VARCHAR2 (4) |
Example CSV File
IDL-WAREHOUSEITEM-*.csv
1,1,A,12345678.9012,34567890.1234,56789012.3456,78901234.5678,kg
Table 2-32 Related Item File Layout
Field Name | Description | Required | Type |
---|---|---|---|
ITEM_ID |
The unique identifier of the item - references the ITEM_ID column in the ITEM table. |
Yes |
VARCHAR(25) |
RELATIONSHIP_ID_EXTERNAL |
The external identifier of the relationship type. |
Yes |
NUMBER (20, 0) |
RELATIONSHIP_NAME |
The name of the relationship type. |
No |
VARCHAR2 (120) |
RELATIONSHIP_TYPE |
The relationship type - RLTD (Related), SUBS (Substitute), UPSL (Upsell) or CSSL (Crosssell). |
Yes |
VARCHAR2 (6) |
MANDATORY_IND |
Flag indicating if the relationship is mandatory - Y or N. |
Yes |
VARCHAR2 (1) |
RELATED_ITEM_ID |
The unique identifier of the related item - references the ITEM_ID column in the ITEM table. |
Yes |
VARCHAR2 (25) |
PRIORITY_NUMBER |
The priority when there are multiple relationships. |
No |
NUMBER (4, 0) |
EFFECTIVE_DATE |
The effective date of the relationship in "yyyy-MM-dd HH:mm:ss" format. |
No |
DATE |
END_DATE |
The end date of the relationship in "yyyy-MM-dd HH:mm:ss" format. |
No |
DATE |
The primary key comprises the ITEM_ID, RELATIONSHIP_ID_EXTERNAL and RELATED_ITEM_ID fields.
Example CSV File
IDL-RELATEDITEM-*.csv
1,1,Related,RLTD,N,11,9999,2021-10-01 12:34:56,2021-11-01 12:34:56
Table 2-33 Supplier Item Country File Layout
Field Name | Description | Required | Type |
---|---|---|---|
ITEM_ID |
The unique identifier of the item. |
Yes |
VARCHAR2 (25) |
SUPPLIER_ID |
The unique identifier of the supplier. |
Yes |
NUMBER (10, 0) |
COUNTRY_ID |
The ISO 3166 2- (or 3-) letter country code. |
Yes |
VARCHAR2 (3) |
CASE_SIZE |
The default number of items within a case from the supplier. |
No |
NUMBER (12, 4) |
UNIT_COST_CURRENCY |
The unit cost currency of the item for that supplier in that country. |
No |
VARCHAR2 (3) |
UNIT_COST_VALUE |
The unit cost of the item for that supplier in that country. |
No |
NUMBER (12, 4) |
The primary key comprises the ITEM_ID, SUPPLIER_ID and COUNTRY_ID fields.
Example CSV File
IDL-SUPPLIERITEMCOUNTRY-*.csv
1,1,GB,12345678.9012,GBP,11111111.1111
Table 2-34 Supplier Item Manufacture File Layout
Field Name | Description | Required | Type |
---|---|---|---|
ITEM_ID |
The unique identifier of the item - references the ITEM_ID column in the ITEM table. |
Yes |
VARCHAR2 (25) |
SUPPLIER_ID |
The unique identifier of the supplier - references the ID column in the SUPPLIER table. |
Yes |
NUMBER (10, 0) |
COUNTRY_ID |
The ISO 3166 2- (or 3-) letter country code. |
Yes |
VARCHAR2 (3) |
IS_PRIMARY |
Flag indicating if this is the primary country of manufacture - Y or N. |
No |
VARCHAR2 (1) |
The primary key comprises the ITEM_ID, SUPPLIER_ID and COUNTRY_ID fields.
Example CSV File
IDL-SUPPLIERITEMMANUFACTURE-*.csv
1,1,GB,Y
Table 2-35 Supplier Item UOM File Layout
Field Name | Description | Required | Type |
---|---|---|---|
ITEM_ID |
The unique identifier of the item - this references the ITEM_ID column in the SUPPLIER_ITEM table. |
Yes |
VARCHAR2 (25) |
SUPPLIER_ID |
The unique identifier of the supplier - this references the SUPPLIER_ID column in the SUPPLIER_ITEM table. |
Yes |
NUMBER (10, 0) |
UNIT_OF_MEASURE |
The unit of measure - this references the UOM column in the UOM_CLASS table. |
Yes |
VARCHAR2 (4) |
VALUE |
The equivalent value of the item/suppliers shipping carton in the associated unit of measure. |
Yes |
NUMBER (20, 4) |
The primary key comprises the ITEM_ID, SUPPLIER_ID and UNIT_OF_MEASURE fields.
Example CSV File
IDL-SUPPLIERITEMUOM-*.csv
1,1,g,1234567890123456.7890
Table 2-36 Supplier Item Country Dimension File Layout
Field Name | Description | Required | Type |
---|---|---|---|
ITEM_ID |
The unique identifier of the item - references the ITEM_ID column in the SUPPLIER_ITEM_COUNTRY table. |
Yes |
VARCHAR2 (25) |
SUPPLIER_ID |
The unique identifier of the supplier - references the SUPPLIER_ID column in the SUPPLIER_ITEM_COUNTRY table. |
Yes |
NUMBER (10, 0) |
COUNTRY_ID |
The ISO 3166 2- (or 3-) letter country code - references the COUNTRY_ID column in the SUPPLIER_ITEM_COUNTRY table. |
Yes |
VARCHAR2 (3) |
DIMENSION_OBJECT |
The dimension object. |
Yes |
VARCHAR2 (6) |
PRESENTATION_METHOD |
The packaging (if any) being taken into consideration in the specified dimensions. |
No |
VARCHAR2 (6) |
LENGTH |
The length of the dimension object. |
No |
NUMBER (12, 4) |
WIDTH |
The width of the dimension object. |
No |
NUMBER (12, 4) |
HEIGHT |
The height of the dimension object. |
No |
NUMBER (12, 4) |
DIMENSION_UOM |
The unit of measurement for length, width and height. |
No |
VARCHAR2 (4) |
WEIGHT |
The weight of the dimension object. |
No |
NUMBER (12, 4) |
NET_WEIGHT |
The net weight of the dimension object. |
No |
NUMBER (12, 4) |
WEIGHT_UOM |
The unit of measurement for weight. |
No |
VARCHAR2 (4) |
LIQUID_VOLUME |
The liquid volume or capacity of the dimension object. |
No |
NUMBER (12, 4) |
LIQUID_VOLUME_UOM |
The unit of measurement for liquid volume. |
No |
VARCHAR2 (4) |
STATISTICAL_CUBE |
The statistical value of the dimension object's dimensions to be used for loading purposed. |
No |
NUMBER (12, 4) |
The primary key comprises the ITEM_ID, SUPPLIER_ID, COUNTRY_ID and DIMENSION_OBJECT fields.
Example CSV File
IDL-SUPPLIERITEMCOUNTRYDIM-*.csv
1,1,GB,CASE,BARE,1,1,1,M,1.1,1.01,KG,0.1,ML,1
Table 2-37 Store File Layout
Field Name | Description | Required | Type |
---|---|---|---|
ID |
The unique identifier of the store. |
Yes |
NUMBER (10,0) |
NAME |
The name of the store. |
Yes |
VARCHAR2 (150) |
ORGANIZATION_UNIT_ID |
The organization unit identifier of the store. |
No |
VARCHAR2 (15) |
LOCALE_LANGUAGE |
The ISO 3166 language to which the store is assigned - see Supported Locales. |
No |
VARCHAR2 (3) |
LOCALE_COUNTRY |
The ISO 3166 2- (or 3-) letter country code to which the store is assigned. |
No |
VARCHAR2 (3) |
OPEN_DATE |
The date on which the store opened in 'yyyy-MM-dd' format. |
No |
DATE |
CLOSE_DATE |
The date on which the store closed in 'yyyy-MM-dd' format. |
No |
DATE |
TOTAL_SQUARE_FEET |
The total square footage of the store. |
No |
NUMBER (9,2) |
SELLING_SQUARE_FEET |
The total square footage of the store's selling area. |
No |
NUMBER (9,2) |
CURRENCY_CODE |
The ISO 4217 currency code of the store. |
No |
VARCHAR2 (40) |
TRANSFER_ZONE_ID |
The transfer zone identifier. |
No |
VARCHAR2 (128) |
SIM_STORE |
Flag indicating if the store is using the SIM application - Y or N. |
No |
VARCHAR2 (1) |
TIMEZONE |
The time zone of the store. |
Yes |
VARCHAR2 (80) |
CUSTOMER_ORDER_LOC_IND |
Flag indicating if the store is a customer order location - Y or N. |
Yes |
VARCHAR2 (1) |
Example CSV File
IDL-STORE-*.csv
1,Store 1,Org Unit ID,en,GB,2001-01-01,2030-12-31,20,10,GBP,1,Y,GMT,Y
Table 2-38 Store Address File Layout
Field Name | Description | Required | Type |
---|---|---|---|
EXTERNAL_ID |
The external identifier of the address. |
Yes |
VARCHAR2 (25) |
STORE_ID |
The unique identifier of the store - forms a unique key together with the EXTERNAL_ID field. |
Yes |
NUMBER (10, 0) |
ADDRESS_TYPE |
The type of address - 01 (Business), 02 (Postal), 03 (Returns), 04 (Order), 05 (Invoice), 06 (Remittance), 07 (Billing), 08 (Delivery) or 09 (External). |
Yes |
VARCHAR2 (2) |
IS_PRIMARY |
Flag indicating if this is the primary address - Y or N. |
Yes |
VARCHAR2 (1) |
ADDRESS_LINE_1 |
The first line of the address. |
No |
VARCHAR2 (240) |
ADDRESS_LINE_2 |
The second line of the address. |
No |
VARCHAR2 (240) |
ADDRESS_LINE_3 |
The third line of the address. |
No |
VARCHAR2 (240) |
CITY |
The city. |
No |
VARCHAR2 (120) |
STATE |
The state. |
No |
VARCHAR2 (3) |
COUNTRY_ID |
The ISO 3166 2- (or 3-) letter country code. |
No |
VARCHAR2 (3) |
POSTAL_CODE |
The postal code. |
No |
VARCHAR2 (30) |
CONTACT_NAME |
The contact name. |
No |
VARCHAR2 (120) |
CONTACT_PHONE |
The contact phone number. |
No |
VARCHAR2 (20) |
CONTACT_FAX |
The contact fax number. |
No |
VARCHAR2 (20) |
CONTACT_EMAIL |
The contact email address. |
No |
VARCHAR2 (100) |
COUNTY |
The county. |
No |
VARCHAR2 (250) |
Example CSV File
IDL-STOREADDR-*.csv
1,1,01,Y,Line 1,Line 2,Line 3,City,MN,USA,Postcode,Contact Name,Contact_Phone,Contact_Fax,Contact_Email,County
Table 2-39 Store Item File Layout
Field Name | Description | Required | Type |
---|---|---|---|
ITEM_ID |
The unique identifier of the item - references the ITEM_ID column in the ITEM table. |
Yes |
VARCHAR2 (25) |
STORE_ID |
The unique identifier of the store - this references the ID column in the STORE table and forms the primary key together with the ITEM_ID field. |
Yes |
NUMBER (10, 0) |
ITEM_TYPE |
The type of store item - 0 (Item), 15 (Simple Pack), 20 (Complex Pack), 25 (Simple Breakable Pack) or 30 (Complex Breakable Pack). |
Yes |
VARCHAR2 (255) |
SHORT_DESCRIPTION |
The short description of the store item. |
No |
VARCHAR2 (255) |
LONG_DESCRIPTION |
The long description of the store item. |
No |
VARCHAR2 (400) |
STATUS |
The status of the store item - ' ' (None), A (Active), C (Discontinued), I (Inactive), D (Deleted), Q (Auto-stocked) or N (Non-ranged). |
No |
VARCHAR2 (20) |
STATUS_DATE |
The date that the status of the store item was updated in 'yyyy-MM-dd' format. |
No |
DATE |
DEFAULT_CURRENCY |
The default ISO 4217 currency code of the store item. |
Yes |
VARCHAR2 (3) |
PRIMARY_SUPPLIER_ID |
The identifier of the primary supplier of the store item - this references the ID column in the SUPPLIER table. |
No |
NUMBER (10, 0 |
NEXT_DELIVERY_DATE |
The next delivery date of the store item in 'yyyy-MM-dd' format. |
No |
DATE |
UIN_REQUIRED |
Flag to indicate if a UIN (unique identification number) is required for the store item - Y or N. |
No |
VARCHAR2 (1) |
REPLENISHMENT_TYPE |
The replenishment method for the store item - SO (Store Order). |
No |
VARCHAR2 (6) |
REJECT_STORE_ORDER |
Flag indicating if uploaded store orders should be rejected for the store item - Y or N. |
No |
VARCHAR2 (1) |
STORE_CONTROL_PRICING |
Flag indicating if the store can modify the item's price - Y or N. |
No |
VARCHAR2 (1) |
MULTIPLE_DELIVERY_PER_DAY |
Flag indicating if the store item is replenished multiple times per day - Y or N. |
No |
VARCHAR2 (1) |
RFID |
Flag indicating if the store item is RFID tagged - Y or N. |
Yes |
VARCHAR2 (1) |
CONSIGNMENT_TYPE |
The consignment type of the store item - 5 (Consignment) or 10 (Concession). |
No |
NUMBER (2, 0) |
Example CSV File
IDL-STOREITEM-*.csv
1,1,0,Short Desc 1,Long Desc 1,A,2022-01-14,GBP,1,2022-01-31,N,SO,N,Y,Y,N,10
Table 2-40 Store Item CFA File Layout
Field Name | Description | Required | Type |
---|---|---|---|
ITEM_ID |
The unique identifier of the item - this references the ITEM_ID column in the ITEM table. |
Yes |
VARCHAR2 (25) |
STORE_ID |
The unique identifier of the store - this references the ID column in the STORE table. |
Yes |
NUMBER (10, 0) |
NAME |
The name of the custom flex attribute. |
Yes |
VARCHAR2 (30) |
VALUE |
The value of the custom flex attribute. |
No |
VARCHAR2 (250) |
VALUE_DATE |
The date value of the custom flex attribute in "yyyy-MM-dd" format. |
No |
DATE |
The primary key comprises the ITEM_ID, STORE_ID and NAME fields.
Example CSV File
IDL-STOREITEMCFA-*.csv
2,1,Name 2,Value 2,
3,1,Name 3, ,2021-10-06
Table 2-41 Store Item Stock File Layout
Field Name | Description | Required | Type |
---|---|---|---|
ITEM_ID |
The unique identifier of the item - this references the ITEM_ID column in the STORE_ITEM table. |
Yes |
VARCHAR2 (25) |
STORE_ID |
The unique identifier of the store - this references the STORE_ID column in the STORE_ITEM table and forms the primary key together with the ITEM_ID field. |
Yes |
NUMBER (10, 0) |
QUANTITY_TOTAL |
The total quantity of the item that is sellable. |
Yes |
NUMBER (12, 4) |
QUANTITY_RESERVED |
The reserved quantity of the item. |
Yes |
NUMBER (12, 4) |
QUANTITY_CUSTOMER_RESERVE |
The quantity of the item reserved for customers. |
Yes |
NUMBER (12, 4) |
QUANTITY_IN_TRANSIT |
The in transit quantity of the item. |
Yes |
NUMBER (12, 4) |
QUANTITY_VENDOR_RETURN |
The vendor return quantity of the item. |
Yes |
NUMBER (12, 4) |
QUANTITY_NON_SELLABLE |
The non-sellable quantity of the item. |
Yes |
NUMBER (12, 4) |
All records in this file will be used to populate the STORE_ITEM_STOCK table. Records where the QUANTITY_NON_SELLABLE field is non-zero will be used to populate the STORE_ITEM_STOCK_NONSELL table.
Example CSV File
IDL-STOREITEMSTOCK-*.csv
1,1,1.1,1.2,1.3,1.4,1.5,1.6
Table 2-42 Store Item Price File Layout
Field Name | Description | Required | Type |
---|---|---|---|
ITEM_ID |
The unique identifier of the item - this references the ITEM_ID column in the STORE_ITEM table. |
Yes |
VARCHAR2 (25) |
STORE_ID |
The unique identifier of the store - this references the STORE_ID column in the STORE_ITEM table. |
Yes |
NUMBER (10, 0) |
EFFECTIVE_DATE |
The date that the item price becomes effective in 'yyyy-MM-dd HH:mm:ss' format. |
No |
DATE |
END_DATE |
The date that the item price is no longer valid in 'yyyy-MM-dd HH:mm:ss' format. |
No |
DATE |
PRICE_TYPE |
The item price type - 202 (Permanent/Regular), 201 (Promotional) or 200 (Clearance). |
Yes |
NUMBER (3, 0) |
STORE_REQUESTED |
Flag indicating if the item price was requested by the store - Y or N. |
Yes |
VARCHAR2 (1) |
STATUS |
The status of the item price - 0 (New), 1 (Pending), 2 (Approved), 3 (Completed), 4 (Rejected), 5 (Ticket List), 6 (Active), 7 (Extract Failed), 9 (Deleted) or 99 (Default). |
Yes |
NUMBER (2, 0) |
PROMOTION_ID |
The identifier of the promotion. |
No |
NUMBER (10, 0) |
PROMOTION_COMP_ID |
The identifier of the promotion component. |
No |
NUMBER (10, 0) |
MULTI_UNITS |
The number of units involved in the multi-unit pricing of the item price. |
No |
NUMBER (12, 4) |
MULTI_UNIT_RETAIL_CURRENCY |
The ISO 4217 currency code of the multi-unit price. |
No |
VARCHAR2 (3) |
MULTI_UNIT_RETAIL |
The value of the multi-unit price. |
No |
NUMBER (20, 4) |
MULTI_UNIT_UOM |
The unit of measure of the multi-unit price. |
No |
VARCHAR2 (4) |
MULTI_UNIT_CHANGE |
Flag indicating if the multi-unit price has changed - Y or N. |
Yes |
VARCHAR2 (1) |
SELLING_UNIT_CHANGE |
Flag indicating if the item price has changed - Y or N. |
Yes |
VARCHAR2 (1) |
PROMOTION_NAME |
The name of the promotion. |
No |
VARCHAR2 (160) |
PROMOTION_DESCRIPTION |
The description of the promotion. |
No |
VARCHAR2 (640) |
PROMOTION_COMP_NAME |
The name of the promotion component. |
No |
VARCHAR2 (160) |
RESET_CLEARANCE_ID |
The clearance reset identifier. |
No |
NUMBER (15, 0) |
PROMO_COMP_TYPE |
The promotion component type - 0 (Complex), 1 (Simple), 2 (Threshold), 3 (Credit) or 4 (Threshold). |
No |
NUMBER (2, 0) |
REGULAR_PRICE_CHANGE_ID |
The identifier of the regular price change. |
No |
NUMBER (15, 0) |
CLEARANCE_ID |
The identifier of the clearance price change. |
No |
NUMBER (15, 0) |
PROMO_COMP_DTL_ID |
The identifier of the promotion component detail. |
No |
NUMBER (15, 0) |
PROMO_DURATION_TYPE |
The promotion duration type - 1 (All Day), 2 (Partial Day) or 3 (Multiple Day). |
No |
NUMBER (2, 0) |
PRICE_VALUE |
The value of the item price. |
Yes |
NUMBER (20, 4) |
PRICE_CURRENCY |
The ISO 4217 currency code of the item price. |
No |
VARCHAR2 (3) |
PRICE_UNIT_OF_MEASURE |
The unit of measure of the item price. |
No |
VARCHAR2 (4) |
EXT_PRICE_EVENT_ID |
The external price event identifier. |
No |
NUMBER (12, 0) |
For Permanent/Regular (202) Item Prices the unique key comprises the ITEM_ID, STORE_ID, PRICE_TYPE and REGULAR_PRICE_CHANGE_ID fields. For Promotional (201) Item Prices the unique key comprises the ITEM_ID, STORE_ID, PRICE_TYPE, PROMOTION_ID, PROMOTION_COMP_ID and PROMO_COMP_DTL_ID fields. For Clearance (200) Item Prices the unique key comprises the ITEM_ID, STORE_ID, PRICE_TYPE and CLEARANCE_ID fields.
Example CSV File
IDL-STOREITEMPRICE-*.csv
1,1,2021-10-06 12:34:56,2021-10-06 12:34:56,202,N,6,,,1,GBP,2469,kg,Y,N,,,,,,1,,,,1234.5678,GBP,kg,1111
1,1,2021-10-07 12:34:56,2021-10-07 12:34:56,201,N,6,1,1,1,GBP,2469,g,Y,N,Promo Name,Promo Desc,Promo Comp Name,,1,,,1,3,1234.5678,GBP,g,3333
1,1,2021-10-08 12:34:56,2021-10-08 12:34:56,200,N,6,,,1,GBP,2469,lb,Y,N,,,,1,,,1,,,1234.5678,GBP,lb,5555
Table 2-43 Store Item Price History File Layout
Field Name | Description | Required | Type |
---|---|---|---|
ITEM_PRICE_ID |
The identifier of the item price. |
No |
NUMBER (12, 0) |
ITEM_ID |
The unique identifier of the item. |
Yes |
VARCHAR2 (25) |
STORE_ID |
The unique identifier of the store. |
Yes |
NUMBER (10, 0) |
EFFECTIVE_DATE |
The date that the item price becomes effective in 'yyyy-MM-dd HH:mm:ss' format. |
No |
DATE |
END_DATE |
The date that the item price is no longer valid in 'yyyy-MM-dd HH:mm:ss' format. |
No |
DATE |
PRICE_TYPE |
The item price type - 202 (Permanent/Regular), 201 (Promotional) or 200 (Clearance). |
Yes |
NUMBER (3, 0) |
STORE_REQUESTED |
Flag indicating if the item price was requested by the store - Y or N. |
Yes |
VARCHAR2 (1) |
PROMOTION_ID |
The identifier of the promotion. |
No |
NUMBER (10, 0) |
PROMOTION_COMP_ID |
The identifier of the promotion component. |
No |
NUMBER (10, 0) |
MULTI_UNITS |
The number of units involved in the multi-unit pricing of the item price. |
No |
NUMBER (12, 4) |
MULTI_UNIT_RETAIL_CURRENCY |
The ISO 4217 currency code of the multi-unit price. |
No |
VARCHAR2 (3) |
MULTI_UNIT_RETAIL |
The value of the multi-unit price. |
No |
NUMBER (20, 4) |
MULTI_UNIT_UOM |
The unit of measure of the multi-unit price. |
No |
VARCHAR2 (4) |
MULTI_UNIT_CHANGE |
Flag indicating if the multi-unit price has changed - Y or N. |
Yes |
VARCHAR2 (1) |
SELLING_UNIT_CHANGE |
Flag indicating if the item price has changed - Y or N. |
Yes |
VARCHAR2 (1) |
PROMOTION_NAME |
The name of the promotion. |
No |
VARCHAR2 (160) |
PROMOTION_DESCRIPTION |
The description of the promotion. |
No |
VARCHAR2 (640) |
PROMOTION_COMP_NAME |
The name of the promotion component. |
No |
VARCHAR2 (160) |
RESET_CLEARANCE_ID |
The clearance reset identifier. |
No |
NUMBER (15, 0) |
PROMO_COMP_TYPE |
The promotion component type - 0 (Complex), 1 (Simple), 2 (Threshold), 3 (Credit) or 4 (Threshold). |
No |
NUMBER (2, 0) |
REGULAR_PRICE_CHANGE_ID |
The identifier of the regular price change. |
No |
NUMBER (15, 0) |
CLEARANCE_ID |
The identifier of the clearance price change. |
No |
NUMBER (15, 0) |
PROMO_COMP_DTL_ID |
The identifier of the promotion component detail. |
No |
NUMBER (15, 0) |
PROMO_DURATION_TYPE |
The promotion duration type - 1 (All Day), 2 (Partial Day) or 3 (Multiple Day). |
No |
NUMBER (2, 0) |
PRICE_VALUE |
The value of the item price. |
Yes |
NUMBER (20, 4) |
PRICE_CURRENCY |
The ISO 4217 currency code of the item price. |
No |
VARCHAR2 (3) |
PRICE_UNIT_OF_MEASURE |
The unit of measure of the item price. |
No |
VARCHAR2 (4) |
For Permanent/Regular (202) Item Prices the unique key comprises the ITEM_ID, STORE_ID, PRICE_TYPE and REGULAR_PRICE_CHANGE_ID fields. For Promotional (201) Item Prices the unique key comprises the ITEM_ID, STORE_ID, PRICE_TYPE, PROMOTION_ID, PROMOTION_COMP_ID and PROMO_COMP_DTL_ID fields. For Clearance (200) Item Prices the unique key comprises the ITEM_ID, STORE_ID, PRICE_TYPE and CLEARANCE_ID fields.
Example CSV File
IDL-STOREITEMPRICEHIST-*.csv
1,1,1,2021-10-06 12:34:56,2021-10-06 12:34:56,202,N,,,1,GBP,2469,kg,Y,N,,,,,,1,,,,1234.5678,GBP,kg
3,1,1,2021-10-07 12:34:56,2021-10-07 12:34:56,201,N,1,1,1,GBP,2469,g,Y,N,Promo Name,Promo Desc,Promo Comp Name,,1,,,1,3,1234.5678,GBP,g
5,1,1,2021-10-08 12:34:56,2021-10-08 12:34:56,200,N,,,1,GBP,2469,lb,Y,N,,,,1,,,1,,,1234.5678,GBP,lb
Table 2-44 Store UIN Admin Item File Layout
Field Name | Description | Required | Type |
---|---|---|---|
ITEM_ID |
The unique identifier of the item - this references the ITEM_ID column in the ITEM table. |
Yes |
VARCHAR2 (25) |
STORE_ID |
The unique identifier of the store - this references the ID column in the STORE table and forms the primary key together with the ITEM_ID field. |
Yes |
NUMBER (10, 0) |
UIN_TYPE |
The UIN (Unique Identification Number) type - 1 (Serial Number) or 2 (Auto-generated Serial Number). |
Yes |
NUMBER (2, 0) |
UIN_LABEL_ID |
The UIN label identifier - SN (Serial Number), IM (IMEI), LN (License Number), PN (Plate Number) or SIN (SIN). |
Yes |
VARCHAR2 (3) |
CAPTURE_TIME_ID |
The time to capture the UIN - 1 (Sales) or 2 (Store Receiving). |
No |
NUMBER (2, 0) |
EXTERNAL_CREATE_ALLOWED |
Flag to indicate if the UIN can be created externally - Y or N. |
No |
VARCHAR2 (1) |
TICKET_FORMAT_ID |
The ticket format identifier. |
No |
NUMBER (10, 0) |
Example CSV File
IDL-STOREUINADMINITEM-*.csv
1,1,1,SN,1,N,1
Table 2-45 Locale ID Values
LOCALE_ID | LOCALE_LANGUAGE | LOCALE_DESCRIPTION |
---|---|---|
1 |
en |
English |
2 |
de |
German |
3 |
fr |
French |
4 |
es |
Spanish |
5 |
ja |
Japanese |
6 |
ko |
Korean |
7 |
ru |
Russian |
8 |
zh |
Chinese |
9 |
tr |
Turkish |
10 |
hu |
Hungarian |
11 |
zh |
Traditional Chinese |
12 |
pt |
Brazilian Portuguese |
13 |
ar |
Arabic |
15 |
hr |
Croatian |
18 |
nl |
Dutch |
20 |
el |
Greek |
22 |
it |
Italian |
26 |
pl |
Polish |
31 |
sv |
Swedish |
32 |
sq |
Albanian |
33 |
hy |
Armenian |
34 |
az |
Azerbaijani |
35 |
be |
Belarusian |
36 |
bn |
Bengali |
37 |
bs |
Bosnian |
38 |
bg |
Bulgarian |
39 |
my |
Burmese |
40 |
cs |
Czech |
41 |
da |
Danish |
42 |
et |
Estonian |
43 |
fil |
Filipino |
44 |
fi |
Finnish |
45 |
ka |
Georgian |
46 |
he |
Hebrew |
47 |
hi |
Hindi |
48 |
id |
Indonesian |
49 |
kk |
Indonesian |
50 |
km |
Khmer |
51 |
lo |
Lao |
52 |
lv |
Latvian |
53 |
lt |
Lithuanian |
54 |
ms |
Malay |
55 |
no |
Norwegian |
56 |
ro |
Romanian |
57 |
sr |
Serbian |
58 |
sk |
Slovak |
59 |
sl |
Slovene |
60 |
th |
Thai |
61 |
uk |
Ukrainian |
62 |
ur |
Urdu |
63 |
uz |
Uzbek |
64 |
vi |
Vietnamese |