Listar pedidos

Realiza a busca de pedidos registrados na plataforma Magento Adobe Commerce

Parâmetros

Parâmetros de configuração

Campo	Tipo	Descrição
Descrição	Campo de texto	Descrição visual do conector na construção do fluxo.
Conta de serviço	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 pedido 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 pedidos, 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 o pedido será consultado. Permite que o pedido 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

Payload

Detalhes

O conector Listar Pedidos possibilita a recuperação e consulta de vários pedidos no e-commerce por meio da API REST.

O endpoint utilizado é GET /orders?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).

Sucesso

Em casos de sucesso, o retorno de execução do conector será uma lista contendo os 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.

Sucesso na listagem de pedidos

Erros

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

Erro na listagem de pedidos

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

Erro de autenticação na listagem