v1

latestOpenAPI 3.0.02026-07-1398671635.1 KB
RestaurantQueries
publicly-accessible

Create Compensation requests

When an order is cancelled the restaurant might be eligible for compensation, this endpoint allows a request for compensation to be created.

post/orders/{tenant}/{orderId}/restaurantqueries/compensation

Path parameters

tenantstring required

Request tenant.

orderIdstring required

Id for the order.

Headers

Authorizationstring required

Containing a partner issued API key e.g. JE-API-KEY ABCDE123456789

Request body

ReasonCode'NotSet' | 'BeingPrepared' | 'OnItsWay' | 'Delivered' | 'Unknown'

The reason why compensation is due

Commentsstring

Any other comments to add to the request

Example request

{
  "ReasonCode": "OnItsWay",
  "Comments": "Driver had just left the restaurant"
}

Response

Created