Create an Order

POST

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

POST

/api/v1/orders-ecommerce

$ curl -X POST https://sandbox-api.deliveryapp.com/api/v1/orders-ecommerce \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "vehicle": "Small Van",
>   "fulfilment_date": "2024-07-15",
>   "duration": "half-day",
>   "payment_method": "da-credit",
>   "starting_location": {
>     "time_from": "09:00:00",
>     "time_to": "09:30:00",
>     "address": {
>       "address_line_1": "123 Grovesby Road",
>       "city": "Manchester",
>       "postcode": "M1 2AB",
>       "latitude": 53.477582,
>       "longitude": -2.255331,
>       "contact_name": "Jane Doe",
>       "phone_number": "07123456789"
>     }
>   }
> }'

1 {
2   "data": {
3     "id": "a3f1c9e2-4b7d-4f3a-9c2e-8f7b6d5a1e2f",
4     "code": "DA9N3B6P",
5     "type": "delivery",
6     "order_date": "2024-07-10",
7     "fulfilment_date": "2024-07-15",
8     "internal_ref": "ORDER000123",
9     "status": "accepted",
10     "total_items": 3,
11     "is_urgent": true,
12     "started_at": "2024-07-15 08:30:15",
13     "completed_at": "2024-07-15 12:45:30",
14     "canceled_at": "2024-07-14 16:00:00",
15     "time_change_requests": 2,
16     "vehicle": {
17       "id": 1,
18       "title": "Small Van"
19     },
20     "payment_card": {
21       "id": "b7e9f8d2-3c4a-4e5f-9a1b-2c3d4e5f6a7b",
22       "number": "3925",
23       "type": "visa"
24     },
25     "additional_notes": "Speak to reception to gain access",
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": "d4e5f6a7-b8c9-4d0e-9f1a-2b3c4d5e6f7a",
33       "first_name": "Chris",
34       "full_name": "Chris Grolent",
35       "contact_number": "07123456789",
36       "profile_image": "https://cdn.deliveryapp.com/drivers/chris_grolent.jpg",
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": "09:00:00",
47         "time_to": "09: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": "2024-07-15 09:15:08",
65         "driver_leaving_time": "2024-07-15 09:21:37",
66         "requires_handballing": true,
67         "total_items": 3,
68         "instruction": "address",
69         "instruction_details": "Gate code 1234 for delivery access",
70         "what3words": "issued.assure.courier",
71         "client_system_delivery_id": "DEL-20240715-001",
72         "barcodes": [
73           {
74             "code": "DA021758014227000253",
75             "code_formatted": "DA 021758 014227 000253",
76             "order_location_id": 24013,
77             "pickup_latitude": 53.477582,
78             "pickup_longitude": -2.255331,
79             "pickup_datetime": "2024-07-14 11:05:55",
80             "drop_off_latitude": 53.612242,
81             "drop_off_longitude": -2.152356,
82             "drop_off_datetime": "2024-07-15 12:36:27",
83             "undeliverable": false,
84             "undeliverable_reason": "",
85             "printable_label_url": "https://sandbox-api.deliveryapp.com/package-label/print/barcode/5c1a370d-26eb-4afe-b18a-6f531dd00eb1/DA021758014227000253",
86             "created_at": "2024-07-10 09:00:00",
87             "updated_at": "2024-07-14 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": "https://cdn.deliveryapp.com/proofs/photo_24013.jpg",
93           "signature": "https://cdn.deliveryapp.com/proofs/signature_24013.png",
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": 102880,
106       "total_price_no_vat_formatted": "£1,028.80",
107       "order_price": 110000,
108       "order_price_formatted": "£1,100.00",
109       "order_price_no_vat": 91700,
110       "order_price_no_vat_formatted": "£917.00",
111       "extra_mileage_cost": 5000,
112       "extra_mileage_cost_formatted": "£50.00",
113       "extra_mileage_cost_no_vat": 4170,
114       "extra_mileage_cost_no_vat_formatted": "£41.70",
115       "extra_mileage_cost_vat_formatted": "£8.30",
116       "extra_time_cost": 2000,
117       "extra_time_cost_formatted": "£20.00",
118       "extra_time_cost_no_vat": 1660,
119       "extra_time_cost_no_vat_formatted": "£16.60",
120       "extra_time_cost_vat_formatted": "£3.40",
121       "surcharge_cost": 3456,
122       "surcharge_cost_formatted": "£34.56",
123       "surcharge_cost_no_vat": 2870,
124       "surcharge_cost_no_vat_formatted": "£28.70",
125       "surcharge_cost_vat_formatted": "£5.86",
126       "total_vat": 20600,
127       "total_vat_formatted": "£206.00"
128     },
129     "allowed_distance": {
130       "postcode": "M1 2AB",
131       "latitude": 53.477582,
132       "longitude": -2.255331,
133       "distance": 25
134     },
135     "barcodes": [
136       {
137         "code": "DA021758014227000253",
138         "code_formatted": "DA 021758 014227 000253",
139         "order_location_id": 24013,
140         "pickup_latitude": 53.477582,
141         "pickup_longitude": -2.255331,
142         "pickup_datetime": "2024-07-14 11:05:55",
143         "drop_off_latitude": 53.612242,
144         "drop_off_longitude": -2.152356,
145         "drop_off_datetime": "2024-07-15 12:36:27",
146         "undeliverable": false,
147         "undeliverable_reason": "",
148         "printable_label_url": "https://sandbox-api.deliveryapp.com/package-label/print/barcode/5c1a370d-26eb-4afe-b18a-6f531dd00eb1/DA021758014227000253",
149         "created_at": "2024-07-10 09:00:00",
150         "updated_at": "2024-07-14 09:00:00"
151       }
152     ],
153     "printable_label_url": "https://sandbox-api.deliveryapp.com/package-label/print/order/5c1a370d-26eb-4afe-b18a-6f531dd00eb1",
154     "duration": "half-day",
155     "total_time": {
156       "seconds": 15323,
157       "display": "04:15:23"
158     },
159     "additional_time": {
160       "seconds": 923,
161       "display": "00:15:23"
162     },
163     "mileage": {
164       "total_miles": 47
165     }
166   }
167 }

Authentication

AuthorizationBearer

Request

vehicleenumRequired

The vehicle type you require to fulfil this order.

fulfilment_datedateRequired

The date on which the order should be fulfilled. Expects date in format ‘Y-m-d’.

durationenumRequired

The required duration within which the order will be fulfilled.

Allowed values:

payment_methodenumRequired

Select the method the API should use to process payment for this order.

Allowed values:

starting_locationobjectRequired

Details of the location where the delivery driver will pickup all items that are to be delivered during this order.

two_man_deliverybooleanOptional

Whether or not the delivery driver is required to have an additional person with them to fulfil the order. Defaults to false if not provided.

internal_refstringOptional

An order reference provided by your systems.

additional_notesstringOptional

Additional information that will be seen by the delivery driver before and during order fulfilment.

Response

Created

dataobject

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

Errors

403

Forbidden Error

422

Unprocessable Entity Error