Change the status of a route

You can use this endpoint to change the status of all deliveries within a route.

Update the status of a route

patch

Update the status of a route, including all its deliveries.

Autorizaciones

Parámetros de ruta

idstringRequerido

Identifier of the route to change its status.

Cuerpo

statusstring · enumRequerido

New status of the route

Example: hold_by_courierValores posibles:

commentstringRequerido

Comment of the change

Example: Dangerous area

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": "Dangerous area",
  "reasonByCompany": [
    {
      "reasonId": 67,
      "reason": "DANGEROUS AREA"
    }
  ],
  "author": {
    "type": "operator",
    "id": 1149,
    "name": "Developers",
    "email": "[email protected]"
  }
}

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

Use cases

Cancel a route

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

Complete a route

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