List Cycle Counts

get

https://api.warehance.com/v1/cycle-counts

Required permission: read_cycle_counts

Returns a paginated list of cycle counts for the organization. Supports filtering by warehouse, status, and cycle count type.

All filter parameters are optional. When no filters are provided, all cycle counts for the organization are returned. Filters can be combined freely.

Example use cases:

Get all cycle counts: GET /cycle-counts
Get cycle counts in a warehouse: GET /cycle-counts?warehouse_id=123
Get only in-progress cycle counts: GET /cycle-counts?status=in_progress
Get location-type cycle counts: GET /cycle-counts?cycle_count_type=locations

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

warehouse_id

integer

≥ 1

Filter by warehouse ID. Only returns cycle counts for the specified warehouse.

status

string

enum

Filter by cycle count status:

in_progress: Active cycle counts that are still being worked on.
completed: Cycle counts that have been completed.
cancelled: Cycle counts that have been cancelled.

Allowed:

cycle_count_type

string

enum

Filter by cycle count type:

locations: Location-based cycle counts where each item represents a location.
products: Product-based cycle counts.

Allowed:

sort_by

string

enum

Specifies the field by which to sort the results:

created_at: Sort by when the cycle count was created.
updated_at: Sort by when the cycle count was last updated.
name: Sort by the cycle count name.

Allowed:

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.

offset

integer

≥ 0

Defaults to 0

The number of items to skip before starting to return results. Used for offset-based pagination. Cannot be used together with the cursor parameter.

cursor

string

A cursor for pagination. Use the next_cursor value from a previous response to fetch the next page of results. This provides more efficient pagination than offset-based pagination, especially for large datasets. Cannot be used together with the offset parameter.

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 cycle counts

400Bad Request — invalid parameter values