Adds Segment

Creates a new segment. Merchants create segments of customers, for example, to offer discounts to particular groups or assign VIP status to a set of customers.

POST /commerce/customer/segments

Error

A valid request URL is required to generate request examples

200

{
  "auditInfo": {
    "createBy": "<string>",
    "createDate": "2023-11-07T05:31:56Z",
    "updateBy": "<string>",
    "updateDate": "2023-11-07T05:31:56Z"
  },
  "code": "<string>",
  "description": "<string>",
  "id": 123,
  "name": "<string>"
}

Authorizations

Authorization · string · header · required

JWT Authorization header using the Bearer scheme.

Query Parameters

responseFields · string

limits which fields are returned in the response body

Body

application/json

Name of the customer segment to create.

A customer segment.

auditInfo · object

Show child attributes

code · string | null

Unique identifier of the customer segment.

description · string | null

Description of the customer segment.

id · integer<int32>

Unique identifier of the customer segment.

name · string | null

Name of the customer segment.

Response

200

application/json

OK

A customer segment.

auditInfo · object

Show child attributes

code · string | null

Unique identifier of the customer segment.

description · string | null

Description of the customer segment.

id · integer<int32>

Unique identifier of the customer segment.

name · string | null

Name of the customer segment.