Spurtcommerce
DocumentAPI ReferenceAdd-ons
API Reference
API Reference
  • About Spurtcommerce APIs
  • Spurtcommerce
    • Admin API
      • Admin
        • Authentication
        • My Profile
        • Support
      • Buyers
        • Manage Buyer
      • Chat
      • CMS
        • Manage Banner
        • Manage Blogs
        • Manage Pages
        • Manage SEO
      • Dashboard
      • Marketing
        • Manage Cross Selling
          • Related Products
        • Manage Promotions
          • Coupon
      • Marketplace
        • Manage Products
        • Manage Sales
        • Manage Settlements
        • Product Configuration
        • Reports
      • Sellers
        • Seller
        • Seller Group
        • Seller KYC Request
      • Settings
        • Add-ons
        • Add-ons Product Attributes
        • Localization
        • Order Fulfilment Status
        • Personalise
        • Site Settings
        • Store Settings
        • System
        • User and Permission
        • Support-Category
    • Store API
      • Account Settings
        • Customer
        • My Order
        • My Quotation
        • My Wishlist
        • Profile
        • Support
      • Checkouts
      • Store
        • Admin Contact
        • Categories
        • Home
        • Product Detail Page
    • Vendor API
      • Page 1
      • Catalogue
        • Bulk Product Imports
          • Custom
          • Standard
        • Common Product
        • Data Export
        • Pricing
        • Product Localisation
        • Product List
        • Product Variants
        • Related Products
      • CRM
        • Customer
        • Customer Group
        • Question and Answer
        • Rating and Review
      • Dashboard
      • Marketing
      • Payments
        • Archeived Payments
        • Earnings
        • Settlements
      • Profile
        • Account Settings
          • My Business
          • My KYC
          • My Profile
          • My Shop
          • Personalised Setting
        • Chat
        • Vendor
        • Support
      • Reports
      • Sales
        • Archeive Orders
        • Back Orders
        • Failed Orders
        • Orders
        • Quotation Request
        • Stock Update
        • Variant Stock Update
      • Supplier
        • Contact
        • Supplier
Powered by GitBook
On this page
  1. Spurtcommerce
  2. Admin API

Chat

PreviousManage BuyerNextCMS

Last updated 4 months ago

Get Vendor List

get

Retrieves a list of vendors for chat administration.

Query parameters
keywordstringOptional

A search keyword to filter vendor details.

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
200
Successfully got vendor details
400
Invalid request parameters
401
Unauthorized access
get
GET /backend/api/chat-admin/vendor-list HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully Got Vendor Details</message>
</object>

Get User Details

get

Fetches user details for chat administration.

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
200
Successfully retrieved user details
400
Invalid request
401
Unauthorized
get
GET /backend/api/chat-admin HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully Got User Details</message>
</object>

Get Vendor Details

get

Fetches vendor details by vendor ID.

Path parameters
vendorIdintegerRequired

ID of the vendor to fetch details for

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
200
Successfully retrieved vendor details
400
Invalid request
401
Unauthorized
404
Vendor not found
get
GET /backend/api/chat-admin/vendor/{vendorId} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully Got Vendor Details</message>
</object>

Get Chat History

get

Fetches the chat history for a given vendor.

Query parameters
vendorIdintegerRequired

ID of the vendor to fetch chat history for

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
200
Successfully retrieved chat history
400
Invalid request
401
Unauthorized
404
Chat history not found
get
GET /backend/api/chat-admin/chat-history HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully Got Chat History..!</message>
</object>

Get Seller Product Count

get

Fetches the count of products listed by a given vendor.

Query parameters
vendorIdintegerRequired

ID of the vendor to fetch the product count for

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
200
Successfully retrieved seller product count
400
Invalid request
401
Unauthorized
404
Vendor not found
get
GET /backend/api/admin-vendor-product/vendor-product-count HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got the seller product count</message>
</object>

Update Chat Seen Status

put

Updates the status of the chat to 'seen' for a given vendor.

Query parameters
vendorIdintegerRequired

ID of the vendor to update the chat seen status for

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
200
Chat seen status updated successfully
400
Invalid request
401
Unauthorized
404
Vendor not found
put
PUT /backend/api/chat-admin/chat-seen HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Chat seen Status Updated..!</message>
</object>
  • GETGet Vendor List
  • GETGet User Details
  • GETGet Vendor Details
  • GETGet Chat History
  • GETGet Seller Product Count
  • PUTUpdate Chat Seen Status
  • POSTUpload File
  • PUTDelete a specific message

Upload File

post

Upload a file (image) to the server.

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Body
imagestring · binaryRequired

The image file to upload

pathstringRequired

The folder path where the image will be saved

fileNamestringRequired

The name to assign to the uploaded file

fileTypeinteger · int32Required

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

Responses
200
Image uploaded successfully
400
Bad request, invalid file data
500
Server error, unable to process the file
post
POST /backend/api/media/upload-file HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 63

"image='binary'&path='text'&fileName='text'&fileType=1"
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Image Uploaded Successfully</message>
</object>

Delete a specific message

put
Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Body
messageIdstringRequired

Unique identifier for the message to delete

fromIdinteger · int32Required

ID of the sender

toIdinteger · int32Required

ID of the recipient

Responses
200
Message Deleted Successfully
400
Invalid input or message not found
put
PUT /backend/api/chat-admin/delete HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 40

"messageId='text'&fromId=1&toId=1"
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Message Deleted Successfully..!</message>
</object>