DocumentAPI ReferenceAdd-ons

Support

Get Support Tickets

get

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

Query parameters
limitnumberOptional

Limit the number of results.

Example: 10
offsetnumberOptional

The offset from where to start the results.

Example: 0
keywordstringOptional

Search keyword for filtering tickets.

Example: refund
countbooleanOptional

Flag to count the number of tickets matching the query.

Example: true
Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
200

Successfully retrieved the support tickets

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

{
  "status": "1",
  "message": "Support tickets retrieved successfully",
  "data": [
    {
      "createdBy": "admin",
      "createdDate": "2025-04-01T10:00:00Z",
      "modifiedBy": "admin",
      "modifiedDate": "2025-04-01T10:30:00Z",
      "id": 123,
      "refId": "REF123",
      "userId": "user01",
      "userType": "customer",
      "categoryId": 1,
      "subCategoryId": 1,
      "subject": "Refund Request",
      "description": "Request for a refund on order #XYZ",
      "isActive": true,
      "isDelete": false,
      "status": "open",
      "ticketCategory": {
        "createdBy": "admin",
        "createdDate": "2025-04-01T10:00:00Z",
        "modifiedBy": "admin",
        "modifiedDate": "2025-04-01T10:30:00Z",
        "id": 1,
        "categoryName": "Refund",
        "parentCategoryId": 0,
        "isActive": true,
        "isDelete": false
      }
    }
  ]
}

Get Ticket Details

get

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

Path parameters
idintegerRequired

Ticket ID

Example: 123
Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
200

Successfully retrieved the ticket details

application/json
get
GET /backend/api/support-ticket/{id} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

{
  "status": 1,
  "message": "Ticket details retrieved successfully",
  "data": {
    "createdBy": "admin",
    "createdDate": "2025-04-01T10:00:00Z",
    "modifiedBy": "admin",
    "modifiedDate": "2025-04-01T10:30:00Z",
    "id": 123,
    "refId": "TICKET123",
    "userId": "user01",
    "userType": "customer",
    "categoryId": 1,
    "subCategoryId": 1,
    "subject": "Refund Request",
    "description": "Refund requested for order #XYZ",
    "isActive": true,
    "isDelete": false,
    "status": "open",
    "ticketMessage": [
      {
        "createdBy": "user01",
        "createdDate": "2025-04-01T10:00:00Z",
        "modifiedBy": "admin",
        "modifiedDate": "2025-04-01T10:30:00Z",
        "id": 456,
        "ticketId": 123,
        "senderId": "user01",
        "senderType": "customer",
        "message": "Can you please update on my refund request?",
        "sentAt": "2025-04-01T10:00:00Z",
        "isActive": true,
        "isDelete": false,
        "createdByType": "customer",
        "modifiedByType": "admin",
        "ticketAttachments": []
      }
    ]
  }
}

Add Message and Attachments to Ticket

post

This API allows users to add a new message and attachments to an existing support ticket based on the provided ticket ID.

Path parameters
idintegerRequired

Ticket ID

Example: 123
Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Body
messagestringOptionalExample: Can you provide an update on my request?
Responses
200

Successfully added message and attachments to the ticket

application/json
post
POST /backend/api/support-ticket/{id} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 139

{
  "message": "Can you provide an update on my request?",
  "attachments": [
    {
      "fileName": "attachment1.pdf",
      "filePath": "/uploads/attachment1.pdf"
    }
  ]
}
{
  "status": 1,
  "message": "Message and attachments added successfully",
  "data": {
    "ticketId": 123,
    "message": "Can you provide an update on my request?",
    "attachments": [
      {
        "fileName": "attachment1.pdf",
        "filePath": "/uploads/attachment1.pdf"
      }
    ]
  }
}

Update Ticket Status

put

This API allows users to update the status of an existing support ticket based on the provided ticket ID.

Path parameters
idintegerRequired

Ticket ID

Example: 123
Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Body
statusintegerOptionalExample: 1
Responses
200

Successfully updated ticket status

application/json
put
PUT /backend/api/support-ticket/{id} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 12

{
  "status": 1
}
{
  "status": 1,
  "message": "Ticket status updated successfully",
  "data": {
    "id": 123,
    "status": 2
  }
}

Get Ticket Logs

get

This API retrieves a list of ticket logs based on the provided query parameters.

Query parameters
limitintegerOptional

The number of logs to retrieve.

Example: 10
offsetintegerOptional

The offset for pagination.

Example: 0
countintegerOptional

The total count of logs (if you want just the count of records).

Example: 0
Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
200

Successfully retrieved ticket logs

application/json
get
GET /backend/api/support-ticket/ticket-logs HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

{
  "status": "1",
  "message": "Successfully retrieved ticket logs",
  "data": [
    {
      "createdBy": "user1",
      "createdDate": "2025-04-21T00:00:00Z",
      "modifiedBy": "user2",
      "modifiedDate": "2025-04-21T01:00:00Z",
      "id": 1,
      "ticketId": 123,
      "actionTaken": "Updated ticket status",
      "actionBy": "admin",
      "actionByType": "system",
      "actionAt": "2025-04-21T01:00:00Z",
      "isActive": true,
      "isDelete": false,
      "createdByType": "user",
      "modifiedByType": "admin"
    }
  ]
}
PreviousMy ProfileNextBuyers

Last updated