Sign in
Order Controller

Update multiple orders status

Update the same status for multiple orders in a single request.

patch/orders/bulk-status-update

Request body

orderIdsnumber[] required

List of order IDs to update

orderStatusIdnumber required

Target order status ID

Example request

{
  "orderIds": [
    101,
    102,
    103
  ],
  "orderStatusId": 3
}

Response

Multiple order statuses updated successfully

targetStatusIdnumber required

Requested order status ID

targetStatusNamestring required

Requested order status name

requestedCountnumber required

Total valid unique order IDs received in request

updatedCountnumber required

Number of orders updated

skippedCountnumber required

Number of orders skipped because status was already same

updatedOrderIdsnumber[] required

IDs of orders that were updated

Example response

{
  "targetStatusId": 3,
  "targetStatusName": "Dispatched",
  "requestedCount": 3,
  "updatedCount": 2,
  "skippedCount": 1,
  "updatedOrderIds": [
    21,
    23
  ],
  "skippedOrders": [
    {
      "id": 22,
      "reason": "Already in selected status"
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.