Skip to main content

PublicPortalConfig

The portal settings returned to the customer portal and buyer app. It carries nothing sensitive.

type PublicPortalConfig {
  accentColor: String!
  allowDirectOrders: Boolean!
  allowGuestBrowsing: Boolean!
  allowQuoteRequests: Boolean!
  allowSelfRegistration: Boolean!
  approvalWorkflowEnabled: Boolean!
  branchesEnabled: Boolean!
  canonicalHost: String!
  countryCode: String
  currencyCode: String
  currencySymbolStyle: String
  dateFormat: String
  faviconUrl: String
  gatewayEnabled: Boolean!
  isEnabled: Boolean!
  logoUrl: String
  mobileAndroidPackageName: String
  mobileAndroidSha256CertFingerprints: [String!]
  mobileAndroidStoreUrl: String
  mobileAppScheme: String
  mobileAppleTeamId: String
  mobileIosBundleId: String
  mobileIosStoreUrl: String
  placeholderImageUrl: String
  portalName: String!
  portalOrigin: String
  primaryColor: String!
  quoteValidityDays: Int!
  requireAddressApproval: Boolean!
  requireCustomerApproval: Boolean!
  returnsWindowDays: Int!
  showInventory: Boolean!
  showPricing: Boolean!
  subdomain: String!
  supportEmail: String
  supportPhone: String
  welcomeMessage: String
}

Fields​

PublicPortalConfig.accentColor ● String! non-null scalar​

The accent colour.

PublicPortalConfig.allowDirectOrders ● Boolean! non-null scalar​

True when customers can order directly.

PublicPortalConfig.allowGuestBrowsing ● Boolean! non-null scalar​

True when visitors can browse without signing in.

PublicPortalConfig.allowQuoteRequests ● Boolean! non-null scalar​

True when customers can request quotes.

PublicPortalConfig.allowSelfRegistration ● Boolean! non-null scalar​

True when customers can register themselves.

PublicPortalConfig.approvalWorkflowEnabled ● Boolean! non-null scalar​

True when customer orders go through the buyer-side approval workflow.

PublicPortalConfig.branchesEnabled ● Boolean! non-null scalar​

True when the branch features of the portal are on: the branch toggle on addresses, the branch picker and branch-scoped approvals.

PublicPortalConfig.canonicalHost ● String! non-null scalar​

The one host the portal treats as its address for this organization: the verified primary custom domain when there is one, otherwise the subdomain.

PublicPortalConfig.countryCode ● String scalar​

The organization's country code, so a new customer address defaults to the seller's country.

PublicPortalConfig.currencyCode ● String scalar​

ISO 4217 currency code.

PublicPortalConfig.currencySymbolStyle ● String scalar​

Currency symbol display style: "local" | "international" | "code_only". Display-only; null when the org has never set it.

PublicPortalConfig.dateFormat ● String scalar​

Org calendar date format, e.g. "DD-MM-YYYY". Display-only; null when the org has never set it.

PublicPortalConfig.faviconUrl ● String scalar​

The URL of the portal favicon.

PublicPortalConfig.gatewayEnabled ● Boolean! non-null scalar​

True when the organization has at least one enabled payment gateway whose keys are verified, so online payment can be offered.

PublicPortalConfig.isEnabled ● Boolean! non-null scalar​

True when the portal is switched on.

PublicPortalConfig.logoUrl ● String scalar​

The URL of the portal logo.

PublicPortalConfig.mobileAndroidPackageName ● String scalar​

Android application id of this tenant's buyer-app binary.

PublicPortalConfig.mobileAndroidSha256CertFingerprints ● [String!] list scalar​

SHA-256 certificate fingerprints Android accepts for this app.

PublicPortalConfig.mobileAndroidStoreUrl ● String scalar​

Play Store listing URL for this tenant's buyer app.

PublicPortalConfig.mobileAppScheme ● String scalar​

URL scheme of this tenant's buyer app (for example myshop for myshop:// links).

PublicPortalConfig.mobileAppleTeamId ● String scalar​

Apple Developer Team ID for this tenant's buyer-app binary.

PublicPortalConfig.mobileIosBundleId ● String scalar​

iOS bundle identifier of this tenant's buyer-app binary.

PublicPortalConfig.mobileIosStoreUrl ● String scalar​

App Store listing URL for this tenant's buyer app.

PublicPortalConfig.placeholderImageUrl ● String scalar​

The image shown wherever a product, category or other catalog image is missing.

PublicPortalConfig.portalName ● String! non-null scalar​

The name shown on the portal.

PublicPortalConfig.portalOrigin ● String scalar​

The canonical host as an origin the buyer app can share a product link on, without a trailing slash.

PublicPortalConfig.primaryColor ● String! non-null scalar​

The main brand colour.

PublicPortalConfig.quoteValidityDays ● Int! non-null scalar​

How many days a quote stays valid.

PublicPortalConfig.requireAddressApproval ● Boolean! non-null scalar​

True when a buyer-created address starts inactive and a seller must activate it before the buyer can order to it.

PublicPortalConfig.requireCustomerApproval ● Boolean! non-null scalar​

True when new customers must be approved before they can order.

PublicPortalConfig.returnsWindowDays ● Int! non-null scalar​

How many days after delivery a return can be requested.

PublicPortalConfig.showInventory ● Boolean! non-null scalar​

True when stock levels are shown.

PublicPortalConfig.showPricing ● Boolean! non-null scalar​

True when prices are shown.

PublicPortalConfig.subdomain ● String! non-null scalar​

The subdomain of the portal.

PublicPortalConfig.supportEmail ● String scalar​

The support email address.

PublicPortalConfig.supportPhone ● String scalar​

The support phone number.

PublicPortalConfig.welcomeMessage ● String scalar​

The welcome message on the portal.

Returned By​

publicPortalConfig query