mutation · Module: Catalog · Requires catalog:write
Arguments
| Argument | Type | Description |
|---|---|---|
input | ZoneInput | The fields for this operation. |
ZoneInput fields
| Field | Type |
|---|---|
name | String |
purpose | [ZoneInputPurposeItem!] |
area | AreaInput |
priority | Int |
status | ZoneInputStatus |
version | Int |
user_metadata | UserMetadataInput |
Returns
Zone!
| Field | Type |
|---|---|
id | String! |
object | ZoneObject! |
livemode | Boolean! |
created | Int! |
updated | Int |
name | String! |
purpose | [ZonePurposeItem!] |
area | Area! |
priority | Int |
status | ZoneStatus! |
version | Int |
user_metadata | UserMetadata |
carrier_metadata | CarrierMetadata |
system_metadata | SystemMetadata |
Errors
Errors are returned inerrors[], with the REST error object in extensions (type, code, param, request_id), using the codes in Conventions §9.
mutation CreateZone($input: ZoneInput!) {
createZone(input: $input) {
id
object
name
status
livemode
created
updated
purpose
area {
countries
subdivisions
postal_codes
cities {
name
country
state
}
exclude {
countries
subdivisions
postal_codes
}
}
priority
version
}
}
{
"input": {
"name": "Example",
"purpose": [
"coverage"
],
"area": {
"countries": [
"example"
],
"subdivisions": [
"example"
],
"postal_codes": [
"example"
],
"cities": [
{
"country": "GB",
"state": "example",
"name": "Example"
}
]
},
"priority": 100,
"status": "draft",
"version": 3
}
}
{
"data": {
"createZone": {
"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
}
}
}