Objects / Customer Displays — Shopfront Developer Documentation

Object

CustomerDisplayColumn

Fields	Type	Description
enabled	Boolean	Whether the columns should be displayed
name	String	The name of the column

Object

CustomerDisplayComponentPosition

Fields	Type	Description
top	Int	The `Int` scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
left	Int	The `Int` scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
width	Int	The `Int` scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
height	Int	The `Int` scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

Object

CustomerDisplayComponent

Fields	Type	Description
type	String	The type of the component
position	CustomerDisplayComponentPosition	The position of the component on the grid
settings	CustomerDisplayComponentSettingsInterface	The settings of the component

Object

CustomerDisplayImageSettings

Implements

List of interfaces this object implements

CustomerDisplayComponentSettingsInterface

Fields	Type	Description
background	String	The background color of the component
color	String	The foreground color of the component
image	String	The URL of the image to display
constrainWidth	Boolean	Whether the image should be constrained to the left and right of the component
constrainHeight	Boolean	Whether the image should be constrained to the top and bottom of the component
fill	Boolean	Whether the image should fill the entire component

Object

CustomerDisplaySaleColumn

Fields	Type	Description
enabled	Boolean	Whether the columns should be displayed
name	String	The name of the column
alignment	String	The text alignment of the column

Object

CustomerDisplaySaleColumnsSettings

Fields	Type	Description
item	CustomerDisplaySaleColumn
quantity	CustomerDisplaySaleColumn
price	CustomerDisplaySaleColumn
totalPrice	CustomerDisplaySaleColumn

Object

CustomerDisplaySaleSettings

Implements

List of interfaces this object implements

CustomerDisplayComponentSettingsInterface

Fields	Type	Description
background	String	The background color of the component
color	String	The foreground color of the component
gridLines	Boolean	Whether the grid lines for the table is shown
gridColor	String	The color of the grid lines
order	[String]	The order the columns are shown
columns	CustomerDisplaySaleColumnsSettings	The settings for the columns
promotionColor	String	The color of the promotion lines
footerBackground	String	The background color of the footer
footerColor	String	The foreground color of the footer
fontSize	Int	The font size of the totals table

Object

CustomerDisplaySlideshowSettingsSlide

Fields	Type	Description
type	CustomerDisplaySlideshowSlideTypeEnum	The type of the media for the slide
url	String	The URL of the media for the slide
name	String	The name of the media for the slide
duration	Float	The duration of the slide
startDate	DateTime	The timestamp of when this slide should start being shown in the slideshow.
endDate	DateTime	The timestamp of when this slide should be removed from the slideshow.

Object

CustomerDisplaySlideshowSettings

Implements

List of interfaces this object implements

CustomerDisplayComponentSettingsInterface

Fields	Type	Description
background	String	The background color of the component
color	String	The foreground color of the component
fill	Boolean	Whether the slides are stretched to fill the entire component
cover	Boolean	Whether the slides cover the entire component without losing their aspect ratio
slides	[CustomerDisplaySlideshowSettingsSlide]	The slides of the slideshow

Object

CustomerDisplayTextSettings

Implements

List of interfaces this object implements

CustomerDisplayComponentSettingsInterface

Fields	Type	Description
background	String	The background color of the component
color	String	The foreground color of the component
text	String	The text that would display for the component
align	String	The horizontal alignment of the text component
justify	String	The vertical alignment of the text component
fontSize	Int	The font size of the text
bold	Boolean	Whether the text should be bold or not
italic	Boolean	Whether the text should be italic or not
underline	Boolean	Whether the text should be underlined or not

Object

CustomerDisplayTotalsColumnsSettings

Fields	Type	Description
total	CustomerDisplayColumn
savings	CustomerDisplayColumn
change	CustomerDisplayColumn
approved	CustomerDisplayColumn
thanks	CustomerDisplayColumn
paid	CustomerDisplayColumn
remaining	CustomerDisplayColumn

Object

CustomerDisplayTotalsSettings

Implements

List of interfaces this object implements

CustomerDisplayComponentSettingsInterface

Fields	Type	Description
background	String	The background color of the component
color	String	The foreground color of the component
order	[String]	The order the columns are shown
rows	CustomerDisplayTotalsColumnsSettings	The settings for the columns
promotion	String	The color of the promotion lines
fontSize	Int	The font size of the totals table
bold	Boolean	Whether the text should be bold or not
italic	Boolean	Whether the text should be italic or not
underline	Boolean	Whether the text should be underlined or not

Object

CustomerDisplay

Fields	Type	Description
id	ID!	The unique ID of the customer display
name	String!	The name of the customer display
idle	[CustomerDisplayComponent]	The components to use when the customer display is on idle (no sale in progress)
sale	[CustomerDisplayComponent]	The components to use on the customer display when there is a sale in progress
mainColour	String	The default main colour to use for components
textColour	String	The default text colour to use for components