OBJECT

ProductVariant

link GraphQL Schema definition

1type ProductVariant implements ObjectWithAttributes, ObjectWithTranslations {
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"): DateTimeTz!
18
19stockOffset: Int!
20
21shippingSpecificationSettings: ShippingSpecificationSettings
22
23# Required permission: ProductVariant.attributes:read
24#
25# All elements are always returned
26#
27# Arguments
28# where: (self-explanatory)
29attributes(where: AssignedAttributeFilter): [Attribute!]!
30
31# Required permission: Campaign:read
32#
33# Limit is optional
34#
35# Store restrictions apply.
36#
37# Arguments
38# where: (self-explanatory)
39# sort: (self-explanatory)
40# limit: (self-explanatory)
41# page: (self-explanatory)
42campaignVariants(where: CampaignVariantFilter, sort: [CampaignVariantSort!] = [id_ASC], limit: Int, page: Int): [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: Translation:read
52#
53# All elements are always returned
54#
55# Arguments
56# where: (self-explanatory)
57translations(where: TranslationFilter): [LanguageTranslation!]!
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(where: SubscriptionPlanFilter, sort: [SubscriptionPlanSort!] = [naturalSort_ASC, id_ASC]): [SubscriptionPlan!]!
118
119externalId: String
120
121# Required permission: PurchaseOrderDelivery:read
122#
123# Limit must be in range 1 - 200
124#
125# Arguments
126# where: (self-explanatory)
127# sort: (self-explanatory)
128# limit: (self-explanatory)
129# page: (self-explanatory)
130purchaseOrderDeliveries(
131where: PurchaseOrderDeliveryFilter,
132sort: [PurchaseOrderDeliverySort!] = [id_DESC],
133limit: Int = 20,
134page: Int = 1
135): [PurchaseOrderDelivery!]!
136
137# Required permission: PurchaseOrder:read
138#
139# Limit must be in range 1 - 200
140#
141# Arguments
142# where: (self-explanatory)
143# sort: (self-explanatory)
144# limit: (self-explanatory)
145# page: (self-explanatory)
146purchaseOrders(where: PurchaseOrderFilter, sort: [PurchaseOrderSort!] = [id_DESC], limit: Int = 20, page: Int = 1): [PurchaseOrder!]!
147
148# Required permission: ProductVariantSupply:read
149#
150# Limit must be in range 1 - 200
151#
152# Arguments
153# where: (self-explanatory)
154# sort: (self-explanatory)
155# limit: (self-explanatory)
156# page: (self-explanatory)
157supply(where: ProductVariantSupplyFilter, sort: [ProductVariantSupplySort!] = [supplierName_ASC], limit: Int = 20, page: Int = 1): [ProductVariantSupply!]!
158
159}