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
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
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 |
Curl Example
Request Body
Please refer to field descriptions in the POST Body above.
Example
Last updated