Docs
Management API
Customer segmentation
Segments

Segments

Get All Segments

GET /segments

Request

Returns a paginated Segments List.

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string
    required
    The MIME type of the response body.
  • page in query - integer

    Page number.

  • limit in query - integer

    Items count per page.

  • id:in in query - array

    Comma separated IDs.

    Type: array[string]

example

curl --request GET \
--url 'https://api.bigcommerce.com/stores/[store_hash]/v3/segments' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: {{token}}'

Response

Body

object | application/json

Response payload for the BigCommerce API.

  • data    array[object]

  • meta    object

    Data about the response including pagination, and collection totals.

example

{
"data": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "My Segment",
"description": "Description",
"created_at": "2022-09-15T23:44:05Z",
"updated_at": "2022-09-15T23:44:05Z"
}
],
"meta": {
"pagination": {
"total": 1,
"count": 1,
"per_page": 50,
"current_page": 1,
"total_pages": 1
}
}
}

Create Segments

POST /segments

Request

Creates Segments.

Limits

  • Limit of 10 concurrent requests.

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string
    required
    The MIME type of the response body.
  • 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.

  • name    string
    required

    Name of the segment
    Example: My Segment

  • description    string

    Description of the segment
    Example: Description

example

[
{
"name": "My Segment",
"description": "Description"
}
]

Response

| An array of created Segments.

Body

object | application/json

Response payload for the BigCommerce API.

  • data    array[object]

  • meta    object

example

{
"data": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "My Segment",
"description": "Description",
"created_at": "2022-09-15T23:44:05Z",
"updated_at": "2022-09-15T23:44:05Z"
}
],
"meta": {}
}

Update Segments

PUT /segments

Request

Updates Segments.

Limits

  • Limit of 10 concurrent requests.

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string
    required
    The MIME type of the response body.
  • 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.

  • id    string
    required

    ID of the segment.

  • name    string

    Name of the segment.
    Example: My Segment

  • description    string

    Description of the segment.
    Example: Description

example

[
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "My Segment",
"description": "Description"
}
]

Response

An array of created Segments.

Body

object | application/json

Response payload for the BigCommerce API.

  • data    array[object]

  • meta    object

example

{
"data": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "My Segment",
"description": "Description",
"created_at": "2022-09-15T23:44:05Z",
"updated_at": "2022-09-15T23:44:05Z"
}
],
"meta": {}
}

Delete Segments

DELETE /segments

Request

Deletes one or more Segments from a store. This will not delete any associated Shopper Profiles.

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string
    required
    The MIME type of the response body.
  • id:in in query - array

    Comma separated IDs.

    Type: array[string]

example

curl --request DELETE \
--url 'https://api.bigcommerce.com/stores/[store_hash]/v3/segments' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: {{token}}'

Response

An empty response.

Did you find what you were looking for?
Customer segmentationGet All Segments