object Location
Fields
| Field | Type | Description | |||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | String | Public API ID for this identifiable. | |||||||||||||||||||||||||||||||||||
legacy_id | BigInt | Numeric legacy ID for this identifiable; use only where legacy IDs are required. | |||||||||||||||||||||||||||||||||||
account_id | String | Public API account ID that identifies the related record. | |||||||||||||||||||||||||||||||||||
warehouse_id | String | Public API warehouse ID. Use this when passing or filtering by a warehouse; warehouse fields are display values or nested objects. | |||||||||||||||||||||||||||||||||||
type | LocationType | Type for this location. | |||||||||||||||||||||||||||||||||||
name | String | Human-readable name for this location. | |||||||||||||||||||||||||||||||||||
zone | String | Zone for this location. | |||||||||||||||||||||||||||||||||||
pickable | Boolean | Whether inventory in this location can be picked for fulfillment. | |||||||||||||||||||||||||||||||||||
sellable | Boolean | Whether inventory in this location counts toward sellable availability. | |||||||||||||||||||||||||||||||||||
staging | Boolean | Indicates if this location is designated as a staging area for wholesale orders. Requires wholesale feature to be enabled for your account. | |||||||||||||||||||||||||||||||||||
is_cart | Boolean | Whether this location is cart. | |||||||||||||||||||||||||||||||||||
pick_priority | Int | Pick priority as a numeric value. | |||||||||||||||||||||||||||||||||||
dimensions | Dimensions | Package or item dimensions. Length, width, and height are in inches unless account or carrier configuration specifies another unit. | |||||||||||||||||||||||||||||||||||
length | String | DEPRECATED Not used anymore. Use dimensions Length as a decimal number in inches unless the account or carrier configuration specifies another unit. | |||||||||||||||||||||||||||||||||||
width | String | DEPRECATED Not used anymore. Use dimensions Width as a decimal number in inches unless the account or carrier configuration specifies another unit. | |||||||||||||||||||||||||||||||||||
height | String | DEPRECATED Not used anymore. Use dimensions Height as a decimal number in inches unless the account or carrier configuration specifies another unit. | |||||||||||||||||||||||||||||||||||
max_weight | String | DEPRECATED Not used anymore. Use dimensions Max weight for this location. Deprecated; see the deprecation reason for current behavior. | |||||||||||||||||||||||||||||||||||
temperature | String | Temperature for this location. | |||||||||||||||||||||||||||||||||||
products | ProductConnection | List of products associated with this location. | |||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||
last_counted | ISODateTime | DEPRECATED 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_at | ISODateTime | Created at as an ISO-8601 datetime, returned in UTC unless otherwise noted. | |||||||||||||||||||||||||||||||||||
expiration_lots | LotConnection | Expiration lots for this location. | |||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||
Referenced By
- AllocatedAllocationType Type
- InventoryChange Type
- ItemLocation Type
- LocationEdge Type
- LocationOutput Type
- LocationQueryResult Type
- TotePick Type
- WorkOrderAssemblySkuType Type
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"}]
}