1. Cupom
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
        POST
      • Atualizar um registro
        PATCH
      • Excluir um registro
        DELETE
      • Ativar um registro
        POST
      • Desativar um registro
        POST
      • Listar registros
        GET
      • Buscar um registro
        GET
    • 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. Cupom

Inserir um registro

POST
/coupons
Cria um novo registro de cupom.
CampoTipoObrigatórioFormato
code
string
Não
salesman
integer
Não
applicationType
integer
Sim
applicationCode
integer
Não
description
string
Não
info
string
Não
value
float
Não
percent
float
Não
beginDate
string
Sim
Qualquer formato de data desta referência
endDate
string
Sim
Qualquer formato de data desta referência
usageLimit
integer
Sim
minimumPurchase
float
Não
perCustomerUsageLimit
integer
Sim
balance
boolean
Não
firstOrderOnly
boolean
Não
freeShipping
boolean
Não
ignoreShippingDiscount
boolean
Não
ignoreShippingRuleDiscount
boolean
Não
ignoreInstallmentDiscount
boolean
Não
ignorePaymentRuleDiscount
boolean
Não
ignoreOfferDiscount
boolean
Não
ignoreClassificationDiscount
boolean
Não
applyToWholeCart
boolean
Não
active
boolean
Não
batch
boolean
Não
batchSize
integer
Não
minimumPurchaseOfAssociations
boolean
Não
appliesToAllSelectedProducts
boolean
Não
priorizeCouponMinimumPurchase
boolean
Não
maximumProductsDiscountValue
float
Não
password
string
Não
externalUse
boolean
Não

Requisição

Authorization
Forneça seu token bearer no cabeçalho
Authorization
ao fazer requisições para recursos protegidos.
Exemplo:
Authorization: Bearer ********************
Parâmetros Header

Parâmetros Bodyapplication/json

Examples

Respostas

🟢201
application/json
Bodyapplication/json

🟠403
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/coupons' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
	"data": {
	    "code": null,
	    "applicationType": 1,
	    "applicationCode": null,
	    "description": "",
	    "info": "",
	    "value": 10.00,
	    "percent": null,
	    "beginDate": "2017-01-23",
	    "endDate": "2020-01-24",
	    "usageLimit": 1,
	    "perCustomerUsageLimit": 1,
	    "firstOrderOnly": false,
	    "applyToWholeCart": "daafs",
	    "active": true,
	    "ignoreOfferDiscount": true,
		"isBalance": false
	}
}'
Response Response Example
201 - 201 Created
{
    "data": {
        "id": 200,
        "idChildCoupon": null,
        "salesman": null,
        "code": "T9XG5G2KZZ",
        "applicationType": 2,
        "applicationCode": null,
        "description": "",
        "info": "",
        "value": null,
        "maximumProductsDiscountValue": null,
        "percent": 50,
        "beginDate": "2017-01-23T00:00:00+0000",
        "endDate": "2017-01-24T00:00:00+0000",
        "uses": 0,
        "usageLimit": 0,
        "minimumPurchase": 0,
        "minimumPurchaseOfAssociations": false,
        "perCustomerUsageLimit": 0,
        "actualBalance": null,
        "balance": false,
        "password": "d41d8cd98f00b204e9800998ecf8007e",
        "couponHistory": [],
        "freeShipping": false,
        "firstOrderOnly": false,
        "ignoreShippingDiscount": true,
        "ignoreShippingRuleDiscount": true,
        "ignoreInstallmentDiscount": false,
        "ignorePaymentRuleDiscount": false,
        "ignoreOfferDiscount": false,
        "ignoreClassificationDiscount": false,
        "applyToWholeCart": false,
        "active": true,
        "externalUse": false,
        "batch": false,
        "appliesToAllSelectedProducts": false,
        "priorizeCouponMinimumPurchase": false
    }
}
Modificado em 2026-08-07 15:49:11
Página anterior
Buscar um cupom filho do lote
Próxima página
Atualizar um registro
Built with