Cancellation request

This action can be done via endpoint, directly on the plataform by the seller or automatically by the system if the order needed to be cancelled by any reason. In both cases this action is restricted to when the order has not been collected, either before the collection or if the driver failed to collect

Whenever this action is done, an event is triggered and a POST request is sent to the URL you provided for cancellation.

The payload is like the one shown below:

SELLER_CANCELED

{
  "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": "88399480000156",
  "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"
}

CARRIER_TIMEOUT

{
  "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": "88399480000156",
  "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
}