Unique identifier to associate the Athos account making the request to the database. This can be found on the My Account page in the Athos Management Console under the Account details section.

Query value will search the index for terms that match the query. Will support up to 256 characters.

If the cookie "athosUserId" is currently set, use the value as the userId value.

If it doesn't exist yet, generate a new ID and store it in the "athosUserId" cookie.

If the cookie "athosSessionIdNamespace" is currently set, use the value as the sessionId value.

If it doesn't exist yet, generate a new ID and store it in the "athosSessionIdNamespace" cookie.

Create a new ID for this parameter on every page load. If using a headless build create a new ID for this parameter on every URL route change.

If it doesn't exist yet, generate a new ID.

The full URL of the current page.

Will change how redirects behave in the API response.

• direct - will return a 302 and redirect a shopper to the returned URL within merchandising.redirect in the response. Direct is best for API integrations as it is the most performant.
• minimal - returns a partial API response without results data. Redirect URL will be returned in the merchandising object. If redirectResponse is not passed the default behavior is minimal.
• full - returns the full API response with results data. Redirect URL will be returned in the merchandising object.

Will allow the API to search the database for products that are a part of a configured landing page campaign.

Landing page campaign example: landing-page=black-friday

Will allow our API to search the database for products that are a part of a configured segmented merchandising campaign. To trigger a segmented merchandising campaign the value must follow this format, tag=merch.segment/[your-tag-here].

Segmented Merchandising campaign example: tag=merch.segment/logged-in-black-friday

Will allow you to specify specific facets you would like returned in the API response. The specified value passed must be the name of the facet field for it to be included. If the parameter is included, but the value is blank, facets will not be returned in the response.

Will allow you to remove a specified facet from the facets array returned in the API response. The specified value passed must be the name of the facet field for removal to function as expected.

Will disable inline banners from being returned in the API response.

Comma seperated list of product SKUs or UIDs that the customer has recently viewed. The most recently viewed product SKU or UID being at the front of the string of product SKUs or UIDs passed. This is required to allow personalization functionality to personalize products in search results as the customer navigates the site. To learn more about personalized search, please refer to this link for more information.

Comma seperated list of product SKUs or UIDs that are in the current customers cart. This is required to allow personalization functionality to personalize products in search results as the customer navigates the site. To learn more about personalized search, please refer to this link for more information.

ID of current logged-in shopper from your platform, this is required for personalization features. If the shopper is anonymous this should be omitted. To learn more about personalized search, please refer to this link for more information.

This header is required only for accounts that are making API requests within their server (server-side integration). \n\nIn order for requests to be properly handled pass the active customer's IP address to Athos as the value for this header.