[lightMode]

Sort Orders Statuses

POST/orders/statuses/sort

[updatedIn] 2 months ago

This endpoint allows you to sort the orders statuses on the Merchant dashboard.

`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

array of:

status_id

integer

required

Order Status ID, list of Status ID's can be found here

sort

integer

required

The sorting position on the Merchant dashboard.

[
  {
    "status_id": 12345,
    "sort": 2
  },
  {
    "status_id": 654321,
    "sort": 1
  },
  {
    "status_id": 98765,
    "sort": 4
  }
]

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

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.

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

[updatedIn] 2 months ago