Nome

Tipo

Descrição

codigo(*)

String(50)

Código de identificação do cupom. Esse código deve ser único.

tipos_pagamento

String(100)

Tipos de pagamentos permitidos para ser usado o cupom.

São eles:

cartao_credito - Cartão de crédito,

transferencia - Transferência,

boleto - Boleto bancário,

sistema_pagamento - Sistema de pagamento,

deposito - Depósito em conta,

cartao_debito - Cartão de débito,

dinheiro - Dinheiro,

multiplos_cartoes_credito - Múltiplos cartões,

multiplos_cartoes_credito_boleto - Múltiplos cartões + Boleto

Caso não seja enviada a tag, ou envie com o valor “all”, irá selecionar todas.

cliente_cpf_cnpj

String(20)

CPF ou CNPJ do cliente.

valor_desconto(*)

Float(9,2)

Valor de desconto que será aplicado, de acordo com o tipo.

tipo_desconto(*)

String(10)

Tipo de desconto que será aplicado - “percentual” ou “valor”

frete_normal_gratis

Integer(1)

Permite utilizar o cupom quando houver frete grátis nas modalidades “Normal”

Valores:

1 - Permite;

0 - Não permite.

frete_expresso_gratis

Integer(1)

Permite utilizar o cupom quando houver frete grátis nas modalidades “Expresso”

Valores:

1 - Permite;

0 - Não permite.

frete_economico_gratis

Integer(1)

Permite utilizar o cupom quando houver frete grátis nas modalidades “Economico”

Valores:

1 - Permite;

0 - Não permite.

valor_minimo_compra

Float(9,2)

Valor mínimo para utilizar o cupom.

valor_maximo_compra

Float(9,2)

Valor máximo para utilizar o cupom.

validade_inicio

Datetime

Data de validade inicial do cupom.

Formato: Y-m-d H:i:s

validade_fim

Datetime

Data de validade final do cupom.

tipo_utilizacao(*)

String(20)

Tipo de utilização do cupom.

Valores:

“unica_geral”, “unica_cliente”, “livre”.

permite_produto_com_desconto

Integer(1)

Define se permite se utilizado o cupom com produtos que já possuem desconto.

Valores:

1 - Permite;

0 - Não permite.

descricao

String(150)

Descrição do cupom.

observacao_cliente

String(150)

Mensagem que será exibida para o cliente ao adicionar cupom.

permite_pontos_na_compra

Integer(1)

Permite gerar pontos ao usar o cupom.

Valores:

1 - Permite;

0 - Não permite.

permite_uso_kit

Integer(1)

Permite o uso do cupom em kits.

Valores:

1 - Permite;

0 - Não permite.

permite_uso_produtos_pre_venda

Integer(1)

Permite uso em produtos de pré-venda.

Valores:

1 - Permite;

0 - Não permite.

status(*)

Integer(1)

Status do cupom

Valores:

1 - Ativo;

0 - Inativo.

categorias

String

Categorias em que será permitido o uso do cupom.

Deve ser enviado o nome exato da(s) categoria(s). Caso desejar adicionar mais de uma, enviar separando-as por vírgula.

Caso não seja enviado nada ou “all” na tag, irá selecionar todas.

produtos

String

Produtos em que será permitido o uso do cupom.

Deve ser enviado o SKU (Código que fica na aba 02. Estoque). Caso desejar adicionar mais de um, enviar separando os SKU’s por vírgula.

marcas

String

Marcas em que será permitido o uso do cupom.

Deve ser enviado o nome exato da(s) marca(s). Caso desejar adicionar mais de uma, enviar separando-as por vírgula.

Caso não seja enviado nada ou “all” na tag, irá selecionar todas.

limpar_marcas

Integer(1)

Define se deve remover as marcas que estão salvas no cupom.

Valores:

1 - Limpar;

0 - Não limpar.

limpar_produtos

Integer(1)

Define se deve remover os produtos que estão salvos no cupom.

Valores:

1 - Limpar;

0 - Não limpar.

limpar_categorias

Integer(1)

Define se deve remover as categorias que estão salvas no cupom.

Valores:

1 - Limpar;

0 - Não limpar.