Skip to main content
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

Parameters

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

Response

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