Home > @vsf-enterprise/sap-commerce-webservices-sdk > StoresApi > getStoreLocations
StoresApi.getStoreLocations() method
Lists all store locations that are near the location specified in a query or based on latitude and longitude. Get a list of store locations
Signature:
getStoreLocations(baseSiteId: string, accuracy?: number, currentPage?: number, fields?: string, latitude?: number, longitude?: number, pageSize?: number, query?: string, radius?: number, sort?: string, options?: any): Promise<import("axios").AxiosResponse<StoreFinderSearchPage>>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| baseSiteId | string | Base site identifier |
| accuracy | number | Accuracy in meters. |
| currentPage | number | The current result page requested. |
| fields | string | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
| latitude | number | Coordinate that specifies the north-south position of a point on the Earth's surface. |
| longitude | number | Coordinate that specifies the east-west position of a point on the Earth's surface. |
| pageSize | number | The number of results returned per page. |
| query | string | Location in natural language i.e. city or country. |
| radius | number | Radius in meters. Max value: 40075000.0 (Earth's perimeter). |
| sort | string | Sorting method applied to the return results. |
| options | any | Override http request option. |
Returns:
Promise<import("axios").AxiosResponse<StoreFinderSearchPage>>
Exceptions
{RequiredError} StoresApi