Sign in

v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Get Customer Recommendations

Retrieves the SKUs and product recommendation details for a customer.

get/customers/lookup/recommendations

Query parameters

source'FACEBOOK' | 'WEB_ENGAGE' | 'WECHAT' | 'INSTORE' | 'MARTJACK' | 'TMALL' | 'TAOBAO' | 'JD' | 'ECOMMERCE' | 'WEBSITE' | 'LINE' | 'MOBILE_APP' required

Source in which the customer identifier is available.

accountIdstring

Account in which the customer details are available (Required only for sources with multiple accounts).

identifierName'mobile' | 'email' | 'externalId' | 'cardExternalId' | 'cardNumber' required

Identifier type used for the customer.

identifierValuestring required

Value of the respective identifier. For example if identifierName is email, then the identifierValue needs to be the email ID of the customer.

Headers

X-CAP-API-OAUTH-TOKENstring

Response

200

countinteger

Example response

{
  "customer": {
    "id": 399012826,
    "source": "INSTORE",
    "type": "LOYALTY",
    "identifierHash": "customer_~~MOBILE:null~~~~EXTERNAL_ID:null~~~~EMAIL:null~~~~ID:399012826~~~~CARD_NUMBER:null~~~~CARD_EXTERNAL_ID:null~~",
    "campaignUser": true
  }
}