Change delivery statuses

You can use this endpoint to change the status of a delivery. Here you can add comments or include reasons for issues previously created in the system. To learn more about Shippify's statuses click here.

Update the status of a delivery

Update the status of a delivery by its ID or reference.

patch

/v1/deliveries/{id}/status

Authorizations

Path parameters

idstringrequired

Identifier or reference ID of the delivery to change status.

Body

commentstringrequired

Comment of the change

Example: Dangerous area

statusstring · enumrequired

New status of the route

Example: hold_by_courier

Options: pending_to_review, processing, broadcasting, assigned, confirmed_to_pickup, going_to_pickup, at_pickup, on_delivery, going_to_dropoff, at_dropoff, dropped_off, completed, canceled, going_to_return, at_return_point, returned, not_picked_up, not_picked_up_payable, hold_by_courier

authorobject

Information of the user making the status change

reasonByCompanyobject[]

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url 'https://api.shippify.co/v1/deliveries/{id}/status' \
  --header 'Authorization: Basic username:password' \
  --header 'Content-Type: application/json' \
  --data '{
    "comment": "Dangerous area",
    "status": "hold_by_courier",
    "author": {
      "id": 1149,
      "name": "Developers",
      "email": "[e-mail]",
      "type": "operator"
    },
    "reasonByCompany": [
      {
        "reasonId": 67,
        "reason": "DANGEROUS AREA"
      }
    ]
  }'

200

401

200

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

Successful operation

Use cases

Update status by referenceId

You can use the delivery's reference ID in the URL of the request to change its status.

Cancel delivery

{
    "status": "canceled",
    "comment": "TEST",
    "author": {
        "email": "[e-mail]",
        "id": 999,
        "name": "Test operator",
        "type": "operator"
    }
}

Change the status to "hold by courier" with a reason for the problem

{
    "status": "hold_by_courier",
    "comment": "South of the city",
    "reasonByCompany": [
        {
            "companyId": "9065",
            "reasonId": 67,
            "reason": "Risky area"
        }
    ],
    "author": {
        "type": "operator",
        "id": 1149,
        "name": "Developers",
        "email": "[e-mail]"
    }
}

Complete a delivery

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