Segments API (Beta)
Get All Shopper Profiles (Beta)
GET /stores/{store_hash}/v3/shopper-profiles
Request
Returns a paginated Shopper Profiles list.
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
object | application/json
Response payload for the BigCommerce API.
dataarray[object]
metaobject
Data about the response including pagination, and collection totals.
example
Create Shopper Profiles (Beta)
POST /stores/{store_hash}/v3/shopper-profiles
Request
Creates a Shopper Profile.
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
array | application/json
Request payload for the BigCommerce API.
example
Response
An array of created Shopper Profiles.
Body
object | application/json
Response payload for the BigCommerce API.
dataarray[object]
metaobject
example
Delete Shopper Profiles (Beta)
DELETE /stores/{store_hash}/v3/shopper-profiles
Request
Deletes one or more Shopper Profiles from a store.
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.
Did you find what you were looking for?