Create Customer Group

POST {{baseUrl}}/customers/groups

This endpoint allows you to create a customer group by providing the group name which is required and the conditions (similarities between group members) and the features that the group members will have.

type may be one of the following options:

  1. "total_sales"
  2. "total_orders"
  3. "store_rating"
  4. "doesnt_have_orders"

And the symbols may be one of the following options:

  1. >
  2. <
  3. between

:::note 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 Body

{"name"=>"<string>", "conditions"=>[{"type"=>"<string>", "symbol"=>"<", "value"=>"<number>", "min_value"=>"<number>", "max_value"=>"<number>"}, {"type"=>"<string>", "symbol"=>"between", "value"=>"<number>", "min_value"=>"<number>", "max_value"=>"<number>"}], "features"=>{"payment_method"=>["<string>", "<string>"], "shipping"=>["<string>", "<string>"]}}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring
Acceptstring

RESPONSES

status: OK

{&quot;status&quot;:&quot;\u003cnumber\u003e&quot;,&quot;success&quot;:&quot;\u003cboolean\u003e&quot;,&quot;data&quot;:{&quot;id&quot;:&quot;\u003cnumber\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;conditions&quot;:{&quot;type&quot;:&quot;\u003cstring\u003e&quot;,&quot;symbol&quot;:&quot;\u003cstring\u003e&quot;,&quot;value&quot;:&quot;\u003cnumber\u003e&quot;},&quot;features&quot;:{&quot;payment_method&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;],&quot;shipping&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;]}}}