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
Parámetros de ruta
idstringRequerido

Identifier or reference ID of the delivery to query.

Respuestas
200
Successful operation
application/json
get
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": "Iliana Bolaños",
    "email": "[email protected]",
    "phonenumber": "0998976565"
  },
  "pickup": {
    "date": "2023-10-27T18:24:11.000Z"
  },
  "dropoff": {},
  "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": "slot",
        "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.

Última actualización