PageType Object
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
where: AttributeWhereInput
search: String
before: String
after: String
first: Int
last: Int
): AttributeCountableConnection
hasPages: Boolean
}
Fields
id ● ID!
ID of the page type.
privateMetadata ● [MetadataItem!]!
List of private metadata items. Requires staff permissions to access.
privateMetafield ● String
A single key from private metadata. Requires staff permissions to access.
Tip: Use GraphQL aliases to fetch multiple keys.
key ● String!
privateMetafields ● Metadata
Private metadata. Requires staff permissions to access. Use keys to control which fields you want to include. The default is to include everything.
keys ● [String!]
metadata ● [MetadataItem!]!
List of public metadata items. Can be accessed without permissions.
metafield ● String
A single key from public metadata.
Tip: Use GraphQL aliases to fetch multiple keys.
key ● String!
metafields ● Metadata
Public metadata. Use keys to control which fields you want to include. The default is to include everything.
keys ● [String!]
name ● String!
Name of the page type.
slug ● String!
Slug of the page type.
attributes ● [Attribute!]
Page attributes of that page type.
availableAttributes ● AttributeCountableConnection
Attributes that can be assigned to the page type.
filter ● AttributeFilterInput
Use where filter instead.
Filtering options for attributes.
where ● AttributeWhereInput
Where filtering options for attributes.
search ● String
Search attributes.
before ● String
Return the elements in the list that come before the specified cursor.
after ● String
Return the elements in the list that come after the specified cursor.
first ● Int
Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.
last ● Int
Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.
hasPages ● Boolean
Whether page type has pages assigned.
Interfaces
Node
An object with an ID
ObjectWithMetadata
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 ● RefundSettings object ● ReturnSettings object
Implemented By
_Entity union ● ReferenceType union