query · Module: Inventory · Requires inventory:read
Arguments
| Argument | Type | Description |
|---|---|---|
facility | String | Filter by facility. |
type | String | Filter by type. |
status | String | Filter by status. |
createdGte | Int | Filter by created gte. |
createdLte | Int | Filter by created lte. |
limit | Int | Page size, 1–100 (default 10). |
startingAfter | ID | Cursor: return objects after this ID. |
endingBefore | ID | Cursor: return objects before this ID. |
Returns
StorageLocationList!
| Field | Type |
|---|---|
data | [StorageLocation!]! |
has_more | Boolean |
Errors
Errors are returned inerrors[], with the REST error object in extensions (type, code, param, request_id), using the codes in Conventions §9.
query StorageLocations($limit: Int) {
storageLocations(limit: $limit) {
data {
id
object
code
type
status
livemode
created
updated
facility
path {
zone
aisle
rack
shelf
bin
}
temperature_class
capacity {
volume {
value
unit
}
weight {
value
unit
}
units
pallets
}
restrictions {
hazmat_classes
owners
max_sku_count
}
barcode
pick_sequence
}
has_more
}
}
{
"limit": 10
}
{
"data": {
"storageLocations": {
"data": [
{
"id": "loc_1a2B3c",
"object": "storage_location",
"code": "dhl_express_worldwide",
"type": "pick_face",
"status": "active",
"livemode": true,
"created": 1791302400,
"updated": 1791302400,
"facility": "fac_lon_hub",
"path": {
"zone": "zone_gb_mainland",
"aisle": "example",
"rack": "example",
"shelf": "example",
"bin": "example"
},
"temperature_class": "ambient",
"capacity": {
"volume": {
"value": 1.5,
"unit": "kg"
},
"weight": {
"value": 1.5,
"unit": "g"
},
"units": 2,
"pallets": 2
},
"restrictions": {
"hazmat_classes": [
"example"
],
"owners": [
"example"
],
"max_sku_count": 2
},
"barcode": "LOC-A12-03-B",
"pick_sequence": 2
}
],
"has_more": true
}
}
}