Light Mode

Order Status Details

GET/orders/statuses/{status_id}

Last modified: a month ago

This endpoint allows you to fetch details about specific order status by passing the status_id as a path parameter.

`orders.read` - Orders Read Only

Request

Authorization

Inherited from project

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer 2f68dbbf-519d-4f01-9636-e2421b68f379

Path Params

status_id

integer

required

Unique identification number assigned to a status. List of Status IDs can be found here

Request samples

Responses

Success(200)

Unauthorized(401)

HTTP Code: 200

Content Type : JSONapplication/json

status

number

optional

Response status code, a numeric or alphanumeric identifier used to convey the outcome or status of a request, operation, or transaction in various systems and applications, typically indicating whether the action was successful, encountered an error, or resulted in a specific condition.

success

boolean

optional

Response flag, boolean indicator used to signal a particular condition or state in the response of a system or application, often representing the presence or absence of certain conditions or outcomes.

data

#/definitions/1389233

optional

{
  "status": 200,
  "success": true,
  "data": {
    "id": 1638621685,
    "name": "تم التنفيذ",
    "type": "custom",
    "slug": "completed",
    "message": "[ {store.name} ] \\n أصبحت حالة طلبك {order.id} {status}",
    "color": "#58C9B9",
    "icon": "sicon-gold-badge",
    "sort": 0,
    "is_active": true,
    "original": {
      "id": 1298199463,
      "name": "تم التنفيذ"
    },
    "parent": {},
    "children": [
      {
        "id": 1422535667,
        "name": "جاري التوصيل",
        "slug": "delivering",
        "type": "custom",
        "message": "[ {store.name} ] \\n أصبحت حالة طلبك {order.id} {status}",
        "color": "#58C9B9",
        "icon": "sicon-shipping",
        "sort": 0,
        "is_active": true
      },
      {
        "id": 647449340,
        "name": "تم التوصيل",
        "slug": "delivered",
        "type": "custom",
        "message": "[ {store.name} ] \\n أصبحت حالة طلبك {order.id} {status}",
        "color": "#58C9B9",
        "icon": "sicon-party-horn",
        "sort": 1,
        "is_active": true
      },
      {
        "id": 1887201789,
        "name": "تم الشحن",
        "slug": "shipped",
        "type": "custom",
        "message": "[ {store.name} ] \\n أصبحت حالة طلبك {order.id} {status}",
        "color": "#58C9B9",
        "icon": "sicon-shipping-fast",
        "sort": 2,
        "is_active": true
      }
    ]
  }
}

Last modified: a month ago