List Order Statuses

This endpoint allows you to fetch a list of all order statuses and sub-statuses.

Scopes

orders.read - Orders Read Only

Add the parameter

Authorization

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

Example:

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

Responses

🟢200Success

application/json

Body

status

integer

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

array[object (ListOrderStatuses) {10}]

optional

number

required

A unique identifier assigned to a specific order. Order status list can be found here.

Example:

863076598

name

string

required

Descriptive name or label associated with the current status of an order. 🌐Support multi-language

Example:

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

type

enum<string>

required

The category of a specific order, indicating its purpose or nature.

Allowed values:

originalcustom

Example:

custom

slug

enum<string>

required

A unique string or identifier used to represent and access a specific order .

Allowed values:

payment_pendingwaiting_for_payment_confirmationpayment_failedwaiting to receive itin_progressunder_reviewcompleteddeliveringdeliveredshippedcanceledrestoredrestoring

Example:

payment_pending

sort

integer

required

The specific integer sequence assigned to each order status in a list or database, determining the order in which they are displayed or sorted.

message

string

required

Status customized message

icon

string

required

Status Icon.

is_active

boolean

required

Whether or not the status is active

parent

object | null

required

Parent of the order.

original

object | null

required

Original order.

Examples

Example | Custom Status TypeExample | Original Status Type

{
  "status": 200,
  "success": true,
  "data": [
    {
      "id": 863076598,
      "name": "في انتظار الدفع",
      "type": "custom",
      "slug": "payment_pending",
      "sort": 0,
      "message": "[ {store.name} ] \\n أصبحت حالة طلبك {order.id} {status}",
      "icon": "sicon-trash",
      "is_active": true,
      "parent": {},
      "original": {
        "id": 1473353380,
        "name": "بإنتظار الدفع"
      }
    },
    {
      "id": 224309239,
      "name": "جاري مراجعة طلبك",
      "type": "custom",
      "slug": "under_review",
      "sort": 1,
      "message": "",
      "icon": "sicon-trash",
      "is_active": true,
      "parent": {},
      "original": {
        "id": 566146469,
        "name": "بإنتظار المراجعة"
      }
    },
    {
      "id": 1597755120,
      "name": "بنفذ طلبك",
      "type": "custom",
      "slug": "in_progress",
      "sort": 2,
      "message": "",
      "icon": "sicon-trash",
      "is_active": true,
      "parent": {},
      "original": {
        "id": 1939592358,
        "name": "قيد التنفيذ"
      }
    },
    {
      "id": 1638621685,
      "name": "تم التنفيذ",
      "type": "custom",
      "slug": "completed",
      "sort": 3,
      "message": "",
      "icon": "sicon-trash",
      "is_active": true,
      "parent": {},
      "original": {
        "id": 1298199463,
        "name": "تم التنفيذ"
      }
    },
    {
      "id": 1422535667,
      "name": "جاري التوصيل",
      "type": "custom",
      "slug": "delivering",
      "sort": 4,
      "message": "",
      "icon": "sicon-trash",
      "is_active": true,
      "parent": {
        "id": 1638621685,
        "name": "تم التنفيذ"
      },
      "original": {
        "id": 349994915,
        "name": "جاري التوصيل"
      }
    },
    {
      "id": 647449340,
      "name": "تم التوصيل",
      "type": "custom",
      "slug": "delivered",
      "sort": 5,
      "message": "",
      "icon": "sicon-trash",
      "is_active": true,
      "parent": {
        "id": 1638621685,
        "name": "تم التنفيذ"
      },
      "original": {
        "id": 1723506348,
        "name": "تم التوصيل"
      }
    },
    {
      "id": 1887201789,
      "name": "تم الشحن",
      "type": "custom",
      "slug": "shipped",
      "sort": 6,
      "message": "",
      "icon": "sicon-trash",
      "is_active": false,
      "parent": {
        "id": 1638621685,
        "name": "تم التنفيذ"
      },
      "original": {
        "id": 814202285,
        "name": "تم الشحن"
      }
    },
    {
      "id": 687926769,
      "name": "ملغي",
      "type": "custom",
      "slug": "canceled",
      "sort": 7,
      "message": "",
      "icon": "sicon-trash",
      "is_active": true,
      "parent": {},
      "original": {
        "id": 525144736,
        "name": "ملغي"
      }
    },
    {
      "id": 2062355698,
      "name": "مسترجع",
      "type": "custom",
      "slug": "restored",
      "sort": 8,
      "message": "",
      "icon": "sicon-trash",
      "is_active": true,
      "parent": {},
      "original": {
        "id": 989286562,
        "name": "مسترجع"
      }
    },
    {
      "id": 1113229566,
      "name": "قيد الإسترجاع",
      "type": "custom",
      "slug": "restoring",
      "sort": 9,
      "message": "",
      "icon": "sicon-trash",
      "is_active": true,
      "parent": {},
      "original": {
        "id": 1548352431,
        "name": "قيد الإسترجاع"
      }
    }
  ]
}

🟠401Unauthorized

Request

Request samples

Responses