Aceite um cancelamento

curl --request POST \
  --url https://api.dev.connect.onbeefapp.com.br/v1/orders/{orderId}/acceptCancellation \
  --header 'Authorization: Bearer <token>'

POST

orders

{orderId}

acceptCancellation

Aceite um cancelamento

curl --request POST \
  --url https://api.dev.connect.onbeefapp.com.br/v1/orders/{orderId}/acceptCancellation \
  --header 'Authorization: Bearer <token>'

Chame este endpoint quando sua loja aceitar uma solicitação CANCELLATION_REQUESTED.

Parâmetros de rota

orderId

string (uuid)

required

Identificador único do pedido cujo cancelamento você está aceitando. Gerado pela Onbeef e retornado no evento do pedido.

Corpo da requisição

Este endpoint não exige corpo de requisição.

Resposta

204: Sem conteúdo

O cancelamento foi aceito. O pedido está cancelado e nenhum corpo de resposta é retornado.

401: Não autorizado

Retornado quando a requisição não inclui credenciais de autenticação válidas.

404: Não encontrado

Nenhum pedido foi encontrado com o orderId informado.

Exemplo de requisição

curl --request POST \
  --url "https://api.dev.connect.onbeefapp.com.br/v1/orders/f47ac10b-58cc-4372-a567-0e02b2c3d479/acceptCancellation" \
  --header "Authorization: Bearer <token>"

curl --request POST \
  --url "https://api.connect.onbeefapp.com.br/v1/orders/f47ac10b-58cc-4372-a567-0e02b2c3d479/acceptCancellation" \
  --header "Authorization: Bearer <token>"

Só chame este endpoint se você ainda consegue interromper o preparo. Se o pedido já estiver preparado aguardando retirada, considere usar o endpoint Negar cancelamento e comunicar-se com o cliente pelo canal de suporte adequado.

Ao receber um evento CANCELLATION_REQUESTED, você precisa responder com acceptCancellation ou denyCancellation. Deixar a solicitação sem resposta pode afetar a reputação da sua loja na plataforma Onbeef.

Solicitar cancelamento Negar cancelamento

⌘I

Visão geral

Autenticação

Merchant

Pedidos

Logística

Aceite um cancelamento

Parâmetros de rota

Corpo da requisição

Resposta

204: Sem conteúdo

401: Não autorizado

404: Não encontrado

Exemplo de requisição

​Parâmetros de rota

​Corpo da requisição

​Resposta

​204: Sem conteúdo

​401: Não autorizado

​404: Não encontrado

​Exemplo de requisição

Parâmetros de rota

Corpo da requisição

Resposta

204: Sem conteúdo

401: Não autorizado

404: Não encontrado

Exemplo de requisição