DocumentAPI ReferenceAdd-ons

Support

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
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
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-08-30T00:37:40.706Z",
    "id": 1
  }
}

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
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"
      }
    ]
  }
}

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
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-08-30T00:37:40.706Z",
    "modifiedBy": "text",
    "modifiedDate": "2025-08-30T00:37:40.706Z",
    "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-08-30T00:37:40.706Z",
        "modifiedBy": "text",
        "modifiedDate": "2025-08-30T00:37:40.706Z",
        "id": 1,
        "ticketId": 1,
        "senderId": 1,
        "senderType": "text",
        "message": "text",
        "sentAt": "2025-08-30T00:37:40.706Z",
        "isActive": true,
        "isDelete": true,
        "createdByType": "text",
        "modifiedByType": "text",
        "ticketAttachments": [
          {}
        ]
      }
    ]
  }
}

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
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-08-30T00:37:40.706Z",
    "modifiedBy": "text",
    "modifiedDate": "2025-08-30T00:37:40.706Z",
    "id": 1,
    "refId": "text",
    "userId": 1,
    "userType": "text",
    "categoryId": 1,
    "subCategoryId": 1,
    "subject": "text",
    "description": "text",
    "isActive": true,
    "isDelete": true,
    "status": "text"
  }
}
PreviousVendorNextReports

Last updated