Adobe Commerce

The Adobe Commerce module, located in the Integrations group, is an add-on module that can be installed from the Plugin module. After installing the plugin, a new module is added that integrates with Adobe Commerce (previously called Magento). Additional connections can also be purchased to connect to multiple Adobe Commerce accounts.

Install

The documentation on this page is for the most recent version of the Adobe Commerce plugin. To get the most recent version, Update Fishbowl.

1. In any Fishbowl Client, open the Plugin module, located in the Integrations group.
2. Select the Adobe Commerce plugin and click Install.
3. Completely close all Fishbowl Clients.
4. Exit the Fishbowl Server by right-clicking the Fishbowl Server tray icon and selecting Exit.
5. After re-opening the Fishbowl Server, the admin user can access the Adobe Commerce module from any Fishbowl Client by opening the Integrations group.
6. To grant access to additional users, assign the Adobe Commerce-View access right to the appropriate groups in the User Group module.

Setup

Complete the steps below to configure the Adobe Commerce integration.

1. Copy your Store URL. This is typically found in your Adobe Commerce account under Stores > Configuration > Web
   
2. Click the Settings button on the module toolbar of the Adobe Commerce module.
3. Paste the Store URL and enter the Username, and Password.
   
4. Click the Test Connection button and verify that the connection to the Adobe Commerce website is working.
5. Click the Save button at the bottom of the window to save the Adobe Commerce settings.

TABS

Several plugins in Fishbowl have a standardized layout. Some of the images below show the options that are most common between all plugins. Any additional Adobe Commerce options or notes are included at the bottom of each section.

Order Import

• Schedule - Select the Active checkbox to import orders on a set schedule. Click the Run task button to run the scheduled task right now. Data that has changed since the Last Sync date will be synchronized. This date will be updated automatically after a sync, or it can be manually edited to adjust which data will be synchronized. If additional options are available, they can be enabled by selecting Use Advanced Options at the bottom of the Schedule section.
  

Order Settings

Additional order data will be imported and displayed on the Details tab of the Sales Order module.

• Order field mapping - Use the mapping table to map Adobe Commerce order fields to Fishbowl order fields. If no field is mapped to the Fishbowl Order Number, then it will be generated by Fishbowl. If no date field is mapped to the Fishbowl Date Scheduled, then it will be set to the date of import.
• Salesperson - Sales orders will be created using this salesperson.
• Accounting Class - If there is no class mapped from Adobe Commerce, sales orders will be created using this class as the sales order class.
• Payment Terms - If there are no payment terms mapped from Adobe Commerce, sales orders will be created using this payment term.
• Shipping Terms - If there are no shipping terms mapped from Adobe Commerce, sales orders will be created using these shipping terms.
• Priority - The default priority to be set on imported orders.
• Use customer properties - Pull customer properties to the order such as salesperson, class, payment terms, shipping terms, and priority. If available, these will override the default values selected above.
• Order Number Prefix - Define a short prefix that will be applied to the imported order numbers. The prefix will not be added if the Fishbowl Generated SO Number is being used as the order number.
• Discount Item - Select the flat rate discount type that will be added as a line item to imported orders.

Additional Adobe Commerce information

• Import channel discounts as separate line items - Enabling this option will import all line item discounts separately and apply them to the specific line item they are associated with.
• Import channel discounts as combined line items - Enabling this option will sum all line item discounts and apply them as one combined order discount.
• Import channel discount code(s) to line item note - Enabling this option will add the channel discount code to the line item notes.
• Remove Adobe Commerce Order Number Prefix '#' - When selected, Adobe Commerce order numbers will not have a '#' prefix when imported into Fishbowl.
• Use store filtering - Orders will only be imported for the stores listed in the {{{1}}} store filter table.

Order Item Settings

