Objects / Shelf Tickets — Shopfront Developer Documentation

Object

AdminTicketTemplatePage

Fields	Type	Description
id	Int!	The ID of the ticket template
name	String!	The name of the ticket template
folder	String!	The folder the ticket template exists in
horizontalPanels	Int!	The number of ticket template panels horizontally
verticalPanels	Int!	The number of ticket template panels vertically
pageWidth	Float!	The width of the page (in millimeters)
pageHeight	Float!	The height of the template panel on a page (in millimeters)
pageMargin	String!	The margin of the page (formatted as a CSS margin)
horizontalPanelSpacing	Float!	The spacing between the panels horizontally (in millimeters)
verticalPanelSpacing	Float!	The spacing between the panels vertically (in millimeters)
cuttingWidth	Float!	The width of the cutting line to display (in millimeters), this will be overlaid on the tickets
mapped	ID	The id of the mapped ticket template page for this vendor, returns null if not mapped

Object

AdminTicketTemplate

Fields	Type	Description
id	Int!	The ID of the ticket template
name	String!	The name of the ticket template
folder	String!	The folder the ticket template exists in
styles	String!	The styles to apply to the ticket template (in CSS)
transformationScript	String!	The transformation script to use (in JavaScript)
width	Float!	The width of the template panel on a page (in millimeters)
height	Float!	The height of the template panel on a page (in millimeters)
fonts	[URL!]!	The fonts used by the template
options	JSON!	The options for the templates, this is in the format `key` => `label`
fieldsTracked	[String!]!	The fields tracked by the template
mapped	ID	The id of the mapped ticket template for this vendor, returns null if not mapped

Object

PrintableTemplate

Fields	Type	Description
quantity	Int!	The suggested number of tickets to print
template	TicketTemplate!	The suggested template to print

Object

ShelfTicket

Fields	Type	Description
id	ID!	The ID of the ticket
product	Product!	The Product this shelf ticket is for
outlet	Outlet	The Outlet that this ticket is for
user	User	The User that added the ticket
createdAt	DateTime!	The time that the ticket was added

Object

TicketTemplatePage

Fields	Type	Description
id	ID!	The ID of the ticket template
name	String!	The name of the ticket template
horizontalPanels	Int!	The number of ticket template panels horizontally
verticalPanels	Int!	The number of ticket template panels vertically
pageWidth	Float!	The width of the page (in millimeters)
pageHeight	Float!	The height of the template panel on a page (in millimeters)
pageMargin	String!	The margin of the page (formatted as a CSS margin)
horizontalPanelSpacing	Float!	The spacing between the panels horizontally (in millimeters)
verticalPanelSpacing	Float!	The spacing between the panels vertically (in millimeters)
cuttingWidth	Float!	The width of the cutting line to display (in millimeters), this will be overlaid on the tickets
mapped	AdminTicketTemplatePage	The ticket template page this is mapped to from the admin interface, if this is a custom page this value will be `null`

Object

TicketTemplate

Fields	Type	Description
id	ID!	The ID of the ticket template
name	String!	The name of the ticket template
styles	String!	The styles to apply to the ticket template (in CSS)
transformationScript	String!	The transformation script to use (in JavaScript)
width	Float!	The width of the template panel on a page (in millimeters)
height	Float!	The height of the template panel on a page (in millimeters)
fonts	[URL!]!	The fonts used by the template
fieldsTracked	[String!]!	The fields tracked by the template
mapped	AdminTicketTemplate	The ticket template this is mapped to from the admin interface, if this is a custom ticket this value will be `null`
options	JSON!	The options this ticket template is using, it's formatted as `option` => `boolean`, with true being enabled. Options will only exist for mapped templates

Object

Ticket

Fields	Type	Description
id	ID!	The ID of the ticket
outlet	Outlet	The Outlet that this ticket is for
user	User	The User that added the ticket
queuedAt	DateTime!	The time that the ticket was added to the queue
item	PrintableInterface!	The item that this ticket is for
templates	[PrintableTemplate!]	The suggested templates for this ticket
reasons	[PrintableReasonInterface!]	The reasons that this ticket was created