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 | The cursor to use for pagination. Do not use this field manually it will be automatically provided in the response headers (see Paging guide). |
Responses
200: OK response.Order[]
[
{
"acceptedAt": "2021-08-04T04:38:00Z",
"cart": {
"adjustments": [
{
"amount": -500,
"id": "DISC001",
"label": "Taco Tuesday 2-for-1 Deal",
"taxIncluded": -65
},
{
"amount": -500,
"id": "DISC001",
"label": "Taco Tuesday 2-for-1 Deal",
"taxIncluded": -65
},
{
"amount": -500,
"id": "DISC001",
"label": "Taco Tuesday 2-for-1 Deal",
"taxIncluded": -65
}
],
"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": [
{
"id": "SAUCE001",
"options": [
{},
{}
],
"price": {
"amount": 2300,
"taxIncluded": 250,
"taxRate": 0.05
},
"quantity": 2,
"title": "BBQ Sauce"
},
{
"id": "SAUCE001",
"options": [
{},
{}
],
"price": {
"amount": 2300,
"taxIncluded": 250,
"taxRate": 0.05
},
"quantity": 2,
"title": "BBQ Sauce"
}
],
"id": "OPTSAUCE",
"title": "Sauce Selection"
},
{
"choices": [
{
"id": "SAUCE001",
"options": [
{},
{}
],
"price": {
"amount": 2300,
"taxIncluded": 250,
"taxRate": 0.05
},
"quantity": 2,
"title": "BBQ Sauce"
},
{
"id": "SAUCE001",
"options": [
{},
{}
],
"price": {
"amount": 2300,
"taxIncluded": 250,
"taxRate": 0.05
},
"quantity": 2,
"title": "BBQ Sauce"
}
],
"id": "OPTSAUCE",
"title": "Sauce Selection"
}
],
"price": {
"amount": 2300,
"taxIncluded": 250,
"taxRate": 0.05
},
"quantity": 1,
"title": "Burger"
},
{
"amount": 1100,
"id": "FOOD001",
"note": "No tomato please",
"options": [
{
"choices": [
{
"id": "SAUCE001",
"options": [
{},
{}
],
"price": {
"amount": 2300,
"taxIncluded": 250,
"taxRate": 0.05
},
"quantity": 2,
"title": "BBQ Sauce"
},
{
"id": "SAUCE001",
"options": [
{},
{}
],
"price": {
"amount": 2300,
"taxIncluded": 250,
"taxRate": 0.05
},
"quantity": 2,
"title": "BBQ Sauce"
}
],
"id": "OPTSAUCE",
"title": "Sauce Selection"
},
{
"choices": [
{
"id": "SAUCE001",
"options": [
{},
{}
],
"price": {
"amount": 2300,
"taxIncluded": 250,
"taxRate": 0.05
},
"quantity": 2,
"title": "BBQ Sauce"
},
{
"id": "SAUCE001",
"options": [
{},
{}
],
"price": {
"amount": 2300,
"taxIncluded": 250,
"taxRate": 0.05
},
"quantity": 2,
"title": "BBQ Sauce"
}
],
"id": "OPTSAUCE",
"title": "Sauce Selection"
}
],
"price": {
"amount": 2300,
"taxIncluded": 250,
"taxRate": 0.05
},
"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": 600,
"completedAt": "2018-08-08T02:35:21Z",
"creditAmount": 200,
"currency": "AUD",
"deliveryAmount": 1200,
"discount": "Commodi quasi aut.",
"discountAmount": 300,
"externalAmount": 600,
"feeAmount": 10,
"id": "29e13de7-d158-4aba-a928-7d868c1dbfb9",
"locationId": "01HMWZ6W8HK7FHE4H0RJC74M7R",
"payoutAmount": 590,
"refId": "INV123456",
"refundedAt": "2018-08-08T02:35:21Z",
"state": "completed",
"tipAmount": 100,
"total": 1000
},
"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",
"taxIncluded": -65
},
{
"amount": -500,
"id": "DISC001",
"label": "Taco Tuesday 2-for-1 Deal",
"taxIncluded": -65
},
{
"amount": -500,
"id": "DISC001",
"label": "Taco Tuesday 2-for-1 Deal",
"taxIncluded": -65
}
],
"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": [
{
"id": "SAUCE001",
"options": [
{},
{}
],
"price": {
"amount": 2300,
"taxIncluded": 250,
"taxRate": 0.05
},
"quantity": 2,
"title": "BBQ Sauce"
},
{
"id": "SAUCE001",
"options": [
{},
{}
],
"price": {
"amount": 2300,
"taxIncluded": 250,
"taxRate": 0.05
},
"quantity": 2,
"title": "BBQ Sauce"
}
],
"id": "OPTSAUCE",
"title": "Sauce Selection"
},
{
"choices": [
{
"id": "SAUCE001",
"options": [
{},
{}
],
"price": {
"amount": 2300,
"taxIncluded": 250,
"taxRate": 0.05
},
"quantity": 2,
"title": "BBQ Sauce"
},
{
"id": "SAUCE001",
"options": [
{},
{}
],
"price": {
"amount": 2300,
"taxIncluded": 250,
"taxRate": 0.05
},
"quantity": 2,
"title": "BBQ Sauce"
}
],
"id": "OPTSAUCE",
"title": "Sauce Selection"
}
],
"price": {
"amount": 2300,
"taxIncluded": 250,
"taxRate": 0.05
},
"quantity": 1,
"title": "Burger"
},
{
"amount": 1100,
"id": "FOOD001",
"note": "No tomato please",
"options": [
{
"choices": [
{
"id": "SAUCE001",
"options": [
{},
{}
],
"price": {
"amount": 2300,
"taxIncluded": 250,
"taxRate": 0.05
},
"quantity": 2,
"title": "BBQ Sauce"
},
{
"id": "SAUCE001",
"options": [
{},
{}
],
"price": {
"amount": 2300,
"taxIncluded": 250,
"taxRate": 0.05
},
"quantity": 2,
"title": "BBQ Sauce"
}
],
"id": "OPTSAUCE",
"title": "Sauce Selection"
},
{
"choices": [
{
"id": "SAUCE001",
"options": [
{},
{}
],
"price": {
"amount": 2300,
"taxIncluded": 250,
"taxRate": 0.05
},
"quantity": 2,
"title": "BBQ Sauce"
},
{
"id": "SAUCE001",
"options": [
{},
{}
],
"price": {
"amount": 2300,
"taxIncluded": 250,
"taxRate": 0.05
},
"quantity": 2,
"title": "BBQ Sauce"
}
],
"id": "OPTSAUCE",
"title": "Sauce Selection"
}
],
"price": {
"amount": 2300,
"taxIncluded": 250,
"taxRate": 0.05
},
"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": 600,
"completedAt": "2018-08-08T02:35:21Z",
"creditAmount": 200,
"currency": "AUD",
"deliveryAmount": 1200,
"discount": "Commodi quasi aut.",
"discountAmount": 300,
"externalAmount": 600,
"feeAmount": 10,
"id": "29e13de7-d158-4aba-a928-7d868c1dbfb9",
"locationId": "01HMWZ6W8HK7FHE4H0RJC74M7R",
"payoutAmount": 590,
"refId": "INV123456",
"refundedAt": "2018-08-08T02:35:21Z",
"state": "completed",
"tipAmount": 100,
"total": 1000
},
"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",
"taxIncluded": -65
},
{
"amount": -500,
"id": "DISC001",
"label": "Taco Tuesday 2-for-1 Deal",
"taxIncluded": -65
},
{
"amount": -500,
"id": "DISC001",
"label": "Taco Tuesday 2-for-1 Deal",
"taxIncluded": -65
}
],
"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": [
{
"id": "SAUCE001",
"options": [
{},
{}
],
"price": {
"amount": 2300,
"taxIncluded": 250,
"taxRate": 0.05
},
"quantity": 2,
"title": "BBQ Sauce"
},
{
"id": "SAUCE001",
"options": [
{},
{}
],
"price": {
"amount": 2300,
"taxIncluded": 250,
"taxRate": 0.05
},
"quantity": 2,
"title": "BBQ Sauce"
}
],
"id": "OPTSAUCE",
"title": "Sauce Selection"
},
{
"choices": [
{
"id": "SAUCE001",
"options": [
{},
{}
],
"price": {
"amount": 2300,
"taxIncluded": 250,
"taxRate": 0.05
},
"quantity": 2,
"title": "BBQ Sauce"
},
{
"id": "SAUCE001",
"options": [
{},
{}
],
"price": {
"amount": 2300,
"taxIncluded": 250,
"taxRate": 0.05
},
"quantity": 2,
"title": "BBQ Sauce"
}
],
"id": "OPTSAUCE",
"title": "Sauce Selection"
}
],
"price": {
"amount": 2300,
"taxIncluded": 250,
"taxRate": 0.05
},
"quantity": 1,
"title": "Burger"
},
{
"amount": 1100,
"id": "FOOD001",
"note": "No tomato please",
"options": [
{
"choices": [
{
"id": "SAUCE001",
"options": [
{},
{}
],
"price": {
"amount": 2300,
"taxIncluded": 250,
"taxRate": 0.05
},
"quantity": 2,
"title": "BBQ Sauce"
},
{
"id": "SAUCE001",
"options": [
{},
{}
],
"price": {
"amount": 2300,
"taxIncluded": 250,
"taxRate": 0.05
},
"quantity": 2,
"title": "BBQ Sauce"
}
],
"id": "OPTSAUCE",
"title": "Sauce Selection"
},
{
"choices": [
{
"id": "SAUCE001",
"options": [
{},
{}
],
"price": {
"amount": 2300,
"taxIncluded": 250,
"taxRate": 0.05
},
"quantity": 2,
"title": "BBQ Sauce"
},
{
"id": "SAUCE001",
"options": [
{},
{}
],
"price": {
"amount": 2300,
"taxIncluded": 250,
"taxRate": 0.05
},
"quantity": 2,
"title": "BBQ Sauce"
}
],
"id": "OPTSAUCE",
"title": "Sauce Selection"
}
],
"price": {
"amount": 2300,
"taxIncluded": 250,
"taxRate": 0.05
},
"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": 600,
"completedAt": "2018-08-08T02:35:21Z",
"creditAmount": 200,
"currency": "AUD",
"deliveryAmount": 1200,
"discount": "Commodi quasi aut.",
"discountAmount": 300,
"externalAmount": 600,
"feeAmount": 10,
"id": "29e13de7-d158-4aba-a928-7d868c1dbfb9",
"locationId": "01HMWZ6W8HK7FHE4H0RJC74M7R",
"payoutAmount": 590,
"refId": "INV123456",
"refundedAt": "2018-08-08T02:35:21Z",
"state": "completed",
"tipAmount": 100,
"total": 1000
},
"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",
"taxIncluded": -65
},
{
"amount": -500,
"id": "DISC001",
"label": "Taco Tuesday 2-for-1 Deal",
"taxIncluded": -65
}
],
"createdAt": "2021-08-04T04:22:43Z",
"currency": "NZD",
"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": [
{
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"price": {
"amount": 2300,
"taxIncluded": 250,
"taxRate": 0.05
},
"quantity": 2,
"title": "BBQ Sauce"
},
{
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"price": {
"amount": 2300,
"taxIncluded": 250,
"taxRate": 0.05
},
"quantity": 2,
"title": "BBQ Sauce"
},
{
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"price": {
"amount": 2300,
"taxIncluded": 250,
"taxRate": 0.05
},
"quantity": 2,
"title": "BBQ Sauce"
},
{
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"price": {
"amount": 2300,
"taxIncluded": 250,
"taxRate": 0.05
},
"quantity": 2,
"title": "BBQ Sauce"
}
],
"id": "OPTSAUCE",
"title": "Sauce Selection"
},
{
"choices": [
{
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"price": {
"amount": 2300,
"taxIncluded": 250,
"taxRate": 0.05
},
"quantity": 2,
"title": "BBQ Sauce"
},
{
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"price": {
"amount": 2300,
"taxIncluded": 250,
"taxRate": 0.05
},
"quantity": 2,
"title": "BBQ Sauce"
},
{
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"price": {
"amount": 2300,
"taxIncluded": 250,
"taxRate": 0.05
},
"quantity": 2,
"title": "BBQ Sauce"
},
{
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"price": {
"amount": 2300,
"taxIncluded": 250,
"taxRate": 0.05
},
"quantity": 2,
"title": "BBQ Sauce"
}
],
"id": "OPTSAUCE",
"title": "Sauce Selection"
}
],
"price": {
"amount": 2300,
"taxIncluded": 250,
"taxRate": 0.05
},
"quantity": 1,
"title": "Burger"
},
{
"amount": 1100,
"id": "FOOD001",
"note": "No tomato please",
"options": [
{
"choices": [
{
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"price": {
"amount": 2300,
"taxIncluded": 250,
"taxRate": 0.05
},
"quantity": 2,
"title": "BBQ Sauce"
},
{
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"price": {
"amount": 2300,
"taxIncluded": 250,
"taxRate": 0.05
},
"quantity": 2,
"title": "BBQ Sauce"
},
{
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"price": {
"amount": 2300,
"taxIncluded": 250,
"taxRate": 0.05
},
"quantity": 2,
"title": "BBQ Sauce"
},
{
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"price": {
"amount": 2300,
"taxIncluded": 250,
"taxRate": 0.05
},
"quantity": 2,
"title": "BBQ Sauce"
}
],
"id": "OPTSAUCE",
"title": "Sauce Selection"
},
{
"choices": [
{
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"price": {
"amount": 2300,
"taxIncluded": 250,
"taxRate": 0.05
},
"quantity": 2,
"title": "BBQ Sauce"
},
{
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"price": {
"amount": 2300,
"taxIncluded": 250,
"taxRate": 0.05
},
"quantity": 2,
"title": "BBQ Sauce"
},
{
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"price": {
"amount": 2300,
"taxIncluded": 250,
"taxRate": 0.05
},
"quantity": 2,
"title": "BBQ Sauce"
},
{
"id": "SAUCE001",
"options": [
{},
{},
{},
{}
],
"price": {
"amount": 2300,
"taxIncluded": 250,
"taxRate": 0.05
},
"quantity": 2,
"title": "BBQ Sauce"
}
],
"id": "OPTSAUCE",
"title": "Sauce Selection"
}
],
"price": {
"amount": 2300,
"taxIncluded": 250,
"taxRate": 0.05
},
"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": 600,
"completedAt": "2018-08-08T02:35:21Z",
"creditAmount": 200,
"currency": "GBP",
"deliveryAmount": 1200,
"discount": "Distinctio temporibus doloremque aut quam non reiciendis.",
"discountAmount": 300,
"externalAmount": 600,
"feeAmount": 10,
"id": "29e13de7-d158-4aba-a928-7d868c1dbfb9",
"locationId": "01HMWZ6W8HK7FHE4H0RJC74M7R",
"payoutAmount": 590,
"refId": "INV123456",
"refundedAt": "2018-08-08T02:35:21Z",
"state": "completed",
"tipAmount": 100,
"total": 1000
},
"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) Unique ID for the location this payment belongs to. May be null on some payments (e.g., promotion purchases). |
| refId | string | (optional) Reference ID provided by payment source (e.g., POS for an order). Not guaranteed to be unique. |
| completedAt | string | When the payment was completed |
| refundedAt | string | (optional) When the payment was refunded |
| chargedAmount | integer | The amount charged to the customer's payment method (credit card) in the lowest denomination (e.g., cents). This will be the total plus tips, minus any discounts and credits. |
| creditAmount | integer | The LOKE-applied credit amount in the lowest denomination (e.g., cents). This will be 0 if there is no credit associated with the payment. If multiple credits have been applied this will be the sum of all credits. Exclude external credits. |
| currency | string(enum) | The currency this payment was processed in "AUD", "SGD", "GBP", "NZD", "USD" |
| deliveryAmount | integer | The charge for delivery in the lowest denomination (e.g., 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 | The LOKE-applied discount amount in the lowest denomination (e.g., cents). This will be 0 if there is no discount associated with the payment. If multiple discounts have been applied this will be the sum of all discounts. Exclude external discounts. |
| externalAmount | integer | The amount (to be) paid by an external payment method (cash etc). This is what the chargedAmount would have been if the customer had payed via LOKE. Only one of chargedAmount or externalPaymentAmount will be non-zero. |
| feeAmount | integer | The fee collected and withheld by LOKE for this payment in the lowest denomination (e.g., cents). This will be 0 if there is no fee associated with the payment. |
| payoutAmount | integer | The amount (to be) paid out to the merchant in the lowest denomination (e.g., cents). This will be the chargedAmount minus the feeAmount. |
| state | string | Current state of payment (e.g., completed, refunded) |
| tipAmount | integer | The tip amount in the lowest denomination (e.g., cents). This will be 0 if the tip was 0 or if there is no tip associated with the payment. |
| total | integer | The total amount in the lowest denomination (e.g., cents). This will be the sum of all the items, external (non-LOKE) discounts, external surcharges, and delivery fees. |
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 | (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. |
| autoComplete | boolean | (optional) 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 | (optional) The terminal the order was completed from. Use something meaningful to your system. |