Geo

Summary

Geo establishes connections between products and locations. You can create search rules that consider the distance between customers and stock locations. For example, you can discount or hide products by stock region. In the following, these locations—identified by an ID and geo-coordinate—are referred to as markets.

You can find the Geo module in the left-hand menu under More settings… within the Modules section.

Note: Geo must be licensed separately before activation. Furthermore, in addition to the product data feed, two files have to be provided:

  • GeoMarket-CSV linking market IDs and locations.

  • GeoStock-CSV with market IDs and market-specific data such as stock levels.

Both files can be configured via Fields.

Configuring Geo

General Settings

The following General settings are available for Geo configuration:

Active: If deactivated, no 'Geo' data will be imported and other modules will not be affected by 'Geo'.

Include all existing markets in search responses: When enabled, the search response contains all existing markets. The list can be large and may negatively affect performance.

Calculate distance for markets: When enabled, the search response includes the distance to each available market. This may negatively affect performance.

Product identifier: If the field with the 'Master ID' role is used as the product identifier in the geoStock file, all other fields with a geo import source, that do not have a field role related to the geo module, must be non-variant fields. If the field with the 'Product Number' role is used instead, all of these geo fields must be variant fields.

Default market selection: Defines the default behavior if no 'marketId' is provided in a search request. It will use the given market id or selection strategy to filter the products based on the market Id field. Choose the ID of a market, 'online' for the online shop, or one of the two strategies:

  • The 'All' strategy will ignore all products, which do not have a value in the market Id field.

  • Choose 'No selection' in order to use the 'skip' strategy. This strategy will not filter the products based on a market selection. So if all products have a value in the market Id field both strategies behave the same way.

Import Geo data in product import interval: When active, a Geo data import is conducted following the product data import in its update interval.

Download Geo import files in product import interval: When active, both the Geo market location file and the Geo stock file are downloaded when an import linked to the data import starts. This setting has no effect if 'Import Geo data in product import interval' is not enabled.

Distance Rule Settings

Distance rule settings let you apply weights to products based on the distance between markets and the search location. While a product may have values for several markets, weights are only applied for the market closest to the search location.

The following Distance rule settings are available:

Exclude products outside of radius: If active, products that aren't available at markets in the specified radius will be removed from the search result. Setting 'exclude products outside of radius' to false for a search request could have a negative impact on the search performance. Therefore, only markets within the radius of 20 km will be considered. This is 2 times the radius configured in 'radius in km'.

Max. amount of markets: If no market is selected, the amount of found markets will be limited to this number. Naturally, only the nearest markets are considered. This setting can be helpful when a search with the configured distance returns too many markets in densely populated areas.

Radius in km: Only products within the specified radius (in km) will receive a score adjustment.

Adjustment at closest distance: The maximum score adjustment for the product at the closest distance to the market location. The adjustment will be applied as weight, meaning it will be multiplied rather than added to the score. An adjustment of X% would mean the product score gets multiplied by 1.0X.

Adjustment at farthest distance: The maximum score adjustment for the product at the max. distance defined. The adjustment will be applied as weight, meaning it will be multiplied rather than added to the score. An adjustment of X% would mean the product score gets multiplied by 1.0X.

Adjustment for the online market: The score adjustment for the product in case of an online score. The adjustment will be applied as weight, meaning it will be multiplied rather than added to the score. An adjustment of X% would mean the product score gets multiplied by 1.0X.

Preview on map: View markets and their radii on a map.

Example - Exclude products outside the radius:

The customer can only search for products from markets A and B.

Example - Do not exclude products outside the radius:

The customer can also find products from markets C and D. Market E is still outside his catchment area.

Note: Applying a Geo field filter shows products that match the specified Market ID. Results might include products whose Market Value does not align with the filter criteria.

Important: Customers who are outside all the catchment areas of markets will only receive zero hit searches. Make sure that either your entire area served is covered by at least one circle on the map preview. Alternatively, configure a campaign.

Import File Settings

Import file settings allows to configure import for Geo:

File selection: select between Geo stock file or Geo market file

URL: Defines the location of the source file to pick and parse.

Frequency: Defines the periodicity of triggering.

Use interval as import trigger: Allows to specify interval as a trigger condition.

Delimiter: Defines the Field separator used in the import file to differentiate between fields.

Enclosing (quote) character: Surrounding characters (e.g. quotation marks) for the field contents (optional).

Escape character: A character that escapes the delimiter if it occurs in field contents (optional).

Min. file size: Defines the minimum file size that will be accepted. Also indicates the current file size.

Expires after:

Last updated

Was this helpful?