Retrieve Location Type

Beta
GET/v1/operations/location-types/{id}

This endpoint is idempotent. Learn more

Returns a location type by ID or code.

Permissions requiredValues:locations:read
The role behind your API key or agent must grant every one of these permissions.
idstring

Location type ID or code, such as building or bin.

idstring

Location type ID.

objectstringenumValues:location_type

Resource type identifier.

codeobject

Location type code, identifying the level of the storage hierarchy this type represents.

  • building: a building-level location.
  • section: a section within a building.
  • aisle: an aisle within a section.
  • rack: a rack within an aisle.
  • shelf: a shelf within a rack.
  • bin: a bin within a shelf.
namestring

Display name of the location type.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last-updated timestamp.

Responses

200

Successful response for Retrieve Location Type