[lightMode]

Create Custom Order Status

POST/orders/statuses

[updatedIn] 2 months ago

This endpoint allows you to create a custom order status using the parameters available to be sent as body request.

`orders.read_write` - Orders Read & Write

Request

Authorization: OAuth 2.0

Add the parameter

Authorization

to [header]，whose value is to concatenate the Token after the Bearer.

[api.label.example]

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c

parent_id

integer

required

Order Status Parent ID. List of Order Statuses can be found here

Example:

863076598

name

string

required

Order Status Name.

Example:

تبقى 40 دقيقة على الدفع

message

string

required

Order Status Message.

Example:

أكمل الدفع الان

icon

string

optional

Order Status Icon.

Example:

sicon-cup-hot

sort

integer

optional

Order Status Sort.

Example:

is_active

boolean

optional

Whether or not the Order Status is active.

Default:

true

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

Request samples

[api.label.responses]

Success(200)

Error Validation(422)

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

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, determining the order in which they are displayed or sorted.

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

{
  "status": 200,
  "success": true,
  "data": {
    "id": 120960473,
    "name": "تبقى 40 دقيقة على الدفع",
    "type": "custom",
    "slug": "payment_pending",
    "message": "أكمل الدفع الان",
    "color": "#ffff",
    "icon": "sicon-cup-hot",
    "sort": 3,
    "is_active": true,
    "original": {
      "id": 1473353380,
      "name": "بإنتظار الدفع"
    },
    "parent": {
      "id": 863076598,
      "name": "في انتظارك تدفع"
    },
    "children": []
  }
}

[updatedIn] 2 months ago