Manage Customers

Customer

Add Customer

post

Add a Customer to the eCommerce Portal.

Header parameters

AuthorizationstringRequired

Body

application/x-www-form-urlencoded

customerGroupIdinteger · int32Required

usernamestringRequired

emailstringRequired

mobileNumberinteger · int32Required

passwordstringRequired

confirmPasswordstringRequired

newsletterinteger · int32Optional

mailStatusinteger · int32Required

statusinteger · int32Required

Responses

200

Success Response

application/json

400

Error Response

application/json

post

/api/customer

HTTPcURLJavaScriptPython

POST /api/customer HTTP/1.1
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 155

"customerGroupId=1&username='text'&email='text'&mobileNumber=1&password='text'&confirmPassword='text'&newsletter=1&mailStatus=1&status=1"

{
  "customerGroupId": "text",
  "firstName": "text",
  "username": "text",
  "email": "text",
  "mobileNumber": "text",
  "password": "text",
  "mailStatus": "text",
  "deleteFlag": 1,
  "isActive": "text",
  "createdDate": "text",
  "id": 1
}

Customer list

get

List of Customers in the eCommerce Portal.

Query parameters

limitintegerRequired

offsetintegerOptional

namestringOptional

emailstringOptional

statusintegerOptional

customerGroupstringOptional

datestringOptional

countintegerOptional

Header parameters

AuthorizationstringRequired

Responses

200

Success Response

*/*

get

/api/customer

HTTPcURLJavaScriptPython

GET /api/customer?limit=1 HTTP/1.1
Authorization: text
Accept: */*

200

Success Response

{
  "status": "1",
  "message": "Successfully got count \" or \" Successfully got Customer list."
}

Customer Details

get

For viewing the entire details of a Customer.

Path parameters

idintegerRequired

Header parameters

AuthorizationstringRequired

Responses

200

Success Response

*/*

400

Error Response

*/*

get

/api/admin-customer/customer-detail/{id}

HTTPcURLJavaScriptPython

GET /api/admin-customer/customer-detail/{id} HTTP/1.1
Authorization: text
Accept: */*

{
  "status": "1",
  "message": "successfully got Customer details."
}

Update Customer

put

Update any details of the Customer.

Path parameters

idintegerRequired

Header parameters

AuthorizationstringRequired

Body

application/x-www-form-urlencoded

customerGroupIdinteger · int32Required

usernamestringRequired

emailstringOptional

mobileNumberinteger · int32Required

passwordstringOptional

confirmPasswordstringOptional

avatarstringOptional

newsletterinteger · int32Optional

realNamestringOptional

customerNostringOptional

mailStatusinteger · int32Required

statusinteger · int32Required

Responses

200

Success Response

application/json

400

Error Response

application/json

422

Error Response

application/json

put

/api/customer/{id}

HTTPcURLJavaScriptPython

PUT /api/customer/{id} HTTP/1.1
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 209

"customerGroupId=1&username='text'&email='text'&mobileNumber=1&password='text'&confirmPassword='text'&avatar='text'&newsletter=1&realName='text'&customerNo='text'&mailStatus=1&status=1"

{
  "createdBy": 1,
  "createdDate": "text",
  "modifiedBy": 1,
  "modifiedDate": "text",
  "id": 1,
  "firstName": "text",
  "lastName": "text",
  "username": "text",
  "password": "text",
  "email": "text",
  "mobileNumber": "text",
  "address": "text",
  "countryId": 1,
  "zoneId": "text",
  "city": "text",
  "local": "text",
  "oauthData": "text",
  "avatar": "text",
  "newsletter": 1,
  "avatarPath": "text",
  "customerGroupId": "text",
  "lastLogin": "text",
  "safe": 1,
  "ip": "text",
  "mailStatus": "text",
  "pincode": "text",
  "deleteFlag": 1,
  "isActive": "text",
  "forgetPasswordKey": "text",
  "linkExpires": "text",
  "lockedOn": "text"
}

Delete Customer

delete

Delete a Customer if you no longer need them.

Path parameters

idintegerRequired

Header parameters

AuthorizationstringRequired

Responses

200

Success Response

*/*

