Commerce Foundation VENearbyStore CommerceQuery
The VENearbyStore Commerce Entity only supports query operation via the CommerceQueryOperation_VENearbyStore message handler. The query pipeline component will perform the following functions:
Retrieves Virtual Earth configuration from the profile system
Prepare the Virtual Earth FindNearbySpecification object
Get the list of store from the MapPoint Find Service
Retrieve the store profile object from Commerce Server and select the localized address language to be used
Add the store(s) to the query response
Syntax
var queryVENearbyStore = new CommerceQuery<CommerceEntity>("BENearbyStore");
Operation Sequence Components
Operation Sequence Component |
Description |
|---|---|
VENearbyStoreQueryProcessor |
Responsible for executing query operations |
Valid Query Operations
The VENearbyStore entity requires a custom CommerceVENearbyStoreSearch search criteria which will supply the required parameters to process the call to the Virtual Earth Platform:
Property |
Description |
|---|---|
PlatformEnvironment |
The Virtual Earth Platform environment to use for this search: Staging (default) or Production. |
Latitude |
The latitude of the search location in decimal degree. |
Longitude |
The longitude of the search location in decimal degree. |
DistanceUnit |
The distance unit used for the search operation: Mile (default) or Kilometer. |
Distance |
The distance used to find nearby store. |
Exceptions
Microsoft Multi-Channel Commerce Foundation can throw FaultException<GeneralOperationFault> during this operation for the following reasons:
InvalidOperationRequestException (NoSearchCriteriaInOperation) – a VENearbyStoreSearch was not provided
InvalidOperationException (VEConfigurationException) – Virtual Earth Platform configuration was invalid or incomplete
InvalidOperationException (VEWebServiceException) – web service call to the Virtual Earth Platform failed