Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Parameter details and edge cases of storelookup API #1207

Open
Shreyaakothari opened this issue Feb 14, 2025 · 0 comments
Open

Add Parameter details and edge cases of storelookup API #1207

Shreyaakothari opened this issue Feb 14, 2025 · 0 comments
Labels
oms documentation

Comments

@Shreyaakothari
Copy link
Collaborator

https://discord.com/channels/919820544684212225/1041689790795501598/threads/1237262180492247111

When passing the lat/long in the store lookup APIs if no stores are visible it can be due to the defined distance parameter in the request. to resolve this distance parameter can be removed and sortby parameter can be used

Need to add the following parameter details and edgecases

Key Parameters and Edge Cases:
distance (in miles): Defines the search radius. If no stores are within the radius, no results are returned.
point (lat,long): The central point for distance-based queries. The API sorts results by distance automatically.
sortBy: Not needed for distance sorting; omit it when using point.
fieldsToSelect: Allows limiting response fields, but only works when point is not used.
Edge Cases:
Ensure that stores have valid geolocation data.
Narrow distances (e.g., 50m) may result in no results if stores are outside the range.
Sorting by distance is automatic when using point.

@Shreyaakothari Shreyaakothari added the oms documentation label Feb 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
oms documentation
Projects
None yet
Development

No branches or pull requests

1 participant