The current article provides integration-specific details for this procedure.
Keystone account and credentials
To use X-Cart's Keystone integration, you must already be a dealer of Keystone Automotive Operations Inc (KAO). If you're not yet their dealer, you can apply to become one here: Keystone Automotive Operations Inc - New Customers.
Once you have a KAO account set up, you will be able to configure the integration settings in X-Cart. If you have any questions, please contact sdksupport@key-stone.com.
Note: Keystone has jobber accounts and dropshipper accounts. The current version of X-Cart's Keystone integration fully supports work with Dropship accounts only. Jobber account users can use the integration for product import; however, the order and shipment part of the functionality is not supported at this time for Jobber accounts.
Your set of credentials will be provided to you by Keystone Automotive Operations Inc (KAO) via KAO's SDK Portal. A user account is needed to access the Portal. You can request help setting up an SDK account at sdksupport@key-stone.com.
Be sure to inform your KAO support team contact of the IP address of the server on which you are going to use Keystone. This is important so the said IP address can be whitelisted on their system to enable data transfer.
Connect X-Cart to Keystone
To access the Keystone integration connection settings, go to Catalog › Catalog Import › Settings › Keystone. The settings you need are located in the Connection section.
 |
|
Your Keystone credentials need to be entered into the appropriate fields.
Account number
API key (Production SDK Key for production or Development/Testing SDK Key for testing)
FTP user
FTP password
Please note that your FTP credentials are listed in the SDK Portal and are different from the credentials you use for SDK Portal access.
Configure shipping for Keystone
After connecting to Keystone, you need to configure shipping for Keystone orders.
X-Cart 5.6.x:
The auto integration settings page for Keystone (Catalog › Catalog Import › Settings › Keystone) no longer includes the Shipping Settings section that was available in X-Cart 5.5.1.x. All shipping-related settings are managed through shipping profiles. See Shipping profiles in X-Cart 5.6.x for more information.
You can create a shipping profile for products sold through Keystone and define the rules that should be used for shipping calculation. The integration can retrieve shipping rates from Keystone via API, or you can choose to use flat shipping rates instead. The settings allow you to specify which type of rates should be displayed to customers at checkout. If necessary, you can also configure a handling fee to be added on top of the shipping rates.
 |
|
X-Cart 5.5.1.x:
Shipping settings can be found under Catalog › Catalog Import › Settings › Keystone in the Shipping Settings section.
|
|
The Keystone integration supports two different approaches to shipping rate calculation:
retrieving real-time shipping rates from the supplier via API
using configured flat shipping rates
"Shipping rates from supplier" setting (5.5.1.x)
The Shipping rates from supplier setting determines whether shipping rates received from Keystone via API are displayed to customers at checkout.
Important: Disabling this setting does not stop the store from requesting shipping rates from the supplier. It only controls whether the received rates are shown to customers.
The integration always sends a request to Keystone for shipping rates as part of the shipment creation process. However, whether rates are actually returned depends on several factors, including:
the terms of your agreement with Keystone (not all account types provide rates via API)
the availability of the supplier’s API
possible technical issues affecting the response
Flat shipping rates configuration (5.5.1.x)
Under Catalog › Catalog Import › Settings › Keystone, scroll down to the Shipping Settings section. In this section, click the Manage link near the Flat shipping rates setting.
On the next page, choose to configure a new shipping rate for Keystone or select an existing one.
Enter the required details.
In the Apply to Stock selector, choose
Keystone.Save the changes.
 |
|
How shipping rates affect checkout
Shipping rates in X-Cart are tied to shipment creation.
A shipment is created only after the store successfully receives a response from the supplier.
If the shipment cannot be created (for example, due to missing or failed API response), no shipping rates will be available at checkout.
In this case, no rates will be displayed at all—neither supplier rates nor flat rates.
This behavior ensures that shipping options shown to customers always reflect actual fulfillment capabilities confirmed by the supplier.
Can't find answers you're looking for?
Email us at support@x-cart.com. We will be happy to help!
Related articles