Skip to main content

PartnerBrand

A brand available to the calling partner. name is the value to pass as brand on brand-aware mutations to disambiguate a partner that operates more than one brand. A single-brand partner has exactly one, with isDefault true.

type PartnerBrand {
displayName: String
isDefault: Boolean!
name: ID!
}

Fields

PartnerBrand.displayName ● String scalar

Human-friendly display name for this brand, localized to the request language, if one is configured. Null when the brand has no configured display name. Not unique: two brands of the same partner may share a display name, so name is the identifier to key on.

PartnerBrand.isDefault ● Boolean! non-null scalar

True if this is the partner's default brand, which applies when brand is omitted from a brand-aware mutation

PartnerBrand.name ● ID! non-null scalar

The brand identifier; the value to pass as brand on brand-aware mutations

Member Of

BrandsResults object

Implemented By

BrandResponse union