Create Recommendation

Create a recommendation algorithm and the relevant page the recommendation widget can be placed.

End Point

POST https://api.cartup.ai/v1/widget/custom

Headers

NameTypeDescription

Accept*

String

application/json

Content_type*

String

application/json

X-Cartup-Access-Token*

String

$CARTUP_API_KEY

X-Cartup-orgId *

String

$CARTUP_ORD_ID

Request Body

NameTypeDescription

name*

String

Name of the recommendation (need to be unique)

divisionId*

String

HTLM tag id (need to be unique)

orgID*

String

Your org ID

orgName*

String

You org name

algoName*

String

Recommendation type

widgetShowType*

String

Type of widget - carousel/matrix

displayTitle*

String

Title you want to display on your site

maxProducts*

Integer

Maximum products to be displayed in the widget

themeId*

String

UUID

pageId*

String

Page type you want to display

includeRules

JSON String

Include rules - please refer to Rules section

excludeRules

JSON String

Exclude rules - please refer to Rules section

{
    errMsg: null, 
    uid: "cd65e939-a48a-430b-b392-cf835efe2a04"
}

Curl Example

curl --request POST 'https://api.cartup.ai/v1/widget/custom'
--header 'Accept: application/json' \  
--header 'Content-Type: application/json' \  
--header 'X-Cartup-Access-Token : $CARTUP_API_KEY'
--header 'X-Cartup-orgId : $CARTUP_ORD_ID'
-d '{
  "name": "cartup-demo",
  "divisionId": "cartup-demo",
  "orgId": "8dbc90c4-ad66-48c4-9711-ce3065cfd189",
  "orgName": "freshcouture",
  "algoName": "Based On Wishlist",
  "widgetShowType": "carousel",
  "displayMode": "carousel",
  "displayTitle": "Demo for Cartup",
  "maxProducts": 20,
  "themeId": "7dd46eda-0d9f-4b9c-bafc-a3e154be8092",
  "pageMappings": {
    "pageMappingList": [
      {
        "pageId": "Home Page"
      },
      {
        "pageId": "Product Page"
      },
      {
        "pageId": "Cart Page"
      }
    ]
  },
  "includeRules": {
    "productPlacements": [],
    "rules": [],
    "categoryPlacements": []
  },
  "excludeRules": {
    "rules": [],
    "categoryPlacements": []
  },
  "timeZone": "America/Los_Angeles",
  "widgetTypes": [
    "wishlistreco"
  ]
}'

‌Request Body

Please refer to field descriptions in the POST Body above.

‌Example

{
  "name": "cartup-demo",
  "divisionId": "cartup-demo",
  "orgId": "8dbc90c4-ad66-48c4-9711-ce3065cfd189",
  "orgName": "freshcouture",
  "algoName": "Based On Wishlist",
  "widgetShowType": "carousel",
  "displayMode": "carousel",
  "displayTitle": "Demo for Cartup",
  "maxProducts": 20,
  "themeId": "7dd46eda-0d9f-4b9c-bafc-a3e154be8092",
  "pageMappings": {
    "pageMappingList": [
      {
        "pageId": "Home Page"
      },
      {
        "pageId": "Product Page"
      },
      {
        "pageId": "Cart Page"
      }
    ]
  },
  "includeRules": {
    "productPlacements": [],
    "rules": [],
    "categoryPlacements": []
  },
  "excludeRules": {
    "rules": [],
    "categoryPlacements": []
  },
  "timeZone": "America/Los_Angeles",
  "widgetTypes": [
    "wishlistreco"
  ]
}

Last updated