OBJECT

Display

link GraphQL Schema definition

1type Display implements ObjectWithAttributes, ObjectWithTranslations, Localizable {
2id: Int!
3
4name: String!
5
6status: Status!
7
8uri: String!
9
10minimumOrderQuantity: Int
11
12orderQuantityDenominator: Int
13
14description: String
15
16shortDescription: String
17
18metaTitle: String
19
20metaDescription: String
21
22metaKeywords: String
23
24# Required permission: Display.comment:read
25comment: String
26
27# All elements are always returned
28tags: [String!]!
29
30# Arguments
31# format: ISO-8601
32updatedAt(format: String = "Y-m-d\\TH:i:sP"): DateTimeTz!
33
34# Required permission: Display.attributes:read
35#
36# All elements are always returned
37attributes: [Attribute!]!
38
39# Required permission: Category:read
40#
41# Limit is optional
42#
43# Store restrictions apply.
44#
45# Arguments
46# where: (self-explanatory)
47# sort: (self-explanatory)
48# limit: (self-explanatory)
49# page: (self-explanatory)
50categories(where: CategoryFilter, sort: [CategorySort!] = [customOrder_ASC], limit: Int, page: Int): [Category!]!
51
52# Required permission: Category:read
53#
54# Store restrictions apply.
55canonicalCategory: Category
56
57# Required permission: Campaign:read
58#
59# Limit must be in range 1 - 200
60#
61# Store restrictions apply.
62#
63# Arguments
64# where: (self-explanatory)
65# sort: (self-explanatory)
66# limit: (self-explanatory)
67# page: (self-explanatory)
68campaignVariants(where: CampaignVariantFilter, sort: [CampaignVariantSort!] = [id_ASC], limit: Int = 20, page: Int = 1): [CampaignVariant!]!
69
70# Required permission: Display:read
71#
72# All elements are always returned
73#
74# Store restrictions apply.
75displayItems: [DisplayItem!]!
76
77# Required permission: Translation:read
78#
79# All elements are always returned
80#
81# Arguments
82# where: (self-explanatory)
83translations(where: TranslationFilter): [LanguageTranslation!]!
84
85# Required permission: Market:read
86#
87# Limit is optional
88#
89# Store restrictions apply.
90#
91# Arguments
92# where: (self-explanatory)
93# sort: (self-explanatory)
94# limit: (self-explanatory)
95# page: (self-explanatory)
96markets(where: MarketFilter, sort: [MarketSort!] = [id_ASC], limit: Int, page: Int): [Market!]!
97
98# Required permission: ProductMedia:read
99#
100# Limit is optional
101#
102# Arguments
103# where: (self-explanatory)
104# sort: (self-explanatory)
105# limit: (self-explanatory)
106# page: (self-explanatory)
107media(where: ProductMediaFilter, sort: [ProductMediaSort!], limit: Int, page: Int): [ProductMedia!]!
108
109# Required permission: Price:read
110#
111# Limit is optional
112#
113# Store restrictions apply.
114#
115# Arguments
116# where: (self-explanatory)
117# sort: (self-explanatory)
118# limit: (self-explanatory)
119# page: (self-explanatory)
120prices(where: PriceFilter, sort: [PriceSort!] = [productId_ASC, productVariantId_ASC], limit: Int, page: Int): [Price!]!
121
122# Required permission: Product:read
123product: Product!
124
125# Required permission: ProductVariant:read
126#
127# Limit is optional
128#
129# Arguments
130# where: (self-explanatory)
131# sort: (self-explanatory)
132# limit: (self-explanatory)
133# page: (self-explanatory)
134productVariants(where: ProductVariantFilter, sort: [ProductVariantSort!] = [id_ASC], limit: Int, page: Int): [ProductVariant!]!
135
136# Required permission: Display:read
137#
138# All elements are always returned
139related: [DisplayRelation!]!
140
141# Required permission: Store:read
142#
143# Store restrictions apply.
144store: Store!
145
146# Required permission: TaxRule:read
147taxGroup: TaxGroup
148
149}