Segments API (Beta)
Get All Segments (Beta)
GET /stores/{store_hash}/v3/segments
Request
Returns a paginated Segments 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.
- id:in in query - array
Comma separated IDs.
example
Response
Body
Response payload for the BigCommerce API.
dataarray[object]
metaobject
Data about the response including pagination, and collection totals.
example
Create Segments (Beta)
POST /stores/{store_hash}/v3/segments
Request
Creates Segments.
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
Request payload for the BigCommerce API.
example
Response
| An array of created Segments.
Body
Response payload for the BigCommerce API.
dataarray[object]
metaobject
example
Update Segments (Beta)
PUT /stores/{store_hash}/v3/segments
Request
Updates Segments.
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
Request payload for the BigCommerce API.
example
Response
An array of created Segments.
Body
Response payload for the BigCommerce API.
dataarray[object]
metaobject
example
Delete Segments (Beta)
DELETE /stores/{store_hash}/v3/segments
Request
Deletes one or more Segments from a store. This will not delete any associated 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.