Skip to main content
POST
Complete filtered tasks

Request Structure

Key Fields

Minimum Attributes per Task Type

The attributes block needs to carry the fields each task type requires in order to complete. The minimum payload per type mirrors the single-task completion path: DISP and LOAD tasks are not usually completed via this endpoint. Use the shipment dispatch flow for DISP and POST /api/load_tasks/{id}/load_storage_unit for LOAD.

Behavior

  • Matches tasks by warehouse_id, task_type_code, and the supplied filters (AND-combined).
  • Up to 50 matching tasks are completed per request.
  • Returns 204 No Content on success.
  • Returns 422 if no filters are supplied, if no tasks match, or if a matched task fails its per-type validations (e.g. missing confirmed_quantity on a PICK).

Authorizations

Authorization
string
header
required

OAuth 2.0 authentication. Use the client credentials or authorization code flow to obtain an access token.

X-Clarus-Subdomain
string
header
required

The subdomain/tenant name identifying which tenant's data to access. Required for all API requests.

Body

application/json
warehouse_id
integer
required

Warehouse ID to scope the tasks

task_type_code
enum<string>
required

Task type code

Available options:
PICK,
DISP,
RCV,
PWAY,
TRAN,
REPLEN,
LOAD,
CONV
filters
object
required

At least one filter must be specified. Maximum 50 tasks will be completed per request.

attributes
object | null

Optional attributes to set on each task before completion. Accepts the same fields as the task update endpoint.

Response

Operation completed successfully with no content to return