1. Raiz
API Livexa
  • Raiz
    • Autenticação
      • Gerar token de acesso
    • Fornecedor
      • Inserir um registro
      • Atualizar um registro
      • Excluir um registro
      • Listar registros
      • Buscar um registro
    • Carrinho
      • Listar Carrinhos
    • Conjunto de produto
      • Produto
        • Adicionar produto a um conjunto
        • Excluir um produto do conjunto
        • Listar produtos de um conjunto
      • Categoria
        • Adicionar categoria a um conjunto
        • Atualizar categorias de um conjunto
        • Listar categorias de um conjunto
      • Midia
        • Adicionar midia a um conjunto
        • Atualizar midias de um conjunto
        • Listar mídias de um conjunto
      • Inserir um registro
      • Atualizar um registro
      • Excluir um registro
      • Buscar um registro
      • Listar registros
    • Caracteristica de produto
      • Inserir um registro
      • Atualizar um registro
      • Excluir um registro
    • Categoria de produto
      • Ordem de produto
        • Inserir um registro
        • Excluir um registro
        • Buscar um registro
      • Produto
        • Listar Produtos por categoria
      • Inserir um registro
      • Atualizar um registro
      • Excluir um registro
      • Listar registros
      • Buscar um registro
    • Opção de produto
      • Inserir um registro
      • Atualizar um registro
      • Excluir um registro
      • Listar registros
      • Buscar um registro
    • Tamanho de produto
      • Inserir um registro
      • Atualizar um registro
      • Excluir um registro
      • Listar registros
      • Buscar um registro
    • Produto
      • Categoria
        • Adicionar categoria a um produto
        • Atualizar categorias de um produto
        • Listar categorias de um produto
      • Unidade
        • Midia
          • Inserir um registro
        • Listar unidades de um produto
        • Inserir um registro
        • Atualizar um registro
      • Caracteristica
        • Listar caracteristicas de um produto
      • Midia
        • Inserir um registro
        • Listar mídias de um produto
      • Avaliação
        • Inserir um registro
      • Listar registros
      • Buscar um registro
      • Inserir um registro
      • Atualizar um registro
    • Estoque
      • Atualizar estoques
      • Listar registros
    • Endereço de cliente
      • Listar registros
      • Buscar um registro
    • Origem de cliente
      • Listar registros
      • Buscar um registro
    • Cliente
      • Endereço
        • Listar endereços de um cliente
      • Listar registros
      • Buscar um registro
    • Forma de entrega
      • Listar registros
      • Buscar um registro
    • Cupom
      • Categoria
        • Adicionar categoria a um cupom
        • Atualizar categorias de um cupom
        • Listar categorias de um cupom
      • Cliente
        • Adicionar cliente a um cupom
        • Atualizar clientes de um cupom
        • Listar clientes de um cupom
      • Fornecedor
        • Adicionar fornecedor a um cupom
        • Atualizar fornecedores de um cupom
        • Listar fornecedores de um cupom
      • Produto
        • Adicionar produto a um cupom
        • Atualizar produtos de um cupom
        • Listar produtos de um cupom
      • Unidade brinde
        • Adicionar unidade brinde a um cupom
        • Atualizar unidade brinde de um cupom
        • Excluir uma unidade brinde do cupom
        • Listar unidades brindes de um cupom
      • Frete
        • Adicionar frete a um cupom
        • Atualizar fretes de um cupom
        • Listar fretes de um cupom
      • Cupom FIlho
        • Adicionar cupons filhos ao lote
        • Listar cupons filhos de um lote
        • Buscar um cupom filho do lote
      • Inserir um registro
      • Atualizar um registro
      • Excluir um registro
      • Ativar um registro
      • Desativar um registro
      • Listar registros
      • Buscar um registro
    • Vendedor
      • Listar registros
      • Buscar um registro
    • Afiliado
      • Listar registros
      • Buscar um registro
    • Pedido
      • Entrega
        • Listar entregas de um pedido
      • Unidade
        • Listar unidades de um pedido
      • Histórico de unidade
        • Listar unidades de um pedido
      • Transação
        • Listar transações de um pedido
      • Alterar status de registro
      • Listar registros
      • Buscar um registro
    • Entrega de pedido
      • Alterar um registro
      • Listar registros
      • Buscar um registro
    • Transação de pedido
      • Análise de risco
        • Listar análises de risco de uma transação
      • Listar registros
      • Buscar um registro
    • Análise de risco de transação
      • Listar registros
      • Buscar um registro
    • Crédito
      • Criar crédito
    • Anúncio de marketplace
      • Unidade
        • Listar unidades de um anúncio
        • Buscar um registro
      • Listar registros
      • Buscar um registro
  1. Raiz

