Search Customer
GET /customers query bearer
Resolves a Customer by email, phone, loyalty card or external identity. Returns matching Customer profiles.
Overview
|
|
| ID |
search-customer-api |
| Method |
GET |
| Path |
/customers |
| Classification |
query |
| Domain |
customer |
| Capability |
customer-identity |
| Service |
search-customer |
| Application |
crm — CRM |
| Auth |
bearer |
Response
|
|
| Business Object |
customer |
| Description |
Canonical party recognized by the enterprise as a customer. |
| Lifecycle |
anonymous → identified → registered → active → at-risk → churned → reactivated → blocked |
Scenarios using customer-identity
| Scenario |
Description |
Clienteling Sale |
A store associate uses a clienteling application to identify a known customer, review their purchase |
Customer Consent Update |
Customer changes privacy and marketing preferences through a digital or assisted channel and expects |
Customer Registration |
A new customer creates a unified identity that can be recognised consistently across digital and phy |
Endless Aisle |
Store associate helps a customer order an item that is not physically stocked in the current store b |
Loyalty Enrollment |
A customer is enrolled into the retailer's loyalty programme during or after a transaction — in-stor |
Loyalty Tier Upgrade |
A customer's loyalty standing is reviewed after new qualifying activity and may be promoted to a hig |
Scan and Go |
Customer scans items using a mobile app while shopping, receives promotions and loyalty benefits in |
Subscription Renewal |
A recurring subscription is renewed either automatically or after a customer reminder and confirmati |
Unified Return |
Customer returns an item regardless of the original purchase channel. The return may be initiated on |
Related APIs — customer domain