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}/orders

Parameters

NameTypeInDescription
organizationIdstringpathOrganization ID
locationIdstringpathLocation ID
afterstringqueryThe 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

NameTypeInDescription
organizationIdstringpathOrganization ID
locationIdstringpathLocation ID
orderIdstringpathOrder 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}/accept

Parameters

NameTypeInDescription
organizationIdstringpathOrganization ID
locationIdstringpathLocation ID
orderIdstringpath

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}/reject

Parameters

NameTypeInDescription
organizationIdstringpathOrganization ID
locationIdstringpathLocation ID
orderIdstringpath

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}/progress

Parameters

NameTypeInDescription
organizationIdstringpathOrganization ID
locationIdstringpathLocation ID
orderIdstringpath

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}/complete

Parameters

NameTypeInDescription
organizationIdstringpathOrganization ID
locationIdstringpathLocation ID
orderIdstringpath

Request Body

OrderCompletePayload
{
  "terminalId": "terminal001/user001"
}

Responses

204: No Content response.
404: not_found: Not Found response.
409: conflict: Conflict response.

Models

Order

NameTypeDescription
idstring
acceptedAtstring(optional) When the order was accepted
completedAtstring(optional) When the order was completed
createdAtstringWhen this order was created
rejectedAtstring(optional) When the order was rejected
rejectionReasonstring(optional)
statestringCurrent state of order (Current Values: "pending" | "accepted" | "rejected" | "completed")
cartCart
paymentOrderPayment
customerCustomerTiny

CustomerTiny

NameTypeDescription
idstringUnique ID of the Customer
emailstring(optional) The Customers email address
firstNamestringCustomer first name or given name
lastNamestringCustomer last name or surname
phoneNumberstring(optional) The Customers mobile phone number

OrderPayment

NameTypeDescription
idstringPayment ID
locationIdstring(optional) Unique ID for the location this payment belongs to. May be null on some payments (e.g., promotion purchases).
refIdstring(optional) Reference ID provided by payment source (e.g., POS for an order). Not guaranteed to be unique.
completedAtstringWhen the payment was completed
refundedAtstring(optional) When the payment was refunded
chargedAmountintegerThe 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.
creditAmountintegerThe 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.
currencystring(enum)The currency this payment was processed in
"AUD", "SGD", "GBP", "NZD", "USD"
deliveryAmountintegerThe 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.
discountstring(optional)
discountAmountintegerThe 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.
externalAmountintegerThe 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.
feeAmountintegerThe 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.
payoutAmountintegerThe amount (to be) paid out to the merchant in the lowest denomination (e.g., cents). This will be the chargedAmount minus the feeAmount.
statestringCurrent state of payment (Current Values: "submitted" | "settled" | "refunded")
tipAmountintegerThe 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.
totalintegerThe 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

NameTypeDescription
statusstring(enum)The current progress status of the order.
"READY", "AWAITING_DRIVER", "ON_THE_WAY", "CLOSE_BY"
coordsCoords(optional)

Coords

NameTypeDescription
latitudenumberLatitude
longitudenumberLongitude

OrderAcceptPayload

NameTypeDescription
refIdstring(optional) A reference to the order, generally something the staff has access to, should be unique
terminalIdstring(optional) The terminal the order was accepted from. Use something meaningful to your system.
autoCompleteboolean(optional) Auto complete will set the order to a fully completed state, no further action is required

OrderRejectPayload

NameTypeDescription
refIdstring(optional) A reference to the order, generally something the staff has access to, should be unique
terminalIdstring(optional) The terminal the order was accepted from. Use something meaningful to your system.
reasonstringThe reason for rejecting the order.

OrderCompletePayload

NameTypeDescription
terminalIdstring(optional) The terminal the order was completed from. Use something meaningful to your system.

In this article