Skip to main content

Page

A Page is a part of the Demand Domain and represents a page with textual and image content on it, that has nothing to do with products. This can range from "About Us" pages to Blog articles. Use the "pageType" field to differentiate. Pages do not have locales specified, but since everything would be different anyway, "pageType" can be a composite key with locale in it.

type Page {
  author: String
  content: PageContent
  contentItemIds: [ID!]
  contentItems: [PageContentItem]
  createdAt: Date!
  demandHqId: ID!
  description: String
  descriptionOrExcerpt(
  numberOfCharacters: Int
): String
  pageId: ID!
  pageType: String!
  primaryImageUrl: String
  primaryImageUrlWithFallback(
  height: Int
  width: Int
): String
  publishedAt: Date
  secondaryImageUrl: String
  seoDescription: String
  seoTitle: String
  slug: String!
  status: DemandEntityStatus!
  storefrontIds: [ID]
  subtitle: String
  tags: PageTags
  tertiaryImageUrl: String
  title: String!
  updatedAt: Date!
  updatedBy: ID!
}

Fields​

Page.author ● String scalar​

The author of the page, limit 256 characters.

Page.content ● PageContent object​

Get the content of the page.

Page.contentItemIds ● [ID!] list scalar​

The ContentItemIds of the Content Items that are associated with this page.

Page.contentItems ● [PageContentItem] list object​

Get the content items of the page.

Page.createdAt ● Date! non-null scalar​

Page.demandHqId ● ID! non-null scalar​

Page.description ● String scalar​

A short description of the page, limit 1000 characters.

Page.descriptionOrExcerpt ● String scalar​

Get the description if it exists, or fallback to the excerpt of content for the page.

Page.descriptionOrExcerpt.numberOfCharacters ● Int scalar​

The number of characters to return, defaults to 200.

Page.pageId ● ID! non-null scalar​

Page.pageType ● String! non-null scalar​

Any string to declare a category of this page, can be used to filter pages, limit 128 characters.

Page.primaryImageUrl ● String scalar​

A primary image url for this page, can be generated from a Page ContentItem.

Page.primaryImageUrlWithFallback ● String scalar​

Returns the primary image URL if exists, otherwise attempts to construct an image url from the first (featured) image of the page. If the primary image URL is a CDN URL, it can be passed width and height properties to return a resized image.

Page.primaryImageUrlWithFallback.height ● Int scalar​

The height of the image to return in pixels.

Page.primaryImageUrlWithFallback.width ● Int scalar​

The width of the image to return in pixels.

Page.publishedAt ● Date scalar​

ISO format date when the page was published. Note that ensuing updates with status set to PUBLISHED will republish and re-set this date.

Page.secondaryImageUrl ● String scalar​

A secondary image url for this page, often a logo or related item.

Page.seoDescription ● String scalar​

Description specific for SEO purposes, limit 170 characters.

Page.seoTitle ● String scalar​

Title specific for SEO purposes, limit 256 characters.

Page.slug ● String! non-null scalar​

Slug for the URL for this page. Limit 128 characters.

Page.status ● DemandEntityStatus! non-null enum​

The status of the page, can be DRAFT or PUBLISHED.

Page.storefrontIds ● [ID] list scalar​

Which storefronts should have access to this page?

Page.subtitle ● String scalar​

The subtitle of the page, limit 256 characters.

Page.tags ● PageTags object​

Get the tags of the page.

Page.tertiaryImageUrl ● String scalar​

A tertiary image url for this page, not often used.

Page.title ● String! non-null scalar​

The title of the page, limit 256 characters.

Page.updatedAt ● Date! non-null scalar​

Page.updatedBy ● ID! non-null scalar​

Returned by​

createPage mutation ● createPageImageFromUrl mutation ● page query ● updatePage mutation

Member of​

DemandHq object ● PageConnectionWithSearch object ● PageEdge object ● PageImageFromFileResponse object