HYhypertrack
Orders

Update Order Task

Updates the details of a specific task associated with an order. This endpoint is used to modify the status and details of a task by its ID.

patch/orders/{order_handle}/tasks/{task_id}

Request

Path parameters

order_handlestring required
task_idstring required

Query parameters

fulfillment_attemptinteger nullable

The attempt number for order fulfillment.

Request body

labelstring nullable

Label of task to be updated.

status'ongoing' | 'completed' | 'cancelled' | 'null' nullable

Status of task to be updated. Valid values are ongoing, completed, cancelled.

descriptionstring nullable

Description of task to be updated. This will not update existing description.

priority'none' | 'low' | 'medium' | 'high' | 'null' nullable

Priority of task to be updated. Valid values are none, low, medium, high.

metadataobject nullable

Metadata to be updated for the task.

Response

Successful response

labelstring required

Type of task to be created for the order.

task_definition_idstring nullable

Id of the tasks definition from which this task is picked

descriptionstring nullable

Description of the task type.

metadataobject nullable

Additional metadata for the task.

priority'none' | 'low' | 'medium' | 'high' | 'null' nullable

Priority of the task. Valid values are none, low, medium, high.

task_idstring required

Unique identifier for the created task.

statusstring nullable

Status of the task. Valid values are pending, ongoing, completed, cancelled.

created_atstring required

Timestamp when the task was created.

updated_atstring nullable

Timestamp when the task was last updated.

Changes

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