Type
|
List
|
List
|
Support Tickets
|
URL
|
http://{domain}/api/v2/supporttickets.json
|
Accepts Filters
|
Yes
|
Output Attributes
|
No
|
List Support Tickets
Gets the filtered LIST of Support Tickets. Using this API one can retrieve limited data on the Support Tickets which have been input into Lead Commerce. This LIST contains the fields ID, Display ID, name, status, etc for each Support Tickets. The ID is the primary key identifier for Support Tickets in Lead Commerce. The Display ID is the visual identifier whose starting number can be set in System Settings, Default Increment. The name is the Support Ticket name and the status is the status of the Support Ticket.
Filters
Filter the Support Tickets into a list. Support Ticket
Attributes are available as a filter. Attributes are user defined customizable fields which use graphical control elements such as Text Box, Checkbox and Drop Down Menu.
Parameter
|
Type
|
Rules
|
Example
|
status
|
int
|
|
1
|
display_id
|
int
|
|
1000
|
customer
|
int
|
|
1000
|
order
|
int
|
|
1000
|
name
|
string
|
|
|
modify_start
|
date
|
|
1431377356
|
modify_end
|
date
|
|
1431377356
|
Support Ticket Status
1
|
Open
|
2
|
Pending
|
3
|
Solved
|
Pagination
Parameters can be added to the CURL call to paginate the List.
The maximum limit is 250. By default, this limit is set to 100.
Parameter
|
Type
|
Default
|
Example
|
limit
|
int
|
1
|
2
|
page
|
int
|
1
|
5
|
Response
Example JSON returned
{
"code": "200",
"data": [
{
"id": "2",
"display_id": "2",
"name": "Quick Question",
"order": "0",
"status": "1",
"customer": [
{
"id": "2",
"display_id": "1001",
"first_name": "Jane",
"last_name": "Doe",
"email": "[email protected]",
"phone": "619-111-2222",
"fax": "619-111-2223"
}
]
},
{
"id": "1",
"display_id": "1",
"name": "Question on Order",
"order": "0",
"status": "1",
"customer": [
{
"id": "1",
"display_id": "1000",
"first_name": "Bob",
"last_name": "Smith",
"email": "[email protected]",
"phone": "619-233-2224",
"fax": "619-233-2225"
}
]
}
]
}