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. Supplier

Contact

PreviousSupplierNextSupplier

Last updated 4 months ago

Get a specific supplier contact

get

Fetches details of a specific supplier contact based on the provided contact ID.

Path parameters
idintegerRequired

The ID of the supplier contact to retrieve.

Header parameters
AuthorizationstringRequired

Bearer token for vendor authentication

Responses
200
Successfully retrieved the supplier contact.
400
Bad Request
404
Contact not found
500
Internal Server Error
get
GET /backend/api/supplier/contact/{id} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully Get supplier Contact</message>
</object>

Delete a specific supplier contact

delete

Deletes the details of a specific supplier contact based on the contact ID.

Path parameters
idintegerRequired

The ID of the supplier contact to delete.

Header parameters
AuthorizationstringRequired

Bearer token for vendor authentication

Responses
200
Successfully deleted the supplier contact.
404
Contact not found
500
Internal Server Error
delete
DELETE /backend/api/supplier/contact/{id} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Supplier Contact Deleted successfully.</message>
</object>
  • GETGet all supplier contacts
  • POSTCreate supplier contact
  • GETGet a specific supplier contact
  • PUTUpdate a specific supplier contact
  • DELETEDelete a specific supplier contact

Get all supplier contacts

get

Retrieves the list of all supplier contacts with optional pagination.

Query parameters
limitintegerOptional

Number of results to return per page.

offsetintegerOptional

Number of results to skip (for pagination).

countintegerOptional

Flag to determine if the count of contacts should be included.

Header parameters
AuthorizationstringRequired

Bearer token for vendor authentication

Responses
200
Successfully retrieved the supplier contact list.
400
Bad Request - Invalid input parameters
500
Internal Server Error
get
GET /backend/api/supplier/contacts/list HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully Get All supplier Contact List</message>
</object>

Create supplier contact

post

Creates a contact for a specific supplier.

Header parameters
AuthorizationstringRequired

Bearer token for vendor authentication

Body
namestringRequired

The name of the contact.

supplierIdinteger · int32Required

The ID of the supplier the contact belongs to.

positionstringRequired

The position of the contact in the supplier organization.

statusinteger · int32Required

The status of the contact (active/inactive).

emailstringRequired

The email address of the contact.

mobilestringRequired

The mobile number of the contact.

Responses
200
Successfully created the supplier contact.
400
Bad Request
500
Internal Server Error
post
POST /backend/api/supplier/create-contact HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 90

"name='text'&supplierId=1&position='text'&status=1&email='text'&mobile='text'"
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully Supplier Contact Created.</message>
</object>

Update a specific supplier contact

put

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

Path parameters
idintegerRequired

The ID of the supplier contact to update.

Header parameters
AuthorizationstringRequired

Bearer token for vendor authentication

Body
idintegerOptional

The ID of the supplier contact

Example: 56
namestringOptional

The name of the contact

Example: test
supplierIdintegerOptional

The ID of the associated supplier

Example: 32
positionstringOptional

The position of the contact

Example: 3
statusintegerOptional

The status of the contact (active or inactive)

Example: 0
emailstringOptional

The email address of the contact

Example: test@gmail.com
mobilestringOptional

The mobile number of the contact

Example: 5345463636
Responses
200
Successfully updated the supplier contact.
400
Bad Request
404
Contact not found
500
Internal Server Error
put
PUT /backend/api/supplier/contact/{id} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 112

"id=56&name='test'&supplierId=32&position='3'&status=0&email='test@gmail.com'&mobile='5345463636'"
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Supplier Contacts Updated Successfully.</message>
</object>