Pular para o conteúdo principal

Cancelar pedido

Solicita o cancelamento de um pedido. O fluxo é assíncrono: a API retorna imediatamente com um operationId; o cancelamento efetivo ocorre em background.

POST /v1/orders/{orderNumber}/cancel​

  • Authorization: Basic Auth com chave pública e secreta do cliente.
    • Exemplo: Basic <base64-encoded-credentials>
  • x-contractAccountId: Identificador da conta do contrato do cliente.
    • Exemplo: x-contractAccountId: 9f36a666-acd5-4987-a47f-3de247f65d82

Exemplo de autorização​

Para gerar o valor de Authorization, codifique suas credenciais (public_key:secret_key) em base64:

echo -n 'public_key:secret_key' | base64

Parâmetros da requisição​

  • orderNumber (path, obrigatório): Número do pedido a ser cancelado.

Corpo da requisição​

Não há corpo. Apenas o orderNumber na URL.

Respostas​

  • 200: Solicitação aceita. O pedido foi enviado para cancelamento. O corpo inclui operationId e Message.
  • 400: Requisição inválida (ex.: dados mal formatados).
  • 500: Erro interno do servidor.

Exemplo de resposta de sucesso (200)​

{
  "operationId": "5f1d265b-d836-40f7-84dd-7ded9804039d",
  "Message": "Pedido enviado para cancelamento"
}

Exemplo de notificação via webhook​

O resultado do cancelamento pode ser recebido via webhook (eventos de pedido configurados). Em caso de sucesso, o status do pedido é atualizado (ex.: ORDER_CANCELLED, ORDER_CANCELLATION_ANALYSIS). Em caso de falha, o evento Order_CancelFailed pode ser enviado.

Consulte a documentação de webhooks para configurar e assinar os eventos desejados.

Referências​