Skip to main content

List POS Order Statuses (v1)

Method & Path

GET /v1/workspace/:workspaceId/pos/order-statuses

Actual backend path: /v1/workspace/:workspaceId/pos/order-statuses

Description

List workspace-defined order statuses for POS (e.g. "قيد التحضير", "جاهز", "تم التوصيل"). These statuses can be assigned to POS invoices and used to filter the orders list.

Authentication

Required: JWT in Authorization header.

Required permissions: store.orders.manage

Persona: Workspace Owner, Staff (store.orders.manage)

Headers

HeaderTypeRequiredDescription
AuthorizationstringYesBearer token: Bearer <token>

Path Parameters

ParameterTypeRequiredDescription
workspaceIdstringYesWorkspace identifier

Response 200 OK

[
{
"id": "507f1f77bcf86cd799439099",
"workspaceId": "507f1f77bcf86cd799439010",
"name": "preparing",
"labelAr": "قيد التحضير",
"order": 0,
"createdAt": "2024-01-15T10:00:00.000Z",
"updatedAt": "2024-01-15T10:00:00.000Z"
}
]

Common Errors

  • 401 Unauthorized: Missing or invalid authentication token
  • 403 Forbidden: Insufficient permissions (requires store.orders.manage)
  • 404 Not Found: Workspace not found
  • 500 Internal Server Error: Server error