ListStores

Name

listStores()

Example

<html>
<head></head>
<body>
<?php

$pinData = new pinPointClient;
$pinData->postcode = "postcode";
$pinData->miles = "miles";

$myresults = $pinData->listStores();

?>
</body>
</html>

Result

{
  "status": "success",
  "totalstores": total No of stores found,
  "store_data": [
    {
      "store_id": "Store UniqueId in Pinpoint Database",
      "store_distance": "Distance from your postcode",
      "store_title": "Store Name",
      "store_address": "Store Address",
      "store_city": "Store City",
      "store_suburb": "Store Suburb",
      "store_state": "Store State",
      "store_country": "Store Country",
      "store_zipcode": "Store Zipcode"
    }
  ]
}

Description

Variables:
$pinData->postcode = "postcode"; (required)
Type (String), Value (Any PostCode from USA, UK, Australia, Canada).
- The PostCode for which you want to search the stores.
The value has to be a valid PostCode from the giving countries otherwise invalid PostCode exception return.

$pinData->miles = "miles" (optional)

Type (Integer), Value (Number).
- Set the miles variable if you want API to find stores within radius(miles) of the PostCode set above.
If this variable is not set all the stores are returned in order of distance from the PostCode specified.
We recommend to use this variable if you have large number of stores concentrated in an area.
Smaller the value of $pinData->miles faster will be the response.