ChannelAdvisor to Magento Connector V2

User Guide

Table of Contents

a.  FEATURES3
B.  HOW TO USE THE CHANNELADVISOR TO MAGENTO CONNECTOR3
c.  APPENDIX3

a.  FEATURES

The module provides real-time connectivity from Magento to ChannelAdvisor and fast updates from ChannelAdvisor to Magento via the ChannealAdvisor API and includes failover detection to ensure the integrity of your data. Its features are as follow:

Real Time Inventory Updates

When stock is decreased in your Magento store Channel advisor is contacted and stock is automatically decreased, this can of course be switched off if it is not required.Contacts ChannelAdvisor at user designated interval (default 15 minutes) to check for changes in stock level and updates Magento stock accordingly, last known stock levels on both systems are kept in the Module database to enable comparison on update so that if a decrease has occurred on both systems then the correct tally is found and applied to both systems.

Real time stock synchronization

Orders flow from Magento from ChannelAdvisor and vice versa at a user designated interval (default 10 minutes). 10 minutes is advised by Ebay to be the required notification period of new orders from their marketplace.Orders are prefixed by a combination of CA (ChannelAdvisor) and Marketplace for example AM for amazon – these prefixes can be user defined, the module then identifies the orders based on these prefixes and sends fulfillment details (shipping carrier, type and shipping details) back to the marketplace via ChannelAdvisor when the order is marked as complete or another user designated order status.You can map the shipping and billing methods to match your business needs so order importing and fulfillment updates are very flexible.Magento orders are imported into CA into their own Magento Marketplace.

Order Management and Fulfillment

Orders flow from Magento from ChannelAdvisor and vice versa at a user designated interval (default 10 minutes). 10 minutes is advised by Ebay to be the required notification period of new orders from their marketplace.Orders are prefixed by a combination of ChannelAdvisor and Marketplace for example AM for amazon – these prefixes can be user defined, the module then identifies the orders based on these prefixes and sends fulfillment details (shipping carrier, type and shipping details) back to the marketplace via ChannelAdvisor when the order is marked as complete or another user designated order status.You can map the shipping and billing methods to match your business needs so order importing and fulfillment updates are very flexible.Magento orders are imported into ChannelAdvisor into their own Magento Marketplace.

Multiple Store Support

Connect each store view on Magento to one ChannelAdvisor account so you can keep all your ChannelAdvisor accounts in synchronization.The store view attribute data will be used to send to the ChannelAdvisor account you connect to.

Variation Items Support

Both Configurable products and Grouped products will update as variation items with their child products associated.Create configurable and grouped products from variation items when products are imported to Magento and vice versa when importing from Magento to ChannelAdvisor by using our simple mapping process.

B.  HOW TO USE THE CHANNELADVISOR TO MAGENTO CONNECTOR

This guidance shows you how to run this module smoothly and appropriately with simple information. It provides explanations, details and images for reference.

WiseRobot ChannelAdvisor Configuration

On the Magento Admin Panel, click on STORES → Configuration → WiseRobot ChannelAdvisor page

guide-v2
guide-v2

On the WiseRobot ChannelAdvisor page, there are 9 module settings such as ChannelAdvisor API Settings, Import Orders from ChannelAdvisor, Export Orders to ChannelAdvisor, Update Shipment to ChannelAdvisor, Update Products to ChannelAdvisor, Setting for Configurable/Grouped Products, Update Products from ChannelAdvisor, Ignore Products and Error Handling respectively.

P-1. ChannelAdvisor API settings

Configuring the ChannelAdvisor API Settings is the first and foremost critical step in connecting your Magento store to ChannelAdvisor. The API settings process has two-important processes involved.

1. Step 1 - Request and authorize a Developer Key

This stage allows you to develop an integration code with the ChannelAdvisor API and to access one or more ChannelAdvisor Client Accounts.

a. To request a Developer Key

Using your browser, navigate to ChannelAdvisor API Developer Credentials. Click here.

guide-v2
  • Enter Name, Company, Email Address, Phone Number, Password and Confirm Password.
  • Read Terms and Conditions → if you agree, click on Submit Request button.
  • Two notification emails from ChannelAdvisor Developer network will be sent to your registered email after finishing this step.
  • The first coming email requires you to activate your ChannelAdvisor API Developer Credentials. After activating it, you will receive the second email containing your developer key.
  • Using your own browser to login to your Magento
  • On the Magento Admin Panel, select STORES → Configuration → see the WiseRobot ChannelAdvisor page → click on ChannelAdvisor API Settings to expand this section.
  • guide-v2
  • From the ChannelAdvisor API Settings page, enter your Developer Key and Password
  • Click Save Config
b. To have your Developer Key authorized

Using your browser, navigate to the ChannelAdvisor Client Login.  Click here.

guide-v2
  • Enter your User name and Password
  • On the Admin Menu, select My Account → Developer Network → Account Authorizations
  • guide-v2
  • From the Account Authorizations page, click on [+] of Account List → get Profile ID
  • guide-v2

After getting profile ID, generate a request to access your ChannelAdvisor API (from Magento Admin Panel → navigate CA API → click on Request API Access → type Profile ID → click on Send Request).

  • On the Magento Admin Panel, select CA API → Request API Access at the Request API Access section.
  • guide-v2
2. Step 2 - Connecting from Magento to ChannelAdvisor using ChannelAdvisor Account ID
a.  Access the WiseRobot ChannelAdvisor Settings
  • Using your own browser to login to your Magento
  • On the Magento Admin Panel, select STORES → Configuration → see the WiseRobot ChannelAdvisor page → click on ChannelAdvisor API Settings to expand this section.
  • guide-v2
