Create member group

POST 
/openapi/2026-01/loyalty/member-groups

Create a new member segment for targeted operations

Request

application/json

Body

Bodyrequired

namestringrequired

Group name

idempotency_keystring

Optional idempotency key

member_condition objectrequired
Member filter condition
keystring
operatorstring
valueGoogleProtobufValue
Represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values.
extra object
Member condition extra config (time window, categories, products, regions)
time_rangestring
Time range window: all / 7d / 30d
categories object[]
Categories filter, 2-level nested array ([["a","a-1"],["b"]])
Array [
valuesGoogleProtobufValue[]
Repeated field of dynamically typed values.
]
product_idsstring[]
Product id list
country_and_province object
Country+province map: key=country code, value=province codes (["ALL"]=whole country)
property name* ListValue
ListValue is a wrapper around a repeated field of values.
The JSON representation for ListValue is JSON array.
valuesGoogleProtobufValue[]
Repeated field of dynamically typed values.
relationstring
childrenundefined[]

Example

{
  "name": "string",
  "idempotency_key": "string",
  "member_condition": {
    "key": "string",
    "operator": "string",
    "extra": {
      "time_range": "string",
      "categories": [
        {
          "values": [
            null
          ]
        }
      ],
      "product_ids": [
        "string"
      ],
      "country_and_province": {}
    },
    "relation": "string",
    "children": [
      null
    ]
  }
}

Responses

200

OK

application/json

Schema

Schema

codestring

error code

messagestring

error message

data object
Create member group response
member_group_idstring
namestring
is_real_timeboolean
member_countint64
created_atstring
updated_atstring
member_condition object
Member condition expression (recursive tree)
keystring
operatorstring
valueGoogleProtobufValue
Represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values.
extra object
Member condition extra config (time window, categories, products, regions)
time_rangestring
Time range window: all / 7d / 30d
categories object[]
Categories filter, 2-level nested array ([["a","a-1"],["b"]])
Array [
valuesGoogleProtobufValue[]
Repeated field of dynamically typed values.
]
product_idsstring[]
Product id list
country_and_province object
Country+province map: key=country code, value=province codes (["ALL"]=whole country)
property name* ListValue
ListValue is a wrapper around a repeated field of values.
The JSON representation for ListValue is JSON array.
valuesGoogleProtobufValue[]
Repeated field of dynamically typed values.
relationstring
childrenundefined[]

Example

{
  "code": "string",
  "message": "string",
  "data": {
    "member_group_id": "string",
    "name": "string",
    "is_real_time": true,
    "member_count": 0,
    "created_at": "string",
    "updated_at": "string",
    "member_condition": {
      "key": "string",
      "operator": "string",
      "extra": {
        "time_range": "string",
        "categories": [
          {
            "values": [
              null
            ]
          }
        ],
        "product_ids": [
          "string"
        ],
        "country_and_province": {}
      },
      "relation": "string",
      "children": [
        null
      ]
    }
  }
}