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. Vendor API
  3. Profile
  4. Account Settings

My Shop

PreviousMy ProfileNextPersonalised Setting

Last updated 4 months ago

Get the details of a specific vendor document by ID

get

This endpoint allows fetching details of a specific vendor document by its unique ID.

Path parameters
idintegerRequired

The unique identifier of the document.

Header parameters
AuthorizationstringRequired

Bearer token for vendor authentication

Responses
200
Document details fetched successfully.
400
Bad request. Invalid document ID.
404
Document not found for the provided ID.
500
Internal server error.
get
GET /backend/api/vendor-document/{id} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got document  details</message>
</object>

Get vendor profile details

get

Retrieve the profile information for the authenticated vendor.

Header parameters
AuthorizationstringRequired

Bearer token for vendor authentication

Responses
200
Successfully retrieved vendor profile.
401
Unauthorized access. Token is missing or invalid.
500
Internal server error.
get
GET /backend/api/vendor/vendor-profile HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>successfully got seller profile</message>
</object>
  • GETGet list of vendor documents
  • POSTUpload a vendor document
  • POSTUpload a media file
  • GETGet the details of a specific vendor document by ID
  • PUTEdit vendor details
  • GETGet vendor profile details

Get list of vendor documents

get

Fetches a list of vendor documents based on the provided filters.

Query parameters
limitintegerOptional

Number of documents to return per page

offsetintegerOptional

The offset for pagination

countintegerOptional

Flag to indicate if count is requested

vendorIdintegerRequired

ID of the vendor

Header parameters
AuthorizationstringRequired

Bearer token for vendor authentication

Responses
200
Successfully retrieved the list of vendor documents.
400
Bad request. Invalid input data.
500
Internal server error.
get
GET /backend/api/vendor-document HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got document list</message>
</object>

Upload a vendor document

post

This endpoint allows the upload of a document for a vendor.

Header parameters
AuthorizationstringRequired

Bearer token for vendor authentication

Body
filestring · binaryOptional

The document file to upload.

vendorIdinteger · int32Optional

The ID of the vendor uploading the document.

documentTypestringOptional

The type of the document being uploaded (e.g., 'invoice', 'contract').

Responses
200
Document uploaded successfully.
400
Bad request. Invalid input data.
500
Internal server error.
post
POST /backend/api/vendor-document HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: multipart/form-data
Accept: */*
Content-Length: 52

{
  "file": "binary",
  "vendorId": 1,
  "documentType": "text"
}
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Document Upload Successfully</message>
</object>

Upload a media file

post

This endpoint allows uploading a media file (such as an image or document) to the server.

Header parameters
AuthorizationstringRequired

Bearer token for vendor authentication

Body
fileNamestringOptional

The name of the file being uploaded.

fileTypeinteger · int32Optional

The type of file being uploaded (e.g., image = 1, document = 2).

pathstringOptional

The path where the file should be stored.

imagestringOptional

Base64 encoded image or document file content.

documentIdinteger · int32Optional

The document ID (for documents).

Responses
200
Successfully uploaded the file.
400
Bad request. Invalid input data.
500
Internal server error.
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: 76

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

Edit vendor details

put

Update the vendor details by providing the vendor ID and the new data via form data.

Path parameters
customerIdintegerRequired

ID of the vendor to be updated

Header parameters
AuthorizationstringRequired

Bearer token for vendor authentication

Body
dobstring · dateOptional

Date of Birth

emailstringOptional

Email address

firstNamestringOptional

First Name

genderstringOptional

Gender

lastNamestringOptional

Last Name

mobileNumberstringOptional

Mobile number

usernamestringOptional

Username

vendorMediastring[]Optional

Media related to the vendor

passwordstringOptional

Password

resetinteger · int32Optional

Flag to reset password

Responses
200
Successfully updated the vendor details.
400
Bad request. Invalid input data.
404
Vendor not found.
500
Internal server error.
put
PUT /backend/api/vendor/edit-vendor/{customerId} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 179

"dob='2025-06-18'&email='text'&firstName='text'&gender='text'&lastName='text'&mobileNumber='text'&username='text'&vendorMedia=['text']&password='text'&reset=1"
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully Updated ..!</message>
</object>