Skip to main content

Connecting to Keystone and initial setup

A
Written by Anna Verbichenko

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.


Keystone connection settings

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 in Shipping Settings.

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

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


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!


Did this answer your question?