Configuration

Custom Site Preferences

After metadata import, go to BM > Merchant Tools > Site Preferences > Custom Preferences.

Screenshot — Custom Preferences menu

Select Kleep:

Screenshot — Kleep preferences group

Preference	Description	Recommended value
`kleepRetailerUUID`	Mandatory. 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).	The UUID provided by your Kleep Account Manager
`isKleepRecommendationEnabled`	Enable/disable the Kleep button in PDP. Does not affect tracking or job exports.	Yes
`kleepButtonColor`	Button color (Black or White). Override via CSS for custom styling.	`White` or `Black`, whichever matches your PDP design
`kleepFontFamily`	Font family for the Kleep button and iFrame.	Your shop’s font family — optional
`kleepCountryCode`	Market / Country Code (ISO 3166 A-2).	Your main market, e.g. `FR`

Depending on your cartridge version, you may also see isKleepSessionEnabled in Business Manager. This preference existed in older cartridge versions to toggle Kleep session tracking; it has been removed in current versions because the session is always active. If it is present, leave it at its default value (Yes).

Services

Found in Administration > Operations > Services:

Screenshot — Services list

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.

Screenshot — kleep.sftp service details

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:

Click Import
Click Select and choose the .p12 file provided by Kleep
Use kleep as the alias
Click Save

Screenshot — Import certificate

The result should look like this — it must be valid and named kleep:

Screenshot — Imported certificate

Export Jobs

Go to Administration > Operations > Jobs. The cartridge ships three jobs:

KleepExportProductsCSV — exports your site’s products
KleepExportOrdersCSV — exports your customers’ order history
KleepResetLastExported — utility job to force a full re-export of orders (details below)

Screenshot — Export jobs list

The two export jobs are disabled by default. Enable them to run once per day (see Scheduling and frequency):

Screenshot — Enabling an export job

Site assignment

Both export jobs run in a site context. In the Job Steps tab, click the site scope (shown as RefArch on a fresh install) and select the site(s) where you use Kleep. Each export job has two steps:

A generate step (Custom.Kleep.GenerateProductsCSV or Custom.Kleep.GenerateOrdersCSV) — writes the CSV file to a WebDAV IMPEX folder
An upload step (Custom.CSComponents.FtpUpload) — pushes the CSV to the Kleep SFTP server through the kleep.sftp service, then archives the file

The TargetFolder parameter of each SFTP upload step must match the folder structure expected by Kleep’s ingestion pipeline. For example, a dev store might use dev/products instead of products. See the SFTP Data Structure documentation for the complete directory layout.

KleepExportProductsCSV settings

Screenshot — KleepExportProductsCSV job steps

Step 1 — GenerateProductsCSV

Parameter	Description	Recommended value
`TargetFolder`	IMPEX folder where the CSV is written	`src/feeds/kleep/products`
`SkipMaster`	Ignore master products during the export	Unchecked
`OnlineOnly`	Export only online products	Unchecked
`ExportType`	`Delta` (products updated since the last export) or `Full` (entire catalog)	`Delta` — run one `Full` export at go-live
`MainViewType`	Image view type used to resolve product images. Use the same one as your PDP.	`large` (adjust to your catalog)
`Locale`	Locale used to generate the data. Uses the site default if empty.	Leave 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.

Screenshot — SFTPUpload step parameters (products)

Step 2 — SFTPUpload

Parameter	Recommended value
`ServiceID`	`kleep.sftp`
`KeyAlias`	`kleep`
`FilePattern`	`._kleep-products_.\.csv`
`SourceFolder`	`src/feeds/kleep/products`
`TargetFolder`	`products`
`Recursive`	Unchecked
`ArchiveFolder`	`src/feeds/kleep/products/archive`
`NoFileFoundStatus`	`OK`
`IsDisabled`	Unchecked

KleepExportOrdersCSV settings

Step 1 — GenerateOrdersCSV

Screenshot — GenerateOrdersCSV step parameters

Parameter	Description	Recommended value
`TargetFolder`	IMPEX folder where the CSV is written	`src/feeds/kleep/orders`
`Timeout`	Seconds before the export stops	`900`
`OrdersMaxToExport`	Maximum number of orders exported per run	`1000`

Step 2 — SFTPUpload

Parameter	Recommended value
`ServiceID`	`kleep.sftp`
`KeyAlias`	`kleep`
`FilePattern`	`._kleep-orders_.\.csv`
`SourceFolder`	`src/feeds/kleep/orders`
`TargetFolder`	`orders`
`Recursive`	Unchecked
`ArchiveFolder`	`src/feeds/kleep/orders/archive`
`NoFileFoundStatus`	`OK`
`IsDisabled`	Unchecked

Scheduling and frequency

Job	Frequency	Reference schedule	Notes
`KleepExportProductsCSV`	Daily	04:00 UTC, every day of the week	`Delta` export — light on resources
`KleepExportOrdersCSV`	Daily	05:00 UTC, every day of the week	Exports at most `OrdersMaxToExport` orders per run
`KleepResetLastExported`	Never scheduled	—	Run manually, on demand only

