Comment on page
Get delivery
This endpoint provides you with a complete overview of a delivery. You can request this endpoint through the `delivery_id` or any other reference declared when creating the delivery.
Reference Ids are identifiers from your system that can be attached to a Shippify delivery so you can later on fetch it through it.
GET /v1/deliveries/:deliveryId/complete
Property | Type | Description | Required | Constraints |
|---|---|---|---|---|
deliveryId | string | Id of the task created within the system, you can also use the reference id here | YES | |
Property | Type | Description |
|---|---|---|
id | string | Id of the task created within the system. |
route | object | Route data. |
route.id | array | Id of the route assigned at delivery. |
route.order | number | Position of the delivery in the route. |
recipient | Contact information of the person who will provide the packages at the time of collection. | |
pickup | object | Price for that particular delivery. |
pickup.date | string | Estimated date of pickup. Format AAAA-MM-DDTHH:mm:ss.000Z |
dropoff | object | Dropoff data. |
dropoff.location | Dropoff location data. | |
dropoff.date | string | Estimated date of dropoff. Format AAAA-MM-DDTHH:mm:ss.000Z |
courier | object | Driver assigned information. |
courier.info | number | Driver assigned information. |
courier.info.shipperId | number | Id of the driver assigned in the system. |
courier.info.shipperDocId | string | Document Id of the driver assigned in the system. |
courier.info.shipperName | string | Name of the driver assigned. |
courier.info.vehicleLicensePlate | number | Vehicle license plate of the driver assigned. |
courier.info.vehicleType | string | Vehicle type of the driver assigned. |
courier.info.vehicleModel | string | Vehicle model of the driver assigned. |
courier.location | object | Location of the driver assigned in the last status. |
courier.location.lat | number | Latitude of the driver assigned in the last status. |
courier.location.lng | number | Longitude of the driver assigned in the last status. |
items | Packages of the task | |
status | number | Id of current task state |
_status | string | Name of current task status |
status_lang | string | Name translation of current task status |
distance | number | Distance between the pickup point and the delivery point for this task. |
company | string | Company name |
referenceId | string | Reference id of the task |
metadata | object | Additional data of the task |
groupId | string | Id of the task group |
reasonId | number | This field is filled when the task has a pickup/dropoff problem. |
reasonText | string | Reason description |
lastStatusDate | string | Date of last update status |
tags | array of string | Tags of the task |
Request
200 Sucess
curl --location --request GET 'https://api.shippify.co/v1/deliveries/t-pruaas-4973/complete' \
--header 'Authorization: Basic XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX=' \
--header 'Cookie: locale=es'
{
"id": "t-pruaas-4973",
"route": {
"id": "r-shiinc-2183891",
"order": 4
},
"recipient": {
"name": "Mayger Rene Montero Saavedra",
"email": "[email protected]",
"phonenumber": "777"
},
"pickup": {
"date": "2023-10-27T18:24:11.000Z"
},
"dropoff": {
"location": {
"lat": -33.56751,
"lng": -70.67549,
"originalAddress": "Los Castaños 11989 Casa, EL BOSQUE, SANTIAGO, CL",
"address": "los castaños 11989, 8010277 santiago, el bosque, región metropolitana, chile"
},
"date": "2023-10-27T19:09:11.000Z"
},
"courier": {
"info": {
"shipperId": 531597,
"shipperDocId": "111000011123",
"shipperName": "Juan Maroto",
"shipperCapacity": "medium",
"vehicleLicensePlate": "Test Placa",
"vehicleType": "Test Marca",
"vehicleModel": "Test Modelo"
},
"location": {}
},
"items": [
{
"name": "149123156552",
"size": 1,
"qty": 1,
"price": 0,
"weight": 0,
"sid": "t-pruaas-4973_1",
"uuid": "cbb09c5c-2209-428c-bc1e-d1cac8efb0f4"
}
],
"status": 3,
"_status": "assigned",
"status_lang": "Asignada",
"distance": 23.5,
"company": "TextLam",
"referenceId": null,
"metadata": {},
"groupId": null,
"reasonId": null,
"reasonText": null,
"lastStatusDate": "2023-10-27T20:00:30.000Z",
"tags": ["prime"]
}
Last modified 1mo ago