Skip to main content

Storefront

A Storefront represents a customer facing ecommerce website that consumes Resonance Demand Entities

type Storefront {
  analyticsSettings: StorefrontAnalyticsSettings
  apiKey(
  slug: String!
): StorefrontApiKey
  apiKeys: [StorefrontApiKey]!
  authenticationSettings: StorefrontAuthenticationSettings
  authenticationType: StorefrontAuthenticationType
  collectionTypeContents(
  after: String
  before: String
  first: Int
  last: Int
): CollectionTypeContentConnection!
  createdAt: Date!
  customer(
  customerId: ID!
): Customer
  customers(
  after: String
  before: String
  customerIds: [ID]
  first: Int
  last: Int
): CustomerConnectionWithSearch!
  demandHqId: ID!
  description: String
  emailSettings: StorefrontEmailSettings
  name: String!
  navs(
  after: String
  before: String
  first: Int
  href: String
  hrefPrefix: String
  last: Int
  navIds: [ID]
  navLevel: Int
  navType: String
): NavConnection!
  pageTypeContents(
  after: String
  before: String
  first: Int
  last: Int
): PageTypeContentConnection!
  storefrontId: ID!
  storefrontIdentities: [StorefrontIdentity!]
  updatedAt: Date!
  updatedBy: ID!
  urlDomain: String!
}

Fields​

Storefront.analyticsSettings ● StorefrontAnalyticsSettings object​

The settings for Analytics for this Storefront.

Requires the storefrontanalyticssettings/read permission on the associated DemandHq.

Storefront.apiKey ● StorefrontApiKey object​

Get an api key for this storefront by identitySlug.

Storefront.apiKey.slug ● String! non-null scalar​

Storefront.apiKeys ● [StorefrontApiKey]! non-null object​

Get all api keys for this storefront.

Storefront.authenticationSettings ● StorefrontAuthenticationSettings object​

Storefront.authenticationType ● StorefrontAuthenticationType enum​

Storefront.collectionTypeContents ● CollectionTypeContentConnection! non-null object​

Get all collectionTypeContents for a storefront.

Requires the collectiontypecontent/read scope on the associated DemandHq

Storefront.collectionTypeContents.after ● String scalar​

Returns the elements in the list that come after the specified cursor.

Storefront.collectionTypeContents.before ● String scalar​

Returns the elements in the list that come before the specified cursor.

Storefront.collectionTypeContents.first ● Int scalar​

Returns the first n elements from the list.

Storefront.collectionTypeContents.last ● Int scalar​

Returns the last n elements from the list.

Storefront.createdAt ● Date! non-null scalar​

Storefront.customer ● Customer object​

Get a Customer by their customerId.

Requires the customer/read permission for the associated DemandHq.

Storefront.customer.customerId ● ID! non-null scalar​

Storefront.customers ● CustomerConnectionWithSearch! non-null object​

Get a list of Customers.

Requires the customer/read permission for the associated DemandHq.

Storefront.customers.after ● String scalar​

Returns the elements in the list that come after the specified cursor.

Storefront.customers.before ● String scalar​

Returns the elements in the list that come before the specified cursor.

Storefront.customers.customerIds ● [ID] list scalar​
Storefront.customers.first ● Int scalar​

Returns the first n elements from the list.

Storefront.customers.last ● Int scalar​

Returns the last n elements from the list.

Storefront.demandHqId ● ID! non-null scalar​

Storefront.description ● String scalar​

Storefront.emailSettings ● StorefrontEmailSettings object​

The settings for Email for this Storefront.

Requires the storefrontemailsettings/read permission on the associated DemandHq.

Storefront.name ● String! non-null scalar​

Storefront.navs ● NavConnection! non-null object​

List Navs for a storefront.

Requires the user to have the nav/read permission on the associated DemandHq.

Storefront.navs.after ● String scalar​

Returns the elements in the list that come after the specified cursor.

Storefront.navs.before ● String scalar​

Returns the elements in the list that come before the specified cursor.

Storefront.navs.first ● Int scalar​

Returns the first n elements from the list.

Storefront.navs.href ● String scalar​
Storefront.navs.hrefPrefix ● String scalar​
Storefront.navs.last ● Int scalar​

Returns the last n elements from the list.

Storefront.navs.navIds ● [ID] list scalar​
Storefront.navs.navLevel ● Int scalar​
Storefront.navs.navType ● String scalar​

Storefront.pageTypeContents ● PageTypeContentConnection! non-null object​

Get all pageTypeContents for a storefront.

Requires the pagetypecontent/read scope on the associated DemandHq

Storefront.pageTypeContents.after ● String scalar​

Returns the elements in the list that come after the specified cursor.

Storefront.pageTypeContents.before ● String scalar​

Returns the elements in the list that come before the specified cursor.

Storefront.pageTypeContents.first ● Int scalar​

Returns the first n elements from the list.

Storefront.pageTypeContents.last ● Int scalar​

Returns the last n elements from the list.

Storefront.storefrontId ● ID! non-null scalar​

Storefront.storefrontIdentities ● [StorefrontIdentity!] list object​

Storefront.updatedAt ● Date! non-null scalar​

Storefront.updatedBy ● ID! non-null scalar​

Storefront.urlDomain ● String! non-null scalar​

Returned by​

createStorefront mutation ● storefront query ● updateStorefront mutation

Member of​

DemandHq object ● StorefrontConnection object ● StorefrontEdge object