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

get

Retrieve data for a delivery by its ID or reference.

Autorizaciones

Basic_Auth

AuthorizationstringRequerido

Parámetros de ruta

idstringRequerido

Identifier or reference ID of the delivery to query.

Respuestas

200

Successful operation

application/json

idstringOpcional

Identifier of the delivery in Shippify.

Example: t-shiinc-27946

dropoffobjectOpcional

Delivery information

statusinteger · mín: 1Opcional

Delivery status code

Example: 3

_statusstringOpcional

Delivery status name

Example: assigned

status_langstringOpcional

Delivery status name in the account's language

Example: Assigned

distancenumberOpcional

Distance between pickup and delivery points

Example: 10.4

companystringOpcional

Task company name

Example: Company ABC

referenceIdstringOpcional

External delivery identifier, such as order number

Example: PO-00012

reasonIdinteger · mín: 1Opcional

Identifier of the reason for the status change

Example: 1

reasonTextstringOpcional

Description of the reason for the status change

Example: DANGER ZONE

problem_notestringOpcional

Status change comment

Example: Dangerous zone

lastStatusDatestringOpcional

Date of the last status change

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

tagsstring[]Opcional

Delivery digital tag names.

Example: Fragile

401

Unauthorized

application/json

get

/v1/deliveries/{id}/complete

HTTPcURLJavaScriptPython

GET /v1/deliveries/{id}/complete HTTP/1.1
Host: api.shippify.co
Authorization: Basic username:password
Accept: */*

{
  "id": "t-shiinc-27946",
  "route": {
    "id": "r-shiinc-2183891",
    "order": 2
  },
  "recipient": {
    "name": "Juan Perez",
    "email": "[email protected]",
    "phonenumber": "9999999999"
  },
  "pickup": {
    "date": "2023-10-27T18:24:11.000Z"
  },
  "dropoff": {},
  "courier": {
    "info": {
      "shipperId": 531597,
      "shipperDocId": "9999999999",
      "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": "xs",
        "price": 5.3
      }
    ]
  ],
  "status": 3,
  "_status": "assigned",
  "status_lang": "Assigned",
  "distance": 10.4,
  "company": "Company ABC",
  "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.