Retrieve Location

Beta
GET/v1/operations/locations/{id}

This endpoint is idempotent. Learn more

Returns a location by ID.

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

Location ID.

include[]optional arrayenumValues:parentchildren

Sub-objects to expand in the response. When omitted, sub-objects are returned as null.

idstring

Location ID.

objectstringenumValues:location

Resource type identifier.

namestring

Display name of the location.

typeobject

This location's level in the storage hierarchy.

The levels run from largest to smallest: building, section, aisle, rack, shelf, bin. They are descriptive labels rather than a rule — a location's parent is not required to be the next level up.

parentlocationExpandablenullable

The location directly above this one in the storage hierarchy.

Absent for top-level locations.

idstring

Location ID.

objectstringenumValues:location

Resource type identifier.

namestring

Display name of the location.

typeobject

This location's level in the storage hierarchy.

The levels run from largest to smallest: building, section, aisle, rack, shelf, bin. They are descriptive labels rather than a rule — a location's parent is not required to be the next level up.

Always returned as null in this endpoint.
parentlocationExpandablenullable

The location directly above this one in the storage hierarchy.

Absent for top-level locations.

Always returned as null in this endpoint.
childrenlistExpandablenullable

The locations directly below this one in the storage hierarchy.

Always returned as null in this endpoint.
created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last-updated timestamp.

childrenlistExpandablenullable

The locations directly below this one in the storage hierarchy.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

Relative URL that fetches the next page of results.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of location

Resources in this page.

idstring

Location ID.

objectstringenumValues:location

Resource type identifier.

namestring

Display name of the location.

typeobject

This location's level in the storage hierarchy.

The levels run from largest to smallest: building, section, aisle, rack, shelf, bin. They are descriptive labels rather than a rule — a location's parent is not required to be the next level up.

Always returned as null in this endpoint.
parentlocationnullable

The location directly above this one in the storage hierarchy.

Absent for top-level locations.

Always returned as null in this endpoint.
childrenlistnullable

The locations directly below this one in the storage hierarchy.

Always returned as null in this endpoint.
created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last-updated timestamp.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last-updated timestamp.

Responses

200

Successful response for Retrieve Location