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

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

200

Successful response for Retrieve Location

Retrieve Location

import Augno from '@augno/sdk';

const client = new Augno({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const location = await client.operations.locations.retrieve('lc_014d187d99b31926f0c74af9d8');

console.log(location.id);

import Augno from '@augno/sdk';

const client = new Augno({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const location = await client.operations.locations.retrieve('lc_014d187d99b31926f0c74af9d8');

console.log(location.id);

200 example

{
  "id": "lc_014d187d99b31926f0c74af9d8",
  "object": "location",
  "name": "Warehouse A",
  "type": "building",
  "parent": null,
  "children": {
    "object": "list",
    "page_info": {
      "next_page_url": null,
      "previous_page_url": null,
      "has_next_page": false,
      "has_prev_page": false
    },
    "data": [
      {
        "id": "lc_0132c4db1e220da9bc596cc4c9",
        "object": "location",
        "name": "Shelf A1",
        "type": null,
        "parent": null,
        "children": null,
        "created_at": "2026-05-10T00:00:00Z",
        "updated_at": "2026-05-10T00:23:00Z"
      }
    ]
  },
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

{
  "id": "lc_014d187d99b31926f0c74af9d8",
  "object": "location",
  "name": "Warehouse A",
  "type": "building",
  "parent": null,
  "children": {
    "object": "list",
    "page_info": {
      "next_page_url": null,
      "previous_page_url": null,
      "has_next_page": false,
      "has_prev_page": false
    },
    "data": [
      {
        "id": "lc_0132c4db1e220da9bc596cc4c9",
        "object": "location",
        "name": "Shelf A1",
        "type": null,
        "parent": null,
        "children": null,
        "created_at": "2026-05-10T00:00:00Z",
        "updated_at": "2026-05-10T00:23:00Z"
      }
    ]
  },
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

Retrieve Location

Authorization

Path Parameters

Query Parameters

Returns

Responses