SegmentHandler
This class provides RESTful services to retrieve the customer segment.
Method Name | HTTP Method | URL | Query Parameters | Description | Authentication | Example |
---|---|---|---|---|---|---|
checkIsInSegmentByUserId | GET | store/{storeId}/segment/{segmentId}/isMember | userId={userId}&personalizationId={personalizationId}&responseFormat={responseFormat} | Check whether the given customer(identified by userId or personalizationId) is part of given customer segment. | Yes,HTTPS | Sample |
getCustomerSegment | GET | store/{storeId}/segment/ | q={q}&qUserId={qUserId}&qPersonalizationId={qPersonalizationId}&qName={qName}&pageNumber={pageNumber}&pageSize={pageSize}&responseFormat={responseFormat} | Get all customer segment by given storeId or get segment by userId or personalizationId or byName. | Yes,HTTPS | Sample |
getCustomerSegmentById | GET | store/{storeId}/segment/{segmentId} | responseFormat={responseFormat} | Get customer segment by segmentId. | Yes,HTTPS | Sample |