v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Get Customer ID

Lets you fetch unique ID of a customer generated internally. This is required for customer related activities such as fetch customer details, update customer details, manage subscription details and other activities.

get/customers/lookup

Query parameters

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

Source on which the customer identifier is available.

accountIdstring

Account ID for sources with multiple accounts.

identifierName'mobile' | 'email' | 'externalId' | 'cardnumber' | 'wechat' | 'martjackId' | 'fbId' required

Identifier type used to identify the customer.

identifierValuestring required

Value of the specified identifierName.

Headers

X-CAP-API-OAUTH-TOKENstring

Response

200

OR

Example response

{
  "entity": 306
}