• Item field mapping - Use the mapping table to map Adobe Commerce order item fields to Fishbowl order item fields. If the Fishbowl price is not mapped, then the price from the Fishbowl product will be used and any applicable pricing rules applied. If the Fishbowl description is not mapped, then the description from the Fishbowl product will be used.
• Shipping item - Select the shipping type product that will be added as a line item to orders when applicable. It will contain the shipping price to be paid by the customer.
• Ignore miscellaneous items - If this option is selected, Adobe Commerce order items that are not related to an actual Adobe Commerce product record will be ignored and no Fishbowl line item will be created.
• Enable order import product linking - Adobe Commerce order items will be matched to Fishbowl products based on the defined field mapping. If the Adobe Commerce product has been linked by ID to a Fishbowl product, that will take precedence.

• Product field - The Fishbowl product field that will match the selected Adobe Commerce item field.
• Adobe Commerce item field - The Adobe Commerce order item field that will match the selected Fishbowl product field.

Additional Adobe Commerce information

• Ignore shipping amount - Enabling this option may lead to order disparities for totals and payments.

Order Status Settings

Use the table to assign Adobe Commerce order statuses to Fishbowl order statuses. The Order Import task will only import orders from Adobe Commerce that are in a status assigned to a Fishbowl order status. If the Fishbowl order status is set to Historical, the order will be imported into Fishbowl, but it will not affect inventory or accounting. At least one active status mapping is required to use the Order Import task.
The plugin supports the following Adobe Commerce order statuses: Pending, Processing, Complete, On Hold

Location Group Settings

• Use default location group - Select a default location group for imported orders.
• Use order ship-to state mapping - This option allows orders to be imported into Fishbowl Location Groups according to the ship-to state. If the state is not mapped to a location group, the default location group specified above can be used.
• Use order carrier mapping - This option allows orders to be imported into Fishbowl Location Groups according to the shipping carrier. If the carrier is not mapped to a location group, the default location group specified above can be used.
• Use location group class as order class - This option will set the class for the order to the location group's class.
• Use order extended attribute mapping - This option can be used if you have a custom Adobe Commerce developer create a custom extended attribute called shipping_from referencing a value from the Inventory Sources/Locations in Adobe Commerce. The plugin will then use the value to map to Location Groups if the Source exists in the mapping. Additional information is available by contacting the Fishbowl Plugins Support team.

Customer Settings

Use the options below to determine how customers are created in Fishbowl and what information is imported into Fishbowl.

• Enable multi-currency settings - Order prices will be converted from the channel order currency to the Fishbowl currency assigned to the mapped customer. Requires Fishbowl currency conversion to be enabled.
• Enable advanced mapping settings - Opens up additional customer mapping options and control over customer creation.
• Use a default customer for all orders - This option will associate all imported sales orders with the customer selected in the Customer field. This could be used with a generic Fishbowl customer such as Adobe Commerce Customer.

• Use order billing address - Use the billing address from the Adobe Commerce order instead of the address for the default customer.
• Use order shipping address - Use the shipping address from the Adobe Commerce order instead of the address for the default customer.

• Use the order customer and addresses - This option will import the addresses and customer from the Adobe Commerce order instead of using a generic customer.

• Field - Select the Adobe Commerce field that contains the customer name that should be imported into Fishbowl.
• Alternate Field - An alternate field mapping when the primary mapping does not contain data.

Address Settings

• Ship to address mapping - Use the table to choose which Adobe Commerce fields are imported into the Fishbowl Ship To Name and Street Line fields.
• Bill to address mapping - Use the table to choose which Adobe Commerce fields are imported into the Fishbowl Bill To Name and Street Line fields.
• Coalesce addresses - If one address is missing, use the existing address for both the shipping and billing address.
• Create missing states - Automatically create missing states.
• Mark addresses residential - Import all shipping addresses as residential.

Carrier Settings

​

• Use a default carrier - When selected, all orders imported from Adobe Commerce will use the selected carrier. If this option is unchecked, carriers can be mapped between Fishbowl and Adobe Commerce. Each mapping will also set the Sales Order Priority so that Fishbowl users can identify orders with express shipping that need to be picked and shipped quickly.
• Use carrier mapping - When selected, the table can be used to map carriers between Adobe Commerce and Fishbowl.

Additional Adobe Commerce information

Click here to see which carriers Adobe Commerce supports.

Follow the instructions below to map carriers between Adobe Commerce and Fishbowl.

