Skip to main content
GET
Visualizar cupom
Esta API possui limites de requisições (rate limits) para garantir estabilidade. Cada endpoint tem um limite específico de chamadas por minuto. Este endpoint em específico tem um limite de requisições por minuto.

Authorizations

User-Token
string
header
required
User-Secret-Key
string
header
required

Path Parameters

alias
string
required

Alias da loja

id
integer
required

ID do cupom

Query Parameters

include
enum<string>[]

Incluir relacionamentos adicionais

Available options:
customer,
categories,
collections,
brand,
products,
payments

Response

Detalhes do cupom

Representa as restrições de inclusão e exclusão para itens específicos

id
integer

ID do cupom.

code
string

Código digitado pelo cliente no carrinho para aplicar o cupom. Único na loja, com no mínimo 3 e no máximo 40 caracteres.

Example:

"TEST"

description
string

Descrição interna do cupom, com até 60 caracteres. Emojis são removidos ao salvar.

Example:

""

customer_id
integer

ID do cliente para quem o cupom é exclusivo. Quando nulo, o cupom vale para qualquer cliente.

active
boolean

Indica se o cupom está ativo.

expired
boolean

Indica se a data de término do cupom já passou.

discount_type
enum<string>

Tipo do desconto do cupom: p para percentual e v para valor fixo em reais.

Available options:
p,
v
for_the_price_of
boolean

Indica se o cupom é do tipo 'pelo preço de', em que cada produto elegível passa a custar o valor de price_products.

cart_default
boolean

Indica se o cupom é aplicado automaticamente no carrinho. Um cupom percentual de 100% ou mais nunca é tratado como padrão.

type_increment_value
string

Tipo do desconto como está gravado no cupom, com os mesmos valores de discount_type (p ou v).

Example:

""

value
number<float>

Valor do desconto: percentual quando discount_type for p, ou valor em reais quando for v.

Example:

10

price_products
number<float>

Preço aplicado a cada produto elegível quando for_the_price_of for verdadeiro. Obrigatório nesse caso.

percent_products
number<float>

Percentual de desconto aplicado ao preço de cada produto elegível, usado em vez de price_products quando for maior que zero.

quantity
integer

Quantidade total de usos disponíveis do cupom. O cupom deixa de valer quando used alcança esse número.

Example:

"100000"

total_customers_used
integer

Quantidade de clientes distintos que já usaram o cupom.

Example:

"22"

product_quantity
integer

Quantidade de produtos elegíveis que o cupom 'pelo preço de' considera no cálculo do total.

product_max_quantity
integer

Quantidade máxima de produtos elegíveis a que o cupom se aplica.

used
integer

Quantidade de vezes que o cupom já foi usado.

Example:

22

items_count
integer

Quantidade de itens do carrinho considerada na regra do cupom. Campo legado: é gravado e devolvido, mas nenhuma regra desta API o aplica.

min_value
number<float>

Valor mínimo do subtotal do carrinho, em reais, para o cupom poder ser aplicado.

Example:

99.99

use_percent
number<float>

Proporção de uso do cupom, entre os usos já feitos e o total disponível.

Example:

0.02

shipment_percent
number<float>

Percentual de desconto aplicado ao frete, usado quando o cupom desconta no frete em vez de descontar nos produtos.

accumulate
boolean

Indica se o cupom pode ser acumulado com outras promoções da loja.

once_per_customer
boolean

Indica se cada cliente pode usar o cupom uma única vez.

abandoned_cart
boolean

Indica se o cupom está vinculado a alguma configuração de recuperação de carrinho abandonado.

newsletter
boolean

Indica se o cupom é entregue ao cliente que se inscreve na newsletter da loja.

payments_ids
any

IDs dos meios de pagamento em que o cupom é aceito.

Example:

"[1, 2, 3, 4]"

free_shipment
boolean

Indica se o cupom concede frete grátis em vez de desconto no valor do pedido.

ignore_promotion_products
boolean

Indica se o cupom deixa de valer para produtos que já estão em promoção.

freebie_id
integer | null

Brinde concedido pelo cupom

advertise
boolean

Divulgar o cupom com brinde no checkout

start_at
object

Data e hora no formato de objeto devolvido pelo PHP, com o fuso horário em que foi registrada.

end_at
object

Data e hora no formato de objeto devolvido pelo PHP, com o fuso horário em que foi registrada.

created_at
object

Data e hora no formato de objeto devolvido pelo PHP, com o fuso horário em que foi registrada.

updated_at
object

Data e hora no formato de objeto devolvido pelo PHP, com o fuso horário em que foi registrada.

include
object

Itens a serem incluídos

exclude
object

Itens a serem excluídos

include_ids
integer[]

IDs dos produtos alcançados pelas regras de inclusão, já expandindo marcas, coleções e categorias

Example:

"[987, 654, 456, 321, 123]"

exclude_ids
integer[]

IDs dos produtos alcançados pelas regras de exclusão, já expandindo marcas, coleções e categorias

Example:

"[123, 321]"