Abbiamo DocsCancelar envio
Cancela uma entrega ativa ou agendada. Use antes de a transportadora coletar o pacote.
Conceito relacionado
Entenda o conceito no guia: Envio (Delivery).
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.
Entregas em andamento e agendadas
Esta mesma chamada cobre os dois cenários — você não precisa saber em qual estágio o pedido está:
- Entrega agendada (ainda não despachada). Quando o pedido tem uma entrega agendada para um horário futuro e que ainda não foi enviada à transportadora, a chamada cancela o agendamento na hora. Não é preciso esperar a data do despacho.
- Entrega em andamento. Quando o pedido já foi despachado, o cancelamento vale enquanto a transportadora ainda não coletou o pacote. Depois da coleta, o cancelamento não é mais aceito.
Authorization
sellerGroupKey In: header
Path Parameters
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-delivery"{
"success": true
}{
"message": "Cannot cancel order with status DISPATCHED"
}{
"message": "Unauthorized"
}"{\n \"code\": \"ORDER_NOT_FOUND\",\n \"message\": \"Order with id: xxx does not found\",\n \"status\": 404,\n \"params\": { \n \"order_id\": \"xxx\"\n },\n}"Reenviar envio POST
Tenta despachar novamente um pedido que retornou ou falhou, mantendo a última modalidade usada.
Cancelar pedido PUT
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.