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

Support

PreviousVendorNextReports

Last updated 14 days ago

Get Vendor Support Ticket Categories

get

This API retrieves a list of vendor support ticket categories based on the provided query parameters.

Query parameters
limitintegerOptional

Limit number of records.

offsetintegerOptional

Pagination offset.

keywordstringOptional

Search keyword.

parentCategoryIdstringOptional

Filter by parent category ID.

statusstringOptional

Filter by status.

Header parameters
AuthorizationstringRequired

Bearer token is required.

Responses
200
Successful response with category list
application/json
500
Server error
application/json
get
GET /backend/api/vendor-support-ticket/ticket-category HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
{
  "status": "1",
  "message": "Success",
  "data": [
    {
      "createdBy": "admin",
      "createdDate": "2025-04-21T12:00:00Z",
      "modifiedBy": "admin",
      "modifiedDate": "2025-04-21T12:00:00Z",
      "id": "1",
      "categoryName": "Technical",
      "parentCategoryId": "0",
      "isActive": true,
      "isDelete": false
    }
  ]
}

Get Vendor Support Tickets

get

Retrieves a list of vendor support tickets based on query parameters.

Query parameters
limitintegerOptional

Limit the number of results.

offsetintegerOptional

Number of items to skip.

keywordstringOptional

Keyword to search tickets.

countintegerOptional

Flag to return only the count of tickets.

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
200
Successfully retrieved vendor support tickets
application/json
500
Failed to retrieve vendor support ticket
application/json
get
GET /backend/api/vendor-support-ticket HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
{
  "status": "text",
  "message": "text",
  "data": {
    "categoryId": 1,
    "subCategoryId": 1,
    "refId": "text",
    "subject": "text",
    "description": "text",
    "status": "text",
    "userId": 1,
    "userType": "text",
    "createdDate": "2025-06-01T00:53:23.316Z",
    "id": 1
  }
}

Get Vendor Support Ticket Details

get

Retrieves the details of a specific vendor support ticket by ID.

Path parameters
idintegerRequired

The ID of the vendor support ticket.

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
200
Successfully retrieved ticket details
application/json
500
Failed to retrieve ticket details
application/json
get
GET /backend/api/vendor-support-ticket/{id} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
{
  "status": "text",
  "message": "text",
  "data": {
    "createdBy": "text",
    "createdDate": "2025-06-01T00:53:23.316Z",
    "modifiedBy": "text",
    "modifiedDate": "2025-06-01T00:53:23.316Z",
    "id": 1,
    "refId": "text",
    "userId": 1,
    "userType": "text",
    "categoryId": 1,
    "subCategoryId": 1,
    "subject": "text",
    "description": "text",
    "isActive": true,
    "isDelete": true,
    "status": "text",
    "ticketMessage": [
      {
        "createdBy": "text",
        "createdDate": "2025-06-01T00:53:23.316Z",
        "modifiedBy": "text",
        "modifiedDate": "2025-06-01T00:53:23.316Z",
        "id": 1,
        "ticketId": 1,
        "senderId": 1,
        "senderType": "text",
        "message": "text",
        "sentAt": "2025-06-01T00:53:23.316Z",
        "isActive": true,
        "isDelete": true,
        "createdByType": "text",
        "modifiedByType": "text",
        "ticketAttachments": [
          {}
        ]
      }
    ]
  }
}
  • GETGet Vendor Support Ticket Categories
  • GETGet Vendor Support Tickets
  • POSTCreate Vendor Support Ticket
  • GETGet Vendor Support Ticket Details
  • PUTUpdate Vendor Support Ticket Status

Create Vendor Support Ticket

post

Allows vendors to create a support ticket with optional attachments.

Header parameters
AuthorizationstringRequired

Bearer token is required.

Body
categoryIdintegerRequired
subCategoryIdintegerRequired
ticketIdinteger | nullableOptional
subjectstringRequired
descriptionstringRequired
messagestringRequired
Responses
200
Vendor support ticket created successfully
application/json
500
Failed to create vendor support ticket
application/json
post
POST /backend/api/vendor-support-ticket HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 268

{
  "categoryId": 1,
  "subCategoryId": 2,
  "ticketId": 123,
  "subject": "Issue with product delivery",
  "description": "The product was not delivered on time.",
  "message": "Please assist as soon as possible.",
  "attachments": [
    {
      "fileName": "invoice.pdf",
      "filePath": "/uploads/invoice.pdf"
    }
  ]
}
{
  "status": "text",
  "message": "text",
  "data": {
    "ticketId": 1,
    "categoryId": 1,
    "subCategoryId": 1,
    "subject": "text",
    "description": "text",
    "message": "text",
    "attachments": [
      {
        "fileName": "text",
        "filePath": "text"
      }
    ]
  }
}

Update Vendor Support Ticket Status

put

Updates the status of a specific vendor support ticket by ID.

Path parameters
idintegerRequired

The ID of the vendor support ticket.

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Body
statusstringRequired

New status for the ticket (e.g., open, closed, resolved).

Responses
200
Ticket status updated successfully
application/json
500
Failed to update vendor support ticket status
application/json
put
PUT /backend/api/vendor-support-ticket/{id} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 17

{
  "status": "text"
}
{
  "status": "text",
  "message": "text",
  "data": {
    "createdBy": "text",
    "createdDate": "2025-06-01T00:53:23.316Z",
    "modifiedBy": "text",
    "modifiedDate": "2025-06-01T00:53:23.316Z",
    "id": 1,
    "refId": "text",
    "userId": 1,
    "userType": "text",
    "categoryId": 1,
    "subCategoryId": 1,
    "subject": "text",
    "description": "text",
    "isActive": true,
    "isDelete": true,
    "status": "text"
  }
}