Docs
Management API
Customer segmentation
Shopper Profiles

Shopper Profiles

Get All Shopper Profiles

GET /shopper-profiles

Request

Returns a paginated Shopper Profiles 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.

example

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

Response

An array of Shopper Profiles objects and metadata.

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",
"customer_id": 1,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"meta": {
"pagination": {
"total": 1,
"count": 1,
"per_page": 50,
"current_page": 1,
"total_pages": 1
}
}
}

Create Shopper Profiles

POST /shopper-profiles

Request

Creates a Shopper Profile.

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.

  • customer_id    number

    The ID of a registered Customer to associate with the new Shopper Profile.
    Example: 1

example

[
{
"customer_id": 1
}
]

Response

An array of created Shopper Profiles.

Body

object | application/json

Response payload for the BigCommerce API.

  • data    array[object]

  • meta    object

example

{
"data": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"customer_id": 1,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"meta": {}
}

Delete Shopper Profiles

DELETE /shopper-profiles

Request

Deletes one or more Shopper Profiles from a store.

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/shopper-profiles' \
--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?
Get All Segments for a Shopper ProfileGet All Shopper Profiles