Modern Retail's WooCommerce Integrator connects WooCommerce to your third party POS/ERP system, (a service like CounterPoint, RunIt, RICS, etc.) via Modern Retail's Integration Middleware. What this means in plain english is that the integrator carries your data (Orders, shipping information, and payment information) to where it needs to go. In this article we'll go screen by screen to look at everything you can see in Modern Retail's WooCommerce integrator.
Where to Start?
You can get to the Integrator from your website's backend. You can get there by adding "/wp-admin" to the end of your website URL. So, for example, if your website was "spicyramen.com", you could get to the backend by going to "spicyramen.com/wp-admin". After logging in to your backend, you should see WooCommerce Integrator at the bottom of the bar on the left side:
The Main Menu
Clicking on WooCommerce Integrator here will bring you to the main WooCommerce Integrator menu, pictured below:
Under Status you'll see an indicator for the overall status of the integrator. Most of the time this should look like it does above, a green light marked Good.
Underneath the Status section is the Jobs section, which displays how the Integrator is performing the Current Job. Pending Jobs shows a list of upcoming jobs for the integrator to perform. Lastly, Past Jobs has a graph showing the rate at which the integrator has performed jobs in the last week.
Below all this is the History section, which has another graph showing how many products have been processed by the integrator recently.
The first menu item underneath WooCommerce Integrator in the sidebar is Settings. The vast majority of these settings you won't have to look at after the onboarding process, during which Modern Retail will work with you to fill most of this out. The Settings page has a whole bunch of buttons and knobs, so buckle up!
This is the General Settings page:
After your initial setup you shouldn't have to touch any of these settings, and in fact, most of them Modern Retail will set during your onboarding process.
The second tab in the settings page is Mapping.
Part of how the integrator works is by taking data from one source (for example, the XML node referenced here) and transferring it to be used in another place. This is done by assigning all the data flowing from one place to another matching names, so the system knows that the info marked as tax_class in the XML node relates to the information marked taxclass in WooCommerce.
By clicking on Product Variation underneath the different settings tabs, you can see another set of options:
This second set of XML nodes and WooCommerce attributes works the same as the first; use the dropdown to make sure the correct data is applied to the correct attribute.
Similar to other settings tabs, most of this will be handled by Modern Retail during your onboarding process.
Next under Settings is the Categories tab.
Again, like other settings tabs, most of this will be filled out during the onboarding process, and you probably won't have to touch it again.
After the Categories tab is the Brands tab, which is where the settings concerning how the integrator handles brands are.
Similar to the Mapping and Categories pages, there's a textbox for identifying the relevant XML node. Like most things in the settings page, you likely won't have a reason to touch this after the onboarding process.
We're almost halfway through the Settings page! The Corrector page is, as one might guess, another place that you won't have to worry about after the onboarding process.
Similar to the Mapping section, you can select between Variable Product and Product Variation at the top, underneath the settings tabs.
Now that we're out of the XML node forest, it's time for the Simple Product tab. Similar to the Mapping and Corrector sections, the Simple Product tab has two pages to look at, ProductFamily and ProductItem.
This page is where you select which nodes from ProductFamily and ProductItem you want to map. As per usual, you won't have to worry about this after your initial onboarding process, Modern Retail has you covered.
The Update tab is where you can update or add new XML nodes to the system. As with most things in the Settings section, you probably won't have to interact with it.
Select the appropriate IntegrationID, type out the XML node, and then hit Save Changes to add new nodes.
The API section is where you can find the API key. This is used to give certain applications access to your site, and should not be given out. Check with Modern Retail or your IT department before using your API key anywhere.
The Middleware API tab lets you enable different features from the middleware, like gift cards, loyalty, or in-store pickup. We recommend not changing anything on this page after the onboarding process.
The In-Store Pickup tab is where you can enable or disable In-Store Pickup features on your site.
Similar to the In-Store Pickup tab, the Gift Card tab is where you can enable or disable the gift card feature.
Underneath Settings in the WooCommerce Integrator sidebar is Support.
The support page has a link to the Help & Resource Center, and a link to the page for submitting new support requests. If you're ever confused about something in WooCommerce, please feel free to use either resource.
Underneath Support is the View Log page.
The View Log page is where you can see a record of everything the integrator has done.
By default the log shows things in chronological order, from most recent to oldest. The Time is displayed on the left, next to the Type Log. These are followed by the Job ID, Type, Message, File, and Line, in that order.
Above the grid displaying the data you can see a set of options for sorting through everything in the log. You can sort by the Type Log and the Type, or simply search for a specific Job by its Job ID.
Underneath View Log is View Job.
The View Job page shows a complete list of all the jobs the integrator has performed.
You can click Clear Jobs to reset this record. You can also click on View Logs for any given job in this list to be taken to the View Log page, automatically filtered to only show results pertaining to that job.
We're almost done! Second to the bottom in the WooCommerce integrator sidebar is the Scripts page.
The Scripts page has an option to reset the integrator plugin, and another option to resync variable product stock status.
If you click on the Woo Version >=3 tab, it should display a screen like this:
If it displays something else, please get in touch with Modern Retail support.
The Search by SKU tab allows you to search through your products by their SKU.
Enter the SKU you're searching for in the SKU box, and then click Check to perform a simple search for products.
You can click on the Strict checkbox to narrow your search results to only what you have entered in the SKU box. So, for example, in the above screenshot we searched "PANTS", which brought up "PANTS", but also "PANTS|BLACK|30". If we check the Strict checkbox, instead we get this:
The Show Metadata checkbox will display the metadata for anything that comes up in the search. That looks like this:
Lastly, you can click the Show Variations checkbox for all the possible variations of a product to be shown in this search. SImilar to the metadata column, this can be a lot of data:
Finally done! The Requirements page is the last thing under the WooCommerce Integrator sidebar. It displays a list of conditions we want your site to meet for the integrator to work properly.
You can mostly leave this page alone; if something is going wrong with your site, we may use this to check and see what that is, but otherwise feel free to ignore it.
This was the entire WooCommerce Integrator! If you have any questions, please feel free to submit a support request.