Pular para o conteúdo principal
A API de descontos permite cadastrar, alterar, ativar, desativar e remover os descontos de uma loja, e consultar quanto cada um vendeu.
API em beta. Ela ainda pode mudar. Acompanhe o changelog antes de cada atualização da sua integração.

​
Tipos de desconto

SMART

Desconto automático. Entra sozinho na sacola quando o pedido cumpre as regras, sem o cliente fazer nada. Identificado por name.

COUPON

Cupom. O cliente digita o code na sacola para aplicar. Bom para campanhas com influenciadores ou para enviar a um cliente específico.
Um pedido recebe no máximo um desconto SMART e um cupom. Se o cliente aplicar um cupom, ele substitui o desconto automático, a menos que o cupom tenha a opção CUMULATIVE_WITH_SMART: nesse caso os dois se somam.

​
Status

O status não é um campo que você envia. Ele é calculado a partir de startsAt e endsAt a cada consulta:
Estados SCHEDULED, ACTIVE e OVERDUE e as transições por data e pelas ações available e unavailableEstados SCHEDULED, ACTIVE e OVERDUE e as transições por data e pelas ações available e unavailable

Status de um desconto

Para ligar ou desligar um desconto na hora, use as ações.

​
Endpoints

Todas as rotas ficam em https://api.deliveryvip.com.br/merchant/v3/{merchantId}/discounts.

​
Requisitos

A loja precisa ter o módulo de descontos contratado. Sem ele, todas as rotas respondem 403 com "title": "growth_discount_not_hired".
Os descontos criados ou alterados pela API valem só no canal de venda da própria loja.

​
Erros comuns

Os erros seguem o formato padrão: { "status": "...", "title": ... }.