API Reference (v1.5)

Complete reference for all Ultimate Custom Order Status API endpoints

Available Endpoints

GET/v1/orders

Retrieve a paginated list of orders with filtering, sorting, and search capabilities.

Read more
GET/v1/orders/:order_id

Retrieve detailed information about a specific order by its ID.

Read more
GET/v1/statuses

Retrieve a list of all custom order statuses configured in your system.

Read more
GET/v1/statuses/:status_id

Retrieve detailed information about a specific custom order status by its ID.

Read more
POST/v1/orders/:order_id/status

Update the custom status of a specific order. Automatically sends notifications based on status configuration.

Read more
POST/v1/orders/:order_id/notify

Forcibly send customer notifications (email, SMS, WhatsApp) for a specific order.

Read more
POST/v1/orders/status-bulk

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

Read more
POST/v1/orders/notify-bulk

Send notifications to customers for multiple orders in a single request.

Read more
GET/v1/workflows

Retrieve all configured workflows with their associated statuses and settings.

Read more
POST/v1/line-items/:lineItemId/status

Change the status of a single line item. Triggers notifications when configured on the target status.

Read more
POST/v1/line-items/status-bulk

Change the status of multiple line items to the same target status in a single batch. Maximum 100 line items per request.

Read more
POST/v1/line-items/clear-status

Remove the current status (and sub-status) from one or more line items. Maximum 100 line items per request.

Read more
POST/v1/orders/:order_id/workflow

Reassign an order to a different workflow. The move applies a starting status from the target workflow and carries the status change and the fulfilment it triggers.

Read more