b.  Connecting Magento to ChannelAdvisor employing ChannelAdvisor Account ID
  • From the ChannelAdvisor API Settings page, enter your Developer Key and Password
  • In the Test Mode tab:
    1. Set Yes if updating some selected products with SKUs which are listed in Test SKUs table (this table only appears when you choose Yes on the Test Mode tab).
    2. Set No if updating all products.

  • In the ChannelAdvisor Account ID Source tab:
    1. Set Magento Config → fill ChannelAdvisor Account ID which is taken from the Account ID column in the Account List (via Account Authorizations page of your ChannelAdvisor). ChannelAdvisor Account Description (optional) just provides you to take note for management. Then, click on Save Config tab (on the top-right corner page) when you finish. Completion of this step means that all your mappings will be implemented through this account.
    2. guide-v2

Notes:

  • Test mode and Test SKUs are designed to export or import only designated SKUs listed in Test SKUs from Magento to ChannelAdvisor (each SKU is distinguished from others by a comma).

P-2.  Export Orders to ChannelAdvisor

guide-v2
  • To activate this function, set Active to Enable
  • Only Export Orders with Status: select one of the statuses in the table. An order will be exported to ChannelAdvisor when it is with the status following your selection.
  • Allow Cancel Order: an order will be exported to ChannelAdvisor involving cancel orders.
  • Allow Cancel Order on CA If exist Credit Memo: an order will be exported to ChannelAdvisor involving cancel orders having credit memo.
  • Default Email: if an order does not have an email, this email will be used.
  • Chang Order Status after Export: the same meaning with the name change order status after export. Choose one of the statuses you want.
  • Add Order To Queue: the orders will be put in a queue list.
  • When finish, click on Save Config at the top-right corner.

P-3.  Import orders from ChannelAdvisor

guide-v2
  1. To activate this function, set Active to Enable
  2. Set Only Import Shipment Information to:
    • Yes order is imported or invoiced only after payment is received.
    • No all orders are imported before payment is received.
  3. Set Use External Cron Job to Yes: cron job of Magento will not be used.
  4. Set Allow Send Shipment Email to Yes: allow sending an email while import shipment.
  5. Set Allow Import Shipment Without Tracking Number to Yes: allow import shipment including shipments without tracking numbers.
  6. Set Import When Payment is cleared to Yes: import will be done after a payment is cleared.
  7. Set Import When Order Has Shipping Status to:
    • Any: import will be done if orders have shipped and unshipped status.
    • Shipped: import will be done if an order has shipped status
    • Unshipped: import will be done if an order has unshipped status
  8. Set Ignore Externally Fulfilled Orders to Yes: import order fulfilled by FBA will not be imported.
  9. Set Import ChannelAdvisor Tax to Magento Tax to:
    • Yes taxes are displayed on the Magento imported sales order.
    • No taxes are hidden on the Magento imported sales order.
  10. guide-v2
  11. Set Use Marketplace Order Number to Yes: order numbers of CA will be used instead of order numbers of Magento.
  12. To add prefix to order ID: Set Order ID prefix mode to:
    • No prefix: use Magento default order number schema only.
    • Prefix using Setting only: fill in the Order Id Prefix section the prefix you want to add to order ID.
    • Prefix using Market place only: link the ID prefix market place to order number.
      • On Magento Admin Panel, select CA API → Manage Sales Source for Order Import at Transaction section (refer on Manage Sales Sources Section.)
      • guide-v2
      • In this page, choose the Sales Source that you want to add prefix such as Amazon.com, Amazon Webstore – UK, etc.
      • guide-v2
      • Click on Add New button.
      • guide-v2
        • Set Status to “Enable” to activate this application.
        • In the Sales Source field, keep as it is or change to other sales sources.
        • Set Enable Email to “Enable” if you want to receive the notification from the system that you've finished adding prefix to your order ID at chosen marketplace.
        • Set Enable Shipment Email to “Enable” if you want to send email while shipment import.
        • Enter Order Prefix section the prefix you like such as AMUK standing for AMAZON_UK etc.
        • Fill the customer address into Assign To Customer: when import order from marketplace, the original customer of that order will be replaced by the customer which is set here.
        • Set Assign Customer Group For New Customer: you can select one group from the list of existing customer groups in this field. When orders from the marketplace are imported, a new customer will be created with the customer group that you select here.
        • When complete, click on Save button.
      • Prefix using Setting and Market place: compromise between Setting and Market place sections above.
  13. Set Reduce stock when order imported to "Yes" to decrease the amount of stocks in Magento equal to the amount of stocks which are ordered by customers like order placed on Magento site.
  14. Set Frequency as needed: from every 5 minutes to every 6 hours. Frequency can be defined as a time frame set to manage how often import order processing occurs.
  15. Set Use Shipping Address as Billing Address when Billing Address is blank to:
    • Yes shipping Address is employed as Billing Address when lacking Billing Address.
    • No simply leaves the Billing Address blank.
  16. Set Use Two-letter Abbreviated Codes for the States to "Yes" to activate this function. (e.g. NA for North American, NC for North Carolina, etc).
  17. Default Shipping/Payment Method: there are some shipping/payment methods for you to set as a default. To add, delete or create new shipping/payment method for order imported to Magento from ChannelAdvisor, you can find more information Shipping Method Mapping and Payment Method Mapping Settings.
  18. Skip update Order with status: when your order is currently in one of these statuses, it won’t be updated even if though there are any changes in the orders.
  19. Use ChannelAdvisor Order’s Date For Imported Orders: use ChannelAdvisor order’s date instead of Magento order’s date for imported orders.
  20. Update Shipment Status After Import: shipment status will be updated to ChannelAdvisor after import.
  21. Active Failover for Order Import: a cron job will test to ensure all orders will be imported.
  22. When complete, click on Save Config button at the top-right corner page.

