Get order status by ID

Retrieve a single order status by its ID.

get/order-status/{id}

Path parameters

idnumber required

Response

Order status retrieved successfully

idnumber required

Order status ID

statusstring required

Order status name

backgroundColorstring

Background color for the status

textColorstring

Text color for the status

borderColorstring

Border color for the status

isSystemDefinedboolean required

Whether this status is system defined

createdByNamestring

Created by user name

Example response

{
  "id": 1,
  "status": "Pending",
  "backgroundColor": "#FF5733",
  "textColor": "#FFFFFF",
  "borderColor": "#000000",
  "createdByName": "John Doe"
}

Changes

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