1. Log into Adobe Commerce.
2. Click the Stores menu on the left, and then select Configuration.
3. In the Sales section on the left, click Shipping Methods.
4. Expand the desired shipping method, and copy the Title and Method.
   
   
   
5. Open the Carrier Settings section on the Order Import tab and then click the New button.
   
6. Enter the exact Title and Method into Fishbowl with the following format: Title - Method. Below are several examples.
   
   • Flat Rate - Fixed
   • Free Shipping - Free
   • United Parcel Service - Next Day Air
   • United Parcel Service - Ground
7. Select the corresponding Fishbowl Carrier Service, and then click the Save button.

Payment Settings

​

• Create payments in Fishbowl - When selected, payments from the Adobe Commerce transaction will be shown in the Payment Viewer module.

• Use a default payment method - When selected, all orders imported from Adobe Commerce will use the selected payment method.
• Use payment method mapping - When selected, the table can be used to map payment methods between Adobe Commerce and Fishbowl.
• Always create payments - If no payment data exists for the order from Adobe Commerce, this option will always create a payment in Fishbowl equaling the order total. If payment mapping is enabled, orders without payment data will show "None" as the payment method type.
• Remove taxes from payment - When selected, the tax amount will be deducted from the payment total.
• Remove shipping from payment - Enabling this option may lead to order disparities between Adobe Commerce and Fishbowl for totals and payments.
• Ignore international payments - Payments will not be created for orders placed outside the United States. This setting is only available if Use Currency Conversion is enabled in the Currency module.
• Currency - Select the currency type you accept in Adobe Commerce. This is a required setting if Use Currency Conversion is enabled in the Currency module.

Additional Adobe Commerce information

Follow the instructions below to map payment methods between Adobe Commerce and Fishbowl.

1. Log into Adobe Commerce using Google Chrome.
2. Click the Stores menu, and then select Configuration.
3. In the Sales section on the left, click Payment Methods.
4. Right-click the header of the desired payment method and select Inspect.
   
5. In the section highlighted by Chrome, copy the text between "payment_us_ and -head".
6. Open the Payment Mapping section on the Order Import tab, and then click the New button.
   
7. Enter the Adobe Commerce payment ID into Fishbowl. Below are several examples.
   
   • checkmo
   • cashondelivery
   • authorizenet
   • banktransfer
8. Select the corresponding Fishbowl Payment Method, and then click the Save button.

Tax Settings

• Import Taxes - When selected, the tax amount from the Adobe Commerce order will appear on the Fishbowl sales order as a flat rate line item. The flat rate amount can be set to $0 in the Tax Rate module and then the correct total tax amount will be set when the order is imported from Adobe Commerce. If taxes are not imported, the Fishbowl payment will equal the order total before tax.

• Use Default Tax Item - With this option selected, the same tax item will be used for all orders.
• Use State Tax Mapping - This option allows different tax items to be used based on the Ship To state/province. If this option is enabled, the plugin will give an error when trying to import an order with a state that has not been mapped.
• Use Fishbowl Tax - Select a Fishbowl tax rate that will be used to calculate the order tax in Fishbowl. Tax calculations done by Fishbowl may differ from those done in Adobe Commerce.
  • Import Adobe Commerce tax as line item note - Import the Adobe Commerce tax as a line item note in Fishbowl.

Tax rates can also be mapped using the Adobe Commerce product tax class ID as explained below. Adobe Commerce 2 does not have its own module to manage tax classes, which makes it a little more difficult to find the ID.

1. Open the Adobe Commerce Admin Dashboard in Google Chrome.
2. Click the Products menu on the left.
3. Click Catalog, and then click a product name.
4. Right-click the Tax Class name, and select Inspect. Then click the highlighted dropdown arrow to the left of the first highlighted line.
   
5. Some additional lines will appear at the bottom. Copy the value after the tax class name.
   
6. Click the Product Import tab of the Adobe Commerce module, and select Use product tax class mapping.
   
7. Click the Add button, enter the ID copied from Adobe Commerce, and select the Fishbowl tax rate.
   
8. Click the Save to close the dialog, and then click the Save button on the module toolbar.
   

Canada/Australia/International