P-4.  Update Shipment to ChannelAdvisor

The ChannelAdvisor connector allows you to update shipment details from Magento to ChannelAdvisor. When shipment is generated for an imported order, the tracking information and items shipped will be updated to ChannelAdvisor.

guide-v2
  1. Set Active to Enable for update shipment information to ChannelAdvisor.
  2. Set Use carrier mapping to Yes → click on Save Config and then do the following
    • On Magento Admin menu, select CA API → Shipping Carriers Map at the Transaction section (this new menu item only appears when setting Use Carrier Mapping to Yes).
    • guide-v2
    • On this section, click Add New button and complete the required fields:
    • guide-v2
      • Select Magento Shipping Carrier such as Federal Express, DHL etc.
      • Select ChannelAdvisor Shipping Method such as eBay - Standard, Newegg - One-Day Shipping etc.
    • Completion of these fields means that you have just created a new mapping carrier which links the shipping carrier. Federal Express in Magento to the shipping method eBay - Standard in ChannelAdvisor.
    • When complete, click on Save button at the top-right corner page.
  3. In Update Shipment Tracking when an Order has status section: select one of the current order statuses to update shipment tracking. For example, if you choose a current order with a status such as Complete or Canceled, the shipment detail of this order will be updated to ChannelAdvisor accordingly.

P-5.  Update Products to ChannelAdvisor

This function allows you to update changes in products from Magento to ChanelAdvisor such as quantity of products, product descriptions, images etc.

guide-v2
  1. Set Active to Enable to start updating product inventories from Magento to ChannelAdvisor.
  2. Set Update function to:
    • Default: updating products can be run immediately by Magento Default code.
    • Exec Function: updating of products can be run by the php and exec function which requires the support from your server or hosting provider to enable the exec function if it’s currently disabled.
    • Cron Job: updating products can be run as a user defined designated interval.
  3. Set Disable Update by Magento Cron to Yes: Magento cron is not used for update (set up a new cron for the update).
  4. Set Update mode to:
    • Product Info Only: accurate, consistent and up-to-date information about product attributes are updated.
    • Quantity Only: only the quantity of products is updated
    • Product Info and Quantity: Both product information and quantity are updated to ChannelAdvisor.
  5. Set Visibility Filter: choose one of the types in this field. Products have visibility will be exported.
  6. In the Attribute of Ignored Value/Ignored Value sections, you type a value into ignored value section after choosing one of the attributes of an ignored value. If a product has the similar attribute to your doing in the sections, it will not be updated to ChannelAdvisor.
  7. Set Quantity Update Type to:
    • Absolute: Available inventory = the quantity value uploaded.
    • Relative: Available inventory = current inventory + uploaded inventory quantity.
    • Available: Available inventory = the quantity value uploaded – Open (open auctions for this SKU).
    • InStock: Available inventory = uploaded Inventory Quantity - Open - Pending Checkout - Pending Payment Cleared.
    • UnShipped: Available inventory = uploaded Inventory Quantity - Open - Pending Checkout - Pending Payment Cleared - Pending Shipment (paid or unpaid).
  8. Set Allow Create New Product to Yes to generate new products to ChannelAdvisor in case data of these products are not available in ChannelAdvisor.
  9. In the Update image field, you can decide an image that you would like to update via Image Url. By contrast, select “Disable” if you do not want to update any changes.
  10. guide-v2
    • Main Image Attribute to set the size of the images.
    • Set Send Exclude Image to Yes to ignore the images.
    • Set Allow Use Image of Parent Product to Yes to utilize image of parent product for child product.
    • Set Allow Use Image of Parent Product If Product no Image to Yes to utilize image of parent product for child product if the product does not have an image.
  1. Set Use Parent Description for Missing Child Description to Yes to employ the description of parent product for its missing child product.
guide-v2
  1. Set Categories format to:
    • Plain Text: Categories are formatted in Plain text.
    • Array as Json: Categories are formatted in Array as Json.
  2. Set Price for Configurable’s Associated Products to:
    • Normal Price: a product itself is priced by its normally setting price.
    • Calculate from Super Product Configuration: a product is priced following its parent product price.
  3. Set Allow Upload Catelog Price Rule to Yes: export a promotion price of a product when it has the promotion.
  4. In the Delete Product on Magento Will Also Delete on Channeladvisor section, select:
    • Yes allowing you to delete products on Magento and ChannelAdvisor simultaneously.
    • No deleting products on Magento have not affected on the amount of products on ChannelAdvisor.
  5. Set Delete Disable Product to Yes to eliminate disabled products.
  6. Attributes to Limit / Character Limit: limit the information of a product. Example for description
    • Attributes to Limit: you type description
    • Character Limit: you type 100. This means that the description of a product is limited to 100 words.
  7. In the Stock for Dropship Item field, enter the default stock quantity for dropship items for your current product status. Ex: 1000000 (default)
  8. Set No Manage Stock send DropShip Stock to Yes: if the manage stock of a product at catalog in inventory section is set No, it will send Quantity of dropship (1000000).
  9. guide-v2
  10. Set Out of Stock Product Send Stock Level 0 to Yes means the stock level equals 0 when your products are out of stock in order to disable on ChannelAdvisor.
  11. Set Disable Product Send Stock Level 0 to Yes to avoid any inconveniences for clients if your products run out of stock.
  12. In the Distribution Center Code field, enter the distribution code.
  13. In the Default Condition section, choose default condition status such as New, Used, Reconditioned and Refurbished for your all products in your web-store.
  14. Save and Compare Data Before Update Product
  15. Save to CSV Data File When Update Product
  16. When you finish, click on Save Config button at the top-right corner.

