Skip to content

Commit

Permalink
Merge branch 'main' into CUST-3450
Browse files Browse the repository at this point in the history
  • Loading branch information
mjhmatt authored Sep 5, 2024
2 parents d8c1335 + 52425ba commit 2b8e7e7
Show file tree
Hide file tree
Showing 11 changed files with 1,366 additions and 5 deletions.
68 changes: 68 additions & 0 deletions docs/store-operations/segments/definitions.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
# Definitions and Logical Relationships

<Callout type="info">
#### Exclusive enterprise feature
The Customer Segmentation API is available to enterprise customers. If you would like to become an enterprise customer, please contact your BigCommerce Customer Service Manager or our support team.
</Callout>

## Segment
An entity that classifies shoppers into groups or buckets, referred to as **segments**.

## Manual segment
A collection of shoppers that a merchant or application has grouped together using the API. Manual segments are not a distinct entity in our API; they are a subset of **segments**.

## Shopper profile
An entity that represents a registered **customer**. Current plans for future releases include supporting **shopper profiles** for **guest** customers.

## Customer
An existing entity that represents a shopper who is registered with the store. In the Customer Segmentation API documentation, assume that **customers** are signed in to the subject storefront. For more on the **customer** entity, see the public [Customers API reference](/docs/rest-management/customers).

## Guest
A shopper who is not signed in to the subject storefront.

A **guest** may or may not be a registered **customer**, but because they are not signed in, your application doesn't know their registration status.

## Promotion
A way to give discounts based on whether the shopper meets specific criteria, such as ordering a certain amount, purchasing certain brands, being a repeat customer, or being associated with a **shopper profile** that belongs to a **segment**.

