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
30storeItemId: Int!
31
32# Arguments
33# format: ISO-8601
34updatedAt(format: String = "Y-m-d\\TH:i:sP"): DateTimeTz!
35
36# Required permission: Display.attributes:read
37#
38# All elements are always returned
39#
40# Arguments
41# where: (self-explanatory)
42attributes(where: AssignedAttributeFilter): [Attribute!]!
43
44# Required permission: Category:read
45#
46# Limit is optional
47#
48# Store restrictions apply.
49#
50# Arguments
51# where: (self-explanatory)
52# sort: (self-explanatory)
53# limit: (self-explanatory)
54# page: (self-explanatory)
55categories(where: CategoryFilter, sort: [CategorySort!] = [customOrder_ASC], limit: Int, page: Int): [Category!]!
56
57# Required permission: Category:read
58#
59# Store restrictions apply.
60canonicalCategory: Category
61
62# Required permission: Campaign:read
63#
64# Limit must be in range 1 - 200
65#
66# Store restrictions apply.
67#
68# Arguments
69# where: (self-explanatory)
70# sort: (self-explanatory)
71# limit: (self-explanatory)
72# page: (self-explanatory)
73campaignVariants(where: CampaignVariantFilter, sort: [CampaignVariantSort!] = [id_ASC], limit: Int = 20, page: Int = 1): [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: Translation:read
83#
84# All elements are always returned
85#
86# Arguments
87# where: (self-explanatory)
88translations(where: TranslationFilter): [LanguageTranslation!]!
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(where: ProductVariantFilter, sort: [ProductVariantSort!] = [id_ASC], limit: Int, page: Int): [ProductVariant!]!
140
141# Required permission: Display:read
142#
143# All elements are always returned
144related: [DisplayRelation!]!
145
146# Required permission: Store:read
147#
148# Store restrictions apply.
149store: Store!
150
151# Required permission: TaxRule:read
152taxGroup: TaxGroup
153
154}