{{Module Introduction|X-Cart|Integrations}} is an add-on module that can be installed from the {{Module|Plugin}}. After installing the plugin, a new module is added that integrates with one or more X-Cart shopping carts.

+

{{Module Introduction|X-Cart|Integrations}} is an add-on module that can be installed from the {{Module|Plugin}}. After installing the plugin, a new module is added that integrates with one or more X-Cart shopping carts. The X-Cart Plugin works on X-Cart 5.

+

+

{{IntroImage}}

−

The X-Cart Plugin works on X-Cart 5.

−

__TOC__

−

[[File:X-Cart.png|link=]]

{{Plugin Install|X-Cart|Integrations}}

{{Plugin Install|X-Cart|Integrations}}

−

== Setup {{top}} ==

+

==Setup==

−

[[File:X-Cart API.png|right|link=]] In order to connect to X-Cart, follow the instructions below to set the [http://kb.x-cart.com/en/modules/rest_api_documentation.html read/write API key].

+

[[File:X-Cart API.png|right]] In order to connect to X-Cart, follow the instructions below to set the [http://kb.x-cart.com/en/modules/rest_api_documentation.html read/write API key].

# Log in to the store administration page. This is typically the store URL followed by '''admin.php''' (for example, '''xcart.mystore.com/admin.php''')

# Log in to the store administration page. This is typically the store URL followed by '''admin.php''' (for example, '''xcart.mystore.com/admin.php''')

Line 16:

Line 15:

# Click the '''Test Connection''' button in the {{Module|X-Cart}} to verify that the connection is valid and then click '''Save'''.

# Click the '''Test Connection''' button in the {{Module|X-Cart}} to verify that the connection is valid and then click '''Save'''.

−

Multiple X-Cart carts can be configured by clicking the {{Button|New}}, which will add another '''X-Cart''' tab.{{Clear}}

+

Multiple X-Cart carts can be configured by clicking the {{Button|New}}, which will add another '''X-Cart''' tab.

−

== Mapping {{top}} ==

−

The table below shows some of the data that transfers between X-Cart and Fishbowl.

+

==Mapping==

+

+

The table below shows how data transfers between X-Cart and Fishbowl.

{| class="prettytable"

{| class="prettytable"

Line 62:

Line 62:

|}

|}

−

= TABS =

+

=TABS=

{{H2|Settings}} [[File:X-Cart Settings Tab.png|right]]

{{H2|Settings}} [[File:X-Cart Settings Tab.png|right]]

−

* '''Email''' - The email address to notify regarding integration information. Failed schedules will send an email to this address. Email can be configured on the {{ModuleTab|Company|Email}}.

+

* '''Email''' - The email address to notify regarding integration information. Failed schedules will send an email to this address. Email can be configured on the {{ModuleTab|Settings|Email}}.

* '''Shipping Terms''' - When selected, sales orders will be created using these shipping terms.

* '''Shipping Terms''' - When selected, sales orders will be created using these shipping terms.

* '''Location Group''' - Sales orders will be created using this location group. This field is required.

* '''Location Group''' - Sales orders will be created using this location group. This field is required.

−

{{Cart Customer}}

+

{{Cart Customer Detail}}

* '''SO Status''' - Orders can be imported as an estimate or issued status.

* '''SO Status''' - Orders can be imported as an estimate or issued status.

*{{anchor|Tax Item}}'''Tax Item''' - Tax rate item for the total tax amount from X-Cart. Can only specify a flat rate tax. If the list is empty, [[Tax_Rate#Add_a_tax_rate|create a flat rate tax]] to be used with X-Cart. The flat rate amount can be set to $0 in the {{Module|Tax Rate}}, and then the correct total tax amount will be set when the order is imported from X-Cart.

*{{anchor|Tax Item}}'''Tax Item''' - Tax rate item for the total tax amount from X-Cart. Can only specify a flat rate tax. If the list is empty, [[Tax_Rate#Add_a_tax_rate|create a flat rate tax]] to be used with X-Cart. The flat rate amount can be set to $0 in the {{Module|Tax Rate}}, and then the correct total tax amount will be set when the order is imported from X-Cart.

After an order has been fulfilled in Fishbowl, the order will be marked as '''Completed''' in X-Cart on the next export. The shipment tracking number will also be exported from Fishbowl to X-Cart.

+

{{Order export}}

−

{{Schedule|export orders}}

{{Schedule|export orders}}

Line 107:

Line 106:

* '''Location Group''' - When selected, the [[Inventory#Inventory_status_terms|Available For Sale]] inventory quantity will be used from this location group only. If left blank, the quantity from all location groups will be used.

* '''Location Group''' - When selected, the [[Inventory#Inventory_status_terms|Available For Sale]] inventory quantity will be used from this location group only. If left blank, the quantity from all location groups will be used.

−

{{Clear}}

+

=Troubleshooting=

−

= Troubleshooting =

+

{{Cart Troubleshooting|{{PAGENAME}}}}

−

{{Cart Troubleshooting}}

+

+

=Release Notes=

+

{{HideH2|2019.6.0X – 6-18-2019 - Fishbowl 2019.5}}

+

* Compatibility updates

+

{{HideH2|2019.5.0X – 5-10-2019 - Fishbowl 2019.5}}

+

* Compatibility updates

+

{{HideH2|2019.4.01 – 4-11-2019 - Fishbowl 2019.4}}

+

* Compatibility updates

+

{{HideH2|2019.3.01 – 3-14-2019 - Fishbowl 2019.3}}

+

* Compatibility fixes for 2019.3 version of Fishbowl

+

* Fixed bug when QB class setting was not being applied to regular products in orders

+

* Fixed bug where plugins first loading into a new database displayed pop up windows that should not be there

+

* Multi-currency support for orders and payments created from the channel. Multi-Currency must be turned on in FB

+

* With multi-currency enabled there is an option to not create payments for international orders

+

* Fixed bug for when discount item field was left blank and saved, causing null errors

+

* Added tracking to shipments on FB for fulfilled orders

+

* Fixed bug where UI issue did not allow some order import setting panels to be seen

Latest revision as of 21:20, 25 June 2019

The X-Cart 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 one or more X-Cart shopping carts. The X-Cart Plugin works on X-Cart 5.

TABS

Settings

Email - The email address to notify regarding integration information. Failed schedules will send an email to this address. Email can be configured on the Email tab of theSettings module.

Schedule Import Order

Orders will only be imported from X-Cart if they have a Paid payment status, and a New shipping status.

Schedule - Select the Active checkbox to import orders on a set schedule. Click the Schedule 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.

Salesperson - Sales orders will be created using this salesperson. This field is required.

Carrier - Sales orders will be created using this carrier.

Payment Terms - When selected, sales orders will be created using this payment term.

Payment Method - Sales orders will be created using this payment method. This field is required.

Shipping Terms - When selected, sales orders will be created using these shipping terms.

Location Group - Sales orders will be created using this location group. This field is required.

Customer - When selected, sales orders will be created using this customer for every order.

If left blank, a customer will be created in Fishbowl with the customer information from the shopping cart.

Alternatively, create a generic/web customer in Fishbowl that will be used for all imported orders. In this case, the billing/shipping name and address will still be imported for each order.

SO Status - Orders can be imported as an estimate or issued status.

Tax Item - Tax rate item for the total tax amount from X-Cart. Can only specify a flat rate tax. If the list is empty, create a flat rate tax to be used with X-Cart. 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 X-Cart.

Class - When selected, sales orders will be created using this class as the sales order class.

Shipping Item - Sales orders will be created using this product as the default shipping item.

Discount Item - Discount item for the order discount amount from Shopify. Can only specify a flat rate discount.

Use store order number as SO Number - When selected, sales orders will be created using the X-Cart order number as the Fishbowl sales order number.

Schedule Export Order

Fishbowl can update the order in the shopping cart after items are fulfilled in Fishbowl. The shipment tracking number will also be exported to the shopping cart.

Schedule - Select the Active checkbox to export orders on a set schedule. Click the Schedule 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.

Schedule Products

When pulling products to Fishbowl, the product sync should usually be scheduled to run before the order import. This will avoid any errors caused by new products that need to be imported before the order can be created in Fishbowl.

Schedule - Select the Active checkbox to sync products on a set schedule. Click the Schedule 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.

Fail when missing SKU - When selected, the sync will log products with missing SKUs as errors.

Weight UOM - The UOM for weight on products. This should match the UOM set in store settings on your X-Cart shopping cart.

Pull products to Fishbowl - When selected, products created in X-Cart will be created in Fishbowl.

Schedule Inventory

Schedule - Select the Active checkbox to sync inventory on a set schedule. Click the Schedule 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.

Location Group - When selected, the Available For Sale inventory quantity will be used from this location group only. If left blank, the quantity from all location groups will be used.

Troubleshooting

The attributes and IDs for orders and products can viewed or modified by clicking the X-Cart button at the top of the Sales Order module and the Product module.

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 X-Cart.jar file in C:\Program Files\Fishbowl\plugins\ or \Applications\Fishbowl\plugins\ on a Mac. If there are two X-Cart versions, exit the Fishbowl Server and remove the older version on all client and server computers.

Release Notes

2019.6.0X – 6-18-2019 - Fishbowl 2019.5

Compatibility updates

2019.5.0X – 5-10-2019 - Fishbowl 2019.5

Compatibility updates

2019.4.01 – 4-11-2019 - Fishbowl 2019.4

Compatibility updates

2019.3.01 – 3-14-2019 - Fishbowl 2019.3

Compatibility fixes for 2019.3 version of Fishbowl

Fixed bug when QB class setting was not being applied to regular products in orders

Fixed bug where plugins first loading into a new database displayed pop up windows that should not be there

Multi-currency support for orders and payments created from the channel. Multi-Currency must be turned on in FB

With multi-currency enabled there is an option to not create payments for international orders

Fixed bug for when discount item field was left blank and saved, causing null errors

Added tracking to shipments on FB for fulfilled orders

Fixed bug where UI issue did not allow some order import setting panels to be seen