API de solicitação de recompensa da promoção
Emita recompensas que não sejam de precificação e atualize os limites de promoção e cliente após os clientes fazerem seus pedidos.
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 |
Depois que um pedido é feito, a API pega os detalhes da promoção aplicada e da recompensa do carrinho como entrada. Você pode executar a API para contatos e contas. Se a sua empresa usar contas pessoais para gerenciar clientes, especifique o ID do contato associado à conta pessoal do cliente.
A resposta da API contém os detalhes das recompensas de precificação e não de precificação fornecidas ao cliente para seu pedido. A API de solicitação de recompensa da promoção pode ser executada para fornecer estas recompensas:
- Descontos
- Vouchers
- Jogos
A API de solicitação de recompensa da promoção também cria ou atualiza o registro de uso relacionado da promoção com base nos parâmetros presentes na solicitação da API.
| Parâmetro | Registros de uso criados ou atualizados |
|---|---|
| recompensas | Registros de Limite de uso da promoção e Uso da parte da promoção para pontos e vouchers. |
| appliedPromotions | Registros de Uso da parte da promoção para o número de vezes que os clientes usaram a promoção. |
Os registros de Uso do limite da promoção ajudam a rastrear o uso de cada recompensa da promoção em relação aos limites da promoção. Os registros de Uso da parte da promoção ajudam a rastrear o uso de cada recompensa da promoção pelos clientes em relação aos limites no nível do cliente da promoção.
A API de solicitação de recompensa da promoção gerencia automaticamente esses limites.
- Limites de promoção:
- Pontos
- Vouchers
- Limites do cliente:
- Pontos
- Vouchers
- Uso por cliente
Você deve configurar processos para gerenciar os limites de uso por carrinho, por item de linha, passivo e total.
Após a execução da API, o valor do campo Contagem de uso no uso da parte da promoção do cliente é incrementado em 1.
API de solicitação de recompensa da promoção para promoções com cupons
Ao executar a API, especifique o código de cupom que o cliente usou para seu pedido. O código do cupom identifica de modo exclusivo a promoção que o cliente usou para seu pedido.
A API consiste no parâmetro shouldCheckCouponUsageLimit. Se você já tiver aumentado o uso do cupom, defina o parâmetro como Falso. Para usar a API para verificar se o cupom está disponível para resgate e, em seguida, aumentar a contagem de uso do cupom, defina o parâmetro como Verdadeiro.
