The Complete the Look API takes a product ID or other identifying information and returns a list of looks. It can be called directly from your servers or via the browser through JavaScript. It returns complete display information to show products.
The API supports the passage of the current product's state via real-time updates for rapidly changing product information like stock level and sale status. Relevant parameters are required on PDP views to maintain up-to-date, accurate product information if relying solely on API integration. However, these parameters are optional for requests coming from background jobs or secondary integrations like email campaigns.
You will find comprehensive syntactical examples at the bottom of this article.
<https://api.findmine.com/api/v3/complete-the-look>
Get
In JavaScript browser integrations, the GET method provides significantly faster responses by avoiding slow browser cross-origin security checking requests. All API parameters are passed as HTTP GET arguments.
Post
For other integrations, the POST method may be preferable. Posts must be content-type: application/json and the passed data must be in JSON format. Otherwise, all parameter names and semantics remain the same. The responses are plain JSON.
| Parameter | Required | Type | Description |
|---|---|---|---|
| application | Yes | String | The application parameter is a unique identifier provided to you at the start of integration. This identifier is not an authorization secret, it is safe and required to embed in your public HTML. Example: **application=AB1212CDABCD |
| product_* | Yes | String(s) | Product identifying information. One or more strings that uniquely identify each visually distinct product, most often a product identifier and a color identifier. The exact parameter names will be configured for your integration during onboarding, and reflect the specific product variation structure of your catalog. These parameters must match identifiers in the product catalog feed exactly. Example: **product_id=P-12&product_color_id=C-34 |
Example: product_id=P-12 |
|||
Example: product_id=P-12&product_color_id=C-34&product_pattern=stripe |
|||
| return_pdp_item | No | Boolean | Example*:* return_pdp_item=true |
| Parameter | Required | Type | Description |
|---|---|---|---|
| product_in_stock | Yes | Boolean | Is the product in stock and available for purchase? true if in stock and available for purchase. false if out of stock or otherwise unavailable for purchase. Example: **product_in_stock=false |
| product_on_sale | Yes | Boolean | Is the product currently on sale? true if an original price and discounted price are being shown, false if the product is still at the original price. |
| Parameter | Required | Type | Description |
|---|---|---|---|
| customer_session_id | Yes | String | The session ID your website uses for analytics tracking of your customers. Providing this value to the API enables our analytics system to accurately match your internal analytics systems, and reports generated by FindMine will more closely track with internal numbers. Example: **customer_session_id=FD041FE1986C4C47FEE1 |
| customer_id | No* | String | The logged-in user id of a customer, when available. This information can be used for targeted outfits based on prior purchase data, and enables more FindMine reporting capabilities.This should be a durable, cross-device identifier for a customer such as an external ID from your ecommerce platform that represents a logged in user. Do not send PII in this string.* - While this identifier is not required, this parameter is valuable for analytics and learning algorithms. Example: **customer_id=129428 |
| customer_gender | No | String | `"M" |
"M": Return Men's looks. |
|||
"W": Return Women's looks. |
|||
"U": Customer gender unknown, Findmine will infer gender from product information where applicable. Example: customer_gender=W |
|||
| region | No* | String | Two letter ISO Country code.* - required for multi-region implementations. Example: region=us |
| language | No* | String | Two letter ISO language code.* - required for multi-language implementations. Example: language=en |
At a high level, the Complete the Look API returns a list of generated looks, each look contains a look_id and a list of items. Each item in the items list has common product display information: item_id, title, item_url, image_url and price. Your integration may include other data points as necessary, such as advanced details data. Successful requests will have a top level "result": "success" property.