OBJECT

Display

link GraphQL Schema definition

1type Display implements 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"): String!
33
34# Required permission: Category:read
35#
36# Limit is optional
37#
38# Store restrictions apply.
39#
40# Arguments
41# where: (self-explanatory)
42# sort: (self-explanatory)
43# limit: (self-explanatory)
44# page: (self-explanatory)
45categories(
46where: CategoryFilter,
47sort: [CategorySort!] = [customOrder_ASC],
48limit: Int,
49page: Int
50): [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(
69where: CampaignVariantFilter,
70sort: [CampaignVariantSort!] = [id_ASC],
71limit: Int = 20,
72page: Int = 1
73): [CampaignVariant!]!
74
75# Required permission: Display:read
76#
77# All elements are always returned
78#
79# Store restrictions apply.
80displayItems: [DisplayItem!]!
81
82# Required permission: Localization:read
83#
84# All elements are always returned
85#
86# Arguments
87# where: (self-explanatory)
88localized(where: LocalizationFilter): [Localization!]!
89
90# Required permission: Market:read
91#
92# Limit is optional
93#
94# Store restrictions apply.
95#
96# Arguments
97# where: (self-explanatory)
98# sort: (self-explanatory)
99# limit: (self-explanatory)
100# page: (self-explanatory)
101markets(where: MarketFilter, sort: [MarketSort!] = [id_ASC], limit: Int, page: Int): [Market!]!
102
103# Required permission: ProductMedia:read
104#
105# Limit is optional
106#
107# Arguments
108# where: (self-explanatory)
109# sort: (self-explanatory)
110# limit: (self-explanatory)
111# page: (self-explanatory)
112media(where: ProductMediaFilter, sort: [ProductMediaSort!], limit: Int, page: Int): [ProductMedia!]!
113
114# Required permission: Price:read
115#
116# Limit is optional
117#
118# Store restrictions apply.
119#
120# Arguments
121# where: (self-explanatory)
122# sort: (self-explanatory)
123# limit: (self-explanatory)
124# page: (self-explanatory)
125prices(where: PriceFilter, sort: [PriceSort!] = [productId_ASC, productVariantId_ASC], limit: Int, page: Int): [Price!]!
126
127# Required permission: Product:read
128product: Product!
129
130# Required permission: ProductVariant:read
131#
132# Limit is optional
133#
134# Arguments
135# where: (self-explanatory)
136# sort: (self-explanatory)
137# limit: (self-explanatory)
138# page: (self-explanatory)
139productVariants(
140where: ProductVariantFilter,
141sort: [ProductVariantSort!] = [id_ASC],
142limit: Int,
143page: Int
144): [ProductVariant!]!
145
146# Required permission: Display:read
147#
148# All elements are always returned
149related: [DisplayRelation!]!
150
151# Required permission: Store:read
152#
153# Store restrictions apply.
154store: Store!
155
156# Required permission: TaxRule:read
157taxGroup: TaxGroup
158
159}