Light Mode

Order Actions

POST/orders/actions

Last modified: 13 days ago

This endpoint allows you to perform bulk actions on the orders related to the store.

:::tip[Tip]
Find the actions that can be performed in the action_name variable's enum values.
:::

::: caution Important
Some order actions are not to be triggered on the same request. Otherwise, you will get an error response. Below are an example of some of the actions that cannot be run together at the same time:

create_shipping_policy
print_shipping_policy
:::

`orders.read_write` - Orders Read & Write

Request

Authorization: OAuth 2.0

Add the parameter

Authorization

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

Example

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c

operations

array [object {2}]

required

action_name

enum<string>

required

The actions to be conducted in bulk, which the value can only be from the enum list mentioned.

Allowed values:

create_shipping_policycreate_return_policyprint_shipping_policycancel_policyassign_usersexportassign_tagschange_statusprint_prepare_listprint_invoicesend_invoiceprint_invoice_summarysend_payment_linkextend_payment_dueresend_codessend_ratingmark_as_readrefunddelete

value

array [anyOf]

optional

Value can either be an object, an array of strings or array of integers. This variable is not required for some actions, such as print_prepare_list, but required in some other actions, such as change_status

filters

object

required

order_ids

array[integer]

optional

List of Order IDs. Fetch a list of orders from here

order_status

array[integer]

optional

List of Order Statuses. Fetch a list of orders statuses from here

{
  "operations": [
    {
      "action_name": "print_prepare_list"
    },
    {
      "action_name": "change_status",
      "value": {
        "status": 525144736,
        "send_status_sms": true,
        "return_police": true,
        "restore_items": true,
        "note": "one note",
        "branch_id": 21123
      }
    },
    {
      "action_name": "assign_users",
      "value": [
        461258256,
        1968921873
      ]
    },
    {
      "action_name": "assign_tags",
      "value": [
        "new tag",
        "tag 3"
      ]
    }
  ],
  "filters": {
    "order_ids": [
      1296837389,
      1936133132
    ],
    "order_status": [
      3,
      5
    ]
  }
}

Request samples

Responses

Success(200)

Error Validation(422)

HTTP Code: 200

Content Type : JSONapplication/json

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 (BulkActions) {4}]

optional

operation_id

string

required

A unique identifier assigned to a specific operation or task within a system.

action_name

enum<string>

required

Action Name

Allowed values:

create_shipping_policyprint_shipping_policyassign_usersexportassign_tagschange_statusprint_prepare_listdeleterefund

status

string

required

Action Performed Status

message

string

required

In the case of action failure, textual message will appear

{
  "status": 200,
  "success": true,
  "data": [
    {
      "operation_id": "9c248334-f4cb-491b-84d0-57c415347d34",
      "action_name": "print_prepare_list",
      "status": "in_progress"
    },
    {
      "operation_id": "9c248334-f4cb-491b-84d0-57c415347dd5",
      "action_name": "change_status",
      "status": "in_progress"
    },
    {
      "operation_id": "9c248336-0080-440f-a936-68ee195e4139",
      "action_name": "assign_users",
      "status": "success"
    },
    {
      "operation_id": "9c1ab67e-fd53-47da-a4d1-12cd69f7b656",
      "action_name": "assign_tags",
      "status": "failed",
      "message": "لم يتم العثور على التاقات "
    }
  ]
}

Last modified: 13 days ago