Support
This API retrieves a list of support tickets based on the provided query parameters.
Limit the number of results.
10
The offset from where to start the results.
0
Search keyword for filtering tickets.
refund
Flag to count the number of tickets matching the query.
true
Bearer token for authentication.
Successfully retrieved the support tickets
Failed to retrieve support tickets
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
}
}
]
}
This API retrieves details of a specific support ticket based on the provided ticket ID.
Ticket ID
123
Bearer token for authentication.
Successfully retrieved the ticket details
Failed to retrieve ticket details
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": []
}
]
}
}
This API allows users to add a new message and attachments to an existing support ticket based on the provided ticket ID.
Ticket ID
123
Bearer token for authentication.
Can you provide an update on my request?
Successfully added message and attachments to the ticket
Failed to add message and attachments to the ticket
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"
}
]
}
}
This API allows users to update the status of an existing support ticket based on the provided ticket ID.
Ticket ID
123
Bearer token for authentication.
1
Successfully updated ticket status
Failed to update ticket status
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
}
}
This API retrieves a list of ticket logs based on the provided query parameters.
The number of logs to retrieve.
10
The offset for pagination.
0
The total count of logs (if you want just the count of records).
0
Bearer token for authentication.
Successfully retrieved ticket logs
Failed to retrieve ticket logs
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"
}
]
}
Last updated