OBJECT

ProductVariant

GraphQL Schema definition

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

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

ProductVariant

link GraphQL Schema definition

link Required by

GraphQL Schema definition

Required by