1. ShippingEasy
  2. Integrations Guides
  3. Stores T-Z

X-Cart

Avatar

ShippingEasy Content Team

Updated

X-Cart is an ecommerce marketplace that specializes in helping offline sellers bring their stores online. Our partners at X-Cart have built plugins that provide support for using X-Cart with ShippingEasy. After you install a plugin on your X-Cart server, you will also add an X-Cart store into your ShippingEasy settings. When an order is entered on your X-Cart store, the plugin for ShippingEasy will connect to the ShippingEasy application and send the order details to your ShippingEasy account.

X-Cart Integration Requirements

Connection Requirements:

  • You must have a live account with X-Cart.

  • X-Cart 4 (v4.4.0 and higher) and X-Cart 5.3 are both supported.

Create Shipment Requirements:

  • Shipment and tracking information will not be sent from ShippingEasy to X-Cart if your store website uses HTTP instead of HTTPS. ShippingEasy can only send shipment information back to an X-Cart store if the website is running on HTTPS.

Connect X-Cart to ShippingEasy

Our partners at X-Cart have built integrations to ShippingEasy that you can use with either X-Cart v4 or X-Cart v5.  The steps for installing and configuring vary depending on your version of X-Cart.

If you are using X-Cart v4, this article from X-Cart shows how to install the plugin in X-Cart. To complete the integration, read the X-Cart article on integrating your X-Cart plugin with ShippingEasy.

Integrate X-Cart v4 with ShippingEasy

If you are using X-Cart v4, this article from X-Cart shows how to install the plugin in X-Cart. To complete the integration, read the X-Cart article on integrating your X-Cart plugin with ShippingEasy.

It is not necessary to add a rewrite rule into the .htaccess file, as outlined in Step 7 of the integration guide from X-Cart.

Integrate X-Cart v5 with ShippingEasy

If you are using X-Cart v5, installation of the plugin in X-Cart is simple.

  1. Log into your X-Cart store and search for ShippingEasy in the Modules Marketplace.

    201401969-1.png

  2. Click the Install option to install the ShippingEasy plugin.

    201480925-2.png

  3. The final step is to integrate the X-Cart plugin with ShippingEasy.

Support for Connecting X-Cart and ShippingEasy

If you run into any problems, feel free to reach out to the X-Cart Support team or ShippingEasy's Customer Success team.

X-Cart is your best resource for questions related to the X-Cart configuration of the integration. Submit a support ticket to X-Cart.

X-Cart Order Data

X-Cart Standard Data Supported

ShippingEasy's X-Cart integration supports the following features and order data fields:

Key: Green checkmark. Supported feature. Yes. = Supported; Red X mark. Unsupported feature. No. = Not Supported; Grey dash icon. Not applicable. = Does Not Apply

Common Integration Features

Feature

Supported?

Custom Statuses

Red X mark. Unsupported feature. No.

Customer Emails

Green checkmark. Supported feature. Yes.

Customer Phone Numbers

Green checkmark. Supported feature. Yes.

Requested Service

Red X mark. Unsupported feature. No.

Payment Method

Red X mark. Unsupported feature. No.

Discounts

Red X mark. Unsupported feature. No.

Identifies Gift Orders

Green checkmark. Supported feature. Yes.

Internal Notes

Green checkmark. Supported feature. Yes.

Customer Notes

Red X mark. Unsupported feature. No.

Combine Orders

Red X mark. Unsupported feature. No.

Split Orders

Green checkmark. Supported feature. Yes.

Product Details

Feature

Supported

Item SKU

Green checkmark. Supported feature. Yes.

Item Name

Red X mark. Unsupported feature. No.

Item Weight

Red X mark. Unsupported feature. No.

Product Options

Green checkmark. Supported feature. Yes.

Item Warehouse Location

Red X mark. Unsupported feature. No.

Shipment Information Sent from ShippingEasy to X-Cart

In X-Cart v4, the carrier, service, tracking number, and shipping cost are displayed in the order detail as an order note that is not visible to your customer.

In X-Cart v5, the tracking number is displayed in the order detail screen.

This integration allows you to define the Status Mappings for the store connection.

ShippingEasy will import the customer's email address with the order and can send customer shipment confirmation and delivery emails, which are configured in your Store Settings.

ShippingEasy will import the customer's phone number.

ShippingEasy will import the shipping method chosen by the customer at the time of checkout.

ShippingEasy will import the payment method used to pay for the order.

ShippingEasy will import discount and coupon information for the order.

ShippingEasy can determine if an order was placed as a gift.

Notes and comments can only be viewed in ShippingEasy.

ShippingEasy will import notes left by the customer at checkout or added to the order once it has been imported to ShippingEasy.

ShippingEasy allows you to consolidate multiple orders from a customer when they go to the same address.

ShippingEasy can split an order to accommodate changes in stock, different shipping locations, or multiple packaging needs.

This integration allows you to define the Status Mappings for the store connection.

ShippingEasy will import the customer's email address with the order and can send customer shipment confirmation and delivery emails, which are configured in your Store Settings.

ShippingEasy will import the customer's phone number.

ShippingEasy will import the shipping method chosen by the customer at the time of checkout.

ShippingEasy will import the payment method used to pay for the order.

