Skip to main content
GET
/
commerce
/
customer
/
customerSets
/
{code}
Error
A valid request URL is required to generate request examples
{
  "code": "<string>",
  "name": "<string>",
  "description": "<string>",
  "auditInfo": {
    "updateDate": "2023-11-07T05:31:56Z",
    "createDate": "2023-11-07T05:31:56Z",
    "updateBy": "<string>",
    "createBy": "<string>"
  },
  "sites": [
    {
      "siteId": 123,
      "customerSetCode": "<string>",
      "name": "<string>"
    }
  ],
  "isDefault": true,
  "aggregateInfo": {
    "customerCount": 123
  }
}

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Path Parameters

code
string
required

Unique identifier of a customer group.

Query Parameters

responseFields
string

limits which fields are returned in the response body

Response

Success

A customer segment.

code
string | null

Unique identifier of the customer segment.

name
string | null

Name of the customer segment.

description
string | null

Description of the customer segment.

auditInfo
object
sites
object[] | null
isDefault
boolean
aggregateInfo
object