Place an Order

POST

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

POST

/api/v1/orders-delivery

$ curl -X POST https://sandbox-api.deliveryapp.com/api/v1/orders-delivery \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "vehicle": "Car",
>   "fulfilment_date": "2019-08-24",
>   "payment_method": "da-credit",
>   "internal_ref": "string",
>   "additional_notes": "string",
>   "two_man_delivery": false,
>   "cost_of_goods": 0,
>   "co_loading": "string",
>   "meta": [
>     null
>   ],
>   "order_locations": {
>     "requires_handballing": true,
>     "time_from": "08:00:00",
>     "time_to": "09:00:00",
>     "items": [
>       {
>         "dimension": {
>           "height": 50,
>           "width": 100,
>           "length": 90
>         },
>         "weight": 8,
>         "quantity": "2"
>       }
>     ],
>     "address": {
>       "id": 24013,
>       "time_from": "11:00:00",
>       "time_to": "11:30:00",
>       "tracking_code": "DA6A3U7U-13447",
>       "web_tracking_url": "https://www.zippd.com/tracking/?code=DA6A3U7U-13447&email=recipient@example.com",
>       "address": {
>         "address_line_1": "123 Grovesby Road",
>         "address_line_2": "Billingham House, Flat 45",
>         "city": "Manchester",
>         "postcode": "M1 2AB",
>         "latitude": 53.477582,
>         "longitude": -2.255331
>       },
>       "contact_details": {
>         "contact_name": "Jane Doe",
>         "phone_number": "07123456789",
>         "email": "contact@example.com",
>         "company_name": "Example Company"
>       },
>       "driver_arriving_time": "2023-01-11 11:15:08",
>       "driver_leaving_time": "2023-01-11 11:21:37",
>       "requires_handballing": true,
>       "total_items": 0,
>       "instruction": "at",
>       "what3words": "issued.assure.courier",
>       "client_system_delivery_id": "string",
>       "barcodes": [
>         {
>           "code": "DA021758014227000253",
>           "code_formatted": "DA 021758 014227 000253",
>           "order_location_id": 0,
>           "pickup_latitude": 53.477582,
>           "pickup_longitude": -2.255331,
>           "pickup_datetime": "2023-01-09 11:05:55",
>           "drop_off_latitude": 53.612242,
>           "drop_off_longitude": -2.152356,
>           "drop_off_datetime": "2023-01-09 12:36:27",
>           "undeliverable": true,
>           "undeliverable_reason": "Could not gain access to location",
>           "printable_label_url": "https://sandbox-api.deliveryapp.com/package-label/print/barcode/5c1a370d-26eb-4afe-b18a-6f531dd00eb1/DA021758014227000253",
>           "created_at": "2023-01-05 09:00:00",
>           "updated_at": "2023-01-05 09:00:00"
>         }
>       ],
>       "printable_label_url": "https://sandbox-api.deliveryapp.com/package-label/print/location/5c1a370d-26eb-4afe-b18a-6f531dd00eb1/24013",
>       "proof_of_delivery": {
>         "photo": "string",
>         "signature": "string",
>         "signer_name": "Jane Doe",
>         "coordinates": {
>           "latitude": 53.477582,
>           "longitude": -2.255331
>         }
>       }
>     }
>   }
> }'

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": 1,
106       "total_price_no_vat_formatted": "string",
107       "order_price": 1,
108       "order_price_formatted": "string",
109       "order_price_no_vat": 1,
110       "order_price_no_vat_formatted": "string",
111       "extra_mileage_cost": 1,
112       "extra_mileage_cost_formatted": "string",
113       "extra_mileage_cost_no_vat": 1,
114       "extra_mileage_cost_no_vat_formatted": "string",
115       "extra_mileage_cost_vat_formatted": "string",
116       "extra_time_cost": 1,
117       "extra_time_cost_formatted": "string",
118       "extra_time_cost_no_vat": 1,
119       "extra_time_cost_no_vat_formatted": "string",
120       "extra_time_cost_vat_formatted": "string",
121       "surcharge_cost": 1,
122       "surcharge_cost_formatted": "string",
123       "surcharge_cost_no_vat": 1,
124       "surcharge_cost_no_vat_formatted": "string",
125       "surcharge_cost_vat_formatted": "string",
126       "total_vat": 1,
127       "total_vat_formatted": "string"
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": 1,
140         "pickup_latitude": 53.477582,
141         "pickup_longitude": -2.255331,
142         "pickup_datetime": "2023-01-09 11:05:55",
143         "drop_off_latitude": 53.612242,
144         "drop_off_longitude": -2.152356,
145         "drop_off_datetime": "2023-01-09 12:36:27",
146         "undeliverable": true,
147         "undeliverable_reason": "Could not gain access to location",
148         "printable_label_url": "https://sandbox-api.deliveryapp.com/package-label/print/barcode/5c1a370d-26eb-4afe-b18a-6f531dd00eb1/DA021758014227000253",
149         "created_at": "2023-01-05 09:00:00",
150         "updated_at": "2023-01-05 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 }

Place an order for an A-B delivery job on the platform.

Authentication

AuthorizationBearer

Request

This endpoint expects an object.

vehicleenumRequired

The vehicle type you require to undertake this delivery job.

fulfilment_datedateRequired

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

payment_methodenumRequired

The method of payment that should be used to pay for this delivery job. This will be da-credit in most cases.

Allowed values:

internal_refstringOptional<=250 characters

An order reference provided by your systems.

additional_notesstringOptional

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

two_man_deliverybooleanOptionalDefaults to false

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.

cost_of_goodsintegerOptional

The total cost of goods being delivered. Must be in lowest unit of currency, e.g. in pence for GBP.

time_zonestringOptional

The ID of the time zone in which the delivery job will take place. This will default to the time zone that is set on the account creating the order. As a rule, this value should be set to the time zone that the driver will be undertaking the delivery in.

orderlocationslist of objectsOptional

These are the pickup and drop-off locations for your delivery.

Response

Created

dataobject

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

Errors

403

Forbidden Error

422

Unprocessable Entity Error