Skip to main content

PortalConfigResponse

The portal settings, for the admin console.

type PortalConfigResponse {
  accentColor: String!
  allowDirectOrders: Boolean!
  allowGuestBrowsing: Boolean!
  allowQuoteRequests: Boolean!
  allowSelfRegistration: Boolean!
  approvalWorkflowEnabled: Boolean!
  faviconUrl: String
  id: ID!
  isEnabled: Boolean!
  logoUrl: String
  organizationId: String!
  placeholderImageUrl: String
  portalName: String
  portalUrl: String!
  primaryColor: String!
  resolvedLogoUrl: String
  resolvedName: String!
  showInventory: Boolean!
  showPricing: Boolean!
  subdomain: String!
  supportEmail: String
  supportPhone: String
  welcomeMessage: String
}

Fields

`PortalConfigResponse.accentColor` ● `String!` non-null scalar

The accent colour.

`PortalConfigResponse.allowDirectOrders` ● `Boolean!` non-null scalar

True when customers can order directly.

`PortalConfigResponse.allowGuestBrowsing` ● `Boolean!` non-null scalar

True when visitors can browse without signing in.

`PortalConfigResponse.allowQuoteRequests` ● `Boolean!` non-null scalar

True when customers can request quotes.

`PortalConfigResponse.allowSelfRegistration` ● `Boolean!` non-null scalar

True when customers can register themselves.

`PortalConfigResponse.approvalWorkflowEnabled` ● `Boolean!` non-null scalar

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

`PortalConfigResponse.faviconUrl` ● `String` scalar

The URL of the portal favicon.

`PortalConfigResponse.id` ● `ID!` non-null scalar

The unique ID of this record.

`PortalConfigResponse.isEnabled` ● `Boolean!` non-null scalar

True when the portal is switched on.

`PortalConfigResponse.logoUrl` ● `String` scalar

The URL of the portal logo.

`PortalConfigResponse.organizationId` ● `String!` non-null scalar

The ID of the organization the record belongs to.

`PortalConfigResponse.placeholderImageUrl` ● `String` scalar

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

`PortalConfigResponse.portalName` ● `String` scalar

The name shown on the portal.

`PortalConfigResponse.portalUrl` ● `String!` non-null scalar

The address of the portal.

`PortalConfigResponse.primaryColor` ● `String!` non-null scalar

The main brand colour.

`PortalConfigResponse.resolvedLogoUrl` ● `String` scalar

The logo shown, taken from the organization when no portal logo is set.

`PortalConfigResponse.resolvedName` ● `String!` non-null scalar

The name shown, taken from the organization when no portal name is set.

`PortalConfigResponse.showInventory` ● `Boolean!` non-null scalar

True when stock levels are shown.

`PortalConfigResponse.showPricing` ● `Boolean!` non-null scalar

True when prices are shown.

`PortalConfigResponse.subdomain` ● `String!` non-null scalar

The subdomain of the portal.

`PortalConfigResponse.supportEmail` ● `String` scalar

The support email address.

`PortalConfigResponse.supportPhone` ● `String` scalar

The support phone number.

`PortalConfigResponse.welcomeMessage` ● `String` scalar

The welcome message on the portal.

Returned By

portalConfig query ● updatePortalConfig mutation

Fields
Returned By