FIfindmydocument
Order Status Controller

Update order status

Update an existing order status. System-defined statuses cannot be updated.

patch/order-status/{id}

Request

Path parameters

idnumber required
Example:1

The ID of the entity

Request body

statusstring required

Order status name

backgroundColorstring

Background color for the status (hex color code)

textColorstring

Text color for the status (hex color code)

borderColorstring

Border color for the status (hex color code)

isSystemDefinedboolean

Whether this status is system defined

Example request

{
  "status": "Pending",
  "backgroundColor": "#FF5733",
  "textColor": "#FFFFFF",
  "borderColor": "#000000"
}

Response

Order status updated successfully

Changes

No recorded changes to this operation across all 7 revisions of this API.