Create a Delivery Review | Zippd API

This endpoint allows both auth token and delivery recipient code/email verification for authorisation.

There are a few fields available to attribute the review to the correct order. The attribution fields are:

code/email
order_id
location_id

An auth token must be sent with the request when attributing using the order_id and location_id fields.

To prevent abiguity in the data, presenting more than one of these fields in a request will result in a validation error. For example, a request with both order_id and the code and email fields will fail, even if the order ID matches the code and email.

This endpoint allows both auth token and delivery recipient code/email verification for authorisation. There are a few fields available to attribute the review to the correct order. The attribution fields are: * `code`/`email` * `order_id` * `location_id` An auth token must be sent with the request when attributing using the `order_id` and `location_id` fields. To prevent abiguity in the data, presenting more than one of these fields in a request will result in a validation error. For example, a request with both `order_id` and the `code` and `email` fields will fail, even if the order ID matches the code and email.

Request

This endpoint expects an object.

ratingintegerRequired1-5

The rating of the review.

messagestringOptional

Additional information given by the reviewer along with the rating.

codestringOptional

Optional, but required if email is present in the request data. The tracking code of a delivery.

emailstringOptional

Optional, but required if code is present in the request data. The email address of the delivery recipient.

order_idstringOptionalformat: "uuid"

The ID of the order to create a review for.

location_idintegerOptional

The ID of the drop-off location to create a review for.

Response

Created

dataobject

The details of a review given for the order (delivery) or drop-off.

Errors

422

Unprocessable Entity Error

$	curl -X POST https://sandbox-api.deliveryapp.com/api/v1/order-reviews \
>	-H "Content-Type: application/json" \
>	-d '{
>	"rating": 4
>	}'

1	{
2	"data": {
3	"rating": 4,
4	"message": "The delivery was prompt and the package was in excellent condition.",
5	"reviewer_name": "Emily Johnson",
6	"created_at": "2024-06-10T14:22:30Z"
7	}
8	}