Update Order Status

Production

POST

https://api.salla.dev/admin/v2/orders/{order_id}/status

Order Status

Last modified:2025-02-02 12:23:10

This endpoint allows you to update the status of a specific order by passing the order_id as a path parameter.

Note

To update an order status, you may use one of the following:

slug: to update an order with predefined Salla statuses.

status_id: to update the Custom Order Sub-status.

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

order_id

integer

required

Unique identification number assigend to an order. Get a list of Order IDs from here.

Body Params application/json

status_id

number

optional

A unique identifier associated with a specific order status.

Example:

1360188634

slug

string

optional

A user-friendly and URL-friendly text string associated with a specific order status.

Example:

restoring

note

string

optional

A written comment or message submitted to request information or updates regarding the status of the order.

Example:

Your request has been received

Example

{
  "slug": "restoring"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.salla.dev/admin/v2/orders//status' \
--header 'Content-Type: application/json' \
--data-raw '{
    "slug": "restoring"
}'

Responses

🟢201Success

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

optional

message

string

optional

A text or data communication generated by a system or application in response to a request.

code

number

optional

A numerical or alphanumeric identifier used in various systems and protocols to indicate the status or outcome of a specific request.

Example

{
  "status": 201,
  "success": true,
  "data": {
    "message": "The entity has been updated successfully",
    "code": 201
  }
}

🟠404Not Found

🟠422Error Validation

🟠401Unauthorized

Modified at 2025-02-02 12:23:10

Order Status

Create Custom Order Status