Skip to main content
POST
Mass update orders

Authorizations

Authorization
string
header
required

Generate a JWT access token through a Custom Global Integration and provide it with each request in the Authorization header prefixed with "Bearer" and then a single space.

Body

application/json
orders
object
required

An object containing the orders to be updated.

actions
object
required

An object containing all of the actions to be taken on the specified Order ids.

onError
enum<string>
default:continue

The value determining how errors are to be handled.

  • continue The current entity will be rolled back and any remaining entities will continue to be processed.
  • stop The current entity will be rolled back and the request will stop processing any remaining entities.
  • abort The entire request will be rolled back.
Available options:
continue,
stop,
abort
selected_ids
(integer<int32> | string)[]

Dynamic-grid selection payload alternative to orders.ids.

Required array length: 1 - 10000 elements
Required range: x >= 1
action
string

Massaction id from the admin grid definition (mass_actions[].id in the grid data response). The server normalizes Magento item ids (for example hold_order) to the appropriate API action. Do not maintain a separate static list; add or change mass actions on the grid block only.

Minimum string length: 1
additional
object

Dynamic-grid action payload object.

Response

An object with orders mass update results.

loaded
integer
required

The number of entities that were successfully loaded.

Required range: x >= 0
committed
integer
required

The number of entities that were successfully updated.

Required range: x >= 0
failed
integer
required

The number of entities that failed to be updated.

Required range: x >= 0
not-found
integer
required

The number of entities that were not found.

Required range: x >= 0
results
OrderUpdateResult · object[]
required

The list of update results for the requested Order objects.

Minimum array length: 1
meta
object
required