Cancelar Envío
Descripción General
Este flujo permite cancelar un envío en curso mediante la selección de una razón de cancelación, obtenida de la API, y el posterior envío de dicha razón junto con el identificador del viaje a la API de cancelación.
Obtener razones de cancelación
Para cancelar un envío, primero debes hacer una solicitud GET al siguiente endpoint para obtener una lista de las razones de cancelación disponibles:
bash
GET baseURL/V2/corporate-api-partner/cancellation-reasons
Cancelar el envío
Una vez seleccionada la razón de cancelación (usando el cancel_reason_id), puedes proceder a cancelar el envío utilizando el siguiente endpoint POST:
bash
POST baseURL/V2/corporate-api-partner/cancel-trip
El cuerpo de la solicitud POST debe incluir los siguientes parámetros:
json
{
"trip_id": "66f423c6bf698642e0ff31a4",
"cancel_reason_id": "66f417c494a09bbcda19e2ee",
"cancel_description": "Cancelado desde postman"
}
Campo | Descripción | Tipo | Requerido/Opcional |
---|---|---|---|
trip_id | Identificador único del viaje que se desea cancelar. | String | Requerido |
cancel_reason_id | Identificador único de la razón de cancelación obtenida previamente. | String | Requerido |
cancel_description | Descripción adicional para la cancelación del viaje. | String | Opcional |
Respuesta
La respuesta de la solicitud POST al cancelar el envío es similar a la siguiente:
json
{
"success": true,
"code": "00",
"msg": "El viaje ha sido cancelado exitosamente.",
"data": {
"cancelled": true,
"trip": { "_id": "trip_id" }
}
}
Campo | Descripción | Tipo |
---|---|---|
cancelled | Viaje/envío cancelado con éxito. | Boolean |
trip._id | Identificador único del viaje cancelado. | String |