Get an Order by Code

GET

https://sandbox-api.deliveryapp.com/api/v1/orders/by-code/:code

GET

/api/v1/orders/by-code/:code

$ curl https://sandbox-api.deliveryapp.com/api/v1/orders/by-code/code \
>      -H "Authorization: Bearer <token>"

1 {
2   "data": {
3     "id": "string",
4     "code": "DA9N3B6P",
5     "type": "delivery",
6     "order_date": "2023-01-15",
7     "fulfilment_date": "2023-01-15",
8     "internal_ref": "string",
9     "status": "accepted",
10     "total_items": 1,
11     "is_urgent": true,
12     "started_at": "2023-01-11 08:30:15",
13     "completed_at": "2023-01-11 08:30:15",
14     "canceled_at": "2023-01-11 08:30:15",
15     "time_change_requests": 1,
16     "vehicle": {
17       "id": 5,
18       "title": "Small Van"
19     },
20     "payment_card": {
21       "id": "string",
22       "number": "3925",
23       "type": "visa"
24     },
25     "additional_notes": "string",
26     "co_loading": true,
27     "two_man_delivery": true,
28     "has_handballing": true,
29     "cost_of_goods": 123456,
30     "cost_of_goods_formatted": "£1,234.56",
31     "driver": {
32       "id": "string",
33       "first_name": "Chris",
34       "full_name": "Chris Grolent",
35       "contact_number": "07123456789",
36       "profile_image": "string",
37       "has_uploaded_profile_image": true,
38       "total_deliveries": 72,
39       "average_rating": 4.8
40     },
41     "time_zone": "Europe/London",
42     "locations": [
43       {
44         "id": 24013,
45         "delivery_id": 5146,
46         "time_from": "11:00:00",
47         "time_to": "11:30:00",
48         "tracking_code": "DA6A3U7U-13447",
49         "web_tracking_url": "https://www.zippd.com/tracking/?code=DA6A3U7U-13447&email=recipient@example.com",
50         "address": {
51           "address_line_1": "123 Grovesby Road",
52           "address_line_2": "Billingham House, Flat 45",
53           "city": "Manchester",
54           "postcode": "M1 2AB",
55           "latitude": 53.477582,
56           "longitude": -2.255331
57         },
58         "contact_details": {
59           "contact_name": "Jane Doe",
60           "phone_number": "07123456789",
61           "email": "contact@example.com",
62           "company_name": "Example Company"
63         },
64         "driver_arriving_time": "2023-01-11 11:15:08",
65         "driver_leaving_time": "2023-01-11 11:21:37",
66         "requires_handballing": true,
67         "total_items": 1,
68         "instruction": "address",
69         "instruction_details": "string",
70         "what3words": "issued.assure.courier",
71         "client_system_delivery_id": "string",
72         "barcodes": [
73           {
74             "code": "DA021758014227000253",
75             "code_formatted": "DA 021758 014227 000253",
76             "order_location_id": 1,
77             "pickup_latitude": 53.477582,
78             "pickup_longitude": -2.255331,
79             "pickup_datetime": "2023-01-09 11:05:55",
80             "drop_off_latitude": 53.612242,
81             "drop_off_longitude": -2.152356,
82             "drop_off_datetime": "2023-01-09 12:36:27",
83             "undeliverable": true,
84             "undeliverable_reason": "Could not gain access to location",
85             "printable_label_url": "https://sandbox-api.deliveryapp.com/package-label/print/barcode/5c1a370d-26eb-4afe-b18a-6f531dd00eb1/DA021758014227000253",
86             "created_at": "2023-01-05 09:00:00",
87             "updated_at": "2023-01-05 09:00:00"
88           }
89         ],
90         "printable_label_url": "https://sandbox-api.deliveryapp.com/package-label/print/location/5c1a370d-26eb-4afe-b18a-6f531dd00eb1/24013",
91         "proof_of_delivery": {
92           "photo": "string",
93           "signature": "string",
94           "signer_name": "Jane Doe",
95           "coordinates": {
96             "latitude": 53.477582,
97             "longitude": -2.255331
98           }
99         }
100       }
101     ],
102     "prices": {
103       "total_price": 123456,
104       "total_price_formatted": "£1,234.56",
105       "total_price_no_vat": 100030,
106       "total_price_no_vat_formatted": "£1,003.10",
107       "order_price": 60072,
108       "order_price_formatted": "£600.72",
109       "order_price_no_vat": 50060,
110       "order_price_no_vat_formatted": "£500.60",
111       "handball_price": 1800,
112       "handball_price_formatted": "£18.00",
113       "handball_price_no_vat": 1500,
114       "handball_price_no_vat_formatted": "£15.00",
115       "extra_mileage_cost": 5400,
116       "extra_mileage_cost_formatted": "£54.00",
117       "extra_mileage_cost_no_vat": 4500,
118       "extra_mileage_cost_no_vat_formatted": "£45.00",
119       "extra_time_cost": 5400,
120       "extra_time_cost_formatted": "£54.00",
121       "extra_time_cost_no_vat": 4500,
122       "extra_time_cost_no_vat_formatted": "£45.00",
123       "surcharge_cost": 14814,
124       "surcharge_cost_formatted": "£148.14",
125       "surcharge_cost_no_vat": 12345,
126       "surcharge_cost_no_vat_formatted": "£123.45",
127       "total_vat": 32132,
128       "total_vat_formatted": "£321.32"
129     },
130     "allowed_distance": {
131       "postcode": "M1 2AB",
132       "latitude": 53.477582,
133       "longitude": -2.255331,
134       "distance": 25
135     },
136     "barcodes": [
137       {
138         "code": "DA021758014227000253",
139         "code_formatted": "DA 021758 014227 000253",
140         "order_location_id": 1,
141         "pickup_latitude": 53.477582,
142         "pickup_longitude": -2.255331,
143         "pickup_datetime": "2023-01-09 11:05:55",
144         "drop_off_latitude": 53.612242,
145         "drop_off_longitude": -2.152356,
146         "drop_off_datetime": "2023-01-09 12:36:27",
147         "undeliverable": true,
148         "undeliverable_reason": "Could not gain access to location",
149         "printable_label_url": "https://sandbox-api.deliveryapp.com/package-label/print/barcode/5c1a370d-26eb-4afe-b18a-6f531dd00eb1/DA021758014227000253",
150         "created_at": "2023-01-05 09:00:00",
151         "updated_at": "2023-01-05 09:00:00"
152       }
153     ],
154     "printable_label_url": "https://sandbox-api.deliveryapp.com/package-label/print/order/5c1a370d-26eb-4afe-b18a-6f531dd00eb1",
155     "duration": "half-day",
156     "total_time": {
157       "seconds": 15323,
158       "display": "04:15:23"
159     },
160     "additional_time": {
161       "seconds": 923,
162       "display": "00:15:23"
163     },
164     "mileage": {
165       "total_miles": 47
166     }
167   }
168 }

Use an order code or tracking code to find and retrieve an order.

Authentication

AuthorizationBearer

Path parameters

codestringRequired

Response

dataobject

A single order's data for consumption by users who can place orders.

Errors

401

Unauthorized Error

404

Not Found Error