POST

Bulk Update Status

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

Endpoint

HTTP Request

POST /v1/orders/status-bulk

Authentication

This endpoint requires a valid API key with canChangeOrderStatus permission. The API key must be passed in the X-API-Key header.

Required Header

X-API-Key: your_api_key_here

Request Body

Parameter	Type	Required	Default	Description
`order_ids`	string[]	Yes	-	Array of order identifiers (UUIDs by default, or Shopify order IDs if use_shopify_order_id is true). For Shopify order IDs, provide the numeric portion of Shopify's order GID (e.g., for 'gid://shopify/Order/450789469', use '450789469').
`status_id`	string	Yes	-	The UUID of the custom status
`sub_status_option_id`	string	Conditional	-	The UUID of the sub-status option. Required if the status has sub-status options.
`use_shopify_order_id`	boolean	No	false	Set to 'true' to look up orders using Shopify order IDs instead of UUIDs. Extract the number from Shopify's GID format (gid://shopify/Order/450789469 → 450789469) and use it in the order_ids array.

Response

Returns confirmation with count of updated orders:

200 OK - Success Response

{
  "message": "Statuses updated successfully",
  "updated_count": 3,
  "notifications": {
    "total_sent": 6,
    "total_failed": 0,
    "by_channel": {
      "email": {
        "sent": 3,
        "failed": 0
      },
      "sms": {
        "sent": 3,
        "failed": 0
      }
    }
  }
}

Response Fields

Root Response Object

Field	Type	Description
`message`	string	Confirmation message
`updated_count`	number	Number of orders successfully updated
`notifications`	object	Object containing notification statistics

Notifications Object Fields

Field	Type	Description
`total_sent`	number	Total number of notifications sent successfully across all orders
`total_failed`	number	Total number of notifications that failed across all orders
`by_channel`	object	Object with per-channel stats (e.g., email, sms)

common.responseTables.channelStatsObject

Field	Type	Description
`sent`	number	Number of notifications sent successfully for this channel
`failed`	number	Number of notifications that failed for this channel

Examples

Basic Request (UUIDs)

cURL Request

curl -X POST "https://api.ultimate-custom-order-status.apps.msmtech.ca/api/v1/orders/status-bulk" \
  -H "X-API-Key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "order_ids": ["uuid1", "uuid2", "uuid3"],
    "status_id": "status-uuid",
    "sub_status_option_id": "sub-status-option-uuid"
  }'

Using Shopify Order IDs

cURL Request

curl -X POST "https://api.ultimate-custom-order-status.apps.msmtech.ca/api/v1/orders/status-bulk" \
  -H "X-API-Key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "order_ids": ["5460132438316", "5460132438317", "5460132438318"],
    "use_shopify_order_id": true,
    "status_id": "status-uuid",
    "sub_status_option_id": "sub-status-option-uuid"
  }'

Rate Limiting

This endpoint is subject to per-minute and per-day rate limits based on your API key. Rate limit information is returned in the response headers:

X-RateLimit-Limit-Minute: Maximum requests per minute
X-RateLimit-Remaining-Minute: Remaining requests in current minute
X-RateLimit-Reset-Minute: Unix timestamp when minute window resets
X-RateLimit-Limit-Day: Maximum requests per day
X-RateLimit-Remaining-Day: Remaining requests in current day
X-RateLimit-Reset-Day: Unix timestamp when day window resets
Retry-After: Seconds to wait before retrying (when rate limited)

Error Responses

400 Bad Request

Invalid request body, validation failed, or status requires a sub-status

400 Bad Request

{
  "error": "Validation failed",
  "details": {
    "errors": [...]
  }
}

401 Unauthorized

Missing or invalid API key

401 Unauthorized

{
  "error": "Unauthorized"
}

403 Forbidden

API key lacks required permissions

403 Forbidden

{
  "error": "Insufficient permissions"
}

404 Not Found

No valid orders found, or status/sub-status not found

404 Not Found

{
  "error": "No valid orders found"
}

500 Internal Server Error

Server error occurred

500 Internal Server Error

{
  "error": "Internal server error",
  "details": {
    "message": "Error description"
  }
}