Solicitação de cancelamento

No guia

Contexto operacional: Transportadora · Homologação.

Essa ação pode ser realizada via endpoint, diretamente na plataforma pela filial ou automaticamente pelo sistema caso o pedido precise ser cancelado por qualquer motivo. Em ambos os casos, esta ação é restrita a situações em que o pedido ainda não foi coletado — seja antes da coleta ou quando o motorista não conseguiu realizar a coleta.

Sempre que essa ação é executada, um evento é disparado e uma requisição POST é enviada à URL que você forneceu para cancelamento.

O payload é similar ao mostrado abaixo:

{
  "event_type": "CANCELLATION_REQUEST",
  "delivery_id": "4278444b-d4e5-4890-8d12-ad3cacd7aaaa",
  "order_number": "example_carrier_payload_1",
  "tracking": "8oRjvvv",
  "seller_id": "5b2d4006-f0af-47d3-943e-e8352aaaaaa",
  "seller_name": "Go Go Fruits",
  "seller_document_number": "12345678000190",
  "seller_group_id": "b7d56bca-606e-405e-bf4d-9b0a3291b61d",
  "status": "ORDER_FAILED",
  "sub_status": "SELLER_CANCELED",
  "timestamp": 1671134757870,
  "event_at": "2022-12-15T20:05:56Z",
  "support_id": "xxx-yyy-zzz"
}

{
  "event_type": "CANCELLATION_REQUEST",
  "delivery_id": "4278444b-d4e5-4890-8d12-ad3cacd7aaaa",
  "order_number": "example_carrier_payload_1",
  "tracking": "8oRjvvv",
  "seller_id": "5b2d4006-f0af-47d3-943e-e8352aaaaaa",
  "seller_name": "Go Go Fruits",
  "seller_document_number": "12345678000190",
  "seller_group_id": "b7d56bca-606e-405e-bf4d-9b0a3291b61d",
  "status": "ORDER_FAILED",
  "sub_status": "CARRIER_TIMEOUT",
  "timestamp": 1671134757870,
  "event_at": "2022-12-15T20:05:56Z",
  "support_id": null
}