Tickets
Get Tickets
Retrieves the tickets.
Authorization
Authorization
RequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Request Body
application/json
Optionalpage
integerperPage
integerMust be at least 1. Must not be greater than 100.
orderColumn
string"id" | "subject" | "created_at" | "closed_at"
orderDirection
string"asc" | "desc"
id
stringstatuses
array<string>customer_email
stringcreated_at_start
stringMust be a valid date.
created_at_end
stringMust be a valid date. Must be a date after created_at_start.
closed_at_start
stringMust be a valid date.
closed_at_end
stringMust be a valid date. Must be a date after closed_at_start.
archived
stringPath Parameters
shopId
RequiredintegerCreate Ticket
Creates a new ticket.
Authorization
Authorization
RequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Request Body
application/json
Requiredcustomer_id
Requiredstringsubject
RequiredstringMust not be greater than 255 characters.
invoice_id
stringPath Parameters
shopId
RequiredintegerGet Ticket
Retrieves a specific ticket.
Authorization
Authorization
RequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Path Parameters
shopId
RequiredintegerticketId
RequiredstringClose Ticket
Closes a ticket.
Authorization
Authorization
RequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Path Parameters
shopId
RequiredintegerticketId
RequiredstringReopen Ticket
Reopens a ticket.
Authorization
Authorization
RequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Path Parameters
shopId
RequiredintegerticketId
RequiredstringArchive Ticket
Archives a ticket.
Authorization
Authorization
RequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Path Parameters
shopId
RequiredintegerticketId
RequiredstringUnarchive Ticket
Unarchives a ticket.
Authorization
Authorization
RequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Path Parameters
shopId
RequiredintegerticketId
RequiredstringSend Ticket Message
Sends a message to a ticket.
Authorization
Authorization
RequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Request Body
application/json
Requiredcontent
RequiredstringMust not be greater than 8000 characters.
Path Parameters
shopId
RequiredintegerticketId
RequiredstringAuthorization
Authorization
RequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Path Parameters
shopId
RequiredintegerticketId
RequiredstringmessageId
Requiredstring