Get a Geozone
GET
/api/v2/geozones/{id}.json
Retrieve a single Geozone using its ID.
Scopes
Requires either the geozones or geozones.readonly OAuth scope.
Parameters
Accepts the following parameters:
id
required
The ID of the Geozone is supplied as a path parameter. |
Response
Returns an object with the following properties:
success
A boolean where a value of true represents a successful request.
|
status
The HTTP status code e.g. 200 for a successful request.
|
data
Contains the Geozone object. |
JSON Example
An example of JSON returned.
{
"success": true,
"status": 200,
"data": {
"id": 48646,
"title": "EU Shipping Zone 1",
"description": "Shipping zone for our main European customer base",
"createdOn": "2022-05-21T15:54:05+00:00",
"modifiedOn": "2022-05-21T15:54:05+00:00",
"countries": [
{
"countryCode": "ES",
"regionCodes": []
},
{
"countryCode": "DE",
"regionCodes": []
},
{
"countryCode": "FR",
"regionCodes": []
}
]
}
}