Configuração

Preferências Personalizadas do Site

Após a importação de metadados, vá em BM > Merchant Tools > Site Preferences > Custom Preferences.

Screenshot — Custom Preferences menu

Selecione Kleep:

Screenshot — Kleep preferences group

Preferência	Descrição
`kleepRetailerUUID`	Obrigatório. Identificador único do seu varejista na plataforma Kleep, fornecido pelo seu Account Manager do Kleep. Deve ser inserido manualmente — é enviado em cada chamada de API do Kleep e usado como parâmetro `domain` do iframe de Recomendação para resolver sua conta. Sem fallback automático: se deixado vazio, o rastreamento, o recurso de Recomendação e o iframe não funcionarão (um erro de configuração é gerado).
`isKleepRecommendationEnabled`	Ativar/desativar o botão Kleep na PDP. Não afeta o rastreamento ou as exportações de jobs.
`kleepButtonColor`	Cor do botão (Preto ou Branco). Substitua via CSS para estilização personalizada.
`kleepFontFamily`	Família de fontes para o botão Kleep e iFrame.
`kleepCountryCode`	Código de Mercado / País (ISO 3166 A-2).

Serviços

Encontrado em Administration > Operations > Services:

Screenshot — Services list

kleep.sftp — Envia arquivos de exportação do SFCC WebDAV para o SFTP do Kleep. Substitua o usuário pelo fornecido pelo Kleep, juntamente com o certificado .p12. Não defina nenhuma senha.

Screenshot — kleep.sftp service details

kleep — Usado para todos os outros recursos. Não é necessário usuário/senha — a requisição é autenticada pela preferência de site kleepRetailerUUID, enviada no payload de cada chamada de API do Kleep para resolver sua conta.

Chave Privada e Certificado

Vá em Administration > Operations > Private Keys and Certificates:

Clique em Import
Clique em Select e escolha o arquivo .p12 fornecido pelo Kleep
Use kleep como alias
Clique em Save

Screenshot — Import certificate

O resultado deve ser assim — deve ser válido e nomeado kleep:

Screenshot — Imported certificate

Jobs de Exportação

Vá em Administration > Operations > Jobs. Dois jobs são pré-configurados:

KleepExportProductsCSV — exporta os produtos do seu site
KleepExportOrdersCSV — exporta o histórico de pedidos dos seus clientes

Screenshot — Export jobs list

Ambos estão desativados por padrão. Ative-os para executar uma vez por dia:

Screenshot — Enabling an export job

Configurações comuns (ambos os jobs)

Vá para a aba Job Steps → clique em RefArch para selecionar os sites onde você usa o Kleep.

Timeout — segundos antes de interromper a exportação
OrdersMaxToExport — máximo de pedidos a exportar (apenas job de pedidos)

Screenshot — GenerateOrdersCSV step parameters

Configurações do KleepExportProductsCSV

Screenshot — KleepExportProductsCSV job steps

Parâmetro	Descrição	Padrão
`SkipMaster`	Ignorar exportações de produtos master	Desativado
`OnlineOnly`	Exportar apenas produtos online	Desativado
`ExportType`	Delta (apenas atualizados desde a última exportação) ou Completo	Delta
`MainViewType`	Tipo de visualização de imagem para imagens de produtos. Use o mesmo que a sua PDP.	`large`
`Locale`	Locale específico para exportação. Usa o padrão se vazio.	—

O número de produtos exportados pode exceder o número processado. Isso acontece quando produtos não categorizados são incluídos por meio de sua associação com um VariationGroup categorizado.

Certifique-se de que o parâmetro MainViewType corresponde à configuração da sua loja. Um tipo de visualização incorreto leva a imagens de produto ausentes, que são necessárias para análise de IA.

Screenshot — SFTPUpload step parameters (products)

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.

KleepResetLastExported (job utilitário)

Um terceiro job, KleepResetLastExported, é fornecido para forçar uma re-exportação completa de pedidos. Sua etapa ResetKleepExportAttributes limpa os atributos de rastreamento de exportação em todos os pedidos (kleepLastExported → vazio, isKleepExported → false) para que sejam processados novamente na próxima execução do KleepExportOrdersCSV. Está desativado por padrão e deve ser executado manualmente, sob demanda (ex.: após um reset de dados no lado do Kleep). Não aceita parâmetros.

Verificações de Estoque ao Vivo

O Kleep consulta os estoques em tempo real para evitar recomendar tamanhos fora de estoque. Configure o acesso usando um dos dois métodos abaixo.

Não sabe qual escolher? OCAPI é a abordagem tradicional usando a API de Dados do Business Manager. SCAPI (IAS) é a Salesforce Commerce API mais recente com o Inventory Availability Service. Pergunte ao seu administrador Salesforce em caso de dúvida.

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

Use isto se sua instância depende de OCAPI para gerenciamento de inventário.Passo 1 — Abrir Configurações OCAPINavegue até Administration > Site Development > Open Commerce API Settings, depois edite as configurações da API Data.Passo 2 — Configurar Client IDPara testes:

"client_id": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

Para produção, gere um novo client ID conforme a documentação Salesforce. Vídeo tutorial.Passo 3 — Configurar Acesso a RecursosAdicione isso às configurações da API Data do OCAPI:

Authorizations
(GET) /inventory_lists/*
(GET) /inventory_lists/*/product_inventory_records/*

Passo 4 — Enviar credenciais ao Kleep

Client ID
Client Secret
IDs de Inventário (um por mercado — forneça o mapeamento)
URL do SBX de Produção (verificações de estoque são habilitadas apenas em produção)

Use isto se sua instância usa SCAPI com o Inventory Availability Service (IAS) / Omnichannel Inventory (OCI).Passo 1 — Criar um Cliente de API

Faça login no Salesforce Account Manager.
Clique em API Client → Add API Client.
Nome de exibição: ex.: Kleep Inventory.
Token Endpoint Auth Method: client_secret_post.
Access Token Format: JWT.
Allowed Scopes: sfcc.inventory.availability
Atribua à sua Organização.
Salve. Copie o Client ID e o Client Secret — o secret é exibido apenas uma vez.

Clientes SCAPI e OCAPI não podem ser compartilhados. Cada framework de API requer seu próprio cliente.

Passo 2 — Obter identificadores da instância

Identificador	Onde encontrar	Exemplo
Short Code	BM > Administration > Site Development > Salesforce Commerce API Settings	`kv7kzm78`
Organization ID	Mesma página, ou 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`

Passo 3 — Enviar credenciais ao Kleep

Client ID e Client Secret
Short Code
Organization ID
Tenant ID
Location Group(s) (um por mercado — forneça o mapeamento)

Bem-vindo

CMS

Mobile

Dados

Privacidade

Preferências Personalizadas do Site

Serviços

Chave Privada e Certificado