Skip to main content
GET
/
fnb
/
list-orders
List orders
curl --request GET \
  --url https://api.series.hr/fnb/list-orders \
  --header 'apikey: <api-key>'
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

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

​
Parameters

​
status
string
Filter by order status: pending, preparing, ready, served, or cancelled.
​
claimStatus
string
Filter by claim status: not-claimed or claimed.
​
orderType
string
Filter by order type: dine-in or to-go.
​
tableNumber
string
Filter by table number.
​
customer
string
Filter by customer user ID, username, or display name (partial match).
​
orderNumber
string
Filter by order number.

​
Response

​
200
{
  "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"
    }
  }
}

​
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

Authorizations

​
apikey
string
header
required

Pass your API key in the apikey header. Alternatively, the x-api-key header is also accepted.

Query Parameters

​
status
enum<string>

Filter by order status

Available options:
pending,
preparing,
ready,
served,
cancelled
​
claimStatus
enum<string>

Filter by claim status

Available options:
not-claimed,
claimed
​
orderType
enum<string>

Filter by order type

Available options:
dine-in,
to-go
​
tableNumber
string

Filter by table number

​
customer
string

Filter by customer user ID, username, or display name

​
orderNumber
string

Filter by order number

Response

Orders list