400

Error Response

*/*

delete

/api/customer/{id}

HTTPcURLJavaScriptPython

DELETE /api/customer/{id} HTTP/1.1
Authorization: text
Accept: */*

{
  "status": "1",
  "message": "Customer Deleted Successfully"
}

Recent Customerlist

get

List of all the recent Customers

Header parameters

AuthorizationstringRequired

Responses

200

Success Response

*/*

get

/api/customer/recent-customerlist

HTTPcURLJavaScriptPython

GET /api/customer/recent-customerlist HTTP/1.1
Authorization: text
Accept: */*

200

Success Response

{
  "status": "1",
  "message": "Successfully got Customer list."
}

Today's Customer Count

get

Customer count as on today.

Header parameters

AuthorizedstringRequired

Responses

200

Success Response

*/*

400

Error Response

*/*

get

/api/customer/today-customercount

HTTPcURLJavaScriptPython

GET /api/customer/today-customercount HTTP/1.1
Authorized: text
Accept: */*

{
  "status": "1",
  "message": "Successfully get customerCount"
}

Delete Customer

post

Delete a Customer, if you no longer need them.

Header parameters

AuthorizationstringRequired

Body

application/x-www-form-urlencoded

customerIdinteger[]Optional

Responses

200

Success Response

application/json

400

Error Response

application/json

post

/api/customer/delete-customer

HTTPcURLJavaScriptPython

POST /api/customer/delete-customer HTTP/1.1
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 18

"customerId=[1]"

{
  "status": "1",
  "message": "Successfully deleted customer."
}

Customer List in Excel

get

Get the list of Customers in Excel.

Query parameters

customerIdstringRequired

Header parameters

AuthorizationstringRequired

Responses

400

Error Response

*/*

get

/api/customer/customer-excel-list

HTTPcURLJavaScriptPython

GET /api/customer/customer-excel-list?customerId=text HTTP/1.1
Authorization: text
Accept: */*

400

Error Response

{
  "status": 1,
  "message": "Invalid customerId"
}

All Customer excel list

get

List of all the Customers in Excel.

Query parameters

namestringRequired

statusintegerRequired

emailstringRequired

customerGroupstringOptional

datestringOptional

Header parameters

AuthorizationstringRequired

Responses

400

Error Response

*/*

get

/api/customer/allcustomer-excel-list

HTTPcURLJavaScriptPython

GET /api/customer/allcustomer-excel-list?name=text&status=1&email=text HTTP/1.1
Authorization: text
Accept: */*

400

Error Response

{
  "status": 1,
  "message": "list is empty"
}

Customer Count

get

Count or number of Customers in the eCommerce portal.

Header parameters

AuthorizationstringRequired

Responses

200

Success Response

*/*

get

/api/customer/customer-count

HTTPcURLJavaScriptPython

GET /api/customer/customer-count HTTP/1.1
Authorization: text
Accept: */*

200

Success Response

{
  "status": "1",
  "message": "Successfully got the Customer Count"
}

Order Product List

get

List of Products Ordered in the eCommerce portal.

Query parameters

limitintegerRequired

offsetintegerOptional

countintegerOptional

customerIdintegerOptional

Header parameters

AuthorizationstringRequired

Responses

200

Success Response

*/*

400

Error Response

*/*

get

/api/customer/order-product-list

HTTPcURLJavaScriptPython

GET /api/customer/order-product-list?limit=1 HTTP/1.1
Authorization: text
Accept: */*

{
  "status": "1",
  "message": "Successfully got the count of order product count \" or \" Successfully got order product list"
}

Product View log list

get

Log list of Product Views in the eCommerce Portal.

Query parameters

limitintegerRequired

offsetintegerOptional

