Query parameters¶

Each page type has a set of applicable query parameters, found in the API specification. The query parameters which apply to multiple pages, are detailed and listed in this section.

Base query parameters¶

Base query parameters apply to all pages. Those which are mandatory must be supplied for all requests, while optional ones are likely to be either be supplied in an equivalent manner for all page types or not at all.

Mandatory parameters¶

Correct usage of the customer and session keys are essential for the behavioral data to be analysed correctly. A session starts when a visitor arrives at a site, and is identified through a unique sessionKey. The same sessionKey must be used though out the visit. For more information about customer keys, see Visitor identification.

Optional parameters¶

Price ID¶

When supplying a price ID to a request, the selling_price and list_price property of all products will be provided as the price in the data feed for that price ID. Sorting, faceting, and filtering on price will also be based on prices with the specified identifier.

Stores and channels¶

Filtering and ranking products based on both online and store specific stock levels are supported in Elevate. Filtering can be done either by default for all listings, or by adding the onlyInStock facet to the site. This lets the visitor control when to show out of stock products. If out of stock products are displayed, they are by default buried and displayed after products that are in stock. These behaviors can be modified in the Out of stock settings for Pages in the Experience app.

The channels parameter determines what channels should be used when filtering and ranking based on stock levels, as discussed above. The ONLINE channel will use the online stock level while the STORE channel will use store specific stock levels. Channels also affect the inStock properties on products and variants, and the general stockNumber on variants in the result. Which store specific stocks levels that are used is decided by the stores parameter.

The availability array on each product variant in the result is unaffected by the channels parameter, and displays unmodified stock levels from the data feed. For regular listings, the stores parameter is used to decide which stores to display, but for the main productGroup of the product-page response the array will include all stores that are present on the variant. Note that the online stock is always included as the first item, and that a store is only included if present on the variant in the data feed.

Examples¶

The following example has three products, each having one variant, with stock levels online and in two physical stores identified by store keys 240 and 100.

The effect of some parameter combinations on a landing page displaying all products is shown below.

Custom attributes¶

Customers and integrators that would like to control what custom attributes of products that are available in product lists and recommendation lists of a page can use the query parameter presentCustom. The attributes returned by the query parameter are valid for all lists on the page.

This parameter is not needed for the main product returned in a Product page query, but the parameter will affect any recommendation lists on a product page if included.

presentCustom can't be used in combination with templateId.

Templates¶

Customers and integrators that would like to control which fields, custom attributes as well as predefined attributes, that should be available on products and variants in listings can define a template. The id of the template should be specified with the parameter templateId. Templates are the suggested way to consistently return the same fields for products and variants.

This parameter will not affect the main product returned in a Product page query, but the parameter will affect any recommendation lists on a product page if included.

templateId can't be used in combination with presentCustom.

The Product list response templates has more information on how to work with templates.

Product rules¶

Notify¶

The notify parameter should always be enabled in production for visitor facing parts of the e-commerce site. However, if any query is used for other purposes such as internal administrative tools or if a load test is run on the production environment with simulated data, ensure that notify=false is applied. This will prevent tests and internal tools to cause noise in statistics as well as erroneous behavior analysis, i.e. notify=false shall only be used in production when the request is undoubtedly unrelated to an actual visitors activity on the site.

Note that this is not an issue for small scale testing, but rather something to consider when lots of non-visitor generated traffic is expected.

Facet selections¶

Facet selections are used for visitor facing product list filters, so called "facets". As opposed to product filters, facets are to be visualized and applicable and reversible by the visitors. All applicable facets are part of the response for Primary Listings. Each facet has an id, which should be provided along with the selected values as query parameters, when selected by the visitors.

Value facet syntax¶

Applicable for Text, Color and Size Facets. All facet ids and value ids are found in the response for each facet. Multiple values are provided with a pipe, |, as a separator. No escaping is needed as pipes that are part of the value id itself will be pre-escaped.

f.[id]=[value1.id]|[value2.id]

Range facet syntax¶

Range facets are provided with min and max as suffix to the facet id with values for the desired range. Both min and max are inclusive and default to 0 and the maximum eligible value respectively.

f.[id].min=[min]&f.[id].max=[max]

Checkbox facet syntax¶

Checkbox facets are similar to Value facets but consist only of one boolean value, represented by the selected property. By default, the selected property can be either true or false. To actively select or deselect the Checkbox facet, and thus apply or clear the filter, the value true or false must be provided as shown below.

f.[id]=[true or false]

Request example¶

The following example illustrates a category page request with a brand, a season (custom attribute), a price range, and a stock filter, onlyInStock, selected as facets. Other request parameters have been omitted for brevity.

https://{cluster-id}.api.esales.apptus.cloud/api/storefront/v3/queries/landing-page?
f.brand=adidas&f.custom.season=winter|spring&f.price.min=500&f.price.max=2500&
f.onlyInStock=true

Page IDs¶

For landing pages and category pages, unique page identifiers must be provided. Page identifiers will be visible and used to distinguish between pages in the Elevate Apps, where merchandisers are provided with control of listings for each individual page. The max length of a page id is 200 characters.

For pages on the site, page paths should be used.

/women/dresses

For external requests, an identifier understood by merchandisers should be used.

mms-campaign-S2020

Sort orders¶

The sort parameter determines the applied sort order of the listing. All eligible sort orders are found in the Primary Listing response. Sort orders are sent as a query parameter with the id as the value which is one of the listed Sort types, sort=[id].

Request example¶

The following example illustrates a category page request with the sort order NEWEST_FIRST applied. Other request parameters have been omitted for brevity.

https://{cluster-id}.api.esales.apptus.cloud/api/storefront/v3/queries/landing-page?sort=NEWEST_FIRST