P-6.  Setting for Configurable/Grouped Products

Configurable and Grouped Products can be loaded from Magento to ChannelAdvisor by following these steps:

  • Getting the relationship name from corresponding variations on ChannelAdvisor.
  • Change settings to allow update configurable/grouped products into variations on ChannelAdvisor.
1. Step 1 - Getting the relationship name from corresponding variations on ChannelAdvisor

Using your browser, navigate to the ChannelAdvisor Client Logging Panel. The URL is  Click here.

  • Enter your User name and Password
  • On the admin menu, select Inventory → Products → Product Variations
  • guide-v2
2. Step 2 - Change settings to allow update configurable/Grouped products into variations on ChannelAdvisor

Go back to the Settings for Configurable/Grouped Products page from Magento

guide-v2
  • Set Allow Update Configurable/Grouped Products to Yes.
  • Then, the Send Configurable/Grouped Products As will appear. Set this field to “Send configurable/grouped as parent item with relationship”.
  • Set Use Default Relationship Name to Yes. In this section, entering the Default Relationship Name you have taken from step 1 in the list name of Product Variations such as Color.
  • When complete, click on Save Config button.

P-7.  Update Products from ChannelAdvisor

In accordance with the features of the ChannelAdvisor to Magento Connector, our module can help you to transfer products and order information reciprocally. If changes in products on ChannelAdvisor are found, our module will update these changes from ChannelAdvisor to Magento. Hence, the product information in both ChannelAdvisor and Magento will be updated if this function is also enabled as well as updating Magento to Channel advisor, as well as this if desired one way communication from ChannelAdvisor to Magento can be enabled here.

guide-v2
  • Set Active to Enable to activate updating products from ChannelAdvisor.
  • Set Update Option as needed to Update Product Info and Quantity,Update Quantity Only and Update Product Info Only
  • Set Make Stock Import After Product to Yes after import product, it will make import quantity
  • In the Only Update Item with Label field, enter an item label. This means that only items with the given labels will be updated to Magento.
  • In the Category Import Mode section, there are two methods to import your categories. Please find more information Category Import Methods Settings.
  • Set Ignore Null Values to Yes if an attribute has no value then skip its update.
  • Set Allow Import images to Yes to import item’s images from ChannelAdvisor to Magento.
  • Set Import images Parent/Simple Only to Yes only import images for parent/simple products
  • Set Import images For New Products Only to Yes only import images when creating new products
  • Set Import Only One Set Image For Child Product to Yes. If child products (ex. Product A and product B) have the same attribute, the system will import images of one (product A or product B only)
  • Set Disable Product If Stock Level Is 0 to Yes. If the quantity of a product is 0, its product status will be disabled.
  • Set Set in Stock If Stock Level Greater Than 0 to Yes. If the quantity of a product is greater than 0, its product status will be appeared in stock.
guide-v2
  • Set Set Out Stock If Stock Level is 0 to Yes. If the quantity of products in the ChannelAdvisor are 0, the system will import set out stock for the products.
  • Set Buffer Quantity Attribute for buffer quantity using the value of specified attribute.
  • Set Allow Create New Product to Yes to generate new products on Magento, in case; data of these products are not available on Magento.
  • In the Default Tax Class section, you can choose one of the default classes that are set up in the Magento
  • Set Product Type for Parent Product to Configurable product if you want to import parent product. By contrast, set it to Grouped product.
  • Set Allow Change Type of Existing Products to “Yes” when import products, you can change the types of existing products.
  • In the Default Attribute Set field, choose an attribute that you want to make it as a default when updating new product.
  • Set Default Status to Enable and then new product status will show up on the front-end page.
  • In the Default Visibility for Simple/Parent or Child Products section, do:
    • Catalog: your new products will be displayed on a catalog list.
    • Search: your new products will be showed on search mode
    • Catalog, Search: your new products will be exposed on both a catalog list and search mode.
    • Not Visible Individually: your new products will be hidden on the catalog list and search mode.
  • Set Show Image of Child Products to Yes to allow images of child products to show on parent product view.
  • Set Use Parent Description For Missing Child Description to Yes: using description of parent products when child products do not have description.
guide-v2
  • Set Allow Create Category under Brands to Yes can create new categories (child) under Brands (parent).
  • Set Allow Create Category based on Category Name mapping to Yes allow creating new categories base on mapping of categories.
  • In Page Size section, select the amount of products that you want to test at a time.
  • In Frequency section, select a designated time frame as needed.
  • Set Allow Update Back to ChannelAdvisor after Import
  • When you finish, click on Save Config button at the top-right corner.

P-8.  Ignore Products

Activating this function will allow you to ignore updating some products from Magento to ChannelAdvisor and vice versa.

