Skip to content

Shop

Returns the shop-level configuration for your loyalty program: its display name, stamp branding, currency, and stamp-card size. Takes no arguments.

Returns a Shop object (nullable).

FieldTypeDescription
programNameStringThe loyalty program’s display name.
stampBrandingPluralStringThe merchant’s plural noun for stamps (e.g. “stamps”, “beans”).
stampCardValueIntNumber of stamps that make up one stamp card.
currencyStringISO currency code.
currencySymbolStringDisplay currency symbol.
query {
shop {
programName
stampBrandingPlural
stampCardValue
currency
currencySymbol
}
}
{
"data": {
"shop": {
"programName": "Bean Club",
"stampBrandingPlural": "beans",
"stampCardValue": 10,
"currency": "GBP",
"currencySymbol": "£"
}
}
}