Customer Groups

Server

Download schema

List customer groups

GET

https://api.wocart.store

/api/customer-groups

X-API-Key (header)

Get all customer groups with optional search filter and pagination

List customer groups › query Parameters

search

string

Search by name

limit

integer · max: 100

Maximum number of groups to return

Default: 50

offset

integer | null · min: 0

Number of groups to skip

Default: 0

List customer groups › Responses

200

List of customer groups

success

boolean · required

CustomerGroup[] · required

count

integer · required

Number of items returned

Create customer group

POST

https://api.wocart.store

/api/customer-groups

X-API-Key (header)

Create a new customer segment group

Create customer group › Request Body

name

string · minLength: 1 · maxLength: 100 · required

description

string | null · maxLength: 500

color

string · pattern: ^#[0-9a-fA-F]{6}$

Default: #6366f1

Create customer group › Responses

Group created

success

boolean · required

CustomerGroup · required

Group for segmenting customers

message

string · required

POST/api/customer-groups

curl https://api.wocart.store/api/customer-groups \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "name": "Wholesale Customers",
  "description": "High volume buyers",
  "color": "#3B82F6"
}'

Example Request Body

{
  "name": "Wholesale Customers",
  "description": "High volume buyers",
  "color": "#3B82F6"
}

json

Example Responses

{
  "success": true,
  "data": {
    "id": "grp_123",
    "name": "Wholesale Customers",
    "description": "High volume buyers",
    "color": "#6366f1",
    "memberCount": 12,
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "members": [
      {
        "id": "cust_123",
        "name": "Ahmed Benali",
        "phone": "0555123456",
        "wilaya": "Alger",
        "totalOrders": 5,
        "totalSpent": 15000,
        "assignedAt": "2024-01-15T10:30:00.000Z"
      }
    ]
  },
  "message": "Operation completed successfully"
}

json

application/json

Get customer group

GET

https://api.wocart.store

/api/customer-groups/{id}

X-API-Key (header)

Returns the group. Pass ?members=true to include the full member list (each with assignedAt timestamp).

Get customer group › path Parameters

id

string · required

Resource ID

Get customer group › query Parameters

members

string · enum

Set to true to include the members array in the response

Enum values:

true

false

Get customer group › Responses

200

Group detail. When ?members=true, includes a members array of customer summaries.

success

boolean · required

CustomerGroup · required

Group for segmenting customers

Update customer group

PATCH

https://api.wocart.store

/api/customer-groups/{id}

X-API-Key (header)

Partial update — only include fields you want to change. Set description to null to clear it.

Update customer group › path Parameters

id

string · required

Resource ID

Update customer group › Request Body

name

string · minLength: 1 · maxLength: 100

description

string | null · maxLength: 500

color

string · pattern: ^#[0-9a-fA-F]{6}$

Update customer group › Responses

Group updated

success

boolean · required

CustomerGroup · required

Group for segmenting customers

PATCH/api/customer-groups/{id}

curl https://api.wocart.store/api/customer-groups/:id \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "name": "VIP Customers",
  "description": "Updated description",
  "color": "#10B981"
}'

Example Request Body

{
  "name": "VIP Customers",
  "description": "Updated description",
  "color": "#10B981"
}

json

Example Responses

{
  "success": true,
  "data": {
    "id": "grp_123",
    "name": "Wholesale Customers",
    "description": "High volume buyers",
    "color": "#6366f1",
    "memberCount": 12,
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "members": [
      {
        "id": "cust_123",
        "name": "Ahmed Benali",
        "phone": "0555123456",
        "wilaya": "Alger",
        "totalOrders": 5,
        "totalSpent": 15000,
        "assignedAt": "2024-01-15T10:30:00.000Z"
      }
    ]
  }
}

json

application/json

Delete customer group

DELETE

https://api.wocart.store

/api/customer-groups/{id}

X-API-Key (header)

Deletes the group and all its member associations. Customers themselves are not affected.

Delete customer group › path Parameters

id

string · required

Resource ID

Delete customer group › Responses

Group deleted

MessageResponse

success

boolean · required

message

string · required

Add member to group

POST

https://api.wocart.store

/api/customer-groups/{id}/members

X-API-Key (header)

Adds a customer to the group. Idempotent — silently succeeds if already a member. Increments memberCount.

Add member to group › path Parameters

id

string · required

Resource ID

Add member to group › Request Body

customerId

string · minLength: 1 · required

Add member to group › Responses

200

Member added

MessageResponse

success

boolean · required

message

string · required

Remove member from group

DELETE

https://api.wocart.store

/api/customer-groups/{id}/members/{customerId}

X-API-Key (header)

Removes a customer from the group. Idempotent — succeeds silently if not a member. Decrements memberCount.

Remove member from group › path Parameters

id

string · required

Resource ID

customerId

string · required

Customer ID

Remove member from group › Responses

200

Member removed

MessageResponse

success

boolean · required

message

string · required

Customers Customer Tags