guide-v2
  • Set Allow Ignore Products to Yes to enable this function.
  • In the SKUs for Ignore section, enter the SKUS in this field. These listed SKUs will be skipped throughout updating-product process. Please, input a comma to separate each single SKU.
  • In the Ignore If SKU Has Character field, any SKUs containing listed characters will be ignored throughout updating-product process.
  • In the Ignore Export for Category IDs field, any products containing listed category ids will be ignored and not updated to ChannelAdvisor.
  • When you finish, click on Save Config button at the top-right corner.

P-9.  Error Handling

guide-v2
  • Retry Intervals: the system will solve problems in order to send a notification to you about the issues. Choosing the time you want it to do this function when the issue happens
  • Number of Max Retry: the system will try to solve problems with the times that are typed in this section.
  • Allow Error Reporting: the system will report the error to you if you choose “Yes”.
  • Send Error to Email Addresses.
  • When you finish, click on Save Config button at the top-right corner page.

new admin menu is CA API (WiseRobot section)

On the Magento Admin Panel, navigate CA API, there is a drop-down list comprising of settings such as Request API Access, Account ID Map, Transaction, Inventory, View Logs, Import/Export Tasks, and Configuration respectively.

guide-v2

P-1.  Request ChannelAdvisor API Access

On the Magento Admin Panel, select CA API → Request API Access at the Request API Access section.

guide-v2

P-2.  Attribute Map

Our connector module has a mapping tool to aid you map the attributes from Magento to ChannelAdvisor accurately and easily.

*   To set attribute map from Magento to ChannelAdvisor

On the Magento Admin Panel, select to CA API → Attribute Map at the Inventory section.

guide-v2
guide-v2
  • In the Magento Attribute and Channel Advisor Attribute sections, choose the product attributes. Those attributes are available in both Magento and ChannelAdvisor. By selecting one attribute in Magento Attribute in this list and map it to one respective attribute in ChannelAdvisor Attribute, you can generate a Mapping Table to update and synchronize data between Magento and ChannelAdvisor. (For example: Mapping an attribute “Name” in Magento to an attribute Title in ChannelAdvisor).
  • In Apply To field, pick one of four product types: All Product Types, Parent Product, Child Product, and Simple Product. Then, the synchronization between Magento and ChannelAdvisor will be applied to the type of product you choose.
  • Set Only in Class to Yes for classification.
  • Set Use Data from Parent Product to:
    1. Yes allows updating data such as Name, Price, Description, Image etc. from Parent Product (in case, the product type is Child Product).
    2. No Child Product will get data by itself, not from Parent Product.
  • Set Use in to:
    1. Export only product's attributes will be updated from Magento to ChannelAdvisor.
    2. Import only product's attributes will be updated from ChannelAdvisor to Magento.
    3. Both product's attributes will be updated both ways.
    4. None product's attributes will not be updated either from Magento or ChannelAdvisor.
  • Select the check box in Use Value section, one new text box “Value” will appear and the column “Use Data from Parent Product” will disappear. It means that instead of getting data from product's attributes, you can make it for your own by inputting data. Since, there are some differences between Magento and ChannelAdvisor. This function may be useful.
  • To finish Mapping your Attributes, click on Add to Mapping Table button as well as please do not forget to click on Save Mapping Table button to save your changes.

Notes:

You should know product characteristics’ name in Magento Attribute Code, Magento Attribute Name and Channel Advisor Attribute respectively in order to map them accurately. If you would like to help mapping your attributes please contact us at support@wiserobot.com.

P-3.  Attribute Set Mapping Settings

In ChannelAdvisor, you can only get relationship name, parent or is_parent, etc. but you won’t know which attributes are in parent-child relationship. Therefore, this section will help you clarify these relationships when creating a configurable product. Thanks to the product relationship, if it is a parent item, it will be converted to a corresponding configurable product when importing products to Magento.

1. To Create Variations on ChannelAdvisor
a. Step 1
  • Using your browser, login to ChannelAdvisor Admin Panel
  • guide-v2
  • On the Admin Menu, navigate to menu Inventory → Product Variations
  • guide-v2
  • On the top-left corner, click to expand Create New Product Variation
  • guide-v2
    1. Name: enter the relationship name such as Color and Size etc.
    2. Varying Attribute Names: enter product attributes which belong to this relationship such as Size, Color etc.
    3. When finish, click on Save and Continue button.
b. Step 2

To map the variation attributes to the specific classification attributes

  • Each varying attribute name you defined in step 1 needs a real product attribute to have its value.Hence, you need to select an attribute for each of them.
  • guide-v2
  • You can select the attributes you want to map from Available Attributes list, use the Filter to get the attribute quickly, then click Add button to select it.
  • Then, you click Save and Exit button to finish.
2. To map the attribute set in Magento to a ChannelAdvisor variation
    guide-v2
  • On the Magento Admin Panel, select CA API → Attribute Set/Relationship Map at the Inventory section.
  • guide-v2
  • Click to expand Add New button at the top-right corner page.
    guide-v2
    • ChannelAdvisor Relationship: enter the Relationship you created on ChannelAdvisor (e.g. Color and Size etc.)
    • Set Magento Attribute Set to Default
    • Attribute: choose the attributes are associated with the relationship.
  • When complete, click on Save button.

Here how it works:

When a configurable product is sent to ChannelAdvisor, the module will get attribute set and configurable attributes from that product in order to check with the mappings to find if a ChannelAdvisor Relationship was defined. For example, if that product attribute set is Default and use configurable attribute FS Color and FS Size, from the mapping at the screen shot above, we have relationship Color and Size. Then, the configurable product and its associated products will have that relationship set correctly on ChannelAdvisor.

