# Listar faturas

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

<figure><img src="https://lh7-rt.googleusercontent.com/docsz/AD_4nXdMUDCtRlWlPXDN4H1XzrEluJxLJ1lGoS249lmDFBeC7iGOsuQeoYa3k6KSCwJistOSI8HL8ME1kAh2WX7114s1S2vzUFAoa0_zuVW-sxo-olzeVfbbimDm0P-jauDb410kFruiVg?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 da fatura 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 faturas, por página, que poderão ser retornados. Caso o campo seja deixado em branco, nenhum valor padrão será aplicado.                                       |
| Página atual                               | Campo de texto       | Define o número da página contendo os resultados da consulta. Caso o campo seja deixado em branco, nenhum valor padrão será aplicado.                                               |
| Código da visão de loja                    | Campo de texto       | Refere-se ao código identificador da visão de loja onde a fatura do pedido será consultada. Permite que a fatura seja consultada 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 Faturas possibilita a recuperação e consulta de vários registros de faturas no e-commerce por meio da API REST.&#x20;

O endpoint utilizado é **GET** `/invoices?searchCriteria` 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 as faturas de pedidos, de acordo com os filtros aplicados, além de 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_4nXdfNZ4PhCoh6Aiib6hY6LDpz9vfBxSX4-IUzJEUxYWkfP5wAtIwcJZ5Wu4p4zFcBGosLY8UwaoECFDHVzo4qaviu4Jw3pK15Tn0zSQc0LPMqyPN2srU56qUM9hzRmNdiTiGE7ALuw?key=Yp0qdx99PgGWwiHA4kq1q_wj" alt=""><figcaption><p>Sucesso na listagem de faturas</p></figcaption></figure>

## Erros

Em cenários de erro, como uso de atributos ou valores inválidos, será retornada uma mensagem de erro ou uma lista vazia.&#x20;

<figure><img src="https://lh7-rt.googleusercontent.com/docsz/AD_4nXcv46ug67EkBjhZckO52xQKstCw5YUbsdhU1_1bhENItOTwhKwafRwhITtPkANbe_uCgp9l6WVc9ZCjSSRs6rBuUCH40mZ6OgQYx7BIuSva54nqBgeXmJhs9wvMyzBJ-XOIeVpKpQ?key=Yp0qdx99PgGWwiHA4kq1q_wj" alt=""><figcaption><p>Erro na listagem de faturas</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_4nXeatoCllS8eDkPY42K_CScb3CgOSZE9nVv3hsnp0crgSLgwSylKa06TMSwiIJzW92q_FOOQznyy_oj1amCzGD8UqXHZyUcs8H510dqNh0FKJaLG0kCCsPlP0tHnZQaZWXnSE_mQCA?key=Yp0qdx99PgGWwiHA4kq1q_wj" alt=""><figcaption><p>Erro de autenticação na listagem de faturas</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.