Light Mode

Update Custom Order Status

PUT/orders/statuses/{status_id}

Last modified: 2 months ago

This endpoint allows you to update a custom order status by passing the status_id as a path parameter.

:::tip[Note]
Use available parameters to send as a body request.
:::

:::danger[Important]
All variables in the Update Custom Order Status body request are optional. At least one of the variables must be in the body request payload. Otherwise, an error will be shown if you send an empty body request payload.
:::

`orders.read_write` - Orders Read & Write

Request

Path Params

status_id

integer

required

The Status ID. List of Status ID can be found here.

No schema defined

{
  "name": "تبقى 40 دقيقة على الدفع",
  "message": "أكمل الدفع الان",
  "icon": "sicon-cup-hot",
  "sort": 3,
  "is_active": true
}

Request samples

Responses

Success(200)

Not Found(404)

Error Validation(422)

HTTP Code: 200

Content Type : JSONapplication/json

No schema defined

{
  "status": 200,
  "success": true,
  "data": {
    "id": 224309239,
    "name": "حنراجع طلبك",
    "type": "custom",
    "slug": "under_review",
    "message": "حنراجع طلبك وقد تستغرق المراجعة 24 ساعة كحد أقصى",
    "color": "#ED696D",
    "icon": "sicon-back",
    "sort": 5,
    "is_active": true,
    "original": {
      "id": 566146469,
      "name": "بإنتظار المراجعة"
    },
    "parent": null,
    "children": []
  }
}

Last modified: 2 months ago