Get product recommendations

Get product recommendations

get

https://athenix.bcserver.xyzhttps://api.athenix.ai

/v1/platform/{platformName}/shop/{platformShopId}/recommend/{recommenderType}

Path parameters

platformNamestring · enumRequired

platform name

Example: shopifyPossible values:

platformShopIdstringRequired

platform shop id

Example: 12345678

recommenderTypestring · enumRequired

recommendation type

Example: fbtPossible values:

Query parameters

pidstringRequired

product id to get recommend

Example: 123456789

vidstringOptional

variant id

Example: 2345677899

ex_pidstring[]Optional

exlcude product id that will not appear in recommend result

limitnumber · min: 1Optional

limit product recommendation return

Example: 3

Responses

200

Successful response

application/json

404

Not found response

application/json

500

Internal Server Error

application/json

get

/v1/platform/{platformName}/shop/{platformShopId}/recommend/{recommenderType}

HTTPcURLJavaScriptPython

GET /v1/platform/{platformName}/shop/{platformShopId}/recommend/{recommenderType}?pid=123456789 HTTP/1.1
Host: athenix.bcserver.xyz
Accept: */*

{
  "data": [
    {
      "id": "8126850957372",
      "handle": "10inch-anime-cute-digital-monster-digimon-koromon-soft-plush-toy-doll-pillow",
      "reviews": null,
      "variant": [
        "42879442321468"
      ]
    },
    {
      "id": "8126912856124",
      "handle": "2014-holiday-barbie-ornament-african-american",
      "reviews": null,
      "variant": []
    }
  ],
  "code": 200,
  "message": "",
  "error": "null"
}