Relay Delivery API Release Notes

2023-NOV-29

When POSTing an order, an optional
```
label
```
field can supply an alternative identifier of an order. Please see our webhook schema for more information.

A new webhook event
```
order_delivery_path
```
are published which can be used to render the delivery path (GeoJSON lineString) and the courier's progress (GeoJSON Points) on the path. A full re-render of the delivery path and rider's coordinates is strongly suggested on every event.

When POSTing an order, Relay will typically create a new restaurant location based on the contents of your POST. However, if we find an existing Relay account that matches your request then we will create the order for that restaurant, so that the users at the restaurant can manage the order just as they are used to. Previously, this process was invisble to V2 users, but not you can see by checking the `order.producer.producerLocationType` field in the POST order response. See here for more info. The rider's name has been added to the rider_accepted hook. Please see our webhook schema for more information.

The rider's name has been added to the rider_accepted hook. Please see our webhook schema for more information.

We have exposed a new event to V2 webhook users. When details of the order such as phone number, apartment, special instructions are edited we publish a `order-details-edited` hook. Please see our webhook schema for more information.

International phone numbers for consumers are now supported in both V1 and V2 APIS. Although, providing a phone number local to the restaurant is still a best practice.

Orders are now updateable via a
```
PATCH
```
to
```
/v2/order/{orderKey}
```
. See More Info
Proof of delivery can now be requested during order creation via the
```
order.consumer.proof
```
object. More Info
URLs to requested proof of delivery are now contained it the v2/order_delivered webhook. More Info