AZazure
orders

Get all orders

Changed on

Returns a list of all orders in the system

get/orders

Request

  • Base URL
    <BURGER_API_HOST>/api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    <BURGER_API_HOST>/api/orders
  • Auth
    none declared

Query parameters

userIdstring

Filter orders by userId

statusstring

Filter orders by status (comma-separated for multiple, e.g. pending,ready)

laststring

Filter orders created in the last X minutes/hours (e.g. 60m, 2h)

Response

List of orders

idstring required
createdAtstring date-time required
estimatedCompletionAtstring date-time required
completedAtstring date-time

ISO date string for when the order was completed (undefined until completed)

nicknamestring

Optional nickname for the order

totalPricenumber float required
status'pending' | 'in-preparation' | 'ready' | 'completed' | 'cancelled' required
  • pending: Order has been created but not yet started - in-preparation: Order is being prepared - ready: Order is ready for pickup - completed: Order has been picked up - cancelled: Order has been cancelled

Example response

[
  {
    "items": [
      {
        "burgerId": "burger-1",
        "quantity": 1,
        "extraToppingIds": [
          "topping-1",
          "topping-2"
        ]
      }
    ]
  }
]

Changes