# Cancelar pedido

{% tabs %}
{% tab title="Configuração" %}

<figure><img src="https://215079342-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F226k0cnPTn1PWu9xHcK8%2Fuploads%2FhZVQM3kDRTK1hhSuckzg%2Fimage.png?alt=media&#x26;token=120fdc80-a379-4827-b793-216abfe4be0f" 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. |
| ID do pedido (order\_id)                   | Campo de texto | Identificador do pedido realizado no e-commerce que será cancelado. Este não é o increment\_id exibido nas grades de pedido.                                                   |
| 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 gera o cancelamento de pedidos realizados dentro da loja virtual. Para isso, é necessário que o pedido esteja em uma situação válida para o cancelamento.

O conector utiliza o endpoint **POST** `/rest/V1/orders/{id}/cancel`, onde `{id}` é o identificador do pedido que será cancelado. Para saber mais sobre esta ou outras APIs disponibilizadas para Adobe Commerce Magento, acesse o link [REST endpoints (ReDocly)](https://developer.adobe.com/commerce/webapi/rest/quick-reference/).

## Sucesso

Quando a solicitação de cancelamento de pedido é realizada com sucesso, o caminho de saída do conector terá um booleano com valor `true`, e com código de sucesso 200. Isto indica que o pedido teve sua situação alterada com sucesso na loja virtual.

<figure><img src="https://215079342-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F226k0cnPTn1PWu9xHcK8%2Fuploads%2FfBXG3jyulnsYr7fCXMBp%2Fimage.png?alt=media&#x26;token=d62dfec9-d81c-4f0d-b790-219155307c79" alt=""><figcaption><p>Sucesso no cancelamento de pedido</p></figcaption></figure>

## Erros

Caso a solicitação de cancelamento de pedido tenha falha será retornado um booleano com valor `false` e o código de status 200. Isto indica que a requisição foi realizada, porém o pedido não estava disponível para cancelamento na loja virtual. Consulte o fluxo de situações de pedidos, o método de pagamento utilizado e a disponibilidade do cancelamento de pedidos nas configurações da plataforma.

<figure><img src="https://215079342-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F226k0cnPTn1PWu9xHcK8%2Fuploads%2FqldRdi7gFPC9H3spT3tp%2Fimage.png?alt=media&#x26;token=2ac7f25d-061b-44cf-9a67-d3833d3c2cd0" alt=""><figcaption><p>Erro no cancelamento de pedido</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.