Customer Segment Service Tutorials
Customer Segment Service allows you to group your customers in many convenient ways that suit different purposes. You can assign products or categories to create targeted marketing campaigns and display the relevant items on the storefront. The flexible service's API facilitates configuring and managing customer segments.
How to add a customer segment
info
To create and configure a segment, you need the
customersegment.segment_manage scope.Create a customer segment
Create a customer segment by sending a request to the theUnknown error - CORS is misconfigured on the server
- The server couldn't send a response
- No internet access
- Documentation issue - contact API owner
- Misconfigured security definition
post/{tenant}/segments
Add products/categories to a segment
Connect the segment with specific products and/or categories for more customized content.
- To add an individual product or a category, call the
Updating an item assignment endpoint.
Unknown error - CORS is misconfigured on the server
- The server couldn't send a response
- No internet access
- Documentation issue - contact API owner
- Misconfigured security definition
put/{tenant}/segments/{segmentId}/items/{type}/{itemId}
- To assign multiple products or categories to the segment, call the
Updating multiple item assignments endpoint.
Unknown error - CORS is misconfigured on the server
- The server couldn't send a response
- No internet access
- Documentation issue - contact API owner
- Misconfigured security definition
put/{tenant}/segments/{segmentId}/items/{type}/bulk
attention
Note that this operation performs an
UPSERT operation. The UPSERT means that if an item is already assigned to a segment, the assignment gets updated. If not, the new one is created in the system.Add segment members
Now, add customers to the segment. Depending on your setup and purpose, you can add B2B or B2C customers.
- To add a B2B customer, send the request to the
[B2B] Updating a customer assignment endpoint.
Unknown error - CORS is misconfigured on the server
- The server couldn't send a response
- No internet access
- Documentation issue - contact API owner
- Misconfigured security definition
put/{tenant}/segments/{segmentId}/customers/{customerId}/{legalEntityId}
- To add a B2C customer, send the request to the
[B2C] Updating a customer assignment endpoint.
Unknown error - CORS is misconfigured on the server
- The server couldn't send a response
- No internet access
- Documentation issue - contact API owner
- Misconfigured security definition
put/{tenant}/segments/{segmentId}/customers/{customerId}
- To add multiple customers at once, send the request to the
Updating multiple customer assignments endpoint.
Unknown error - CORS is misconfigured on the server
- The server couldn't send a response
- No internet access
- Documentation issue - contact API owner
- Misconfigured security definition
put/{tenant}/segments/{segmentId}/customers/bulk
attention
Note that this operation performs an
UPSERT operation. The UPSERT means that if a customer is already assigned to a segment, the assignment gets updated. If not, the customer assignment is created in the system.How to find a specific segment using search parameters
info
To search for a segment, you need the
customersegment.segment_read scope to retrieve all customer segments.Unknown error - CORS is misconfigured on the server
- The server couldn't send a response
- No internet access
- Documentation issue - contact API owner
- Misconfigured security definition
post/{tenant}/segments/search
q parameter.