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

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

PATCHhttps://api.shippify.co/v1/routes/{id}/status

Authorization

Basic_Auth

Path parameters

id*string

Identifier of the route to change its status.

Body

application/json

Description goes here

status*enum

New status of the route

Example: "hold_by_courier"

pending_to_reviewprocessingbroadcastingassignedconfirmed_to_pickupgoing_to_pickupat_pickupon_deliverygoing_to_dropoffat_dropoffdropped_offcompletedcanceledgoing_to_returnat_return_pointreturnednot_picked_upnot_picked_up_payablehold_by_courier

comment*string

Comment of the change

Example: "Dangerous area"

reasonByCompanyarray of object

Predefined reasons for the change of status

authorobject

Information of the user making the status change

Response

200401

Successful operation

Body

application/json

codestring

Example: "OK"

messagestring

Example: "Success"

Request

JavaScriptCurlPython

const response = await fetch('https://api.shippify.co/v1/routes/{id}/status', {
    method: 'PATCH',
    headers: {
      "Authorization": "basic <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "status": "hold_by_courier",
      "comment": "Dangerous area"
    }),
});
const data = await response.json();

Response

200401

{
  "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]"
    }
}