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
afterstringquery

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",
                  "title": "BBQ Sauce"
                },
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "title": "BBQ Sauce"
                },
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "title": "BBQ Sauce"
                },
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "title": "BBQ Sauce"
                }
              ],
              "id": "OPTSAUCE",
              "title": "Sauce Selection"
            },
            {
              "choices": [
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "title": "BBQ Sauce"
                },
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "title": "BBQ Sauce"
                },
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "title": "BBQ Sauce"
                },
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "title": "BBQ Sauce"
                }
              ],
              "id": "OPTSAUCE",
              "title": "Sauce Selection"
            },
            {
              "choices": [
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "title": "BBQ Sauce"
                },
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "title": "BBQ Sauce"
                },
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "title": "BBQ Sauce"
                },
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "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",
                  "title": "BBQ Sauce"
                },
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "title": "BBQ Sauce"
                },
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "title": "BBQ Sauce"
                },
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "title": "BBQ Sauce"
                }
              ],
              "id": "OPTSAUCE",
              "title": "Sauce Selection"
            },
            {
              "choices": [
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "title": "BBQ Sauce"
                },
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "title": "BBQ Sauce"
                },
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "title": "BBQ Sauce"
                },
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "title": "BBQ Sauce"
                }
              ],
              "id": "OPTSAUCE",
              "title": "Sauce Selection"
            },
            {
              "choices": [
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "title": "BBQ Sauce"
                },
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "title": "BBQ Sauce"
                },
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "title": "BBQ Sauce"
                },
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "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": 2344484629523713500,
      "completedAt": "2018-08-08T02:35:21Z",
      "creditAmount": 7300831886359522000,
      "currency": "Enim nesciunt.",
      "deliveryAmount": 1200,
      "discount": "Dolorem quidem cum et voluptate blanditiis.",
      "discountAmount": 5112408921058142000,
      "feeAmount": 5411828392743718000,
      "id": "29e13de7-d158-4aba-a928-7d868c1dbfb9",
      "locationId": "Reiciendis omnis neque dolore eaque.",
      "payoutAmount": 8273307142517683000,
      "refId": "Est esse tempora unde.",
      "refundedAt": "2018-08-08T02:35:21Z",
      "state": "Sit omnis numquam laborum non ab praesentium.",
      "tipAmount": 7645691577221413000,
      "total": 8858141711638465000
    },
    "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",
                  "title": "BBQ Sauce"
                },
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "title": "BBQ Sauce"
                },
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "title": "BBQ Sauce"
                },
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "title": "BBQ Sauce"
                }
              ],
              "id": "OPTSAUCE",
              "title": "Sauce Selection"
            },
            {
              "choices": [
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "title": "BBQ Sauce"
                },
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "title": "BBQ Sauce"
                },
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "title": "BBQ Sauce"
                },
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "title": "BBQ Sauce"
                }
              ],
              "id": "OPTSAUCE",
              "title": "Sauce Selection"
            },
            {
              "choices": [
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "title": "BBQ Sauce"
                },
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "title": "BBQ Sauce"
                },
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "title": "BBQ Sauce"
                },
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "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",
                  "title": "BBQ Sauce"
                },
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "title": "BBQ Sauce"
                },
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "title": "BBQ Sauce"
                },
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "title": "BBQ Sauce"
                }
              ],
              "id": "OPTSAUCE",
              "title": "Sauce Selection"
            },
            {
              "choices": [
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "title": "BBQ Sauce"
                },
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "title": "BBQ Sauce"
                },
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "title": "BBQ Sauce"
                },
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "title": "BBQ Sauce"
                }
              ],
              "id": "OPTSAUCE",
              "title": "Sauce Selection"
            },
            {
              "choices": [
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "title": "BBQ Sauce"
                },
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "title": "BBQ Sauce"
                },
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "title": "BBQ Sauce"
                },
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "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": 2344484629523713500,
      "completedAt": "2018-08-08T02:35:21Z",
      "creditAmount": 7300831886359522000,
      "currency": "Enim nesciunt.",
      "deliveryAmount": 1200,
      "discount": "Dolorem quidem cum et voluptate blanditiis.",
      "discountAmount": 5112408921058142000,
      "feeAmount": 5411828392743718000,
      "id": "29e13de7-d158-4aba-a928-7d868c1dbfb9",
      "locationId": "Reiciendis omnis neque dolore eaque.",
      "payoutAmount": 8273307142517683000,
      "refId": "Est esse tempora unde.",
      "refundedAt": "2018-08-08T02:35:21Z",
      "state": "Sit omnis numquam laborum non ab praesentium.",
      "tipAmount": 7645691577221413000,
      "total": 8858141711638465000
    },
    "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",
                  "title": "BBQ Sauce"
                },
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "title": "BBQ Sauce"
                },
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "title": "BBQ Sauce"
                },
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "title": "BBQ Sauce"
                }
              ],
              "id": "OPTSAUCE",
              "title": "Sauce Selection"
            },
            {
              "choices": [
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "title": "BBQ Sauce"
                },
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "title": "BBQ Sauce"
                },
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "title": "BBQ Sauce"
                },
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "title": "BBQ Sauce"
                }
              ],
              "id": "OPTSAUCE",
              "title": "Sauce Selection"
            },
            {
              "choices": [
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "title": "BBQ Sauce"
                },
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "title": "BBQ Sauce"
                },
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "title": "BBQ Sauce"
                },
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "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",
                  "title": "BBQ Sauce"
                },
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "title": "BBQ Sauce"
                },
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "title": "BBQ Sauce"
                },
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "title": "BBQ Sauce"
                }
              ],
              "id": "OPTSAUCE",
              "title": "Sauce Selection"
            },
            {
              "choices": [
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "title": "BBQ Sauce"
                },
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "title": "BBQ Sauce"
                },
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "title": "BBQ Sauce"
                },
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "title": "BBQ Sauce"
                }
              ],
              "id": "OPTSAUCE",
              "title": "Sauce Selection"
            },
            {
              "choices": [
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "title": "BBQ Sauce"
                },
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "title": "BBQ Sauce"
                },
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "title": "BBQ Sauce"
                },
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "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": 2344484629523713500,
      "completedAt": "2018-08-08T02:35:21Z",
      "creditAmount": 7300831886359522000,
      "currency": "Enim nesciunt.",
      "deliveryAmount": 1200,
      "discount": "Dolorem quidem cum et voluptate blanditiis.",
      "discountAmount": 5112408921058142000,
      "feeAmount": 5411828392743718000,
      "id": "29e13de7-d158-4aba-a928-7d868c1dbfb9",
      "locationId": "Reiciendis omnis neque dolore eaque.",
      "payoutAmount": 8273307142517683000,
      "refId": "Est esse tempora unde.",
      "refundedAt": "2018-08-08T02:35:21Z",
      "state": "Sit omnis numquam laborum non ab praesentium.",
      "tipAmount": 7645691577221413000,
      "total": 8858141711638465000
    },
    "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",
                  "title": "BBQ Sauce"
                },
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "title": "BBQ Sauce"
                },
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "title": "BBQ Sauce"
                },
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "title": "BBQ Sauce"
                }
              ],
              "id": "OPTSAUCE",
              "title": "Sauce Selection"
            },
            {
              "choices": [
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "title": "BBQ Sauce"
                },
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "title": "BBQ Sauce"
                },
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "title": "BBQ Sauce"
                },
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "title": "BBQ Sauce"
                }
              ],
              "id": "OPTSAUCE",
              "title": "Sauce Selection"
            },
            {
              "choices": [
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "title": "BBQ Sauce"
                },
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "title": "BBQ Sauce"
                },
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "title": "BBQ Sauce"
                },
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "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",
                  "title": "BBQ Sauce"
                },
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "title": "BBQ Sauce"
                },
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "title": "BBQ Sauce"
                },
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "title": "BBQ Sauce"
                }
              ],
              "id": "OPTSAUCE",
              "title": "Sauce Selection"
            },
            {
              "choices": [
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "title": "BBQ Sauce"
                },
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "title": "BBQ Sauce"
                },
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "title": "BBQ Sauce"
                },
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "title": "BBQ Sauce"
                }
              ],
              "id": "OPTSAUCE",
              "title": "Sauce Selection"
            },
            {
              "choices": [
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "title": "BBQ Sauce"
                },
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "title": "BBQ Sauce"
                },
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "title": "BBQ Sauce"
                },
                {
                  "amount": 20,
                  "id": "SAUCE001",
                  "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": 2344484629523713500,
      "completedAt": "2018-08-08T02:35:21Z",
      "creditAmount": 7300831886359522000,
      "currency": "Enim nesciunt.",
      "deliveryAmount": 1200,
      "discount": "Dolorem quidem cum et voluptate blanditiis.",
      "discountAmount": 5112408921058142000,
      "feeAmount": 5411828392743718000,
      "id": "29e13de7-d158-4aba-a928-7d868c1dbfb9",
      "locationId": "Reiciendis omnis neque dolore eaque.",
      "payoutAmount": 8273307142517683000,
      "refId": "Est esse tempora unde.",
      "refundedAt": "2018-08-08T02:35:21Z",
      "state": "Sit omnis numquam laborum non ab praesentium.",
      "tipAmount": 7645691577221413000,
      "total": 8858141711638465000
    },
    "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"
      },
      {
        "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": "SGD",
    "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",
                "title": "BBQ Sauce"
              },
              {
                "amount": 20,
                "id": "SAUCE001",
                "title": "BBQ Sauce"
              },
              {
                "amount": 20,
                "id": "SAUCE001",
                "title": "BBQ Sauce"
              },
              {
                "amount": 20,
                "id": "SAUCE001",
                "title": "BBQ Sauce"
              }
            ],
            "id": "OPTSAUCE",
            "title": "Sauce Selection"
          },
          {
            "choices": [
              {
                "amount": 20,
                "id": "SAUCE001",
                "title": "BBQ Sauce"
              },
              {
                "amount": 20,
                "id": "SAUCE001",
                "title": "BBQ Sauce"
              },
              {
                "amount": 20,
                "id": "SAUCE001",
                "title": "BBQ Sauce"
              },
              {
                "amount": 20,
                "id": "SAUCE001",
                "title": "BBQ Sauce"
              }
            ],
            "id": "OPTSAUCE",
            "title": "Sauce Selection"
          },
          {
            "choices": [
              {
                "amount": 20,
                "id": "SAUCE001",
                "title": "BBQ Sauce"
              },
              {
                "amount": 20,
                "id": "SAUCE001",
                "title": "BBQ Sauce"
              },
              {
                "amount": 20,
                "id": "SAUCE001",
                "title": "BBQ Sauce"
              },
              {
                "amount": 20,
                "id": "SAUCE001",
                "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",
                "title": "BBQ Sauce"
              },
              {
                "amount": 20,
                "id": "SAUCE001",
                "title": "BBQ Sauce"
              },
              {
                "amount": 20,
                "id": "SAUCE001",
                "title": "BBQ Sauce"
              },
              {
                "amount": 20,
                "id": "SAUCE001",
                "title": "BBQ Sauce"
              }
            ],
            "id": "OPTSAUCE",
            "title": "Sauce Selection"
          },
          {
            "choices": [
              {
                "amount": 20,
                "id": "SAUCE001",
                "title": "BBQ Sauce"
              },
              {
                "amount": 20,
                "id": "SAUCE001",
                "title": "BBQ Sauce"
              },
              {
                "amount": 20,
                "id": "SAUCE001",
                "title": "BBQ Sauce"
              },
              {
                "amount": 20,
                "id": "SAUCE001",
                "title": "BBQ Sauce"
              }
            ],
            "id": "OPTSAUCE",
            "title": "Sauce Selection"
          },
          {
            "choices": [
              {
                "amount": 20,
                "id": "SAUCE001",
                "title": "BBQ Sauce"
              },
              {
                "amount": 20,
                "id": "SAUCE001",
                "title": "BBQ Sauce"
              },
              {
                "amount": 20,
                "id": "SAUCE001",
                "title": "BBQ Sauce"
              },
              {
                "amount": 20,
                "id": "SAUCE001",
                "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",
                "title": "BBQ Sauce"
              },
              {
                "amount": 20,
                "id": "SAUCE001",
                "title": "BBQ Sauce"
              },
              {
                "amount": 20,
                "id": "SAUCE001",
                "title": "BBQ Sauce"
              },
              {
                "amount": 20,
                "id": "SAUCE001",
                "title": "BBQ Sauce"
              }
            ],
            "id": "OPTSAUCE",
            "title": "Sauce Selection"
          },
          {
            "choices": [
              {
                "amount": 20,
                "id": "SAUCE001",
                "title": "BBQ Sauce"
              },
              {
                "amount": 20,
                "id": "SAUCE001",
                "title": "BBQ Sauce"
              },
              {
                "amount": 20,
                "id": "SAUCE001",
                "title": "BBQ Sauce"
              },
              {
                "amount": 20,
                "id": "SAUCE001",
                "title": "BBQ Sauce"
              }
            ],
            "id": "OPTSAUCE",
            "title": "Sauce Selection"
          },
          {
            "choices": [
              {
                "amount": 20,
                "id": "SAUCE001",
                "title": "BBQ Sauce"
              },
              {
                "amount": 20,
                "id": "SAUCE001",
                "title": "BBQ Sauce"
              },
              {
                "amount": 20,
                "id": "SAUCE001",
                "title": "BBQ Sauce"
              },
              {
                "amount": 20,
                "id": "SAUCE001",
                "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": "CHECK001",
    "firstName": "CHECK001",
    "id": "CHECK001",
    "lastName": "CHECK001",
    "phoneNumber": "CHECK001"
  },
  "id": "642b791d-124f-41d6-a137-009f1fe84f77",
  "payment": {
    "chargedAmount": 4684978877690848000,
    "completedAt": "2018-08-08T02:35:21Z",
    "creditAmount": 1191507239647505200,
    "currency": "Dolorem doloremque.",
    "deliveryAmount": 1200,
    "discount": "Quia autem explicabo et.",
    "discountAmount": 6414892348536324000,
    "feeAmount": 3337097501518064600,
    "id": "29e13de7-d158-4aba-a928-7d868c1dbfb9",
    "locationId": "Earum ab similique assumenda dicta.",
    "payoutAmount": 8419938814405786000,
    "refId": "Commodi commodi saepe.",
    "refundedAt": "2018-08-08T02:35:21Z",
    "state": "Perferendis nemo quia.",
    "tipAmount": 5590651067981960000,
    "total": 810572843766876000
  },
  "rejectedAt": "2021-08-04T04:38:00Z",
  "rejectionReason": "Couldn't fulfill order, product out of stock",
  "state": "rejected"
}
404: 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 response.
409: 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 response.
409: 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": "READY"
}

