Update or complete a task
curl --request PATCH \
--url https://clarus-api.com/api/tasks/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Clarus-Subdomain: <api-key>' \
--data '
{
"data": {
"type": "tasks",
"attributes": {
"priority": 10,
"notes": "Urgent - customer waiting",
"location_to_id": 25,
"confirmed_quantity": 8
}
}
}
'import requests
url = "https://clarus-api.com/api/tasks/{id}"
payload = { "data": {
"type": "tasks",
"attributes": {
"priority": 10,
"notes": "Urgent - customer waiting",
"location_to_id": 25,
"confirmed_quantity": 8
}
} }
headers = {
"Authorization": "Bearer <token>",
"X-Clarus-Subdomain": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
Authorization: 'Bearer <token>',
'X-Clarus-Subdomain': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
data: {
type: 'tasks',
attributes: {
priority: 10,
notes: 'Urgent - customer waiting',
location_to_id: 25,
confirmed_quantity: 8
}
}
})
};
fetch('https://clarus-api.com/api/tasks/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"data": {
"id": "1",
"type": "tasks",
"attributes": {
"status": "AVAILABLE",
"subtype": "standard",
"priority": 10,
"notes": "Urgent - customer waiting",
"start_quantity": 10,
"confirmed_quantity": 8,
"stock_description": "Widget A",
"created_at": "2026-03-10T08:00:00Z",
"completed_at": null,
"last_accessed_at": "2026-03-12T09:30:00Z",
"start_at": null,
"boolean1": null,
"boolean2": null,
"boolean3": null,
"boolean4": null,
"boolean5": null,
"datetime1": null,
"datetime2": null,
"datetime3": null,
"datetime4": null,
"datetime5": null,
"integer1": null,
"integer2": null,
"integer3": null,
"integer4": null,
"integer5": null,
"string1": null,
"string2": null,
"string3": null,
"string4": null,
"string5": null
},
"relationships": {
"account": {
"data": {
"id": "1",
"type": "accounts"
}
},
"warehouse": {
"data": {
"id": "1",
"type": "warehouses"
}
},
"product": {
"data": {
"id": "42",
"type": "products"
}
},
"location_from": {
"data": {
"id": "10",
"type": "locations"
}
},
"location_to": {
"data": {
"id": "25",
"type": "locations"
}
},
"task_type": {
"data": {
"id": "1",
"type": "task_types"
}
},
"goods_out": {
"data": {
"id": "100",
"type": "goods_outs"
}
},
"goods_out_line": {
"data": null
},
"goods_out_pick_list": {
"data": null
},
"inbound_good": {
"data": null
},
"inbound_item": {
"data": null
},
"last_accessed_by_user": {
"data": null
},
"stock": {
"data": null
},
"storage_unit_from": {
"data": null
},
"storage_unit_to": {
"data": null
},
"user_completed_by": {
"data": null
},
"user_created_by": {
"data": {
"id": "5",
"type": "users"
}
}
}
}
}{
"error": "<string>"
}{
"errors": [
{
"code": 123,
"symbol": "<string>",
"details": "<string>",
"source": "<string>",
"context": {}
}
]
}{
"errors": [
{
"code": 123,
"symbol": "<string>",
"details": "<string>",
"source": "<string>",
"context": {}
}
]
}Tasks
Update or complete a task
Update attributes of an existing task, or complete it. Tasks are created automatically by warehouse operations and this endpoint allows modifying task properties such as priority, notes, locations, quantities, and custom fields. To complete a single task, send status: "completed" together with the attributes required by that task’s type. To complete multiple tasks of the same type in one call use POST /api/tasks/complete_collection. Type-specific receive and load actions are documented under the Goods In: Receipts and Loads tags respectively.
PATCH
/
api
/
tasks
/
{id}
Update or complete a task
curl --request PATCH \
--url https://clarus-api.com/api/tasks/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Clarus-Subdomain: <api-key>' \
--data '
{
"data": {
"type": "tasks",
"attributes": {
"priority": 10,
"notes": "Urgent - customer waiting",
"location_to_id": 25,
"confirmed_quantity": 8
}
}
}
'import requests
url = "https://clarus-api.com/api/tasks/{id}"
payload = { "data": {
"type": "tasks",
"attributes": {
"priority": 10,
"notes": "Urgent - customer waiting",
"location_to_id": 25,
"confirmed_quantity": 8
}
} }
headers = {
"Authorization": "Bearer <token>",
"X-Clarus-Subdomain": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
Authorization: 'Bearer <token>',
'X-Clarus-Subdomain': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
data: {
type: 'tasks',
attributes: {
priority: 10,
notes: 'Urgent - customer waiting',
location_to_id: 25,
confirmed_quantity: 8
}
}
})
};
fetch('https://clarus-api.com/api/tasks/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"data": {
"id": "1",
"type": "tasks",
"attributes": {
"status": "AVAILABLE",
"subtype": "standard",
"priority": 10,
"notes": "Urgent - customer waiting",
"start_quantity": 10,
"confirmed_quantity": 8,
"stock_description": "Widget A",
"created_at": "2026-03-10T08:00:00Z",
"completed_at": null,
"last_accessed_at": "2026-03-12T09:30:00Z",
"start_at": null,
"boolean1": null,
"boolean2": null,
"boolean3": null,
"boolean4": null,
"boolean5": null,
"datetime1": null,
"datetime2": null,
"datetime3": null,
"datetime4": null,
"datetime5": null,
"integer1": null,
"integer2": null,
"integer3": null,
"integer4": null,
"integer5": null,
"string1": null,
"string2": null,
"string3": null,
"string4": null,
"string5": null
},
"relationships": {
"account": {
"data": {
"id": "1",
"type": "accounts"
}
},
"warehouse": {
"data": {
"id": "1",
"type": "warehouses"
}
},
"product": {
"data": {
"id": "42",
"type": "products"
}
},
"location_from": {
"data": {
"id": "10",
"type": "locations"
}
},
"location_to": {
"data": {
"id": "25",
"type": "locations"
}
},
"task_type": {
"data": {
"id": "1",
"type": "task_types"
}
},
"goods_out": {
"data": {
"id": "100",
"type": "goods_outs"
}
},
"goods_out_line": {
"data": null
},
"goods_out_pick_list": {
"data": null
},
"inbound_good": {
"data": null
},
"inbound_item": {
"data": null
},
"last_accessed_by_user": {
"data": null
},
"stock": {
"data": null
},
"storage_unit_from": {
"data": null
},
"storage_unit_to": {
"data": null
},
"user_completed_by": {
"data": null
},
"user_created_by": {
"data": {
"id": "5",
"type": "users"
}
}
}
}
}{
"error": "<string>"
}{
"errors": [
{
"code": 123,
"symbol": "<string>",
"details": "<string>",
"source": "<string>",
"context": {}
}
]
}{
"errors": [
{
"code": 123,
"symbol": "<string>",
"details": "<string>",
"source": "<string>",
"context": {}
}
]
}Request Structure
{
"data": {
"type": "tasks",
"attributes": {
"priority": 10,
"notes": "Urgent - customer waiting",
"location_to_id": 25,
"confirmed_quantity": 8.0
}
}
}
Completing a Task
A single task is completed through this endpoint by settingstatus to "completed" together with the attributes required for the task’s type. The table below lists the minimum payload to complete each type; additional fields may be set in the same request when they need updating at the same time.
| Task type | Minimum attributes to complete |
|---|---|
PICK | status, confirmed_quantity, location_to_id (drop location) |
RCV | status, confirmed_quantity, location_to_id, storage_unit_to_id |
PWAY | status, confirmed_quantity, location_to_id, storage_unit_to_id |
TRAN | status, location_to_id, storage_unit_to_id |
CONV | status (optionally confirmed_quantity; defaults to the task’s start_quantity) |
REPLEN | status, confirmed_quantity, location_to_id |
DISP | status for SHIPMENT subtype only. LOAD-subtype DISP tasks must be completed by dispatching the load, not via this endpoint. |
LOAD | Not completable via this endpoint. Use POST /api/load_tasks/{id}/load_storage_unit. |
POST /api/tasks/complete_collection with a task_type_code and a filters block.
Key Fields
| Field | Required | Description |
|---|---|---|
account_id | No | Stock account ID |
warehouse_id | No | Warehouse ID |
priority | No | Task priority (higher = more urgent) |
notes | No | Free-text notes |
status | No | Task status. Set to completed to complete the task (see Completing a Task above). |
location_from_id | No | Source location ID |
location_to_id | No | Destination location ID |
product_id | No | Product ID |
start_quantity | No | Starting quantity (>= 0) |
confirmed_quantity | No | Confirmed/completed quantity (>= 0) |
start_at | No | Planned start datetime |
end_at | No | Planned end datetime |
completed_at | No | Completion datetime |
assigned_at | No | Assignment datetime |
user_id | No | Assigned user ID |
user_created_by_id | No | User who created the task |
user_completed_by_id | No | User who completed the task |
device_type_id | No | Device type ID |
device_id | No | Device ID |
storage_unit_from_id | No | Source storage unit ID |
storage_unit_to_id | No | Destination storage unit ID |
stock_id | No | Associated stock record ID |
load_id | No | Associated load ID |
load_drop_id | No | Associated load drop ID |
dispatch_container_id | No | Associated dispatch container ID |
parent_task_id | No | Parent task ID for subtasks |
transaction_number_id | No | Transaction number ID |
transaction_line_id | No | Transaction line ID |
stock_description | No | Stock description text |
drop_sequence | No | Drop sequence (1-9999999999) |
serial_numbers | No | Array of serial number strings |
string1-string5 | No | Custom string fields |
integer1-integer5 | No | Custom integer fields |
datetime1-datetime5 | No | Custom datetime fields |
boolean1-boolean5 | No | Custom boolean fields |
Authorizations
OAuth 2.0 authentication. Use the client credentials or authorization code flow to obtain an access token.
The subdomain/tenant name identifying which tenant's data to access. Required for all API requests.
Path Parameters
The unique identifier of the task to update
Body
application/json
Show child attributes
Show child attributes
Response
Task updated successfully
Task response in JSON:API format
Show child attributes
Show child attributes
⌘I