Preflight API

post

https://{siteId}.a.athoscommerce.net/v1/preflight

If your account is configured to utilize Personalized Search & Merchandising, this endpoint is required to feed into the feature. In the integration, the moment the data points for "shopper", "cart", or "lastViewed" query string parameters are assigned a value, a Preflight request will need to be sent before a request to the Autocomplete or Search API endpoint is sent. The POST method will support more than 2048, if there are less characters use the GET method.

Body Params

siteId

string

required

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.

userId

string

required

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.

shopper

string

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.

cart

string

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.

lastViewed

string

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.

Responses

200

204

Returned when personalization is not setup in the account settings.

400

If the siteId, userId, or shopper query string parameters are not passed this error code will be returned. If siteId or shopper are not passed the message will be "ShopperContext is invalid". If userId is not passed the message will be "Missing UserID".