API de promoções elegíveis

Você está aqui:

API de promoções elegíveis

Use a API de Promoções elegíveis para fornecer aos clientes uma lista de promoções elegíveis para carrinhos de clientes. A API pode obter a lista de promoções elegíveis para contatos, contas e membros do programa de fidelidade.

Edições obrigatórias

Disponível em: Lightning Experience

Disponível em: Edições Enterprise, Unlimited e Developer com Gerenciamento de ofertas em tempo real

Forneça aos seus clientes uma lista de promoções elegíveis para o carrinho. A API pega os detalhes do carrinho de um cliente como a solicitação e fornece os detalhes das promoções ativas elegíveis para o carrinho como a resposta. Ao procurar promoções elegíveis para um item, a API verifica cinco níveis da hierarquia de categorias do produto.

Se um carrinho contiver um produto que não existe no catálogo do Salesforce, a API ignorará os produtos não sincronizados ao avaliar promoções no nível da linha e no nível entre linhas e mostrará promoções elegíveis para o carrinho.

Se uma organização tiver várias bibliotecas de regra do tipo Gerenciamento de promoção global, os integradores do sistema deverão especificar qual biblioteca de regras a API executa. Eles também devem confirmar que a solicitação da API contém valores que a definição de contexto da biblioteca de regras exige para avaliar carrinhos.

Importante Quando a API não encontra o valor de um atributo personalizado ou um atributo de produto na solicitação, presume-se que o valor está ausente no carrinho.

A resposta da API fornece estes detalhes da promoção.

Os principais detalhes da promoção, como datas de início e término
Valores de campo personalizados da promoção
Limites da promoção
As regras da promoção que são elegíveis para o carrinho do cliente
Os valores de campo personalizados da promoção que são mapeados na definição de contexto da promoção.

Para fornecer aos clientes suas promoções elegíveis em tempo real, integre a API de Promoções elegíveis a sistemas externos que gerenciam carrinhos de clientes. Consulte Promoções elegíveis.

Dica Ao integrar a API a sistemas externos, como sites de compras, sistemas de ponto de venda (POS) e sistemas de distribuição global (GDS), você usa ID de registro ou nomes para identificar os principais atributos do carrinho. Por exemplo, para identificar o cliente ao qual o carrinho pertence, especifique o ID do registro de contato do cliente ou o sobrenome e o email do contato. Para identificar os membros do programa de fidelidade aos quais o carrinho pertence, especifique o ID de registro do membro do programa de fidelidade ou seu número de associação. Para identificar produtos ou categorias das quais os produtos são adicionados ao carrinho do cliente, especifique o ID do produto ou o nome do produto ou o ID ou o nome da categoria.

Depois que o uso de uma promoção atende ao limite da promoção para um carrinho específico, a API de Promoções elegíveis não fornece a recompensa na saída da API para nenhum cliente. Depois que o uso de uma recompensa por um cliente atinge o limite no nível do cliente da promoção, a API de Promoções elegíveis não oferece mais a recompensa ao cliente.

Exemplo O administrador e o gerente de marketing da Cloud Kicks colaboraram para criar uma definição de contexto personalizada para uma promoção direcionada ao segmento Sneakerhead que compra escudos de tênis premium com um valor de carrinho de US$ 75.

Esta é a aparência da solicitação da API de promoção elegível quando a API é executada no site de compras online da Cloud Kicks.

{
   "cart":{
      "Accessory":[
         {
            "activityStartDate":"2023-06-14T12:45:19Z",
            "contactId":"003xx000004WjzAAAS",
            "transactionAmount":85,
            "currencyISOCode":"INR",
            "cartLineDetails":[
               {
                  "CartLineProductCategory":"Sneaker Shields",
                  "cartLineProductCatalogId:"0ZSSB0000002d8X4AQ"",
                  "AttributeKey:"Premium"
               }
            ]
         }
      ]
   }
}