Create Location

Beta
POST/v1/operations/locations

Idempotent with Idempotency-Key header. Learn more

Creates a storage location, optionally placing it in the location hierarchy.

Permissions requiredValues:locations:create
The role behind your API key or agent must grant every one of these permissions.
include[]optional arrayenumValues:parentchildren

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

namestring

Display name of the location.

Maximum 255 characters.

typeobject

Location 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 string

ID of the parent location.

Omit for top-level locations.

child_idsoptional array of string

IDs of existing locations to attach as children of the new location.

Listed locations are moved from their current parent, if any.

idstring

Location ID.

objectstringenumValues:location

Resource type identifier.

namestring

Display name of the location.

typeobject

Location 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.
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

Location 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.
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.

null when the last page has been reached.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

null while on the first page.

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

Location 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.
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

201

Successful response for Create Location