List All Orders

GET

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

GET

/api/v1/orders

$ curl https://sandbox-api.deliveryapp.com/api/v1/orders \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json"

200Retrieved

1 {
2   "data": [
3     {
4       "id": "a3f1c9e2-4b7d-4f3a-9c2e-8b7d9f1a2c3d",
5       "code": "DA9N3B6P",
6       "type": "delivery",
7       "order_date": "2023-01-15",
8       "fulfilment_date": "2023-01-15",
9       "internal_ref": "INV-2023-0157",
10       "status": "accepted",
11       "total_items": 3,
12       "is_urgent": true,
13       "started_at": "2023-01-15 08:30:15",
14       "completed_at": "2023-01-15 12:45:30",
15       "canceled_at": null,
16       "time_change_requests": 2,
17       "vehicle": {
18         "id": 5,
19         "title": "Small Van"
20       },
21       "payment_card": {
22         "id": "d9f1c2a3-4b7d-4f3a-9c2e-8b7d9f1a2c3d",
23         "number": "3925",
24         "type": "visa"
25       },
26       "additional_notes": "Leave packages at the back door if no answer.",
27       "co_loading": true,
28       "two_man_delivery": false,
29       "has_handballing": true,
30       "cost_of_goods": 234500,
31       "cost_of_goods_formatted": "£2,345.00",
32       "driver": {
33         "id": "d7a9f3b1-2c4e-4f6a-8b9d-1e2f3a4b5c6d",
34         "first_name": "Chris",
35         "full_name": "Chris Grolent",
36         "contact_number": "07123456789",
37         "profile_image": "https://sandbox-api.deliveryapp.com/images/drivers/chris_grolent.jpg",
38         "has_uploaded_profile_image": true,
39         "total_deliveries": 72,
40         "average_rating": 4.8
41       },
42       "time_zone": "Europe/London",
43       "locations": [
44         {
45           "id": 24013,
46           "delivery_id": 5146,
47           "time_from": "11:00:00",
48           "time_to": "11:30:00",
49           "tracking_code": "DA6A3U7U-13447",
50           "web_tracking_url": "https://www.zippd.com/tracking/?code=DA6A3U7U-13447&email=recipient@example.com",
51           "address": {
52             "address_line_1": "123 Grovesby Road",
53             "address_line_2": "Billingham House, Flat 45",
54             "city": "Manchester",
55             "postcode": "M1 2AB",
56             "latitude": 53.477582,
57             "longitude": -2.255331
58           },
59           "contact_details": {
60             "contact_name": "Jane Doe",
61             "phone_number": "07123456789",
62             "email": "contact@example.com",
63             "company_name": "Example Company"
64           },
65           "driver_arriving_time": "2023-01-15 11:15:08",
66           "driver_leaving_time": "2023-01-15 11:21:37",
67           "requires_handballing": true,
68           "total_items": 1,
69           "instruction": "address",
70           "instruction_details": "Gate code 1234 for back entrance",
71           "what3words": "issued.assure.courier",
72           "client_system_delivery_id": "CS-DEL-20230115-001",
73           "barcodes": [
74             {
75               "code": "DA021758014227000253",
76               "code_formatted": "DA 021758 014227 000253",
77               "order_location_id": 24013,
78               "pickup_latitude": 53.477582,
79               "pickup_longitude": -2.255331,
80               "pickup_datetime": "2023-01-15 10:45:00",
81               "drop_off_latitude": 53.612242,
82               "drop_off_longitude": -2.152356,
83               "drop_off_datetime": "2023-01-15 11:20:00",
84               "undeliverable": false,
85               "undeliverable_reason": null,
86               "printable_label_url": "https://sandbox-api.deliveryapp.com/package-label/print/barcode/5c1a370d-26eb-4afe-b18a-6f531dd00eb1/DA021758014227000253",
87               "created_at": "2023-01-10 09:00:00",
88               "updated_at": "2023-01-15 11:21:00"
89             }
90           ],
91           "printable_label_url": "https://sandbox-api.deliveryapp.com/package-label/print/location/5c1a370d-26eb-4afe-b18a-6f531dd00eb1/24013",
92           "proof_of_delivery": {
93             "photo": "https://sandbox-api.deliveryapp.com/proof-of-delivery/photos/5c1a370d-26eb-4afe-b18a-6f531dd00eb1.jpg",
94             "signature": "https://sandbox-api.deliveryapp.com/proof-of-delivery/signatures/5c1a370d-26eb-4afe-b18a-6f531dd00eb1.png",
95             "signer_name": "Jane Doe",
96             "coordinates": {
97               "latitude": 53.477582,
98               "longitude": -2.255331
99             }
100           }
101         }
102       ],
103       "prices": {
104         "total_price": 234500,
105         "total_price_formatted": "£2,345.00",
106         "total_price_no_vat": 195417,
107         "total_price_no_vat_formatted": "£1,954.17",
108         "order_price": 200000,
109         "order_price_formatted": "£2,000.00",
110         "order_price_no_vat": 166667,
111         "order_price_no_vat_formatted": "£1,666.67",
112         "extra_mileage_cost": 15000,
113         "extra_mileage_cost_formatted": "£150.00",
114         "extra_mileage_cost_no_vat": 12500,
115         "extra_mileage_cost_no_vat_formatted": "£125.00",
116         "extra_mileage_cost_vat_formatted": "£25.00",
117         "extra_time_cost": 10000,
118         "extra_time_cost_formatted": "£100.00",
119         "extra_time_cost_no_vat": 8333,
120         "extra_time_cost_no_vat_formatted": "£83.33",
121         "extra_time_cost_vat_formatted": "£16.67",
122         "surcharge_cost": 5000,
123         "surcharge_cost_formatted": "£50.00",
124         "surcharge_cost_no_vat": 4167,
125         "surcharge_cost_no_vat_formatted": "£41.67",
126         "surcharge_cost_vat_formatted": "£8.33",
127         "total_vat": 39083,
128         "total_vat_formatted": "£390.83"
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": 24013,
141           "pickup_latitude": 53.477582,
142           "pickup_longitude": -2.255331,
143           "pickup_datetime": "2023-01-15 10:45:00",
144           "drop_off_latitude": 53.612242,
145           "drop_off_longitude": -2.152356,
146           "drop_off_datetime": "2023-01-15 11:20:00",
147           "undeliverable": false,
148           "undeliverable_reason": null,
149           "printable_label_url": "https://sandbox-api.deliveryapp.com/package-label/print/barcode/5c1a370d-26eb-4afe-b18a-6f531dd00eb1/DA021758014227000253",
150           "created_at": "2023-01-10 09:00:00",
151           "updated_at": "2023-01-15 11:21:00"
152         }
153       ],
154       "printable_label_url": "https://sandbox-api.deliveryapp.com/package-label/print/order/5c1a370d-26eb-4afe-b18a-6f531dd00eb1",
155       "duration": null,
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   ],
169   "links": {
170     "current_page": 2,
171     "last_page": 4,
172     "per_page": 15,
173     "from": 16,
174     "to": 30,
175     "total": 57,
176     "path": "https://sandbox-api.deliveryapp.com/api/v1/orders"
177   },
178   "meta": {
179     "current_page": 2,
180     "last_page": 4,
181     "per_page": 15,
182     "from": 16,
183     "to": 30,
184     "total": 57,
185     "path": "https://sandbox-api.deliveryapp.com/api/v1/orders"
186   }
187 }

This endpoint retrieves orders of every type. Refer to the order type-specific parts of the documentation for working with orders of specific types.

Authentication

AuthorizationBearer

Query parameters

pageintegerOptionalDefaults to 1

The index of the page to retrieve from the results listing.

pickupDatedateOptional

Filter for jobs that are to be fulfilled on the given date. Format YYYY-MM-DD.

pickupDateFromdateOptional

Filter for jobs that are to be fulfilled on or after the given date. Format YYYY-MM-DD.

pickupDateTodateOptional

Filter for jobs that are to be fulfilled on or before the given date. Format YYYY-MM-DD.

Response

datalist of objects

linksobject

metaobject