List Custom Holds

get

https://api.warehance.com/v1/custom-holds

Required permission: read_orders

Returns the custom-hold definitions that can be assigned to orders by ID. Client API keys receive organization-wide holds plus holds belonging to their client. Organization API keys receive all definitions and can optionally use client_id to return organization-wide holds plus holds for one client.

This endpoint uses cursor pagination. Pass next_cursor as cursor on the next request. Custom holds must be enabled for the organization.

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.

search_value

string

length ≥ 1

Case-insensitive partial match against the custom-hold name.

sort_by

string

enum

Defaults to id

Allowed:

order_by

string

enum

Defaults to asc

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.

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.

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200A page of custom-hold definitions.

400Invalid query parameter.

403Missing permission or the custom-holds feature is not enabled.