For more on using **promotions** with **segments**, see [Targeting a segment with a promotion](/docs/store-operations/customer-segmentation/user-guide#targeting-a-segment-with-a-promotion). For more on the **promotion** entity, see the [Promotions documentation](/docs/store-operations/promotions).

## Summary of entity relationships

### Many-to-many

* Segments and shopper profiles
* Segments and promotions

### One-to-one

* Shopper profiles and customers

### Other entity relationships

Relationships that don't currently involve the Customer Segmentation API:
* Many-to-many: guests and promotions

Relationships that don't yet exist:
* Shopper profiles and guests

## Resources

### Articles
* [Customer Segmentation API Overview](/docs/store-operations/customer-segmentation)
* [Customer Segmentation API Guide](/docs/store-operations/customer-segmentation/user-guide)
* [Promotions and Customer Segmentation](/docs/store-operations/customer-segmentation/promotions-api)
* [Promotions API documentation](/docs/store-operations/promotions)

### Customer Segmentation reference
* [Customer Segmentation V3 API Reference Overview](/docs/rest-management/customer-segmentation)
* [Create segments](/docs/rest-management/customer-segmentation/segments#create-segments)
* [Create shopper profiles](/docs/rest-management/customer-segmentation/shopper-profiles#create-shopper-profiles)
* [Add shopper profiles to a segment](docs/rest-management/customer-segmentation/shopper-profiles-for-a-segment#add-shopper-profiles-to-a-segment)
* [Update Segments](docs/rest-management/customer-segmentation/segments#update-segments)
* [Remove shopper profiles from a segment](/docs/rest-management/customer-segmentation/shopper-profiles-for-a-segment#remove-shopper-profiles-from-a-segment)
* [Delete segments](docs/rest-management/customer-segmentation/segments#delete-segments)
* [Get all shopper profiles in a segment](/docs/rest-management/customer-segmentation/shopper-profiles-for-a-segment#get-all-shopper-profiles-in-a-segment)
* [Get all segments for a shopper profile](/docs/rest-management/customer-segmentation/segments-for-a-shopper-profile#get-all-segments-for-a-shopper-profile)


35 changes: 35 additions & 0 deletions docs/store-operations/segments/faqs.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# FAQ

## How will a promotion be applied to shoppers associated with a targeted segment?

For a promotion to apply, you must assign a customer to the targeted segment, and they must sign in to the subject storefront.

For automatic promotions, the discount automatically applies itself to the cart of each eligible signed-in customer. For coupon promotions, the signed-in customer must enter a valid coupon code associated with the promotion during checkout.


## Can you segment guests where customer_id=0?

Not currently. This version of the Customer Segmentation API doesn’t support segmenting guest shoppers; only registered customers can be assigned to segments.


## How many segments are supported?

We support up to 100 segments per **store**. The number of segments we support may increase due to the feedback we receive.


## What’s the difference between customer segments and customer groups?

Customer groups allow you to group shoppers based on more permanent characteristics, like tax zones or shopper consent to collect GDPR-compliant data. A registered customer can only belong to one group at a time.

Customer segments provide greater flexibility. They leverage both the permanent and transient characteristics of a shopper to drive highly personalized shopping experiences. A [shopper profile](/docs/store-operations/customer-segmentation/definitions-and-relationships#shopper-profile) can belong to multiple segments.

## Resources

### Articles
* [Customer Segmentation API Overview](/docs/store-operations/customer-segmentation)
* [Customer Segmentation API Guide](/docs/store-operations/customer-segmentation/user-guide)
* [Definitions and Logical Relationships](/docs/store-operations/customer-segmentation/definitions-and-relationships)
* [Promotions API](/docs/store-operations/customer-segmentation/promotions-api)

### Endpoints
* [Customer Segmentation V3 API Reference](/docs/rest-management/customer-segmentation)
42 changes: 42 additions & 0 deletions docs/store-operations/segments/overview.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# Customer Segmentation API Overview

<Callout>
* Create manual segments with the API - leverage externally-defined customer segments using third-party tools and quickly transfer this data into and out of BigCommerce.
* Add a shopper to multiple segments - shoppers, or registered customers, can belong to up to 100 segments, meaning you can target a registered customer with multiple promotional experiences.
* Use segments with the Promotions API - apply a promotion to target multiple segments of shoppers, and exclude shoppers within a segment from receiving this promotion.
</Callout>

## Introduction

A **customer segment** is a collection of shoppers that share specific characteristics. Segmentation defines groups of shoppers that a merchant wants to target with a [Promotion](/docs/store-operations/customer-segmentation/definitions-and-relationships#promotion), or dedicated value proposition.

As a BigCommerce merchant, agency, and/or tech partner needing to improve a merchant store’s personalization strategy, the Customer Segmentation API enables the creation of externally defined segments that you can target within a promotion.

Manual segments created with the Segmentation API will be visible within the Promotions Advanced Editor Control Panel UI Targeting section.

![Promotion targeting segment.png](https://storage.googleapis.com/bigcommerce-production-dev-center/images/Customer_Segmentation/Beta%20Docs%20Phasea1/Edit%20Promotions.png)

For participants using the Promotions API, manual segments created with the Segmentation API will also be available to be targeted within the Promotions API.

<Callout type="info">
#### Exclusive enterprise feature
The Customer Segmentation API is available to enterprise customers. If you would like to become an enterprise customer, please contact your BigCommerce Customer Service Manager or our support team.
</Callout>

## Segments and shopper profiles

This API introduces two new objects that are both high-level entities with a many-to-many relationship: [segments](/docs/store-operations/customer-segmentation/definitions-and-relationships#segment) and [shopper profiles](/docs/store-operations/customer-segmentation/definitions-and-relationships#shopper-profile).

![Screen Shot 2021-08-06 at 3.50.00 pm.png](https://storage.googleapis.com/bigcommerce-production-dev-center/images/Customer_Segmentation/Beta%20Docs%20Phasea1/AquoYWAIt6g.png)


## Resources

### Articles
* [Customer Segmentation API Guide](/docs/store-operations/customer-segmentation/user-guide)
* [Definitions and Logical Relationships](/docs/store-operations/customer-segmentation/definitions-and-relationships)
* [Promotions API](/docs/store-operations/customer-segmentation/promotions-api)
* [Promotions Advanced Editor](https://support.bigcommerce.com/s/article/Advanced-Promotions#creating) (Support Center)

### Endpoints
* [Customer Segmentation V3 API Reference Overview](/docs/rest-management/customer-segmentation/segments)
34 changes: 34 additions & 0 deletions docs/store-operations/segments/promotions-api.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Promotions API

<Callout type="info">
#### Exclusive enterprise feature
The Customer Segmentation API is available to enterprise customers. If you would like to become an enterprise customer, please contact your BigCommerce Customer Service Manager or our support team.
</Callout>

The [Promotions API](/docs/store-operations/promotions) lets you create exponentially more promotions and granular targeting rules than what you can do in the store control panel UI alone.


Learn more about [targeting a segment with a promotion](/docs/store-operations/customer-segmentation/user-guide#targeting-a-segment-with-a-promotion).

## Resources

### Articles
* [Customer Segmentation API Guide](/docs/store-operations/customer-segmentation/user-guide)
* [Customer Segmentation API Overview](/docs/store-operations/customer-segmentation)
* [Definitions and Logical Relationships](/docs/store-operations/customer-segmentation/definitions-and-relationships)
* [Promotions Advanced Editor](https://support.bigcommerce.com/s/article/Advanced-Promotions#creating) (Support Center)

### Customer Segmentation reference
* [Customer Segmentation V3 API Reference Overview](/docs/rest-management/customer-segmentation/segments)
* [Create segments](/docs/rest-management/customer-segmentation/segments#create-segments)
* [Create shopper profiles](/docs/rest-management/customer-segmentation/shopper-profiles#create-shopper-profiles)
* [Add shopper profiles to a segment](/docs/rest-management/customer-segmentation/shopper-profiles-for-a-segment#add-shopper-profiles-to-a-segment)
* [Update Segments](/docs/rest-management/customer-segmentation/segments#update-segments)
* [Remove shopper profiles from a segment](/docs/rest-management/customer-segmentation/shopper-profiles-for-a-segment#remove-shopper-profiles-from-a-segment)
* [Delete segments](/docs/rest-management/customer-segmentation/segments#delete-segments)
* [Get all shopper profiles in a segment](/docs/rest-management/customer-segmentation/shopper-profiles-for-a-segment#get-all-shopper-profiles-in-a-segment)
* [Get all segments for a shopper profile](/docs/rest-management/customer-segmentation/segments-for-a-shopper-profile#get-all-segments-for-a-shopper-profile)

### Customers reference
* [Create customers](/docs/rest-management/customers#create-customers)
* [Get customers](/docs/rest-management/customers#get-all-customer)
Loading

0 comments on commit 2b8e7e7

Please sign in to comment.