Objects / Gift Cards — Shopfront Developer Documentation

Object

EnterpriseGiftCard

Implements

List of interfaces this object implements

SellableInterface

Fields	Type	Description
id	ID!	The ID of the enterprise the gift card belongs to
code	String!	The code on the gift card
name	String!	The Enterprise's name for the gift card
enterprise	EnterpriseConnection	The enterprise the gift card belongs to

Object

GiftCardCreationSource

Fields	Type	Description
source	GiftCardCreationSourceUnion!	Where the gift card was created from
additional	JSON	Any additional information associated with the creation source, Shopfront does not control this

Object

GiftCardImport

Fields	Type	Description
user	User!	The user who imported the gift card

Object

GiftCardMovement

Fields	Type	Description
sale	Sale!	The sale the movement occurred within
register	Register!	The register the movement occurred on
giftCard	GiftCard!	The gift card which had the movement
amount	Float!	The value of the gift card which was moved (sold will be positive, redeemed will be negative)
action	GiftCardMovementActionEnum!	The action that occurred
timestamp	DateTime!	The timestamp of the movement

Object

GiftCard

Implements

List of interfaces this object implements

SellableInterface

Fields	Type	Description
id	ID!	The unique ID for the gift card
clientId	String	The client ID for the gift card (not unique) (this could be your ID)
outlet	Outlet	The Outlet this gift card was purchased at
originalAmount	Float!	The original amount that was loaded on the gift card
currentAmount	Float!	The current amount of money that is left on the gift card
code	String!	The code on the gift card (this is unique across valid gift cards)
expiry	DateTime	The expiry date for the gift card
status	GiftCardStatusEnum!	The status of the gift card
creationSource	GiftCardCreationSource	Where the gift card was initially created from