Basics

Basics of Customer Groups in VaahStore

What is Customer Groups?

Customer groups allow you to combine customers with similar attributes such as purchase habits or region.

How to create a Customer Groups?

After activating VaahStore, to create a customer group, go into VaahCMS > Store > Customer Groups, then click on create button. A form to create customer groups will open. After filling out all the below-mentioned fields, click on create and new button to create a new record.

Requirements to create a Customer Groups.

FieldsDescriptions
NameName of the customer group.
SlugSlug of the customer group.
Customer CountNumber of customers.
Order CountNumber of orders.
StatusSelect the status of the customer group.
Status NotesNotes are to describe your decision for any status.

Details about customer groups table

  • After creating a customer group, you find the record on the table and if there is no record, then it will show no records found.
  • The name column shows the name of the customer groups.
  • The Customer Count column shows the count of the customers.
  • The Order Count column shows the number of orders.
  • The status column shows the status of the record.
  • The updated at column shows the last updated time.
  • Actions column includes View, Update and Trash. By clicking on view, details of the customer group can be seen. And by clicking on the update button, records can be updated. And the trash button is for trashing and restoring the data.

Details about customer groups filters

  • There is a Filters button on the right side of the search bar. By clicking on this button, a filter page will open. On this page there are several filters. These filters can be used to filter records.
  • Date Range Filter: This filter filters the records between the given dates.
  • Status: This filter can be used to filter the record on the basis of the status of the record.

API


create

URL
POST <public-url>/public/api/store/customergroups

Request samples

parameter = [
    "customer_count",                        // Integer
    "order_count",                           // Integer
    "taxonomy_id_customer_groups_status",    // Id
    "name",                                  // String
    "slug",                                  // String
    "status",                                // Object
    "status_notes",                          // String
];

Response sample

{
    "status": "success",
    "messages": [
        "Saved"
    ],
    "data": {
        ...........
        ...........
        ...........
    }
}

Get List

URL

GET <public-url>/public/api/store/customergroups?rows={number_of_rows}

Response sample

{
    "success": true,
    "data": {
        ...........
        ...........
        ...........
    }
}

Get Record

URL

GET <public-url>/public/api/store/customergroups/{record_id}

Response sample

{
    "success": true,
    "data": {
        ...........
        ...........
        ...........
    }
}

Copyright © 2024