Customer Group

PreviousCustomer NextQuestion and Answer

Last updated 22 days ago

Get customer list from vendor group

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

get

/vendor-customer-group

Query parameters

limitinteger

The number of results to return.

offsetinteger

The starting point for the result set.

countinteger

A parameter to toggle count behavior.

Header parameters

Authorizationstringrequired

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://139.59.67.17/backend/api/vendor-customer-group' \
  --header 'Authorization: text'

200

400

500

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

Successfully retrieved the customer list.

Create a new customer group

Creates a new customer group using form data.

post

/vendor-customer-group

Header parameters

Authorizationstringrequired

Body

namestringrequired

The name of the customer group.

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://139.59.67.17/backend/api/vendor-customer-group' \
  --header 'Authorization: text' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data '{"name":"text"}'

201

400

500

{
  "status": 1,
  "message": "Successfully created customer group"
}

Successfully created the customer group.

Update customer group status

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

put

/vendor-customer-group/status/{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

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'http://139.59.67.17/backend/api/vendor-customer-group/status/{id}' \
  --header 'Authorization: text' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data '{"status":1,"id":1}'

200

400

404

500

{
  "status": 1,
  "message": "Successfully update customer group status"
}

Successfully updated the customer group status.

Get customer group details

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

get

/vendor-customer-group/{id}

Path parameters

idintegerrequired

The ID of the customer group to retrieve.

Header parameters

Authorizationstringrequired

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://139.59.67.17/backend/api/vendor-customer-group/{id}' \
  --header 'Authorization: text'

200

404

500

{
  "status": 1,
  "message": "Successfully got customer groups detail"
}

Successfully retrieved the customer group details.

Update customer group details

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

put

/vendor-customer-group/{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

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'http://139.59.67.17/backend/api/vendor-customer-group/{id}' \
  --header 'Authorization: text' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data '{"id":1,"name":"text"}'

200

400

404

500

{
  "status": 1,
  "message": "Successfully updated customer group"
}

Successfully updated the customer group.

Delete customer group

Deletes a specific customer group by its ID.

delete

/vendor-customer-group/{id}

Path parameters

idintegerrequired

The ID of the customer group to delete.

Header parameters

Authorizationstringrequired

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'http://139.59.67.17/backend/api/vendor-customer-group/{id}' \
  --header 'Authorization: text'

200

404

500

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

Successfully deleted the customer group.