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: 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)
42 campaignVariants(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.
49 displays: [Display!]! 
50 
51 #   Required permission: Translation:read
52 # 
53 #   All elements are always returned
54 # 
55 # Arguments
56 #   where: (self-explanatory)
57 translations(where: TranslationFilter): [LanguageTranslation!]! 
58 
59 #   Required permission: ProductMedia:read
60 # 
61 #   All elements are always returned
62 media: [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)
75 prices(where: PriceFilter, sort: [PriceSort!] = [pricelistId_ASC], limit: Int, page: Int): [Price!]! 
76 
77 #   Required permission: Price:read
78 # 
79 #   Limit is optional
80 # 
81 #   Store restrictions apply.
82 # 
83 # Arguments
84 #   where: (self-explanatory)
85 #   sort: (self-explanatory)
86 #   limit: (self-explanatory)
87 #   page: (self-explanatory)
88 lowestPrices(where: LowestPriceFilter, sort: [LowestPriceSort!] = [pricelistId_ASC], limit: Int, page: Int): [LowestPrice!]! 
89 
90 #   Required permission: Product:read
91 product: Product! 
92 
93 #   Required permission: ProductSize:read
94 # 
95 #   All elements are always returned
96 # 
97 # Arguments
98 #   where: (self-explanatory)
99 productSizes(where: ProductSizeFilter): [ProductSize!]! 
100 
101 #   Required permission: SizeChart:read
102 sizeChart: SizeChart 
103 
104 #   Required permission: ProductVariant.stock:read
105 # 
106 #   Limit must be in range 1 - 200
107 # 
108 # Arguments
109 #   where: (self-explanatory)
110 #   sort: (self-explanatory)
111 #   limit: (self-explanatory)
112 #   page: (self-explanatory)
113 stock(where: StockFilter, sort: [StockSort!] = [warehouseId_ASC, productSizeSort_ASC], limit: Int = 20, page: Int = 1): [Stock!]! 
114 
115 #   Required permission: ProductVariant.stockTotals:read
116 # 
117 # Arguments
118 #   where: (self-explanatory)
119 stockTotals(where: StockTotalsFilter): StockTotals! 
120 
121 #   Required permission: SubscriptionPlan:read
122 # 
123 #   All elements are always returned
124 # 
125 #   Store restrictions apply.
126 # 
127 # Arguments
128 #   where: (self-explanatory)
129 #   sort: (self-explanatory)
130 availableInSubscriptionPlans(where: SubscriptionPlanFilter, sort: [SubscriptionPlanSort!] = [naturalSort_ASC, id_ASC]): [SubscriptionPlan!]! 
131 
132 externalId: String 
133 
134 #   Required permission: PurchaseOrderDelivery:read
135 # 
136 #   Limit must be in range 1 - 200
137 # 
138 # Arguments
139 #   where: (self-explanatory)
140 #   sort: (self-explanatory)
141 #   limit: (self-explanatory)
142 #   page: (self-explanatory)
143 purchaseOrderDeliveries(
144 where: PurchaseOrderDeliveryFilter,
145 sort: [PurchaseOrderDeliverySort!] = [id_DESC],
146 limit: Int = 20,
147 page: Int = 1
148 ): [PurchaseOrderDelivery!]! 
149 
150 #   Required permission: PurchaseOrder:read
151 # 
152 #   Limit must be in range 1 - 200
153 # 
154 # Arguments
155 #   where: (self-explanatory)
156 #   sort: (self-explanatory)
157 #   limit: (self-explanatory)
158 #   page: (self-explanatory)
159 purchaseOrders(where: PurchaseOrderFilter, sort: [PurchaseOrderSort!] = [id_DESC], limit: Int = 20, page: Int = 1): [PurchaseOrder!]! 
160 
161 #   Required permission: ProductVariantSupply:read
162 # 
163 #   Limit must be in range 1 - 200
164 # 
165 # Arguments
166 #   where: (self-explanatory)
167 #   sort: (self-explanatory)
168 #   limit: (self-explanatory)
169 #   page: (self-explanatory)
170 supply(where: ProductVariantSupplyFilter, sort: [ProductVariantSupplySort!] = [supplierName_ASC], limit: Int = 20, page: Int = 1): [ProductVariantSupply!]! 
171 
172 }

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: 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)
42	campaignVariants(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.
49	displays: [Display!]!
50
51	# Required permission: Translation:read
52	#
53	# All elements are always returned
54	#
55	# Arguments
56	# where: (self-explanatory)
57	translations(where: TranslationFilter): [LanguageTranslation!]!
58
59	# Required permission: ProductMedia:read
60	#
61	# All elements are always returned
62	media: [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)
75	prices(where: PriceFilter, sort: [PriceSort!] = [pricelistId_ASC], limit: Int, page: Int): [Price!]!
76
77	# Required permission: Price:read
78	#
79	# Limit is optional
80	#
81	# Store restrictions apply.
82	#
83	# Arguments
84	# where: (self-explanatory)
85	# sort: (self-explanatory)
86	# limit: (self-explanatory)
87	# page: (self-explanatory)
88	lowestPrices(where: LowestPriceFilter, sort: [LowestPriceSort!] = [pricelistId_ASC], limit: Int, page: Int): [LowestPrice!]!
89
90	# Required permission: Product:read
91	product: Product!
92
93	# Required permission: ProductSize:read
94	#
95	# All elements are always returned
96	#
97	# Arguments
98	# where: (self-explanatory)
99	productSizes(where: ProductSizeFilter): [ProductSize!]!
100
101	# Required permission: SizeChart:read
102	sizeChart: SizeChart
103
104	# Required permission: ProductVariant.stock:read
105	#
106	# Limit must be in range 1 - 200
107	#
108	# Arguments
109	# where: (self-explanatory)
110	# sort: (self-explanatory)
111	# limit: (self-explanatory)
112	# page: (self-explanatory)
113	stock(where: StockFilter, sort: [StockSort!] = [warehouseId_ASC, productSizeSort_ASC], limit: Int = 20, page: Int = 1): [Stock!]!
114
115	# Required permission: ProductVariant.stockTotals:read
116	#
117	# Arguments
118	# where: (self-explanatory)
119	stockTotals(where: StockTotalsFilter): StockTotals!
120
121	# Required permission: SubscriptionPlan:read
122	#
123	# All elements are always returned
124	#
125	# Store restrictions apply.
126	#
127	# Arguments
128	# where: (self-explanatory)
129	# sort: (self-explanatory)
130	availableInSubscriptionPlans(where: SubscriptionPlanFilter, sort: [SubscriptionPlanSort!] = [naturalSort_ASC, id_ASC]): [SubscriptionPlan!]!
131
132	externalId: String
133
134	# Required permission: PurchaseOrderDelivery:read
135	#
136	# Limit must be in range 1 - 200
137	#
138	# Arguments
139	# where: (self-explanatory)
140	# sort: (self-explanatory)
141	# limit: (self-explanatory)
142	# page: (self-explanatory)
143	purchaseOrderDeliveries(
144	where: PurchaseOrderDeliveryFilter,
145	sort: [PurchaseOrderDeliverySort!] = [id_DESC],
146	limit: Int = 20,
147	page: Int = 1
148	): [PurchaseOrderDelivery!]!
149
150	# Required permission: PurchaseOrder:read
151	#
152	# Limit must be in range 1 - 200
153	#
154	# Arguments
155	# where: (self-explanatory)
156	# sort: (self-explanatory)
157	# limit: (self-explanatory)
158	# page: (self-explanatory)
159	purchaseOrders(where: PurchaseOrderFilter, sort: [PurchaseOrderSort!] = [id_DESC], limit: Int = 20, page: Int = 1): [PurchaseOrder!]!
160
161	# Required permission: ProductVariantSupply:read
162	#
163	# Limit must be in range 1 - 200
164	#
165	# Arguments
166	# where: (self-explanatory)
167	# sort: (self-explanatory)
168	# limit: (self-explanatory)
169	# page: (self-explanatory)
170	supply(where: ProductVariantSupplyFilter, sort: [ProductVariantSupplySort!] = [supplierName_ASC], limit: Int = 20, page: Int = 1): [ProductVariantSupply!]!
171
172	}

ProductVariant

link GraphQL Schema definition

link Required by

GraphQL Schema definition

Required by