ShippingEasy will import discount and coupon information for the order.

ShippingEasy can determine if an order was placed as a gift.

Notes and comments can only be viewed in ShippingEasy.

ShippingEasy will import notes left by the customer at checkout or added to the order once it has been imported to ShippingEasy.

ShippingEasy allows you to consolidate multiple orders from a customer when they go to the same address.

ShippingEasy can split an order to accommodate changes in stock, different shipping locations, or multiple packaging needs.

Syncing X-Cart Orders to ShippingEasy

Unlike most ShippingEasy store integrations, X-Cart orders are not periodically read into your ShippingEasy account by the ShippingEasy application. Instead, orders are sent by your X-Cart store - in this case, specifically by the X-Cart plugin that supports ShippingEasy. The orders are sent as soon as they are entered, so there is no delay. Manually syncing your X-Cart store in ShippingEasy has no effect.

Order Statuses

There is a configuration option in the X-Cart plugin for ShippingEasy where you can specify the status that an X-Cart order must have before it is sent automatically.

In X-Cart v4, select Settings > ShippingEasy statuses. In this example, if an X-Cart order has a status of Processed, it will be automatically sent to ShippingEasy where it will have a status of Awaiting Shipment. Click the Add button to map another order status.

201639309-shippingeasy_statues_x_cart.png

In X-Cart v5, select Store setup > ShippingEasy statuses. In this example, if an X-Cart order has a status of Paid, it will be automatically sent to ShippingEasy where it will have a status of Awaiting Shipment. Click the New item button to map another order status.

201639339-shippingeasy_statues_add_xcart.png

Sync Existing X-Cart Orders to ShippingEasy

After integrating the X-Cart plugin with ShippingEasy, you can sync your existing X-Cart orders to your ShippingEasy account.

In X-Cart v4, on the Order Management page, check the box next to the order and then click the Export to ShippingEasy button.

201639359-export_to_shippingeasy_x_cart.png

In X-Cart v5, on the X-Cart page for that order, click the Export to ShippingEasy button at the bottom of the page.

201639399-export_button.png

Troubleshoot Syncing Orders from X-Cart

If an error occurs or an order does not get sent to ShippingEasy, you can determine the cause of the error in X-Cart.

In X-Cart v4:

  1. Click the Tools tab within the X-Cart store, then select the Maintenance entry.

    X-Cartv4_Tools-Maintenance_MRK.png

  2. Click the See also tab on the righthand side of the page, then click Logs.

    X-Cartv4_Logs_MRK.png

  3. Make sure the ShippingEasy option is checked. Enter a 0 in the number of records field, then click the Search button.

    X-Cartv4_SearchLogs_MRK.png

  4. Look at the displayed log entries for any errors that occurred when the plugin was attempting to send the order to ShippingEasy. For example, if the API key values were entered incorrectly, you will see the error message Access denied.

    X-Cartv4_Logs_SearchResults_MRK.png

In X-Cart v5:

  1. Click the System settings drop-down menu within the X-Cart store, then select the View system logs entry.

    X-Cartv5_ViewSystemLogs_MRK.png

  2. Look at the displayed log entries for any errors that occurred when the plugin was attempting to send the order to ShippingEasy. For example, if the API key values were entered incorrectly, you will see the error message Access denied.

    X-Cartv5_Logs_Example_MRK.png

X-Cart Integration Notes

Canceling, Combining, and Splitting Orders

  • If you cancel an order in X-Cart, it will be automatically removed from your ShippingEasy account as long as it is still on the ORDERS page in ShippingEasy.

  • If you combine two or more X-Cart orders in ShippingEasy, only the order that you selected for the shipping address of the combined orders in ShippingEasy will be updated with the shipment and tracking information in X-Cart.

  • The X-Cart plugins for ShippingEasy support partial shipments. If you split an X-Cart order in ShippingEasy, the tracking numbers will be added in X-Cart as each part of the split order is shipped in ShippingEasy. When the final order has been shipped, the order status will be updated in X-Cart.

Product Details

If you define options for your products in X-Cart, the selected options will be displayed in ShippingEasy.

Be sure to enable Display Product Options in your ShippingEasy store settings for X-Cart. This information can be found by navigating to SETTINGS > Edit Store Settings link under the X-Cart store listing.

201639289-display_Prod._options.png

Email Notifications

X-cart automatically sends shipment confirmation emails to your customer once their order has been shipped.

This integration allows you to define the Status Mappings for the store connection.

ShippingEasy will import the customer's email address with the order and can send customer shipment confirmation and delivery emails, which are configured in your Store Settings.

ShippingEasy will import the customer's phone number.

ShippingEasy will import the shipping method chosen by the customer at the time of checkout.

ShippingEasy will import the payment method used to pay for the order.

ShippingEasy will import discount and coupon information for the order.

ShippingEasy can determine if an order was placed as a gift.

Notes and comments can only be viewed in ShippingEasy.

ShippingEasy will import notes left by the customer at checkout or added to the order once it has been imported to ShippingEasy.

ShippingEasy allows you to consolidate multiple orders from a customer when they go to the same address.

ShippingEasy can split an order to accommodate changes in stock, different shipping locations, or multiple packaging needs.

Comments

Add a Comment

Article is closed for comments.

    Tags: