Get delivery information

This endpoint provides a comprehensive view of a delivery, either with the delivery identifier or with its reference ID.

Check delivery information

Retrieve data for a delivery by its ID or reference.

GEThttps://api.shippify.co/v1/deliveries/{id}/complete

Authorization

Basic_Auth

Path parameters

id*string

Identifier or reference ID of the delivery to query.

Response

200401

Successful operation

Body

application/json

idstring

Identifier of the delivery in Shippify.

Example: "t-shiinc-27946"

routeobject

Information about the route to which the delivery belongs.

recipientcontact (object)

Contact information of the person responsible for delivering the packages at the pickup warehouse.

pickupobject

dropoffobject

Delivery information

courierobject

Driver details

itemsarray of array of package (object)

Delivery packages

statusinteger

Delivery status code

Example: 3

_statusstring

Delivery status name

Example: "assigned"

status_langstring

Delivery status name in the account's language

Example: "Assigned"

distancenumber

Distance between pickup and delivery points

Example: 10.4

companystring

Task company name

Example: "TextLam"

referenceIdstring

External delivery identifier, such as order number

Example: "PO-00012"

reasonIdinteger

Identifier of the reason for the status change

Example: 1

reasonTextstring

Description of the reason for the status change

Example: "DANGER ZONE"

problem_notestring

Status change comment

Example: "Dangerous zone"

lastStatusDatestring

Date of the last status change

Example: "2023-10-27T19:09:11.000Z"

tagsarray of string

Delivery digital tag names.

Request

JavaScriptCurlPython

const response = await fetch('https://api.shippify.co/v1/deliveries/{id}/complete', {
    method: 'GET',
    headers: {
      "Authorization": "basic <token>"
    },
});
const data = await response.json();

Response

200401

{
  "id": "t-shiinc-27946",
  "route": {
    "id": "r-shiinc-2183891",
    "order": 2
  },
  "recipient": {
    "name": "Iliana Bolaños",
    "email": "[e-mail]",
    "phonenumber": "0998976565"
  },
  "pickup": {
    "date": "2023-10-27T18:24:11.000Z"
  },
  "courier": {
    "info": {
      "shipperId": 531597,
      "shipperDocId": "111000011123",
      "shipperName": "Juan Maroto",
      "shipperCapacity": "medium",
      "vehicleLicensePlate": "PO-1234",
      "vehicleType": "Suzuki",
      "vehicleModel": "Vitara"
    },
    "location": {
      "lat": -33.511333999,
      "lng": -70.6102933
    }
  },
  "items": [
    [
      {
        "id": "Product-001",
        "name": "Color box",
        "qty": 4,
        "weight": 5.3,
        "size": "flex",
        "price": 5.3
      }
    ]
  ],
  "status": 3,
  "_status": "assigned",
  "status_lang": "Assigned",
  "distance": 10.4,
  "company": "TextLam",
  "referenceId": "PO-00012",
  "reasonId": 1,
  "reasonText": "DANGER ZONE",
  "problem_note": "Dangerous zone",
  "lastStatusDate": "2023-10-27T19:09:11.000Z",
  "tags": [
    "Fragile"
  ]
}

Use cases

Retrieve information about a delivery by its ID.

You can use the delivery ID in the request URL to fetch its information.

Retrieve information about a delivery by its reference ID

You can use the delivery reference ID in the request URL to fetch its information.