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

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

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

Response

| An array of created Segments.

Body

object | application/json

Response payload for the BigCommerce API.

  • data
    array[object]

  • meta
    object

example

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

Response

An array of created Segments.

Body

object | application/json

Response payload for the BigCommerce API.

  • data
    array[object]

  • meta
    object

example

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

Response

An empty response.

Did you find what you were looking for?