List Kit Assembly Tasks

get

https://api.warehance.com/v1/kit-assembly-tasks

Required permission: read_kit_assembly_tasks

Returns a paginated list of kit assembly tasks for the organization. Supports filtering by client, warehouse, kit product, assigned user, status, and priority, as well as a completed-at date range and free-text search on the reference number and status.

All filter parameters are optional. When no filters are provided, all kit assembly tasks accessible to the API key are returned. Client-level API keys are automatically scoped to their client; organization-level API keys may optionally scope results to a single client they own via client_id.

This endpoint uses cursor-based pagination. Use the next_cursor value from a response in the cursor parameter of the next request to fetch the following page; has_next_page indicates whether more results remain. For performance, this endpoint does not return total or filtered result counts.

Example use cases:

Get all kit assembly tasks: GET /kit-assembly-tasks
Get tasks still needing assembly: GET /kit-assembly-tasks?statuses=unstaged,picking,staged
Get tasks for a client: GET /kit-assembly-tasks?client_id=123
Get tasks for a kit product: GET /kit-assembly-tasks?kit_product_id=456
Find a task by reference: GET /kit-assembly-tasks?search_value=REF-1001

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

client_id

integer

≥ 1

Only applicable for organizations. Filters items by the specified client_id, provided the client_id belongs to the organization. Note: API keys can belong to either client level or organization level.

warehouse_id

integer

≥ 1

Filter by warehouse ID. Only returns kit assembly tasks assigned to the specified warehouse.

kit_product_id

integer

≥ 1

Filter by kit product ID. Only returns kit assembly tasks whose kit product matches the specified product.

assigned_user_id

integer

≥ 1

Filter by the ID of the user the task is assigned to.

status

string

enum

Filter by a single task status. Cannot be combined with statuses.

Allowed:

statuses

string

Filter by multiple statuses at once, as a non-empty comma-separated list (e.g. unstaged,picking,staged). Each value must be one of unstaged, picking, staged, completed, or cancelled. Cannot be combined with status.

priority

integer

1 to 3

Filter by a single priority level (1 = Low, 2 = Medium, 3 = High). Cannot be combined with priorities.

priorities

string

Filter by multiple priority levels at once, as a non-empty comma-separated list of integers between 1 and 3 (e.g. 2,3). Cannot be combined with priority.

completed_at_start

date-time

Only return tasks completed at or after this timestamp (ISO 8601).

completed_at_end

date-time

Only return tasks completed at or before this timestamp (ISO 8601).

sort_by

string

enum

Specifies the field by which to sort the results:

created_at: Sort by when the kit assembly task was created.
updated_at: Sort by when the kit assembly task was last updated.

Allowed:

search_value

string

A value to search for within the items. The specific fields searched depend on the endpoint.

limit

integer

1 to 100

Defaults to 25

The maximum number of items to return in the response. Used for pagination. Must be between 1 and 100.

cursor

string

A cursor for pagination. Omit it for the first page, then pass the next_cursor value from the previous response to fetch the next page. Keep the same filters and sort on every page. See Pagination.

order_by

string

enum

Defaults to asc

Specifies the sort direction of the returned items:

asc: Ascending order. For dates, this means from oldest to newest. For numbers, this means from smallest to largest.
desc: Descending order. For dates, this means from newest to oldest. For numbers, this means from largest to smallest.

Allowed:

Responses

200A list of kit assembly tasks

400Bad Request — invalid parameter values