# Listar clientes

{% tabs %}
{% tab title="Parâmetros" %}

<figure><img src="https://lh7-rt.googleusercontent.com/docsz/AD_4nXdGANxEU_c1OdPy-c6fK6R5zs3IQuqrFVcfoqPXEYskaQ7P8TT32k5KhYX7LLmGIswMdon0t_MwtXShq6pmWh-OYvAl5WEsElTt86-Bvz6zjXSC7PTwhFREBeQnqbQurwwrnqwL1w?key=Yp0qdx99PgGWwiHA4kq1q_wj" alt=""><figcaption><p>Parâmetros de configuração</p></figcaption></figure>

| Campo                                      | Tipo                 | Descrição                                                                                                                                                                             |
| ------------------------------------------ | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Descrição                                  | Campo de texto       | Descrição visual do conector na construção do fluxo.                                                                                                                                  |
| [Conta de serviço](#user-content-fn-1)[^1] | Seletor              | Permite selecionar uma conta de serviço do tipo Bearer Token, cadastrada no Workspace Floui, para realizar a conexão e autenticação com o ambiente Adobe Commerce Magento.            |
| Filters                                    | Tabela de parâmetros | Permite aplicar filtros com base em critérios de pesquisa, definindo o campo do cadastro a ser filtrado, o operador de pesquisa e o valor a ser buscado dentro do campo especificado. |
| Número de resultados por página            | Campo de texto       | Quantidade máxima de cadastros, por página, que poderão ser retornados. Não há valores padrão ao deixar o campo vazio.                                                                |
| Página atual                               | Campo de texto       | Define o número da página contendo os resultados da consulta. Não há valores padrão ao deixar o campo vazio.                                                                          |
| Código da visão de loja                    | Campo de texto       | Refere-se ao código identificador da visão de loja onde o cadastro do cliente será consultado. Permite que o cadastro seja consultado em visões de loja específicas.                  |
| Output Path                                | Campo de texto       | Refere-se ao caminho do resultado da requisição na saída do conector no contexto de execução do fluxo                                                                                 |
| {% endtab %}                               |                      |                                                                                                                                                                                       |

{% tab title="Payload" %}

## Detalhes

O conector Listar Clientes possibilita a recuperação e consulta de vários registros de clientes no e-commerce por meio da API REST.&#x20;

O endpoint utilizado é **GET** `/customers/search` com `searchCriteria`. O `searchCriteria` é amplamente utilizado na API REST do Magento para aplicação de filtros, paginação e ordenação de resultados.

Para mais informações sobre essa e outras APIs disponíveis no Adobe Commerce Magento, consulte a documentação oficial [REST endpoints (ReDocly)](https://developer.adobe.com/commerce/webapi/rest/quick-reference/).

## Sucesso

Em casos de sucesso, o retorno de execução do conector será uma lista contendo os cadastros de usuário. A lista irá respeitar as parametrizações de Número de resultados por página e Página atual. Na chave `search_criteria` será disponibilizado os detalhes de filtro e paginação aplicados na API durante a consulta.

<figure><img src="https://lh7-rt.googleusercontent.com/docsz/AD_4nXcmqwj1Paz9TXuyf7NrDGYMPQgNeiLxdNxFhHECNCvo4gMg77B4ubFG1FxHqPKvWalWpZ2UZfgdxO8m0wTRWlAfFBF_4Rv7-iZfjaUL7HHTKQ8d2JvpoIdcRxTZO_kSpfjMty7CWg?key=Yp0qdx99PgGWwiHA4kq1q_wj" alt=""><figcaption><p>Sucesso na listagem de clientes</p></figcaption></figure>

<figure><img src="https://lh7-rt.googleusercontent.com/docsz/AD_4nXfpWcPrvGj-iO3gQEQx1FvE2Rk5f8-rwIQOYv3JG8dbzeyfjKElqiDglaC0yINHjvoYc1lp-Eu-2pF5hM9L8pJytuhRR7Js1qeuat99VUxjyQI6qbCGs3MIIG2oogCkXql0MKQ87w?key=Yp0qdx99PgGWwiHA4kq1q_wj" alt=""><figcaption><p>Detalhes do filtro e paginação da listagem</p></figcaption></figure>

## Erros

Em cenários de erro, como uso de atributos ou valores inválidos, será retornada uma mensagem de erro conforme o exemplo abaixo.&#x20;

<figure><img src="https://lh7-rt.googleusercontent.com/docsz/AD_4nXe9JL1lc086c3UfqoiRQD7MdZC-ecxjkSIikODZvfFmxqrN0Ayi7yT-Fdwp5PMV9AKvhjalziJSrw4UzyX8euT31tdJdN5vLlLmcWY3P7V8-2l_E5dKT6Tykk5MjReQFA5uCFL2fQ?key=Yp0qdx99PgGWwiHA4kq1q_wj" alt=""><figcaption><p>Erro em requisição de listagem</p></figcaption></figure>

Em casos como erro de autenticação no e-commerce, será retornada uma mensagem de erro similar ao exemplo abaixo.

<figure><img src="https://lh7-rt.googleusercontent.com/docsz/AD_4nXfVLMq1Ps5MypjLT3OSpAhBv0VPxHFkuFOtyK_-LI4EwxXOXr-xJ9Jsrqa3dgfQWMTVDhkXYYHPALEgKSy_fWXmnRUizWgXx4UfI8s676Hicyy3PDilWCr10uIhKeAki6QEnIp7ZA?key=Yp0qdx99PgGWwiHA4kq1q_wj" alt=""><figcaption><p>Erro de autenticação</p></figcaption></figure>
{% endtab %}
{% endtabs %}

[^1]: A conta de serviço precisa ser adicionada no painel de configuração do Floui antes de ser selecionada dentro do componente.