Create Location
Beta/v1/operations/locationsIdempotent with Idempotency-Key header. Learn more
Creates a storage location, optionally placing it in the location hierarchy.
include[]optional arrayenumValues:parentchildrenSub-objects to expand in the response. When omitted, sub-objects are returned as null.
namestringDisplay name of the location.
Maximum 255 characters.
typeobjectLocation type code, identifying this location's level in the storage hierarchy.
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.
parent_idoptional stringID of the parent location.
Omit for top-level locations.
child_idsoptional array of stringIDs of existing locations to attach as children of the new location.
Listed locations are moved from their current parent, if any.
idstringLocation ID.
objectstringenumValues:locationResource type identifier.
namestringDisplay name of the location.
typeobjectLocation type code, identifying this location's level in the storage hierarchy.
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.
parentlocationExpandablenullableThe location directly above this one in the storage hierarchy.
Absent for top-level locations.
idstringLocation ID.
objectstringenumValues:locationResource type identifier.
namestringDisplay name of the location.
typeobjectLocation type code, identifying this location's level in the storage hierarchy.
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.
null in this endpoint.parentlocationExpandablenullableThe location directly above this one in the storage hierarchy.
Absent for top-level locations.
null in this endpoint.The locations directly below this one in the storage hierarchy.
null in this endpoint.created_atstring (date-time)Creation timestamp.
updated_atstring (date-time)Last-updated timestamp.
The locations directly below this one in the storage hierarchy.
objectstringenumValues:listResource type identifier.
page_infoobjectPagination metadata.
next_page_urlstringnullableRelative URL that fetches the next page of results.
null when the last page has been reached.
previous_page_urlstringnullableRelative URL that fetches the previous page of results.
null while on the first page.
has_next_pagebooleanWhether more results exist after this page.
has_prev_pagebooleanWhether results exist before this page.
dataarray of locationResources in this page.
idstringLocation ID.
objectstringenumValues:locationResource type identifier.
namestringDisplay name of the location.
typeobjectLocation type code, identifying this location's level in the storage hierarchy.
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.
null in this endpoint.parentlocationnullableThe location directly above this one in the storage hierarchy.
Absent for top-level locations.
null in this endpoint.The locations directly below this one in the storage hierarchy.
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
Successful response for Create Location