commerce/customer/accounts/segments

Use the Customer Account Segments subresource to view the customer segments associated with a customer account.

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
GetAccountSegments GET %7baccountId%7d%2fsegments%2f%3fstartIndex%3d%7bstartIndex%7d%26pageSize%3d%7bpageSize%7d%26sortBy%3d%7bsortBy%7d%26filter%3d%7bfilter%7d%26responseFields%3d%7bresponseFields%7d

Retrieves the list of segments associated with a customer account.