A customer is an individual who purchases goods/services, or subscribes to the organization’s newsletters. An organization refers to a store, business firm, hospital or restaurant.

Based on the registration status, customers are categorized into three types:

  • Loyalty customers: Customers who have registered into the organization’s loyalty program
  • Non-loyalty customers: Customers who have subscribed (mobile number or email id) to organization’s newsletter to receive campaign/transaction messages but not enrolled into the organization’s loyalty program
  • Not-interested or anonymous customers: Customers who have neither enrolled in the loyalty program nor subscribed to the organization’s newsletter

The customer entity contains APIs related to registering customers into the loyalty program, managing loyalty accounts and updating subscription status of both registered and non-registered customers. It stores customer related information such as identifiers, profile details, custom field details, transactions, preferences, subscription details (mobile number/email id), tier details, points history and coupons history.

Customer APIs allow you to do the following -

  • Register customers into your organization’s loyalty program
  • Update loyalty customers’ profile information
  • Update primary or secondary identifiers (mobile no, email id, or external id)
  • Retrieve customer details of loyalty and non-loyalty customers
  • Capture complaints and feedback of loyalty customers
  • Add, update and retrieve customer preferences of loyalty customers
  • Retrieve transactions of loyalty/non-loyalty customers

Response Codes

Success Codes

1000Customer registered successfully.
Customer retrieved successfully.
Subscription updated successfully.
Subscription retrieved successfully
Customer updated successfully.
Coupons retrieved successfully.
Customer notes added/updated successfully
Customer notes retrieved successfully
Customer preferences retrieved successfully.
Customer preferences updated successfully.
1000Referral statistics retrieved successfully
Referrals are invited successfully
1040Customer id change request has submitted successfully
1061Customer recommendations fetched successfully
1052Transactions fetched successfully
1300Ticket retrieved successfully
Ticket added successfully

Error Codes

500All requests failed due to errors.
400Input is invalid. Please check request parameters or input xml/json; No identifier provided to get loyalty users.
618Not allowed - customer is marked as fraud.
816Customer not found for organization.
1001Unable to register. Invalid mobile number
1002Unable to register. Invalid email id
1003Unable to register. Invalid external id
1004Failed to populate store
1006Unable to register. Mobile number is required
1007Unable to register customer. No valid primary identifier mobile number, email ID, or external ID passed.
1008/ 1038Unable to register with external id
1009Unable to add registered customer to MLM
1010Unable to update loyalty points of the customer
1011Cannot find customer for provided identifier
1012Cannot find customer with the provided mobile number/external ID/e-mail ID.
1013Customer is not registered for the loyalty Program.
1014Customer is registered already
1015No identifier provided to get loyalty users
1016Unable to register. Email provided already exists for some other user
1017Provided Custom Field is invalid
1018Unable to update custom field
1019Mobile number or external id is required along with the email Id to register
1020The customer is not registered for loyalty program
1021Invalid validation code
1023Unable to register customer to loyalty program
1024Unable to update customer profile
1025Mandatory fields are not matching for customer identity update
1026Count of optional fields match is less than required
1027Field name provided for verification is invalid
1028No customer notes are available
1029Unable to retrieve customer preferences
1030Unable to update customer preferences
1031No preferences set for this customer
1032A customer already exists with the same mobile number
1033A customer already exists with the same external id
1034Unable to register. Registration date is not within the allowed past or future date limit.
1035Unable to update few customer preferences
1036One or more notes could not be added/updated for customer.
1037Unable to add/update customer notes
1039Unable to register. Email ID is required.
1041Customer id change request failed
1042Invalid mobile no/email id/external id
1043Unable to register. Customer’s external id is required.
1044You do not have sufficient permission to view the customer details
1045No valid identifier (mobile/email) passed for non-loyalty customer.
1046Conversion of loyalty customer to non-loyalty is not allowed
1047Customer's primary identifier not matching with other identifiers
1048Customer’s email id is required to convert to loyalty customer
1049Customer’s external id is required to convert to loyalty customer
1051No transactions or recommendations found for the customer
1053Preferred store specified is not found.
1060Batch limit exceeded
1062Invalid Test & Control Status
1086Points processing failed
1087Points processing failed
1088Unable to issue points. Please report to capillary support
1089Points processing failed
1090Points processing failed
1091Points processing failed
1092Points processing failed
1093Points processing failed
1094Points processing failed
1095Points processing failed
1096Points processing failed
1097Points processing failed
1098Points processing failed
1099Points processing failed
1101Invalid channel type
1102Invalid priority type
1103Invalid scope
1104Invalid identifier or no identifier passed
1105Multiple scopes are not allowed
1106Invalid subscription status passed
1107Invalid campaign id passed
1108Invalid outbox id passed
1109Unable to add, update or fetch subscription details.
1150Invalid store ID passed.
1110Unable to update subscription details
1222Internal error occurred with the referral system
1202Invalid campaign token
1203Invalid campaign configured
1204The customer may not be eligible for the referral program.
1205Unable to find the referrer in the specific campaign
1206Failed to add referral. Referral type is not supported.
1222Internal error occurred with the referral system
1301A ticket already exists with the same subject
1302Ticket registration failed
1303Ticket subject should not be empty
10001Failed to add customer.
10002Failed to update customer details.
91001Failed to get point details.
91002Failed to get subscription details.
91003Validation failed.
91004Failed to get segmentation details.
91005{x} is Primary Key, {y} cannot be updated.
91006{x} update is not allowed.
91007{x} is already occupied by some other user, ignoring it.
91009Retrieved survivor account for the requested merge victim.
91010Downgrade strategy is not configured.
91011Customer is already in the lowest slab.
91012Customer is already in the highest slab.
91013Call to Points Engine for tier upgrade criteria has failed {x}.
91014Call to Points Engine for tier renewal criteria has failed {x}.
91015Failed to update extended fields; or field length too long -{x}.
91016WECHAT profile is not available for the customer.
91017WEB_ENGAGE profile is not available for the customer.
91018Unable to load WeChat notifications.
91019Unable to load Web Engage notifications.
91020Invalid TILL passed for registration.
91021Invalid attribution TILL passed.
91022Failed to update subscription for {x} channel and priority {y}