Light Mode

Create Customer Group

POST/customers/groups

Last modified: 2 months ago

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.

:::tip[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`

:::

:::info[Information]
To add the payment methods you will need to get the payment methods list from the Available Payment Methods endpoint
:::

`customers.read_write`- Customers Read & Write

Request

No schema defined

{
  "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

Responses

Success(200)

Error Validation(422)

HTTP Code: 200

Content Type : JSONapplication/json

No schema defined

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

Last modified: 2 months ago