API Reference (v1.4)
Complete reference for all Ultimate Custom Order Status API endpoints
Available Endpoints
/v1/ordersRetrieve a paginated list of orders with filtering, sorting, and search capabilities.
/v1/orders/:order_idRetrieve detailed information about a specific order by its ID.
/v1/statusesRetrieve a list of all custom order statuses configured in your system.
/v1/statuses/:status_idRetrieve detailed information about a specific custom order status by its ID.
/v1/orders/:order_id/statusUpdate the custom status of a specific order. Automatically sends notifications based on status configuration.
/v1/orders/:order_id/notifyForcibly send customer notifications (email, SMS, WhatsApp) for a specific order.
/v1/orders/status-bulkUpdate the custom status for multiple orders in a single request.
/v1/orders/notify-bulkSend notifications to customers for multiple orders in a single request.
/v1/workflowsRetrieve all configured workflows with their associated statuses and settings.
/v1/line-items/:lineItemId/statusChange the status of a single line item. Triggers notifications when configured on the target status.
/v1/line-items/status-bulkChange the status of multiple line items to the same target status in a single batch. Maximum 100 line items per request.
/v1/line-items/clear-statusRemove the current status (and sub-status) from one or more line items. Maximum 100 line items per request.