Cambiar de estado una ruta

Puede utilizar este endpoint para cambiar el estado de todas las entregas de una ruta.

Actualizar el estado de una ruta

patch

Actualizar el estado de una ruta, incluyendo todas sus entregas.

Autorizaciones
Parámetros de ruta
idstringRequerido

Identifier of the route to change its status.

Cuerpo
statusstring · enumRequerido

Nuevo estado de la ruta

Example: hold_by_courierValores posibles:
commentstringRequerido

Comentario del cambio

Example: Dangerous area
Respuestas
200
Operación exitosa
application/json
patch
PATCH /v1/routes/{id}/status HTTP/1.1
Host: api.shippify.co
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 209

{
  "status": "hold_by_courier",
  "comment": "Dangerous area",
  "reasonByCompany": [
    {
      "reasonId": 67,
      "reason": "DANGEROUS AREA"
    }
  ],
  "author": {
    "type": "operator",
    "id": 1149,
    "name": "Developers",
    "email": "[email protected]"
  }
}
{
  "code": "OK",
  "message": "Success"
}

Casos de uso

Cancelar ruta
{
    "status": "canceled",
    "comment": "",
    "author": {
        "type": "operator",
        "id": 1149,
        "name": "Developers",
        "email": "[email protected]"
    }
}
Completar ruta
{
    "status": "completed",
    "comment": "",
    "author": {
        "type": "operator",
        "id": 1149,
        "name": "Developers",
        "email": "[email protected]"
    }
}

Última actualización