Referências de API

Listar promoções

get
https://{loja}.commerce-wake.tech/api/promotions

Retorna as promoções da loja (exceto as excluídas), com filtros e paginação.

Permissão: Cadastro de promoções — visualização.

O parâmetro status aceita, sem diferenciar maiúsculas:

  • Ativa: promoções atualmente em vigor
  • Inativa: promoções desativadas
  • Expirada: promoções com a vigência encerrada
  • Programada: promoções ativas com início futuro

Valores fora das faixas e listas aceitas retornam 400 (VALIDATION_FAILED), com o parâmetro em details[].field.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
date-time | null

Início do período a filtrar. Só tem efeito junto com finalDate: retorna as promoções cuja vigência se sobrepõe ao período.

date-time | null

Fim do período a filtrar. Só tem efeito junto com initialDate.

int32 | null
enum

Período pré-definido (nome ou número); quando informado, substitui initialDate/finalDate. 1 Today, 2 Yesterday, 3 Last7Days, 4 Last30Days, 5 Last6Months, 6 Tomorrow, 7 Next7Days, 8 Next30Days, 9 Next6Months, 10 CurrentWeek, 11 CurrentMonth, 12 CurrentSemester, 13 Last12Months.

int32 | null

Página, começando em 1. Padrão: 1.

int32 | null

Itens por página, de 1 a 100. Padrão: 10.

string | null

Campo de ordenação: name, initialDate, finalDate ou order (prioridade), exatamente com essa grafia. Padrão: order.

string | null

Direção da ordenação: asc ou desc. Padrão: desc.

Trecho do nome, ID exato ou código de cupom. %, _ e [ são buscados como texto.

boolean | null

Filtra pelo indicador de ativação.

boolean | null

Filtra pelo indicador de acúmulo.

boolean | null

Somente promoções com múltiplos cupons.

Conditions
array of int64s | null

Promoções que usam estes tipos de condição (promotionConditionId de GET /api/promotions/conditions). Repita a chave para vários valores.

Conditions
Actions
array of int64s | null

Promoções que usam estes tipos de ação (promotionActionId de GET /api/promotions/actions). Repita a chave para vários valores.

Actions
boolean | null

Somente promoções com (true) ou sem (false) cupom.

string | null

Filtro por status da promoção. Valores aceitos: "Ativa", "Inativa", "Expirada", "Programada"

Headers
string
enum
required
Defaults to 2.0

Versão da API. Obrigatório: sem ele a resposta é 400 (API_VERSION_REQUIRED).

Allowed:
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated about 3 hours ago

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json

Updated about 3 hours ago