FBfbits
Admin API · Promoções

Listar clientes de uma condição

Lista os clientes vinculados a uma condição de clientes específicos já salva. Um conditionPromotionId desatualizado (anterior ao último PUT) retorna lista vazia, não 404.

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

get/api/promotions/{promotionId}/conditions/{conditionPromotionId}/customers

Request

  • Base URL
    https://sualoja.commerce-wake.tech
  • URL
    https://sualoja.commerce-wake.tech/api/promotions/{promotionId}/conditions/{conditionPromotionId}/customers
  • Auth
    HTTP bearer

Path parameters

promotionIdinteger required

ID da promoção.

conditionPromotionIdinteger required

conditionPromotionId da condição de clientes específicos (subgrupo 4), obtido em Obter promoção.

Query parameters

Searchstring

Busca por nome ou e-mail.

Pageinteger

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

Limitinteger

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

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 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.