Manage Customers

Customer

Add Customer

Add a Customer to the eCommerce Portal.

POST/api/customer

Header parameters

Body

application/x-www-form-urlencoded

customerGroupId*integer (int32)

username*string

email*string

mobileNumber*integer (int32)

password*string

confirmPassword*string

newsletterinteger (int32)

mailStatus*integer (int32)

status*integer (int32)

Response

200400

Success Response

Body

application/json

customerGroupIdstring

firstNamestring

usernamestring

emailstring

mobileNumberstring

passwordstring

mailStatusstring

deleteFlaginteger

isActivestring

createdDatestring

idinteger

Request

JavaScriptCurl

const response = await fetch('/api/customer', {
    method: 'POST',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({
      "confirmPassword": "text",
      "email": "text",
      "password": "text",
      "username": "text"
    }),
});
const data = await response.json();

Response

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

Customer list

List of Customers in the eCommerce Portal.

GET/api/customer

Query parameters

Header parameters

Response

200

Success Response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/api/customer', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

Customer Details

For viewing the entire details of a Customer.

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

Path parameters

id*integer

Header parameters

Response

200400

Success Response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/api/admin-customer/customer-detail/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "successfully got Customer details."
}

Update Customer

Update any details of the Customer.

PUT/api/customer/{id}

Path parameters

id*integer

Header parameters

Body

application/x-www-form-urlencoded

customerGroupId*integer (int32)

username*string

emailstring

mobileNumber*integer (int32)

passwordstring

confirmPasswordstring

avatarstring

newsletterinteger (int32)

realNamestring

customerNostring

mailStatus*integer (int32)

status*integer (int32)

Response

200400422

Success Response

Body

application/json

createdByinteger

createdDatestring

modifiedByinteger

modifiedDatestring

idinteger

firstNamestring

lastNamestring

usernamestring

passwordstring

emailstring

mobileNumberstring

addressstring

countryIdinteger

zoneIdstring

citystring

localstring

oauthDatastring

avatarstring

newsletterinteger

avatarPathstring

customerGroupIdstring

lastLoginstring

safeinteger

ipstring

mailStatusstring

pincodestring

deleteFlaginteger

isActivestring

forgetPasswordKeystring

linkExpiresstring

lockedOnstring

Request

JavaScriptCurl

const response = await fetch('/api/customer/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({
      "username": "text"
    }),
});
const data = await response.json();

Response

{
  "createdDate": "text",
  "modifiedDate": "text",
  "firstName": "text",
  "lastName": "text",
  "username": "text",
  "password": "text",
  "email": "text",
  "mobileNumber": "text",
  "address": "text",
  "zoneId": "text",
  "city": "text",
  "local": "text",
  "oauthData": "text",
  "avatar": "text",
  "avatarPath": "text",
  "customerGroupId": "text",
  "lastLogin": "text",
  "ip": "text",
  "mailStatus": "text",
  "pincode": "text",
  "isActive": "text",
  "forgetPasswordKey": "text",
  "linkExpires": "text",
  "lockedOn": "text"
}

Delete Customer

Delete a Customer if you no longer need them.

DELETE/api/customer/{id}

Path parameters

id*integer

Header parameters

Response

200400

Success Response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/api/customer/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "Customer Deleted Successfully"
}

Recent Customerlist

List of all the recent Customers

GET/api/customer/recent-customerlist

Header parameters

Response

200

Success Response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/api/customer/recent-customerlist', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "Successfully got Customer list."
}

Today's Customer Count

Customer count as on today.

GET/api/customer/today-customercount

Header parameters

Response

200400

Success Response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/api/customer/today-customercount', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "Successfully get customerCount"
}

Delete Customer

Delete a Customer, if you no longer need them.

POST/api/customer/delete-customer

Header parameters

Body

application/x-www-form-urlencoded

customerIdarray of integer

Response

200400

Success Response

Body

application/json

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/api/customer/delete-customer', {
    method: 'POST',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "message": "Successfully deleted customer."
}

Customer List in Excel

Get the list of Customers in Excel.

GET/api/customer/customer-excel-list

Query parameters

Header parameters

Response

400

Error Response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/api/customer/customer-excel-list', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "Invalid customerId"
}

All Customer excel list

List of all the Customers in Excel.

GET/api/customer/allcustomer-excel-list

Query parameters

Header parameters

Response

400

Error Response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/api/customer/allcustomer-excel-list', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "list is empty"
}

Customer Count

Count or number of Customers in the eCommerce portal.

GET/api/customer/customer-count

Header parameters

Response

200

Success Response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/api/customer/customer-count', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "Successfully got the Customer Count"
}

Order Product List

List of Products Ordered in the eCommerce portal.

GET/api/customer/order-product-list

Query parameters

Header parameters

Response

200400

Success Response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/api/customer/order-product-list', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

Product View log list

Log list of Product Views in the eCommerce Portal.

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

Query parameters

Header parameters

Response

200

Success Response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/api/customer/product-view-log-list', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

Vendor graph list

List of Vendor related graphs.

GET/api/customer/vendor-graph-list

Query parameters

Header parameters

Response

200400

Success Response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/api/customer/vendor-graph-list', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "Successfully got the vendor graph list"
}

Customer visit list

List of Customer visits to the eCommerce portal.

GET/api/customer/customer-visit-list

Query parameters

Header parameters

Response

200

Success Response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/api/customer/customer-visit-list', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "Successfully got the customer visit list"
}

Customer Group

Create customer group

Creation of a Customer group in the eCommerce portal.

POST/api/customer-group

Header parameters

Body

application/x-www-form-urlencoded

name*string

descriptionstring

colorcode*string

status*integer (int32)

Response

200400

Success Response

Body

application/json

namestring

colorCodestring

isActivestring

createdDatestring (date-time)

groupIdinteger

Request

JavaScriptCurl

const response = await fetch('/api/customer-group', {
    method: 'POST',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({
      "colorcode": "text",
      "name": "text"
    }),
});
const data = await response.json();

Response

{
  "name": "text",
  "colorCode": "text",
  "isActive": "text",
  "createdDate": "2024-04-28T02:54:10.864Z"
}

Customer group list

List of Customer groups.

GET/api/customer-group

Query parameters

Header parameters

Response

200

Success Response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/api/customer-group', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "Successfully got all customer group List"
}

Update Customer group

Updating or editing Customer group.

PUT/api/customer-group/{id}

Path parameters

id*integer

Header parameters

Body

application/x-www-form-urlencoded

name*string

descriptionstring

colorcode*string

status*integer (int32)

Response

200400

Success Response

Body

application/json

namestring

colorCodestring

isActivestring

modifiedDatestring (date-time)

groupIdinteger

Request

JavaScriptCurl

const response = await fetch('/api/customer-group/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({
      "colorcode": "text",
      "name": "text"
    }),
});
const data = await response.json();

Response

{
  "name": "text",
  "colorCode": "text",
  "isActive": "text",
  "modifiedDate": "2024-04-28T02:54:10.864Z"
}

Delete customer group

For deleting a customer group, if no longer required.

DELETE/api/customer-group/{id}

Path parameters

id*integer

Header parameters

Body

application/x-www-form-urlencoded

groupIdinteger (int32)

Response

200400

Success Response

Body

application/json

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/api/customer-group/{id}', {
    method: 'DELETE',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "message": "Group Deleted Successfully."
}