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

Basic_Auth

AuthorizationstringRequerido

Parámetros de ruta

idstringRequerido

Identifier of the route to change its status.

Cuerpo

application/json

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

codestringOpcionalExample: OK

messagestringOpcionalExample: Success

401

No autorizado

application/json

patch/v1/routes/{id}/status

HTTPcURLJavaScriptPython

PATCH /v1/routes/{id}/status HTTP/1.1
Host: api.shippify.co
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 201

{
  "status": "hold_by_courier",
  "comment": "Dangerous area",
  "reasonByCompany": [
    {
      "reasonId": 67,
      "reason": "DANGEROUS AREA"
    }
  ],
  "author": {
    "type": "operator",
    "id": 1,
    "name": "Juan Perez",
    "email": "[e-mail]"
  }
}

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

Casos de uso

Cancelar ruta

{
    "status": "canceled",
    "comment": "",
    "author": {
        "type": "operator",
        "id": 1,
        "name": "Juan Perez",
        "email": "[e-mail]"
    }
}

Completar ruta

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