Order Actions
POST {{baseUrl}}/orders/actions
This endpoint allows you to perform bulk actions on the orders related to the store. 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 Body
{"operations"=>[{"action_name"=>"resend_codes", "value"=>["<string>", "<string>"]}, {"action_name"=>"create_shipping_policy", "value"=>["<string>", "<string>"]}], "filters"=>{"order_ids"=>["<integer>", "<integer>"], "order_status"=>["<integer>", "<integer>"]}}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | string | ||
Accept | string |
RESPONSES
status: OK
{"status":"\u003cinteger\u003e","success":"\u003cboolean\u003e","data":[{"status":"\u003cstring\u003e","message":"\u003cstring\u003e","action_name":"export","operation_id":"\u003cstring\u003e"},{"status":"\u003cstring\u003e","message":"\u003cstring\u003e","action_name":"delete","operation_id":"\u003cstring\u003e"}]}