> ## Documentation Index
> Fetch the complete documentation index at: https://docs.maple.inc/llms.txt
> Use this file to discover all available pages before exploring further.

# List orders

> Lists orders for the locations the app is connected to as POS receiver.

GET`https://api.maple.inc/v1/orders`API key

Lists orders for the locations the app is connected to as POS receiver. Without `since`, results are newest first. With `since`, results drain oldest first from that exclusive checkpoint; while `has_more` is true, repeat with `starting_after` set to the last order id from the previous page. `starting_after` must be an order owned by the app and requires `since`. Set a page size from 1 to 100. Money is in integer cents; line-item modifiers reflect the directly-selected (first-level) options.

## Authorization

Send your API key as `Authorization: Bearer <key>`: `mpk_test_…` against the sandbox (`https://api.staging.maple.inc/v1`), `mpk_live_…` against production. See [Authentication](https://docs.maple.inc/developer-api/concepts/authentication.md). The samples read the key from `MAPLE_KEY` and the base URL from `MAPLE_BASE`, as set up in the [Quickstart](https://docs.maple.inc/developer-api/quickstart.md).

## Parameters

- `since` string or null query

- `starting_after` string or null query

- `limit` string or null query

## Responses

### 200 OK

- `object` string required

  Always `list`.

- `data` object\[] required

- `data[].object` string required

  Always `order`.

- `data[].id` string required

- `data[].livemode` boolean required

  True when the order belongs to the live environment; false for test-mode data.

- `data[].created` number required

- `data[].status` string required

- `data[].payment_status` string or null required

- `data[].location_id` string or null required

- `data[].fulfillment_type` string required

- `data[].scheduled_for` string or null required

  Customer-selected completion time (ISO 8601, UTC) for scheduled orders; null for ASAP orders. Prepare the order for this time, not on receipt.

- `data[].delivery_address` object or null required

  The delivery address for delivery orders, including delivery instructions; null for pickup orders or when no stored address is available.

- `data[].delivery_address.street` string required

- `data[].delivery_address.unit` string or null required

- `data[].delivery_address.city` string required

- `data[].delivery_address.state` string required

- `data[].delivery_address.zip` string required

- `data[].delivery_address.notes` string or null required

- `data[].customer` object required

- `data[].customer.name` string required

- `data[].customer.phone` string or null required

  Customer phone number in E.164 format (e.g. +14155552671); null when the customer provided none.

- `data[].customer.phone_last_four` string or null required

  Last four digits of the customer phone number.

- `data[].line_items` object\[] required

- `data[].line_items[].name` string required

- `data[].line_items[].menu_entity_id` string or null required

- `data[].line_items[].quantity` number required

- `data[].line_items[].base_price` number required

- `data[].line_items[].tax` number required

- `data[].line_items[].modifiers` object\[] required

- `data[].line_items[].modifiers[].name` string required

- `data[].line_items[].modifiers[].menu_entity_id` string or null required

- `data[].line_items[].modifiers[].quantity` number required

- `data[].line_items[].modifiers[].price` number required

- `data[].totals` object required

  All amounts in integer USD cents. `total` = subtotal + tax + surcharge + tip + delivery fees.

- `data[].totals.currency` string required

- `data[].totals.subtotal` number required

- `data[].totals.tax` number required

- `data[].totals.surcharge` number required

- `data[].totals.tip` number required

- `data[].totals.delivery_fee` number required

- `data[].totals.delivery_tip` number required

- `data[].totals.total` number required

- `data[].external_id` string or null required

- `data[].payment` object required

- `data[].payment.provider` string or null required

- `data[].payment.status` string or null required

- `data[].payment.payment_link_url` string or null required

- `has_more` boolean required

### Errors

- `400` Bad request DeveloperApiBadRequest

- `401` Unauthorized DeveloperApiUnauthorized

- `403` Forbidden DeveloperApiForbidden

- `429` Too many requests DeveloperApiRateLimited

Every error body names the error in `_tag`, explains it in `message`, and says where to report it in `feedback`. See [Errors](https://docs.maple.inc/developer-api/concepts/errors.md).

A `429` also sends `Retry-After`: Seconds to wait before retrying; also returned as retry\_after in the body.

List orders

```sh
curl "$MAPLE_BASE/orders" \
  -H "Authorization: Bearer $MAPLE_KEY"
```

```python
import os
import requests


r = requests.get(
    f"{os.environ['MAPLE_BASE']}/orders",
    headers={"Authorization": f"Bearer {os.environ['MAPLE_KEY']}"},
    timeout=30,
)
r.raise_for_status()
print(r.json())
```

```js
const res = await fetch(`${process.env.MAPLE_BASE}/orders`, {
  headers: {
    Authorization: `Bearer ${process.env.MAPLE_KEY}`,
  },
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());
```

```json
{
  "object": "list",
  "data": [
    {
      "object": "order",
      "id": "string",
      "livemode": true,
      "created": 1.5,
      "status": "string",
      "payment_status": "string",
      "location_id": "str_123",
      "fulfillment_type": "string",
      "scheduled_for": "string",
      "delivery_address": {
        "street": "string",
        "unit": "string",
        "city": "string",
        "state": "string",
        "zip": "string",
        "notes": "string"
      },
      "customer": {
        "name": "string",
        "phone": "+15555550123",
        "phone_last_four": "string"
      },
      "line_items": [
        {
          "name": "string",
          "menu_entity_id": "string",
          "quantity": 1.5,
          "base_price": 1.5,
          "tax": 1.5,
          "modifiers": [
            {
              "name": "string",
              "menu_entity_id": "string",
              "quantity": null,
              "price": null
            }
          ]
        }
      ],
      "totals": {
        "currency": "USD",
        "subtotal": 1.5,
        "tax": 1.5,
        "surcharge": 1.5,
        "tip": 1.5,
        "delivery_fee": 1.5,
        "delivery_tip": 1.5,
        "total": 1.5
      },
      "external_id": "string",
      "payment": {
        "provider": "string",
        "status": "string",
        "payment_link_url": "string"
      }
    }
  ],
  "has_more": true
}
```

```json
{
  "_tag": "DeveloperApiBadRequest",
  "code": "string",
  "message": "string",
  "feedback": "string"
}
```