PLEASE READ THIS MANUAL BEFORE INTEGRATING MAGENTO WITH THE POS APPLICATION TO ENSURE THE SYNCHRONIZATION PROCESS RUNS SMOOTHLY.
A copy of this manual is attached, including screenshots for use as a visual reference.
1. About This Manual
• Any navigation or features mentioned in this document might be obsolete based on latest upgrades to both the POS and Magento software.
2. Requirements
The below set up is required before enabling and using this integration:
- A Magento E-Commerce account and storefront site
- A Marketplace subscription to POS Back Office (BO)
3. Magento Admin Side
Generate API Keys
• API Keys enable POS BO access and manipulate data from the Magento Site
- Log in to your Magento.com. Select the System (gear) button at the bottom of the left navigation panel, then under Extensions select Integration.
- On the Integrations page, select Add New Integration. The Basic Settings screen appears.
- For Integration Info, enter a Name and Password and then select the API tab.
- On the Available APIs page: for Resource Access, select ALL from the dropdown then click Save.
- On the Add New Integrations page. Click Activate for the Inactive API(s), then Allow, for it to generate the keys.
- After allowing the API(s), the following keys are generated and the key values are to be placed in POS applications.
Host Base URL
The Site ID for a current Site can be obtained from the site URL in your browser. For example, the Site ID appears after the /dashboard/ part of this URL.
Store Code
The Store Code is available by selecting the Stores option on the left side navigation panel, then selecting All Stores.
Upon clicking All Stores, the Store Code will be available at the bottom-right of the screen. That code must be placed in the Integrations Settings page of the POS application.
4. POS Marketplace
Subscribe to Magento Integration
Select Marketplace from the left-side navigation. Select Browse and Subscribe Integrations then select the Magento integration.
Configure Magento Integration
- Go to the Configurations / Manage Integrations page. For the Magento row, click on the Settings (gear) button under Actions to configure the integration.
- Paste the values of the mandatory fields from the previous step. Once all mandatory fields are filled in and confirmed, click Save at the bottom-right.
5. Push Products and Inventory Data to the Magento Site
- Before you sync for the first time, ensure your Products/Items and Inventory are updated.
- You can take 3 actions from the Action tab towards Magento Integration.
- Sync Categories - Sync newly created Categories.
- Sync Products - Sync newly created Products and tag the Products under the corresponding Categories.
- Sync Stocks - Update the Inventory count of all the products that are already synced with Magento. The button can be clicked at any time to sync the latest Stock count with Magento. Stock count will be automatically synced with Magento site on POS during sale and inventory adjustments.
6. Online Orders
Online Orders placed through Magento storefront and Magento admin portal will be pulled every 15 minutes and displayed under the Online Orders section in POS (Sale History > Online Orders). Inventory will be updated with stock count based on the items and its quantity in the order.
- You can mark an order Completed if the Order is executed.
- You can mark it Cancelled if the Order will not be executed (which reverts to the previous inventory count).