Cambiar de estado una ruta

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

Actualiza el estado de una ruta

patch

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

Autorizaciones

Parámetros de ruta

idstringRequerido

Identificador de la ruta a cambiar de estado.

Cuerpo

statusstring · enumRequerido

Nuevo estado de la ruta

Example: hold_by_courierValores posibles:

commentstringRequerido

Comentario del cambio

Example: Zona peligrosa

Respuestas

200

Successful operation

application/json

401

Unauthorized

application/json

patch

HTTPcURLJavaScriptPython

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": "Zona peligrosa",
  "reasonByCompany": [
    {
      "reasonId": 67,
      "reason": "ZONA PELIGROSA"
    }
  ],
  "author": {
    "type": "operator",
    "id": 1149,
    "name": "Developers",
    "email": "[e-mail]"
  }
}

{
  "code": "OK",
  "message": "Success"
}

Casos de uso

Cancelar ruta

{
    "status": "canceled",
    "comment": "",
    "author": {
        "type": "operator",
        "id": 1149,
        "name": "Developers",
        "email": "[e-mail]"
    }
}

Completar ruta

{
    "status": "completed",
    "comment": "",
    "author": {
        "type": "operator",
        "id": 1149,
        "name": "Developers",
        "email": "[e-mail]"
    }
}