Embarcador (LOG)Frota Própria (GO)TransportadoraTMSTrackingAPI ReferenceChangelog
Pedidos (Orders)

Cancelar pedido

Cancela um pedido por completo — agendamento, entrega e o próprio pedido. Se a entrega não puder ser cancelada, o pedido não é cancelado e a API retorna um erro claro.

Header obrigatório. Toda chamada exige o header x-abbiamo-seller-group-key. Preencha-o no canto superior direito desta página ou veja como obter a sua chave.

Rate limit: 300 requisições por minuto por chave. Acima disso a API retorna HTTP 429.

O que acontece ao cancelar

Use este endpoint quando o cliente quiser cancelar o pedido por qualquer motivo. Numa única chamada, o cancelamento:

  1. Cancela o agendamento e a entrega. A mesma operação cobre os dois cenários: se a entrega está apenas agendada (ainda não despachada), o agendamento é cancelado na hora; se já foi despachada à transportadora, a entrega é cancelada enquanto o pacote ainda não foi coletado.
  2. Cancela o próprio pedido. Só depois que a entrega é cancelada (ou quando não há entrega a cancelar) é que o pedido é marcado como cancelado.

O cancelamento da entrega é a etapa de bloqueio. Se a entrega não puder ser cancelada — por exemplo, quando o pedido já está em uma rota (trip) / em trânsito —, a chamada retorna HTTP 400 com o código ORDER_DELIVERY_NOT_CANCELABLE e o pedido não é cancelado. Pedidos sem nenhuma entrega são cancelados normalmente.

PUT
/seller-group/v1/orders/{order_id}/cancel

Authorization

sellerGroupKey
x-abbiamo-seller-group-key<token>

In: header

Path Parameters

order_id*string

Identificador único do pedido

Response Body

application/json

application/json

application/json

application/json

curl -X PUT "https://example.com/seller-group/v1/orders/string/cancel"
{
  "success": true
}
{
  "code": "ORDER_DELIVERY_NOT_CANCELABLE",
  "message": "Cannot cancel order with status DISPATCHED",
  "status": 400,
  "params": {
    "order_id": "xxx"
  }
}
{
  "message": "Unauthorized"
}
{
  "code": "ORDER_NOT_FOUND",
  "message": "Order with id: xxx does not found",
  "status": 404,
  "params": {
    "order_id": "xxx"
  }
}

Cancelar envio PUT

Cancela uma entrega ativa ou agendada. Use antes de a transportadora coletar o pacote.

Verificações do pedido (coleta e retorno) GET

Informa as verificações do pedido — coleta, entrega e retorno — cobrindo os dois modelos de pincode, e retorna o código quando ele deve ser exibido ao operador.

Nesta página

O que acontece ao cancelar