The exact time does not matter to Kleep — pick a low-traffic window for your instance and keep both export jobs daily. Staggering the two jobs by one hour (as above) avoids concurrent IMPEX and SFTP activity. For error handling, the reference configuration retries a failed run up to 3 times at 1-minute intervals.

At go-live, run KleepExportProductsCSV once manually with ExportType set to Full, then switch back to Delta for the daily schedule.

KleepResetLastExported (utility job)

KleepResetLastExported forces a full re-export of orders. Its single step, Custom.Kleep.ResetKleepExportAttributes, clears the export-tracking attributes on every order (kleepLastExported → empty, isKleepExported → false) so all orders are picked up again by the next KleepExportOrdersCSV runs. It takes no parameters. Run it only when a full order backfill is needed:

Kleep asks you to re-send the order history (e.g. after a data reset on the Kleep side)
You fixed an order export misconfiguration and want previously exported orders to be sent again

Keep it unscheduled and run it manually: Administration > Operations > Jobs > KleepResetLastExported > Run Now.

KleepExportOrdersCSV exports at most OrdersMaxToExport orders per run (1,000 by default). After a reset, a backfill of N orders therefore takes N / 1,000 runs — trigger the orders job manually several times, or temporarily raise OrdersMaxToExport, then restore it.

Live Stock Checks

Kleep queries stocks live to avoid recommending out-of-stock sizes. Configure access using one of the two methods below.

We recommend SCAPI (IAS) — it is Salesforce’s modern headless API, delivering faster response times and a more streamlined integration experience. OCAPI remains supported for instances that have not yet migrated to the newer API framework.

SCAPI — Inventory Availability Service (IAS) (Recommended)
OCAPI (Open Commerce API)

Use this if your instance uses SCAPI with the Inventory Availability Service (IAS) / Omnichannel Inventory (OCI). This is the preferred method: SCAPI is Salesforce’s modern, high-performance API layer — it offers lower latency, JWT-based authentication, and aligns with Salesforce’s long-term platform direction.Step 1 — Create an API Client

Log into Salesforce Account Manager.
Click API Client → Add API Client.
Display name: e.g. Kleep Inventory.
Token Endpoint Auth Method: client_secret_post.
Access Token Format: JWT.
Allowed Scopes: sfcc.inventory.availability
Assign to your Organization.
Save. Copy the Client ID and Client Secret — the secret is shown only once.

SCAPI and OCAPI clients cannot be shared. Each API framework requires its own client.

Step 2 — Gather instance identifiers

Identifier	Where to find it	Example
Short Code	BM > Administration > Site Development > Salesforce Commerce API Settings	`kv7kzm78`
Organization ID	Same page, or Account Manager	`f_ecom_zzzz_prd`
Tenant ID	Account Manager > Organizations	`zzzz_prd`
Location Group(s)	BM > Merchant Tools > Inventory > Inventory Availability	`WAREHOUSE_FR`, `WAREHOUSE_US`

Step 3 — Send credentials to Kleep

Client ID & Client Secret
Short Code
Organization ID
Tenant ID
Location Group(s) (one per market — provide your mapping)

Use this if your instance still relies on OCAPI for inventory management. OCAPI is the legacy Business Manager Data API — it remains fully functional but is not the recommended path for new integrations.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)

FAQ

Which parameters do I need to set for each job?

Each export job has two steps — a generate step and an SFTP upload step — and every parameter with its recommended value is listed in KleepExportProductsCSV settings and KleepExportOrdersCSV settings. In practice you only need to review three things: the site assignment in the Job Steps tab, MainViewType (must match your PDP image view type), and ExportType (Delta daily, one Full run at go-live). Everything else can keep its default value. KleepResetLastExported takes no parameters.

What does the KleepResetLastExported job do, and when should I run it?

It clears the export-tracking attributes (kleepLastExported, isKleepExported) on all orders so the next KleepExportOrdersCSV runs re-export the full order history. Run it manually only when a full backfill is needed — typically when Kleep asks for it. Never schedule it. See KleepResetLastExported (utility job).

Which site preferences do I need to configure?

The minimum working setup is: kleepRetailerUUID (mandatory — provided by your Kleep Account Manager), isKleepRecommendationEnabled set to Yes, and kleepCountryCode set to your main market. kleepButtonColor and kleepFontFamily are optional styling preferences. See Custom Site Preferences.

How often should the jobs run, and at what time?

Both export jobs run once per day, every day. The reference schedule is 04:00 UTC for products and 05:00 UTC for orders, but the exact time does not matter to Kleep — pick a low-traffic window and keep roughly an hour between the two jobs. KleepResetLastExported is never scheduled. See Scheduling and frequency.

I see isKleepSessionEnabled in Business Manager but it is not documented — what is it?

This preference existed in older cartridge versions to toggle Kleep session tracking. It has been removed in current versions because the session is always active. If your Business Manager still shows it, leave it at its default value (Yes).

Welcome

CMS

Mobile

Data

Privacy

Custom Site Preferences

Services

Private Key & Certificate