Update Bulk Orders Status

Request

This API is used to Updates the status of multiple orders in a single request such as UNFULFILLED, ONHOLD, FULFILLED, or CANCELED, based on business or fulfillment actions. Use this API to apply the same status change to more than one order at once.

Security

bearerAuth

Bodyapplication/jsonrequired

ordersArray of objects, non-emptyrequired

List of orders whose status needs to be updated.

reasonstring

Reason for performing the bulk status update.

Example:"bulk status update"

statusstringrequired

New status to be applied to the specified orders.

Enum:"UNFULFILLED""FULFILLED""ONHOLD""CANCELED"

Example:"ONHOLD"

curl -i -X PATCH \
  https://api-sandbox.sendpro360.pitneybowes.com/ordermanagement/api/v1/orders/bulk/status \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "orders": [
      {
        "orderId": "PBqTYEhO31JY"
      }
    ],
    "reason": "bulk status update",
    "status": "ONHOLD"
  }'

Responses

Order status updated successfully.

Bodyapplication/json

statusstring

Current status of the order after update.

Example:"ONHOLD"

messagestring

Confirmation message describing the outcome.

Example:"Order status updated successfully."

transactionDateTimestring, (date-time)

Timestamp when the transaction took place in ISO 8601 format.

Example:"2025-07-01T09:59:16.617Z"

Response

{
  "status": "ONHOLD",
  "message": "Order status updated successfully.",
  "transactionDateTime": "2025-07-01T09:59:16.617Z"
}