For the complete documentation index, see llms.txt. This page is also available as Markdown.

Supplier

Get list of suppliers

get
/supplier

Retrieves a list of suppliers with optional query parameters for filtering and pagination.

Query parameters
limitintegerOptional

The number of results to return.

Default: 10
offsetintegerOptional

The starting point for the result set.

Default: 0
keywordstringOptional

The keyword to search suppliers by.

supplierNamestringOptional

The name of the supplier to search for.

countryNamestringOptional

The country of the supplier.

categoryNamestringOptional

The category of the supplier.

mobileNumberstringOptional

The mobile number associated with the supplier.

createdDatestring · dateOptional

The date when the supplier was created.

countintegerOptional

Optional parameter to toggle count behavior.

Default: 0
Header parameters
AuthorizationstringRequired

Bearer token for vendor authentication

Responses
200

Successfully retrieved the list of suppliers.

statusintegerOptionalExample: 1
messagestringOptionalExample: Successfully Get All supplier List
get/supplier
GET /backend/api/supplier HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully Get All supplier List</message>
</object>

Create a new supplier

post
/supplier

Creates a new supplier entry with the provided details.

Header parameters
AuthorizationstringRequired

Bearer token for vendor authentication

Body
supplierNamestringOptional
taxIdstringOptional
addressstringOptional
countryIdintegerOptional
websitestringOptional
mobilestringOptional
notesstringOptional
categoryIdintegerOptional
commentsstringOptional
statusintegerOptional
tagsstringOptional
Responses
200

Successfully created a new supplier.

statusintegerOptionalExample: 1
messagestringOptionalExample: Successfully supplier Created.
post/supplier
POST /backend/api/supplier HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 396

"supplierName='text'&taxId='text'&address='text'&countryId=1&website='text'&mobile='text'&notes='text'&categoryId=1&comments='text'&status=1&tags='text'&contactDetail=[{'name':'text','position':'text','status':1,'email':'text','mobile':'text'}]&uploadDetail=[{'documentId':1,'name':'text','filePath':'text','fileName':'text','isApproved':1,'type':'text','link':'text'}]"
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully supplier Created.</message>
</object>

Get list of countries

get
/list/country-list

Retrieves a list of all available countries.

Header parameters
AuthorizationstringRequired

Bearer token for vendor authentication

Responses
200

Successfully retrieved the list of countries.

statusintegerOptionalExample: 1
messagestringOptionalExample: Successfully got the list of countries
get/list/country-list
GET /backend/api/list/country-list HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got the list of countries</message>
</object>

Get list of categories

get
/list/category

Retrieves a list of all available categories.

Header parameters
AuthorizationstringRequired

Bearer token for vendor authentication

Responses
200

Successfully retrieved the list of categories.

statusintegerOptionalExample: 1
messagestringOptionalExample: Successfully got the list of categories
get/list/category
GET /backend/api/list/category HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got the list of categories</message>
</object>

Get details of a supplier

get
/supplier/{id}

Retrieves the details of a specific supplier by their ID.

Path parameters
idintegerRequired

The ID of the supplier to retrieve.

Header parameters
AuthorizationstringRequired

Bearer token for vendor authentication

Responses
200

Successfully retrieved the supplier details.

statusintegerOptionalExample: 1
messagestringOptionalExample: Successfully Get supplier
get/supplier/{id}
GET /backend/api/supplier/{id} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully Get supplier</message>
</object>

Update supplier details

put
/supplier/{id}

Updates the details of a specific supplier based on their ID.

Path parameters
idintegerRequired

The ID of the supplier to update.

Header parameters
AuthorizationstringRequired

Bearer token for vendor authentication

Body
supplierNamestringOptional
taxIdstringOptional
addressstringOptional
countryIdintegerOptional
websitestringOptional
mobilestringOptional
notesstringOptional
categoryIdintegerOptional
commentsstringOptional
statusintegerOptional
tagsstringOptional
idintegerOptional
contactDeleteIdinteger[]Optional
uploadDeleteIdinteger[]Optional
Responses
200

Successfully updated the supplier details.

statusintegerOptionalExample: 1
messagestringOptionalExample: Supplier Updated Successfully.
put/supplier/{id}
PUT /backend/api/supplier/{id} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 710

"supplierName='text'&taxId='text'&address='text'&countryId=1&website='text'&mobile='text'&notes='text'&categoryId=1&comments='text'&status=1&tags='text'&contactDetail=[{'createdBy':'text','createdDate':'text','modifiedBy':'text','modifiedDate':'text','id':1,'supplierId':1,'name':'text','email':'text','mobile':'text','isActive':1,'isDelete':1,'position':'text'}]&uploadDetail=[{'createdBy':'text','createdDate':'text','modifiedBy':'text','modifiedDate':'text','id':1,'supplierId':1,'documentId':1,'name':'text','filePath':'text','fileName':'text','link':'text','isApproved':1,'isDelete':1,'isActive':1,'UploadType':1,'type':'text'}]&id=1&contactDeleteId=[1]&uploadDeleteId=[1]"
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Supplier Updated Successfully.</message>
</object>

Delete a supplier

delete
/supplier/{id}

Deletes a specific supplier based on the supplied supplier ID.

Path parameters
idintegerRequired

The ID of the supplier to delete.

Header parameters
AuthorizationstringRequired

Bearer token for vendor authentication

Responses
200

Successfully deleted the supplier.

statusintegerOptionalExample: 1
messagestringOptionalExample: Supplier Deleted successfully.
delete/supplier/{id}
DELETE /backend/api/supplier/{id} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Supplier Deleted successfully.</message>
</object>

Get list of vendor documents

get
/vendor-document/document

Fetches a list of documents associated with the vendor.

Responses
200

Successfully retrieved the list of vendor documents.

statusintegerOptionalExample: 1
messagestringOptionalExample: Successfully got documents list
get/vendor-document/document
GET /backend/api/vendor-document/document HTTP/1.1
Host: 139.59.67.17
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got documents list</message>
</object>

Upload a file (image, document, etc.)

post
/media/upload-file

Uploads a media file (image or document) to a specific path.

Header parameters
AuthorizationstringRequired

Bearer token for vendor authentication

Body
filestring · binaryRequired

The file to be uploaded (image or document).

fileNamestringRequired

The name of the file being uploaded.

fileTypeinteger · int32Required

The type of the file (e.g., image, document).

pathstringRequired

The path where the file should be stored on the server.

imagestringOptional

The image content, can be base64 encoded (if file is an image).

documentIdinteger · int32Optional

An identifier for the document (if applicable).

Responses
200

Successfully uploaded the media file.

statusintegerOptionalExample: 1
messagestringOptionalExample: Image Uploaded Successfully
post/media/upload-file
POST /backend/api/media/upload-file HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: multipart/form-data
Accept: */*
Content-Length: 92

{
  "file": "binary",
  "fileName": "text",
  "fileType": 1,
  "path": "text",
  "image": "text",
  "documentId": 1
}
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Image Uploaded Successfully</message>
</object>

Last updated