Buscar clientes

post

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

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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Filtros combináveis, paginação e ordenação. Todos os campos são opcionais.

promotionId

int64 | null

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

conditionId

int64 | null

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

linkedCustomers

boolean | null

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

searchSelected

string | null

Busca por nome ou e-mail dentro do resultado.

page

int32

1 to 9999

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

limit

int32

1 to 100

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

orderBy

string | null

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

orderDirection

int32

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

customersId

array of int64s | null

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

customersId

customersId_Neq

array of int64s | null

Clientes removidos do resultado final.

customersId_Neq

filtersGroup

array of objects | null

Conjuntos de filtros. Dentro de um conjunto, todos os filtros preenchidos se aplicam. Use um único conjunto por busca.

filtersGroup

Headers

x-api-version

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:

content-type

string

enum

Defaults to application/json-patch+json

Generated from available request content types

Allowed:

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/plain

application/json

text/json

200Página de clientes.

400Valor fora das faixas ou listas aceitas (VALIDATION_FAILED).

401Token ausente, inválido ou expirado (SESSION_INVALID), ou sem a permissão exigida (UNAUTHORIZED).

500Erro inesperado. Tente de novo; se persistir, contate o suporte com o traceId.