BETA: Please note that the current endpoints are considered beta. It is possible there may be changes before these endpoints are finalised.
Orders
See currencies for more information on providing and using currency values. All values are in lowest denomination.
List Orders
Get order by id
get /organizations/{organizationId}/locations/{locationId}/ordersParameters
| Name | Type | In | Description |
|---|---|---|---|
organizationId | string | path | Organization ID |
locationId | string | path | Location ID |
after | string | query |
Responses
200: OK response.Order[]
[
{
"acceptedAt": "2021-08-04T04:38:00Z",
"cart": {
"adjustments": [
{
"amount": -500,
"id": "DISC001",
"label": "Taco Tuesday 2-for-1 Deal"
},
{
"amount": -500,
"id": "DISC001",
"label": "Taco Tuesday 2-for-1 Deal"
}
],
"createdAt": "2021-08-04T04:22:43Z",
"currency": "AUD",
"deliveryAddress": {
"apartment": "2B",
"coords": {
"latitude": -37.802,
"longitude": 144.988
},
"country": "Australia",
"locality": "Collingwood",
"postcode": "3066",
"region": "Victoria",
"streetAddress": "41 Derby Street"
},
"fulfillAt": "2022-01-12T21:00:00.000Z",
"id": "20e543f0-ddcd-4059-aaf3-7b21952c06f9",
"items": [
{
"amount": 1100,
"id": "FOOD001",
"note": "No tomato please",
"options": [
{
"choices": [
{
"amount": 20,
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"quantity": 2,
"title": "BBQ Sauce"
},
{
"amount": 20,
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"quantity": 2,
"title": "BBQ Sauce"
},
{
"amount": 20,
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"quantity": 2,
"title": "BBQ Sauce"
},
{
"amount": 20,
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"quantity": 2,
"title": "BBQ Sauce"
}
],
"id": "OPTSAUCE",
"title": "Sauce Selection"
},
{
"choices": [
{
"amount": 20,
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"quantity": 2,
"title": "BBQ Sauce"
},
{
"amount": 20,
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"quantity": 2,
"title": "BBQ Sauce"
},
{
"amount": 20,
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"quantity": 2,
"title": "BBQ Sauce"
},
{
"amount": 20,
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"quantity": 2,
"title": "BBQ Sauce"
}
],
"id": "OPTSAUCE",
"title": "Sauce Selection"
}
],
"quantity": 1,
"title": "Burger"
},
{
"amount": 1100,
"id": "FOOD001",
"note": "No tomato please",
"options": [
{
"choices": [
{
"amount": 20,
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"quantity": 2,
"title": "BBQ Sauce"
},
{
"amount": 20,
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"quantity": 2,
"title": "BBQ Sauce"
},
{
"amount": 20,
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"quantity": 2,
"title": "BBQ Sauce"
},
{
"amount": 20,
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"quantity": 2,
"title": "BBQ Sauce"
}
],
"id": "OPTSAUCE",
"title": "Sauce Selection"
},
{
"choices": [
{
"amount": 20,
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"quantity": 2,
"title": "BBQ Sauce"
},
{
"amount": 20,
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"quantity": 2,
"title": "BBQ Sauce"
},
{
"amount": 20,
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"quantity": 2,
"title": "BBQ Sauce"
},
{
"amount": 20,
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"quantity": 2,
"title": "BBQ Sauce"
}
],
"id": "OPTSAUCE",
"title": "Sauce Selection"
}
],
"quantity": 1,
"title": "Burger"
},
{
"amount": 1100,
"id": "FOOD001",
"note": "No tomato please",
"options": [
{
"choices": [
{
"amount": 20,
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"quantity": 2,
"title": "BBQ Sauce"
},
{
"amount": 20,
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"quantity": 2,
"title": "BBQ Sauce"
},
{
"amount": 20,
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"quantity": 2,
"title": "BBQ Sauce"
},
{
"amount": 20,
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"quantity": 2,
"title": "BBQ Sauce"
}
],
"id": "OPTSAUCE",
"title": "Sauce Selection"
},
{
"choices": [
{
"amount": 20,
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"quantity": 2,
"title": "BBQ Sauce"
},
{
"amount": 20,
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"quantity": 2,
"title": "BBQ Sauce"
},
{
"amount": 20,
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"quantity": 2,
"title": "BBQ Sauce"
},
{
"amount": 20,
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"quantity": 2,
"title": "BBQ Sauce"
}
],
"id": "OPTSAUCE",
"title": "Sauce Selection"
}
],
"quantity": 1,
"title": "Burger"
}
],
"notes": "Red coloured house with black stripes.",
"serviceRef": "5",
"status": "VALID",
"total": 10000,
"validatedAt": "2021-08-04T04:23:09Z"
},
"completedAt": "2021-08-04T04:38:00Z",
"createdAt": "2021-08-04T04:22:43Z",
"customer": {
"email": "john@example.com",
"firstName": "John",
"id": "01FCCGYZA9JPQ97HBSTKW0KT7P",
"lastName": "Smith",
"phoneNumber": "+61411222333"
},
"id": "642b791d-124f-41d6-a137-009f1fe84f77",
"payment": {
"chargedAmount": 8796056640871117000,
"completedAt": "2018-08-08T02:35:21Z",
"creditAmount": 5676134997235017000,
"currency": "Qui commodi quasi aut aut unde.",
"deliveryAmount": 1200,
"discount": "Voluptas consequuntur nobis dolor sed sit.",
"discountAmount": 7267768405019224000,
"feeAmount": 7591146712182092000,
"id": "29e13de7-d158-4aba-a928-7d868c1dbfb9",
"locationId": "Consequatur molestias.",
"payoutAmount": 9208995597338915000,
"refId": "Ipsa dolor laudantium eos.",
"refundedAt": "2018-08-08T02:35:21Z",
"state": "Culpa veniam beatae qui.",
"tipAmount": 8294673992617344000,
"total": 4645226612828691000
},
"rejectedAt": "2021-08-04T04:38:00Z",
"rejectionReason": "Couldn't fulfill order, product out of stock",
"state": "rejected"
},
{
"acceptedAt": "2021-08-04T04:38:00Z",
"cart": {
"adjustments": [
{
"amount": -500,
"id": "DISC001",
"label": "Taco Tuesday 2-for-1 Deal"
},
{
"amount": -500,
"id": "DISC001",
"label": "Taco Tuesday 2-for-1 Deal"
}
],
"createdAt": "2021-08-04T04:22:43Z",
"currency": "AUD",
"deliveryAddress": {
"apartment": "2B",
"coords": {
"latitude": -37.802,
"longitude": 144.988
},
"country": "Australia",
"locality": "Collingwood",
"postcode": "3066",
"region": "Victoria",
"streetAddress": "41 Derby Street"
},
"fulfillAt": "2022-01-12T21:00:00.000Z",
"id": "20e543f0-ddcd-4059-aaf3-7b21952c06f9",
"items": [
{
"amount": 1100,
"id": "FOOD001",
"note": "No tomato please",
"options": [
{
"choices": [
{
"amount": 20,
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"quantity": 2,
"title": "BBQ Sauce"
},
{
"amount": 20,
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"quantity": 2,
"title": "BBQ Sauce"
},
{
"amount": 20,
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"quantity": 2,
"title": "BBQ Sauce"
},
{
"amount": 20,
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"quantity": 2,
"title": "BBQ Sauce"
}
],
"id": "OPTSAUCE",
"title": "Sauce Selection"
},
{
"choices": [
{
"amount": 20,
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"quantity": 2,
"title": "BBQ Sauce"
},
{
"amount": 20,
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"quantity": 2,
"title": "BBQ Sauce"
},
{
"amount": 20,
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"quantity": 2,
"title": "BBQ Sauce"
},
{
"amount": 20,
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"quantity": 2,
"title": "BBQ Sauce"
}
],
"id": "OPTSAUCE",
"title": "Sauce Selection"
}
],
"quantity": 1,
"title": "Burger"
},
{
"amount": 1100,
"id": "FOOD001",
"note": "No tomato please",
"options": [
{
"choices": [
{
"amount": 20,
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"quantity": 2,
"title": "BBQ Sauce"
},
{
"amount": 20,
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"quantity": 2,
"title": "BBQ Sauce"
},
{
"amount": 20,
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"quantity": 2,
"title": "BBQ Sauce"
},
{
"amount": 20,
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"quantity": 2,
"title": "BBQ Sauce"
}
],
"id": "OPTSAUCE",
"title": "Sauce Selection"
},
{
"choices": [
{
"amount": 20,
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"quantity": 2,
"title": "BBQ Sauce"
},
{
"amount": 20,
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"quantity": 2,
"title": "BBQ Sauce"
},
{
"amount": 20,
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"quantity": 2,
"title": "BBQ Sauce"
},
{
"amount": 20,
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"quantity": 2,
"title": "BBQ Sauce"
}
],
"id": "OPTSAUCE",
"title": "Sauce Selection"
}
],
"quantity": 1,
"title": "Burger"
},
{
"amount": 1100,
"id": "FOOD001",
"note": "No tomato please",
"options": [
{
"choices": [
{
"amount": 20,
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"quantity": 2,
"title": "BBQ Sauce"
},
{
"amount": 20,
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"quantity": 2,
"title": "BBQ Sauce"
},
{
"amount": 20,
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"quantity": 2,
"title": "BBQ Sauce"
},
{
"amount": 20,
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"quantity": 2,
"title": "BBQ Sauce"
}
],
"id": "OPTSAUCE",
"title": "Sauce Selection"
},
{
"choices": [
{
"amount": 20,
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"quantity": 2,
"title": "BBQ Sauce"
},
{
"amount": 20,
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"quantity": 2,
"title": "BBQ Sauce"
},
{
"amount": 20,
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"quantity": 2,
"title": "BBQ Sauce"
},
{
"amount": 20,
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"quantity": 2,
"title": "BBQ Sauce"
}
],
"id": "OPTSAUCE",
"title": "Sauce Selection"
}
],
"quantity": 1,
"title": "Burger"
}
],
"notes": "Red coloured house with black stripes.",
"serviceRef": "5",
"status": "VALID",
"total": 10000,
"validatedAt": "2021-08-04T04:23:09Z"
},
"completedAt": "2021-08-04T04:38:00Z",
"createdAt": "2021-08-04T04:22:43Z",
"customer": {
"email": "john@example.com",
"firstName": "John",
"id": "01FCCGYZA9JPQ97HBSTKW0KT7P",
"lastName": "Smith",
"phoneNumber": "+61411222333"
},
"id": "642b791d-124f-41d6-a137-009f1fe84f77",
"payment": {
"chargedAmount": 8796056640871117000,
"completedAt": "2018-08-08T02:35:21Z",
"creditAmount": 5676134997235017000,
"currency": "Qui commodi quasi aut aut unde.",
"deliveryAmount": 1200,
"discount": "Voluptas consequuntur nobis dolor sed sit.",
"discountAmount": 7267768405019224000,
"feeAmount": 7591146712182092000,
"id": "29e13de7-d158-4aba-a928-7d868c1dbfb9",
"locationId": "Consequatur molestias.",
"payoutAmount": 9208995597338915000,
"refId": "Ipsa dolor laudantium eos.",
"refundedAt": "2018-08-08T02:35:21Z",
"state": "Culpa veniam beatae qui.",
"tipAmount": 8294673992617344000,
"total": 4645226612828691000
},
"rejectedAt": "2021-08-04T04:38:00Z",
"rejectionReason": "Couldn't fulfill order, product out of stock",
"state": "rejected"
},
{
"acceptedAt": "2021-08-04T04:38:00Z",
"cart": {
"adjustments": [
{
"amount": -500,
"id": "DISC001",
"label": "Taco Tuesday 2-for-1 Deal"
},
{
"amount": -500,
"id": "DISC001",
"label": "Taco Tuesday 2-for-1 Deal"
}
],
"createdAt": "2021-08-04T04:22:43Z",
"currency": "AUD",
"deliveryAddress": {
"apartment": "2B",
"coords": {
"latitude": -37.802,
"longitude": 144.988
},
"country": "Australia",
"locality": "Collingwood",
"postcode": "3066",
"region": "Victoria",
"streetAddress": "41 Derby Street"
},
"fulfillAt": "2022-01-12T21:00:00.000Z",
"id": "20e543f0-ddcd-4059-aaf3-7b21952c06f9",
"items": [
{
"amount": 1100,
"id": "FOOD001",
"note": "No tomato please",
"options": [
{
"choices": [
{
"amount": 20,
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"quantity": 2,
"title": "BBQ Sauce"
},
{
"amount": 20,
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"quantity": 2,
"title": "BBQ Sauce"
},
{
"amount": 20,
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"quantity": 2,
"title": "BBQ Sauce"
},
{
"amount": 20,
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"quantity": 2,
"title": "BBQ Sauce"
}
],
"id": "OPTSAUCE",
"title": "Sauce Selection"
},
{
"choices": [
{
"amount": 20,
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"quantity": 2,
"title": "BBQ Sauce"
},
{
"amount": 20,
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"quantity": 2,
"title": "BBQ Sauce"
},
{
"amount": 20,
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"quantity": 2,
"title": "BBQ Sauce"
},
{
"amount": 20,
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"quantity": 2,
"title": "BBQ Sauce"
}
],
"id": "OPTSAUCE",
"title": "Sauce Selection"
}
],
"quantity": 1,
"title": "Burger"
},
{
"amount": 1100,
"id": "FOOD001",
"note": "No tomato please",
"options": [
{
"choices": [
{
"amount": 20,
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"quantity": 2,
"title": "BBQ Sauce"
},
{
"amount": 20,
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"quantity": 2,
"title": "BBQ Sauce"
},
{
"amount": 20,
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"quantity": 2,
"title": "BBQ Sauce"
},
{
"amount": 20,
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"quantity": 2,
"title": "BBQ Sauce"
}
],
"id": "OPTSAUCE",
"title": "Sauce Selection"
},
{
"choices": [
{
"amount": 20,
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"quantity": 2,
"title": "BBQ Sauce"
},
{
"amount": 20,
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"quantity": 2,
"title": "BBQ Sauce"
},
{
"amount": 20,
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"quantity": 2,
"title": "BBQ Sauce"
},
{
"amount": 20,
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"quantity": 2,
"title": "BBQ Sauce"
}
],
"id": "OPTSAUCE",
"title": "Sauce Selection"
}
],
"quantity": 1,
"title": "Burger"
},
{
"amount": 1100,
"id": "FOOD001",
"note": "No tomato please",
"options": [
{
"choices": [
{
"amount": 20,
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"quantity": 2,
"title": "BBQ Sauce"
},
{
"amount": 20,
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"quantity": 2,
"title": "BBQ Sauce"
},
{
"amount": 20,
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"quantity": 2,
"title": "BBQ Sauce"
},
{
"amount": 20,
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"quantity": 2,
"title": "BBQ Sauce"
}
],
"id": "OPTSAUCE",
"title": "Sauce Selection"
},
{
"choices": [
{
"amount": 20,
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"quantity": 2,
"title": "BBQ Sauce"
},
{
"amount": 20,
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"quantity": 2,
"title": "BBQ Sauce"
},
{
"amount": 20,
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"quantity": 2,
"title": "BBQ Sauce"
},
{
"amount": 20,
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"quantity": 2,
"title": "BBQ Sauce"
}
],
"id": "OPTSAUCE",
"title": "Sauce Selection"
}
],
"quantity": 1,
"title": "Burger"
}
],
"notes": "Red coloured house with black stripes.",
"serviceRef": "5",
"status": "VALID",
"total": 10000,
"validatedAt": "2021-08-04T04:23:09Z"
},
"completedAt": "2021-08-04T04:38:00Z",
"createdAt": "2021-08-04T04:22:43Z",
"customer": {
"email": "john@example.com",
"firstName": "John",
"id": "01FCCGYZA9JPQ97HBSTKW0KT7P",
"lastName": "Smith",
"phoneNumber": "+61411222333"
},
"id": "642b791d-124f-41d6-a137-009f1fe84f77",
"payment": {
"chargedAmount": 8796056640871117000,
"completedAt": "2018-08-08T02:35:21Z",
"creditAmount": 5676134997235017000,
"currency": "Qui commodi quasi aut aut unde.",
"deliveryAmount": 1200,
"discount": "Voluptas consequuntur nobis dolor sed sit.",
"discountAmount": 7267768405019224000,
"feeAmount": 7591146712182092000,
"id": "29e13de7-d158-4aba-a928-7d868c1dbfb9",
"locationId": "Consequatur molestias.",
"payoutAmount": 9208995597338915000,
"refId": "Ipsa dolor laudantium eos.",
"refundedAt": "2018-08-08T02:35:21Z",
"state": "Culpa veniam beatae qui.",
"tipAmount": 8294673992617344000,
"total": 4645226612828691000
},
"rejectedAt": "2021-08-04T04:38:00Z",
"rejectionReason": "Couldn't fulfill order, product out of stock",
"state": "rejected"
}
]Get an Order
Get order by id
get /organizations/{organizationId}/locations/{locationId}/orders/{orderId}Parameters
| Name | Type | In | Description |
|---|---|---|---|
organizationId | string | path | Organization ID |
locationId | string | path | Location ID |
orderId | string | path | Order ID |
Responses
200: OK response.Order
{
"acceptedAt": "2021-08-04T04:38:00Z",
"cart": {
"adjustments": [
{
"amount": -500,
"id": "DISC001",
"label": "Taco Tuesday 2-for-1 Deal"
},
{
"amount": -500,
"id": "DISC001",
"label": "Taco Tuesday 2-for-1 Deal"
}
],
"createdAt": "2021-08-04T04:22:43Z",
"currency": "AUD",
"deliveryAddress": {
"apartment": "2B",
"coords": {
"latitude": -37.802,
"longitude": 144.988
},
"country": "Australia",
"locality": "Collingwood",
"postcode": "3066",
"region": "Victoria",
"streetAddress": "41 Derby Street"
},
"fulfillAt": "2022-01-12T21:00:00.000Z",
"id": "20e543f0-ddcd-4059-aaf3-7b21952c06f9",
"items": [
{
"amount": 1100,
"id": "FOOD001",
"note": "No tomato please",
"options": [
{
"choices": [
{
"amount": 20,
"id": "SAUCE001",
"options": [
{},
{}
],
"quantity": 2,
"title": "BBQ Sauce"
},
{
"amount": 20,
"id": "SAUCE001",
"options": [
{},
{}
],
"quantity": 2,
"title": "BBQ Sauce"
},
{
"amount": 20,
"id": "SAUCE001",
"options": [
{},
{}
],
"quantity": 2,
"title": "BBQ Sauce"
}
],
"id": "OPTSAUCE",
"title": "Sauce Selection"
},
{
"choices": [
{
"amount": 20,
"id": "SAUCE001",
"options": [
{},
{}
],
"quantity": 2,
"title": "BBQ Sauce"
},
{
"amount": 20,
"id": "SAUCE001",
"options": [
{},
{}
],
"quantity": 2,
"title": "BBQ Sauce"
},
{
"amount": 20,
"id": "SAUCE001",
"options": [
{},
{}
],
"quantity": 2,
"title": "BBQ Sauce"
}
],
"id": "OPTSAUCE",
"title": "Sauce Selection"
}
],
"quantity": 1,
"title": "Burger"
},
{
"amount": 1100,
"id": "FOOD001",
"note": "No tomato please",
"options": [
{
"choices": [
{
"amount": 20,
"id": "SAUCE001",
"options": [
{},
{}
],
"quantity": 2,
"title": "BBQ Sauce"
},
{
"amount": 20,
"id": "SAUCE001",
"options": [
{},
{}
],
"quantity": 2,
"title": "BBQ Sauce"
},
{
"amount": 20,
"id": "SAUCE001",
"options": [
{},
{}
],
"quantity": 2,
"title": "BBQ Sauce"
}
],
"id": "OPTSAUCE",
"title": "Sauce Selection"
},
{
"choices": [
{
"amount": 20,
"id": "SAUCE001",
"options": [
{},
{}
],
"quantity": 2,
"title": "BBQ Sauce"
},
{
"amount": 20,
"id": "SAUCE001",
"options": [
{},
{}
],
"quantity": 2,
"title": "BBQ Sauce"
},
{
"amount": 20,
"id": "SAUCE001",
"options": [
{},
{}
],
"quantity": 2,
"title": "BBQ Sauce"
}
],
"id": "OPTSAUCE",
"title": "Sauce Selection"
}
],
"quantity": 1,
"title": "Burger"
}
],
"notes": "Red coloured house with black stripes.",
"serviceRef": "5",
"status": "VALID",
"total": 10000,
"validatedAt": "2021-08-04T04:23:09Z"
},
"completedAt": "2021-08-04T04:38:00Z",
"createdAt": "2021-08-04T04:22:43Z",
"customer": {
"email": "john@example.com",
"firstName": "John",
"id": "01FCCGYZA9JPQ97HBSTKW0KT7P",
"lastName": "Smith",
"phoneNumber": "+61411222333"
},
"id": "642b791d-124f-41d6-a137-009f1fe84f77",
"payment": {
"chargedAmount": 7550967035237278000,
"completedAt": "2018-08-08T02:35:21Z",
"creditAmount": 1233387220550493700,
"currency": "Fugiat quia qui sit.",
"deliveryAmount": 1200,
"discount": "Autem deleniti nemo vero nemo.",
"discountAmount": 7272495348290447000,
"feeAmount": 6228371038223196000,
"id": "29e13de7-d158-4aba-a928-7d868c1dbfb9",
"locationId": "A rem eum ipsam omnis animi et.",
"payoutAmount": 6904350238845328000,
"refId": "Iusto eaque.",
"refundedAt": "2018-08-08T02:35:21Z",
"state": "Voluptatibus atque totam rerum ut possimus reiciendis.",
"tipAmount": 4519050703868433000,
"total": 1189481535425585200
},
"rejectedAt": "2021-08-04T04:38:00Z",
"rejectionReason": "Couldn't fulfill order, product out of stock",
"state": "rejected"
}404: not_found: Not Found response.
Accept an Order
Accept an order made from the app. Set autoComplete to true in the request body to also complete the order in a single step.
put /organizations/{organizationId}/locations/{locationId}/orders/{orderId}/acceptParameters
| Name | Type | In | Description |
|---|---|---|---|
organizationId | string | path | Organization ID |
locationId | string | path | Location ID |
orderId | string | path |
Request Body
OrderAcceptPayload
{
"autoComplete": false,
"refId": "01CMET9V9AMSVPG495BBRPGTFF",
"terminalId": "terminal001/user001"
}Responses
204: No Content response.
404: not_found: Not Found response.
409: conflict: Conflict response.
Reject an Order
Reject an order made from the app
put /organizations/{organizationId}/locations/{locationId}/orders/{orderId}/rejectParameters
| Name | Type | In | Description |
|---|---|---|---|
organizationId | string | path | Organization ID |
locationId | string | path | Location ID |
orderId | string | path |
Request Body
OrderRejectPayload
{
"reason": "The store has stopped taking new orders.",
"refId": "01CMET9V9AMSVPG495BBRPGTFF",
"terminalId": "terminal001/user001"
}Responses
204: No Content response.
404: not_found: Not Found response.
409: conflict: Conflict response.
Update Order progress
Update the progress status of an order.
put /organizations/{organizationId}/locations/{locationId}/orders/{orderId}/progressParameters
| Name | Type | In | Description |
|---|---|---|---|
organizationId | string | path | Organization ID |
locationId | string | path | Location ID |
orderId | string | path |
Request Body
OrderProgress
{
"coords": {
"latitude": -37.802,
"longitude": 144.988
},
"status": "ON_THE_WAY"
}Responses
204: No Content response.
404: not_found: Not Found response.
409: conflict: Conflict response.
Complete an Order
Complete an order, indicating the customer has received it
put /organizations/{organizationId}/locations/{locationId}/orders/{orderId}/completeParameters
| Name | Type | In | Description |
|---|---|---|---|
organizationId | string | path | Organization ID |
locationId | string | path | Location ID |
orderId | string | path |
Request Body
OrderCompletePayload
{
"terminalId": "terminal001/user001"
}Responses
204: No Content response.
404: not_found: Not Found response.
409: conflict: Conflict response.
Models
Order
| Name | Type | Description |
|---|---|---|
| id | string | |
| acceptedAt | string | (optional) When the order was accepted |
| completedAt | string | (optional) When the order was completed |
| createdAt | string | When this order was created |
| rejectedAt | string | (optional) When the order was rejected |
| rejectionReason | string | (optional) |
| state | string | |
| cart | Cart | |
| payment | OrderPayment | |
| customer | CustomerTiny | |
CustomerTiny
| Name | Type | Description |
|---|---|---|
| id | string | Unique ID of the Customer |
| string | (optional) The Customers email address | |
| firstName | string | Customer first name or given name |
| lastName | string | Customer last name or surname |
| phoneNumber | string | (optional) The Customers mobile phone number |
OrderPayment
| Name | Type | Description |
|---|---|---|
| id | string | Payment ID |
| locationId | string | (optional) |
| refId | string | (optional) |
| completedAt | string | When the payment was completed |
| refundedAt | string | (optional) When the payment was refunded |
| chargedAmount | integer | Portion covered by credit card |
| creditAmount | integer | Portion covered by customer credit |
| currency | string | |
| deliveryAmount | integer | The charge for delivery in cents. This will be 0 if the delivery fee was 0 or if there is no delivery associated with the order. |
| discount | string | (optional) |
| discountAmount | integer | Portion discounted by user promotion |
| feeAmount | integer | |
| payoutAmount | integer | |
| state | string | |
| tipAmount | integer | |
| total | integer | Total amount covered by payment |
OrderProgress
| Name | Type | Description |
|---|---|---|
| status | string(enum) | The current progress status of the order. "READY", "AWAITING_DRIVER", "ON_THE_WAY", "CLOSE_BY" |
| coords | Coords | (optional) |
Coords
| Name | Type | Description |
|---|---|---|
| latitude | number | Latitude |
| longitude | number | Longitude |
OrderAcceptPayload
| Name | Type | Description |
|---|---|---|
| refId | string | A reference to the order, generally something the staff has access to, should be unique |
| terminalId | string | The terminal the order was accepted from. Use something meaningful to your system. |
| autoComplete | boolean | Auto complete will set the order to a fully completed state, no further action is required |
OrderRejectPayload
| Name | Type | Description |
|---|---|---|
| refId | string | (optional) A reference to the order, generally something the staff has access to, should be unique |
| terminalId | string | (optional) The terminal the order was accepted from. Use something meaningful to your system. |
| reason | string | The reason for rejecting the order. |
OrderCompletePayload
| Name | Type | Description |
|---|---|---|
| terminalId | string | The terminal the order was completed from. Use something meaningful to your system. |