countintegerOptional

customerIdintegerOptional

Header parameters

AuthorizationstringRequired

Responses

200

Success Response

*/*

get

/api/customer/product-view-log-list

HTTPcURLJavaScriptPython

GET /api/customer/product-view-log-list?limit=1 HTTP/1.1
Authorization: text
Accept: */*

200

Success Response

{
  "status": "1",
  "message": "Successfully got the count of order product count \" or \" Successfully got order product list"
}

Vendor graph list

get

List of Vendor related graphs.

Query parameters

vendorIdintegerRequired

durationintegerRequired

Header parameters

AuthorizationstringRequired

Responses

200

Success Response

*/*

400

Error Response

*/*

get

/api/customer/vendor-graph-list

HTTPcURLJavaScriptPython

GET /api/customer/vendor-graph-list?vendorId=1&duration=1 HTTP/1.1
Authorization: text
Accept: */*

{
  "status": "1",
  "message": "Successfully got the vendor graph list"
}

Customer visit list

get

List of Customer visits to the eCommerce portal.

Query parameters

monthintegerRequired

yearintegerRequired

Header parameters

AuthorizationstringRequired

Responses

200

Success Response

*/*

get

/api/customer/customer-visit-list

HTTPcURLJavaScriptPython

GET /api/customer/customer-visit-list?month=1&year=1 HTTP/1.1
Authorization: text
Accept: */*

200

Success Response

{
  "status": "1",
  "message": "Successfully got the customer visit list"
}

Customer Group

Create customer group

post

Creation of a Customer group in the eCommerce portal.

Header parameters

AuthorizationstringRequired

Body

application/x-www-form-urlencoded

namestringRequired

descriptionstringOptional

colorcodestringRequired

statusinteger · int32Required

Responses

200

Success Response

application/json

400

Error Response

application/json

post

/api/customer-group

HTTPcURLJavaScriptPython

POST /api/customer-group HTTP/1.1
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 66

"name='text'&description='text'&colorcode='text'&status=1"

{
  "name": "text",
  "colorCode": "text",
  "isActive": "text",
  "createdDate": "2026-02-03T16:56:12.912Z",
  "groupId": 1
}

Customer group list

get

List of Customer groups.

Query parameters

limitintegerOptional

offsetintegerOptional

keywordstringOptional

statusstringOptional

countstringOptional

Header parameters

AuthorizationstringRequired

Responses

200

Success Response

*/*

get

/api/customer-group

HTTPcURLJavaScriptPython

GET /api/customer-group HTTP/1.1
Authorization: text
Accept: */*

200

Success Response

{
  "status": 1,
  "message": "Successfully got all customer group List"
}

Update Customer group

put

Updating or editing Customer group.

Path parameters

idintegerRequired

Header parameters

AuthorizationstringRequired

Body

application/x-www-form-urlencoded

namestringRequired

descriptionstringOptional

colorcodestringRequired

statusinteger · int32Required

Responses

200

Success Response

application/json

400

Error Response

application/json

put

/api/customer-group/{id}

HTTPcURLJavaScriptPython

PUT /api/customer-group/{id} HTTP/1.1
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 66

"name='text'&description='text'&colorcode='text'&status=1"

{
  "name": "text",
  "colorCode": "text",
  "isActive": "text",
  "modifiedDate": "2026-02-03T16:56:12.912Z",
  "groupId": 1
}

Delete customer group

delete

For deleting a customer group, if no longer required.

Path parameters

idintegerRequired

Header parameters

AuthorizationstringRequired

Body

application/x-www-form-urlencoded

groupIdinteger · int32Optional

Responses

200

Success Response

application/json

400

Error Response

application/json

delete

/api/customer-group/{id}

HTTPcURLJavaScriptPython

DELETE /api/customer-group/{id} HTTP/1.1
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 13

"groupId=1"

{
  "status": 1,
  "message": "Group Deleted Successfully."
}