Create Customer Group

Production

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

POST

/customers/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

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

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