P-4.  Attribute Set/Classification Map

This function will export attribute set to ChannelAdvisor regarding to classification which you desire. When products are created in Magento, they need to be declared in order to know the products having attributes.

On the Magento Admin Panel, select CA API → Attribute Set/Classification Map at the Inventory section

guide-v2
guide-v2
  • Click on Add New button
  • guide-v2
    1. Magento Attribute Set and ChannelAdvisor Classification sections: choose one of the optional list.
    2. Click on Save button when finishing.

P-5.  Queued Items

When products are failed to update to ChannelAdvisor with any reasons, they will be added to the queued items page in order to announce this process to you. The failed update products will also be updated again to ChannelAdvisor in a short time later or you can manually update the products to ChannelAdvisor.

On the Magento Admin Panel, select CA API → Queued Items at the Inventory section.

guide-v2
guide-v2
  • Export to section: choose one of the optional list.
  • Click on Export button when finish.

P-6.  Image Placement Settings

Due to differing management structures, image management in Magento is somewhat different from the one in ChannelAdvisor. Thus, we need to create an “Image Placement” for images in Magento to make it easier to be mapped to the corresponding one in ChannelAdvisor when updated. In other words, when you change images in Magento, it will be sent to ChannelAdvisor directly at the correct image placement.

* to manage image placements for product update

On Magento Admin Menu, navigate to CA API → Image Placements at the Inventory section.

guide-v2
guide-v2
  • Click on Add New button at the top-right corner page.
  • guide-v2
    1. Name: do the following to enter exactly the name of ChannelAdvisor Image Placements (On ChannelAdvisor Admin Panel, select Inventory → images → Image Hosting. A list of ChannelAdvisor Image Placements is available for you to choose). Look at the image below:
    2. guide-v2
    3. Import to Image Attributes: select the types of image size.
    4. Order: enter sequentially. For example, the image name is “ITEMINAGEURL 0”. In Order field, enter “0”.
    5. When complete, click Save button at the top-right corner page.

P-7.  Distribution Centers Map

This function helps you to manage products of warehouses in different areas (i.e. the quantity of a product in different warehouses).

On the Magento Admin Panel, select CA API → Distribution Centers Map at the Inventory section.

guide-v2
guide-v2
  • Click on Add New button at the top-right corner page.
  • guide-v2
    1. ChannelAdvisor Distribution Center Code and Manufacturer sections: choose one of the optional list.
    2. Don’t not forget to click on Save button when complete.

P-8.  Label Mapping

This function helps you to set a website into a product in relation to label of product in ChannelAdvisor. Ex: label of a product is Website US then you can set it to US Magento site. This will be applied for Magento has more websites.

On the Magento Admin Panel, select CA APILabel Mapping at the Inventory section.

guide-v2
guide-v2
  • Click on Add New button at the top-right corner page.
  • Don’t not forget to click on Save button at the top-right corner page when complete.

P-9.  Category Import Methods Settings

Before importing category methods in ChannelAdvisor to Magento, you need to set up categories in Magento first.

To set up Categories in Magento

guide-v2

On the Magento Admin Panel, navigate to PRODUCTS → Categories at the Inventory section.

guide-v2
  • In the New Root Category page, complete the required fields: Name, Is Active, URL Key, Description, Image, Page Title, Meta Keywords, Meta Description and Include in Navigation Menu.
  • When finished, click Save Category

There are three methods to import categories from ChannelAdvisor to Magento

1. Method 1 - Use Category IDs in Attribute Map
a. Step 1 - Create an attribute in ChannelAdvisor
  • Using your browser, navigate to the ChannelAdvisor page
  • guide-v2
  • On the Admin menu, select Inventory → Grouping → Attributes
  • guide-v2
  • In the Attributes page, click Create New Attribute button and complete the following

    guide-v2
    • Attribute Name: fill the name of an attribute that will appear on your inventory.
    • In Attribute Type section, select Appears on all products or Only used on products in a set of Classifications
    • When complete, click Save button at the top-right corner.
b. Step 2. Map Magento Attribute to ChannelAdvisor Attribute.

On Magento Admin Panel, navigate to CA API → Attribute Map at the Inventory section.

guide-v2
guide-v2
  • Magento Attribute: always select Category Ids to show which attribute on ChannelAdvisor referencing to the Ids of Magento Categories that a product belongs to.
  • Channel Advisor Attribute: select any attributes which contain category Ids
  • Set Use Data from Parent Product to No
  • Set Use in to Import Only
  • Don't choose Use Value
  • When complete, click on Save Mapping Table button

Then, they will have the category set correctly from that attribute item in ChannelAdvisor when products are imported.

2. Method 2 - Use Category/Classification Map

On Magento Admin Menu, navigate to CA API → Category/Classification Map at the Inventory section.

guide-v2
guide-v2

Click on Add New button and complete two required fields

    guide-v2
  • Category: select one of Magento categories
  • Classification: select one of the available classifications

When complete, click Save button at the top-right corner to add them to the mapping table.

Note:

As can be seen in the screen shot, once the mapping is saved, the item will have the classification Bath Sheets and then will be imported into Magento with category Towels & Bedding under the Default Category.

3. Method 3 - Use the attribute mapping method

On Magento Admin Panel, navigate to CA API → Attribute Map at the Inventory section.