When using the Adobe Commerce plugin with international versions of Fishbowl, some additional tax options are available in the Tax Settings section of the Order Import tab.

• Use product tax - When selected, the Tax Code from the General tab of the Product module will be used.
  
• Use province tax - When selected, the shipping province on the order will be used to determine the tax, based on the mapping table below.
  

Fulfillment Export

• Schedule - Select the Active checkbox to export orders on a set schedule. Click the Run task button to run the scheduled task right now. Data that has changed since the Last Sync date will be synchronized. This date will be updated automatically after a sync, or it can be manually edited to adjust which data will be synchronized.
• The Fulfillment Export task will export order fulfillment information to Adobe Commerce based on fulfilled Fishbowl sales orders.
• Update order status - When selected, Adobe Commerce orders will be updated after the product(s) on the order have been shipped in Fishbowl. Shipment tracking information will also be sent from Fishbowl to Adobe Commerce.
• Check order status - When selected, the Adobe Commerce order status will be checked prior to attempting to send fulfillment information. If the Adobe Commerce order status has changed, no fulfillment information will be sent. This will increase the time required to complete the order fulfillment task.
• Create invoice - If this option is selected, an invoice will be created for the order in Adobe Commerce.
• Omit tracking for listed carrier - The carriers added to the table will not export tracking details to Adobe Commerce.

Additional Adobe Commerce information

• If a carrier on an order is not an approved carrier by Adobe Commerce, it will be set to Custom Value.
• For a list of accepted carriers, please see Carriers.
• The plugin supports Adobe Commerce Pickup Delivery orders, which can be identified by mapping Adobe Commerce In-Store Pickup Delivery to Fishbowl Will Call or a similar carrier.

Product Import

• Schedule - Select the Active checkbox to import products on a set schedule. Click the Run task button to run the scheduled task right now. Data that has changed since the Last Sync date will be synchronized. This date will be updated automatically after a sync, or it can be manually edited to adjust which data will be synchronized.

  NOTE: When setting up the Adobe Commerce integration for the first time, you will want to adjust the Last Sync to a date before any of your products were created (for example, setting the year to 2000) so that all of the products on your website will be imported.

The Product Import task imports products into Fishbowl from Adobe Commerce. A product link is created by storing the Adobe Commerce product ID in Fishbowl.

• Link Existing Products will match existing products in Fishbowl and Adobe Commerce where data matches in the selected fields.
• Import Products will import products from Adobe Commerce into Fishbowl, creating them based on the field mapping and settings below.

Product Export

• Schedule - Select the Active checkbox to export products on a set schedule. Click the Run task button to run the scheduled task right now. Data that has changed since the Last Sync date will be synchronized. This date will be updated automatically after a sync, or it can be manually edited to adjust which data will be synchronized.
• Product Create Settings - Enable Export New Products and then map the fields that should be exported from Fishbowl to Adobe Commerce.
  • If the Weight UOM or Size UOM are specified, the Fishbowl product UOMs will be converted to the selected UOMs before the values are exported.
  • If the Product Tree Filter is used, only the products in the selected product tree category will be exported. If the product tree filter is left blank, all products will be included in the export.
• Product Update Settings - Enable Update Linked Products and then map the fields that should be exported from Fishbowl to Adobe Commerce. This section has the same options as the Product Create Settings section above. After the initial product export, only the selected fields will be updated.

Additional Adobe Commerce information

• Export Images - When selected, the Fishbowl product image will be exported to Adobe Commerce.

Inventory Update

• Schedule - Select the Active checkbox to export inventory levels to Adobe Commerce on a set schedule. Click the Run task button to run the scheduled task right now. Data that has changed since the Last Sync date will be synchronized. This date will be updated automatically after a sync, or it can be manually edited to adjust which data will be synchronized.

  NOTE: When setting up the Adobe Commerce integration for the first time, you will want to adjust the Last Sync to a date before any of your products were created (for example, setting the year to 2000) so that it includes all of your products (or any applicable product tree filter) when updating inventory levels.