Responses

204: No Content response.
404: Not Found 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 response.
409: Conflict response.

Models

Order

NameTypeDescription
idstring
acceptedAtstring(optional) When the order was accepted
completedAtstring(optional) When the order was completed
createdAtstring When this order was created
rejectedAtstring(optional) When the order was rejected
rejectionReasonstring(optional)
statestring
cartCart
paymentOrderPayment
customerCustomerTiny

CustomerTiny

NameTypeDescription
idstring Unique ID of the Customer
emailstring(optional) The Customers email address
firstNamestring Customer first name or given name
lastNamestring Customer last name or surname
phoneNumberstring(optional) The Customers mobile phone number

OrderPayment

NameTypeDescription
idstring Payment ID
locationIdstring(optional)
refIdstring(optional)
completedAtstring When the payment was completed
refundedAtstring(optional) When the payment was refunded
chargedAmountinteger Portion covered by credit card
creditAmountinteger Portion covered by customer credit
currencystring
deliveryAmountinteger 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.
discountstring(optional)
discountAmountinteger Portion discounted by user promotion
feeAmountinteger
payoutAmountinteger
statestring(optional)
tipAmountinteger
totalinteger Total amount covered by payment

OrderProgress

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

Coords

NameTypeDescription
latitudenumber Latitude
longitudenumber Longitude

OrderAcceptPayload

NameTypeDescription
refIdstring A reference to the order, generally something the staff has access to, should be unique
terminalIdstring The terminal the order was accepted from. Use something meaningful to your system.
autoCompleteboolean 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.
reasonstring The reason for rejecting the order.

OrderCompletePayload

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

In this article