Get Zone from ID

GET
https://api.woosmap.com/zones/{zone_id}

Used to retrieve a zone from his zone_id

Authorization

private_key
apiKey query

A Private key generated specifically to authenticate API requests on server side. Required for Data management API. See how to register a Private API Key.

Path Parameters

zone_id
string required

ID of the zone to get

Example: ZoneA

Response

200 application/json

Zone successfully retrieved

zone_id
string required

A textual identifier that uniquely identifies a Zone.

Example: ZoneA

Textual description of your Zone

Example: Delivery Zone for Store A
store_id
string required

A textual identifier that uniquely identifies an Asset. It must matches the following regexp [A-Za-z0-9]+

Example: STORE_ID_12345
polygon
string required

Zone geometry polygon as Well Known Text. WKT defines how to represent geometry of one object (cf. https://en.wikipedia.org/wiki/Well-known_text). Your zones could be complex and multipart polygons.

Example: POLYGON ((-122.4546384 37.774656,-122.4515485 37.7595934,-122.4354306 37.7602172,-122.4333707 37.7512596,-122.423071 37.7511239,-122.4242726 37.7687665,-122.4259893 37.7691736,-122.4289075 37.7732444,-122.4306241 37.7850483,-122.4472753 37.7830133,-122.445902 37.7759581,-122.4546384 37.774656))
types
string[]

Contains an array of types describing the Zone.

Example:
JSON
        
[


  "delivery",


  "san_francisco_west"


]
status
string

the status as string

Example: ok

Errors

401

Unauthorized. Incorrect authentication credentials.
application/json
detail
string

Details for the credentials error

Example: Incorrect authentication credentials. Please check or use a valid API Key
403

Forbidden. This Woosmap API is not enabled for this project.
application/json
detail
string

Details for the forbidden error message

Example: This Woosmap API is not enabled for this project.
404

Not Found - zone_id do not exist.

 
        curl -L 'https://api.woosmap.com/zones/ZoneA/?private_key=YOUR_PRIVATE_API_KEY'

    
        const requestOptions = {
  method: "GET",
  redirect: "follow"
};

fetch("https://api.woosmap.com/zones/ZoneA/?private_key=YOUR_PRIVATE_API_KEY", requestOptions)
  .then((response) => response.text())
  .then((result) => console.log(result))
  .catch((error) => console.error(error));

    
        import requests

url = "https://api.woosmap.com/zones/ZoneA/?private_key=YOUR_PRIVATE_API_KEY"

payload = {}
headers = {}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)


    
        
{


  "store_id": "STORE_ID_123456",


  "zone_id": "ZoneA",


  "polygon": "POLYGON ((-122.496116 37.7648181, -122.4954079 37.751518, -122.4635648 37.7530788, -122.4618481 37.7514501, -122.4601315 37.7521288, -122.4565266 37.7513144, -122.4540375 37.7566755, -122.4528359 37.7583041, -122.4515485 37.7595934, -122.4546384 37.774656, -122.4718903 37.7731635, -122.472577 37.772485, -122.4755811 37.7725529, -122.4791001 37.7723493, -122.4793576 37.7713995, -122.4784993 37.769839, -122.4783276 37.7680071, -122.4774693 37.766718, -122.4772118 37.7652931, -122.496116 37.7648181))",


  "types": [


    "delivery"


  ],


  "description": "Delivery Zone for Store A",


  "status": "ok"


}



    
        
{


  "detail": "Incorrect authentication credentials. Please check or use a valid API Key"


}



    
        
{


  "detail": "This Woosmap API is not enabled for this project."


}
Was this helpful?