guide-v2
guide-v2
  • Magento Attribute: always select Category Name to show which attribute on ChannelAdvisor referencing to the name of Magento Categories that a product belongs to.
  • ChannelAdvisor Attribute: select any attributes which contain category name.
  • Set Use Data from Parent Product to No
  • Set Use in to Import Only
  • Do not choose Use Value
  • When complete, click Save Mapping Table at the top-right corner page

P-10.  Shipping Methods and Payment Methods Mapping Settings

1. Shipping Methods Map

One of the fundamental features of the ChannelAdvisor to Magento Connector is Order Management and Fulfillment. To manage and fulfill orders from ChannelAdvisor, information about fulfillment (such as shipping carrier, shipping class, etc.) needs map to Magento. Our Shipping Methods Mapping tool accelerates the mapping process easier.

* To change, create or add new shipping methods map

On the Magento Admin Panel, select CA API → Shipping Methods Map at the Transaction section.

guide-v2
guide-v2

At the top-right corner, click on Add New button and complete the following

guide-v2
  • Select Magento Shipping Method such as Flat Rate-Fixed, Best Way-Table Rate, etc.
  • Select ChannelAdvisor Shipping Method such as Amazon Merchant@ Standard, eBay – Standard, etc.
  • In Use In field, select one of the types such as Import Only, Export Only or Both
  • When complete, click Save button at the top-right corner page.
2. Payment Methods Map

This is similar to Shipping Methods Map.

* To change, create or add new payment methods map

On the Magento Admin Menu, select CA API → Payment Methods Map at the Transaction section.

guide-v2
guide-v2

At the top-right corner, click on Add New button and complete the required fields

guide-v2
  • Select Magento Payment Method such as Credit Card (saved), and Cash on Delivery, etc
  • Enter ChannelAdvisor Payment Method
  • When complete, click the Save button at the top-right corner.

P-11.  Manage Sales Sources

Orders at many marketplaces will flow into Magento from ChannelAdvisor at a user designated interval (default 10 minutes). When orders are sent to Magento they can be managed and fulfilled.

With our connector, you can decide which sales sources are connected to ChannelAdvisor to import orders from. Furthermore, sending emails obtaining inclusive of order information to clients is also under your control.

* To manage Sales Sources for Order Import

On the Magento Admin Panel, select CA API → Manage Sales Source for Order Import at the Transaction section.

guide-v2
guide-v2

At the top-right corner, click on Add New button and complete the following.

guide-v2
  • Set Status to Enable to activate this tool.
  • In the Sales Source field, select one of the sources you want to import orders.
  • Set Enable Email to Enable if you want to receive the notification from the system that you've finished adding prefix to your order ID at chosen marketplace.
  • Set Enable Shipment Email to Yes
  • Enter Order Prefix section, the prefixes which are convenient for your management such as AMUK standing for AMAZON_UK, etc. In the Order prefix section, you create the prefix for each Sales Source, our module can base on it (Order prefix) to identify orders and send fulfillment information such as shipping carrier, shipping fee, type and other shipping details to clients via ChannelAdvisor. When finishing your set up at new item information in Manage Sales Source of Products Update, please do not forget to click on Save button.
  • Assign to Customer you need to fill a customer’s address into the field to assign the marketplace for the customer. When import an order from marketplace, the original customer of that order will be replaced by the customer who is set here.
  • Assign Customer Group for New Customer to select a customer group for new customer creation when import order from that marketplace. You can select from list of existing customer groups in this field. A new customer will be created with the customer group you select here when orders from the marketplace are imported. You need to click on Save button to save the change you made after finishing.

P-12.  Synchronization Error Messages/Synced Orders

If orders/shipments send to ChannelAdvisor unsuccessfully, they will be showed in Synchronization Messages page. On the other hand, orders/shipments will be showed in Synced Orders page when they send to ChannelAdvisor successfully.

  • On the Magento Admin Panel, select CA API → Synchronization Error Messages at the Transaction section.
  • guide-v2
    guide-v2
  • On the Magento Admin Panel, select CA API → Synced Orders at the Transaction section.
  • guide-v2
    guide-v2

P-13.  Mass Update to ChannelAdvisor Settings

This is one of the most indispensable tools that our module aids you in updating a huge amount of information into ChannelAdvisor from modifications or changes in Magento. This script is often used right at the start of integrating your Magento store with ChanneAdvisor when you need to update all product inventory in one go, or when you need to update some SKU's due to recent mass updates via CSV files. To start Mass Update to ChannelAdvisor:

On the Magento Admin Panel, navigate to CA API → Mass Update to ChannelAdvisor at the Import/Export Tasks section.

guide-v2
guide-v2
  • In the box Skip update Attribute(s), choose attribute(s) that you don’t want to update
  • Click on Run Mass Update to in a new tab button to commence your Mass update. After clicking this button, the other tap will appear to let you know whether the Mass Update to ChannelAdvisor is successful or not.

P-14.   Update SKUs to ChannelAdvisor/Import SKUs or Product images from ChannelAdvisor

1. Manually Update SKUS to ChannelAdvisor

On the Magento Admin Panel, navigate to CA API → Update SKUS to ChannelAdvisor at the Import/Export Tasks section.

guide-v2
guide-v2

Select Browse button to upload a list of SKUS. Then, click on Update (will open a new tab to run) button to start. After that, the new tap will appear to let you know whether the process of Update SKUS to ChannelAdvisor is successful or not.

