Skip to main content

AppGroup

No description

type AppGroup {
  uuid: String!
  inviteCode: String!
  merchantUuid: String
  name: String!
  url: String
  logoUrl: String
  merchantImageUrl: String
  iconUrl: String
  imageUrl: String
  brandColorHex: String
  merchantColor: MerchantColor @deprecated
  primaryBalanceType: String
  merchantTypes: [MerchantType!]!
  categories: [String!]!
  categoryLabel: String!
  localCreditName: String
  allowCustomerSelectedRedemptionAmount: Boolean!
  balanceVisibility: RoWalletBalanceVisibility!
  description: String
  venueCount: Int!
  availableCredit: Float!
  availableCreditCurrencyCode: String!
  rewardPoints: Float!
  displayBalance: AppGroupDisplayBalance
  redemptionConversion: AppGroupRedemptionConversion
  activeOfferCount: Int!
}

Fields

`AppGroup.uuid` ● `String!` non-null scalar

UUID of the group account

`AppGroup.inviteCode` ● `String!` non-null scalar

Public brand link code

`AppGroup.merchantUuid` ● `String` scalar

UUID of the primary merchant record when available

`AppGroup.name` ● `String!` non-null scalar

Display name for the group summary

`AppGroup.url` ● `String` scalar

Primary venue website URL

`AppGroup.logoUrl` ● `String` scalar

Primary venue logo URL

`AppGroup.merchantImageUrl` ● `String` scalar

Primary venue image URL

`AppGroup.iconUrl` ● `String` scalar

Admin-managed group icon URL

`AppGroup.imageUrl` ● `String` scalar

Admin-managed group hero image URL

`AppGroup.brandColorHex` ● `String` scalar

Admin-managed brand colour as a six-digit hexadecimal value

`AppGroup.primaryBalanceType` ● `String` scalar

Primary balance type used by the group

`AppGroup.merchantTypes` ● `[MerchantType!]!` non-null enum

Commerce capabilities supported by merchants in this group

`AppGroup.categories` ● `[String!]!` non-null scalar

Merged venue categories across the group

`AppGroup.categoryLabel` ● `String!` non-null scalar

Admin-managed primary display category

`AppGroup.localCreditName` ● `String` scalar

Admin-managed display name for local credit balances

`AppGroup.allowCustomerSelectedRedemptionAmount` ● `Boolean!` non-null scalar

Whether wallet customers may choose partial/custom POS redemption amounts

`AppGroup.balanceVisibility` ● `RoWalletBalanceVisibility!` non-null enum

Account balance types shown in RO Wallet

`AppGroup.description` ● `String` scalar

Primary venue description

`AppGroup.venueCount` ● `Int!` non-null scalar

Number of merchant venues linked to the group

`AppGroup.availableCredit` ● `Float!` non-null scalar

Available currency credit summed across the resolved wallets for this group

`AppGroup.availableCreditCurrencyCode` ● `String!` non-null scalar

ISO 4217 currency code for availableCredit

`AppGroup.rewardPoints` ● `Float!` non-null scalar

Available points summed across the resolved wallets for this group

`AppGroup.displayBalance` ● `AppGroupDisplayBalance` object

Non-zero balance selected for linked-brand display, or null when both balances are zero

`AppGroup.redemptionConversion` ● `AppGroupRedemptionConversion` object

Server-calculated currency value of the member's points, or null when display is disabled

`AppGroup.activeOfferCount` ● `Int!` non-null scalar

Number of active, visible offers for this group

Show deprecated

`AppGroup.merchantColor` ● `MerchantColor` deprecated enum

DEPRECATED

Use brandColorHex.

Legacy primary venue colour token

Member Of

App object ● AppActivityItem object ● AppGroupDetail object

Fields
Member Of