Order Status Details

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

Scopes

orders.read - Orders Read Only

Request

Authorization

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Path Params

status_id

integer

required

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

Responses

🟢200Success

application/json

Body

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

object (OrderStatuses)

optional

number

required

A unique identifier associated with a specific status assigned to an order.
List of order statuses can be found here

Example:

863076598

name

string

required

A label or designation given to a specific status assigned to an order. 🌐Support multi-language

Example:

في انتظار الدفع

type

enum<string>

required

The categorization or classification of an order.

Allowed values:

originalcustom

Example:

custom

slug

string

required

A user-friendly and URL-friendly text string associated with a specific order. Note the parent slug is inherited.

Example:

payment_pending

message

string

required

A remark that provides information about the current status or condition of an order. 🌐Support multi-language

Example:

[ {store.name} ] \\n أصبحت حالة طلبك {order.id} {status}

color

string

required

A specific color code or indicator assigned to different order statuses.

Example:

#58C9B9

icon

string

required

Graphical symbol or image used to represent different order statuses.

Example:

sicon-gold-badge

sort

number

required

The specific numerical or alphanumeric sequence assigned to each order status in a list or database.

Example:

is_active

boolean

required

The option to indicate that the order status is active.

Default:

true

original

object | null

required

parent

object | null

required

children

array [object {9}] | null

required

Examples

Example | Custom Status TypeExample | Original Status Type

{
  "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
      }
    ]
  }
}

🟠401Unauthorized

Request

Request samples

Responses