Segments API (Beta)
Get All Shopper Profiles in a Segment (Beta)
GET /stores/{store_hash}/v3/segments/{segmentId}/shopper-profiles
Request
Returns a list of Shopper Profiles that are associated with a given Segment.
Authentication
- X-Auth-Token in header - required
Parameters
- store_hash in path - string
- page in query - integer
Page number.
- limit in query - integer
Items count per page.
example
Response
An array of Shopper Profiles objects and metadata.
Body
dataarray[object]
metaobject
Data about the response including pagination, and collection totals.
example
Add Shopper Profiles to a Segment (Beta)
POST /stores/{store_hash}/v3/segments/{segmentId}/shopper-profiles
Request
Add Shopper Profiles to a specific Segment.
A maximum number of Shopper Profiles per request is 50
, and up to three concurrent requests are allowed.
Authentication
- X-Auth-Token in header - required
Parameters
- store_hash in path - string
- Content-Type in header with default of application/json - string - required
The MIME type of the request body.
Body
A list of Shopper Profiles to associate with the segment.
example
Response
An array of Shopper Profiles added to a Segment.
Body
dataarray[object]
example
Remove Shopper Profiles from a Segment (Beta)
DELETE /stores/{store_hash}/v3/segments/{segmentId}/shopper-profiles
Request
Remove one or more Shopper Profiles that are associated with a Segment. This operation only removes the association; it doesn't delete the Shopper Profiles.
Authentication
- X-Auth-Token in header - required
Parameters
- store_hash in path - string
- id:in in query - array
Comma separated IDs.
example
Response
An empty response.