Requirements
Before configuring the integration, make sure the following requirements are met.
Acumatica ERP account
Your company must have an active Acumatica Cloud ERP account.
The integration connects your X-Cart store to an existing Acumatica instance. Typically, an Acumatica SaaS instance is accessible via a URL similar to the following:
https://your-company.acumatica.com
The Acumatica account, instance, and access credentials are provided and managed by Acumatica or your Acumatica implementation partner. Creating and maintaining the Acumatica environment is outside the scope of X-Cart.
Access credentials
To connect X-Cart to Acumatica, you will need valid credentials for accessing your Acumatica instance. Depending on your Acumatica configuration, this typically includes:
the Acumatica instance URL
a user account with appropriate permissions
API access credentials
If you do not have these credentials, contact your Acumatica administrator.
Connecting to Acumatica
After installing the Acumatica ERP Integration add-on, configure the connection between your X-Cart store and your Acumatica ERP instance.
To access the add-on settings:
In the X-Cart Admin area, go to Apps → My Apps.
Find Acumatica ERP Integration in the list of installed add-ons and ensure it is enabled.
Click Settings.
The Acumatica – Connection Settings page opens.
On this page, you can configure the parameters required to establish the connection with your Acumatica ERP instance.
To establish the connection, provide the required access parameters for your Acumatica environment. See the section Connection settings further on this page for more information.
Click the Connect button at the bottom of the page. The integration will use the provided details to establish communication between your X-Cart store and the Acumatica ERP system. If the connection is successful, confirmation messages will appear at the top of the page, indicating that the connection has been established and the OAuth token has been generated successfully.
If the connection attempt is unsuccessful, error messages will appear on the page.
Note the following changes after a successful connection:
The integration status at the top of the page is now displayed as “Acumatica is connected.”
The Connection settings section is now collapsed. If you expand it, you will see the connection details that were used to establish the connection with Acumatica.
A Reset connection link appears next to the status line. You can use this link to reset the current connection and reconnect using different connection details.
You can now proceed to configure the integration in the Data Sync Options Acumatica Configuration sections. See the section Initial setup for details.
Connection settings
The Acumatica – Connection Settings page allows you to configure the connection between your X-Cart store and your Acumatica ERP instance.
To establish the connection, provide the required access parameters for your Acumatica environment.
Base URL: Specify the Base URL of your Acumatica ERP instance.
The Base URL is the address used by X-Cart to access the Acumatica API. It is typically constructed from:
your Acumatica instance URL, and
your Tenant Name. In Acumatica Cloud ERP, tenants are used to separate environments within a single instance (for example, production, testing, or development environments).
The general format is:
https://your-company.acumatica.com/t/<tenant>
For example:
Acumatica instance URL:
https://your-company.acumatica.comTenant Name:
Test
The resulting Base URL would be:
https://your-company.acumatica.com/t/test
Your tenant name must match the one you specify on your Acumatica instance login page.
If you are unsure about the correct instance URL or tenant name, contact your Acumatica administrator or implementation partner.
Username and Password: Enter the username and password of the Acumatica user account that will be used for the integration (the ones you enter on your Acumatica instance login page).
Client ID and Client Secret: Enter the Client ID and Client Secret of your Acumatica ERP client application. If you do not yet have an application configured, you will need to create one in Acumatica ERP.
Client applications are managed in Acumatica ERP on the Connected Applications page (Screen ID: SM303010). The Client ID is assigned automatically when the application is registered in Acumatica ERP. The Client Secret must be generated for the application before it can be used for authentication.
Client ID:
Client Secret:
(The application configuration shown in the screenshots is for illustration purposes only.)
API Endpoint Name and API version: Enter the name of the Web Service Endpoint and API Version to be used in the integration. These are sourced from the Web Service Endpoints Acumatica ERP page (Screen ID: SM2070PL). Currently we recommend selecting the latest version of the eCommerce endpoint. If your Acumatica environment uses a different configuration, contact Acumatica support for guidance on selecting the appropriate endpoint.
After completing all required fields, click Connect to proceed.
Integration status
The current connection status between X-Cart and Acumatica ERP is displayed at the top of the Acumatica – Connection Settings page.
The status is indicated by a colored label.
Info label (green): Acumatica is connected
Displayed when the current OAuth token is valid and the integration is connected.
Warning label (yellow): Acumatica not connected
Displayed when the current OAuth token has expired or is no longer valid.
You can use the Reset connection link to reset the current connection and establish a new one with updated connection details.
Initial setup
After the connection with Acumatica ERP has been established, additional configuration sections become available on the same page: Data Sync Options and Acumatica Configuration.
Use these sections to configure how data will be synchronized between your X-Cart store and Acumatica ERP. After configuring the settings, click Save changes in the sticky panel to apply the configuration.
Data sync options
The Data Sync Options section allows you to define how X-Cart orders are synchronized with Acumatica Sales Orders.
Order sync mode: Select the mode used to synchronize orders between X-Cart and Acumatica. Available options:
Automatic (after payment) (default) - Orders are synchronized automatically after their payment status changes to Paid.
Manual only - Orders are synchronized manually using the Sync to Acumatica button on the order details page.
Create new products: This setting determines whether products from X-Cart orders should be created in Acumatica if they do not already exist there. Product creation in Acumatica may occur during the synchronization of an X-Cart order with an Acumatica Sales Order.
If the setting is set to On and a product from the X-Cart order cannot be found in Acumatica, the integration will automatically create a new product in Acumatica.
If the setting is set to Off and a product from the X-Cart order cannot be found in Acumatica, the order synchronization will fail.
Acumatica configuration
The Acumatica Configuration section defines how X-Cart entities are mapped to their corresponding entities in Acumatica.
Customer ID: Select what customer data will be used as Customer ID when identifying and synchronizing existing customers in Acumatica. Available options:
Email (default)
Phone
Profile ID
Stock Item ID: Select what product data will be used as Stock Item ID when identifying and synchronizing existing products in Acumatica. Available options:
SKU (default)
If the Create new products option is set to On and a product from the X-Cart order cannot be found in the Acumatica catalog during order synchronization, the integration will attempt to create the missing product in Acumatica using the configuration settings described below:
Customer Class: The Customer Class that will be assigned to newly created customers in Acumatica.
Item Class: The Item Class that will be assigned to newly created products in Acumatica.
Posting Class: The Posting Class that will be assigned to newly created products in Acumatica.
Reason code subaccount: The Reason code subaccount that will be assigned to newly created products in Acumatica. Available options:
000-00 - Default
[other options]
Default Tax Category ID: The Tax Category ID that will be assigned to newly created products in Acumatica. Available options:
TAXABLE
EXEMPT
Default Warehouse ID: The Warehouse ID that will be assigned to newly created products in Acumatica. Available options:
Main
[other options]
The list of available values for each setting is retrieved automatically from your Acumatica instance via the Acumatica API.
Can't find answers you're looking for?
Email us at support@x-cart.com. We will be happy to help!
Related articles