Skip to main content

​
Custom Site Preferences

After metadata import, go to BM > Merchant Tools > Site Preferences > Custom Preferences. image.png Select Kleep: image.png
PreferenceDescription
kleepRetailerUUIDMandatory. Unique identifier for your retailer on the Kleep platform, provided by your Kleep Account Manager. Must be entered manually — it is sent in every Kleep API call and used as the domain parameter of the Recommendation iframe to resolve your account. No automatic fallback: if left empty, tracking, the Recommendation feature and the iframe will not work (a configuration error is raised).
isKleepRecommendationEnabledEnable/disable the Kleep button in PDP. Does not affect tracking or job exports.
kleepButtonColorButton color (Black or White). Override via CSS for custom styling.
kleepFontFamilyFont family for the Kleep button and iFrame.
kleepCountryCodeMarket / Country Code (ISO 3166 A-2).

​
Services

Found in Administration > Operations > Services: image.png kleep.sftp — Sends export files from SFCC WebDAV to Kleep SFTP. Replace the user with the one provided by Kleep, along with the .p12 certificate. Don’t set any password. image.png kleep — Used for all other features. No user/password needed — the request is authenticated by the kleepRetailerUUID site preference, sent in the payload of every Kleep API call to resolve your account.

​
Private Key & Certificate

Go to Administration > Operations > Private Keys and Certificates:
  1. Click Import
  2. Click Select and choose the .p12 file provided by Kleep
  3. Use kleep as the alias
  4. Click Save
image.png The result should look like this — it must be valid and named kleep: image.png

​
Export Jobs

Go to Administration > Operations > Jobs. Two jobs are pre-configured:
  • KleepExportProductsCSV — exports your site’s products
  • KleepExportOrdersCSV — exports your customers’ order history
image.png Both are disabled by default. Enable them to run once per day: image.png

​
Common settings (both jobs)

Go to the Job Steps tab → click RefArch to select the sites where you use Kleep.
  • Timeout — seconds before stopping the export
  • OrdersMaxToExport — max orders to export (orders job only)
image.png

​
KleepExportProductsCSV settings

image.png
ParameterDescriptionDefault
SkipMasterIgnore master product exportsDisabled
OnlineOnlyExport only online productsDisabled
ExportTypeDelta (only updated since last export) or FullDelta
MainViewTypeImage view type for product images. Use the same one as your PDP.large
LocaleSpecific locale for export. Uses default if empty.—
The number of exported products may exceed the number processed. This happens when uncategorized products are included through their association with a categorized VariationGroup.
Make sure the MainViewType parameter matches your shop’s configuration. A mismatched view type leads to missing product images, which are required for AI analysis.
image.png

​
KleepResetLastExported (utility job)

A third job, KleepResetLastExported, is provided to force a full re-export of orders. Its ResetKleepExportAttributes step clears the export-tracking attributes on every order (kleepLastExported → empty, isKleepExported → false) so they are picked up again on the next KleepExportOrdersCSV run. It is disabled by default and meant to be run manually, on demand (e.g. after a Kleep-side data reset). It takes no parameters.

​
Live Stock Checks

Kleep queries stocks live to avoid recommending out-of-stock sizes. Configure access using one of the two methods below.
Not sure which one to pick? OCAPI is the traditional approach using the Business Manager Data API. SCAPI (IAS) is the newer Salesforce Commerce API with the Inventory Availability Service. Ask your Salesforce administrator if unsure.
Use this if your instance relies on OCAPI for inventory management.Step 1 — Open OCAPI SettingsNavigate to Administration > Site Development > Open Commerce API Settings, then edit the Data API settings.Step 2 — Set Up Client IDFor testing:
"client_id": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
For production, generate a new client ID per the Salesforce documentation. Video walkthrough.Step 3 — Configure Resource AccessAdd this to your OCAPI Data API configurations:
Authorizations
(GET) /inventory_lists/*
(GET) /inventory_lists/*/product_inventory_records/*
Step 4 — Send credentials to Kleep
  • Client ID
  • Client Secret
  • Inventory IDs (one per market — provide your mapping)
  • Production SBX URL (stock checks are enabled on production only)