Queries and mutations for managing Zones in the platform.
Queries
Query Zones
Get Zone
| Arguments | |
|---|---|
idString | Queries with specified ID |
keyString | Queries with specified key |
Mutations
Create Zone
Update Zone
| Arguments | |
|---|---|
versionLong | |
actionsArray of ZoneUpdateAction | |
idString | Queries with specified ID |
keyString | Queries with specified key |
Delete Zone
Output types
Zone
Zones allow defining ShippingRates for specific Locations.
nameString | Name of the Zone. |
keyString | User-defined unique identifier of the Zone. |
descriptionString | Description of the Zone. |
locationsArray of Location | List of locations that belong to the Zone. |
idString | Unique identifier of the Zone. |
versionLong | Current version of the Zone. |
createdAt | Date and time (UTC) the Zone was initially created. |
lastModifiedAt | Date and time (UTC) the Zone was last updated. |
createdBy | IDs and references that created the Zone. |
lastModifiedBy | IDs and references that last modified the Zone. |
Location
A geographical location representing a country and optionally a state within this country. A location can only be assigned to one Zone.
country | Country code of the geographic location. |
stateString | State within the country. |
ZoneQueryResult
Input types
CreateZone
nameString | |
keyString | |
descriptionString | |
locationsArray of ZoneLocation | Default: [] |
ZoneLocation
country | |
stateString |
ZoneUpdateAction
addLocation | |
changeName | |
removeLocation | |
setDescription | |
setKey |
Update actions
Add Location
location | Location to be added to the Zone. |
Change Name
nameString | New name of the Zone. |
Remove Location
location | Location to be removed from the Zone. |
Set Description
descriptionString | Description of the Zone. |
Set Key
keyString | If key is absent or null, the existing key, if any, will be removed. |