docs
  1. SCAYLE Resource Center
  2. Omnichannel
  3. Resources
  4. Store Inventory Locator
  5. Store Locator

Store Locator

To enable your customers to search online for the closest store to their address, you can use our /stores/locator endpoint.

You only need to provide the address and the radius and the endpoint will return to you a list of stores, matching the criteria.

API Reference docs: Store Locator

Pre-conditions

  • You have created stores
  • You have set these stores to active

Implementation hints

  • You can use the geoPoint in the response to render the results on a map to better visualize the different locations
  • You can also show the requested location in the query on the map by using meta.searchAddress.geoPoint
  • Store information, which is not included in our standard keys, can be added on the customData
  • The response payload is already sorted by distance, but you can also check the distance property
  • In the payload the endpoint also provides the info, if the store is currently open (openingTimes.currentlyOpen) and for how long it will remain open (openingTimes.minutesUntilClosed)
  • Images are unsorted. You can also define customData for each asset and develop filtering and sorting to your specific needs.