Retrieve Pre-Orders for a Reservation at a given Location.
This endpoint accepts several query parameters to filter the data returned.
GET ~/bookings/:booking-id/preorders
Headers
| Field | Type | Description |
|---|---|---|
| doshii-location-id | String |
The hashed ID of the location you're targeting. See Hashed Location IDs |
Parameters
| Field | Type | Description |
|---|---|---|
| :booking-id | String |
The ID of the reservation you'd like to retrieve the preorders for |
| offsetoptional | Integer |
Number of matching records to skip before returning the appropriate rows. Default: 0 |
| limitoptional | Integer |
Max number of records to return. Default is 10. (Maximum: 100) |
Response
| Field | Type | Description |
|---|---|---|
| count | Integer |
Number of records that match the query |
| offset | String |
Number of matching records skipped before returning the appropriate rows |
| limit | String |
Max number of records returned |
| rows | Object[] |
The matching pre-orders for the given booking |
Examples
Response
{
count: 224,
offset: 12,
limit: 2,
rows: [{
"id": "1",
"status": "pending",
"checkinId": "3",
"locationId": "Xuy8K3a0",
"requiredAt": "2018-04-12T20:54:25.289Z",,
"availableEta":null,
"preorderBookingId": "6743",
"manuallyProcessed": false,
"surcounts": [],
"items": [
{
"name":"Toasted Sourdough Bread & Eggs",
"description":"Just ye old classic",
"unitPrice":"1100",
"posId":"lol12",
"quantity":1,
"surcounts": [],
"options": []
}
],
"createdAt": "2018-04-11T20:54:25.289Z",
"updatedAt": "2018-04-11T20:54:25.289Z",
"transactions": [],
"version":"iwgjr2NJ014",
"uri": "https://sandbox.doshii.co/partner/v3/orders/1"
}, {
"id": "2",
"status": "accepted",
"checkinId": "5",
"locationId": "Xuy8K3a0",
"requiredAt": "2018-04-12T20:54:25.289Z",,
"availableEta":null,
"preorderBookingId": "6743",
"manuallyProcessed": false,
"surcounts": [],
"items": [
{
"name":"Toasted Sourdough Bread & Eggs",
"description":"Just ye old classic",
"unitPrice":"1100",
"posId":"lol12",
"quantity":1,
"surcounts": [],
"options": []
}
],
"posCreatedAt": "2018-04-11T20:54:26.289Z",
"createdAt": "2018-04-11T20:54:25.289Z",
"updatedAt": "2018-04-11T20:54:27.289Z",
"transactions": [
{
"version": "Gj0mwWY9YbIjQMPYX2qEib1enQPBRYIbllDrOXpD",
"id": "1",
"orderId": "2",
"reference": "cash",
"invoice": null,
"amount": "10000",
"status": "complete",
"createdAt": "2016-04-12T21:28:29.330Z",
"updatedAt": "2016-04-12T21:28:29.330Z",
"uri": "https://sandbox.doshii.co/partner/v3/transactions/1"
}
],
"version":"g4MMRsd3333NJ014",
"uri": "https://sandbox.doshii.co/partner/v3/orders/2"
}]
Comments
0 comments
Please sign in to leave a comment.