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

Detalhes do Cupom

Retorna os dados completos de um cupom de desconto específico, identificado pelo seu Código.

GET /cupom-desconto/{Codigo}/

O {Codigo} é o código interno do cupom, obtido na listagem de cupons.

📥 Exemplo de requisição

curl -X GET "https://api.toplojas.com.br/cupom-desconto/313255/" \
  -H "Authorization: Bearer [Token]" \
  -H "Loja: [Identificador de Sua Loja]"

📤 Exemplo de resposta

{
  "Codigo": "313255",
  "Status": "D",
  "CodigoCupom": "TesteCupom1 Editado",
  "Observacao": "Teste",
  "DataDe": "2020-12-01",
  "DataAte": "2020-12-10",
  "QtdUtilizacoes": "100",
  "QtdPorCliente": "1",
  "DescontoTipo": "P",
  "DescontoValor": "12.34",
  "ValorMinimoCompra": "100.98"
}

📋 Campos retornados

Campo
Tipo
Descrição

Codigo

inteiro

Código interno do cupom

Status

texto

A (Ativado) ou D (Desativado)

CodigoCupom

texto

Código que o cliente utiliza na cesta de compras

Observacao

texto

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

DataDe

data

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

DataAte

data

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

QtdUtilizacoes

inteiro

Quantidade limite de utilizações do cupom

QtdPorCliente

inteiro

Quantidade de utilizações por cliente

DescontoTipo

texto

P (Porcentagem) ou V (Valor fixo)

DescontoValor

decimal

Valor ou porcentagem de desconto (conforme DescontoTipo)

ValorMinimoCompra

decimal

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

Consulte a descrição de cada campo retornado na referência:

Last updated