Class: module:api/StoresApi

module:api/StoresApi(apiClient)

new module:api/StoresApi(apiClient)

Constructs a new StoresApi.

Parameters:
Name Type Description
apiClient module:ApiClient

Optional API client implementation to use, default to module:ApiClient#instance if unspecified.
Source:

Methods

getStore(storeId, opts) → {Promise}

getStore Returns store location based on its unique name.

Parameters:
Name Type Description
storeId String

Store identifier (currently store name)
opts Object

Optional parameters

Properties
Name Type Description
fields String

Response configuration (list of fields, which should be returned in response)
Source:
Returns:

a Promise">www.promisejs.org/|Promise}, with data of type module:models/PointOfService

Type
Promise

getStores(opts) → {Promise}

Stores Lists all store locations that are near the location specified in a query or based on latitude and longitude.

Parameters:
Name Type Description
opts Object

Optional parameters

Properties
Name Type Description
query String

Location in natural language i.e. city or country.
latitude String

Coordinate that specifies the north-south position of a point on the Earth's surface.
pageSize String

The number of results returned per page.
accuracy String

Accuracy in meters.
sort String

Sorting method applied to the return results.
currentPage String

The current result page requested.
radius String

Radius in meters. Max value: 40075000.0 (Earth's perimeter).
fields String

Response configuration (list of fields, which should be returned in response)
longitude String

Coordinate that specifies the east-west position of a point on the Earth's surface.
Source:
Returns:

a Promise">www.promisejs.org/|Promise}, with data of type module:models/StoreFinderSearchPage

Type
Promise

stores1WithHttpInfo(opts) → {Promise}

Stores Lists all store locations that are near the location specified in a query or based on latitude and longitude.

Parameters:
Name Type Description
opts Object

Optional parameters

Properties
Name Type Description
query String

Location in natural language i.e. city or country.
latitude String

Coordinate that specifies the north-south position of a point on the Earth's surface.
pageSize String

The number of results returned per page.
accuracy String

Accuracy in meters.
sort String

Sorting method applied to the return results.
currentPage String

The current result page requested.
radius String

Radius in meters. Max value: 40075000.0 (Earth's perimeter).
fields String

Response configuration (list of fields, which should be returned in response)
longitude String

Coordinate that specifies the east-west position of a point on the Earth's surface.
Source:
Returns:

a Promise">www.promisejs.org/|Promise}, with an object containing data of type module:models/StoreFinderSearchPage and HTTP response

Type
Promise

storesByStoreIdWithHttpInfo(storeId, opts) → {Promise}

getStore Returns store location based on its unique name.

Parameters:
Name Type Description
storeId String

Store identifier (currently store name)
opts Object

Optional parameters

Properties
Name Type Description
fields String

Response configuration (list of fields, which should be returned in response)
Source:
Returns:

a Promise">www.promisejs.org/|Promise}, with an object containing data of type module:models/PointOfService and HTTP response

Type
Promise