While Product and Category records require a dynamic row format, which would allow flexible columns configuration, other information in catalog requires well defined and DB oriented format. We call it “fixed row format”.
Example of file with fixed format rows:
##CPCO,sku,default_title,type,is_require,option_sku,sort_order,max_characters,price,price_type,file_extension,image_size_x,image_size_y
CPCO,SKU1,"Custom Option 1",drop_down,0,OPTION_SKU,1
##CPCOL,sku,default_title,store,title,price,price_type
CPCOL,SKU1,"Custom Option 1",store1,"Store Specific Option Name"
##CPCOS,sku,default_title,selection_default_title,selection_sku,sort_order,price,price_type
CPCOS,SKU1,"Custom Option 1","Product Selection Name",SELSKU1,1
##CPCOSL,sku,default_title,selection_default_title,store,title,price,price_type
CPCOSL,SKU1,"Custom Option 1","Product Selection Name",store1,"Store Specific Selection Name"
##CPRI,sku,linked_sku,position,qty
CPRI,SKU1,RELATED_SKU
##CPGI,sku,linked_sku,position,qty
CPGI,SKU1,GROUPED_SKU,1,2
The file above will create a dropdown custom option named “Custom Option 1” for product SKU1. This custom option will have store view specific label “Store Specific Option Name”, and a selection of one product “Product Selection Name”, with store view specific label as well.
Also, it will add RELATED_SKU as related to SKU1 and GROUPED_SKU as a child grouped product with default quantity of 2.
Each row begins with action char and row type identifier. If action char is ommited, insert/update is implied.
Action Char | Meaning |
+ | Insert/Update (optional) |
- | Delete |
% | Rename (* see below for explanation) |
# | Comment line (## is used for row structure explanation) |
! | Define column order for row type within the file (ROADMAP) |
* For example, in CPCO, “default_title” is used as a key to update store view specific records. Use “[%] Rename” action to change this title.
First few fields are always required, others are optional, but the row structure should always remain the same.
This allows to combine different types of fixed format rows into the same file, as there's no need for header titles, which means each row's structure is well known and will be expected by the parser.
Eav Structure Row Types
Allowed actions
* Rename is in ROADMAP, currently only CP and CPBO are implemented.
EA: EAV Attribute
Create/Update Columns
# | Column | Key? | Required? | Comments |
1 | attribute_code | X | X | |
2 | backend_type | | X | |
3 | frontend_input | | X | |
4 | frontend_label | | X | |
5 | is_required | | X | |
6 | is_unique | | X | |
7 | entity_type | X | | If not specified, 'catalog_product' used by default |
Examples
Create attributes
##EA,attribute_code,backend_type,frontend_input,frontend_label,is_required,is_unique
EA,custom_field,varchar,select,Custom Dropdown Field,0,0
EAL: EAV Attribute Store Specific
Support only for Magento CE 1.4.0.0+ or EE 1.7.0.0+
Create/Update Columns
# | Column | Key? | Required? | Comments |
1 | attribute_code | X | X | |
2 | store | X | X | |
3 | label | | X | |
4 | entity_type | X | | If not specified, 'catalog_product' used by default |
EAX: EAV Attribute Extension
Create/Update Columns
# | Column | Key? | Required? | Comments |
1 | attribute_code | X | X | |
2 | attribute_model | | | |
3 | backend_model | | | |
4 | backend_table | | | |
5 | frontend_model | | | |
6 | frontend_class | | | |
7 | source_model | | | |
8 | default_value | | | |
9 | note | | | |
10 | entity_type | X | | If not specified, 'catalog_product' used by default |
EAXP: EAV Attribute Product Extension
Create/Update Columns
Magento 1
# | Column | Key? | Required? | Comments |
1 | attribute_code | X | X | |
2 | is_global | | | |
3 | is_visible | | | |
4 | is_searchable | | | |
5 | is_filterable | | | |
6 | is_comparable | | | |
7 | is_visible_on_front | | | |
8 | is_html_allowed_on_front | | | |
9 | is_used_for_price_rules | | | |
10 | is_filterable_in_search | | | |
11 | used_in_product_listing | | | |
12 | used_for_sort_by | | | |
13 | is_configurable | | | |
14 | apply_to | | | |
15 | is_visible_in_advanced_search | | | |
16 | position | | | |
17 | frontend_input_renderer | | | |
18 | is_wysiwyg_enabled | | | |
Magento 2
# | Column | Key? | Required? | Comments |
1 | attribute_code | X | X | string |
2 | is_global | | | int |
3 | is_visible | | | int |
4 | is_searchable | | | int |
5 | is_filterable | | | int |
6 | is_comparable | | | int |
7 | is_visible_on_front | | | int |
8 | is_html_allowed_on_front | | | int |
9 | is_used_for_price_rules | | | int |
10 | is_filterable_in_search | | | int |
11 | used_in_product_listing | | | int |
12 | used_for_sort_by | | | int |
13 | apply_to | | | string |
14 | is_visible_in_advanced_search | | | int |
15 | position | | | int |
16 | frontend_input_renderer | | | string |
17 | is_wysiwyg_enabled | | | int |
18 | is_used_for_promo_rules | | | int |
19 | is_required_in_admin_store | | | int |
20 | is_used_in_grid | | | int |
21 | is_visible_in_grid | | | int |
22 | is_filterable_in_grid | | | int |
23 | search_weight | | | float |
24 | additional_data | | | text |
EAS: EAV Attribute Set
Create/Update Columns
# | Column | Key? | Required? | Comments |
1 | set_name | X | X | |
2 | sort_order | | | |
3 | entity_type | X | | If not specified, 'catalog_product' used by default |
Examples
Create attribute set
##EAS,set_name,sort_order,entity_type
EAS,New Attribute Set
EAG: EAV Attribute Group
Create/Update Columns
Magento 1
# | Column | Key? | Required? | Comments |
1 | set_name | X | X | |
2 | group_name | X | X | |
3 | sort_order | | | |
4 | entity_type | X | | If not specified, 'catalog_product' used by default |
Magento 2
# | Column | Key? | Required? | Comments |
1 | set_name | X | X | string |
2 | group_name | X | X | string |
3 | sort_order | | | int |
4 | default_id | X | | int |
5 | attribute_group_code | X | | varchar |
6 | tab_group_code | X | | varchar |
7 | entity_type | X | | If not specified, 'catalog_product' used by default |
EASI: EAV Attribute Within Attribute Set
Create/Update Columns
# | Column | Key? | Required? | Comments |
1 | set_name | X | X | |
2 | group_name | X | X | |
3 | attribute_code | X | X | |
4 | sort_order | | | |
5 | entity_type | X | | If not specified, 'catalog_product' used by default |
Examples
Add attribute to attribute set
##EASI,set_name,group_name,attribute_code,sort_order,entity_type
EASI,New Attribute Set,General,your_attribute,10
Remove attribute from attribute set
##-EASI,set_name,attribute_code,entity_type
-EASI,New Attribute Set,your_attribute
EAO: EAV Attribute Option
Create/Update Columns
# | Column | Key? | Required? | Comments |
1 | attribute_code | X | X | |
2 | option_name | X | X | |
3 | sort_order | | | |
4 | entity_type | X | | If not specified, 'catalog_product' used by default |
Examples
Add attribute options
EAO,custom_field,Option 1,1
EAO,custom_field,Option 2,2
EAOL: EAV Attribute Option Store Specific
Create/Update Columns
# | Column | Key? | Required? | Comments |
1 | attribute_code | X | X | |
2 | option_name | X | X | |
3 | store | X | X | |
4 | option_label | | Х | |
5 | entity_type | X | | If not specified, 'catalog_product' used by default |
EAOS: EAV Attribute Option Swatch
Create/Update Columns
# | Column | Key? | Required? | Comments |
1 | attribute_code | X | X | varchar |
2 | swatch_name | X | X | varchar |
3 | option_name | X | X | varchar |
4 | sort_order | | | int |
5 | type | | | int - 0 - text, 1 - visual color, 2 - visual image |
6 | entity_type | X | | If not specified, 'catalog_product' used by default |
Examples
Add attribute swatches
#EAOS,attribute_code,swatch_name,option_name,sort_order,type,entity_type
EAOS,custom_field,#000000,Black,1,1
EAOS,custom_field,55 cm,55 cm,2,0
EAOSL: EAV Attribute Swatch Store Specific
Create/Update Columns
# | Column | Key? | Required? | Comments |
1 | attribute_code | X | X | varchar |
2 | default_swatch_name | X | X | varchar |
3 | store | X | X | varchar |
4 | locale_swatch_name | | Х | varchar |
5 | entity_type | X | | If not specified, 'catalog_product' used by default |
Examples
Add attribute swatch locale version
#EAOSL,attribute_code,default_swatch_name,store,locale_swatch_name,entity_type
EAOSL,custom_field,#000000,default,black
EAOSL,custom_field,55 cm,default,2"
Allowed actions
CC: Catalog Category
Examples
Delete categories
-CC,electronics/accessories
-CC,misc/accessories
CCP: Catalog Category-Product Association
Can be used to specify product position within category.
Alternatively, products can be associated in “Product” data type files.
Examples
Create category-product associations
CCP,electronics/accessories,SKU1,1
CCP,misc/accessories,SKU2,5
Delete category-product associations
-CCP,electronics/accessories,SKU1
-CCP,misc/accessories,SKU2
CP: Catalog Product
Examples
Delete products
Rename product SKU
CPI: Catalog Product Image
Create/Update Columns
# | Column | Key? | Required? | Comments |
1 | sku | X | X | |
2 | image_url | X | X | |
3 | label | | | |
4 | position | | | |
5 | disabled | | | |
Examples
Add Gallery Images
- CPI.csv
# CPI,sku,image name,image label,position,disabled
# to add images
CPI,SKU-1,/i/m/image1.jpg,"Image 1 label",1,0
CPI,SKU-1,/i/m/image2.jpg,"Image 2 label",2,0
# to add images but exclude them from gallery
CPI,SKU-1,/i/m/image3.jpg,"Image 3 label",3,1
CPI,SKU-1,/i/m/image4.jpg,"Image 4 label",4,1
# delete image
-CPI,SKU-1,/i/m/image5.jpg
CPIL: Catalog Product Image Store Specific
Create/Update Columns
# | Column | Key? | Required? | Comments |
1 | sku | X | X | |
2 | image_url | X | X | |
3 | store | X | X | Can't be “admin” |
4 | label | | | |
5 | position | | | |
6 | disabled | | | |
CPV: Catalog Product Video
Create/Update Columns
# | Column | Key? | Required? | Comments |
1 | sku | X | X | |
2 | url | X | X | |
3 | screenshot | X | X | |
4 | store | X | X | |
5 | title | | | |
6 | provider | | | |
7 | description | | | |
8 | metadata | | | |
9 | position | | | |
10 | disabled | | | |
CPVL: Catalog Product Video Store Specific
Create/Update Columns
# | Column | Key? | Required? | Comments |
1 | sku | X | X | |
2 | screenshot | X | X | |
3 | store | X | X | Can't be “admin” |
4 | label | | X | |
5 | position | | | |
6 | disabled | | | |
Examples
Add Gallery Videos
- CPI.csv
#CPV, sku ,url ,screenshot ,store ,title ,provider ,description ,metadata ,position ,disabled
# to add video
CPV, SKU-1, https://youtu.be/O8NYn-H03Lc, image1.jpg, default, "Video 1 title", youtube, "lorem ipsum dolor", "some meta data", 1, 0
# to add video but exclude it from gallery
CPV, SKU-1, https://youtu.be/O8NYn-H03Lc, image1.jpg, default, "Video 1 title", youtube, "lorem ipsum dolor", "some meta data", 1, 1
# -CPV, sku ,url ,screenshot ,store
# delete video
-CPV,SKU-1, https://youtu.be/O8NYn-H03Lc, /i/m/image5.jpg, default
# -CPVL, sku ,url ,screenshot ,store
# delete video store specific
-CPVL,SKU-1, https://youtu.be/O8NYn-H03Lc, /i/m/image5.jpg, default
CPCO: Catalog Product Custom Option
Create/Update Columns
# | Column | Key? | Required? | Comments |
1 | sku | X | X | |
2 | default_title | X | X | |
3 | type | | X | |
4 | is_require | | | |
5 | option_sku | | | |
6 | sort_order | | | |
7 | max_characters | | | |
8 | price | | | |
9 | price_type | | | |
10 | file_extension | | | |
11 | image_size_x | | | |
12 | image_size_y | | | |
Examples
Add custom options to a product
- custom_options.csv
# // Add a non-required text custom option
##CPCO,sku,default_title,type,is_require,option_sku,sort_order,max_characters,price,price_type,file_extension,image_size_x,image_size_y
CPCO,PRODUCT_SKU,Text option,field,0,,1
# // Add a required dropdown custom option
##CPCO,sku,default_title,type,is_require,option_sku,sort_order,max_characters,price,price_type,file_extension,image_size_x,image_size_y
CPCO,PRODUCT_SKU,Color,drop_down,1,,2
##CPCOS,sku,default_title,selection_default_title,selection_sku,sort_order,price_price_type
CPCOS,PRODUCT_SKU,Color,Blue,BLUE,1
CPCOS,PRODUCT_SKU,Color,Red,RED,2
CPCOL: Catalog Product Custom Option Store Specific
Create/Update Columns
# | Column | Key? | Required? | Comments |
1 | sku | X | X | |
2 | default_title | X | X | |
3 | store | X | X | |
4 | title | | X | |
5 | price | | | |
6 | price_type | | | |
CPCOS: Catalog Product Custom Option Selection
Create/Update Columns
# | Column | Key? | Required? | Comments |
1 | sku | X | X | |
2 | default_title | X | X | |
3 | selection_default_title | X | X | |
4 | selection_sku | | | |
5 | sort_order | | | |
6 | price | | | |
7 | price_type | | | |
CPCOSL: Catalog Product Custom Option Selection Store Specific
Create/Update Columns
# | Column | Key? | Required? | Comments |
1 | sku | X | X | |
2 | default_title | X | X | |
3 | selection_default_title | X | X | |
4 | store | | X | |
5 | title | | X | |
6 | price | | | |
7 | price_type | | | |
CPBO: Catalog Product Bundle Option
Create/Update Columns
# | Column | Key? | Required? | Comments |
1 | sku | X | X | |
2 | default_title | X | X | |
3 | position | | | |
4 | type | | | |
5 | required | | | |
Examples
Add a Bundle Product
##CPBO,sku,default_title,position,type,required
CPBO,BUNDLE_SKU,CPU,1,select,1
CPBO,BUNDLE_SKU,RAM,2,select,0
##CPBOS,sku,default_title,selection_sku,position,is_default,selection_price_type,selection_price_value,selection_qty,selection_can_change_qty
CPBOS,BUNDLE_SKU,CPU,"CORE2DUO",1,1,0,100,1,0
CPBOS,BUNDLE_SKU,CPU,"PHENOMII",2,0,0,120,1,0
CPBOS,BUNDLE_SKU,RAM,"2GB",1,1,0,30,1,1
CPBOS,BUNDLE_SKU,RAM,"4GB",2,0,0,60,1,1
CPBOL: Catalog Product Bundle Option Store Specific
Create/Update Columns
# | Column | Key? | Required? | Comments |
1 | sku | X | X | |
2 | default_title | X | X | |
3 | store | X | X | |
4 | title | | X | |
CPBOS: Catalog Product Bundle Option Selection
Create/Update Columns
# | Column | Key? | Required? | Comments |
1 | sku | X | X | |
2 | default_title | X | X | |
3 | selection_sku | X | X | |
4 | position | | | |
5 | is_default | | | |
6 | selection_price_type | | | |
7 | selection_price_value | | | |
8 | selection_qty | | | |
9 | selection_can_change_qty | | | |
CPBOSL: Catalog Product Bundle Option Selection Price
Create/Update Columns
# | Column | Key? | Required? | Comments |
1 | sku | X | X | |
2 | default_title | X | X | |
3 | selection_sku | X | X | |
4 | selection_price_type | | X | |
5 | selection_price_value | | X | |
6 | website | X | X | |
Delete Columns
# | Column | Key? | Required? | Comments |
1 | sku | X | X | |
2 | default_title | X | X | |
3 | selection_sku | X | X | |
4 | website | X | X | |
Examples
Add a Bundle Product
- cpbosl.csv
"##CPBOSL","sku","default_title","selection_sku","selection_price_type","selection_price_value","website"
"CPBOSL","24-WG080","Sprite Stasis Ball","24-WG081-blue",1,3,"base"
"CPBOSL","24-WG080","Sprite Stasis Ball","24-WG082-blue",1,4,"base"
"CPBOSL","24-WG080","Sprite Stasis Ball","24-WG083-blue",1,4,"base"
"##-CPBOSL","sku","default_title","selection_sku","website"
"-CPBOSL","24-WG080","Sprite Stasis Ball","24-WG083-blue","base"
Create/Update Columns
# | Column | Key? | Required? | Comments |
1 | sku | X | X | |
2 | linked_sku | X | X | |
3 | position | | | |
4 | qty | | | |
CPUI: Catalog Product Up Sell Item
Create/Update Columns
# | Column | Key? | Required? | Comments |
1 | sku | X | X | |
2 | linked_sku | X | X | |
3 | position | | | |
4 | qty | | | |
CPXI: Catalog Product Cross Sell Item
Create/Update Columns
# | Column | Key? | Required? | Comments |
1 | sku | X | X | |
2 | linked_sku | X | X | |
3 | position | | | |
4 | qty | | | |
CPGI: Catalog Product Grouped Item
Create/Update Columns
# | Column | Key? | Required? | Comments |
1 | sku | X | X | |
2 | linked_sku | X | X | |
3 | position | | | |
4 | qty | | | |
CPSA: Catalog Product Super Configurable Attribute
Create/Update Columns
# | Column | Key? | Required? | Comments |
1 | sku | X | X | |
2 | attribute_code | X | X | |
3 | position | | X | |
4 | label | | X | |
Examples
Basic link between configurable product and 5 simple products using 2 attributes
##CPSA,sku,attribute_code,position,label
CPSA,CONFIGURABLE,color,1,Color
CPSA,CONFIGURABLE,size,2,Size
##CPSI,sku,linked_sku
CPSI,CONFIGURABLE,SIMPLE-BLUE-L
CPSI,CONFIGURABLE,SIMPLE-RED-L
CPSI,CONFIGURABLE,SIMPLE-BLUE-M
CPSI,CONFIGURABLE,SIMPLE-RED-M
CPSI,CONFIGURABLE,SIMPLE-BLUE-S
CPSAL: Catalog Product Super Configurable Attribute Store Specific
Create/Update Columns
# | Column | Key? | Required? | Comments |
1 | sku | X | X | |
2 | attribute_code | X | X | |
3 | store | | X | |
4 | label | | | |
CPSAP: Catalog Product Super Configurable Attribute Pricing
Create/Update Columns
# | Column | Key? | Required? | Comments |
1 | sku | X | X | |
2 | attribute_code | X | X | |
3 | value_label | X | X | |
4 | website | X | X | |
5 | pricing_value | | X | |
6 | is_percent | | X | |
CPSI: Catalog Product Super Configurable Item
Create/Update Columns
# | Column | Key? | Required? | Comments |
1 | sku | X | X | |
2 | linked_sku | X | X | |
CPPT: Catalog Product Tier Prices
Create/Update Columns
1 | sku | X | X | |
2 | customer_group | X | X | Use '*' for all groups |
3 | qty | X | X | |
4 | price | | X | |
5 | website | | | |
6 | percentage_value | | | magento2 >= 2.2.0 |
Delete Columns
# | Column | Key? | Required? | Comments |
1 | sku | X | X | |
2 | customer_group | X | X | Use '*' for all groups |
3 | qty | X | X | |
4 | website | | | |
CPPG: Catalog Product Group Prices
(available for Rapidflow 2.0.0.2 and further)
Create/Update Columns
# | Column | Key? | Required? | Comments |
1 | sku | X | X | |
2 | customer_group | X | X | |
3 | price | | X | |
4 | website | | | |
Delete Columns
# | Column | Key? | Required? | Comments |
1 | sku | X | X | |
2 | customer_group | X | X | |
4 | website | | | |
CPD: Catalog Product Downloadable
Create/Update Columns
# | Column | Key? | Required? | Comments |
1 | sku | X | X | |
2 | title | X | X | |
3 | price | | | |
4 | max_downloads | | | |
5 | is_shareable | | | |
6 | sort_order | | | |
7 | link_url | | | |
8 | link_file | | | |
9 | link_type | | | |
10 | sample_url | | | |
11 | sample_file | | | |
12 | sample_type | | | |
CPDL: Catalog Product Downloadable Store Specific
Create/Update Columns
# | Column | Key? | Required? | Comments |
1 | sku | X | X | |
2 | default_title | X | X | |
3 | store | X | X | |
4 | title | | X | |
CPDP: Catalog Product Downloadable Website Price
Create/Update Columns
# | Column | Key? | Required? | Comments |
1 | sku | X | X | |
2 | default_title | X | X | |
3 | website | X | X | |
4 | price | | X | |
CPDS: Catalog Product Downloadable Sample
Columns
# | Column | Key? | Required? | Comments |
1 | sku | X | X | |
2 | title | X | X | |
3 | sort_order | | | |
4 | sample_url | | | |
5 | sample_file | | | |
6 | sample_type | | | |
CPDSL: Catalog Product Downloadable Sample Store Specific
Columns
# | Column | Key? | Required? | Comments |
1 | sku | X | X | |
2 | default_title | X | X | |
3 | store | X | X | |
4 | title | | X | |
Enterprise Data Row Types
Allowed actions
GCA: Gift Card Account
Columns
# | Column | Key? | Required? | Comments |
1 | code | X | X | |
2 | balance | X | X | |
3 | status | X | X | |
4 | state | X | X | |
5 | is_redeemable | X | X | |
6 | date_created | | | |
7 | date_expires | | | |
8 | website | | | |
Examples
GCA,001PZCPE0Y1N-2,110.00,1,0,1,2020-01-14,2020-06-26,base
Delete giftcard
-GCA,02UXLMTJC5AH-2,50.00,1,0,1,2020-01-14,,base
GCAH: Gift Card Account History
Columns
# | Column | Key? | Required? | Comments |
1 | code | X | X | |
2 | updated_at | X | X | |
3 | action | X | X | |
4 | balance_amount | X | X | |
5 | balance_delta | X | X | |
6 | additional_info | | | |
Examples
GCAH,02UXLMTJC5AH-2,"2020-01-14 18:34:21",Created,50.00,50.00,"By admin: admin."
GCAH,02UXLMTJC5AH-2,"2020-01-14 18:34:38",Updated,44.00,-6.00,"By admin: admin."
Multi Source Inventory Row Types
Allowed actions
MSIS: MSI Source
Columns
# | Column | Key? | Required? | Comments |
1 | source_code | X | X | |
2 | name | X | X | |
3 | enabled | X | X | |
4 | description | X | X | |
5 | latitude | X | X | |
6 | longitude | X | X | |
7 | country_id | X | X | |
8 | region_id | X | X | |
9 | region | X | X | |
10 | city | X | X | |
11 | street | X | X | |
12 | postcode | X | X | |
13 | contact_name | X | X | |
14 | email | X | X | |
15 | phone | X | X | |
16 | fax | X | X | |
17 | use_default_carrier_config | X | X | |
Examples
MSIS,default,"US PA Source",1,"US PA Source",0.000000,0.000000,US,51,,Eclectic,"Steel Crossway",17589,,,,,1
Delete source
-MSIS,eu_it,"Europe IT Source",1,"Europe IT Source",,,IT,,,Rome,"Rome Street",00199,,,,,1
MSIST: MSI Stock
Columns
# | Column | Key? | Required? | Comments |
1 | name | X | X | |
Examples
Delete stock
MSIS: MSI Stock Source Link
Columns
# | Column | Key? | Required? | Comments |
1 | source_code | X | X | |
2 | stock_name | X | X | |
3 | priority | X | X | |
Examples
MSISL,default,"Default Stock",1
Delete stock source link
-MSISL,us_ca,"US Stock",3
MSIS: MSI Source Item
Columns
# | Column | Key? | Required? | Comments |
1 | source_code | X | X | |
2 | sku | X | X | |
3 | quantity | X | X | |
4 | status | X | X | |
Examples
MSISI,eu_it,"utest 1",3.0000,1
Delete source item
-MSISI,eu_uk,"utest 1",2.0000,1
MSIS: MSI Stock Sales Channel
Columns
# | Column | Key? | Required? | Comments |
1 | website_code | X | X | |
2 | stock_name | X | X | |
Examples
Delete stock sales channel
-MSIC,europe,"Europe Stock"
B2B Data Row Types
Allowed actions
B2BC: B2B Company
Columns
# | Column | Key? | Required? | Comments |
1 | company_name | X | X | |
2 | company_status | X | X | |
3 | email | X | X | |
4 | street | X | X | |
5 | city | X | X | |
6 | country_id | X | X | |
7 | region | X | X | |
8 | region_id | X | X | |
9 | postcode | X | X | |
10 | telephone | X | X | |
11 | customer_group | X | X | |
12 | admin_customer | X | X | |
13 | admin_customer_website | X | | |
14 | sales_representative | X | | |
15 | legal_name | X | | |
16 | vat_id | X | | |
17 | reseller_id | X | | |
17 | comment | X | | |
17 | reject_reason | X | | |
17 | rejected_at | X | | |
Examples
B2BC,company1,Approved,company1@example.com,"Foam Road","Foam Lak",US,,23,60360,3235553232,"Wholesale SC",company1admin@example.com,base,admin,,,,,,
B2BC,company2,Approved,company2@example.com,"Grove Crossing",Noseville,US,,61,23860,911,"Wholesale SC",company2admin@example.com,base,admin,,,,,,
Delete company
-B2BC,company1,Approved,company1@example.com,"Foam Road","Foam Lak",US,,23,60360,3235553232,"Wholesale SC",company1admin@example.com,base,admin,,,,,,
B2BCACE: B2B Company Advanced Customer Entity
Columns
# | Column | Key? | Required? | Comments |
1 | company_name | X | X | |
2 | customer | X | X | |
3 | ace_status | X | X | |
4 | job_title | X | | |
5 | telephone | X | | |
6 | customer_website | X | | |
Examples
B2BCACE,company1,company1admin@example.com,Active,,,base
B2BCACE,company2,company2admin@example.com,Active,CEO,,base
Delete
-B2BCACE,company2,company2admin@example.com,Active,CEO,,base
B2BCC: B2B Company Credit
Columns
# | Column | Key? | Required? | Comments |
1 | company_name | X | X | |
2 | credit_limit | X | | |
3 | balance | X | | |
4 | currency_code | X | | |
5 | exceed_limit | X | | |
Examples
B2BCC,company1,1500.0000,100.0000,USD,0
B2BCC,company2,1000.0000,0.0000,USD,1
Delete
-B2BCC,company2,1000.0000,0.0000,USD,1
B2BCCH: B2B Company Credit History
Columns
# | Column | Key? | Required? | Comments |
1 | company_name | X | X | |
2 | datetime | X | X | |
3 | amount | X | X | |
4 | balance | X | X | |
5 | credit_limit | X | X | |
6 | available_credit | X | X | |
7 | credit_history_type | X | X | |
8 | user | X | X | |
9 | user_type | X | X | |
10 | currency_credit | X | | |
11 | currency_operation | X | | |
12 | rate | X | | |
13 | rate_credit | X | | |
14 | purchase_order | X | | |
15 | comment | X | | |
16 | user_website | X | | |
Examples
B2BCCH,company1,"2020-06-24 18:43:21",0.0000,0.0000,1000.0000,1000.0000,Allocated,adminuser,Admin,USD,USD,1.000000000000,0.000000000000,,,
B2BCCH,company2,"2020-06-30 07:57:59",0.0000,0.0000,1000.0000,1000.0000,Allocated,adminuser,Admin,USD,USD,1.000000000000,0.000000000000,,,
Delete
-B2BCCH,company2,"2020-06-30 07:57:59",0.0000,0.0000,1000.0000,1000.0000,Allocated,adminuser,Admin,USD,USD,1.000000000000,0.000000000000,,,
B2BCOE: B2B Company Order Entity
Columns
# | Column | Key? | Required? | Comments |
1 | company_name | X | X | |
2 | order_id | X | X | |
Examples
B2BCOE,company1,000000001
B2BCOE,company2,000000002
Delete
-B2BCOE,company2,000000002
B2BCPM: B2B Company Payment
Columns
# | Column | Key? | Required? | Comments |
1 | company_name | X | X | |
2 | use_config_settings | X | X | |
3 | applicable_payment_method | X | | |
4 | available_payment_methods | X | | |
Examples
B2BCPM,company1,0,B2B,"amazonlogin,amazon_payment,banktransfer,cashondelivery,checkmo,payflow_advanced,payflowpro,payflow_link,authorizenet_acceptjs,braintree,cybersource,eway,authorizenet_directpost,klarna_kp,free,braintree_paypal,paypal_billing_agreement,payflow_express_bml,paypal_express_bml,paypal_express,payflow_express,hosted_pro,worldpay,companycredit,purchaseorder,braintree_paypal_vault,braintree_cc_vault,payflowpro_cc_vault"
B2BCPM,company2,1,B2B,"amazonlogin,amazon_payment,banktransfer,cashondelivery,checkmo,payflow_advanced,payflowpro,payflow_link,authorizenet_acceptjs,braintree,cybersource,eway,authorizenet_directpost,klarna_kp,free,braintree_paypal,paypal_billing_agreement,payflow_express_bml,paypal_express_bml,paypal_express,payflow_express,hosted_pro,worldpay,companycredit,purchaseorder,braintree_paypal_vault,braintree_cc_vault,payflowpro_cc_vault"
Delete
-B2BCPM,company2,1,B2B,"amazonlogin,amazon_payment,banktransfer,cashondelivery,checkmo,payflow_advanced,payflowpro,payflow_link,authorizenet_acceptjs,braintree,cybersource,eway,authorizenet_directpost,klarna_kp,free,braintree_paypal,paypal_billing_agreement,payflow_express_bml,paypal_express_bml,paypal_express,payflow_express,hosted_pro,worldpay,companycredit,purchaseorder,braintree_paypal_vault,braintree_cc_vault,payflowpro_cc_vault"
B2BCR: B2B Company Roles
Columns
# | Column | Key? | Required? | Comments |
1 | company_name | X | X | |
2 | role_name | X | X | |
3 | sort_order | X | | |
Examples
B2BCR,company1,"Default User",0
B2BCR,company1,"Warehouse Role",0
B2BCR,company2,"Default User",0
Delete
-B2BCR,company2,"Default User",0
B2BCPR: B2B Company Permissions
Columns
# | Column | Key? | Required? | Comments |
1 | company_name | X | X | |
2 | role_name | X | X | |
3 | resource_id | X | X | |
4 | permission | X | X | |
Examples
B2BCPR,company1,"Default User",Magento_Company::index,allow
B2BCPR,company1,"Default User",Magento_Sales::all,allow
B2BCPR,company1,"Default User",Magento_Sales::place_order,allow
B2BCPR,company1,"Warehouse Role",Magento_Company::roles_view,deny
B2BCPR,company1,"Warehouse Role",Magento_Company::roles_edit,deny
Delete
-B2BCPR,company1,"Warehouse Role",Magento_Company::roles_edit,deny
B2BCT: B2B Company Team
Columns
# | Column | Key? | Required? | Comments |
1 | company_name | X | X | |
2 | team_name | X | X | |
3 | description | X | | |
Examples
B2BCT,company1,Sales,
B2BCT,company1,Warehouse,
B2BCT,company2,Sales,
Delete
B2BCS: B2B Company Structure
Columns
# | Column | Key? | Required? | Comments |
1 | company_name | X | X | |
2 | entity_type | X | X | |
3 | entity | X | X | |
4 | parent_type | X | X | |
5 | parent_entity | X | X | |
6 | position | X | | |
7 | entity_website | X | | |
8 | parent_website | X | | |
Examples
B2BCS,company1,Customer,company1admin@example.com,,,0,base,
B2BCS,company1,Team,Sales,Customer,company1admin@example.com,0,,base
B2BCS,company1,Team,Warehouse,Team,Sales,0,,
Delete
-B2BCS,company1,Team,Warehouse,Team,Sales,0,,
B2BCUR: B2B Company User Roles
Columns
# | Column | Key? | Required? | Comments |
1 | company_name | X | X | |
2 | role_name | X | X | |
3 | customer | X | X | |
4 | customer_website | X | | |
Examples
B2BCUR,company1,"Default User",company1user@example.com,1
B2BCUR,company2,"Default User",company2user@example.com,1
Delete
-B2BCS,company1,Team,Warehouse,Team,Sales,0,,
B2BSC: B2B Shared Catalog
Columns
# | Column | Key? | Required? | Comments |
1 | name | X | X | |
2 | tax_class | X | X | |
3 | created_by | X | | |
4 | created_at | X | | |
5 | description | X | | |
6 | store | X | | |
Examples
B2BSC,"Wholesale SC","Wholesale Customer",adminuser,"2020-07-08 06:02:50",,
Delete
-B2BSC,"Wholesale SC","Wholesale Customer",adminuser,"2020-07-08 06:02:50",,
B2BSCPI: B2B Shared Catalog Product Item
Columns
# | Column | Key? | Required? | Comments |
1 | customer_group | X | X | Supports multiple values separated with multivalue separator (default '; ') |
2 | sku | X | X | |
Examples
B2BSCPI,"NOT LOGGED IN",24-MB01
B2BSCPI,General,24-MB01
B2BSCPI,"Wholesale SC",24-MB01
B2BSCPI,"Retailer 1; Retailer 2",24-MB01
Delete
-B2BSCPI,"Wholesale SC",24-MB01
-B2BSCPI,"Retailer 1; Retailer 2",24-MB01
B2BRQL: B2B Requisition List
Columns
# | Column | Key? | Required? | Comments |
1 | name | X | X | |
2 | customer | X | X | |
3 | description | X | | |
4 | updated_at | X | | |
5 | customer_website | X | | |
Examples
B2BRQL,"company1 Req List",company1admin@example.com,,"2020-07-08 06:49:44",1
Delete
-B2BRQL,"company1 Req List",company1admin@example.com,,"2020-07-08 06:49:44",1
B2BRQLI: B2B Requisition List Item
Columns
# | Column | Key? | Required? | Comments |
1 | name | X | X | |
2 | customer | X | X | |
3 | sku | X | X | |
4 | qty | X | | |
5 | added_at | X | | |
6 | store | X | | |
7 | options | X | | |
8 | customer_website | X | | |
Examples
B2BRQLI,"company1 Req List",company1admin@example.com,24-MB01,1.0000,,,"{""info_buyRequest"":{""product"":""1"",""uenc"":""aHR0cDovL21hZ2VudG8yMzJiMmIubG9jL2NoZWNrb3V0L2NhcnQvYWRkL3VlbmMvYUhSMGNEb3ZMMjFoWjJWdWRHOHlNekppTW1JdWJHOWpMMmRsWVhJdlltRm5jeTVvZEcxcy9wcm9kdWN0LzEv"",""form_key"":""rspW4yqaVs3ZrNdQ""}}",1
B2BRQLI,"company1 Req List",company1admin@example.com,24-MB04,1.0000,,,,
Delete
-B2BRQLI,"company1 Req List",company1admin@example.com,24-MB04,1.0000,,,,
Roadmap
Row Type | Description | Comments |
CT | Catalog Tag | |
CTL | Catalog Tag Store Specific | |
CTP | Catalog Tag Product Relation | |
CS | Catalog Search | |
AC | Customer | |
AA | Customer Address | |
SO | Sales Order | |
SI | Sales Invoice | |
SS | Sales Shipment | |
SC | Credit Memo | |
CT: Catalog Tag
Columns
# | Column | Key? | Required? | Comments |
1 | tag_name | X | X | |
2 | status | | | |
CTL: Catalog Tag Store Specific
Columns
# | Column | Key? | Required? | Comments |
1 | tag_name | X | X | |
2 | store | | | |
3 | customers | | | |
4 | products | | | |
5 | uses | | | |
6 | historical_uses | | | |
7 | popularity | | | |
CTP: Catalog Tag Product Relation
Columns
# | Column | Key? | Required? | Comments |
1 | sku | X | X | |
2 | tag_name | X | X | |
3 | store | | | |
4 | active | | | |
5 | created_at | | | |