Cupom

Cupons de desconto para utilização nos pedidos.
CampoTipo
Obrigatório
Descrição
code
string
Não
Código utilizável do cupom (ex: 10OFF, 50DESCONTO etc.)
salesman
integer
Não
Código do vendedor
applicationType
integer
Sim
Tipo de aplicação de cupom
Valores possíveis:
1 - Pedido completo
2 - Frete do pedido
3 - Itens do pedido
applicationCode
integer
Não
Código da aplicação do cupom, referente ao tipo.
Se o tipo for "frete", o código pode ser a forma de entrega específica na qual o cupom funcionará.
description
string
Não
Descrição interna do cupom
info
string
Não
Descrição pública do cupom (será exibido para o cliente)
value
float
Não
Valor monetário de desconto
\* Apenas um dos campos deverá possui preenchimento (value ou percent)
percent
float
Não
Valor percentual de desconto
\* Apenas um dos campos deverá possui preenchimento (value ou percent)
beginDate
string
Sim
Data de início da validade do cupom
endDate
string
Sim
Date de fim da validade do cupom
uses
integer
Sim
Quantidade de usos atuais
usageLimit
integer
Sim
Limite de usos totais
0 representa usos ilimitados
minimumPurchase
float
Não
Valor mínimo de pedido para aplicação do cupom
perCustomerUsageLimit
integer
Sim
Quantidade de usos por cliente
0 representa usos ilimitados
actualBalance
float
Sim
Saldo atual do cupom, se o sistema de saldo (balance) estiver ativo
balance
boolean
Não
Estado de ativação do sistema de saldo
Neste estado, cada compra desconta valores do saldo e, quando saldo acabar, o cupom não pode ser mais utilizado
firstOrderOnly
boolean
Não
Se só é possível utilizar o cupom na primeira compra dos clientes
freeShipping
boolean
Não
Frete grátis no cupom
ignoreShippingDiscount
boolean
Não
Ignora o desconto do frete
ignoreShippingRuleDiscount
boolean
Não
Ignora o desconto da regra do frete
ignoreInstallmentDiscount
boolean
Não
Ignora o desconto da regra de parcelamento
ignorePaymentRuleDiscount
boolean
Não
Ignora o desconto da regra de pagamento
ignoreOfferDiscount
boolean
Não
Ignora o desconto da promoção
ignoreClassificationDiscount
boolean
Não
Ignora o desconto da classificação do cliente
applyToWholeCart
boolean
Não
Verifica se vai aplicar cupom em todo carrinho
active
boolean
Não
Estado de ativação do cupom
batch
boolean
Não
Verifica se é um lote de cupons
minimumPurchaseOfAssociations
boolean
Não
Define se a regra de valor mínimo de pedido será apenas para produtos das associações
appliesToAllSelectedProducts
boolean
Não
Aplicar a todos produtos selecionados
priorizeCouponMinimumPurchase
boolean
Não
Priorizar o valor minimo do cupom ao invés do da loja
maximumProductsDiscountValue
float
Não
Define o teto do disconto do cupom
password
string
Não
Define a senha do cupom
externalUse
boolean
Não
Define se o cupom tera uso externo
Modificado em 2026-08-07 15:49:11
Página anterior
Buscar um registro
Próxima página
Categoria
Built with