@salesforce/b2c-tooling-sdk 1.19.0 → 1.20.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (589) hide show
  1. package/data/help/index.json +9685 -0
  2. package/data/script-api/index.json +1 -528
  3. package/data/tooling/index.json +4 -4
  4. package/data/xsd/index.json +1 -1
  5. package/dist/esm/cli/base-command.js +5 -0
  6. package/dist/esm/cli/base-command.js.map +1 -1
  7. package/dist/esm/clients/index.d.ts +2 -0
  8. package/dist/esm/clients/index.js +1 -0
  9. package/dist/esm/clients/index.js.map +1 -1
  10. package/dist/esm/clients/middleware-registry.d.ts +1 -1
  11. package/dist/esm/clients/middleware-registry.js.map +1 -1
  12. package/dist/esm/clients/preferences.d.ts +83 -0
  13. package/dist/esm/clients/preferences.generated.d.ts +1651 -0
  14. package/dist/esm/clients/preferences.generated.js +6 -0
  15. package/dist/esm/clients/preferences.generated.js.map +1 -0
  16. package/dist/esm/clients/preferences.js +64 -0
  17. package/dist/esm/clients/preferences.js.map +1 -0
  18. package/dist/esm/config/dw-json.d.ts +2 -0
  19. package/dist/esm/config/dw-json.js.map +1 -1
  20. package/dist/esm/config/mapping.js +4 -0
  21. package/dist/esm/config/mapping.js.map +1 -1
  22. package/dist/esm/config/sources/dw-json-source.js +17 -4
  23. package/dist/esm/config/sources/dw-json-source.js.map +1 -1
  24. package/dist/esm/config/sources/env-source.js +2 -0
  25. package/dist/esm/config/sources/env-source.js.map +1 -1
  26. package/dist/esm/config/types.d.ts +14 -0
  27. package/dist/esm/discovery/detector.d.ts +1 -0
  28. package/dist/esm/discovery/detector.js +3 -1
  29. package/dist/esm/discovery/detector.js.map +1 -1
  30. package/dist/esm/discovery/index.d.ts +1 -1
  31. package/dist/esm/discovery/patterns/cartridges.js +4 -2
  32. package/dist/esm/discovery/patterns/cartridges.js.map +1 -1
  33. package/dist/esm/discovery/patterns/sfra.js +10 -5
  34. package/dist/esm/discovery/patterns/sfra.js.map +1 -1
  35. package/dist/esm/discovery/types.d.ts +20 -1
  36. package/dist/esm/docs/content-cache.d.ts +70 -0
  37. package/dist/esm/docs/content-cache.js +186 -0
  38. package/dist/esm/docs/content-cache.js.map +1 -0
  39. package/dist/esm/docs/index.d.ts +1 -0
  40. package/dist/esm/docs/index.js +2 -0
  41. package/dist/esm/docs/index.js.map +1 -1
  42. package/dist/esm/docs/search.js +34 -6
  43. package/dist/esm/docs/search.js.map +1 -1
  44. package/dist/esm/docs/types.d.ts +6 -1
  45. package/dist/esm/docs/types.js +1 -0
  46. package/dist/esm/docs/types.js.map +1 -1
  47. package/dist/esm/index.d.ts +2 -2
  48. package/dist/esm/index.js +1 -1
  49. package/dist/esm/index.js.map +1 -1
  50. package/dist/esm/operations/code/cartridges.d.ts +18 -0
  51. package/dist/esm/operations/code/cartridges.js +31 -20
  52. package/dist/esm/operations/code/cartridges.js.map +1 -1
  53. package/dist/esm/operations/jobs/discover.d.ts +46 -0
  54. package/dist/esm/operations/jobs/discover.js +87 -0
  55. package/dist/esm/operations/jobs/discover.js.map +1 -0
  56. package/dist/esm/operations/jobs/index.d.ts +2 -0
  57. package/dist/esm/operations/jobs/index.js +2 -0
  58. package/dist/esm/operations/jobs/index.js.map +1 -1
  59. package/dist/esm/operations/jobs/run.js +4 -3
  60. package/dist/esm/operations/jobs/run.js.map +1 -1
  61. package/package.json +5 -3
  62. package/specs/preferences-v1.yaml +2095 -0
  63. package/data/script-api/TopLevel.APIException.md +0 -119
  64. package/data/script-api/TopLevel.Array.md +0 -732
  65. package/data/script-api/TopLevel.ArrayBuffer.md +0 -97
  66. package/data/script-api/TopLevel.BigInt.md +0 -154
  67. package/data/script-api/TopLevel.Boolean.md +0 -83
  68. package/data/script-api/TopLevel.ConversionError.md +0 -51
  69. package/data/script-api/TopLevel.DataView.md +0 -271
  70. package/data/script-api/TopLevel.Date.md +0 -688
  71. package/data/script-api/TopLevel.ES6Iterator.md +0 -47
  72. package/data/script-api/TopLevel.Error.md +0 -124
  73. package/data/script-api/TopLevel.EvalError.md +0 -47
  74. package/data/script-api/TopLevel.Fault.md +0 -133
  75. package/data/script-api/TopLevel.Float32Array.md +0 -186
  76. package/data/script-api/TopLevel.Float64Array.md +0 -186
  77. package/data/script-api/TopLevel.Function.md +0 -114
  78. package/data/script-api/TopLevel.Generator.md +0 -132
  79. package/data/script-api/TopLevel.IOError.md +0 -98
  80. package/data/script-api/TopLevel.Int16Array.md +0 -186
  81. package/data/script-api/TopLevel.Int32Array.md +0 -186
  82. package/data/script-api/TopLevel.Int8Array.md +0 -186
  83. package/data/script-api/TopLevel.InternalError.md +0 -47
  84. package/data/script-api/TopLevel.Iterable.md +0 -44
  85. package/data/script-api/TopLevel.Iterator.md +0 -89
  86. package/data/script-api/TopLevel.JSON.md +0 -173
  87. package/data/script-api/TopLevel.Map.md +0 -189
  88. package/data/script-api/TopLevel.Math.md +0 -948
  89. package/data/script-api/TopLevel.Module.md +0 -152
  90. package/data/script-api/TopLevel.Namespace.md +0 -152
  91. package/data/script-api/TopLevel.Number.md +0 -404
  92. package/data/script-api/TopLevel.Object.md +0 -472
  93. package/data/script-api/TopLevel.QName.md +0 -147
  94. package/data/script-api/TopLevel.RangeError.md +0 -47
  95. package/data/script-api/TopLevel.ReferenceError.md +0 -47
  96. package/data/script-api/TopLevel.RegExp.md +0 -155
  97. package/data/script-api/TopLevel.Set.md +0 -150
  98. package/data/script-api/TopLevel.StopIteration.md +0 -36
  99. package/data/script-api/TopLevel.String.md +0 -1060
  100. package/data/script-api/TopLevel.Symbol.md +0 -196
  101. package/data/script-api/TopLevel.SyntaxError.md +0 -47
  102. package/data/script-api/TopLevel.SystemError.md +0 -99
  103. package/data/script-api/TopLevel.TypeError.md +0 -47
  104. package/data/script-api/TopLevel.URIError.md +0 -47
  105. package/data/script-api/TopLevel.Uint16Array.md +0 -186
  106. package/data/script-api/TopLevel.Uint32Array.md +0 -186
  107. package/data/script-api/TopLevel.Uint8Array.md +0 -186
  108. package/data/script-api/TopLevel.Uint8ClampedArray.md +0 -186
  109. package/data/script-api/TopLevel.WeakMap.md +0 -135
  110. package/data/script-api/TopLevel.WeakSet.md +0 -96
  111. package/data/script-api/TopLevel.XML.md +0 -922
  112. package/data/script-api/TopLevel.XMLList.md +0 -418
  113. package/data/script-api/TopLevel.XMLStreamError.md +0 -115
  114. package/data/script-api/TopLevel.arguments.md +0 -56
  115. package/data/script-api/TopLevel.global.md +0 -539
  116. package/data/script-api/TopLevel.md +0 -58
  117. package/data/script-api/dw.alert.Alert.md +0 -175
  118. package/data/script-api/dw.alert.Alerts.md +0 -256
  119. package/data/script-api/dw.alert.md +0 -7
  120. package/data/script-api/dw.campaign.ABTest.md +0 -63
  121. package/data/script-api/dw.campaign.ABTestMgr.md +0 -76
  122. package/data/script-api/dw.campaign.ABTestSegment.md +0 -107
  123. package/data/script-api/dw.campaign.AmountDiscount.md +0 -70
  124. package/data/script-api/dw.campaign.ApproachingDiscount.md +0 -157
  125. package/data/script-api/dw.campaign.BonusChoiceDiscount.md +0 -190
  126. package/data/script-api/dw.campaign.BonusDiscount.md +0 -59
  127. package/data/script-api/dw.campaign.Campaign.md +0 -346
  128. package/data/script-api/dw.campaign.CampaignMgr.md +0 -436
  129. package/data/script-api/dw.campaign.CampaignStatusCodes.md +0 -103
  130. package/data/script-api/dw.campaign.Coupon.md +0 -324
  131. package/data/script-api/dw.campaign.CouponMgr.md +0 -137
  132. package/data/script-api/dw.campaign.CouponRedemption.md +0 -87
  133. package/data/script-api/dw.campaign.CouponStatusCodes.md +0 -130
  134. package/data/script-api/dw.campaign.Discount.md +0 -271
  135. package/data/script-api/dw.campaign.DiscountPlan.md +0 -322
  136. package/data/script-api/dw.campaign.FixedPriceDiscount.md +0 -74
  137. package/data/script-api/dw.campaign.FixedPriceShippingDiscount.md +0 -74
  138. package/data/script-api/dw.campaign.FreeDiscount.md +0 -24
  139. package/data/script-api/dw.campaign.FreeShippingDiscount.md +0 -24
  140. package/data/script-api/dw.campaign.PercentageDiscount.md +0 -74
  141. package/data/script-api/dw.campaign.PercentageOptionDiscount.md +0 -59
  142. package/data/script-api/dw.campaign.PriceBookPriceDiscount.md +0 -56
  143. package/data/script-api/dw.campaign.Promotion.md +0 -939
  144. package/data/script-api/dw.campaign.PromotionMgr.md +0 -478
  145. package/data/script-api/dw.campaign.PromotionPlan.md +0 -378
  146. package/data/script-api/dw.campaign.SlotContent.md +0 -131
  147. package/data/script-api/dw.campaign.SourceCodeGroup.md +0 -83
  148. package/data/script-api/dw.campaign.SourceCodeInfo.md +0 -167
  149. package/data/script-api/dw.campaign.SourceCodeStatusCodes.md +0 -61
  150. package/data/script-api/dw.campaign.TotalFixedPriceDiscount.md +0 -56
  151. package/data/script-api/dw.campaign.md +0 -36
  152. package/data/script-api/dw.catalog.Catalog.md +0 -158
  153. package/data/script-api/dw.catalog.CatalogMgr.md +0 -161
  154. package/data/script-api/dw.catalog.Category.md +0 -1212
  155. package/data/script-api/dw.catalog.CategoryAssignment.md +0 -179
  156. package/data/script-api/dw.catalog.CategoryLink.md +0 -142
  157. package/data/script-api/dw.catalog.PriceBook.md +0 -215
  158. package/data/script-api/dw.catalog.PriceBookMgr.md +0 -176
  159. package/data/script-api/dw.catalog.Product.md +0 -2492
  160. package/data/script-api/dw.catalog.ProductActiveData.md +0 -1244
  161. package/data/script-api/dw.catalog.ProductAttributeModel.md +0 -409
  162. package/data/script-api/dw.catalog.ProductAvailabilityLevels.md +0 -125
  163. package/data/script-api/dw.catalog.ProductAvailabilityModel.md +0 -516
  164. package/data/script-api/dw.catalog.ProductInventoryList.md +0 -136
  165. package/data/script-api/dw.catalog.ProductInventoryMgr.md +0 -132
  166. package/data/script-api/dw.catalog.ProductInventoryRecord.md +0 -638
  167. package/data/script-api/dw.catalog.ProductLink.md +0 -166
  168. package/data/script-api/dw.catalog.ProductMgr.md +0 -136
  169. package/data/script-api/dw.catalog.ProductOption.md +0 -189
  170. package/data/script-api/dw.catalog.ProductOptionModel.md +0 -209
  171. package/data/script-api/dw.catalog.ProductOptionValue.md +0 -132
  172. package/data/script-api/dw.catalog.ProductPriceInfo.md +0 -170
  173. package/data/script-api/dw.catalog.ProductPriceModel.md +0 -988
  174. package/data/script-api/dw.catalog.ProductPriceTable.md +0 -121
  175. package/data/script-api/dw.catalog.ProductSearchHit.md +0 -702
  176. package/data/script-api/dw.catalog.ProductSearchModel.md +0 -1894
  177. package/data/script-api/dw.catalog.ProductSearchRefinementDefinition.md +0 -99
  178. package/data/script-api/dw.catalog.ProductSearchRefinementValue.md +0 -80
  179. package/data/script-api/dw.catalog.ProductSearchRefinements.md +0 -265
  180. package/data/script-api/dw.catalog.ProductVariationAttribute.md +0 -107
  181. package/data/script-api/dw.catalog.ProductVariationAttributeValue.md +0 -215
  182. package/data/script-api/dw.catalog.ProductVariationModel.md +0 -1010
  183. package/data/script-api/dw.catalog.Recommendation.md +0 -327
  184. package/data/script-api/dw.catalog.SearchModel.md +0 -769
  185. package/data/script-api/dw.catalog.SearchRefinementDefinition.md +0 -145
  186. package/data/script-api/dw.catalog.SearchRefinementValue.md +0 -194
  187. package/data/script-api/dw.catalog.SearchRefinements.md +0 -238
  188. package/data/script-api/dw.catalog.SortingOption.md +0 -120
  189. package/data/script-api/dw.catalog.SortingRule.md +0 -53
  190. package/data/script-api/dw.catalog.Store.md +0 -484
  191. package/data/script-api/dw.catalog.StoreGroup.md +0 -95
  192. package/data/script-api/dw.catalog.StoreInventoryFilter.md +0 -112
  193. package/data/script-api/dw.catalog.StoreInventoryFilterValue.md +0 -111
  194. package/data/script-api/dw.catalog.StoreMgr.md +0 -223
  195. package/data/script-api/dw.catalog.Variant.md +0 -1000
  196. package/data/script-api/dw.catalog.VariationGroup.md +0 -869
  197. package/data/script-api/dw.catalog.md +0 -50
  198. package/data/script-api/dw.content.Content.md +0 -481
  199. package/data/script-api/dw.content.ContentMgr.md +0 -147
  200. package/data/script-api/dw.content.ContentSearchModel.md +0 -618
  201. package/data/script-api/dw.content.ContentSearchRefinementDefinition.md +0 -61
  202. package/data/script-api/dw.content.ContentSearchRefinementValue.md +0 -22
  203. package/data/script-api/dw.content.ContentSearchRefinements.md +0 -218
  204. package/data/script-api/dw.content.Folder.md +0 -432
  205. package/data/script-api/dw.content.Library.md +0 -124
  206. package/data/script-api/dw.content.MarkupText.md +0 -150
  207. package/data/script-api/dw.content.MediaFile.md +0 -367
  208. package/data/script-api/dw.content.md +0 -15
  209. package/data/script-api/dw.crypto.CertificateRef.md +0 -59
  210. package/data/script-api/dw.crypto.CertificateUtils.md +0 -162
  211. package/data/script-api/dw.crypto.Cipher.md +0 -1234
  212. package/data/script-api/dw.crypto.Encoding.md +0 -193
  213. package/data/script-api/dw.crypto.JWE.md +0 -245
  214. package/data/script-api/dw.crypto.JWEHeader.md +0 -147
  215. package/data/script-api/dw.crypto.JWS.md +0 -260
  216. package/data/script-api/dw.crypto.JWSHeader.md +0 -128
  217. package/data/script-api/dw.crypto.KeyRef.md +0 -77
  218. package/data/script-api/dw.crypto.Mac.md +0 -191
  219. package/data/script-api/dw.crypto.MessageDigest.md +0 -243
  220. package/data/script-api/dw.crypto.SecureRandom.md +0 -161
  221. package/data/script-api/dw.crypto.Signature.md +0 -241
  222. package/data/script-api/dw.crypto.WeakCipher.md +0 -725
  223. package/data/script-api/dw.crypto.WeakMac.md +0 -163
  224. package/data/script-api/dw.crypto.WeakMessageDigest.md +0 -220
  225. package/data/script-api/dw.crypto.WeakSignature.md +0 -208
  226. package/data/script-api/dw.crypto.X509Certificate.md +0 -180
  227. package/data/script-api/dw.crypto.md +0 -23
  228. package/data/script-api/dw.customer.AddressBook.md +0 -158
  229. package/data/script-api/dw.customer.AgentUserMgr.md +0 -94
  230. package/data/script-api/dw.customer.AgentUserStatusCodes.md +0 -164
  231. package/data/script-api/dw.customer.AuthenticationStatus.md +0 -157
  232. package/data/script-api/dw.customer.Credentials.md +0 -524
  233. package/data/script-api/dw.customer.Customer.md +0 -488
  234. package/data/script-api/dw.customer.CustomerActiveData.md +0 -563
  235. package/data/script-api/dw.customer.CustomerAddress.md +0 -666
  236. package/data/script-api/dw.customer.CustomerCDPData.md +0 -70
  237. package/data/script-api/dw.customer.CustomerContextMgr.md +0 -62
  238. package/data/script-api/dw.customer.CustomerGroup.md +0 -146
  239. package/data/script-api/dw.customer.CustomerList.md +0 -76
  240. package/data/script-api/dw.customer.CustomerMgr.md +0 -1046
  241. package/data/script-api/dw.customer.CustomerPasswordConstraints.md +0 -125
  242. package/data/script-api/dw.customer.CustomerPaymentInstrument.md +0 -161
  243. package/data/script-api/dw.customer.CustomerStatusCodes.md +0 -55
  244. package/data/script-api/dw.customer.EncryptedObject.md +0 -34
  245. package/data/script-api/dw.customer.ExternalProfile.md +0 -154
  246. package/data/script-api/dw.customer.OrderHistory.md +0 -167
  247. package/data/script-api/dw.customer.ProductList.md +0 -870
  248. package/data/script-api/dw.customer.ProductListItem.md +0 -469
  249. package/data/script-api/dw.customer.ProductListItemPurchase.md +0 -139
  250. package/data/script-api/dw.customer.ProductListMgr.md +0 -350
  251. package/data/script-api/dw.customer.ProductListRegistrant.md +0 -165
  252. package/data/script-api/dw.customer.Profile.md +0 -940
  253. package/data/script-api/dw.customer.Wallet.md +0 -136
  254. package/data/script-api/dw.customer.consent.ConsentStatusEntry.md +0 -92
  255. package/data/script-api/dw.customer.consent.MarketingConsentSubscription.md +0 -247
  256. package/data/script-api/dw.customer.consent.ShopperConsentErrorCodes.md +0 -74
  257. package/data/script-api/dw.customer.consent.ShopperConsentException.md +0 -63
  258. package/data/script-api/dw.customer.consent.ShopperConsentMgr.md +0 -152
  259. package/data/script-api/dw.customer.consent.md +0 -10
  260. package/data/script-api/dw.customer.md +0 -31
  261. package/data/script-api/dw.customer.oauth.OAuthAccessTokenResponse.md +0 -171
  262. package/data/script-api/dw.customer.oauth.OAuthFinalizedResponse.md +0 -75
  263. package/data/script-api/dw.customer.oauth.OAuthLoginFlowMgr.md +0 -165
  264. package/data/script-api/dw.customer.oauth.OAuthUserInfoResponse.md +0 -84
  265. package/data/script-api/dw.customer.oauth.md +0 -9
  266. package/data/script-api/dw.customer.shoppercontext.ShopperContext.md +0 -369
  267. package/data/script-api/dw.customer.shoppercontext.ShopperContextErrorCodes.md +0 -111
  268. package/data/script-api/dw.customer.shoppercontext.ShopperContextException.md +0 -77
  269. package/data/script-api/dw.customer.shoppercontext.ShopperContextMgr.md +0 -209
  270. package/data/script-api/dw.customer.shoppercontext.md +0 -9
  271. package/data/script-api/dw.experience.AspectAttributeValidationException.md +0 -25
  272. package/data/script-api/dw.experience.Component.md +0 -166
  273. package/data/script-api/dw.experience.ComponentRenderSettings.md +0 -130
  274. package/data/script-api/dw.experience.ComponentScriptContext.md +0 -148
  275. package/data/script-api/dw.experience.CustomEditor.md +0 -146
  276. package/data/script-api/dw.experience.CustomEditorResources.md +0 -100
  277. package/data/script-api/dw.experience.Page.md +0 -467
  278. package/data/script-api/dw.experience.PageMgr.md +0 -549
  279. package/data/script-api/dw.experience.PageScriptContext.md +0 -200
  280. package/data/script-api/dw.experience.Region.md +0 -119
  281. package/data/script-api/dw.experience.RegionRenderSettings.md +0 -207
  282. package/data/script-api/dw.experience.cms.CMSRecord.md +0 -125
  283. package/data/script-api/dw.experience.cms.md +0 -6
  284. package/data/script-api/dw.experience.image.FocalPoint.md +0 -71
  285. package/data/script-api/dw.experience.image.Image.md +0 -101
  286. package/data/script-api/dw.experience.image.ImageMetaData.md +0 -71
  287. package/data/script-api/dw.experience.image.md +0 -8
  288. package/data/script-api/dw.experience.md +0 -16
  289. package/data/script-api/dw.extensions.applepay.ApplePayHookResult.md +0 -254
  290. package/data/script-api/dw.extensions.applepay.ApplePayHooks.md +0 -572
  291. package/data/script-api/dw.extensions.applepay.md +0 -7
  292. package/data/script-api/dw.extensions.facebook.FacebookFeedHooks.md +0 -102
  293. package/data/script-api/dw.extensions.facebook.FacebookProduct.md +0 -1343
  294. package/data/script-api/dw.extensions.facebook.md +0 -7
  295. package/data/script-api/dw.extensions.paymentapi.PaymentApiHooks.md +0 -136
  296. package/data/script-api/dw.extensions.paymentapi.md +0 -6
  297. package/data/script-api/dw.extensions.paymentrequest.PaymentRequestHookResult.md +0 -149
  298. package/data/script-api/dw.extensions.paymentrequest.PaymentRequestHooks.md +0 -356
  299. package/data/script-api/dw.extensions.paymentrequest.md +0 -7
  300. package/data/script-api/dw.extensions.payments.SalesforceAdyenPaymentIntent.md +0 -134
  301. package/data/script-api/dw.extensions.payments.SalesforceAdyenSavedPaymentMethod.md +0 -283
  302. package/data/script-api/dw.extensions.payments.SalesforceBancontactPaymentDetails.md +0 -88
  303. package/data/script-api/dw.extensions.payments.SalesforceCardPaymentDetails.md +0 -107
  304. package/data/script-api/dw.extensions.payments.SalesforceEpsPaymentDetails.md +0 -63
  305. package/data/script-api/dw.extensions.payments.SalesforceIdealPaymentDetails.md +0 -63
  306. package/data/script-api/dw.extensions.payments.SalesforceKlarnaPaymentDetails.md +0 -63
  307. package/data/script-api/dw.extensions.payments.SalesforcePayPalOrder.md +0 -263
  308. package/data/script-api/dw.extensions.payments.SalesforcePayPalOrderAddress.md +0 -171
  309. package/data/script-api/dw.extensions.payments.SalesforcePayPalOrderPayer.md +0 -110
  310. package/data/script-api/dw.extensions.payments.SalesforcePayPalPaymentDetails.md +0 -88
  311. package/data/script-api/dw.extensions.payments.SalesforcePaymentDetails.md +0 -83
  312. package/data/script-api/dw.extensions.payments.SalesforcePaymentIntent.md +0 -273
  313. package/data/script-api/dw.extensions.payments.SalesforcePaymentMethod.md +0 -368
  314. package/data/script-api/dw.extensions.payments.SalesforcePaymentRequest.md +0 -1077
  315. package/data/script-api/dw.extensions.payments.SalesforcePaymentsHooks.md +0 -190
  316. package/data/script-api/dw.extensions.payments.SalesforcePaymentsMerchantAccount.md +0 -151
  317. package/data/script-api/dw.extensions.payments.SalesforcePaymentsMerchantAccountPaymentMethod.md +0 -98
  318. package/data/script-api/dw.extensions.payments.SalesforcePaymentsMgr.md +0 -989
  319. package/data/script-api/dw.extensions.payments.SalesforcePaymentsSiteConfiguration.md +0 -202
  320. package/data/script-api/dw.extensions.payments.SalesforcePaymentsZone.md +0 -393
  321. package/data/script-api/dw.extensions.payments.SalesforceSepaDebitPaymentDetails.md +0 -63
  322. package/data/script-api/dw.extensions.payments.SalesforceVenmoPaymentDetails.md +0 -88
  323. package/data/script-api/dw.extensions.payments.md +0 -28
  324. package/data/script-api/dw.extensions.pinterest.PinterestAvailability.md +0 -85
  325. package/data/script-api/dw.extensions.pinterest.PinterestFeedHooks.md +0 -118
  326. package/data/script-api/dw.extensions.pinterest.PinterestOrder.md +0 -263
  327. package/data/script-api/dw.extensions.pinterest.PinterestOrderHooks.md +0 -89
  328. package/data/script-api/dw.extensions.pinterest.PinterestProduct.md +0 -677
  329. package/data/script-api/dw.extensions.pinterest.md +0 -10
  330. package/data/script-api/dw.io.CSVStreamReader.md +0 -128
  331. package/data/script-api/dw.io.CSVStreamWriter.md +0 -92
  332. package/data/script-api/dw.io.File.md +0 -729
  333. package/data/script-api/dw.io.FileReader.md +0 -70
  334. package/data/script-api/dw.io.FileWriter.md +0 -159
  335. package/data/script-api/dw.io.InputStream.md +0 -35
  336. package/data/script-api/dw.io.OutputStream.md +0 -38
  337. package/data/script-api/dw.io.PrintWriter.md +0 -66
  338. package/data/script-api/dw.io.RandomAccessFileReader.md +0 -183
  339. package/data/script-api/dw.io.Reader.md +0 -284
  340. package/data/script-api/dw.io.StringWriter.md +0 -89
  341. package/data/script-api/dw.io.Writer.md +0 -96
  342. package/data/script-api/dw.io.XMLIndentingStreamWriter.md +0 -121
  343. package/data/script-api/dw.io.XMLStreamConstants.md +0 -172
  344. package/data/script-api/dw.io.XMLStreamReader.md +0 -1181
  345. package/data/script-api/dw.io.XMLStreamWriter.md +0 -478
  346. package/data/script-api/dw.io.md +0 -21
  347. package/data/script-api/dw.job.JobExecution.md +0 -111
  348. package/data/script-api/dw.job.JobStepExecution.md +0 -136
  349. package/data/script-api/dw.job.md +0 -7
  350. package/data/script-api/dw.net.FTPClient.md +0 -621
  351. package/data/script-api/dw.net.FTPFileInfo.md +0 -132
  352. package/data/script-api/dw.net.HTTPClient.md +0 -775
  353. package/data/script-api/dw.net.HTTPClientLoggingConfig.md +0 -363
  354. package/data/script-api/dw.net.HTTPRequestPart.md +0 -296
  355. package/data/script-api/dw.net.Mail.md +0 -487
  356. package/data/script-api/dw.net.SFTPClient.md +0 -535
  357. package/data/script-api/dw.net.SFTPFileInfo.md +0 -128
  358. package/data/script-api/dw.net.WebDAVClient.md +0 -762
  359. package/data/script-api/dw.net.WebDAVFileInfo.md +0 -163
  360. package/data/script-api/dw.net.md +0 -15
  361. package/data/script-api/dw.object.ActiveData.md +0 -86
  362. package/data/script-api/dw.object.CustomAttributes.md +0 -165
  363. package/data/script-api/dw.object.CustomObject.md +0 -82
  364. package/data/script-api/dw.object.CustomObjectMgr.md +0 -478
  365. package/data/script-api/dw.object.Extensible.md +0 -71
  366. package/data/script-api/dw.object.ExtensibleObject.md +0 -85
  367. package/data/script-api/dw.object.Note.md +0 -118
  368. package/data/script-api/dw.object.ObjectAttributeDefinition.md +0 -542
  369. package/data/script-api/dw.object.ObjectAttributeGroup.md +0 -160
  370. package/data/script-api/dw.object.ObjectAttributeValueDefinition.md +0 -78
  371. package/data/script-api/dw.object.ObjectTypeDefinition.md +0 -239
  372. package/data/script-api/dw.object.PersistentObject.md +0 -92
  373. package/data/script-api/dw.object.SimpleExtensible.md +0 -53
  374. package/data/script-api/dw.object.SystemObjectMgr.md +0 -520
  375. package/data/script-api/dw.object.md +0 -19
  376. package/data/script-api/dw.order.AbstractItem.md +0 -220
  377. package/data/script-api/dw.order.AbstractItemCtnr.md +0 -219
  378. package/data/script-api/dw.order.Appeasement.md +0 -398
  379. package/data/script-api/dw.order.AppeasementItem.md +0 -104
  380. package/data/script-api/dw.order.Basket.md +0 -868
  381. package/data/script-api/dw.order.BasketMgr.md +0 -673
  382. package/data/script-api/dw.order.BonusDiscountLineItem.md +0 -309
  383. package/data/script-api/dw.order.CouponLineItem.md +0 -289
  384. package/data/script-api/dw.order.CreateAgentBasketLimitExceededException.md +0 -35
  385. package/data/script-api/dw.order.CreateBasketFromOrderException.md +0 -54
  386. package/data/script-api/dw.order.CreateCouponLineItemException.md +0 -67
  387. package/data/script-api/dw.order.CreateOrderException.md +0 -23
  388. package/data/script-api/dw.order.CreateTemporaryBasketLimitExceededException.md +0 -35
  389. package/data/script-api/dw.order.GiftCertificate.md +0 -530
  390. package/data/script-api/dw.order.GiftCertificateLineItem.md +0 -292
  391. package/data/script-api/dw.order.GiftCertificateMgr.md +0 -228
  392. package/data/script-api/dw.order.GiftCertificateStatusCodes.md +0 -108
  393. package/data/script-api/dw.order.Invoice.md +0 -571
  394. package/data/script-api/dw.order.InvoiceItem.md +0 -199
  395. package/data/script-api/dw.order.LineItem.md +0 -577
  396. package/data/script-api/dw.order.LineItemCtnr.md +0 -2429
  397. package/data/script-api/dw.order.LineItemTax.md +0 -142
  398. package/data/script-api/dw.order.Order.md +0 -2770
  399. package/data/script-api/dw.order.OrderAddress.md +0 -624
  400. package/data/script-api/dw.order.OrderItem.md +0 -613
  401. package/data/script-api/dw.order.OrderMgr.md +0 -1502
  402. package/data/script-api/dw.order.OrderPaymentInstrument.md +0 -231
  403. package/data/script-api/dw.order.OrderProcessStatusCodes.md +0 -146
  404. package/data/script-api/dw.order.PaymentCard.md +0 -220
  405. package/data/script-api/dw.order.PaymentInstrument.md +0 -1416
  406. package/data/script-api/dw.order.PaymentMethod.md +0 -257
  407. package/data/script-api/dw.order.PaymentMgr.md +0 -138
  408. package/data/script-api/dw.order.PaymentProcessor.md +0 -106
  409. package/data/script-api/dw.order.PaymentStatusCodes.md +0 -70
  410. package/data/script-api/dw.order.PaymentTransaction.md +0 -291
  411. package/data/script-api/dw.order.PriceAdjustment.md +0 -745
  412. package/data/script-api/dw.order.PriceAdjustmentLimitTypes.md +0 -61
  413. package/data/script-api/dw.order.ProductLineItem.md +0 -1749
  414. package/data/script-api/dw.order.ProductShippingCost.md +0 -101
  415. package/data/script-api/dw.order.ProductShippingLineItem.md +0 -336
  416. package/data/script-api/dw.order.ProductShippingModel.md +0 -143
  417. package/data/script-api/dw.order.Return.md +0 -396
  418. package/data/script-api/dw.order.ReturnCase.md +0 -463
  419. package/data/script-api/dw.order.ReturnCaseItem.md +0 -372
  420. package/data/script-api/dw.order.ReturnItem.md +0 -335
  421. package/data/script-api/dw.order.Shipment.md +0 -1132
  422. package/data/script-api/dw.order.ShipmentShippingCost.md +0 -54
  423. package/data/script-api/dw.order.ShipmentShippingModel.md +0 -203
  424. package/data/script-api/dw.order.ShippingLineItem.md +0 -315
  425. package/data/script-api/dw.order.ShippingLocation.md +0 -313
  426. package/data/script-api/dw.order.ShippingMethod.md +0 -251
  427. package/data/script-api/dw.order.ShippingMgr.md +0 -173
  428. package/data/script-api/dw.order.ShippingOrder.md +0 -630
  429. package/data/script-api/dw.order.ShippingOrderItem.md +0 -425
  430. package/data/script-api/dw.order.SumItem.md +0 -158
  431. package/data/script-api/dw.order.TaxGroup.md +0 -128
  432. package/data/script-api/dw.order.TaxItem.md +0 -74
  433. package/data/script-api/dw.order.TaxMgr.md +0 -314
  434. package/data/script-api/dw.order.TrackingInfo.md +0 -261
  435. package/data/script-api/dw.order.TrackingRef.md +0 -108
  436. package/data/script-api/dw.order.hooks.BasketMergeHooks.md +0 -87
  437. package/data/script-api/dw.order.hooks.CalculateHooks.md +0 -139
  438. package/data/script-api/dw.order.hooks.CheckoutHooks.md +0 -88
  439. package/data/script-api/dw.order.hooks.OrderHooks.md +0 -96
  440. package/data/script-api/dw.order.hooks.PaymentHooks.md +0 -325
  441. package/data/script-api/dw.order.hooks.ReturnHooks.md +0 -395
  442. package/data/script-api/dw.order.hooks.ShippingOrderHooks.md +0 -426
  443. package/data/script-api/dw.order.hooks.TaxHooks.md +0 -495
  444. package/data/script-api/dw.order.hooks.md +0 -13
  445. package/data/script-api/dw.order.md +0 -65
  446. package/data/script-api/dw.rpc.SOAPUtil.md +0 -736
  447. package/data/script-api/dw.rpc.Stub.md +0 -373
  448. package/data/script-api/dw.rpc.WebReference.md +0 -133
  449. package/data/script-api/dw.rpc.md +0 -8
  450. package/data/script-api/dw.sitemap.SitemapFile.md +0 -137
  451. package/data/script-api/dw.sitemap.SitemapMgr.md +0 -165
  452. package/data/script-api/dw.sitemap.md +0 -7
  453. package/data/script-api/dw.suggest.BrandSuggestions.md +0 -34
  454. package/data/script-api/dw.suggest.CategorySuggestions.md +0 -76
  455. package/data/script-api/dw.suggest.ContentSuggestions.md +0 -76
  456. package/data/script-api/dw.suggest.CustomSuggestions.md +0 -34
  457. package/data/script-api/dw.suggest.ProductSuggestions.md +0 -76
  458. package/data/script-api/dw.suggest.SearchPhraseSuggestions.md +0 -126
  459. package/data/script-api/dw.suggest.SuggestModel.md +0 -471
  460. package/data/script-api/dw.suggest.SuggestedCategory.md +0 -51
  461. package/data/script-api/dw.suggest.SuggestedContent.md +0 -51
  462. package/data/script-api/dw.suggest.SuggestedPhrase.md +0 -70
  463. package/data/script-api/dw.suggest.SuggestedProduct.md +0 -55
  464. package/data/script-api/dw.suggest.SuggestedTerm.md +0 -143
  465. package/data/script-api/dw.suggest.SuggestedTerms.md +0 -144
  466. package/data/script-api/dw.suggest.Suggestions.md +0 -206
  467. package/data/script-api/dw.suggest.md +0 -19
  468. package/data/script-api/dw.svc.FTPService.md +0 -140
  469. package/data/script-api/dw.svc.FTPServiceDefinition.md +0 -97
  470. package/data/script-api/dw.svc.HTTPFormService.md +0 -32
  471. package/data/script-api/dw.svc.HTTPFormServiceDefinition.md +0 -36
  472. package/data/script-api/dw.svc.HTTPService.md +0 -370
  473. package/data/script-api/dw.svc.HTTPServiceDefinition.md +0 -290
  474. package/data/script-api/dw.svc.LocalServiceRegistry.md +0 -63
  475. package/data/script-api/dw.svc.Result.md +0 -320
  476. package/data/script-api/dw.svc.SOAPService.md +0 -104
  477. package/data/script-api/dw.svc.SOAPServiceDefinition.md +0 -32
  478. package/data/script-api/dw.svc.Service.md +0 -276
  479. package/data/script-api/dw.svc.ServiceCallback.md +0 -282
  480. package/data/script-api/dw.svc.ServiceConfig.md +0 -114
  481. package/data/script-api/dw.svc.ServiceCredential.md +0 -162
  482. package/data/script-api/dw.svc.ServiceDefinition.md +0 -211
  483. package/data/script-api/dw.svc.ServiceProfile.md +0 -152
  484. package/data/script-api/dw.svc.ServiceRegistry.md +0 -118
  485. package/data/script-api/dw.svc.md +0 -22
  486. package/data/script-api/dw.system.AgentUserStatusCodes.md +0 -41
  487. package/data/script-api/dw.system.Cache.md +0 -126
  488. package/data/script-api/dw.system.CacheMgr.md +0 -70
  489. package/data/script-api/dw.system.HookMgr.md +0 -78
  490. package/data/script-api/dw.system.InternalObject.md +0 -47
  491. package/data/script-api/dw.system.JobProcessMonitor.md +0 -103
  492. package/data/script-api/dw.system.Log.md +0 -198
  493. package/data/script-api/dw.system.LogNDC.md +0 -75
  494. package/data/script-api/dw.system.Logger.md +0 -216
  495. package/data/script-api/dw.system.OrganizationPreferences.md +0 -53
  496. package/data/script-api/dw.system.Pipeline.md +0 -94
  497. package/data/script-api/dw.system.PipelineDictionary.md +0 -42
  498. package/data/script-api/dw.system.RESTErrorResponse.md +0 -102
  499. package/data/script-api/dw.system.RESTResponseMgr.md +0 -243
  500. package/data/script-api/dw.system.RESTSuccessResponse.md +0 -62
  501. package/data/script-api/dw.system.RemoteInclude.md +0 -146
  502. package/data/script-api/dw.system.Request.md +0 -785
  503. package/data/script-api/dw.system.RequestHooks.md +0 -112
  504. package/data/script-api/dw.system.Response.md +0 -612
  505. package/data/script-api/dw.system.SearchStatus.md +0 -187
  506. package/data/script-api/dw.system.Session.md +0 -469
  507. package/data/script-api/dw.system.Site.md +0 -570
  508. package/data/script-api/dw.system.SitePreferences.md +0 -90
  509. package/data/script-api/dw.system.Status.md +0 -330
  510. package/data/script-api/dw.system.StatusItem.md +0 -273
  511. package/data/script-api/dw.system.System.md +0 -224
  512. package/data/script-api/dw.system.Transaction.md +0 -107
  513. package/data/script-api/dw.system.md +0 -32
  514. package/data/script-api/dw.template.ISML.md +0 -127
  515. package/data/script-api/dw.template.Velocity.md +0 -168
  516. package/data/script-api/dw.template.md +0 -7
  517. package/data/script-api/dw.util.ArrayList.md +0 -99
  518. package/data/script-api/dw.util.Assert.md +0 -370
  519. package/data/script-api/dw.util.BigInteger.md +0 -283
  520. package/data/script-api/dw.util.Bytes.md +0 -278
  521. package/data/script-api/dw.util.Calendar.md +0 -1051
  522. package/data/script-api/dw.util.Collection.md +0 -272
  523. package/data/script-api/dw.util.Currency.md +0 -147
  524. package/data/script-api/dw.util.DateUtils.md +0 -82
  525. package/data/script-api/dw.util.Decimal.md +0 -386
  526. package/data/script-api/dw.util.FilteringCollection.md +0 -140
  527. package/data/script-api/dw.util.Geolocation.md +0 -293
  528. package/data/script-api/dw.util.HashMap.md +0 -50
  529. package/data/script-api/dw.util.HashSet.md +0 -65
  530. package/data/script-api/dw.util.Iterator.md +0 -86
  531. package/data/script-api/dw.util.LinkedHashMap.md +0 -52
  532. package/data/script-api/dw.util.LinkedHashSet.md +0 -68
  533. package/data/script-api/dw.util.List.md +0 -429
  534. package/data/script-api/dw.util.Locale.md +0 -277
  535. package/data/script-api/dw.util.Map.md +0 -251
  536. package/data/script-api/dw.util.MapEntry.md +0 -68
  537. package/data/script-api/dw.util.MappingKey.md +0 -96
  538. package/data/script-api/dw.util.MappingMgr.md +0 -113
  539. package/data/script-api/dw.util.PropertyComparator.md +0 -122
  540. package/data/script-api/dw.util.SecureEncoder.md +0 -582
  541. package/data/script-api/dw.util.SecureFilter.md +0 -572
  542. package/data/script-api/dw.util.SeekableIterator.md +0 -187
  543. package/data/script-api/dw.util.Set.md +0 -39
  544. package/data/script-api/dw.util.SortedMap.md +0 -148
  545. package/data/script-api/dw.util.SortedSet.md +0 -173
  546. package/data/script-api/dw.util.StringUtils.md +0 -655
  547. package/data/script-api/dw.util.Template.md +0 -141
  548. package/data/script-api/dw.util.UUIDUtils.md +0 -34
  549. package/data/script-api/dw.util.md +0 -37
  550. package/data/script-api/dw.value.EnumValue.md +0 -105
  551. package/data/script-api/dw.value.MimeEncodedText.md +0 -131
  552. package/data/script-api/dw.value.Money.md +0 -526
  553. package/data/script-api/dw.value.Quantity.md +0 -299
  554. package/data/script-api/dw.value.md +0 -9
  555. package/data/script-api/dw.web.CSRFProtection.md +0 -105
  556. package/data/script-api/dw.web.ClickStream.md +0 -177
  557. package/data/script-api/dw.web.ClickStreamEntry.md +0 -255
  558. package/data/script-api/dw.web.Cookie.md +0 -431
  559. package/data/script-api/dw.web.Cookies.md +0 -59
  560. package/data/script-api/dw.web.Form.md +0 -84
  561. package/data/script-api/dw.web.FormAction.md +0 -195
  562. package/data/script-api/dw.web.FormElement.md +0 -211
  563. package/data/script-api/dw.web.FormElementValidationResult.md +0 -170
  564. package/data/script-api/dw.web.FormField.md +0 -642
  565. package/data/script-api/dw.web.FormFieldOption.md +0 -211
  566. package/data/script-api/dw.web.FormFieldOptions.md +0 -49
  567. package/data/script-api/dw.web.FormGroup.md +0 -222
  568. package/data/script-api/dw.web.FormList.md +0 -134
  569. package/data/script-api/dw.web.FormListItem.md +0 -57
  570. package/data/script-api/dw.web.Forms.md +0 -25
  571. package/data/script-api/dw.web.HttpParameter.md +0 -462
  572. package/data/script-api/dw.web.HttpParameterMap.md +0 -194
  573. package/data/script-api/dw.web.LoopIterator.md +0 -231
  574. package/data/script-api/dw.web.PageMetaData.md +0 -197
  575. package/data/script-api/dw.web.PageMetaTag.md +0 -173
  576. package/data/script-api/dw.web.PagingModel.md +0 -407
  577. package/data/script-api/dw.web.Resource.md +0 -147
  578. package/data/script-api/dw.web.URL.md +0 -174
  579. package/data/script-api/dw.web.URLAction.md +0 -95
  580. package/data/script-api/dw.web.URLParameter.md +0 -52
  581. package/data/script-api/dw.web.URLRedirect.md +0 -72
  582. package/data/script-api/dw.web.URLRedirectMgr.md +0 -86
  583. package/data/script-api/dw.web.URLUtils.md +0 -1357
  584. package/data/script-api/dw.web.md +0 -34
  585. package/data/script-api/dw.ws.Port.md +0 -126
  586. package/data/script-api/dw.ws.WSUtil.md +0 -728
  587. package/data/script-api/dw.ws.WebReference2.md +0 -137
  588. package/data/script-api/dw.ws.md +0 -8
  589. package/data/script-api/index.md +0 -40
