OBJECT

ProductVariant

link GraphQL Schema definition

1type ProductVariant implements ObjectWithAttributes, Localizable {
2id: Int!
3
4name: String
5
6status: Status!
7
8variantNumber: String
9
10# Required permission: ProductVariant.internalName:read
11internalName: String
12
13unitCost: MonetaryValue
14
15# Arguments
16# format: ISO-8601
17updatedAt(format: String = "Y-m-d\\TH:i:sP"): String!
18
19stockOffset: Int!
20
21# Required permission: ProductVariant.attributes:read
22#
23# All elements are always returned
24attributes: [Attribute!]!
25
26# Required permission: Campaign:read
27#
28# Limit is optional
29#
30# Store restrictions apply.
31#
32# Arguments
33# where: (self-explanatory)
34# sort: (self-explanatory)
35# limit: (self-explanatory)
36# page: (self-explanatory)
37campaignVariants(
38where: CampaignVariantFilter,
39sort: [CampaignVariantSort!] = [id_ASC],
40limit: Int,
41page: Int
42): [CampaignVariant!]!
43
44# Required permission: Display:read
45#
46# All elements are always returned
47#
48# Store restrictions apply.
49displays: [Display!]!
50
51# Required permission: Localization:read
52#
53# All elements are always returned
54#
55# Arguments
56# where: (self-explanatory)
57localized(where: LocalizationFilter): [Localization!]!
58
59# Required permission: ProductMedia:read
60#
61# All elements are always returned
62media: [ProductMedia!]!
63
64# Required permission: Price:read
65#
66# Limit is optional
67#
68# Store restrictions apply.
69#
70# Arguments
71# where: (self-explanatory)
72# sort: (self-explanatory)
73# limit: (self-explanatory)
74# page: (self-explanatory)
75prices(where: PriceFilter, sort: [PriceSort!] = [pricelistId_ASC], limit: Int, page: Int): [Price!]!
76
77# Required permission: Product:read
78product: Product!
79
80# Required permission: ProductSize:read
81#
82# All elements are always returned
83#
84# Arguments
85# where: (self-explanatory)
86productSizes(where: ProductSizeFilter): [ProductSize!]!
87
88# Required permission: SizeChart:read
89sizeChart: SizeChart
90
91# Required permission: ProductVariant.stock:read
92#
93# Limit must be in range 1 - 200
94#
95# Arguments
96# where: (self-explanatory)
97# sort: (self-explanatory)
98# limit: (self-explanatory)
99# page: (self-explanatory)
100stock(where: StockFilter, sort: [StockSort!] = [warehouseId_ASC, productSizeSort_ASC], limit: Int = 20, page: Int = 1): [Stock!]!
101
102# Required permission: ProductVariant.stockTotals:read
103#
104# Arguments
105# where: (self-explanatory)
106stockTotals(where: StockTotalsFilter): StockTotals!
107
108# Required permission: SubscriptionPlan:read
109#
110# All elements are always returned
111#
112# Store restrictions apply.
113#
114# Arguments
115# where: (self-explanatory)
116# sort: (self-explanatory)
117availableInSubscriptionPlans(
118where: SubscriptionPlanFilter,
119sort: [SubscriptionPlanSort!] = [naturalSort_ASC, id_ASC]
120): [SubscriptionPlan!]!
121
122# Required permission: PurchaseOrderDelivery:read
123#
124# Limit must be in range 1 - 200
125#
126# Arguments
127# where: (self-explanatory)
128# sort: (self-explanatory)
129# limit: (self-explanatory)
130# page: (self-explanatory)
131purchaseOrderDeliveries(
132where: PurchaseOrderDeliveryFilter,
133sort: [PurchaseOrderDeliverySort!] = [id_DESC],
134limit: Int = 20,
135page: Int = 1
136): [PurchaseOrderDelivery!]!
137
138# Required permission: PurchaseOrder:read
139#
140# Limit must be in range 1 - 200
141#
142# Arguments
143# where: (self-explanatory)
144# sort: (self-explanatory)
145# limit: (self-explanatory)
146# page: (self-explanatory)
147purchaseOrders(
148where: PurchaseOrderFilter,
149sort: [PurchaseOrderSort!] = [id_DESC],
150limit: Int = 20,
151page: Int = 1
152): [PurchaseOrder!]!
153
154# Required permission: ProductVariantSupply:read
155#
156# Limit must be in range 1 - 200
157#
158# Arguments
159# where: (self-explanatory)
160# sort: (self-explanatory)
161# limit: (self-explanatory)
162# page: (self-explanatory)
163supply(
164where: ProductVariantSupplyFilter,
165sort: [ProductVariantSupplySort!] = [supplierName_ASC],
166limit: Int = 20,
167page: Int = 1
168): [ProductVariantSupply!]!
169
170}