POST /api/vendor-customer HTTP/1.1
Host: <API_HOST>
Accept: application/json
Authorization: Bearer <ACCESS_TOKEN>
Content-Type: application/json

{
  "customerGroupId": 1,
  "username": "sample.customer",
  "email": "customer@example.com",
  "mobileNumber": "9876543210",
  "password": "<PASSWORD>",
  "confirmPassword": "<PASSWORD>",
  "newsletter": 1,
  "mailStatus": 1,
  "status": 1,
  "firstName": "Asha",
  "lastName": "Kumar"
}

{
  "status": 1,
  "message": "Customer created successfully.",
  "data": {
    "id": 1,
    "username": "sample.customer",
    "email": "customer@example.com",
    "firstName": "Asha",
    "lastName": "Kumar"
  }
}

{
  "status": 0,
  "message": "Invalid customer details"
}

Customer directory

Create or process Customer

Post /api/vendor-customer

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

Feature area: Customers

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

Request example provenance: Source-defined in CustomerController API comments; use a password that meets validation.

Response example provenance: Success envelope illustrative; fields shown are from the request DTO and controller response family.

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.

POST

api

vendor-customer

POST /api/vendor-customer HTTP/1.1
Host: <API_HOST>
Accept: application/json
Authorization: Bearer <ACCESS_TOKEN>
Content-Type: application/json

{
  "customerGroupId": 1,
  "username": "sample.customer",
  "email": "customer@example.com",
  "mobileNumber": "9876543210",
  "password": "<PASSWORD>",
  "confirmPassword": "<PASSWORD>",
  "newsletter": 1,
  "mailStatus": 1,
  "status": 1,
  "firstName": "Asha",
  "lastName": "Kumar"
}

{
  "status": 1,
  "message": "Customer created successfully.",
  "data": {
    "id": 1,
    "username": "sample.customer",
    "email": "customer@example.com",
    "firstName": "Asha",
    "lastName": "Kumar"
  }
}

{
  "status": 0,
  "message": "Invalid customer details"
}

Authorizations

Authorization

string

header

required

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

Body

application/json

Sample request body. Source-defined in CustomerController API comments; use a password that meets validation.

customerGroupId

integer

username

string

mobileNumber

string

password

string

write-only

confirmPassword

string

mailStatus

integer

status

integer

firstName

string

lastName

string

Response

Successful response. Success envelope illustrative; fields shown are from the request DTO and controller response family. Example is illustrative and does not guarantee a stable response contract.

status

integer

message

string

data

object

Show child attributes

Store API

Vendor API

Create or process Customer

Authorizations

Body

Response