Get order statuses with filters

Retrieve order statuses with optional search by status name and pagination.

get/order-status

Query parameters

searchstring

Example:Pending

Search by status name

isSystemDefinedboolean

Filter by system defined status

sortBy'status' | 'createdAt' | 'isSystemDefined'

Example:createdAt

Field to sort by

sortType'ASC' | 'DESC'

Example:DESC

Sort direction

pagenumber required

Page number for pagination

sizenumber required

Example:10

Number of items per page

Response

Order statuses retrieved successfully

totalItemsnumber required

Total number of items

pagenumber required

Current page number

sizenumber required

Number of items per page

Example response

{
  "totalItems": 100,
  "items": [
    {
      "id": 1,
      "status": "Pending",
      "backgroundColor": "#FF5733",
      "textColor": "#FFFFFF",
      "borderColor": "#000000",
      "createdByName": "John Doe"
    }
  ],
  "size": 10
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.