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

# List Orders

> List all F&B orders with optional filters

List all orders for the workspace F\&B module. Supports filtering by status, claim status, order type, table number, customer, and order number. Returns up to 200 orders sorted by creation date (newest first).

## Request

```bash theme={null}
curl -X GET "https://api.series.hr/fnb/list-orders?status=pending&claimStatus=not-claimed" \
  -H "apikey: YOUR_API_KEY"
```

## Parameters

<ParamField query="status" type="string">
  Filter by order status: `pending`, `preparing`, `ready`, `served`, or `cancelled`.
</ParamField>

<ParamField query="claimStatus" type="string">
  Filter by claim status: `not-claimed` or `claimed`.
</ParamField>

<ParamField query="orderType" type="string">
  Filter by order type: `dine-in` or `to-go`.
</ParamField>

<ParamField query="tableNumber" type="string">
  Filter by table number.
</ParamField>

<ParamField query="customer" type="string">
  Filter by customer user ID, username, or display name (partial match).
</ParamField>

<ParamField query="orderNumber" type="string">
  Filter by order number.
</ParamField>

## Response

<ResponseField status={200} name="200">
  ```json theme={null}
  {
    "success": true,
    "data": {
      "WorkspaceId": "a7d5339a-5531-4336-99c6-6f3249c9ac20",
      "WorkspaceName": "Café Series",
      "Orders": [
        {
          "Id": "1717027200000",
          "Customer": {
            "UserId": 714760171,
            "Username": "builderman",
            "DisplayName": "Builderman",
            "AvatarUrl": "https://tr.rbxcdn.com/..."
          },
          "OrderType": "dine-in",
          "TableNumber": "T1",
          "OrderNumber": "12",
          "Items": [
            {
              "MenuItemId": "item-1",
              "Name": "Espresso",
              "Quantity": 2,
              "Price": 25,
              "Notes": "Extra hot"
            }
          ],
          "Status": "pending",
          "ClaimStatus": "not-claimed",
          "ClaimedBy": null,
          "Total": 50,
          "CreatedAt": "2026-04-05T11:30:00.000Z",
          "CreatedBy": "714760171"
        }
      ],
      "TotalOrders": 1,
      "Filters": {
        "status": "pending",
        "claimStatus": "not-claimed"
      }
    }
  }
  ```
</ResponseField>

## Status Codes

* `200`: Orders returned successfully
* `400`: Invalid filter value
* `401`: API key is required or invalid
* `403`: F\&B module is disabled or workspace access is denied


## OpenAPI

````yaml GET /fnb/list-orders
openapi: 3.0.0
info:
  title: Series API
  version: 1.0.0
  description: >-
    Series API — a free REST API by Sailboat Games, LLC that lets Roblox
    communities programmatically manage workspaces, staff, sessions, time-off
    and activity data.
  contact:
    name: Sailboat Games, LLC.
    email: admin@sailboatgames.com
servers:
  - url: https://api.series.hr
    description: Production API
security:
  - ApiKeyAuth: []
paths:
  /fnb/list-orders:
    get:
      tags:
        - Food & Beverage
      summary: List orders
      description: >-
        List all orders with optional filters for status, claim status, order
        type, table, customer, and order number.
      parameters:
        - name: status
          in: query
          required: false
          schema:
            type: string
            enum:
              - pending
              - preparing
              - ready
              - served
              - cancelled
          description: Filter by order status
        - name: claimStatus
          in: query
          required: false
          schema:
            type: string
            enum:
              - not-claimed
              - claimed
          description: Filter by claim status
        - name: orderType
          in: query
          required: false
          schema:
            type: string
            enum:
              - dine-in
              - to-go
          description: Filter by order type
        - name: tableNumber
          in: query
          required: false
          schema:
            type: string
          description: Filter by table number
        - name: customer
          in: query
          required: false
          schema:
            type: string
          description: Filter by customer user ID, username, or display name
        - name: orderNumber
          in: query
          required: false
          schema:
            type: string
          description: Filter by order number
      responses:
        '200':
          description: Orders list
        '400':
          description: Invalid filter value
        '401':
          description: API key is required
        '403':
          description: F&B module disabled or access denied
      security:
        - ApiKeyAuth: []
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: apikey
      description: >-
        Pass your API key in the `apikey` header. Alternatively, the `x-api-key`
        header is also accepted.

````