Change route status

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

To cancel the route you can use this endpoint with canceled status.

Endpoint

PATCH {{SHIPPIFY_API_URL}}/v1/routes/:id/status

Request

Params

Property	Type	Description	Required	Constraints
id	string	Id of the route created within the system	YES

Body

Property	Type	Description	Required	Constraints
status	string	Status code you want to change to.	YES	You can see all status code in this table. Statuses
comment	string	Short description of the change.	YES
author	object	Information of the operator who makes the change.	YES

Response

Property	Type	Description
code	string	Result code.
message	string	Result description.

Example

Request

curl --location --request PATCH 'https://api.shippify.co/v1/deliveries/t-pruaas-4973/status' \
--header 'Authorization: Basic XXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--header 'Content-Type: application/json' \
--header 'Cookie: locale=es' \
--data-raw '{
  "author": {
    "type": "operator",
    "id": 1149,
    "name": "Developers",
    "email": "[e-mail]"
  },
  "status": "assigned",
  "comment": "e"
}'

200 Success

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