Manage Buyer

Get customer count

get

This endpoint retrieves the total count of customers.

Responses

200

Successfully got the buyer count

application/xmlapplication/json

get

HTTPcURLJavaScriptPython

GET /backend/api/admin-customer/customer-count HTTP/1.1
Host: 139.59.67.17
Accept: */*

200

Successfully got the buyer count

<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got the buyer Count</message>
</object>

Get customer list

get

This endpoint retrieves the list of customers with optional filters such as customer group, date, email, and name.

Query parameters

customerGroupstringOptional

Filter by customer group

datestring · dateOptional

Filter by date

keywordstringOptional

Search by keyword

emailstringOptional

Filter by email address

namestringOptional

Filter by customer name

limitintegerOptional

Limit the number of results

offsetintegerOptional

Offset for pagination

countintegerOptional

Indicates if only count is returned (1 for count, 0 for list)

statusstringOptional

Filter by customer status

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully got the customer list

application/xmlapplication/json

get

HTTPcURLJavaScriptPython

GET /backend/api/admin-customer HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

200

Successfully got the customer list

<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got Customer list.</message>
</object>

Create a new customer

post

This endpoint allows the creation of a new customer with the provided details.

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Body

customerGroupIdintegerRequiredExample: 75

usernamestringRequiredExample: test

emailstringRequiredExample: [e-mail]

mobileNumberstringRequiredExample: 4364536456

passwordstringRequiredExample: Picco123@

confirmPasswordstringRequiredExample: Picco123@

avatarstringOptional

newsletterstringOptional

mailStatusintegerOptionalExample: 0

statusstringRequiredExample: 1

siteIdintegerRequiredExample: 2

Responses

200

Successfully created a new customer

application/xmlapplication/json

post

HTTPcURLJavaScriptPython

POST /backend/api/admin-customer HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 213

"customerGroupId=75&username='test'&email='[e-mail]'&mobileNumber='4364536456'&password='Picco123@'&confirmPassword='Picco123@'&avatar=''&newsletter=''&mailStatus=0&status='1'&siteId=2"

200

Successfully created a new customer

<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Buyer created successfully</message>
</object>

Get customer group list

get

This endpoint retrieves the list of customer groups with optional filters such as keyword, limit, and offset.

Query parameters

limitintegerOptional

Limit the number of results

offsetintegerOptional

Offset for pagination

keywordstringOptional

Search by keyword

countintegerOptional

Indicates if only count is returned (1 for count, 0 for list)

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully got all customer group list

application/xmlapplication/json

get

HTTPcURLJavaScriptPython

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

200

Successfully got all customer group list

<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got all customer group List</message>
</object>

Get system settings

get

This endpoint retrieves the current system settings.

Responses

200

Successfully retrieved settings

application/xmlapplication/json

get

HTTPcURLJavaScriptPython

GET /backend/api/settings HTTP/1.1
Host: 139.59.67.17
Accept: */*

200

Successfully retrieved settings

<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got settings</message>
</object>

Get customer details

get

Retrieves the details of a specific customer by their ID

Path parameters

idintegerRequired

ID of the customer

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully retrieved customer details

application/xmlapplication/json

404

Customer not found

application/xmlapplication/json

get

HTTPcURLJavaScriptPython

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

<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got buyer details</message>
</object>

Update a customer

put

Updates the details of a specific customer

Path parameters

idintegerRequired

ID of the customer

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Body

customerGroupIdintegerOptional

usernamestringOptional

emailstringOptional

mobileNumberstringOptional

passwordstringOptional

confirmPasswordstringOptional

avatarstringOptional

newsletterstringOptional

mailStatusintegerOptional

statusstringOptional

siteIdintegerOptional

customerIdstringOptional

Responses

200

Successfully updated the customer

application/xmlapplication/json

404

Customer not found

application/xmlapplication/json

put

HTTPcURLJavaScriptPython

PUT /backend/api/admin-customer/{id} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 217

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

<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Buyer updated successfully</message>
</object>