This is a Magento app for integrating with Reverb's API including product sync (magento->reverb) and order sync (reverb->magento). Please note that this extension is independent and separate from the Reverb Magento 1.x plugin, which was developed by a different 3rd party team.
While this plugin can and does work out of the box for many sellers, it is intended as a base for you to customize for your own magento usage. It is only tested on Magento Community 2.2.3. Enterprise Edition customers are advised to have their own developers evaluate and customize the plugin for usage.
Please read this entire README prior to installing the application.
- Create new draft listings on Reverb from Magento products, including image & category sync
- Control whether price/title/inventory syncs individualy.
- Sync updates for inventory from Magento to Reverb.
- Sync orders from Reverb to Magento
- Sync shipping tracking information from Magento to Reverb
- Configurable products - children are synced as individual listings on Reverb
- Make/model/price/finish/year/shipping_profile_name can be mapped to attributes in your magento installation
If you need help with your Magento install or integration of this plugin with your Magento instance, please contact these independent consultants for support. Please note that Reverb does not manage these relationships or support the plugin directly.
Github: kevinecd
Email: [email protected]
The Reverb sync runs on a cron (magento's scheduler) that's set to every minute for product syncs and every two minutes for order syncing. This is done so that when you save a product we won't interfere with your normal magento functions, and do all the sync in the background.
However the design of Magento's cron means that other cron-based plugins that take a long time to run may interfere with each other. Reverb generally finishes its work in seconds, but we have seen plugins that can take many minutes to run, or even crash, preventing plugins like Reverb from finishing their work.
If you're continuing to have cron issues, please install Reverb on a fresh magento instance without any other plugins as a test. If that works, the problem is with one of your other plugins. Please ensure you have no error messages in your cron and php logs prior to contacting Reverb Support.
Make & Model are guessed from the title unless you map those fields. Use the configuration screen (Stores->Configuration->Reverb Configuration) to map make/model fields to attribute fields in your Magento installation. If you don't have structured make/model fields, we will attempt to guess them from the title, but this is not reliable.
If you don't already have make & model fields in your magento installation, you can add them by using the Stores->Product section to add two new fields (for example, "reverb_make" and "reverb_model"). Then go to Stores->Attribute Set and add those fields into your default attribute set so they appear on every product. Finally, go to Stores->Configuration->Reverb Configuration and map the make and model fields to your newly created fields. You can do the same for other reverb attributes such as finish/year/shipping_profile_name
- Set up a Reverb Shipping Profile with free shipping ($0), called "Free Shipping".
- Add a magento attribute for reverb_shipping_profile from Stores->Product. Set a default value of "Free Shipping" (corresponding to the profile you created in step 1).
- Add a mapping from Shipping Profile to your newly created attribute in the Stores->Configuration->Reverb Configuration screen.
Please follow the instructions below to download and install the app. This assumes you have shell access to your server. If you have only FTP access, please download and unzip the app into /path/to/magento/app/code/
Command Line instructions below require update pending home repo.
Note: When running commands in Magento2 please make sure you are located in the magento directory and logged in as the magento user
# Navigate to your magento root folder
cd /path/to/magento
# Download the release
cd /tmp && wget https://github.com/reverbdotcom/reverb-magento-2/archive/1.0.8.tar.gz
# Unzip the release
tar zxvf 1.0.8.tar.gz
# Copy everything from the app folder into your magento app
rsync -avzp reverb-magento-2-1.0.8/* /path/to/magento/app/code/
# Enable All Reverb Modules
php bin/magento module:enable Reverb_Base
php bin/magento module:enable Reverb_Io
php bin/magento module:enable Reverb_Payment
php bin/magento module:enable Reverb_Process
php bin/magento module:enable Reverb_ProcessQueue
php bin/magento module:enable Reverb_Reports
php bin/magento module:enable Reverb_ReverbSync
php bin/magento module:enable Reverb_Shipping
# Update Magento 2 databse
php bin/magento setup:upgrade
# Clear your cache
php bin/magento cache:flush
php bin/magento cache:cleanThe following change needs to be made in this core file:
/vendor/magento/framework/DataObject/Copy/Config/Converter.php on line 41
Find line 41 in above file, should look like following code:
$fieldsetName = $fieldset->attributes->getNamedItem('id')->nodeValue;
$result[$fieldsetName] = $this->_convertFieldset($fieldset);
Replace those lines with the following:
if($fieldset->attributes->getNamedItem('id')){
$fieldsetName = $fieldset->attributes->getNamedItem('id')->nodeValue;
$result[$fieldsetName] = $this->_convertFieldset($fieldset);
}
Note: This is a temporary solution, follow this issue for updates on this fix.
The cron is used to process the listing syncing queue. To see what's in your crontab, run crontab -l. Please ensure that your crontab contains one of the following examples:
* * * * * /usr/bin/php /path/to/magento/bin/magento cron:run | grep -v "Ran jobs by schedule" >> /path/to/magento/var/log/magento.cron.log
* * * * * /usr/bin/php /path/to/magento/update/cron.php >> /var/www/magento2/var/log/update.cron.log
* * * * * /usr/bin/php /path/to/magento/bin/magento setup:cron:run >> /var/www/magento2/var/log/setup.cron.logor
* * * * * /usr/bin/php /path/to/magento/bin/magento cron:run | grep -v "Ran jobs by schedule" >> /path/to/magento/log/magento.cron.logIf your crontab does not contain either of these examples, please use crontab -e to edit it and copy the second line (cron.sh) into your crontab.
- In Magento Admin, go to Stores -> Configuration -> Reverb Configuration
- Put in your API Key (grab it from https://reverb.com/my/api_settings)
- Select Yes for Enable Reverb Module to turn on the sync
- If you also want to create drafts for skus that don't exist on Reverb, select "Enable Listing Creation" in the Reverb Default section.
The listing sync to Reverb can be triggered in two ways:
-
When you Save any Product in Magento, it will automaticaly sync to Reverb. Make sure you set "Sync to Reverb" to "Yes" on the bottom of the product page, and enable the Reverb Module in your global settings (see Part 3 of installation).
-
Bulk Sync. Under the Reverb menu item, navigate to the Listings page. On the top right of this page, click the button "Sync All Products". Please note that very large catalogs (thousands of skus) may take an hour or more to fully sync. Please refresh the page to see the sync report, which will populate once the process is complete.
After you have synced your products, go to the Image Sync page. Click "Sync All Images" to intiate the image sync process. Refresh the page to see the sync report.
Orders are automatically synced on a five minute cron timer. If you aren't seeing orders, please visit the Order Sync tab under Reverb and click the 'Download and Process Order Updates' button to manually sync them. If you are experiencing any issues with periodic syncing please create a new issue.
The integration is grabbing all orders placed from Reverb in the past 24 hours. Each grab will get duplicate orders, which leads to the same orders populating the task feed on each request. Despite orders appearing in the task feed multiple times they cannot be processed twice. Even if the same order is processed multiple times it will not be duplicated and will only appear once under Sales -> Orders.
To process your orders, go to the Reverb -> Order Updates page and click on "download and process order updates." This will populate orders into your sales page.
To see your Reverb specific orders navigate to Sales -> Orders. In your search bar type in 'reverb' to display all reverb related orders.
When clicking on an order you can assign it to the desired store (or click "Run automatic assignation"). You can also click on "Ship" to input shipping information and complete the order.
To verify that the shipment has synced, navigate to Reverb -> Shipment Tracking to verify that the shipment has synced to Reverb (or the reverse if marking your shipment on Reverb)
Note: if orders will not complete OR if you receive an error message when using manual download/processing buttons please refer to the final item in the troubleshooting section, "Can't create invoice / paypal won't work / can't add item to cart / Order sync will not complete"
- Orders are synced only 24 hours into the past if you just installed the extension and want to sync older orders, please edit the file at app/code/Reverb/ReverbSync/Helper/Orders/Retrieval/Update.php and change MINUTES_IN_PAST_FOR_CREATION_QUERY to the number in minutes you want to go into the past. For 3 days, use 3 * 60 * 24 = 4320
You can select whether to sync all orders (including unpaid accepted offers) or only orders awaiting shipment, via the settings screen
The bulk sync uses multiple threads (runs in parallel). It takes some time to spin up, so it may appear that nothing is happening for approximately 1 minute until your cron runs and starts picking up the jobs.
- First, check the cron log in /path/to/magento/htdocs/var/log/cron.log
- Enable logging.
- Let the cron run again (wait a minute), then check logs
tail -f /path/to/magento/htdocs/var/log/*
Please make sure you've cleared your magento cache.
Change needs to be made in this core file:
/vendor/magento/framework/DataObject/Copy/Config/Converter.php on line 41
Find line 41 in above file, should look like following code:
$fieldsetName = $fieldset->attributes->getNamedItem('id')->nodeValue;
$result[$fieldsetName] = $this->_convertFieldset($fieldset);
Replace those lines with the following:
if($fieldset->attributes->getNamedItem('id')){
$fieldsetName = $fieldset->attributes->getNamedItem('id')->nodeValue;
$result[$fieldsetName] = $this->_convertFieldset($fieldset);
}
Note: updating core files is not recommended. This is a temporary solution, follow this issue for updates on this fix.
Please use the issue tracker in this repository if you require any support. Click the "Watch" button for this repository if you would like be be notified of updates.
- Fork it
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create new Pull Request
Copyright 2017 Reverb.com, LLC
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.