Light Mode

Order Actions

POST/orders/actions

Last modified: 16 hours 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

No schema defined

{
  "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

No schema defined

{
  "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: 16 hours ago