Objects / Outlets — Shopfront Developer Documentation

Object

LoyaltyClassification

Fields Type Description

Fields	Type	Description
id	ID!	The `ID` scalar type represents a unique identifier. The `ID` type appears in a `JSON` response as a `String`; however, it is not intended to be human-readable. The `ID` is mathematically universally unique across all types and Vendors and can be used as such.
type	String	The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
name	String	The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

id

The ID scalar type represents a unique identifier.

The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. The ID is mathematically universally unique across all types and Vendors and can be used as such.

type

String

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

name

String

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Object

Loyalty

Fields	Type	Description
id	Int!	The ID of the loyalty
quantity	Float	The quantity for this rate to activate at
earnRate	Float	The amount of points per dollar to earn at this quantity (or null to inherit from the Outlet)
redeemRate	Float	The amount of points per dollar it costs to redeem at this quantity (or null to inherit from the Outlet)
classification	LoyaltyInterface	The classification this affects

Object

Outlet

Implements

List of interfaces this object implements

Fields	Type	Description
id	ID!	The ID of the outlet
name	String!	The name of the outlet
settings	[Settings]	The settings for this object
registers	[Register]	The registers that this Outlet has
contact	Contact!	The contact details of the Outlet
logo	String	The url to the logo of the Outlet
businessNumber	String!	The business number of the Outlet
loyaltyEnabled	Boolean!	Whether loyalty is enabled for this Outlet
loyalties	[Loyalty]	The custom loyalty rates for classifications
loyaltyName	String	The name of the loyalty field
loyaltyEarnRate	Float	The default amount of points earned for spending one dollar.
loyaltyRedeemRate	Float	The default amount of points needed to redeem one dollar.
hasKitchenScreen	Boolean!	Whether the outlet has a kitchen screen
ticketingPriceSet	PriceSet	The price set used for ticketing at this outlet
createdAt	DateTime!	The time the Outlet was created
deletedAt	DateTime	The time this outlet was deleted (or null if not deleted)