SapccApiGetStoreLocationsRequest
Request parameters for getStoreLocations operation in SapccApi. SapccApiGetStoreLocationsRequest
interface SapccApiGetStoreLocationsRequest {
readonly accuracy?: number;
readonly baseSiteId: string;
readonly currentPage?: number;
readonly fields?: string;
readonly latitude?: number;
readonly longitude?: number;
readonly pageSize?: number;
readonly query?: string;
readonly radius?: number;
readonly sort?: string;
}Properties
| Name | Required | Type | Description |
|---|---|---|---|
accuracy | Optional | number | Accuracy in meters. {number} SapccApiGetStoreLocations |
baseSiteId | Required | string | Base site identifier {string} SapccApiGetStoreLocations |
currentPage | Optional | number | Current result page. Default value is 0. {number} SapccApiGetStoreLocations |
fields | Optional | string | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL {string} SapccApiGetStoreLocations |
latitude | Optional | number | Coordinate that specifies the north-south position of a point on the Earth's surface. {number} SapccApiGetStoreLocations |
longitude | Optional | number | Coordinate that specifies the east-west position of a point on the Earth's surface. {number} SapccApiGetStoreLocations |
pageSize | Optional | number | Number of results returned per page. {number} SapccApiGetStoreLocations |
query | Optional | string | Location in plain text. Example: USA or New York City {string} SapccApiGetStoreLocations |
radius | Optional | number | Radius in meters. Max value: 40075000.0 (Earth's perimeter). {number} SapccApiGetStoreLocations |
sort | Optional | string | Sorting method applied to the return results. {string} SapccApiGetStoreLocations |