query · Module: Inventory · Requires inventory:read
Arguments
Returns
WaveList!
Errors
Errors are returned inerrors[], with the REST error object in extensions (type, code, param, request_id), using the codes in Conventions §9.
Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
query Waves($limit: Int) {
waves(limit: $limit) {
data {
id
object
status
livemode
created
updated
facility
strategy
fulfillment_orders
pick_list
}
has_more
}
}
{
"limit": 10
}
{
"data": {
"waves": {
"data": [
{
"id": "wave_1a2B3c",
"object": "wave",
"status": "released",
"livemode": true,
"created": 1791302400,
"updated": 1791302400,
"facility": "fac_lon_hub",
"strategy": "zone",
"fulfillment_orders": [
"example"
],
"pick_list": "example"
}
],
"has_more": true
}
}
}
List waves
query Waves($limit: Int) {
waves(limit: $limit) {
data {
id
object
status
livemode
created
updated
facility
strategy
fulfillment_orders
pick_list
}
has_more
}
}
{
"limit": 10
}
{
"data": {
"waves": {
"data": [
{
"id": "wave_1a2B3c",
"object": "wave",
"status": "released",
"livemode": true,
"created": 1791302400,
"updated": 1791302400,
"facility": "fac_lon_hub",
"strategy": "zone",
"fulfillment_orders": [
"example"
],
"pick_list": "example"
}
],
"has_more": true
}
}
}
query · Module: Inventory · Requires inventory:read
| Argument | Type | Description |
|---|---|---|
facility | String | Filter by facility. |
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. |
WaveList!
| Field | Type |
|---|---|
data | [Wave!]! |
has_more | Boolean |
errors[], with the REST error object in extensions (type, code, param, request_id), using the codes in Conventions §9.
query Waves($limit: Int) {
waves(limit: $limit) {
data {
id
object
status
livemode
created
updated
facility
strategy
fulfillment_orders
pick_list
}
has_more
}
}
{
"limit": 10
}
{
"data": {
"waves": {
"data": [
{
"id": "wave_1a2B3c",
"object": "wave",
"status": "released",
"livemode": true,
"created": 1791302400,
"updated": 1791302400,
"facility": "fac_lon_hub",
"strategy": "zone",
"fulfillment_orders": [
"example"
],
"pick_list": "example"
}
],
"has_more": true
}
}
}