List Handling Classes
Returns Handling Classes and their current asynchronous classification state. Request
fields=conditions,conditions_readable when a client needs the canonical condition
definition for editing.
Authorizations
Generate a JWT access token through a Custom Global Integration and provide it with each request in the Authorization header prefixed with "Bearer" and then a single space.
Query Parameters
Select fields of the HandlingClass object. See the
selecting fields page for more information.
Specify fields of the HandlingClass object to include in the response.
all, name, code, sort_order, warehouses, conditions, referenced_product_profiles, conditions_readable, matched_count, classification, created_at, updated_at Specify fields of the referenced Warehouse objects to include under included.Warehouse. type and id are always returned. See the selecting fields page for more information.
Specify additional fields of the Warehouse object to be included in the response.
basic, all, id, name, is_active, abbreviation Specify fields of the referenced ProductProfile objects to include under included.ProductProfile. type and id are always returned. See the selecting fields page for more information.
Specify fields of an included ProductProfile object.
basic, all, name, code, conditions, conditions_readable, matched_count, classification, created_at, updated_at Using the filtering syntax, you may filter the results using:
idcodenamewarehouse_idsort_order
warehouse_id supports eq, in, neq, and nin. Negative filters exclude a Handling
Class if it is assigned to any of the specified Warehouses.
The default sort is ascending by id. Available fields are:
id
Cursor paging supports only id or -id sorting.
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 last id of the next page of results, non-inclusive.
See paging parameters for more information on paging.
A cursor for use in pagination which defines the starting id of the next page of results.
See paging parameters for more information on paging.
Maximum number of Handling Classes to return.
1 <= x <= 250Response
A cursor-paginated collection of Handling Classes.
Related Warehouses and Product Profiles requested through nested fields:* parameters.
True if the collection has more items on the next page. Use the "next" link to retrieve the next page of results.
The resource path for the next page of results if any are expected.
The resource path for the previous page of results if any are expected.
Additional metadata pertaining to the response.