Tickets
Get Tickets
Retrieves the tickets.
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Request Body
application/jsonOptionalpageintegerperPageintegerMust be at least 1. Must not be greater than 100.
orderColumnstring"id" | "subject" | "created_at" | "closed_at"orderDirectionstring"asc" | "desc"idstringstatusesarray<string>customer_emailstringcreated_at_startstringMust be a valid date.
created_at_endstringMust be a valid date. Must be a date after created_at_start.
closed_at_startstringMust be a valid date.
closed_at_endstringMust be a valid date. Must be a date after closed_at_start.
archivedstringPath Parameters
shopIdRequiredintegerCreate Ticket
Creates a new ticket.
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Request Body
application/jsonRequiredcustomer_idRequiredstringsubjectRequiredstringMust not be greater than 255 characters.
invoice_idstringPath Parameters
shopIdRequiredintegerGet Ticket
Retrieves a specific ticket.
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Path Parameters
shopIdRequiredintegerticketIdRequiredstringClose Ticket
Closes a ticket.
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Path Parameters
shopIdRequiredintegerticketIdRequiredstringReopen Ticket
Reopens a ticket.
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Path Parameters
shopIdRequiredintegerticketIdRequiredstringArchive Ticket
Archives a ticket.
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Path Parameters
shopIdRequiredintegerticketIdRequiredstringUnarchive Ticket
Unarchives a ticket.
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Path Parameters
shopIdRequiredintegerticketIdRequiredstringSend Ticket Message
Sends a message to a ticket.
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Request Body
application/jsonRequiredcontentRequiredstringMust not be greater than 8000 characters.
Path Parameters
shopIdRequiredintegerticketIdRequiredstringAuthorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Path Parameters
shopIdRequiredintegerticketIdRequiredstringmessageIdRequiredstring