Get Ticket by Id - Ecommerce

curl --location -g --request GET '{{ecommercev2_url}}/tickets/?query={"popFields":[ "typeId", "requesterId", "vendorId", "buyerId", "quotationId", "invoiceId", "orderId"],}' \ --header 'x-access-token;'

{ "id": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "deletedAt": "2019-08-24T14:15:22Z", "title": "string", "typeId": "string", "status": "open", "priority": "low", "description": "string", "attachment": { "url": "string", "filename": "string", "size": 0, "contentType": "string" }, "quotationId": "string", "invoiceId": "string", "orderId": "string", "requesterId": "string", "buyerId": "string", "vendorId": "string", "comments": [ { "text": "string", "attachment": { "url": "string", "filename": "string", "size": 0, "contentType": "string" }, "userId": "string", "user": { "id": "string", "firstName": "string", "lastName": "string", "email": "string" }, "createdAt": "2019-08-24T14:15:22Z" } ], "ticketType": {}, "requester": {}, "buyer": {}, "vendor": {}, "quotation": {}, "invoice": {}, "order": {} }

Request

Authorization

API Key

Add parameter in header

x-access-token

Example:

x-access-token: ********************

Path Params

string

required

Query Params

query

array[string]

optional

query

Example:

["{\"popFields\":[ \"typeId\", \"requesterId\", \"vendorId\", \"buyerId\", \"quotationId\", \"invoiceId\", \"orderId\"],}"]

Header Params

x-access-token

string

optional

Example:

x-client

string

optional

Example:

accept-language

string

optional

Example:

Responses

🟢200Success

application/json

Body

Schema for ticket response object

string

required

MongoDB ObjectID as string

createdAt

string <date-time>

required

Timestamp when the ticket was created

updatedAt

string <date-time>

required

Timestamp when the ticket was last updated

deletedAt

string <date-time> | null

optional

Timestamp when the ticket was deleted (soft delete)

title

string

required

Title of the ticket

typeId

string

required

MongoDB ObjectID of the ticket type

status

enum<string>

required

Current status of the ticket

Allowed values:

openin_progressresolvedclosed

priority

enum<string>

required

Priority level of the ticket

Allowed values:

lowmediumhighurgent

description

string

required

Detailed description of the ticket

attachment

object | null

optional

Optional file attachment

url

string

optional

File URL

filename

string

optional

Original filename

size

number

optional

File size in bytes

contentType

string

optional

MIME type of the file

quotationId

string | null

optional

MongoDB ObjectID of related quotation

invoiceId

string | null

optional

MongoDB ObjectID of related invoice

orderId

string | null

optional

MongoDB ObjectID of related order

requesterId

string

required

MongoDB ObjectID of the user who created the ticket

buyerId

string | null

optional

MongoDB ObjectID of the buyer

vendorId

string | null

optional

MongoDB ObjectID of the vendor

comments

array [object {5}]

optional

Array of comments on the ticket

text

string

required

Comment text

attachment

object | null

optional

Optional file attachment for comment

userId

string

required

MongoDB ObjectID of the comment author

user

object | null

optional

Basic profile information of comment author

createdAt

string <date-time>

required

When the comment was created

ticketType

object | null

optional

Populated ticket type information

requester

object | null

optional

Populated requester profile information

buyer

object | null

optional

Populated buyer profile information

vendor

object | null

optional

Populated vendor profile information

quotation

object | null

optional

Populated quotation information

invoice

object | null

optional

Populated invoice information

order

object | null

optional

Populated order information