Keystone Vendor Integration
The Keystone Integration allows you to connect your store with Keystone’s inventory, pricing, and order fulfillment services. This guide walks you through the available configuration options and required credentials to set up the integration.
Credentials
To connect to Keystone, you need the following credentials:
- FTP Username – Used to access Keystone’s FTP server for inventory and product data.
- FTP Password – The password associated with your FTP account.
- Account ID – Your unique identifier for Keystone’s services. Ensure you only use the numeric portion of your Account ID.
- Development API Key – Used for testing and development purposes.
- Production API Key – The key required for live API calls when processing real data.
- Environment – Determines whether the integration runs in "production" mode or a testing environment. Spark Shipping uses the Development API Key when this is set to testing and the Production API Key when it is set to production.
Options
The integration includes several configurable options to optimize how data is processed.
Enable API Inventory (Faster)
This option enables real-time inventory checks via API instead of relying on batch file updates. Enabling this may improve accuracy and speed when checking stock levels. It is enabled by default on new Keystone vendors.
Country for Inventory
Determines which country’s inventory stock levels are used for availability calculations. For Canada, the inventory is the sum of stock in three warehouses: Great Lakes, East and Pacific Northwest.
Inventory Warehouses
Select one or more Keystone warehouses (East (Exeter, PA), Midwest, California, Southeast, Pacific Northwest, Texas, Great Lakes, Florida) to use only their stock. Stock is the sum of the selected warehouses. When one or more warehouses are selected, the Country for Inventory setting is ignored. Leave it empty to use the default.
Part Number
Choose whether products use Keystone's Part Number or the Manufacturer Part Number.
Use MAP pricing from inventory file (column MAPretail or MRP)
When enabled, the integration pulls Minimum Advertised Pricing (MAP) from Keystone’s data feed. If you need to adjust or remove MAP pricing, visit the Maintenance tab.
Enable Case Packed Products
When enabled, the integration will recognize case-packed products. This means certain items may only be available in specified quantities rather than individually.
If this option is not enabled, you may see an error message like the following:
DEBUG [Keystone] Setting SKU W31912 stock to 0: case packed products is disabled and case quantity is 10.
This means that since case-packed products are disabled, the stock will not be updated correctly unless the option is enabled.
Add Core Charge to Product Cost
When enabled, core charges will be added to the base product cost.
Disable Keystone Shipping Cost for Cost Calculations
By default, Keystone’s provided shipping cost is used in cost calculations. When checked, Spark Shipping uses the flat shipping cost instead of Keystone's average shipping cost, and a custom shipping cost can be added using a custom file in the Advanced tab.
Shipping Cost Flat Rate
This field allows you to set a flat shipping cost for Keystone orders. This cost is combined with UPS Ground Accessorials (if the item is UPS-shippable). If the item requires freight shipping (US-LTL), Keystone’s rate is used instead. When Country for Inventory is Canada, the flat rate is combined with Purolator Ground Accessorials (if the item can ship by Purolator). If left blank, the flat rate defaults to $11.50 for US inventory.
Send Orders Using Spark Shipping Order ID
When enabled, orders sent to Keystone will use the Spark Shipping Order ID instead of the store/marketplace order number. This is useful when the store order number is too long or contains characters the vendor rejects. Tracking is matched back automatically.
Troubleshooting
- Incorrect inventory levels? Ensure API inventory is enabled and that the correct country is selected. If you selected Inventory Warehouses, only those warehouses are counted.
- Shipping costs seem incorrect? Check whether Keystone’s shipping cost is enabled or if a custom rate is overriding it.
- Orders not being accepted? Double-check API credentials, especially the Production API Key, and make sure Environment is set to production. Kits are not supported by the Keystone order API and must be ordered from the Keystone portal. See Keystone - Common Errors.
For further assistance, please reach out to our support team.