commerce/customer/segments
Use the Customer Segments resource to manage the segments that enable a client to manage groups of customers and target discounts for these segments. After a customer segment is defined, you can associate any number of customer accounts with it.
JSON Example
CustomerSegment Properties
Property | Description |
---|---|
code |
type: string The unique identifier of the object. |
description |
type: string The localized description in text for the object, displayed per the locale code. For example, descriptions are used for product descriptions, attributes, and pre-authorization transaction types. |
name |
type: string The user supplied name that appears in Admin. You can use this field for identification purposes. |
Operations
Operation Name | Request URI | Description |
---|---|---|
AddSegment | POST %3fresponseFields%3d%7bresponseFields%7d |
Creates a new customer segments. New customer segments do not have any associated customer accounts. |
AddSegmentAccounts | POST %7bid%7d%2faccounts |
Adds one or more customer accounts to a defined customer segment. |
DeleteSegment | DELETE %7bid%7d |
Deletes a customer segment specified by its unique identifier. Deleting a segment removes any customer account associations, but does not delete the customer account itself. |
GetSegment | GET %7bid%7d%3fresponseFields%3d%7bresponseFields%7d |
Retrieves the details of the customer segment specified in the request. This operation does not return a list of the customer accounts associated with the segment. |
GetSegments | GET %3fstartIndex%3d%7bstartIndex%7d%26pageSize%3d%7bpageSize%7d%26sortBy%3d%7bsortBy%7d%26filter%3d%7bfilter%7d%26responseFields%3d%7bresponseFields%7d |
Retrieves a list of defined customer segments according to any filter and sort criteria. |
RemoveSegmentAccount | DELETE %7bid%7d%2faccounts%2f%7baccountId%7d |
Removes single account from a segment. |
UpdateSegment | PUT %7bid%7d%3fresponseFields%3d%7bresponseFields%7d |
Updates the details of the customer segment specified in the request. |