OBJECT

ProductVariant

GraphQL Schema definition

1 type ProductVariant implements ObjectWithAttributes, ObjectWithTranslations, Localizable {
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 attributes: [Attribute!]! 
27 
28 #   Required permission: Campaign:read
29 # 
30 #   Limit is optional
31 # 
32 #   Store restrictions apply.
33 # 
34 # Arguments
35 #   where: (self-explanatory)
36 #   sort: (self-explanatory)
37 #   limit: (self-explanatory)
38 #   page: (self-explanatory)
39 campaignVariants(where: CampaignVariantFilter, sort: [CampaignVariantSort!] = [id_ASC], limit: Int, page: Int): [CampaignVariant!]! 
40 
41 #   Required permission: Display:read
42 # 
43 #   All elements are always returned
44 # 
45 #   Store restrictions apply.
46 displays: [Display!]! 
47 
48 #   Required permission: Translation:read
49 # 
50 #   All elements are always returned
51 # 
52 # Arguments
53 #   where: (self-explanatory)
54 translations(where: TranslationFilter): [LanguageTranslation!]! 
55 
56 #   Required permission: ProductMedia:read
57 # 
58 #   All elements are always returned
59 media: [ProductMedia!]! 
60 
61 #   Required permission: Price:read
62 # 
63 #   Limit is optional
64 # 
65 #   Store restrictions apply.
66 # 
67 # Arguments
68 #   where: (self-explanatory)
69 #   sort: (self-explanatory)
70 #   limit: (self-explanatory)
71 #   page: (self-explanatory)
72 prices(where: PriceFilter, sort: [PriceSort!] = [pricelistId_ASC], limit: Int, page: Int): [Price!]! 
73 
74 #   Required permission: Product:read
75 product: Product! 
76 
77 #   Required permission: ProductSize:read
78 # 
79 #   All elements are always returned
80 # 
81 # Arguments
82 #   where: (self-explanatory)
83 productSizes(where: ProductSizeFilter): [ProductSize!]! 
84 
85 #   Required permission: SizeChart:read
86 sizeChart: SizeChart 
87 
88 #   Required permission: ProductVariant.stock:read
89 # 
90 #   Limit must be in range 1 - 200
91 # 
92 # Arguments
93 #   where: (self-explanatory)
94 #   sort: (self-explanatory)
95 #   limit: (self-explanatory)
96 #   page: (self-explanatory)
97 stock(where: StockFilter, sort: [StockSort!] = [warehouseId_ASC, productSizeSort_ASC], limit: Int = 20, page: Int = 1): [Stock!]! 
98 
99 #   Required permission: ProductVariant.stockTotals:read
100 # 
101 # Arguments
102 #   where: (self-explanatory)
103 stockTotals(where: StockTotalsFilter): StockTotals! 
104 
105 #   Required permission: SubscriptionPlan:read
106 # 
107 #   All elements are always returned
108 # 
109 #   Store restrictions apply.
110 # 
111 # Arguments
112 #   where: (self-explanatory)
113 #   sort: (self-explanatory)
114 availableInSubscriptionPlans(where: SubscriptionPlanFilter, sort: [SubscriptionPlanSort!] = [naturalSort_ASC, id_ASC]): [SubscriptionPlan!]! 
115 
116 #   Required permission: PurchaseOrderDelivery:read
117 # 
118 #   Limit must be in range 1 - 200
119 # 
120 # Arguments
121 #   where: (self-explanatory)
122 #   sort: (self-explanatory)
123 #   limit: (self-explanatory)
124 #   page: (self-explanatory)
125 purchaseOrderDeliveries(
126 where: PurchaseOrderDeliveryFilter,
127 sort: [PurchaseOrderDeliverySort!] = [id_DESC],
128 limit: Int = 20,
129 page: Int = 1
130 ): [PurchaseOrderDelivery!]! 
131 
132 #   Required permission: PurchaseOrder:read
133 # 
134 #   Limit must be in range 1 - 200
135 # 
136 # Arguments
137 #   where: (self-explanatory)
138 #   sort: (self-explanatory)
139 #   limit: (self-explanatory)
140 #   page: (self-explanatory)
141 purchaseOrders(where: PurchaseOrderFilter, sort: [PurchaseOrderSort!] = [id_DESC], limit: Int = 20, page: Int = 1): [PurchaseOrder!]! 
142 
143 #   Required permission: ProductVariantSupply:read
144 # 
145 #   Limit must be in range 1 - 200
146 # 
147 # Arguments
148 #   where: (self-explanatory)
149 #   sort: (self-explanatory)
150 #   limit: (self-explanatory)
151 #   page: (self-explanatory)
152 supply(where: ProductVariantSupplyFilter, sort: [ProductVariantSupplySort!] = [supplierName_ASC], limit: Int = 20, page: Int = 1): [ProductVariantSupply!]! 
153 
154 }

