Link
A shopping offer, product, or giftcard that a user can visit or purchase.
type Link {
acceptedLinkedCardTypes: [CardTypeEnum!]!
availableDenominations: String
balanceCheckUrl: String
baselineGiveAmount: String!
belongsToButtonNetwork: Boolean!
browserExtensionInfo: LinkBrowserExtensionInfo!
buttonCTA: String!
cashbackTiming: String
commissionPromotionId: ID
currency: Currency!
defaultBrand: Brand!
description: String
earnInstructions: String
exclusionGiftCardNotEligible: Boolean!
exclusionPurchaseWithGiftCardNotEligible: Boolean!
exclusions: String
extensionRegex: String @deprecated
extensionShowPopup: Boolean! @deprecated
giftcardDenominations(
first: Int
after: String
last: Int
before: String
): GiftcardDenominationConnection!
giftcardInstructions: String
giftcardType: String
giveAmount: String!
givePercentage: Float!
giveSentence: String!
id: ID!
image: String @deprecated
images: LinkImages!
isBulkShop: Boolean!
isVariableRate: Boolean!
labelPromotionId: ID
location(
id: ID
): Location
logoImage: String @deprecated
merchant: Merchant
mobileBrowserType: LinkMobileBrowserType!
name: String!
nearestLocation(
siteId: ID
brandId: ID
coordinates: CoordinatesInput
): Location
positiveGiveAmount: Boolean!
previewInfo: LinkPreviewInfo!
promoDescription: String @deprecated
promoEndsAt: DateTimeISO @deprecated
promoLabel: String @deprecated
promoSecondaryLabel: String @deprecated
promoTitle: String @deprecated
promotionInfo: LinkPromotionInfo!
relatedLinks(
first: Int
after: String
last: Int
before: String
linkTypes: [LinkType!]
): LinkConnection!
reloadableGiftcardInfo: LinkReloadableGiftcardInfo!
reloadablePercentages: [Int!]! @deprecated
shortName: String
squareImage: String @deprecated
terms: String
termsHeadline: String
termsSummary: String
type: LinkType!
variableRates: String
walletDescription: String
}
Fields
Link.acceptedLinkedCardTypes ● [CardTypeEnum!]! non-null enum
Accepted Linked Card Types for a link
Link.availableDenominations ● String scalar
Link's available denominations
Link.balanceCheckUrl ● String scalar
If present, the URL to check a giftcard's balance
Link.baselineGiveAmount ● String! non-null scalar
Link's baseline give amount when promo is present
Link.belongsToButtonNetwork ● Boolean! non-null scalar
Does the link belong to the Button affiliate network?
Link.browserExtensionInfo ● LinkBrowserExtensionInfo! non-null object
The link's browser extension info
Link.buttonCTA ● String! non-null scalar
Link's buy button CTA
Link.cashbackTiming ● String scalar
Approximate timing for when the link should give cashback
Link.commissionPromotionId ● ID scalar
Link's commission promotion ID
Link.currency ● Currency! non-null enum
Link's currency
Link.defaultBrand ● Brand! non-null object
Link's default brand
Link.description ● String scalar
Link's description
Link.earnInstructions ● String scalar
Link's 'how to earn' instructions
Link.exclusionGiftCardNotEligible ● Boolean! non-null scalar
Gift cards are not eligible for cash back.
Link.exclusionPurchaseWithGiftCardNotEligible ● Boolean! non-null scalar
Purchases made with a gift card are not eligible for cash back.
Link.exclusions ● String scalar
Link's exclusions
Link.extensionRegex ● String deprecated scalar
DEPRECATED: Use the browserExtensionInfo field.Regex matching the website of the link's merchant. Used in the Max browser extension
Link.extensionShowPopup ● Boolean! deprecated non-null scalar
DEPRECATED: Use the browserExtensionInfo field.Whether to show a popup in extension for this link
Link.giftcardDenominations ● GiftcardDenominationConnection! non-null object
Giftcard denominations available for this link
Link.giftcardDenominations.first●IntscalarReturns the first n elements from the list.
Link.giftcardDenominations.after ● String scalar
Returns the elements in the list that come after the specified cursor.
Link.giftcardDenominations.last ● Int scalar
Returns the last n elements from the list.
Link.giftcardDenominations.before ● String scalar
Returns the elements in the list that come before the specified cursor.
Link.giftcardInstructions ● String scalar
Link's giftcard instructions
Link.giftcardType ● String scalar
Type of gift card
Link.giveAmount ● String! non-null scalar
Link's give amount
Link.givePercentage ● Float! non-null scalar
Link's give percentage
Link.giveSentence ● String! non-null scalar
Link's give sentence
Link.id ● ID! non-null scalar
Link's ID
Link.image ● String deprecated scalar
DEPRECATED: Use the images field.Link's image URL
Link.images ● LinkImages! non-null object
Link's images
Link.isBulkShop ● Boolean! non-null scalar
Is the link a bulk shopping link?
Link.isVariableRate ● Boolean! non-null scalar
If a link is variable rate
Link.labelPromotionId ● ID scalar
Link's label promotion ID
Link.location ● Location object
Load specific location for link
Link.location.id●IDscalar
Link.logoImage ● String deprecated scalar
DEPRECATED: Use the images field.Link's logo image URL
Link.merchant ● Merchant object
Link's merchant
Link.mobileBrowserType ● LinkMobileBrowserType! non-null enum
The mobile browser type to use when loading the link in an intent
Link.name ● String! non-null scalar
Link's name
Link.nearestLocation ● Location object
Nearest location for this link
Link.nearestLocation.siteId●IDscalar
Link.nearestLocation.brandId ● ID scalar
Link.nearestLocation.coordinates ● CoordinatesInput input
Link.positiveGiveAmount ● Boolean! non-null scalar
Link has a positive give back
Link.previewInfo ● LinkPreviewInfo! non-null object
The link's preview text to show on the brand modal
Link.promoDescription ● String deprecated scalar
DEPRECATED: Use the promotionInfo field.Link's promotion description
Link.promoEndsAt ● DateTimeISO deprecated scalar
DEPRECATED: Use the promotionInfo field.Link's promotion ends at
Link.promoLabel ● String deprecated scalar
DEPRECATED: Use the promotionInfo field.Link's promotion label
Link.promoSecondaryLabel ● String deprecated scalar
DEPRECATED: Use the promotionInfo field.Link's small promotion label
Link.promoTitle ● String deprecated scalar
DEPRECATED: Use the promotionInfo field.Link's promotion title
Link.promotionInfo ● LinkPromotionInfo! non-null object
The link's promotion info
Link.relatedLinks ● LinkConnection! non-null object
A list of the link's related links
Link.relatedLinks.first●IntscalarReturns the first n elements from the list.
Link.relatedLinks.after ● String scalar
Returns the elements in the list that come after the specified cursor.
Link.relatedLinks.last ● Int scalar
Returns the last n elements from the list.
Link.relatedLinks.before ● String scalar
Returns the elements in the list that come before the specified cursor.
Link.relatedLinks.linkTypes ● [LinkType!] list enum
Link.reloadableGiftcardInfo ● LinkReloadableGiftcardInfo! non-null object
Link.reloadablePercentages ● [Int!]! deprecated non-null scalar
DEPRECATED: Use reloadable info insteadThe link's available reloadable percentages
Link.shortName ● String scalar
Link's short name
Link.squareImage ● String deprecated scalar
DEPRECATED: Use the images field.Link's square image URL
Link.terms ● String scalar
Link's terms and conditions
Link.termsHeadline ● String scalar
Link's terms and conditions headline
Link.termsSummary ● String scalar
Link's terms summary
Link.type ● LinkType! non-null enum
Link's type
Link.variableRates ● String scalar
Link's variable rates description
Link.walletDescription ● String scalar
Link's gift card wallet description
Returned by
Link query ● LinkSearch query
Member of
ActivityData object ● Brand object ● BrandMaxGiveLinks object ● Collection object ● Giftcard object ● GiftcardIntent object ● Intent object ● LabelPromotion object ● LinkEdge object ● LinkPromotion object ● Merchant object