Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

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

id
integer<int32>
required

The id of the referenced Warehouse.

profile_id
integer<int32>
required

The id of the referenced LocationProfile.

Query Parameters

fields
enum<string>[]

Specify additional fields of the LocationProfile object to be included in the response.

Available options:
all,
name,
description,
status,
member_count,
match,
match_readable,
location_tags,
slot_types,
active_revision,
pending_revision,
used_by,
created_at,
updated_at
fields:location_tags
enum<string>[]

Specify fields of the directly referenced LocationTag objects to include under included.LocationTag. Add location_tags to the root fields parameter to return the relationship. type and id are always returned. Specify additional fields of the LocationTag object to be included in the response.

Available options:
basic,
all,
name,
description,
color,
sort_order,
is_deleted,
created_at,
updated_at
fields:slot_types
enum<string>[]

Specify fields of the directly referenced SlotType objects to include under included.SlotType. Add slot_types to the root fields parameter to return the relationship. type and id are always returned. Specify additional fields of the SlotType object to be included in the response.

Available options:
basic,
all,
name,
is_pickable,
sort_order,
patterns,
is_fixed_capacity,
slot_dimensions,
weight_capacity,
created_at,
updated_at

Response

A dictionary with a resource property that contains the requested LocationProfile object.

resource
LocationProfile · object

A LocationProfile is a warehouse-scoped, named set of locations defined by match clauses rather than by enumeration. Slotting Rules and Replenishment Policies target a profile instead of listing locations, so the same policy keeps working as the warehouse grows.

Membership is materialized asynchronously. Saving a definition creates an immutable revision and starts a build; the previously published revision keeps serving consumers until the replacement is ready. A profile without a ready active revision has no resolved member set and is never represented as an empty one — member_count is null rather than 0.

Example:
included
object

Direct Location Tags and Slot Types expanded through nested fields:* parameters.

Example:
meta
object

Warehouse-level membership repair freshness. This is the freshness of the authoritative resolved membership, distinct from the Replenishment quantity computation freshness.