Merchantry Magento Extension
Merchantry Magento Extension serves as a gateway between the Merchantry platform and the Magento eCommerce storefront. It can be used by retailers who have storefronts based on Magento and who need to connect to suppliers in theMerchantry platform.
Merchantry Magento Extension can be configured to work in one of the fol-lowing ways on the Magento instance it's installed on:
l Storefront- you're a retailer using the Magento instance as a storefront, and the extension will be used to connect to suppliers in the Merchantry platform.
l Supplier- you're a supplier using the Magento instance to manage your products and orders, and you're going to sell your products through a retailer, and you use the extension to connect to the retailer.
Here you can find more information about Merchantry Magento Extension which can help to set up the extension and start to use it:
l System Requirements l Installation Guide l Administrator's Guide l Limitations
System Requirements
Merchantry Magento Extension works correctly with systems of the following versions
Magento Versions
l Enterprise - version 1.13 l Community - not supported
Magento user with administrator permissions is needed to install and set up the Merchantry Magento Extension.
Merchantry platform API Versions
l Merchantry Platform - Retailer account / Supplier accounts l Product Integration API - Version 1.8 FLAT
Installation Guide
l Environment Readinessl Installing the Extension l Uninstalling the Extension
Note: Please contact your account manager if you are interested in getting the latest version of Merchantry Magento Extension.
Environment Readiness
This Extension must be pre-installed/tested on a snapshot of the destination production Magento instance prior to live deployment.
Installing the Extension
Note: Magento Connect installation requires Magento administrator per-missions.
Installation Guide
l Log in to the Magento admin
Installation Guide
l Make sure you are on the “Extensions” tab
l In the “Direct package file upload” section click “Choose File” and then select theMerchantry_xxx.tgzfile
l Click “Upload” and the extension will be installed to your Magento instance
The window at the bottom of the screen will show the status of the procedure (it may take several minutes to run).
Uninstalling the Extension
Installation Guide
Installation Guide
l Make sure you are on the "Extensions” tab
l Scroll to the bottom to find “Manage Existing Extensions” section
l Under “Package Name” you will see “Merchantry_importexporter”. In the “Actions” drop down menu select “uninstall”
l Click “Commit Changes” at the bottom and the extension will be unin-stalled
The window at the bottom of the screen will show the status of the pro-cedure (it may take several minutes to run).
Administrator's Guide
Navigating and Configurationl Merchantry Magento Extension Menu l General Configuration
l Product Data Mapping Data Processing
l Manual Processing (Import, Export) l Supplier Options (Export)
l Viewing Processing Status l Scheduling Processes
Merchantry Magento Extension Menu
Merchantry Magento Extension
Menu
Note: Configuring the Merchantry Magento Extension requires Magento admin-istrator permissions.
After the Merchantry Magento Extension successfully installed to your Magento instance, you can see new item "Merchantry" in the upper menu
Menu Items
Note: Menu items visibility depends on the Configuration Type set for the Mer-chantry Magento Extension instance. SeeGeneral Configurationfor details. Configuration-general configurationparameters.
l Add New Attribute- used for adding new attributes to attribute lists in product data mapping.
Supplier Options- available for "Supplier" configuration type only. This sec-tion is used for running manually processes toexport products, prices, invent-ory, fulfilled and canceled orders.
Manual Processing Options- used fortriggering manually import/export pro-cessessuch as import products, prices, inventory, orders, RMAs. The pro-cesses which can be run in this section differ for Supplier and Storefront configurations.
Transactional Logs View- viewing the recent process log. l Download- downloads a log file.
Processing Status- available for "Storefront" configuration type only. Leads toProcessing Statussection.
General Configuration
The page allows to view and change general configuration options of the exten-sion.
General Configuration
General Settings
l Magento Store Id- Magento Store identifier indicates which Magento store will be used for the Merchantry Magento Extension. The default is “Default Store View”.
l Configuration Type- defines if the Magento instance works with the Mer-chantry platform as aStorefront1or as a Supplier system. Applicable val-ues are:
l Storefront- select this option if you are using the extension to con-nect to suppliers in the Merchantry platform
l Supplier- select this option if you are using the extension to sell your products through a retailer
l Select user if Guest Checkout is Disabled- a user with administrative permission needs to be created in Magento for this module to allow updates when Guest Checkout is disabled on the cart. Select the admin user name.
l Minimum Product Quantity For Export- available only if "Supplier" configuration type is selected. Products with quantity below the value set in the field will be exported with zero inventory.
l Account ID- Company ID of your account in the Merchantry platform. The value is available from Merchantry once the account is created. Contact your account manager to get the value, and then enter the value in this field.
Example: 119.
l Currency- currency used to sell your products. The default is set to USD.
l Log Level- defines who much detailed logs are needed.
l Show Magento Attributes- available only if "Supplier" configuration type is selected.
l Normal- attributes not visible and not applied to any product type in Magento are not shown in drop down lists inData Mappingsection.
General Configuration
l All- all attributes are available in drop down lists inData Mapping section.
l Use Parent Pricing Model- automatically calculate the parent product price based on its child products. The lowest price across all the children will be taken as the parent price when this is enabled. Available options are:
l Yes(Default) - turns on parent pricing l No- turns off parent pricing
l Status- indicates the status of the Extension. Select the appropriate option:
l Enabled- extension is active for the Merchantry platform l Disabled- extension is not active for the Merchantry platform
Shipping Settings
l Shipping Integration
-FTP Settings
File Transfer Protocol used as data pass through. The information is available in your account in the Merchantry platform.
l FTP Mode- indicates if you use FTP or secure FTP protocol for data transfer. Available options are:
l SFTP l FTP
l FTP UserName- your FTP account username l FTP Password- your FTP account password
l FTP Export data to this folder name- the folder to which you are send-ing files. Usually it's “FromSupplier” (without quotes) for Supplier.
Example:
l FromSupplier(for Suppliers) l FromStorefront(for Retailers)
l FTP Import data from this folder name- the folder from which you will receive files. Usually it's “ToSupplier” (without quotes) for Supplier. Example:
l ToSupplier(for Suppliers) l ToStorefront(for Retailers)
l Export Orders from Previous Day(s)- available only if "Storefront" con-figuration type selected. Specifies the start day of a date range for export-ing orders (current date is the end date). Orders placed within the date range are to be exported to Suppliers. Enter the appropriate numeric value representing number of days.
Example: 1 (means 1 day).
Note: Suppliers can ignore this field.
Product Data Mapping
For Retailer ("Storefront" Configuration Type)
To view the "Data Mapping" section go to"Merchantry"menu item -> "Con-figuration"menu item ->"Data Mapping"tab.
Product Data Mapping
This section allows to configure mapping of Merchantry data fields (MPO Source Attribute) to Magento attributes fields (Destination Attribute in Magento) which will be used on import of product data from Merchantry platform. By default a limited number of core fields are available. Additional fields will become available for mapping once an initial product, inventory and price file is imported.
Create Magento attributes as required based on the data elements available from the Merchantry data fields.
Modify the mapping by selecting proper Magento attributes in drop down lists, then click "Save Configuration" to apply changes.
Adding New Import Attributes Manually
1. Go to"Merchantry"menu item ->"Configuration"->"Add New Attribute"
2. Fill the "Attribute Name to Import" field with the proper name of the Magento attribute you want to export your Merchantry platform attributes to.
3. Select a value in "Attribute Type" - one of l Localized/Attribute -> domain = MPO
l Localized/Attribute -> domain = CommonTaxonomy
l Shipping Data -> Shipping Option- to add shipping option data. 4. Click "Add New Attribute" to add the new attribute to the attribute list in
"Data Mapping" section.
For Suppliers ("Supplier" Configuration Type)
To view the "Supplier Data Mapping" section go to"Merchantry"menu item ->
Product Data Mapping
This section allows to configure mapping of Magento attributes fields to Mer-chantry data fields which will be used on export of product data from Magento to the Merchantry platform
Adding New Export Attributes Manually
1. Go to"Merchantry"menu item ->"Configuration"->"Add New Attribute"
menu item.
2. Fill the "Attribute Name to Export" field with the proper name of the attrib-ute in Merchantry platform you want to export your Magento attribattrib-utes to. 3. Select a value in "Attribute Type" (one of "Export - Variation Theme" and
"Export - Custom Attribute").
4. Click "Add New Attribute" to add the new attribute to the attribute list in "Supplier Data Mapping" section.
Manual Processing (Import,
Export)
The section allow to run different processes for Supplier and Storefront con-figurations of the extension.
You can select the process you need to trigger, fill additional parameters (if any), and click "Run" to start the process.
You will see a notification message indicated that the process was suc-cessfully completed.
Manual Processing (Import, Export)
Processes Available for Suppliers ("Supplier" configuration type) l Import Orders - Supplier Option
l Export ALL Magento Categories
l RESET Import / Export Attribute Mappings
Processes Available for Retailers ("Storefront" configuration type) l Download Files from FTP - the process moves all files from the
FTP directory specified in"FTP Export data to this folder name" con-figuration option to special directory in Magento where the files will be taken to be imported to Magento. The files will be removed from the FTP directory.
Note: The destination directory in Magento is located there: <Your Magento instance URL>/var/www/html/var/merchantry
Example: http://yourmagentoinstance.com/var/www/html/var/merchantry l Import Products / Fulfillments / Prices / Inventory- the process
imports product, prices, inventory and fulfillment files from Merchantry Magento Extension directory to the Magento instance.
Note: All necessary product related settings such as amapping of Mer-chantry attributes to storefront attributes, taxonomy/category, tax class, shipping options should be configured prior to importing product data into
Magento.
Note: The product data files should be previously downloaded from FTP to the special Merchantry Magento Extension directory.
l Export NEW Merchantry Orders- exports not exported orders to the FTP directory specified in"FTP Import data from this folder name". Refer toOrders (eCommerce API 1.4)for the file format.
You can specify the following additional parameters for the process: l Export Orders from Previous Day(s)- specifies a numeric value
which indicates the number of days old from current date to export orders. When it's set to zero or empty value, the process exports all orders that have not been exported before.
Example: 1 indicates to export orders that are 1 day old from cur-rent date.
l Order EXPORT Status Filter- order status in Magento. The process will export only orders in the status. It is recommended to select "Processing" or "Pending".
l Export Orders by Order Number- exports orders by order numbers to the FTP directory specified in"FTP Import data from this folder name". Refer toOrders (eCommerce API 1.4)for the file format.
l Order Numbers to Export (comma separated for multiple)- specify order numbers to export (comma separated list)
l Export ALL Merchantry Orders- works similarly to "Export
NEW Merchantry Orders" but exports all orders, including the ones that have been exported previously. Useful when you need to re-send pre-viously exported order.
l Export NEW Merchantry RMA's- exports not exported RMA's to the FTP directory specified in"FTP Import data from this folder name". Refer toRMAs (eCommerce API 1.4)for the file format.
pre-Supplier Options
from this folder name". Refer toRMAs (eCommerce API 1.4)for the file format.
l Export ALL Magento Categories- exports all Magento categories to Merchantry platform Refer toStorefront Categories (eCommerce API 1.4) for the file format.
l RESET Import / Export Attribute Mappings- Used to reset all data mappings back to defaults prior to data mappings being created for products, prices, inventory, etc.
Supplier Options
Note: This section is available only for "Supplier" configuration of the exten-sion.
This section allows Suppliers to run processes manually to export products, prices, inventory.
You can choose export settings and the process to run, and click "Run Export" to trigger the process. Available settings:
l Start Export from beginning- this setting defines if the system should export products which have been exported already. It doesn't affect order export.
l Yes- exports all products
l No- export only products not exported yet l Number of Records to Process- TBD
l Export Type- select the export process needed. The following pro-cesses are available to export the corresponding product data sets:
l Products, Prices, Inventory l Products
Viewing Processing Status
l Pricing l Inventory l Fulfilled Orders l Canceled Orders
Viewing Processing Status
On the page you can view processing statuses of all processes run. You can fil-ter the process list by process ID, file name, start date and end date, and pro-cessing status.
Note: By default the list shows product related processes. Use filter by File Name to search for other processes.
Clicking a process in the list opens the process detail page where you can download the process file and the process logs:
Scheduling Processes
To schedule processes in Merchantry Magento Extension, follow the steps below:
Scheduling Processes
1. Login to Magento admin
2. Go toSystem -> Configurationin the upper menu
3. Find"Merchantry"section in the left menu, and open the"Scheduled Tasks"tab
4. Schedule a process start, then click "Save Config" to apply changes.
Scheduling Processes
You can use the following configuration options
l Merchantry - FTP Frequency- defines the time and frequency when the Merchantry Magento Extension should download files from FTP.
l Merchantry - Import Frequency- defines the time and frequency when product related files and fulfillments will be imported to Magento. Recom-mended to schedule the trigger to be fired AFTER the"Merchantry - FTP Frequency"one to have all data downloaded from FTP to Magento before the import.
Limitations
l Import - Maximum Number of Files- specifies the maximum number of files to process at one time. If not specified, the system tries to import all files
l RMA - Export Frequency- defines the time and frequency when RMAs and fulfillments will be imported to Magento.
l Orders - Export Frequency- defines the time and frequency when orders and fulfillments will be imported to Magento.
l Orders - Age Before Sent- not supported.
l Orders - Previous Days to Export- specifies a numeric value which indicates the number of days old from current date to export orders. When it's set to zero or empty value, the process exports all orders that have not been exported before.
l Orders - Status to Export- order status in Magento. The process will export only orders in the status.
UseCRON formatto specify process frequency.
For Suppliers ("Supplier" Configuration Type)
Not supported at this moment.
Limitations
Below is the list of cases not supported currently in Merchantry Magento Exten-sion.
l Order Export- Magento does not support tax calculations at the order-item level. Orders are exported with the order tax total amount specified for the first order item.
