Skip to content

Commit

Permalink
Update user-guide.mdx - added customer-segmentation to urls
Browse files Browse the repository at this point in the history
  • Loading branch information
@bc-traciporter
bc-traciporter authored Sep 3, 2024
1 parent 19734dd commit f62df03
Showing 1 changed file with 18 additions and 18 deletions.
36 changes: 18 additions & 18 deletions docs/store-operations/segments/user-guide.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Create customer segments to offer customers targeted promotions. See the [Custom

### Creating segments

Create new segments by sending a request to the [Create segments](/docs/rest-management/segments#create-segments) endpoint. Include an array of objects, where each object represents a segment and contains `name` and `description` properties.
Create new segments by sending a request to the [Create segments](/docs/rest-management/customer-segmentation/segments#create-segments) endpoint. Include an array of objects, where each object represents a segment and contains `name` and `description` properties.

<Callout type="info">
Segment names appear in the Promotions Manager view of the store control panel. To reduce confusion, give your segments unique names.
Expand Down Expand Up @@ -65,7 +65,7 @@ Create a shopper profile to assign registered customers to segments. You can ide

### Existing customers

You can create one [shopper profile](/docs/store-operations/customer-segmentation/definitions-and-relationships#shopper-profile) for each registered customer using the [Create shopper profiles](/docs/rest-management/shopper-profiles#create-shopper-profiles) endpoint. Include an array of objects, where each object represents a shopper profile and contains the corresponding `customer_id`.
You can create one [shopper profile](/docs/store-operations/customer-segmentation/definitions-and-relationships#shopper-profile) for each registered customer using the [Create shopper profiles](/docs/rest-management/customer-segmentation/shopper-profiles#create-shopper-profiles) endpoint. Include an array of objects, where each object represents a shopper profile and contains the corresponding `customer_id`.

<Tabs items={['Request', 'Response']}>
<Tab>
Expand Down Expand Up @@ -109,7 +109,7 @@ To create a shopper profile for a new customer, first use the [Create customers]

### Add shopper profiles to a segment

After you create segments and shopper profiles, you can associate multiple shopper profiles with a given segment using the [Add shopper profiles to a segment](/docs/rest-management/shopper-profiles-for-a-segment#add-shopper-profiles-to-a-segment) endpoint. Include the `segmentId` as a path parameter, and pass an array of shopper profile `id`s.
After you create segments and shopper profiles, you can associate multiple shopper profiles with a given segment using the [Add shopper profiles to a segment](/docs/rest-management/customer-segmentation/shopper-profiles-for-a-segment#add-shopper-profiles-to-a-segment) endpoint. Include the `segmentId` as a path parameter, and pass an array of shopper profile `id`s.

<Tabs items={['Request', 'Response']}>
<Tab>
Expand Down Expand Up @@ -150,7 +150,7 @@ Use the following guide to update or delete segments.

### Update segments

Update segment names and descriptions using the [Update Segments](/docs/rest-management/segments#update-segments) endpoint. Include an array of objects that each contain the `segmentId`; `name` and `description` are optional.
Update segment names and descriptions using the [Update Segments](/docs/rest-management/customer-segmentation/segments#update-segments) endpoint. Include an array of objects that each contain the `segmentId`; `name` and `description` are optional.

<Tabs items={['Request', 'Response']}>
<Tab>
Expand Down Expand Up @@ -193,7 +193,7 @@ Update segment names and descriptions using the [Update Segments](/docs/rest-man

#### Remove shoppers from a given segment

You may want to change the segments to which a shopper's profile belongs based on the shopper's behavior on the storefront. To remove one or more specific shopper profiles, use the [Remove shopper profiles from a segment](/docs/rest-management/shopper-profiles-for-a-segment#remove-shopper-profiles-from-a-segment) endpoint. Include the `segmentId` as a path parameter, and use the `id:in` query parameter to pass the shopper profile `id`(s) you want to remove. If you exclude `id:in`, this request will empty the segment of all shopper profiles.
You may want to change the segments to which a shopper's profile belongs based on the shopper's behavior on the storefront. To remove one or more specific shopper profiles, use the [Remove shopper profiles from a segment](/docs/rest-management/customer-segmentation/shopper-profiles-for-a-segment#remove-shopper-profiles-from-a-segment) endpoint. Include the `segmentId` as a path parameter, and use the `id:in` query parameter to pass the shopper profile `id`(s) you want to remove. If you exclude `id:in`, this request will empty the segment of all shopper profiles.

<Callout type="info">
Removing a shopper profile from a segment does not delete the shopper profile itself. The shopper profile will remain associated with any other segments.
Expand All @@ -219,7 +219,7 @@ You may want to change the segments to which a shopper's profile belongs based o

### Delete segments

To delete segments, use the [Delete segments](/docs/rest-management/segments#delete-segments) endpoint. Segments and shopper profiles have a many-to-many relationship. Thus, all the shopper profiles associated with a deleted segment will still exist, but be disassociated from the deleted segment. Include the `id:in` query parameter to specify which segments you want to delete.
To delete segments, use the [Delete segments](/docs/rest-management/customer-segmentation/segments#delete-segments) endpoint. Segments and shopper profiles have a many-to-many relationship. Thus, all the shopper profiles associated with a deleted segment will still exist, but be disassociated from the deleted segment. Include the `id:in` query parameter to specify which segments you want to delete.

<Callout type="warning">
#### Make sure to specify which segments
Expand All @@ -245,7 +245,7 @@ To delete segments, use the [Delete segments](/docs/rest-management/segments#del

### Delete shopper profiles

To delete shopper profiles, use the [Delete shopper profiles](/docs/rest-management/shopper-profiles#delete-shopper-profiles) endpoint. Include the `id:in` query parameter to specify which shopper profiles you want to delete.
To delete shopper profiles, use the [Delete shopper profiles](/docs/rest-management/customer-segmentation/shopper-profiles#delete-shopper-profiles) endpoint. Include the `id:in` query parameter to specify which shopper profiles you want to delete.


<Callout type="warning">
Expand Down Expand Up @@ -276,7 +276,7 @@ Once you've established relationships between segments and shopper profiles, you

### Retrieve shopper profiles for a segment

To keep your segments in sync with external apps, use the [Get all shopper profiles in a segment](/docs/rest-management/shopper-profiles#get-all-shopper-profiles) endpoint. This request returns a list of all shopper profiles belonging to a specific segment.
To keep your segments in sync with external apps, use the [Get all shopper profiles in a segment](/docs/rest-management/customer-segmentation/shopper-profiles#get-all-shopper-profiles) endpoint. This request returns a list of all shopper profiles belonging to a specific segment.

<Tabs items={['Request', 'Response']}>
<Tab>
Expand Down Expand Up @@ -317,7 +317,7 @@ To keep your segments in sync with external apps, use the [Get all shopper profi

### Retrieve segments for a shopper profile

To find all segments associated with a given shopper profile, use the [Get all segments for a shopper profile](/docs/rest-management/segments-for-a-shopper-profile#get-all-segments-for-a-shopper-profile) endpoint. Include the `id` of the shopper profile as a path parameter.
To find all segments associated with a given shopper profile, use the [Get all segments for a shopper profile](/docs/rest-management/customer-segmentation/segments-for-a-shopper-profile#get-all-segments-for-a-shopper-profile) endpoint. Include the `id` of the shopper profile as a path parameter.

<Tabs items={['Request', 'Response']}>
<Tab>
Expand Down Expand Up @@ -393,15 +393,15 @@ To learn more about promotion targeting rules, visit the [Advanced Editor](https
* [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/segments)
* [Create segments](/docs/rest-management/segments#create-segments)
* [Create shopper profiles](/docs/rest-management/shopper-profiles#create-shopper-profiles)
* [Add shopper profiles to a segment](/docs/rest-management/shopper-profiles-for-a-segment#add-shopper-profiles-to-a-segment)
* [Update Segments](/docs/rest-management/segments#update-segments)
* [Remove shopper profiles from a segment](/docs/rest-management/shopper-profiles-for-a-segment#remove-shopper-profiles-from-a-segment)
* [Delete segments](/docs/rest-management/segments#delete-segments)
* [Get all shopper profiles in a segment](/docs/rest-management/shopper-profiles-for-a-segment#get-all-shopper-profiles-in-a-segment)
* [Get all segments for a shopper profile](/docs/rest-management/segments-for-a-shopper-profile#get-all-segments-for-a-shopper-profile)
* [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)
Expand Down

0 comments on commit f62df03

Please sign in to comment.