@@ -1,869 +0,0 @@
1
- <!-- prettier-ignore-start -->
2
- # Class VariationGroup
3
-
4
- - [TopLevel.Object](TopLevel.Object.md)
5
- - [dw.object.PersistentObject](dw.object.PersistentObject.md)
6
- - [dw.object.ExtensibleObject](dw.object.ExtensibleObject.md)
7
- - [dw.catalog.Product](dw.catalog.Product.md)
8
- - [dw.catalog.VariationGroup](dw.catalog.VariationGroup.md)
9
-
10
- Class representing a group of variants within a master product who share a
11
- common value for one or more variation attribute values. Variation groups are
12
- used to simplify merchandising of products.
13
-
14
-
15
- From a more technical perspective, variation groups are defined by two things:
16
-
17
-
18
- - A relation to a master product.
19
- - A set of variation attributes which have fixed values.
20
-
21
- A variant of the related master product is considered in the group if and
22
- only if it matches on the fixed variation attribute values.
23
-
24
-
25
- Similar to a Variant, a VariationGroup does a fallback to the master product
26
- for all attributes (name, description, etc) and relations (recommendations,
27
- etc).
28
-
29
-
30
-
31
- ## Property Summary
32
-
33
- | Property | Description |
34
- | --- | --- |
35
- | [EAN](#ean): [String](TopLevel.String.md) `(read-only)` | Returns the EAN of the product variation group. |
36
- | [UPC](#upc): [String](TopLevel.String.md) `(read-only)` | Returns the UPC of the product variation group. |
37
- | [allProductLinks](#allproductlinks): [Collection](dw.util.Collection.md) `(read-only)` | Returns all product links of the product variation group. |
38
- | [brand](#brand): [String](TopLevel.String.md) `(read-only)` | Returns the brand of the product variation group. |
39
- | [classificationCategory](#classificationcategory): [Category](dw.catalog.Category.md) `(read-only)` | Returns the classification category of the product variation group. |
40
- | [custom](#custom): [CustomAttributes](dw.object.CustomAttributes.md) `(read-only)` | Returns the custom attributes of the variation group. |
41
- | [image](#image): [MediaFile](dw.content.MediaFile.md) `(read-only)` | Returns the image of the product variation group. |
42
- | [longDescription](#longdescription): [MarkupText](dw.content.MarkupText.md) `(read-only)` | Returns the long description of the product variation group. |
43
- | [manufacturerName](#manufacturername): [String](TopLevel.String.md) `(read-only)` | Returns the manufacturer name of the product variation group. |
44
- | [manufacturerSKU](#manufacturersku): [String](TopLevel.String.md) `(read-only)` | Returns the manufacturer sku of the product variation group. |
45
- | [masterProduct](#masterproduct): [Product](dw.catalog.Product.md) `(read-only)` | Returns the ProductMaster for this mastered product. |
46
- | [name](#name): [String](TopLevel.String.md) `(read-only)` | Returns the name of the product variation group. |
47
- | [onlineFrom](#onlinefrom): [Date](TopLevel.Date.md) `(read-only)` | Returns the onlineFrom date of the product variation group. |
48
- | [onlineTo](#onlineto): [Date](TopLevel.Date.md) `(read-only)` | Returns the onlineTo date of the product variation group. |
49
- | [optionProduct](#optionproduct): [Boolean](TopLevel.Boolean.md) `(read-only)` | Returns 'true' if the variation group has any options, otherwise 'false'. |
50
- | [pageDescription](#pagedescription): [String](TopLevel.String.md) `(read-only)` | Returns the pageDescription of the product variation group. |
51
- | [pageKeywords](#pagekeywords): [String](TopLevel.String.md) `(read-only)` | Returns the pageKeywords of the product variation group. |
52
- | [pageTitle](#pagetitle): [String](TopLevel.String.md) `(read-only)` | Returns the pageTitle of the product variation group. |
53
- | [pageURL](#pageurl): [String](TopLevel.String.md) `(read-only)` | Returns the pageURL of the product variation group. |
54
- | [productLinks](#productlinks): [Collection](dw.util.Collection.md) `(read-only)` | Returns all product links of the product variation group for which the target product is assigned to the current site catalog. |
55
- | [shortDescription](#shortdescription): [MarkupText](dw.content.MarkupText.md) `(read-only)` | Returns the short description of the product variation group. |
56
- | [taxClassID](#taxclassid): [String](TopLevel.String.md) `(read-only)` | Returns the tax class id of the product variation group. |
57
- | [template](#template): [String](TopLevel.String.md) `(read-only)` | Returns the rendering template name of the product variation group. |
58
- | [thumbnail](#thumbnail): [MediaFile](dw.content.MediaFile.md) `(read-only)` | Returns the thumbnail image of the product variation group. |
59
- | [unit](#unit): [String](TopLevel.String.md) `(read-only)` | Returns the sales unit of the product variation group as defined by the master product. |
60
- | [unitQuantity](#unitquantity): [Quantity](dw.value.Quantity.md) `(read-only)` | Returns the unitQuantity of the product variation group as defined by the master product. |
61
-
62
- ## Constructor Summary
63
-
64
- This class does not have a constructor, so you cannot create it directly.
65
- ## Method Summary
66
-
67
- | Method | Description |
68
- | --- | --- |
69
- | [getAllProductLinks](dw.catalog.VariationGroup.md#getallproductlinks)() | Returns all product links of the product variation group. |
70
- | [getAllProductLinks](dw.catalog.VariationGroup.md#getallproductlinksnumber)([Number](TopLevel.Number.md)) | Returns all product links of the specified type of the product variation group. |
71
- | [getBrand](dw.catalog.VariationGroup.md#getbrand)() | Returns the brand of the product variation group. |
72
- | [getClassificationCategory](dw.catalog.VariationGroup.md#getclassificationcategory)() | Returns the classification category of the product variation group. |
73
- | [getCustom](dw.catalog.VariationGroup.md#getcustom)() | Returns the custom attributes of the variation group. |
74
- | [getEAN](dw.catalog.VariationGroup.md#getean)() | Returns the EAN of the product variation group. |
75
- | [getImage](dw.catalog.VariationGroup.md#getimage)() | Returns the image of the product variation group. |
76
- | [getLongDescription](dw.catalog.VariationGroup.md#getlongdescription)() | Returns the long description of the product variation group. |
77
- | [getManufacturerName](dw.catalog.VariationGroup.md#getmanufacturername)() | Returns the manufacturer name of the product variation group. |
78
- | [getManufacturerSKU](dw.catalog.VariationGroup.md#getmanufacturersku)() | Returns the manufacturer sku of the product variation group. |
79
- | [getMasterProduct](dw.catalog.VariationGroup.md#getmasterproduct)() | Returns the ProductMaster for this mastered product. |
80
- | [getName](dw.catalog.VariationGroup.md#getname)() | Returns the name of the product variation group. |
81
- | [getOnlineFrom](dw.catalog.VariationGroup.md#getonlinefrom)() | Returns the onlineFrom date of the product variation group. |
82
- | [getOnlineTo](dw.catalog.VariationGroup.md#getonlineto)() | Returns the onlineTo date of the product variation group. |
83
- | [getPageDescription](dw.catalog.VariationGroup.md#getpagedescription)() | Returns the pageDescription of the product variation group. |
84
- | [getPageKeywords](dw.catalog.VariationGroup.md#getpagekeywords)() | Returns the pageKeywords of the product variation group. |
85
- | [getPageTitle](dw.catalog.VariationGroup.md#getpagetitle)() | Returns the pageTitle of the product variation group. |
86
- | [getPageURL](dw.catalog.VariationGroup.md#getpageurl)() | Returns the pageURL of the product variation group. |
87
- | [getProductLinks](dw.catalog.VariationGroup.md#getproductlinks)() | Returns all product links of the product variation group for which the target product is assigned to the current site catalog. |
88
- | [getProductLinks](dw.catalog.VariationGroup.md#getproductlinksnumber)([Number](TopLevel.Number.md)) | Returns all product links of the specified type of the product variation group for which the target product is assigned to the current site catalog. |
89
- | [getRecommendations](dw.catalog.VariationGroup.md#getrecommendationsnumber)([Number](TopLevel.Number.md)) | Retrieve the sorted collection of recommendations of the specified type for this product variation group. |
90
- | [getShortDescription](dw.catalog.VariationGroup.md#getshortdescription)() | Returns the short description of the product variation group. |
91
- | [getTaxClassID](dw.catalog.VariationGroup.md#gettaxclassid)() | Returns the tax class id of the product variation group. |
92
- | [getTemplate](dw.catalog.VariationGroup.md#gettemplate)() | Returns the rendering template name of the product variation group. |
93
- | [getThumbnail](dw.catalog.VariationGroup.md#getthumbnail)() | Returns the thumbnail image of the product variation group. |
94
- | [getUPC](dw.catalog.VariationGroup.md#getupc)() | Returns the UPC of the product variation group. |
95
- | [getUnit](dw.catalog.VariationGroup.md#getunit)() | Returns the sales unit of the product variation group as defined by the master product. |
96
- | [getUnitQuantity](dw.catalog.VariationGroup.md#getunitquantity)() | Returns the unitQuantity of the product variation group as defined by the master product. |
97
- | [isOptionProduct](dw.catalog.VariationGroup.md#isoptionproduct)() | Returns 'true' if the variation group has any options, otherwise 'false'. |
98
-
99
- ### Methods inherited from class Product
100
-
101
- [assignedToCategory](dw.catalog.Product.md#assignedtocategorycategory), [getActiveData](dw.catalog.Product.md#getactivedata), [getAllCategories](dw.catalog.Product.md#getallcategories), [getAllCategoryAssignments](dw.catalog.Product.md#getallcategoryassignments), [getAllIncomingProductLinks](dw.catalog.Product.md#getallincomingproductlinks), [getAllIncomingProductLinks](dw.catalog.Product.md#getallincomingproductlinksnumber), [getAllProductLinks](dw.catalog.Product.md#getallproductlinks), [getAllProductLinks](dw.catalog.Product.md#getallproductlinksnumber), [getAllRecommendations](dw.catalog.Product.md#getallrecommendationscatalog), [getAllRecommendations](dw.catalog.Product.md#getallrecommendationscatalog-number), [getAttributeModel](dw.catalog.Product.md#getattributemodel), [getAvailabilityModel](dw.catalog.Product.md#getavailabilitymodel), [getAvailabilityModel](dw.catalog.Product.md#getavailabilitymodelproductinventorylist), [getAvailableFlag](dw.catalog.Product.md#getavailableflag), [getBrand](dw.catalog.Product.md#getbrand), [getBundledProductQuantity](dw.catalog.Product.md#getbundledproductquantityproduct), [getBundledProducts](dw.catalog.Product.md#getbundledproducts), [getBundles](dw.catalog.Product.md#getbundles), [getCategories](dw.catalog.Product.md#getcategories), [getCategoryAssignment](dw.catalog.Product.md#getcategoryassignmentcategory), [getCategoryAssignments](dw.catalog.Product.md#getcategoryassignments), [getClassificationCategory](dw.catalog.Product.md#getclassificationcategory), [getEAN](dw.catalog.Product.md#getean), [getID](dw.catalog.Product.md#getid), [getImage](dw.catalog.Product.md#getimage), [getImage](dw.catalog.Product.md#getimagestring), [getImage](dw.catalog.Product.md#getimagestring-number), [getImages](dw.catalog.Product.md#getimagesstring), [getIncomingProductLinks](dw.catalog.Product.md#getincomingproductlinks), [getIncomingProductLinks](dw.catalog.Product.md#getincomingproductlinksnumber), [getLongDescription](dw.catalog.Product.md#getlongdescription), [getManufacturerName](dw.catalog.Product.md#getmanufacturername), [getManufacturerSKU](dw.catalog.Product.md#getmanufacturersku), [getMinOrderQuantity](dw.catalog.Product.md#getminorderquantity), [getName](dw.catalog.Product.md#getname), [getOnlineCategories](dw.catalog.Product.md#getonlinecategories), [getOnlineFlag](dw.catalog.Product.md#getonlineflag), [getOnlineFrom](dw.catalog.Product.md#getonlinefrom), [getOnlineTo](dw.catalog.Product.md#getonlineto), [getOptionModel](dw.catalog.Product.md#getoptionmodel), [getOrderableRecommendations](dw.catalog.Product.md#getorderablerecommendations), [getOrderableRecommendations](dw.catalog.Product.md#getorderablerecommendationsnumber), [getPageDescription](dw.catalog.Product.md#getpagedescription), [getPageKeywords](dw.catalog.Product.md#getpagekeywords), [getPageMetaTag](dw.catalog.Product.md#getpagemetatagstring), [getPageMetaTags](dw.catalog.Product.md#getpagemetatags), [getPageTitle](dw.catalog.Product.md#getpagetitle), [getPageURL](dw.catalog.Product.md#getpageurl), [getPriceModel](dw.catalog.Product.md#getpricemodel), [getPriceModel](dw.catalog.Product.md#getpricemodelproductoptionmodel), [getPrimaryCategory](dw.catalog.Product.md#getprimarycategory), [getPrimaryCategoryAssignment](dw.catalog.Product.md#getprimarycategoryassignment), [getProductLinks](dw.catalog.Product.md#getproductlinks), [getProductLinks](dw.catalog.Product.md#getproductlinksnumber), [getProductSetProducts](dw.catalog.Product.md#getproductsetproducts), [getProductSets](dw.catalog.Product.md#getproductsets), [getRecommendations](dw.catalog.Product.md#getrecommendations), [getRecommendations](dw.catalog.Product.md#getrecommendationsnumber), [getSearchPlacement](dw.catalog.Product.md#getsearchplacement), [getSearchRank](dw.catalog.Product.md#getsearchrank), [getSearchableFlag](dw.catalog.Product.md#getsearchableflag), [getSearchableIfUnavailableFlag](dw.catalog.Product.md#getsearchableifunavailableflag), [getShortDescription](dw.catalog.Product.md#getshortdescription), [getSiteMapChangeFrequency](dw.catalog.Product.md#getsitemapchangefrequency), [getSiteMapIncluded](dw.catalog.Product.md#getsitemapincluded), [getSiteMapPriority](dw.catalog.Product.md#getsitemappriority), [getStepQuantity](dw.catalog.Product.md#getstepquantity), [getStoreReceiptName](dw.catalog.Product.md#getstorereceiptname), [getStoreTaxClass](dw.catalog.Product.md#getstoretaxclass), [getTaxClassID](dw.catalog.Product.md#gettaxclassid), [getTemplate](dw.catalog.Product.md#gettemplate), [getThumbnail](dw.catalog.Product.md#getthumbnail), [getUPC](dw.catalog.Product.md#getupc), [getUnit](dw.catalog.Product.md#getunit), [getUnitQuantity](dw.catalog.Product.md#getunitquantity), [getVariants](dw.catalog.Product.md#getvariants), [getVariationGroups](dw.catalog.Product.md#getvariationgroups), [getVariationModel](dw.catalog.Product.md#getvariationmodel), [includedInBundle](dw.catalog.Product.md#includedinbundleproduct), [isAssignedToCategory](dw.catalog.Product.md#isassignedtocategorycategory), [isAssignedToSiteCatalog](dw.catalog.Product.md#isassignedtositecatalog), [isAvailable](dw.catalog.Product.md#isavailable), [isBundle](dw.catalog.Product.md#isbundle), [isBundled](dw.catalog.Product.md#isbundled), [isCategorized](dw.catalog.Product.md#iscategorized), [isFacebookEnabled](dw.catalog.Product.md#isfacebookenabled), [isMaster](dw.catalog.Product.md#ismaster), [isOnline](dw.catalog.Product.md#isonline), [isOptionProduct](dw.catalog.Product.md#isoptionproduct), [isPinterestEnabled](dw.catalog.Product.md#ispinterestenabled), [isProduct](dw.catalog.Product.md#isproduct), [isProductSet](dw.catalog.Product.md#isproductset), [isProductSetProduct](dw.catalog.Product.md#isproductsetproduct), [isRetailSet](dw.catalog.Product.md#isretailset), [isSearchable](dw.catalog.Product.md#issearchable), [isSiteProduct](dw.catalog.Product.md#issiteproduct), [isVariant](dw.catalog.Product.md#isvariant), [isVariationGroup](dw.catalog.Product.md#isvariationgroup), [setAvailableFlag](dw.catalog.Product.md#setavailableflagboolean), [setOnlineFlag](dw.catalog.Product.md#setonlineflagboolean---variant-1), [setOnlineFlag](dw.catalog.Product.md#setonlineflagboolean---variant-2), [setSearchPlacement](dw.catalog.Product.md#setsearchplacementnumber---variant-1), [setSearchPlacement](dw.catalog.Product.md#setsearchplacementnumber---variant-2), [setSearchRank](dw.catalog.Product.md#setsearchranknumber---variant-1), [setSearchRank](dw.catalog.Product.md#setsearchranknumber---variant-2), [setSearchableFlag](dw.catalog.Product.md#setsearchableflagboolean---variant-1), [setSearchableFlag](dw.catalog.Product.md#setsearchableflagboolean---variant-2)
102
- ### Methods inherited from class ExtensibleObject
103
-
104
- [describe](dw.object.ExtensibleObject.md#describe), [getCustom](dw.object.ExtensibleObject.md#getcustom)
105
- ### Methods inherited from class PersistentObject
106
-
107
- [getCreationDate](dw.object.PersistentObject.md#getcreationdate), [getLastModified](dw.object.PersistentObject.md#getlastmodified), [getUUID](dw.object.PersistentObject.md#getuuid)
108
- ### Methods inherited from class Object
109
-
110
- [assign](TopLevel.Object.md#assignobject-object), [create](TopLevel.Object.md#createobject), [create](TopLevel.Object.md#createobject-object), [defineProperties](TopLevel.Object.md#definepropertiesobject-object), [defineProperty](TopLevel.Object.md#definepropertyobject-object-object), [entries](TopLevel.Object.md#entriesobject), [freeze](TopLevel.Object.md#freezeobject), [fromEntries](TopLevel.Object.md#fromentriesiterable), [getOwnPropertyDescriptor](TopLevel.Object.md#getownpropertydescriptorobject-object), [getOwnPropertyNames](TopLevel.Object.md#getownpropertynamesobject), [getOwnPropertySymbols](TopLevel.Object.md#getownpropertysymbolsobject), [getPrototypeOf](TopLevel.Object.md#getprototypeofobject), [hasOwnProperty](TopLevel.Object.md#hasownpropertystring), [is](TopLevel.Object.md#isobject-object), [isExtensible](TopLevel.Object.md#isextensibleobject), [isFrozen](TopLevel.Object.md#isfrozenobject), [isPrototypeOf](TopLevel.Object.md#isprototypeofobject), [isSealed](TopLevel.Object.md#issealedobject), [keys](TopLevel.Object.md#keysobject), [preventExtensions](TopLevel.Object.md#preventextensionsobject), [propertyIsEnumerable](TopLevel.Object.md#propertyisenumerablestring), [seal](TopLevel.Object.md#sealobject), [setPrototypeOf](TopLevel.Object.md#setprototypeofobject-object), [toLocaleString](TopLevel.Object.md#tolocalestring), [toString](TopLevel.Object.md#tostring), [valueOf](TopLevel.Object.md#valueof), [values](TopLevel.Object.md#valuesobject)
111
- ## Property Details
112
-
113
- ### EAN
114
- - EAN: [String](TopLevel.String.md) `(read-only)`
115
- - : Returns the EAN of the product variation group.
116
-
117
-
118
- If the variation group does not define an own value for 'EAN', the value of
119
- the master product is returned.
120
-
121
-
122
-
123
- ---
124
-
125
- ### UPC
126
- - UPC: [String](TopLevel.String.md) `(read-only)`
127
- - : Returns the UPC of the product variation group.
128
-
129
-
130
- If the variation group does not define an own value for 'UPC', the value of
131
- the master product is returned.
132
-
133
-
134
-
135
- ---
136
-
137
- ### allProductLinks
138
- - allProductLinks: [Collection](dw.util.Collection.md) `(read-only)`
139
- - : Returns all product links of the product variation group.
140
-
141
-
142
- If the variation group does not define any product links, but the master product
143
- does, the product links of the master are returned.
144
-
145
-
146
-
147
- ---
148
-
149
- ### brand
150
- - brand: [String](TopLevel.String.md) `(read-only)`
151
- - : Returns the brand of the product variation group.
152
-
153
-
154
- If the variation group does not define an own value for 'brand', the value of
155
- the master product is returned.
156
-
157
-
158
-
159
- ---
160
-
161
- ### classificationCategory
162
- - classificationCategory: [Category](dw.catalog.Category.md) `(read-only)`
163
- - : Returns the classification category of the product variation group.
164
-
165
-
166
- **Please note** that the classification category is always inherited
167
- from the master and cannot be overridden by the variation group.
168
-
169
-
170
-
171
- ---
172
-
173
- ### custom
174
- - custom: [CustomAttributes](dw.object.CustomAttributes.md) `(read-only)`
175
- - : Returns the custom attributes of the variation group.
176
-
177
-
178
- Custom attributes are inherited from the master product and can
179
- be overridden by the variation group.
180
-
181
-
182
-
183
- ---
184
-
185
- ### image
186
- - image: [MediaFile](dw.content.MediaFile.md) `(read-only)`
187
- - : Returns the image of the product variation group.
188
-
189
-
190
- If the variation group does not define an own value for 'image', the value of
191
- the master product is returned.
192
-
193
-
194
-
195
- ---
196
-
197
- ### longDescription
198
- - longDescription: [MarkupText](dw.content.MarkupText.md) `(read-only)`
199
- - : Returns the long description of the product variation group.
200
-
201
-
202
- If the variation group does not define an own value for 'longDescription', the value of
203
- the master product is returned.
204
-
205
-
206
-
207
- ---
208
-
209
- ### manufacturerName
210
- - manufacturerName: [String](TopLevel.String.md) `(read-only)`
211
- - : Returns the manufacturer name of the product variation group.
212
-
213
-
214
- If the variation group does not define an own value for 'manufacturerName', the value of
215
- the master product is returned.
216
-
217
-
218
-
219
- ---
220
-
221
- ### manufacturerSKU
222
- - manufacturerSKU: [String](TopLevel.String.md) `(read-only)`
223
- - : Returns the manufacturer sku of the product variation group.
224
-
225
-
226
- If the variation group does not define an own value for 'manufacturerSKU', the value of
227
- the master product is returned.
228
-
229
-
230
-
231
- ---
232
-
233
- ### masterProduct
234
- - masterProduct: [Product](dw.catalog.Product.md) `(read-only)`
235
- - : Returns the ProductMaster for this mastered product.
236
-
237
-
238
- ---
239
-
240
- ### name
241
- - name: [String](TopLevel.String.md) `(read-only)`
242
- - : Returns the name of the product variation group.
243
-
244
-
245
- If the variation group does not define an own value for 'name', the value of
246
- the master product is returned.
247
-
248
-
249
-
250
- ---
251
-
252
- ### onlineFrom
253
- - onlineFrom: [Date](TopLevel.Date.md) `(read-only)`
254
- - : Returns the onlineFrom date of the product variation group.
255
-
256
-
257
- If the variation group does not define an own value for 'onlineFrom', the value of
258
- the master product is returned.
259
-
260
-
261
-
262
- ---
263
-
264
- ### onlineTo
265
- - onlineTo: [Date](TopLevel.Date.md) `(read-only)`
266
- - : Returns the onlineTo date of the product variation group.
267
-
268
-
269
- If the variation group does not define an own value for 'onlineTo', the value of
270
- the master product is returned.
271
-
272
-
273
-
274
- ---
275
-
276
- ### optionProduct
277
- - optionProduct: [Boolean](TopLevel.Boolean.md) `(read-only)`
278
- - : Returns 'true' if the variation group has any options, otherwise 'false'.
279
- Method also returns 'true' if the variation group has not any options,
280
- but the related master product has options.
281
-
282
-
283
-
284
- ---
285
-
286
- ### pageDescription
287
- - pageDescription: [String](TopLevel.String.md) `(read-only)`
288
- - : Returns the pageDescription of the product variation group.
289
-
290
-
291
- If the variation group does not define an own value for 'pageDescription', the value of
292
- the master product is returned.
293
-
294
-
295
-
296
- ---
297
-
298
- ### pageKeywords
299
- - pageKeywords: [String](TopLevel.String.md) `(read-only)`
300
- - : Returns the pageKeywords of the product variation group.
301
-
302
-
303
- If the variation group does not define an own value for 'pageKeywords', the value of
304
- the master product is returned.
305
-
306
-
307
-
308
- ---
309
-
310
- ### pageTitle
311
- - pageTitle: [String](TopLevel.String.md) `(read-only)`
312
- - : Returns the pageTitle of the product variation group.
313
-
314
-
315
- If the variation group does not define an own value for 'pageTitle', the value of
316
- the master product is returned.
317
-
318
-
319
-
320
- ---
321
-
322
- ### pageURL
323
- - pageURL: [String](TopLevel.String.md) `(read-only)`
324
- - : Returns the pageURL of the product variation group.
325
-
326
-
327
- If the variation group does not define an own value for 'pageURL', the value of
328
- the master product is returned.
329
-
330
-
331
-
332
- ---
333
-
334
- ### productLinks
335
- - productLinks: [Collection](dw.util.Collection.md) `(read-only)`
336
- - : Returns all product links of the product variation group for which the target
337
- product is assigned to the current site catalog.
338
-
339
-
340
- If the variation group does not define any product links, but the master product
341
- does, the product links of the master are returned.
342
-
343
-
344
-
345
- ---
346
-
347
- ### shortDescription
348
- - shortDescription: [MarkupText](dw.content.MarkupText.md) `(read-only)`
349
- - : Returns the short description of the product variation group.
350
-
351
-
352
- If the variation group does not define an own value for 'shortDescription', the value of
353
- the master product is returned.
354
-
355
-
356
-
357
- ---
358
-
359
- ### taxClassID
360
- - taxClassID: [String](TopLevel.String.md) `(read-only)`
361
- - : Returns the tax class id of the product variation group.
362
-
363
-
364
- If the variation group does not define an own value for 'taxClassID', the value of
365
- the master product is returned.
366
-
367
-
368
-
369
- ---
370
-
371
- ### template
372
- - template: [String](TopLevel.String.md) `(read-only)`
373
- - : Returns the rendering template name of the product variation group.
374
-
375
-
376
- If the variation group does not define an own value for 'template', the value of
377
- the master product is returned.
378
-
379
-
380
-
381
- ---
382
-
383
- ### thumbnail
384
- - thumbnail: [MediaFile](dw.content.MediaFile.md) `(read-only)`
385
- - : Returns the thumbnail image of the product variation group.
386
-
387
-
388
- If the variation group does not define an own value for 'thumbnailImage', the value of
389
- the master product is returned.
390
-
391
-
392
-
393
- ---
394
-
395
- ### unit
396
- - unit: [String](TopLevel.String.md) `(read-only)`
397
- - : Returns the sales unit of the product variation group as defined by the
398
- master product.
399
-
400
-
401
- If the variation group does not define an own value for 'unit', the value of
402
- the master product is returned.
403
-
404
-
405
-
406
- ---
407
-
408
- ### unitQuantity
409
- - unitQuantity: [Quantity](dw.value.Quantity.md) `(read-only)`
410
- - : Returns the unitQuantity of the product variation group as defined by the
411
- master product.
412
-
413
-
414
- If the variation group does not define an own value for 'unitQuantity', the value of
415
- the master product is returned.
416
-
417
-
418
-
419
- ---
420
-
421
- ## Method Details
422
-
423
- ### getAllProductLinks()
424
- - getAllProductLinks(): [Collection](dw.util.Collection.md)
425
- - : Returns all product links of the product variation group.
426
-
427
-
428
- If the variation group does not define any product links, but the master product
429
- does, the product links of the master are returned.
430
-
431
-
432
- **Returns:**
433
- - All product links of the variation group or master
434
-
435
-
436
- ---
437
-
438
- ### getAllProductLinks(Number)
439
- - getAllProductLinks(type: [Number](TopLevel.Number.md)): [Collection](dw.util.Collection.md)
440
- - : Returns all product links of the specified type of the product variation group.
441
-
442
-
443
- If the variation group does not define any product links, but the master product
444
- does, the product links of the master are returned.
445
-
446
-
447
- **Parameters:**
448
- - type - Type of the product link
449
-
450
- **Returns:**
451
- - Product links of specified type of the variation group or master
452
-
453
-
454
- ---
455
-
456
- ### getBrand()
457
- - getBrand(): [String](TopLevel.String.md)
458
- - : Returns the brand of the product variation group.
459
-
460
-
461
- If the variation group does not define an own value for 'brand', the value of
462
- the master product is returned.
463
-
464
-
465
- **Returns:**
466
- - The brand of the variation group or master
467
-
468
-
469
- ---
470
-
471
- ### getClassificationCategory()
472
- - getClassificationCategory(): [Category](dw.catalog.Category.md)
473
- - : Returns the classification category of the product variation group.
474
-
475
-
476
- **Please note** that the classification category is always inherited
477
- from the master and cannot be overridden by the variation group.
478
-
479
-
480
- **Returns:**
481
- - The classification category as defined for the master product of the variation group
482
-
483
-
484
- ---
485
-
486
- ### getCustom()
487
- - getCustom(): [CustomAttributes](dw.object.CustomAttributes.md)
488
- - : Returns the custom attributes of the variation group.
489
-
490
-
491
- Custom attributes are inherited from the master product and can
492
- be overridden by the variation group.
493
-
494
-
495
- **Returns:**
496
- - the custom attributes of the variation group.
497
-
498
-
499
- ---
500
-
501
- ### getEAN()
502
- - getEAN(): [String](TopLevel.String.md)
503
- - : Returns the EAN of the product variation group.
504
-
505
-
506
- If the variation group does not define an own value for 'EAN', the value of
507
- the master product is returned.
508
-
509
-
510
- **Returns:**
511
- - The EAN of the variation group or master
512
-
513
-
514
- ---
515
-
516
- ### getImage()
517
- - getImage(): [MediaFile](dw.content.MediaFile.md)
518
- - : Returns the image of the product variation group.
519
-
520
-
521
- If the variation group does not define an own value for 'image', the value of
522
- the master product is returned.
523
-
524
-
525
- **Returns:**
526
- - The image of the variation group or master
527
-
528
-
529
- ---
530
-
531
- ### getLongDescription()
532
- - getLongDescription(): [MarkupText](dw.content.MarkupText.md)
533
- - : Returns the long description of the product variation group.
534
-
535
-
536
- If the variation group does not define an own value for 'longDescription', the value of
537
- the master product is returned.
538
-
539
-
540
- **Returns:**
541
- - The long description name of the variation group or master
542
-
543
-
544
- ---
545
-
546
- ### getManufacturerName()
547
- - getManufacturerName(): [String](TopLevel.String.md)
548
- - : Returns the manufacturer name of the product variation group.
549
-
550
-
551
- If the variation group does not define an own value for 'manufacturerName', the value of
552
- the master product is returned.
553
-
554
-
555
- **Returns:**
556
- - The manufacturer name of the variation group or master
557
-
558
-
559
- ---
560
-
561
- ### getManufacturerSKU()
562
- - getManufacturerSKU(): [String](TopLevel.String.md)
563
- - : Returns the manufacturer sku of the product variation group.
564
-
565
-
566
- If the variation group does not define an own value for 'manufacturerSKU', the value of
567
- the master product is returned.
568
-
569
-
570
- **Returns:**
571
- - The manufacturer sku of the variation group or master
572
-
573
-
574
- ---
575
-
576
- ### getMasterProduct()
577
- - getMasterProduct(): [Product](dw.catalog.Product.md)
578
- - : Returns the ProductMaster for this mastered product.
579
-
580
- **Returns:**
581
- - the ProductMaster of this mastered product
582
-
583
-
584
- ---
585
-
586
- ### getName()
587
- - getName(): [String](TopLevel.String.md)
588
- - : Returns the name of the product variation group.
589
-
590
-
591
- If the variation group does not define an own value for 'name', the value of
592
- the master product is returned.
593
-
594
-
595
- **Returns:**
596
- - The name of the variation group or master
597
-
598
-
599
- ---
600
-
601
- ### getOnlineFrom()
602
- - getOnlineFrom(): [Date](TopLevel.Date.md)
603
- - : Returns the onlineFrom date of the product variation group.
604
-
605
-
606
- If the variation group does not define an own value for 'onlineFrom', the value of
607
- the master product is returned.
608
-
609
-
610
- **Returns:**
611
- - The onlineFrom date of the variation group or master
612
-
613
-
614
- ---
615
-
616
- ### getOnlineTo()
617
- - getOnlineTo(): [Date](TopLevel.Date.md)
618
- - : Returns the onlineTo date of the product variation group.
619
-
620
-
621
- If the variation group does not define an own value for 'onlineTo', the value of
622
- the master product is returned.
623
-
624
-
625
- **Returns:**
626
- - The onlineTo date of the variation group or master
627
-
628
-
629
- ---
630
-
631
- ### getPageDescription()
632
- - getPageDescription(): [String](TopLevel.String.md)
633
- - : Returns the pageDescription of the product variation group.
634
-
635
-
636
- If the variation group does not define an own value for 'pageDescription', the value of
637
- the master product is returned.
638
-
639
-
640
- **Returns:**
641
- - The pageDescription of the variation group or master
642
-
643
-
644
- ---
645
-
646
- ### getPageKeywords()
647
- - getPageKeywords(): [String](TopLevel.String.md)
648
- - : Returns the pageKeywords of the product variation group.
649
-
650
-
651
- If the variation group does not define an own value for 'pageKeywords', the value of
652
- the master product is returned.
653
-
654
-
655
- **Returns:**
656
- - The pageKeywords of the variation group or master
657
-
658
-
659
- ---
660
-
661
- ### getPageTitle()
662
- - getPageTitle(): [String](TopLevel.String.md)
663
- - : Returns the pageTitle of the product variation group.
664
-
665
-
666
- If the variation group does not define an own value for 'pageTitle', the value of
667
- the master product is returned.
668
-
669
-
670
- **Returns:**
671
- - The pageTitle of the variation group or master
672
-
673
-
674
- ---
675
-
676
- ### getPageURL()
677
- - getPageURL(): [String](TopLevel.String.md)
678
- - : Returns the pageURL of the product variation group.
679
-
680
-
681
- If the variation group does not define an own value for 'pageURL', the value of
682
- the master product is returned.
683
-
684
-
685
- **Returns:**
686
- - The pageURL of the variation group or master
687
-
688
-
689
- ---
690
-
691
- ### getProductLinks()
692
- - getProductLinks(): [Collection](dw.util.Collection.md)
693
- - : Returns all product links of the product variation group for which the target
694
- product is assigned to the current site catalog.
695
-
696
-
697
- If the variation group does not define any product links, but the master product
698
- does, the product links of the master are returned.
699
-
700
-
701
- **Returns:**
702
- - Product links of the variation group or master
703
-
704
-
705
- ---
706
-
707
- ### getProductLinks(Number)
708
- - getProductLinks(type: [Number](TopLevel.Number.md)): [Collection](dw.util.Collection.md)
709
- - : Returns all product links of the specified type of the product variation group
710
- for which the target product is assigned to the current site catalog.
711
-
712
-
713
- If the variation group does not define any product links of the specified type,
714
- but the master product does, the product links of the master are returned.
715
-
716
-
717
- **Parameters:**
718
- - type - Type of the product link
719
-
720
- **Returns:**
721
- - Product links of specified type of the variation group or master
722
-
723
-
724
- ---
725
-
726
- ### getRecommendations(Number)
727
- - getRecommendations(type: [Number](TopLevel.Number.md)): [Collection](dw.util.Collection.md)
728
- - : Retrieve the sorted collection of recommendations of the specified type
729
- for this product variation group. The types (cross-sell, up-sell, etc) are
730
- enumerated in the `dw.catalog.Recommendation` class. Only
731
- recommendations which are stored in the current site catalog are returned.
732
- Furthermore, a recommendation is only returned if the target of the
733
- recommendation is assigned to the current site catalog.
734
-
735
-
736
- If the variation group does not define any recommendations, but the master
737
- product does, the recommendations of the master are returned.
738
-
739
-
740
- **Parameters:**
741
- - type - the recommendation type
742
-
743
- **Returns:**
744
- - the sorted collection, never null but possibly empty.
745
-
746
-
747
- ---
748
-
749
- ### getShortDescription()
750
- - getShortDescription(): [MarkupText](dw.content.MarkupText.md)
751
- - : Returns the short description of the product variation group.
752
-
753
-
754
- If the variation group does not define an own value for 'shortDescription', the value of
755
- the master product is returned.
756
-
757
-
758
- **Returns:**
759
- - The short description name of the variation group or master
760
-
761
-
762
- ---
763
-
764
- ### getTaxClassID()
765
- - getTaxClassID(): [String](TopLevel.String.md)
766
- - : Returns the tax class id of the product variation group.
767
-
768
-
769
- If the variation group does not define an own value for 'taxClassID', the value of
770
- the master product is returned.
771
-
772
-
773
- **Returns:**
774
- - The tax class id of the variation group or master
775
-
776
-
777
- ---
778
-
779
- ### getTemplate()
780
- - getTemplate(): [String](TopLevel.String.md)
781
- - : Returns the rendering template name of the product variation group.
782
-
783
-
784
- If the variation group does not define an own value for 'template', the value of
785
- the master product is returned.
786
-
787
-
788
- **Returns:**
789
- - The rendering template name of the variation group or master
790
-
791
-
792
- ---
793
-
794
- ### getThumbnail()
795
- - getThumbnail(): [MediaFile](dw.content.MediaFile.md)
796
- - : Returns the thumbnail image of the product variation group.
797
-
798
-
799
- If the variation group does not define an own value for 'thumbnailImage', the value of
800
- the master product is returned.
801
-
802
-
803
- **Returns:**
804
- - The thumbnail image of the variation group or master
805
-
806
-
807
- ---
808
-
809
- ### getUPC()
810
- - getUPC(): [String](TopLevel.String.md)
811
- - : Returns the UPC of the product variation group.
812
-
813
-
814
- If the variation group does not define an own value for 'UPC', the value of
815
- the master product is returned.
816
-
817
-
818
- **Returns:**
819
- - The UPC of the variation group or master
820
-
821
-
822
- ---
823
-
824
- ### getUnit()
825
- - getUnit(): [String](TopLevel.String.md)
826
- - : Returns the sales unit of the product variation group as defined by the
827
- master product.
828
-
829
-
830
- If the variation group does not define an own value for 'unit', the value of
831
- the master product is returned.
832
-
833
-
834
- **Returns:**
835
- - The sales unit of the variation group or master
836
-
837
-
838
- ---
839
-
840
- ### getUnitQuantity()
841
- - getUnitQuantity(): [Quantity](dw.value.Quantity.md)
842
- - : Returns the unitQuantity of the product variation group as defined by the
843
- master product.
844
-
845
-
846
- If the variation group does not define an own value for 'unitQuantity', the value of
847
- the master product is returned.
848
-
849
-
850
- **Returns:**
851
- - The unitQuantity of the variation group or master
852
-
853
-
854
- ---
855
-
856
- ### isOptionProduct()
857
- - isOptionProduct(): [Boolean](TopLevel.Boolean.md)
858
- - : Returns 'true' if the variation group has any options, otherwise 'false'.
859
- Method also returns 'true' if the variation group has not any options,
860
- but the related master product has options.
861
-
862
-
863
- **Returns:**
864
- - true if the variation group has any options, false otherwise.
865
-
866
-
867
- ---
868
-
869
- <!-- prettier-ignore-end -->