FBfbits
Admin API · Promoções

Buscar clientes

Pesquisa clientes da loja por filtros combináveis. Use-o para pré-visualizar quem será atingido pela condição de clientes específicos: o objeto de filtro enviado aqui é o mesmo que vai dentro da condição. Use um único conjunto em filtersGroup por busca e confira o resultado antes de salvar.

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

post/api/promotions/customers

Request

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

Headers

x-api-version'2.0' required

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

Request body

promotionIdinteger nullable

Junto com conditionId, identifica uma condição de clientes já salva; os clientes já vinculados a ela ficam fora do resultado dos filtros.

conditionIdinteger nullable

conditionPromotionId da condição de clientes (de Obter promoção).

linkedCustomersboolean nullable

true: inclui no resultado os clientes já vinculados à condição informada. false sem filtersGroup: retorna todos os clientes da loja.

searchSelectedstring nullable

Busca por nome ou e-mail dentro do resultado.

pageinteger

Página, de 1 a 9999. Padrão: 1.

limitinteger

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

orderBystring nullable

customerId, name ou email, sem diferenciar maiúsculas. Padrão: customerId.

orderDirectioninteger

1 crescente, -1 decrescente. Padrão: 1.

customersIdinteger[] nullable

Clientes incluídos individualmente, além dos que atenderem aos filtros.

customersId_Neqinteger[] nullable

Clientes removidos do resultado final.

Response

Página de clientes.

totalinteger nullable

Total informado pela listagem. Nas rotas de apoio de promoções é a quantidade de itens desta página; o total geral fica em totalGeneral.

totalGeneralinteger nullable

Total de itens que atendem aos filtros, em todas as páginas.

totalActiveinteger nullable

Total de itens ativos, quando a listagem informa.

totalInactiveinteger nullable

Total de itens inativos, quando a listagem informa.

totalArchivedinteger nullable

Total de itens arquivados, quando a listagem informa.

limitinteger nullable

Tamanho de página usado.

pageinteger nullable

Página retornada, começando em 1.

totalPageinteger nullable

Quantidade de páginas, quando a listagem informa.

messagestring nullable

Observação opcional sobre a listagem (por exemplo, por que veio vazia). Omitida quando nula.

Changes

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