GET /api/vendor-customer-group?limit=10&offset=0&keyword=&groupName=&status=1&count=0 HTTP/1.1
Host: <API_HOST>
Accept: application/json
Authorization: Bearer <ACCESS_TOKEN>

{
  "status": 1,
  "message": "Request processed successfully",
  "data": [
    {
      "customerGroupId": 1,
      "name": "Retail Customers",
      "status": 1
    }
  ]
}

{
  "status": 0,
  "message": "Invalid request or resource."
}

Customer groups

Retrieve Customer Group

Get /api/vendor-customer-group

Authentication: Vendor bearer token required for protected operations; verify exact permission decorator in controller.

Feature area: Customer Groups

Implementation source: src/api/vendor/controllers/CustomerController.ts

Request example provenance: Illustrative response envelope only. This route inventory does not include its route-specific @apiSuccessExample; response fields and messages must be verified in the matching controller/service. The example is intended to show the common response-wrapper style, not to define a guaranteed response schema.

Response example provenance: Illustrative response envelope only. This route inventory does not include its route-specific @apiSuccessExample; response fields and messages must be verified in the matching controller/service. The example is intended to show the common response-wrapper style, not to define a guaranteed response schema.

Example status: Illustrative. The example is included to demonstrate request/response shape in the reference UI; verify the owning controller and request DTO before using it as a contract.

GET

api

vendor-customer-group

GET /api/vendor-customer-group?limit=10&offset=0&keyword=&groupName=&status=1&count=0 HTTP/1.1
Host: <API_HOST>
Accept: application/json
Authorization: Bearer <ACCESS_TOKEN>

{
  "status": 1,
  "message": "Request processed successfully",
  "data": [
    {
      "customerGroupId": 1,
      "name": "Retail Customers",
      "status": 1
    }
  ]
}

{
  "status": 0,
  "message": "Invalid request or resource."
}

Authorizations

Authorization

string

header

required

Paste the JWT access token returned by the corresponding login endpoint.

Query Parameters

limit

integer

Query parameter limit.

offset

integer

Query parameter offset.

keyword

string

Query parameter keyword.

groupName

string

Query parameter groupName.

status

integer

Query parameter status.

count

integer

Query parameter count.

Response

Successful response. Illustrative response envelope only. This route inventory does not include its route-specific @apiSuccessExample; response fields and messages must be verified in the matching controller/service. The example is intended to show the common response-wrapper style, not to define a guaranteed response schema. Example is illustrative and does not guarantee a stable response contract.

status

integer

message

string

data

object[]

Show child attributes

Store API

Vendor API

Retrieve Customer Group

Authorizations

Query Parameters

Response