2. Import SKUS from ChannelAdvisor

On the Magento Admin Panel, navigate to CA API → Import SKUS from ChannelAdvisor at the Import/Export Tasks section.

guide-v2
guide-v2

Select Browse button to upload a list of SKUS. Then, click on Run Import (will open a new tab to run) button to start. After that, the new tap will appear to let you know whether the process of Import SKUS from ChannelAdvisor is successful or not.

3. Import Product images from ChannelAdvisor

On the Magento Admin Menu, navigate to CA API → Import Product images from ChannelAdvisor at the Import/Export Tasks section.

guide-v2
guide-v2

Select Browse button to upload a list of SKUS. Then, click on Run Import images (will open a new tab to run) button to start. After that, the new tap will appear to let you know whether the process of Import Product images from ChannelAdvisor is successful or not.

4. Import orders

On the Magento Admin Menu, navigate to CA API → Import Orders at the Import/Export Tasks section.

guide-v2
guide-v2

Set Please Select A Store For Import and Marketplace Order Numbers (one per line).Then, click on Run Import (will open a new tab to run) button to start. After that, the new tap will appear to let you know whether the process of Import Orders from ChannelAdvisor is successful or not.

P-15.  View Logs

On the Magento Admin Panel, select CA API → View Logs at the View Logs section.

guide-v2
guide-v2

P-16. Import/Export Module Configuration

The meaning of these functions is the similar to the tittle. You can export the module configuration to your computer for reserve. By contrast, you can import the module configuration from your computer to upload your last work.

  • On the Magento Admin Panel, select CA API → Import Module Configuration
  • guide-v2
    guide-v2
  • On the Magento Admin Panel, select CA API → Export Module Configuration
  • guide-v2

c.  APPENDIX

The module includes a folder channeladvisorapi in Magento root directory provides several scripts for external cron entries and usefull functions

Cron Entries

We find that the cron runs more reliably outside magento as you also have more controls for the standalone entry e.g to set CPU limits if the server is lacking resources etc so we created the cron entries and disable the built-in Magento crons in the module:


channeladvisorapi/ImportOrder1.php This will import order or shipment from CA to Magento

channeladvisorapi/importProductExternalCron.php This will import products/quantities from CA to Magento

channeladvisorapi/callProcessQueue.php This will export products in queued to CA

channeladvisorapi/exportProductByUpdateAtToQueue.php This will check the timestamp of updated_at and add product to queue


You will need to add the cron entries for the function(s) you want as above, each one should run no less than each 15min and can be configure at every 30min or hourly, etc based on your demand

Example cron: */15 * * * * php /var/www/magento/channeladvisorapi/importOrder1.php


Function scripts

The scripts provide additional way to run the import/export data manually and shouldn't be used in normal usage:

channeladvisorapi/callOrderImport.php call the main import order function manually

channeladvisorapi/callProcessQueue.php export the queue of product/stock manually

channeladvisorapi/callProductImport.php call the main import product function manually

channeladvisorapi/callSubmitBulkDownload.php ask CA to create a export products file

channeladvisorapi/execExportCatalogRule.php export prices after calculation with catalog rule to CA

channeladvisorapi/execExportProduct.php export single product to CA

channeladvisorapi/execExportProductAndDetach.php export single product and detact with the parent to CA

channeladvisorapi/execExportQueue.php export stock item in queue to CA

channeladvisorapi/execExportStock.php export a single stock item to CA

channeladvisorapi/execMassExportPrice.php export all product price data to CA

channeladvisorapi/execMassExportQty.php export all stock data to CA

channeladvisorapi/execUploadImport.php read upload skus and import from CA to Magento

channeladvisorapi/exportConfigurable.php export configurable products to CA

channeladvisorapi/exportImages.php export product images to CA

channeladvisorapi/exportImagesForEnableVisibleSimpleProduct.php export images of visiable products to CA

channeladvisorapi/exportOrders.php export orders to CA

channeladvisorapi/exportProductByUpdateAt.php export recently updated product to CA

channeladvisorapi/exportProductURL.php export product URL to CA

channeladvisorapi/exportQty.php export product stock to CA

channeladvisorapi/exportQtyInFile.php export product stock from file to CA

channeladvisorapi/exportRelationship.php export product variation data to CA

channeladvisorapi/exportShipmentCustom.php export recently shipments to CA

channeladvisorapi/importOrder2.php failover for order import, needed in some cases

channeladvisorapi/importProductDownloadCron.php download product file from CA and import

channeladvisorapi/importProducts.php read product from file and import from CA

channeladvisorapi/importProductsImages.php import images from CA

channeladvisorapi/importProductsImagesBySKUs.php import images from CA by provided SKUs

channeladvisorapi/importProductsWithDelete.php import products as new from CA by delete existing one

channeladvisorapi/importStockExternalCron.php cron script to import quantity only from CA

channeladvisorapi/makeChildrenSameCategoriesAsParents.php set the children's categroies to match their parents

channeladvisorapi/massExport.php export all products and quantites to CA

channeladvisorapi/massUpdate2.php export all products and quantites to CA with FTP support

channeladvisorapi/removeVisibilityFromChildProducts.php set child products to not visiable

channeladvisorapi/updateAllProducts.php build SKUs list and call import from CA for them

channeladvisorapi/updateAllProductsImages.php build SKUs list and call import images from CA for them

channeladvisorapi/updatePriceinfo.php export a product price to CA

channeladvisorapi/wUpdateShipment.php update a shipment information to CA