Visão geral - Yampi Developer Portal

Introdução

Essa página documenta filtros e includes para serem usados nos seguintes endpoints:

Esses filtros ajudam a trazer apenas os cupons com cada propriedade específica, permitindo uma busca mais eficiente e direcionada.

Filters

Query Parameters

Hide properties

status

boolean

Retorna os cupons que estejam ativos ou inativos.

Exemplo: GET /pricing/promocodes?status=1

expired

boolean

Compara end_at em relação a agora. Aceita expired.

Exemplo: GET /pricing/promocodes?expired=0.

string

Busca textual por código ou descrição do cupom. Exemplo: ?q=BLACK.

rules[]

array

Aplica regras específicas (pode combinar múltiplas ocorrências). Valores aceitos:

accumulate: acumula com outras promoções ativas.
once_per_customer: uso limitado a 1 por cliente.
newsletter: cupom vinculados a newsletter, que é enviado no e-mail de cadastro dos leads.
cart_default: cupom padrão de carrinho, adicionado automáticamente.
abandoned_cart: cupom de carrinho abandonado.

Exemplo: ?rules[]=cart_default&rules[]=accumulate.

Utilize esses filtros para refinar suas consultas e obter exatamente os cupons que você precisa.