Skip to main content
Version: 3.x

PageType

Represents a type of page. It defines what attributes are available to pages of this type.

type PageType implements Node, ObjectWithMetadata {
id: ID!
privateMetadata: [MetadataItem!]!
privateMetafield(key: String!): String
privateMetafields(keys: [String!]): Metadata
metadata: [MetadataItem!]!
metafield(key: String!): String
metafields(keys: [String!]): Metadata
name: String!
slug: String!
attributes: [Attribute!]
availableAttributes(
filter: AttributeFilterInput
before: String
after: String
first: Int
last: Int
): AttributeCountableConnection
hasPages: Boolean
}

Fields

PageType.id ● ID! non-null scalar

PageType.privateMetadata ● [MetadataItem!]! non-null object

List of private metadata items. Requires staff permissions to access.

PageType.privateMetafield ● String scalar

A single key from private metadata. Requires staff permissions to access.

Tip: Use GraphQL aliases to fetch multiple keys.

Added in Saleor 3.3.

Note: this API is currently in Feature Preview and can be subject to changes at later point.

PageType.privateMetafield.key ● String! non-null scalar

PageType.privateMetafields ● Metadata scalar

Private metadata. Requires staff permissions to access. Use keys to control which fields you want to include. The default is to include everything.

Added in Saleor 3.3.

Note: this API is currently in Feature Preview and can be subject to changes at later point.

PageType.privateMetafields.keys ● [String!] list scalar

PageType.metadata ● [MetadataItem!]! non-null object

List of public metadata items. Can be accessed without permissions.

PageType.metafield ● String scalar

A single key from public metadata.

Tip: Use GraphQL aliases to fetch multiple keys.

Added in Saleor 3.3.

Note: this API is currently in Feature Preview and can be subject to changes at later point.

PageType.metafield.key ● String! non-null scalar

PageType.metafields ● Metadata scalar

Public metadata. Use keys to control which fields you want to include. The default is to include everything.

Added in Saleor 3.3.

Note: this API is currently in Feature Preview and can be subject to changes at later point.

PageType.metafields.keys ● [String!] list scalar

PageType.name ● String! non-null scalar

PageType.slug ● String! non-null scalar

PageType.attributes ● [Attribute!] list object

Page attributes of that page type.

PageType.availableAttributes ● AttributeCountableConnection object

Attributes that can be assigned to the page type.

Requires one of the following permissions: MANAGE_PAGES.

PageType.availableAttributes.filter ● AttributeFilterInput input
PageType.availableAttributes.before ● String scalar

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

PageType.availableAttributes.after ● String scalar

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

PageType.availableAttributes.first ● Int scalar

Return the first n elements from the list.

PageType.availableAttributes.last ● Int scalar

Return the last n elements from the list.

PageType.hasPages ● Boolean scalar

Whether page type has pages assigned.

Requires one of the following permissions: MANAGE_PAGES.

Interfaces

Node interface

An object with an ID

ObjectWithMetadata interface

Returned by

pageType query

Member of

Page object ● PageAttributeAssign object ● PageAttributeUnassign object ● PageTypeCountableEdge object ● PageTypeCreate object ● PageTypeCreated object ● PageTypeDelete object ● PageTypeDeleted object ● PageTypeReorderAttributes object ● PageTypeUpdate object ● PageTypeUpdated object

Implemented by

_Entity union