List Location Profile member Locations
Returns full Location objects from the resolved membership of one LocationProfile.
The response supports the same field selection, filtering, sorting, and cursor paging as
the Warehouse Locations endpoint. Membership is read from the ready active revision, and
meta.profile_revision_id identifies the exact revision that supplied the page.
A profile without a ready active revision has no resolved member set and responds with
422 instead of an empty collection; a ready profile with zero members is a genuine
empty set and responds with an empty collection. Cursor continuation is available only
when sorting by id; other sorts return the bounded page without cursor links.
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.
Path Parameters
The id of the referenced Warehouse.
The id of the referenced LocationProfile.
Query Parameters
Specify additional fields of the Location object to be included in the response.
basic, all, label, priority, qty_on_hand, qty_putaway, qty_unreserved, qty_reserved, qty_locked, is_temp, is_pickable, is_type_auto, created_at, updated_at, last_cyclecount_at, tags, lot, product, rack, slot_type Specify additional fields of the Lot object to be included in the response.
basic, all, id, lot_number, origination_date, expiration_date, is_expired, is_active, lot_number_input, expiration_input, sort_value, days_until_expiration, sort_direction, group_value, created_at, updated_at, created_by, lot_type, product Specify additional fields of the LotType object (via Lot) to be included in the response. See the selecting fields page for more information.
Specify additional fields of the LotType object to be included in the response.
basic, all, allow_mixing_locations, allow_mixing_fulfillment, lot_number_example, lot_number_replacement, expiration_date_pattern, expiration_date_delta, created_at, updated_at Specify additional fields of the Product object (via Lot) to be included in the response. See the selecting fields page for more information.
Specify additional fields of the Product or Packaging* object to be included in the response.
basic, all, created_at, updated_at, container_options, supplies_options, data_collection_options, instruction_options, infill_options, vendor_sku, manufacturer_part_number, external_id, barcodes, goods_type, is_available, is_visible, weight, dimensions, volume, inventory, export, regulated_goods, packaging, custom_fields Specify additional fields of the Product or Packaging* object to be included in the response.
basic, all, created_at, updated_at, container_options, supplies_options, data_collection_options, instruction_options, infill_options, vendor_sku, manufacturer_part_number, external_id, barcodes, goods_type, is_available, is_visible, weight, dimensions, volume, inventory, export, regulated_goods, packaging, custom_fields Specify additional fields of the Merchant object to be included in the response. See the selecting fields page for more information.
basic, all, code, name, status, created_at, updated_at, brands, default_brand, custom_fields Specify additional fields of the Rack object to be included in the response.
all, id, name, rack_type, location_pattern, warehouse Specify additional fields of the RackType object (via Rack) to be included in the response. See the selecting fields page for more information.
Specify additional fields of the RackType object to be included in the response.
basic, all, id, name, notes Specify additional fields of the Warehouse object (via Rack) to be included in the response. 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 additional fields of the SlotType object to be included in the response.
basic, all, name, is_pickable, sort_order, patterns, is_fixed_capacity, slot_dimensions, weight_capacity, created_at, updated_at Using the filtering syntax, you may filter the results using the following fields:
idlabelcreated_atupdated_atqty_putawayqty_unreservedqty_reserved
The default sort order is descending by primary key (sort=-id).
The following fields are available for sorting:
idlabel
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.
The number of member Location objects to return. The default is 50 and the maximum is 250.
1 <= x <= 25050
Response
A dictionary with a collection property that contains a list of up to
limit member Location objects matching the query.
A list of resolved member Location objects.
Lists of referenced objects included by specifying optional fields. See the selecting fields page for more information.
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.