object Location

Fields

FieldTypeDescription
idString

Public API ID for this identifiable.

legacy_idBigInt

Numeric legacy ID for this identifiable; use only where legacy IDs are required.

account_idString

Public API account ID that identifies the related record.

warehouse_idString

Public API warehouse ID. Use this when passing or filtering by a warehouse; warehouse fields are display values or nested objects.

typeLocationType

Type for this location.

nameString

Human-readable name for this location.

zoneString

Zone for this location.

pickableBoolean

Whether inventory in this location can be picked for fulfillment.

sellableBoolean

Whether inventory in this location counts toward sellable availability.

stagingBoolean

Indicates if this location is designated as a staging area for wholesale orders. Requires wholesale feature to be enabled for your account.

is_cartBoolean

Whether this location is cart.

pick_priorityInt

Pick priority as a numeric value.

dimensionsDimensions

Package or item dimensions. Length, width, and height are in inches unless account or carrier configuration specifies another unit.

lengthStringDEPRECATED Not used anymore. Use dimensions

Length as a decimal number in inches unless the account or carrier configuration specifies another unit.

widthStringDEPRECATED Not used anymore. Use dimensions

Width as a decimal number in inches unless the account or carrier configuration specifies another unit.

heightStringDEPRECATED Not used anymore. Use dimensions

Height as a decimal number in inches unless the account or carrier configuration specifies another unit.

max_weightStringDEPRECATED Not used anymore. Use dimensions

Max weight for this location. Deprecated; see the deprecation reason for current behavior.

temperatureString

Temperature for this location.

productsProductConnection

List of products associated with this location.

ArgumentTypeRequiredDefaultDescription
sortStringNo
beforeStringNo
afterStringNo
firstIntNo
lastIntNo
last_countedISODateTimeDEPRECATED This field is no longer in use.

Last counted as an ISO-8601 datetime, returned in UTC unless otherwise noted. Deprecated; see the deprecation reason for current behavior.

created_atISODateTime

Created at as an ISO-8601 datetime, returned in UTC unless otherwise noted.

expiration_lotsLotConnection

Expiration lots for this location.

ArgumentTypeRequiredDefaultDescription
customer_account_idStringNo

Filter by 3PL child/customer account ID; omit to use the authenticated account.

sortStringNo
beforeStringNo
afterStringNo
firstIntNo
lastIntNo

Referenced By

Example

{
  "id": "UmVjb3JkOjEyMzQ=",
  "legacy_id": 1234,
  "account_id": "TG9jYXRpb246MTIzNA==",
  "warehouse_id": "V2FyZWhvdXNlOjEyMzQ=",
  "type": {id: "TG9jYXRpb246MTIzNA==", name: "A01-01-01"},
  "name": "A01-01-01",
  "zone": "A",
  "pickable": true,
  "sellable": true,
  "staging": true,
  "is_cart": true,
  "pick_priority": 1,
  "dimensions": {length: 12.5, width: 8.0, height: 4.0},
  "length": "default",
  "width": "default",
  "height": "default",
  "max_weight": "1.25",
  "temperature": "ambient",
  "products": [{sku: "BLUE-TEE-M", name: "Blue Tee"}],
  "last_counted": "2026-07-09T15:30:00Z",
  "created_at": "2026-07-09T15:30:00Z",
  "expiration_lots": [{id: "TG9jYXRpb246MTIzNA==", name: "A01-01-01"}]
}