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.

Authorizations

Path parameters

idstringrequired

Identifier of the route to change its status.

Body

statusstring · enumrequired

New status of the route

Example: hold_by_courierAvailable options:

commentstringrequired

Comment of the change

Example: Dangerous area

reasonByCompanyobject[]optional

Predefined reasons for the change of status

authorobjectoptional

Information of the user making the status change

Responses

application/json

objectoptional

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": "[e-mail]"
  }
}

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

Use cases

Cancel a route

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

Complete a route

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