Overview

On this page, we’ll dive into the different ticket endpoints you can use to manage tickets programmatically.

Tickets are a way to communicate with visitors and customers alike. They help answer questions from potential customers, and streamline post-purchase conversations with existing customers.

On this page, we'll dive into the different ticket endpoints you can use to manage tickets programmatically. We'll look at how to query and reply to tickets.

Endpoints

The ticket model

The ticket model contains all the information about your store's tickets, including the ticket's title, status, and customer details.

Properties

Name: idinteger
Description: The unique identifier for the ticket.
Name: titlestring
Description: The title of the ticket.
Name: statusstring
Description: The ticket status. One of two statuses:

OPEN

CLOSED
Name: customerarray
Description: Array of customer details consisting of two types of information:

id: Unique customer identifier

email: Email associated to the customer's ticket.
Name: referencearray
Description: Array of order details if ticket is associated with an order. Consists of two types of information:

id: Order ID

type: Order model
Name: created_attimestamp
Description: The time at which this ticket was first created.
Name: updated_attimestamp
Description: The time at which this ticket was last updated.
Name: store_idinteger
Description: The ID of the store this ticket belongs to.
Name: read_byinteger
Description: The ID of the user who read the ticket last.
Name: archivedinteger
Description: Whether the ticket has been archived, one of two:

1: Ticket is archived.

0: Ticket is not archived.

The ticket message model

A ticket has many messages. Each ticket message model contains all the information about that specific message, including the ticket's author, content, and ticket ID.

Properties

Name: idinteger
Description: The unique identifier for the ticket message.
Name: authorstring
Description: The author of the ticket message. One of two statuses:

STORE

CUSTOMER
Name: senderstring
Description: The details of the ticket message sender. One of two possibilities:

Username: For users logged into SellApp.

Email: For users not logged into SellApp.
Name: contentstring
Description: The ticket message content; the actual message that is sent.
Name: created_attimestamp
Description: The time at which this ticket was first created.
Name: updated_attimestamp
Description: The time at which this ticket was last updated.
Name: ticket_idinteger
Description: The ID of the ticket this ticket message belongs to.