1	type ProductVariant implements ObjectWithAttributes, ObjectWithTranslations, Localizable {
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	attributes: [Attribute!]!
27
28	# Required permission: Campaign:read
29	#
30	# Limit is optional
31	#
32	# Store restrictions apply.
33	#
34	# Arguments
35	# where: (self-explanatory)
36	# sort: (self-explanatory)
37	# limit: (self-explanatory)
38	# page: (self-explanatory)
39	campaignVariants(where: CampaignVariantFilter, sort: [CampaignVariantSort!] = [id_ASC], limit: Int, page: Int): [CampaignVariant!]!
40
41	# Required permission: Display:read
42	#
43	# All elements are always returned
44	#
45	# Store restrictions apply.
46	displays: [Display!]!
47
48	# Required permission: Translation:read
49	#
50	# All elements are always returned
51	#
52	# Arguments
53	# where: (self-explanatory)
54	translations(where: TranslationFilter): [LanguageTranslation!]!
55
56	# Required permission: ProductMedia:read
57	#
58	# All elements are always returned
59	media: [ProductMedia!]!
60
61	# Required permission: Price:read
62	#
63	# Limit is optional
64	#
65	# Store restrictions apply.
66	#
67	# Arguments
68	# where: (self-explanatory)
69	# sort: (self-explanatory)
70	# limit: (self-explanatory)
71	# page: (self-explanatory)
72	prices(where: PriceFilter, sort: [PriceSort!] = [pricelistId_ASC], limit: Int, page: Int): [Price!]!
73
74	# Required permission: Product:read
75	product: Product!
76
77	# Required permission: ProductSize:read
78	#
79	# All elements are always returned
80	#
81	# Arguments
82	# where: (self-explanatory)
83	productSizes(where: ProductSizeFilter): [ProductSize!]!
84
85	# Required permission: SizeChart:read
86	sizeChart: SizeChart
87
88	# Required permission: ProductVariant.stock:read
89	#
90	# Limit must be in range 1 - 200
91	#
92	# Arguments
93	# where: (self-explanatory)
94	# sort: (self-explanatory)
95	# limit: (self-explanatory)
96	# page: (self-explanatory)
97	stock(where: StockFilter, sort: [StockSort!] = [warehouseId_ASC, productSizeSort_ASC], limit: Int = 20, page: Int = 1): [Stock!]!
98
99	# Required permission: ProductVariant.stockTotals:read
100	#
101	# Arguments
102	# where: (self-explanatory)
103	stockTotals(where: StockTotalsFilter): StockTotals!
104
105	# Required permission: SubscriptionPlan:read
106	#
107	# All elements are always returned
108	#
109	# Store restrictions apply.
110	#
111	# Arguments
112	# where: (self-explanatory)
113	# sort: (self-explanatory)
114	availableInSubscriptionPlans(where: SubscriptionPlanFilter, sort: [SubscriptionPlanSort!] = [naturalSort_ASC, id_ASC]): [SubscriptionPlan!]!
115
116	# Required permission: PurchaseOrderDelivery:read
117	#
118	# Limit must be in range 1 - 200
119	#
120	# Arguments
121	# where: (self-explanatory)
122	# sort: (self-explanatory)
123	# limit: (self-explanatory)
124	# page: (self-explanatory)
125	purchaseOrderDeliveries(
126	where: PurchaseOrderDeliveryFilter,
127	sort: [PurchaseOrderDeliverySort!] = [id_DESC],
128	limit: Int = 20,
129	page: Int = 1
130	): [PurchaseOrderDelivery!]!
131
132	# Required permission: PurchaseOrder:read
133	#
134	# Limit must be in range 1 - 200
135	#
136	# Arguments
137	# where: (self-explanatory)
138	# sort: (self-explanatory)
139	# limit: (self-explanatory)
140	# page: (self-explanatory)
141	purchaseOrders(where: PurchaseOrderFilter, sort: [PurchaseOrderSort!] = [id_DESC], limit: Int = 20, page: Int = 1): [PurchaseOrder!]!
142
143	# Required permission: ProductVariantSupply:read
144	#
145	# Limit must be in range 1 - 200
146	#
147	# Arguments
148	# where: (self-explanatory)
149	# sort: (self-explanatory)
150	# limit: (self-explanatory)
151	# page: (self-explanatory)
152	supply(where: ProductVariantSupplyFilter, sort: [ProductVariantSupplySort!] = [supplierName_ASC], limit: Int = 20, page: Int = 1): [ProductVariantSupply!]!
153
154	}

ProductVariant

link GraphQL Schema definition

link Required by

GraphQL Schema definition

Required by