Skip to main content

Get POS Order Status (v1)

Method & Path

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

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

Description

Get a single POS order status by ID.

Authentication

Required: JWT in Authorization header.

Required permissions: store.orders.manage

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

Path Parameters

ParameterTypeRequiredDescription
workspaceIdstringYesWorkspace identifier
statusIdstringYesOrder status ID (MongoDB ObjectId)

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
  • 404 Not Found: Workspace or order status not found
  • 500 Internal Server Error: Server error