DocumentAPI ReferenceAdd-ons

Support

Get Customer Support Ticket Categories

get

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

Query parameters
limitnumberOptional

Limit for pagination

offsetnumberOptional

Offset for pagination

keywordstringOptional

Search keyword to filter categories

parentCategoryIdstringOptional

Parent Category ID to filter

statusstringOptional

Status of the category (e.g., active, inactive)

Responses
200

Successfully retrieved ticket categories

application/json
get
GET /backend/api/api/customer-support-ticket/ticket-category HTTP/1.1
Host: 139.59.67.17
Accept: */*

{
  "status": "success",
  "message": "Successfully retrieved ticket categories",
  "data": [
    {
      "createdBy": "admin",
      "createdDate": "2025-04-20",
      "modifiedBy": "admin",
      "modifiedDate": "2025-04-20",
      "id": "123",
      "categoryName": "Technical Issue",
      "parentCategoryId": "null",
      "isActive": true,
      "isDelete": false
    }
  ]
}

Retrieve Customer Support Tickets

get

This API retrieves a list of customer support tickets based on the provided query parameters.

Query parameters
limitnumberOptional

Limit for the number of tickets to retrieve.

Example: 10
offsetnumberOptional

Offset for pagination.

Example: 0
keywordstringOptional

Keyword to search tickets.

Example: refund
countnumberOptional

A flag to specify if the count of tickets should be returned.

Example: 1
Header parameters
AuthorizationstringRequired

Authorization token (Bearer)

Example: Bearer <token>
Responses
200

Successfully retrieved customer support tickets

application/json
get
GET /backend/api/api/customer-support-ticket HTTP/1.1
Host: 139.59.67.17
Authorization: Bearer <token>
Accept: */*

{
  "status": "success",
  "message": "Customer support tickets retrieved successfully.",
  "data": [
    {
      "categoryId": 1,
      "subCategoryId": 2,
      "refId": "TKT123",
      "subject": "Issue with Product",
      "description": "The product is defective.",
      "status": "open",
      "userId": 123,
      "userType": "customer",
      "createdDate": "2025-04-20T12:34:56Z",
      "id": 1
    }
  ]
}

Create Customer Support Ticket

post

This API allows customers to create a support ticket by submitting a category, sub-category, ticket details, message, and optional attachments.

Header parameters
AuthorizationstringRequired

Authorization token (Bearer)

Example: Bearer <token>
Body
categoryIdnumberOptional

Category ID

subCategoryIdnumberOptional

Sub Category ID

ticketIdnumberOptional

Ticket ID (optional)

subjectstringOptional

Subject of the ticket

descriptionstringOptional

Description of the issue

messagestringOptional

Message body for the ticket

Responses
200

Successfully created customer support ticket

application/json
post
POST /backend/api/api/customer-support-ticket HTTP/1.1
Host: 139.59.67.17
Authorization: Bearer <token>
Content-Type: application/json
Accept: */*
Content-Length: 250

{
  "categoryId": 1,
  "subCategoryId": 2,
  "ticketId": 123,
  "subject": "Issue with Product",
  "description": "The product is defective.",
  "message": "Please check the issue with the product.",
  "attachments": [
    {
      "fileName": "image1.jpg",
      "filePath": "/uploads/image1.jpg"
    }
  ]
}
{
  "status": "success",
  "message": "Customer support ticket created successfully.",
  "data": {
    "ticketId": 123,
    "categoryId": 1,
    "subCategoryId": 2,
    "subject": "Issue with Product",
    "description": "The product is defective.",
    "message": "Please check the issue with the product.",
    "attachments": [
      {
        "fileName": "image1.jpg",
        "filePath": "/uploads/image1.jpg"
      }
    ]
  }
}

Get Customer Support Ticket Details

get

This API retrieves the details of a specific customer support ticket based on the provided ticket ID.

Path parameters
idnumberRequired

The ID of the customer support ticket.

Example: 1
Header parameters
AuthorizationstringRequired

Authorization token (Bearer)

Example: Bearer <token>
Responses
200

Successfully retrieved customer support ticket details

application/json
get
GET /backend/api/api/customer-support-ticket/{id} HTTP/1.1
Host: 139.59.67.17
Authorization: Bearer <token>
Accept: */*

{
  "status": "success",
  "message": "Customer support ticket details retrieved successfully.",
  "data": {
    "createdBy": "admin",
    "createdDate": "2025-04-20T12:34:56Z",
    "modifiedBy": "admin",
    "modifiedDate": "2025-04-21T08:45:00Z",
    "id": 1,
    "refId": "TKT123",
    "userId": 123,
    "userType": "customer",
    "categoryId": 2,
    "subCategoryId": 1,
    "subject": "Issue with Product",
    "description": "The product is defective.",
    "isActive": true,
    "isDelete": false,
    "status": "open",
    "ticketMessage": [
      {
        "createdBy": "customer",
        "createdDate": "2025-04-20T12:34:56Z",
        "modifiedBy": "admin",
        "modifiedDate": "2025-04-21T08:45:00Z",
        "id": 1,
        "ticketId": 1,
        "senderId": 123,
        "senderType": "customer",
        "message": "Can you please assist me with this issue?",
        "sentAt": "2025-04-20T12:34:56Z",
        "isActive": true,
        "isDelete": false,
        "createdByType": "customer",
        "modifiedByType": "admin",
        "ticketAttachments": []
      }
    ]
  }
}

Update Customer Support Ticket Status

put

This API updates the status of a specific customer support ticket based on the provided ticket ID.

body
statusnumberRequired

The status of the ticket (e.g., open, closed, resolved, etc.).

Example: 2
Path parameters
idnumberRequired

The ID of the customer support ticket.

Example: 1
Header parameters
AuthorizationstringRequired

Authorization token (Bearer)

Example: Bearer <token>
Responses
200

Successfully updated customer support ticket status

application/json
put
PUT /backend/api/api/customer-support-ticket/{id} HTTP/1.1
Host: 139.59.67.17
Authorization: Bearer <token>
Accept: */*

{
  "status": "success",
  "message": "Customer support ticket status updated successfully.",
  "data": {
    "createdBy": "admin",
    "createdDate": "2025-04-20T12:34:56Z",
    "modifiedBy": "admin",
    "modifiedDate": "2025-04-21T08:45:00Z",
    "id": 1,
    "refId": "TKT123",
    "userId": 123,
    "userType": "customer",
    "categoryId": 2,
    "subCategoryId": 1,
    "subject": "Issue with Product",
    "description": "The product is defective.",
    "isActive": true,
    "isDelete": false,
    "status": "resolved"
  }
}
PreviousProfileNextCheckouts

Last updated