FBfbits
Admin API · Promoções

Listar promoções

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.

get/api/promotions

Request

  • Base URL
    https://sualoja.commerce-wake.tech
  • URL
    https://sualoja.commerce-wake.tech/api/promotions
  • Auth
    HTTP bearer

Query parameters

InitialDatestring date-time nullable

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.

FinalDatestring date-time nullable

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

PromotionsDate1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13

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.

Pageinteger nullable

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

Limitinteger nullable

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

OrderFieldstring nullable

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

OrderBystring nullable

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

Searchstring nullable

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

Activeboolean nullable

Filtra pelo indicador de ativação.

CanAccumulateboolean nullable

Filtra pelo indicador de acúmulo.

HasMultipleCouponsboolean nullable

Somente promoções com múltiplos cupons.

Conditionsinteger[] nullable

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

Actionsinteger[] nullable

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

HasCouponsboolean nullable

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

Statusstring nullable

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

Headers

x-api-version'2.0' required

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

Response

Página de promoções. data traz os itens; total é o total que atende aos filtros.

totalinteger

Total de promoções que atendem aos filtros (para paginação).

pageinteger

Página usada pela listagem (o padrão, quando não informada).

limitinteger

Tamanho de página usado pela listagem (o padrão, quando não informado).

Changes

No recorded changes to this operation across all 1 revision of this API.