query · Module: Catalog · Requires catalog:read
Arguments
| Argument | Type | Description |
|---|---|---|
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
ZoneList!
| Field | Type |
|---|---|
data | [Zone!]! |
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 Zones($limit: Int) {
zones(limit: $limit) {
data {
id
object
name
status
livemode
created
updated
purpose
area {
countries
subdivisions
postal_codes
cities {
name
country
state
}
exclude {
countries
subdivisions
postal_codes
}
}
priority
version
}
has_more
}
}
{
"limit": 10
}
{
"data": {
"zones": {
"data": [
{
"id": "zone_1a2B3c",
"object": "zone",
"name": "Example",
"status": "draft",
"livemode": true,
"created": 1791302400,
"updated": 1791302400,
"purpose": [
"coverage"
],
"area": {
"countries": [
"example"
],
"subdivisions": [
"example"
],
"postal_codes": [
"example"
],
"cities": [
{
"name": "Example",
"country": "GB",
"state": "example"
}
],
"exclude": {
"countries": [
"example"
],
"subdivisions": [
"example"
],
"postal_codes": [
"example"
]
}
},
"priority": 100,
"version": 3
}
],
"has_more": true
}
}
}