| Campo | Tipo | 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 |