Customer Group

Get customer list from vendor group

get

Retrieves a list of customers from a vendor's customer group, with pagination and filter options.

Query parameters
limitintegerOptional

The number of results to return.

Default: 10
offsetintegerOptional

The starting point for the result set.

Default: 0
countintegerOptional

A parameter to toggle count behavior.

Default: 0
Header parameters
AuthorizationstringRequired
Responses
200

Successfully retrieved the customer list.

get
GET /backend/api/vendor-customer-group HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got customer list</message>
</object>

Create a new customer group

post

Creates a new customer group using form data.

Header parameters
AuthorizationstringRequired
Body
namestringRequired

The name of the customer group.

Responses
201

Successfully created the customer group.

post
POST /backend/api/vendor-customer-group HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 15

"name='text'"
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully created customer group</message>
</object>

Update customer group status

put

Updates the status of a specific customer group by its ID.

Path parameters
idintegerRequired

The ID of the customer group to update.

Header parameters
AuthorizationstringRequired
Body
statusintegerRequired

The new status of the customer group (e.g., 0 for inactive, 1 for active).

idintegerRequired

The ID of the customer group being updated.

Responses
200

Successfully updated the customer group status.

put
PUT /backend/api/vendor-customer-group/status/{id} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 19

"status=1&id=1"
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully update customer group status</message>
</object>

Get customer group details

get

Retrieves the details of a specific customer group by its ID.

Path parameters
idintegerRequired

The ID of the customer group to retrieve.

Header parameters
AuthorizationstringRequired
Responses
200

Successfully retrieved the customer group details.

get
GET /backend/api/vendor-customer-group/{id} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got customer groups detail</message>
</object>

Update customer group details

put

Updates the details of a specific customer group by its ID.

Path parameters
idintegerRequired

The ID of the customer group to update.

Header parameters
AuthorizationstringRequired
Body
idintegerRequired

The ID of the customer group being updated.

namestringRequired

The new name for the customer group.

Responses
200

Successfully updated the customer group.

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

"id=1&name='text'"
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully updated customer group</message>
</object>

Delete customer group

delete

Deletes a specific customer group by its ID.

Path parameters
idintegerRequired

The ID of the customer group to delete.

Header parameters
AuthorizationstringRequired
Responses
200

Successfully deleted the customer group.

delete
DELETE /backend/api/vendor-customer-group/{id} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully deleted customer group</message>
</object>

Last updated