Update Custom Order Status - Salla Merchants APIs

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

Note

Use available parameters to send as a body request.

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.

Scopes

orders.read_write - Orders Read & Write

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

Body Params application/json

name

string

optional

Order Status Name. List of Order Statuses can be found here. 🌐 [Support multi-language](🌐Support multi-language)

Example:

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

message

string

optional

Order Status Message. 🌐 [Support multi-language](🌐Support multi-language)

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

Example

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

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

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

Example

{
  "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": {},
    "children": []
  }
}

🟠422Error Validation

🟠404Not Found

🟠401Unauthorized