Create Customer Group

Production

https://api.salla.dev/admin/v2

POST

/customers/groups

Customer Groups

Last modified:2025-02-05 13:21:46

This endpoint allows you to create a customer group by providing a required group name, along with conditions (shared traits among members) and the features that will apply to the group.

Note

The type variable may be one of the following options:


`"total_sales"`
`"total_orders"`
`"store_rating"`
`"doesnt_have_orders"`

And the symbols may be one of the following options:


`>`
`<`
`between`

Information

To add the payment methods you will need to get the payment methods list from the Available Payment Methods endpoint

Scopes

customers.read_write- Customers Read & Write

Request

Authorization

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Body Params application/json

name

string

optional

A unique title or label assigned to a collection of items, individuals, or entities that share common characteristics, serving as a means of categorization or identification within a broader context or organization. List of customers can be found here.

conditions

array [object {5}]

optional

An array of conditions to consider when automatically assigning customers to a group.

type

string

optional

The type of the condition.

symbol

enum<string>

optional

A condition operator.

Allowed values:

><between

value

number

optional

A condition value (value to be after the operator).

min_value

number

optional

Refers to the minimum possible value. Required if symbol equals between.

max_value

number

optional

Refers to the maximum possible value. Required if symbol equals between

Example

{
  "name": "VIPCustomers",
  "conditions": [
    {
      "type": "total_sales",
      "symbol": ">",
      "value": 100
    }
  ],
  "features": {
    "payment_method": [
      "credit_card",
      "mada",
      "bank",
      "cod",
      "apple_pay",
      "stc_pay"
    ],
    "shipping": [
      "all"
    ]
  }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.salla.dev/admin/v2/customers/groups' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "VIPCustomers",
    "conditions": [
        {
            "type": "total_sales",
            "symbol": ">",
            "value": 100
        }
    ],
    "features": {
        "payment_method": [
            "credit_card",
            "mada",
            "bank",
            "cod",
            "apple_pay",
            "stc_pay"
        ],
        "shipping": [
            "all"
        ]
    }
}'

Responses

🟢200Success

application/json

Body

status

number

optional

Response status code, a numeric or alphanumeric identifier used to convey the outcome or status of a request, operation, or transaction in various systems and applications, typically indicating whether the action was successful, encountered an error, or resulted in a specific condition.

success

boolean

optional

Response flag, boolean indicator used to signal a particular condition or state in the response of a system or application, often representing the presence or absence of certain conditions or outcomes.

data

object (CustomerGroup)

optional

Detailed structure of the customer group model object showing its fields and data types.

number

required

The unique identifier assigned to a specific group of customers.

name

string

required

The name or label for a the Customer Group.

conditions

object

required

Conditions for group membership, such as total_sales > 100, determine auto-assignment. For example, customers with sales exceeding 100 are added to the group automatically.

features

object

required

Examples

ExampleExample 1

{
  "status": 200,
  "success": true,
  "data": {
    "id": 1394760126,
    "name": "VIPCustomers"
  }
}

🟠422Error Validation

🟠401Unauthorized

Modified at 2025-02-05 13:21:46

Customer Groups

List Customer Groups