For the complete documentation index, see llms.txt. This page is also available as Markdown.

Criar Cupom

Cadastra um novo cupom de desconto na loja.

POST /cupom-desconto/

📋 Campos

Campo
Tipo
Obrigatório
Descrição

CodigoCupom

texto

✅ Sim

Código que o cliente utiliza na cesta de compras

DataDe

data

✅ Sim

Início da vigência do cupom (Ano-Mês-Dia)

DataAte

data

✅ Sim

Fim da vigência do cupom (Ano-Mês-Dia)

QtdUtilizacoes

inteiro

✅ Sim

Quantidade limite de utilizações do cupom

DescontoTipo

texto

✅ Sim

P (Porcentagem) ou V (Valor fixo)

DescontoValor

decimal

✅ Sim

Valor ou porcentagem de desconto (conforme DescontoTipo)

Status

texto

✅ Sim

A (Ativado) ou D (Desativado)

Observacao

texto

❌ Não

Observação privada, visível apenas para a administração

QtdPorCliente

inteiro

❌ Não

Utilizações por cliente. Se omitido, o cliente pode usar quantas vezes desejar

ValorMinimoCompra

decimal

❌ Não

Valor mínimo da compra para o cupom poder ser utilizado

📥 Exemplo de requisição

curl -X POST "https://api.toplojas.com.br/cupom-desconto/" \
  -H "Authorization: Bearer [Token]" \
  -H "Loja: [Identificador de Sua Loja]" \
  -H "Content-Type: application/json" \
  -d '{
    "CodigoCupom": "TesteCupom1",
    "Observacao": "Teste",
    "DataDe": "2020-12-01",
    "DataAte": "2020-12-10",
    "QtdUtilizacoes": 100,
    "QtdPorCliente": 1,
    "DescontoTipo": "P",
    "DescontoValor": 12.34,
    "ValorMinimoCompra": 100.98,
    "Status": "A"
  }'

Em caso de sucesso, a API retorna o HTTP Code 201.

Referência completa deste endpoint:

Last updated