• Export Company Wide Inventory - Include inventory quantities from all location groups in the inventory sync. If this option is unchecked, selected location groups can be added by clicking the Add button.
• Inventory Type - Select the inventory quantity that should be used during the update: Available For Sale, Inventory On Hand, or Available To Pick:
  • Available For Sale - The quantity available is calculated as On Hand - Allocated - Not Available + Drop Ship.
  • Inventory On Hand - The total amount of inventory in stock.
  • Available To Pick - Calculated as On Hand - Committed for inventory in locations that are marked as Pickable.
  • Available To Kit - In Fishbowl, kits are comprised of various inventory items, so the kit itself isn't displayed in the Inventory module. However, Fishbowl will always export an Available to Kit number to Adobe Commerce. The available quantity exported for kits will be the lowest available quantity for any of the items in the kit. For example, a Wheel kit may require 1 rim and 1 tire. If there are 100 rims available, but only 5 tires, then the quantity exported for the Wheel kit will be 5. The available quantity for a configurable kit will be the lowest available quantity for the default kit items.
• Product Tree Filter - The export can be limited to a specific product tree category. If this field is left blank, all products will be included in the export.
• Specify Min/Max Inventory Quantity - With this option enabled, the maximum inventory quantity sent to Adobe Commerce can be limited. For example, if there is an available quantity of 4000 in Fishbowl, the quantity in Adobe Commerce could be set to 999. If there is an available quantity of 3 in Fishbowl, the minimum quantity field could be used to send a quantity of 10 to Adobe Commerce.
• Include Quantities Available To Build - When enabled, this option calculates and includes available-to-build quantities from applicable bills of materials in the inventory update. When a product is sold individually but also used as an input for a bill of materials, both quantities are pushed to the channel when applicable. Please note, this could lead to overselling in the scenario described.

Additional Adobe Commerce information

• Adobe Commerce Inventory Source - To see the Adobe Commerce Inventory Source column, click the Settings button at the top of the Adobe Commerce module, and then select Import Store Data.

Troubleshooting

• Click the API Logs button at the top of the Adobe Commerce module to see the API calls and any errors that have been logged. You can leave the API Logs window open while you work in Fishbowl and click the Refresh button at the bottom of the window as needed. API logs can also be viewed in the Fishbowl/logs/plugins folder. Click Tools > Module Options to Disable REST logging.
• When more than one shipment exists for an order (partial fulfillment), the applicable tracking numbers are synced to Adobe Commerce, however this feature does not work for orders with kits.
• Only new orders are imported. Orders are not updated once they have been imported. Returns and refunds are not imported.
• The attributes and IDs for orders and products can be viewed or modified by clicking the Adobe Commerce button at the top of the Sales Order module and the Product module.
• To view the scheduled tasks for the Adobe Commerce module, open the Schedule module.
• A scheduled task can be run manually by double-clicking the task.
• Enter an email address in the Schedule module to receive error notifications.
• To view the history of a scheduled task, including the result/error, click the History button in the Schedule module.
• More details about recent errors can be viewed by opening the Data module and clicking the Server Log button.
• Check for multiple versions of the Adobe Commerce.jar file in C:\Program Files\Fishbowl\plugins\ or \Applications\Fishbowl\plugins\ on a Mac. If there are two Adobe Commerce versions, exit the Fishbowl Server and remove the older version on all client and server computers.
• Inventory sync uses the Adobe Commerce SKU instead of product ID.
• When syncing inventory, the Adobe Commerce Product Name will update if it has changed in Fishbowl.
• Product updates pushed from Fishbowl to Adobe Commerce will update in the Adobe Commerce database but may not display in the user interface correctly.
• If you update the SKU and other fields in Fishbowl, only the SKU field will be updated in Adobe Commerce.
• If you are getting a Failed to run scheduled task error, it is likely due to upgrading from Adobe Commerce 3.x to 4.x because of the layout change within the plugin. The following fix re-installs the plugin, which will require you to re-enter your store login information and import/export settings. Make sure to write that information down before proceeding with the following steps.

1. Open the Plugin module, and click the Uninstall button.
2. Restart the Fishbowl server.
3. Open the Plugin module, click the Install button, and then restart the Fishbowl server again.
4. Enter the store login information and the import/export settings, and then click the Save button.