{"info":{"_postman_id":"5ab4c697-f5e2-41f4-9933-1edb08d528c1","name":"Personalized Recommendations Developers API","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"description":"","owner":"253760","collectionId":"5ab4c697-f5e2-41f4-9933-1edb08d528c1","publishedId":"T1DmFfG3","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"2B2D42","highlight":"8953B7"},"publishDate":"2020-07-21T19:22:47.000Z"},"item":[{"name":"Storefront Headless Setup","item":[{"name":"Recommendations - GET","id":"ff6d7b12-b13d-43d0-a0c2-df04c7559e99","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://recommendations.loopclub.io/v2/headless/recommendations/?shop=minimalism-t.myshopify.com&page=minimalism-t.myshopify.com/products/a-test-product/&is_preview=false&page_type=product_page&locale=en&product_id=4594018222183&customer_id=123141414&cart_product_ids=4593988632679,4594024153191&user_id=1213413r-123e12-2e1e12¤cy=USD&collection=all&cart_token=adajdaufaw121d812d","description":"

Field description and their possible values:

\n

page_type:

\n

This is used to determine which page a user is browsing. Following are the possible values:

\n

[\"product_page\", \"collection\", \"home\", \"cart\", \"order_confirm\", \"other\", \"blog\", \"ajax_cart\", \"404\"]

\n

collection:

\n

This is the collection slug a user is browsing. If it is a product page, then send the collection this product belongs to. In case of multiple collections, send the collection link using which this user landed on this product page.

\n

is_preview

\n

To render disabled widgets as well as live widgets.

\n

customer_id

\n

Shopify customer id.

\n

user_id

\n

PR visitor id to identify each user individually

\n","urlObject":{"protocol":"https","path":["v2","headless","recommendations",""],"host":["recommendations","loopclub","io"],"query":[{"key":"shop","value":"minimalism-t.myshopify.com"},{"key":"page","value":"minimalism-t.myshopify.com/products/a-test-product/"},{"key":"is_preview","value":"false"},{"key":"page_type","value":"product_page"},{"key":"locale","value":"en"},{"key":"product_id","value":"4594018222183"},{"key":"customer_id","value":"123141414"},{"key":"cart_product_ids","value":"4593988632679,4594024153191"},{"key":"user_id","value":"1213413r-123e12-2e1e12"},{"key":"currency","value":"USD"},{"key":"collection","value":"all"},{"key":"cart_token","value":"adajdaufaw121d812d"}],"variable":[]}},"response":[],"_postman_id":"ff6d7b12-b13d-43d0-a0c2-df04c7559e99"},{"name":"Recommendations - POST","id":"52c19ead-953b-4671-9765-11f4fb4f95bb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"page","value":"minimalism-t.myshopify.com/products/a-test-product/","type":"text"},{"key":"is_preview","value":"false","type":"text"},{"key":"page_type","value":"product_page","type":"text"},{"key":"locale","value":"en","type":"text"},{"key":"product_id","value":"4594018222183","type":"text"},{"key":"customer_id","value":"123141414","type":"text"},{"key":"cart_product_ids","value":"4593988632679,4594024153191","type":"text"},{"key":"user_id","value":"1213413r-123e12-2e1e12","type":"text"},{"key":"currency","value":"USD","type":"text"},{"key":"collection","value":"all","type":"text"},{"key":"cart_token","value":"adajdaufaw121d812d","type":"text"}]},"url":"https://recommendations.loopclub.io/v2/headless/recommendations/?shop=minimalism-t.myshopify.com","urlObject":{"protocol":"https","path":["v2","headless","recommendations",""],"host":["recommendations","loopclub","io"],"query":[{"key":"shop","value":"minimalism-t.myshopify.com"}],"variable":[]}},"response":[],"_postman_id":"52c19ead-953b-4671-9765-11f4fb4f95bb"},{"name":"Identify - GET","id":"074d4ce9-1f13-4e59-af43-197a8da09a88","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://recommendations.loopclub.io/v2/headless/identify/?shop=minimalism-t.myshopify.com&user_id=abcif4-kdfhcnfd-suf73la&locale=en&customer_id=47565394","urlObject":{"protocol":"https","path":["v2","headless","identify",""],"host":["recommendations","loopclub","io"],"query":[{"key":"shop","value":"minimalism-t.myshopify.com"},{"key":"user_id","value":"abcif4-kdfhcnfd-suf73la"},{"key":"locale","value":"en"},{"key":"customer_id","value":"47565394"}],"variable":[]}},"response":[],"_postman_id":"074d4ce9-1f13-4e59-af43-197a8da09a88"},{"name":"Identify - POST","id":"7c7b8b8b-3c5d-404a-bc39-e9a5e01d8e3f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"user_id","value":"abcif4-kdfhcnfd-suf73la","type":"text"},{"key":"locale","value":"en","type":"text"},{"key":"customer_id","value":"47565394","type":"text"}]},"url":"https://recommendations.loopclub.io/v2/headless/identify/?shop=minimalism-t.myshopify.com","urlObject":{"protocol":"https","path":["v2","headless","identify",""],"host":["recommendations","loopclub","io"],"query":[{"key":"shop","value":"minimalism-t.myshopify.com"}],"variable":[]}},"response":[],"_postman_id":"7c7b8b8b-3c5d-404a-bc39-e9a5e01d8e3f"},{"name":"Send Events","id":"d1c2c2d2-542b-4348-a311-2d2dc7710695","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"events\": [\n {\n \"recommendation_type\": \"bought_together\",\n \"widget_id\": 2,\n \"widget_server_id\": \"\",\n \"event_type\": \"clicked\",\n \"data\": {},\n \"location\": null,\n \"triggered_at\": null,\n \"visit_id\": \"\",\n \"page_id\": 1,\n \"product_id\": null,\n \"page_type\": \"home\", \n \"user_id\": \"adasdsa\",\n \"customer_id\": null,\n \"cart_token\": null\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://recommendations.loopclub.io/v2/headless/events/?shop=minimalism-t.myshopify.com","description":"

Following are the events that should be supported

\n\n","urlObject":{"protocol":"https","path":["v2","headless","events",""],"host":["recommendations","loopclub","io"],"query":[{"key":"shop","value":"minimalism-t.myshopify.com"}],"variable":[]}},"response":[],"_postman_id":"d1c2c2d2-542b-4348-a311-2d2dc7710695"},{"name":"Query Raw Recommendations","id":"eacefbdd-ca38-4580-ad0c-d1466a87329d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"queries\": [\n {\n \"id\": \"query1\",\n \"max_recommendations\": 5,\n \"product_ids\": [\n 4594116165735\n ],\n \"recommendation_type\": \"bought_together\"\n }\n ]\n}"},"url":"https://recommendationsapi.loopclub.io/v2/headless/query/?shop=minimalism-t.myshopify.com","urlObject":{"protocol":"https","path":["v2","headless","query",""],"host":["recommendationsapi","loopclub","io"],"query":[{"key":"shop","value":"minimalism-t.myshopify.com"}],"variable":[]}},"response":[],"_postman_id":"eacefbdd-ca38-4580-ad0c-d1466a87329d"}],"id":"0232b950-373c-4d2b-9372-c1cf1081997f","_postman_id":"0232b950-373c-4d2b-9372-c1cf1081997f","description":""},{"name":"Client APIs","item":[{"name":"GET Integration Detail","id":"2f664dcf-86c1-4d58-94cf-1204a8602118","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-SHOP","value":"mystore.myshopify.com"},{"key":"X-CLIENT","type":"text","value":"client-id"},{"key":"X-ACCESS-TOKEN","type":"text","value":"access-token"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://recommendations.loopclub.io/api/v1/integrations/","urlObject":{"protocol":"https","path":["api","v1","integrations",""],"host":["recommendations","loopclub","io"],"query":[],"variable":[]}},"response":[{"id":"2a455913-de59-4da0-abd0-8d0a3acebd85","name":"Integration not enabled","originalRequest":{"method":"GET","header":[{"key":"X-SHOP","value":"mystore.myshopify.com"},{"key":"X-CLIENT","type":"text","value":"client-id"},{"key":"X-ACCESS-TOKEN","type":"text","value":"access-token"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"https://recommendations.loopclub.io/api/v1/integrations/"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Sun, 08 Dec 2019 16:29:46 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Allow","value":"GET, HEAD, OPTIONS"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"false"},{"key":"Access-Control-Allow-Methods","value":"GET,HEAD,OPTIONS,POST,PUT,DELETE"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Access-Control-Allow-Headers","value":"x-csrftoken, Origin, X-Requested-With, Content-Type, Accept, Authorization, X-RecommendationKit-UserId"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": \"Merchant has not enabled the integration.\"\n}"},{"id":"a5db607f-87e4-4ae2-8f33-730d18e38ea5","name":"Personalized Recommendations Not Installed","originalRequest":{"method":"GET","header":[{"key":"X-SHOP","value":"mystore.myshopify.com"},{"key":"X-CLIENT","type":"text","value":"client-id"},{"key":"X-ACCESS-TOKEN","type":"text","value":"access-token"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"https://recommendations.loopclub.io/api/v1/integrations/"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Sun, 08 Dec 2019 16:28:42 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Allow","value":"GET, HEAD, OPTIONS"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"false"},{"key":"Access-Control-Allow-Methods","value":"GET,HEAD,OPTIONS,POST,PUT,DELETE"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Access-Control-Allow-Headers","value":"x-csrftoken, Origin, X-Requested-With, Content-Type, Accept, Authorization, X-RecommendationKit-UserId"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": \"Unauthorized\"\n}"},{"id":"eb2678d9-ac61-4dc0-8189-d45cb6416bb6","name":"Integration Enabled","originalRequest":{"method":"GET","header":[{"key":"X-SHOP","value":"mystore.myshopify.com"},{"key":"X-CLIENT","type":"text","value":"client-id"},{"key":"X-ACCESS-TOKEN","type":"text","value":"access-token"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"https://recommendations.loopclub.io/api/v1/integrations/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Sun, 08 Dec 2019 16:27:57 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"16"},{"key":"Allow","value":"GET, HEAD, OPTIONS"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"false"},{"key":"Access-Control-Allow-Methods","value":"GET,HEAD,OPTIONS,POST,PUT,DELETE"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Access-Control-Allow-Headers","value":"x-csrftoken, Origin, X-Requested-With, Content-Type, Accept, Authorization, X-RecommendationKit-UserId"}],"cookie":[],"responseTime":null,"body":"{\n \"enabled\": true\n}"}],"_postman_id":"2f664dcf-86c1-4d58-94cf-1204a8602118"},{"name":"GET Cross Recommendations","id":"bc839f20-3440-44bb-9413-3013432c55e8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-SHOP","value":"mystore.myshopify.com"},{"key":"X-CLIENT","value":"client-id","type":"text"},{"key":"X-ACCESS-TOKEN","value":"access-token","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"queries\": [\n\t\t{\n\t\t\t\"id\": \"query1\",\n\t\t\t\"recommendation_type\": \"cross_sell\",\n\t\t\t\"max_recommendations\": 8,\n\t\t\t\"product_ids\": [123]\n\t\t}\n\t]\n}"},"url":"https://recommendations.loopclub.io/api/v1/recommendations/","urlObject":{"protocol":"https","path":["api","v1","recommendations",""],"host":["recommendations","loopclub","io"],"query":[],"variable":[]}},"response":[{"id":"59988af6-d606-483e-aff1-56582ff29c20","name":" Recommendations","originalRequest":{"method":"POST","header":[{"key":"X-SHOP","value":"mystore.myshopify.com"},{"key":"X-CLIENT","value":"client-id","type":"text"},{"key":"X-ACCESS-TOKEN","value":"access-token","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"queries\": [\n\t\t{\n\t\t\t\"id\": \"query1\",\n\t\t\t\"recommendation_type\": \"cross_sell\",\n\t\t\t\"max_recommendations\": 8,\n\t\t\t\"product_ids\": [3935777947690]\n\t\t}\n\t]\n}"},"url":"https://recommendations.loopclub.io/api/v1/recommendations/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Sun, 08 Dec 2019 16:34:07 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Allow","value":"POST, OPTIONS"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"false"},{"key":"Access-Control-Allow-Methods","value":"GET,HEAD,OPTIONS,POST,PUT,DELETE"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Access-Control-Allow-Headers","value":"x-csrftoken, Origin, X-Requested-With, Content-Type, Accept, Authorization, X-RecommendationKit-UserId"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"request_serve_id\": \"2c224867-408a-4c5c-b669-2611aa3a6933\",\n \"query1\": {\n \"query_serve_id\": \"d2d4f58c-a1c9-4d83-95da-7b87d8a5542b\",\n \"products\": [\n {\n \"product_id\": 3935779094570\n },\n {\n \"product_id\": 3935779061802\n },\n {\n \"product_id\": 3935779160106\n },\n {\n \"product_id\": 3935779127338\n },\n {\n \"product_id\": 3935779291178\n },\n {\n \"product_id\": 3935777652778\n },\n {\n \"product_id\": 3935777914922\n },\n {\n \"product_id\": 3935819235370\n }\n ]\n }\n}"}],"_postman_id":"bc839f20-3440-44bb-9413-3013432c55e8"},{"name":"GET Similar Recommendations","id":"4a0aa8f9-51e7-448f-94c9-f750b1afbe6c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-SHOP","value":"mystore.myshopify.com"},{"key":"X-CLIENT","type":"text","value":"client-id"},{"key":"X-ACCESS-TOKEN","type":"text","value":"access-token"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"queries\": [\n\t\t{\n\t\t\t\"id\": \"query1\",\n\t\t\t\"recommendation_type\": \"similar_products\",\n\t\t\t\"max_recommendations\": 8,\n\t\t\t\"product_ids\": [123]\n\t\t}\n\t]\n}"},"url":"https://recommendations.loopclub.io/api/v1/recommendations/","urlObject":{"protocol":"https","path":["api","v1","recommendations",""],"host":["recommendations","loopclub","io"],"query":[],"variable":[]}},"response":[{"id":"8aa215bc-8ab3-4cae-8c90-5da3ca55e9cd","name":" Recommendations","originalRequest":{"method":"POST","header":[{"key":"X-SHOP","value":"mystore.myshopify.com"},{"key":"X-CLIENT","value":"client-id","type":"text"},{"key":"X-ACCESS-TOKEN","value":"access-token","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"queries\": [\n\t\t{\n\t\t\t\"id\": \"query1\",\n\t\t\t\"recommendation_type\": \"similar_products\",\n\t\t\t\"max_recommendations\": 8,\n\t\t\t\"product_ids\": [3935777947690]\n\t\t}\n\t]\n}"},"url":"https://recommendations.loopclub.io/api/v1/recommendations/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Sun, 08 Dec 2019 16:34:07 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Allow","value":"POST, OPTIONS"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"false"},{"key":"Access-Control-Allow-Methods","value":"GET,HEAD,OPTIONS,POST,PUT,DELETE"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Access-Control-Allow-Headers","value":"x-csrftoken, Origin, X-Requested-With, Content-Type, Accept, Authorization, X-RecommendationKit-UserId"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"request_serve_id\": \"2c224867-408a-4c5c-b669-2611aa3a6933\",\n \"query1\": {\n \"query_serve_id\": \"d2d4f58c-a1c9-4d83-95da-7b87d8a5542b\",\n \"products\": [\n {\n \"product_id\": 3935779094570\n },\n {\n \"product_id\": 3935779061802\n },\n {\n \"product_id\": 3935779160106\n },\n {\n \"product_id\": 3935779127338\n },\n {\n \"product_id\": 3935779291178\n },\n {\n \"product_id\": 3935777652778\n },\n {\n \"product_id\": 3935777914922\n },\n {\n \"product_id\": 3935819235370\n }\n ]\n }\n}"}],"_postman_id":"4a0aa8f9-51e7-448f-94c9-f750b1afbe6c"},{"name":"GET Bought Together Recommendations","id":"59b7fe21-5190-4049-b8fc-522699aa344a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-SHOP","value":"mystore.myshopify.com"},{"key":"X-CLIENT","type":"text","value":"client-id"},{"key":"X-ACCESS-TOKEN","type":"text","value":"access-token"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"queries\": [\n\t\t{\n\t\t\t\"id\": \"query1\",\n\t\t\t\"recommendation_type\": \"bought_together\",\n\t\t\t\"max_recommendations\": 8,\n\t\t\t\"product_ids\": [3935777947690]\n\t\t}\n\t]\n}"},"url":"https://recommendations.loopclub.io/api/v1/recommendations/","urlObject":{"protocol":"https","path":["api","v1","recommendations",""],"host":["recommendations","loopclub","io"],"query":[],"variable":[]}},"response":[{"id":"413eaca0-ac24-4175-b8c1-3f326189e02d","name":" Recommendations","originalRequest":{"method":"POST","header":[{"key":"X-SHOP","value":"mystore.myshopify.com"},{"key":"X-CLIENT","value":"client-id","type":"text"},{"key":"X-ACCESS-TOKEN","value":"access-token","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"queries\": [\n\t\t{\n\t\t\t\"id\": \"query1\",\n\t\t\t\"recommendation_type\": \"bought_together\",\n\t\t\t\"max_recommendations\": 8,\n\t\t\t\"product_ids\": [3935777947690]\n\t\t}\n\t]\n}"},"url":"https://recommendations.loopclub.io/api/v1/recommendations/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Sun, 08 Dec 2019 16:34:07 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Allow","value":"POST, OPTIONS"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"false"},{"key":"Access-Control-Allow-Methods","value":"GET,HEAD,OPTIONS,POST,PUT,DELETE"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Access-Control-Allow-Headers","value":"x-csrftoken, Origin, X-Requested-With, Content-Type, Accept, Authorization, X-RecommendationKit-UserId"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"request_serve_id\": \"2c224867-408a-4c5c-b669-2611aa3a6933\",\n \"query1\": {\n \"query_serve_id\": \"d2d4f58c-a1c9-4d83-95da-7b87d8a5542b\",\n \"products\": [\n {\n \"product_id\": 3935779094570\n },\n {\n \"product_id\": 3935779061802\n },\n {\n \"product_id\": 3935779160106\n },\n {\n \"product_id\": 3935779127338\n },\n {\n \"product_id\": 3935779291178\n },\n {\n \"product_id\": 3935777652778\n },\n {\n \"product_id\": 3935777914922\n },\n {\n \"product_id\": 3935819235370\n }\n ]\n }\n}"}],"_postman_id":"59b7fe21-5190-4049-b8fc-522699aa344a"},{"name":"GET Trending Recommendations","id":"2b9531cb-62e5-4f92-900f-70b1e3415239","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-SHOP","value":"mystore.myshopify.com"},{"key":"X-CLIENT","type":"text","value":"client-id"},{"key":"X-ACCESS-TOKEN","type":"text","value":"access-token"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"queries\": [\n\t\t{\n\t\t\t\"id\": \"query1\",\n\t\t\t\"recommendation_type\": \"trending\",\n\t\t\t\"max_recommendations\": 8\n\t\t}\n\t]\n}"},"url":"https://recommendations.loopclub.io/api/v1/recommendations/","urlObject":{"protocol":"https","path":["api","v1","recommendations",""],"host":["recommendations","loopclub","io"],"query":[],"variable":[]}},"response":[{"id":"0c942108-4853-434d-b8e7-897bbef232fc","name":" Recommendations","originalRequest":{"method":"POST","header":[{"key":"X-SHOP","value":"mystore.myshopify.com"},{"key":"X-CLIENT","value":"client-id","type":"text"},{"key":"X-ACCESS-TOKEN","value":"access-token","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"queries\": [\n\t\t{\n\t\t\t\"id\": \"query1\",\n\t\t\t\"recommendation_type\": \"trending\",\n\t\t\t\"max_recommendations\": 8\n\t\t}\n\t]\n}"},"url":"https://recommendations.loopclub.io/api/v1/recommendations/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Sun, 08 Dec 2019 16:34:07 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Allow","value":"POST, OPTIONS"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"false"},{"key":"Access-Control-Allow-Methods","value":"GET,HEAD,OPTIONS,POST,PUT,DELETE"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Access-Control-Allow-Headers","value":"x-csrftoken, Origin, X-Requested-With, Content-Type, Accept, Authorization, X-RecommendationKit-UserId"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"request_serve_id\": \"2c224867-408a-4c5c-b669-2611aa3a6933\",\n \"query1\": {\n \"query_serve_id\": \"d2d4f58c-a1c9-4d83-95da-7b87d8a5542b\",\n \"products\": [\n {\n \"product_id\": 3935779094570\n },\n {\n \"product_id\": 3935779061802\n },\n {\n \"product_id\": 3935779160106\n },\n {\n \"product_id\": 3935779127338\n },\n {\n \"product_id\": 3935779291178\n },\n {\n \"product_id\": 3935777652778\n },\n {\n \"product_id\": 3935777914922\n },\n {\n \"product_id\": 3935819235370\n }\n ]\n }\n}"}],"_postman_id":"2b9531cb-62e5-4f92-900f-70b1e3415239"},{"name":"GET Bestseller Recommendations","id":"53123fe1-a795-477a-8380-b08ee37a1b48","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-SHOP","value":"mystore.myshopify.com"},{"key":"X-CLIENT","type":"text","value":"client-id"},{"key":"X-ACCESS-TOKEN","type":"text","value":"access-token"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"queries\": [\n\t\t{\n\t\t\t\"id\": \"query1\",\n\t\t\t\"recommendation_type\": \"bestsellers\",\n\t\t\t\"max_recommendations\": 8\n\t\t}\n\t]\n}"},"url":"https://recommendations.loopclub.io/api/v1/recommendations/","urlObject":{"protocol":"https","path":["api","v1","recommendations",""],"host":["recommendations","loopclub","io"],"query":[],"variable":[]}},"response":[{"id":"59d40e97-4ccc-4baf-b2df-6890e62b00cc","name":" Recommendations","originalRequest":{"method":"POST","header":[{"key":"X-SHOP","value":"mystore.myshopify.com"},{"key":"X-CLIENT","value":"client-id","type":"text"},{"key":"X-ACCESS-TOKEN","value":"access-token","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"queries\": [\n\t\t{\n\t\t\t\"id\": \"query1\",\n\t\t\t\"recommendation_type\": \"bestsellers\",\n\t\t\t\"max_recommendations\": 8\n\t\t}\n\t]\n}"},"url":"https://recommendations.loopclub.io/api/v1/recommendations/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Sun, 08 Dec 2019 16:34:07 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Allow","value":"POST, OPTIONS"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"false"},{"key":"Access-Control-Allow-Methods","value":"GET,HEAD,OPTIONS,POST,PUT,DELETE"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Access-Control-Allow-Headers","value":"x-csrftoken, Origin, X-Requested-With, Content-Type, Accept, Authorization, X-RecommendationKit-UserId"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"request_serve_id\": \"2c224867-408a-4c5c-b669-2611aa3a6933\",\n \"query1\": {\n \"query_serve_id\": \"d2d4f58c-a1c9-4d83-95da-7b87d8a5542b\",\n \"products\": [\n {\n \"product_id\": 3935779094570\n },\n {\n \"product_id\": 3935779061802\n },\n {\n \"product_id\": 3935779160106\n },\n {\n \"product_id\": 3935779127338\n },\n {\n \"product_id\": 3935779291178\n },\n {\n \"product_id\": 3935777652778\n },\n {\n \"product_id\": 3935777914922\n },\n {\n \"product_id\": 3935819235370\n }\n ]\n }\n}"}],"_postman_id":"53123fe1-a795-477a-8380-b08ee37a1b48"},{"name":"Create Events","id":"036bbf91-b8af-4c62-a7e9-be9b24c65c12","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-SHOP","value":"mystore.myshopify.com"},{"key":"X-CLIENT","type":"text","value":"client-id"},{"key":"X-ACCESS-TOKEN","type":"text","value":"access-token"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"events\": [\n \t {\n \"query_serve_id\": \"1234\",\n \"request_serve_id\": \"1232311\",\n \"recommendation_type\": \"similar_products\",\n \"event_type\": \"viewed\",\n \"triggered_at\": 1580879321\n },\n {\n \"query_serve_id\": \"1234\",\n \"request_serve_id\": \"1232311\",\n \"recommendation_type\": \"similar_products\",\n \"event_type\": \"clicked\",\n \"triggered_at\": 1580879321\n }\n ]\n}"},"url":"https://recommendations.loopclub.io/api/v1/events/","description":"

Following are the events that should be supported

\n
    \n
  1. ppv -> When a user visits a page.
    2. \n
  2. rendered -> When a widget is rendered on the page
    3. \n
  3. viewed -> When a widget is viewed by a user
    4. \n
  4. clicked -> When a product is clicked within a widget
    5. \n
  5. addtocart -> When Add To Cart button is clicked within a store.
    6. \n
\n

query_serve_id, request_serve_id and recommendation_type will be the same that you get in recommendation response.

\n","urlObject":{"protocol":"https","path":["api","v1","events",""],"host":["recommendations","loopclub","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"036bbf91-b8af-4c62-a7e9-be9b24c65c12"}],"id":"0290914c-62f4-49da-b65b-a06b0a01e37f","_postman_id":"0290914c-62f4-49da-b65b-a06b0a01e37f","description":""},{"name":"Widgets APIs","item":[{"name":"Get widgets","id":"77cccb4c-26ff-4181-9f74-1e7b4b8041ad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-SHOP","value":"mystore.myshopify.com"},{"key":"X-CLIENT","type":"text","value":"client-id"},{"key":"X-ACCESS-TOKEN","type":"text","value":"access-token"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"page_type\": \"home\",\n \"user_id\": \"123131\",\n \"customer_id\": \"123\",\n \"product_id\": 123,\n \"page\": \"app://products/123\",\n \"cart_token\": \"123456778\",\n \"collection\": \"mens-tshirts\",\n \"cart_product_ids\": \"12345,6789,01234\"\n}"},"url":"https://recommendations.loopclub.io/api/v1/widgets/","description":"

Using this API you can fetch all the widgets along with the recommended products for a particular shop and page.

\n","urlObject":{"protocol":"https","path":["api","v1","widgets",""],"host":["recommendations","loopclub","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"77cccb4c-26ff-4181-9f74-1e7b4b8041ad"},{"name":"Create Widget Events","id":"565f2b9a-f221-4569-90d6-9d027a156218","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-SHOP","value":"mystore.myshopify.com"},{"key":"X-CLIENT","type":"text","value":"client-id"},{"key":"X-ACCESS-TOKEN","type":"text","value":"access-token"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"events\": [\n {\n \"recommendation_type\": \"bought_together\",\n \"widget_id\": 2,\n \"widget_server_id\": \"\",\n \"event_type\": \"clicked\",\n \"data\": {},\n \"location\": null,\n \"triggered_at\": null,\n \"visit_id\": \"\",\n \"page_id\": 1,\n \"product_id\": null,\n \"page_type\": \"home\", \n \"user_id\": \"adasdsa\",\n \"customer_id\": null,\n \"cart_token\": null\n }\n ]\n}"},"url":"https://recommendations.loopclub.io/api/v1/widgets/events/","description":"

Following are the events that should be supported

\n
    \n
  1. viewed -> When a widget is viewed by a user
    2. \n
  2. clicked -> When a product is clicked within a widget
    3. \n
  3. addtocart -> When Add To Cart button is clicked within a store.
    4. \n
\n

vsit_id is same as request_serve_id you get in widget response.\nRest of the parameters are also present in the response of widgets API.

\n","urlObject":{"protocol":"https","path":["api","v1","widgets","events",""],"host":["recommendations","loopclub","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"565f2b9a-f221-4569-90d6-9d027a156218"}],"id":"68df1778-9fb3-4b6f-bf50-888155ecb07c","_postman_id":"68df1778-9fb3-4b6f-bf50-888155ecb07c","description":""},{"name":"Product Search","item":[{"name":"Product Suggest API","id":"b90801aa-c73d-4280-a43e-793d331955b5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://recommendations.loopclub.io/v2/storefront/search/suggest/?shop=minimalism-t.myshopify.com&user_id=abcif4-kdfhcnfd-suf73la&locale=en&customer_id=47565394&q=top","urlObject":{"protocol":"https","path":["v2","storefront","search","suggest",""],"host":["recommendations","loopclub","io"],"query":[{"key":"shop","value":"minimalism-t.myshopify.com"},{"key":"user_id","value":"abcif4-kdfhcnfd-suf73la"},{"key":"locale","value":"en"},{"key":"customer_id","value":"47565394"},{"key":"q","value":"top"}],"variable":[]}},"response":[],"_postman_id":"b90801aa-c73d-4280-a43e-793d331955b5"}],"id":"30a4a517-6146-4ec8-8962-2f79bfb23596","description":"

Product Search API is used for looking up most relevant products based on the provided search term.

\n

You can also manually override the search results from the dashboard.

\n","_postman_id":"30a4a517-6146-4ec8-8962-2f79bfb23596"}]}