List active hold reasons
Returns the active hold-reason tree as a flat list of parent (system) reasons; each parent
inlines its user-defined child reasons via the children array. Schema enforces a single
nesting level — child reasons never carry a children key.
Cross-merchant by design (no website scoping). System reasons are always returned; user-defined reasons are returned regardless of which merchant created them.
See the Inventory Hold System documentation for hold semantics.
Authorizations
Query Parameters
Specify additional fields of the parent HoldReason object to be included in the response. See the selecting fields page for more information.
Specify additional fields of the HoldReason object to be included in the response.
basic, all, code, label, parent_code, allow_relocation, sort_order, is_active, is_system, children, parent, merchants Using the filtering syntax, you may filter the results using the following fields:
id— reason_idcode
Default sort is ascending by id. Using the sorting syntax,
the following fields are available for sorting:
idcodesort_order
If specified as 1, the meta.count property of the response will be present and populated with the total count of items
matching the query before any paging is applied. This is not included by default to improve performance in some edge
cases and is not required to perform paging using the next property of the response.
See paging parameters for more information.
0 <= x <= 1A cursor for use in pagination which defines the end of the next page of results, non-inclusive.
For collections sorted by id this is the last id. For other sort orders use the
opaque cursor provided by the previous link and meta.cursor_end of the previous page;
a plain record id is also accepted and resolves to that record's position in the sort order.
See paging parameters for more information on paging.
A cursor for use in pagination which defines the start of the next page of results.
For collections sorted by id this is the starting id. For other sort orders use the
opaque cursor provided by the next link and meta.cursor_start of the previous page;
a plain record id is also accepted and resolves to that record's position in the sort order.
See paging parameters for more information on paging.
Response
A dictionary with a collection property containing an array of HoldReason objects (parents only;
each parent's children array carries any user-defined sub-reasons). If no active reasons exist
the array will be empty.