🟢API for Products Recommendation

This page contains description how to fetch products recommendation via API.

Product Recommendation Engine is a no-code feature to tailor Product Item suggestions to each user's unique skin analysis results.

What is Products Recommendation?

What can you do?

• List recommended products for image

---

List recommended products for image

Get recommended products for image

Get recommended products from the shelf products for the specified image.

GET/api/v1/companies/{company_id}/images/{image_id}/recommended_products/

Authorization

PrivateTokenAuthPasswordAuthcookieAuth

Path parameters

company_id*string (uuid)

image_id*string (uuid)

Query parameters

Response

200

Body

application/json

raw_resultRaw Result

recommended_productsRecommended Products

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/companies/{company_id}/images/{image_id}/recommended_products/?shelf_id=text', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200

{
  "recommended_products": []
}

First you need to create inventory items as described here. Then you need to create a shelf and populate it with your inventory items as described here and here.

After that you can use your product shelf ID in this API method to get products recommendations.