Get Recommendation

Get the recommendation information based on the division ID.

End Point

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

Query Parameters

Name	Type	Description
request*	String	Request Object (Refer below)

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

200: OK

{
    errMsg: null,
    customWidgets: [{
        id: "cd65e939-a48a-430b-b392-cf835efe2a04",
        name: "test123",
        description: null,
        displayTitle: "test123",
        divisionId: "test123",
        orgId: "850a8b8f-a6fe-49e4-88fc-874843279d66",
        orgName: "WorldMarts",
        themeId: "fa23ac55-493b-4699-bcbf-3eebcd8ebd0d",
        minProducts: null,
        maxProducts: 10,
        duration: {
            startDate: null,
            endDate: null
        },
        widgetTypes: ["trending"],
        skipAnchorProduct: false,
        timeZone: "Asia/Calcutta",
        displayMode: "carousel",
        pageMappings: {
            pageMappingList: [{
                pageId: "Home Page",
                themeId: null
            }]
        },
        includeRules: {
            customValues: null,
            bundledProductPlacements: [],
            productPlacements: [],
            categoryPlacements: [],
            rules: [],
            constraints: [],
            pageMeta: null
        },
        excludeRules: {
            rules: [],
            categoryPlacements: []
        }
    }]
}

400: Bad Request

{
    "errMsg": "request json is not present in request params",
    "customWidgets": null
}

‌

Curl Example

curl --request GET 'https://api.cartup.ai/v1/widget/custom?request={"orgId":"8dbc90c4-ad66-48c4-9711-ce3065cf","orgName":"store","divisionId":"Content_Jogger_PDP_Freshcouture"}'
--header 'Accept: application/json' \  
--header 'Content-Type: application/json' \  
--header 'X-Cartup-Access-Token: $CARTUP_API_KEY'
--header 'X-Cartup-orgId : $CARTUP_ORD_ID'

​

Request Object

Key	Type	Description	Required
orgId	String	Your Org ID	Yes
divisionId	String	HTML Tag ID	Yes
orgName	String	Your Org Name	Yes

Example

{
  "orgId": "850a8b8f-a6fe-49e4-88fc-874843279d66",
  "divisionId": "test123",
  "orgName": "WorldMarts"
}

‌

‌