Criar estorno para pedido

Cria um estorno para um pedido realizado na plataforma Magento Adobe Commerce

Parâmetros

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.
ID do pedido (order_id)	Campo de texto	Identificador do pedido realizado no e-commerce. Este não é o increment_id exibido nas grades de pedido.
Lista com itens para reembolso (objeto JS/JSON)	Campo de texto	Permite informar o caminho, dentro do objeto msg, de uma lista JSON contendo os dados do reembolso. Os dados do reembolso deverão conter o identificador dos itens do pedido que serão reembolsados, a quantidade de itens e atributos opcionais extensíveis do reembolso.
Notificar cliente	Seletor	Define se o cliente será notificado por e-mail.
Acrescentar comentários anteriores	Seletor	Define se será enviado ou não um comentário junto a criação do reembolso.
Comentário visível na vitrine	Campo de texto	Permite definir se os comentários adicionados junto ao reembolso serão visíveis pelo usuário comprador nos detalhes do pedido.
Atributos extensíveis adicionais para comentários	Tabela de parâmetros	Definem informações adicionais e extensíveis associadas ao comentário do pedido. Configurado no formato de Chave e Valor.
Quantidade de envio	Campo de texto	Representa o valor do frete que será reembolsado. Caso não tenha frete (frete grátis), manter vazio.
Correção positiva	Campo de texto	Campo para adicionar um valor extra ao reembolso (exemplo: bônus ou compensação).
Correção negativa	Campo de texto	Campo para deduzir um valor do reembolso (exemplo: taxas e penalidades).
Lista com id de itens para retornar ao estoque (objeto JS/JSON)	Campo de texto	Permite informar o caminho, dentro do objeto msg, de uma lista JSON contendo os itens que serão retornados ao estoque. A lista deverá conter o identificador dos itens do pedido que serão retornados, a quantidade de itens e atributos opcionais extensíveis do retorno.
Atributos extensíveis adicionais	Tabela de parâmetros	Definem informações adicionais e extensíveis associadas ao reembolso do pedido. Configurado no formato de Chave e Valor.
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 Criar estorno para Pedido oferece uma interface simples e automatizada para gerenciar reembolsos de pedidos realizados no e-commerce por meio da API REST.

O conector utiliza o endpoint POST /rest/V1/order/{id}/refund, onde {id} é o identificador do pedido. Para saber mais sobre esta ou outras APIs disponibilizadas para Adobe Commerce Magento, acesse o link REST endpoints (ReDocly).

Lista de itens do reembolso

Para adicionar uma lista com os itens que serão reembolsados será necessário que o JSON siga um padrão específico. Segue um exemplo da estrutura para gerar o reembolso. No caso abaixo o JSON está no caminho msg.list, logo, na configuração Lista com itens para reembolso (objeto JS/JSON) será necessário passar o caminho msg.list. O mesmo se aplica para a configuração Lista com id de itens para retornar ao estoque (objeto JS/JSON), responsável por retornar os itens do reembolso ao estoque.

[
    {
        "order_item_id": 3522,
        "qty": 1,
        "extension_attributes": {}
    }
]

Lista de itens para retorno ao estoque

Para realizar a configuração dos itens que serão retornados ao estoque do e-commerce, é necessário configurar uma lista JSON válida. Segue um exemplo de uma lista contendo os identificadores dos itens do pedido. A lista abaixo informa que os itens do pedido de identificador 3525 e 3526 serão retornados ao estoque.

[
    "3525",
    "3526"
]

Sucesso

Quando a requisição for bem-sucedida, a resposta conterá um identificador único do reembolso gerado no e-commerce.

Sucesso na criação de estorno

Erros

Cenários de erro poderão ocorrer por diversos motivos, desde o uso de listas com formato não esperado pelo conector até erros na atualização devido ao fluxo de pedidos no e-commerce. Caso a lista contenha um produto válido e um inválido, dado pelo identificador do item do pedido, o reembolso não será gerado para nenhum item. Segue um exemplo abaixo de como os erros são retornados da API.

Erro na criação de estorno