@salesforce/b2c-tooling-sdk 1.19.1 → 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 (577) 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/docs/content-cache.d.ts +70 -0
  28. package/dist/esm/docs/content-cache.js +186 -0
  29. package/dist/esm/docs/content-cache.js.map +1 -0
  30. package/dist/esm/docs/index.d.ts +1 -0
  31. package/dist/esm/docs/index.js +2 -0
  32. package/dist/esm/docs/index.js.map +1 -1
  33. package/dist/esm/docs/search.js +34 -6
  34. package/dist/esm/docs/search.js.map +1 -1
  35. package/dist/esm/docs/types.d.ts +6 -1
  36. package/dist/esm/docs/types.js +1 -0
  37. package/dist/esm/docs/types.js.map +1 -1
  38. package/dist/esm/index.d.ts +2 -2
  39. package/dist/esm/index.js +1 -1
  40. package/dist/esm/index.js.map +1 -1
  41. package/dist/esm/operations/jobs/discover.d.ts +46 -0
  42. package/dist/esm/operations/jobs/discover.js +87 -0
  43. package/dist/esm/operations/jobs/discover.js.map +1 -0
  44. package/dist/esm/operations/jobs/index.d.ts +2 -0
  45. package/dist/esm/operations/jobs/index.js +2 -0
  46. package/dist/esm/operations/jobs/index.js.map +1 -1
  47. package/dist/esm/operations/jobs/run.js +4 -3
  48. package/dist/esm/operations/jobs/run.js.map +1 -1
  49. package/package.json +5 -3
  50. package/specs/preferences-v1.yaml +2095 -0
  51. package/data/script-api/TopLevel.APIException.md +0 -119
  52. package/data/script-api/TopLevel.Array.md +0 -732
  53. package/data/script-api/TopLevel.ArrayBuffer.md +0 -97
  54. package/data/script-api/TopLevel.BigInt.md +0 -154
  55. package/data/script-api/TopLevel.Boolean.md +0 -83
  56. package/data/script-api/TopLevel.ConversionError.md +0 -51
  57. package/data/script-api/TopLevel.DataView.md +0 -271
  58. package/data/script-api/TopLevel.Date.md +0 -688
  59. package/data/script-api/TopLevel.ES6Iterator.md +0 -47
  60. package/data/script-api/TopLevel.Error.md +0 -124
  61. package/data/script-api/TopLevel.EvalError.md +0 -47
  62. package/data/script-api/TopLevel.Fault.md +0 -133
  63. package/data/script-api/TopLevel.Float32Array.md +0 -186
  64. package/data/script-api/TopLevel.Float64Array.md +0 -186
  65. package/data/script-api/TopLevel.Function.md +0 -114
  66. package/data/script-api/TopLevel.Generator.md +0 -132
  67. package/data/script-api/TopLevel.IOError.md +0 -98
  68. package/data/script-api/TopLevel.Int16Array.md +0 -186
  69. package/data/script-api/TopLevel.Int32Array.md +0 -186
  70. package/data/script-api/TopLevel.Int8Array.md +0 -186
  71. package/data/script-api/TopLevel.InternalError.md +0 -47
  72. package/data/script-api/TopLevel.Iterable.md +0 -44
  73. package/data/script-api/TopLevel.Iterator.md +0 -89
  74. package/data/script-api/TopLevel.JSON.md +0 -173
  75. package/data/script-api/TopLevel.Map.md +0 -189
  76. package/data/script-api/TopLevel.Math.md +0 -948
  77. package/data/script-api/TopLevel.Module.md +0 -152
  78. package/data/script-api/TopLevel.Namespace.md +0 -152
  79. package/data/script-api/TopLevel.Number.md +0 -404
  80. package/data/script-api/TopLevel.Object.md +0 -472
  81. package/data/script-api/TopLevel.QName.md +0 -147
  82. package/data/script-api/TopLevel.RangeError.md +0 -47
  83. package/data/script-api/TopLevel.ReferenceError.md +0 -47
  84. package/data/script-api/TopLevel.RegExp.md +0 -155
  85. package/data/script-api/TopLevel.Set.md +0 -150
  86. package/data/script-api/TopLevel.StopIteration.md +0 -36
  87. package/data/script-api/TopLevel.String.md +0 -1060
  88. package/data/script-api/TopLevel.Symbol.md +0 -196
  89. package/data/script-api/TopLevel.SyntaxError.md +0 -47
  90. package/data/script-api/TopLevel.SystemError.md +0 -99
  91. package/data/script-api/TopLevel.TypeError.md +0 -47
  92. package/data/script-api/TopLevel.URIError.md +0 -47
  93. package/data/script-api/TopLevel.Uint16Array.md +0 -186
  94. package/data/script-api/TopLevel.Uint32Array.md +0 -186
  95. package/data/script-api/TopLevel.Uint8Array.md +0 -186
  96. package/data/script-api/TopLevel.Uint8ClampedArray.md +0 -186
  97. package/data/script-api/TopLevel.WeakMap.md +0 -135
  98. package/data/script-api/TopLevel.WeakSet.md +0 -96
  99. package/data/script-api/TopLevel.XML.md +0 -922
  100. package/data/script-api/TopLevel.XMLList.md +0 -418
  101. package/data/script-api/TopLevel.XMLStreamError.md +0 -115
  102. package/data/script-api/TopLevel.arguments.md +0 -56
  103. package/data/script-api/TopLevel.global.md +0 -539
  104. package/data/script-api/TopLevel.md +0 -58
  105. package/data/script-api/dw.alert.Alert.md +0 -175
  106. package/data/script-api/dw.alert.Alerts.md +0 -256
  107. package/data/script-api/dw.alert.md +0 -7
  108. package/data/script-api/dw.campaign.ABTest.md +0 -63
  109. package/data/script-api/dw.campaign.ABTestMgr.md +0 -76
  110. package/data/script-api/dw.campaign.ABTestSegment.md +0 -107
  111. package/data/script-api/dw.campaign.AmountDiscount.md +0 -70
  112. package/data/script-api/dw.campaign.ApproachingDiscount.md +0 -157
  113. package/data/script-api/dw.campaign.BonusChoiceDiscount.md +0 -190
  114. package/data/script-api/dw.campaign.BonusDiscount.md +0 -59
  115. package/data/script-api/dw.campaign.Campaign.md +0 -346
  116. package/data/script-api/dw.campaign.CampaignMgr.md +0 -436
  117. package/data/script-api/dw.campaign.CampaignStatusCodes.md +0 -103
  118. package/data/script-api/dw.campaign.Coupon.md +0 -324
  119. package/data/script-api/dw.campaign.CouponMgr.md +0 -137
  120. package/data/script-api/dw.campaign.CouponRedemption.md +0 -87
  121. package/data/script-api/dw.campaign.CouponStatusCodes.md +0 -130
  122. package/data/script-api/dw.campaign.Discount.md +0 -271
  123. package/data/script-api/dw.campaign.DiscountPlan.md +0 -322
  124. package/data/script-api/dw.campaign.FixedPriceDiscount.md +0 -74
  125. package/data/script-api/dw.campaign.FixedPriceShippingDiscount.md +0 -74
  126. package/data/script-api/dw.campaign.FreeDiscount.md +0 -24
  127. package/data/script-api/dw.campaign.FreeShippingDiscount.md +0 -24
  128. package/data/script-api/dw.campaign.PercentageDiscount.md +0 -74
  129. package/data/script-api/dw.campaign.PercentageOptionDiscount.md +0 -59
  130. package/data/script-api/dw.campaign.PriceBookPriceDiscount.md +0 -56
  131. package/data/script-api/dw.campaign.Promotion.md +0 -939
  132. package/data/script-api/dw.campaign.PromotionMgr.md +0 -478
  133. package/data/script-api/dw.campaign.PromotionPlan.md +0 -378
  134. package/data/script-api/dw.campaign.SlotContent.md +0 -131
  135. package/data/script-api/dw.campaign.SourceCodeGroup.md +0 -83
  136. package/data/script-api/dw.campaign.SourceCodeInfo.md +0 -167
  137. package/data/script-api/dw.campaign.SourceCodeStatusCodes.md +0 -61
  138. package/data/script-api/dw.campaign.TotalFixedPriceDiscount.md +0 -56
  139. package/data/script-api/dw.campaign.md +0 -36
  140. package/data/script-api/dw.catalog.Catalog.md +0 -158
  141. package/data/script-api/dw.catalog.CatalogMgr.md +0 -161
  142. package/data/script-api/dw.catalog.Category.md +0 -1212
  143. package/data/script-api/dw.catalog.CategoryAssignment.md +0 -179
  144. package/data/script-api/dw.catalog.CategoryLink.md +0 -142
  145. package/data/script-api/dw.catalog.PriceBook.md +0 -215
  146. package/data/script-api/dw.catalog.PriceBookMgr.md +0 -176
  147. package/data/script-api/dw.catalog.Product.md +0 -2492
  148. package/data/script-api/dw.catalog.ProductActiveData.md +0 -1244
  149. package/data/script-api/dw.catalog.ProductAttributeModel.md +0 -409
  150. package/data/script-api/dw.catalog.ProductAvailabilityLevels.md +0 -125
  151. package/data/script-api/dw.catalog.ProductAvailabilityModel.md +0 -516
  152. package/data/script-api/dw.catalog.ProductInventoryList.md +0 -136
  153. package/data/script-api/dw.catalog.ProductInventoryMgr.md +0 -132
  154. package/data/script-api/dw.catalog.ProductInventoryRecord.md +0 -638
  155. package/data/script-api/dw.catalog.ProductLink.md +0 -166
  156. package/data/script-api/dw.catalog.ProductMgr.md +0 -136
  157. package/data/script-api/dw.catalog.ProductOption.md +0 -189
  158. package/data/script-api/dw.catalog.ProductOptionModel.md +0 -209
  159. package/data/script-api/dw.catalog.ProductOptionValue.md +0 -132
  160. package/data/script-api/dw.catalog.ProductPriceInfo.md +0 -170
  161. package/data/script-api/dw.catalog.ProductPriceModel.md +0 -988
  162. package/data/script-api/dw.catalog.ProductPriceTable.md +0 -121
  163. package/data/script-api/dw.catalog.ProductSearchHit.md +0 -702
  164. package/data/script-api/dw.catalog.ProductSearchModel.md +0 -1894
  165. package/data/script-api/dw.catalog.ProductSearchRefinementDefinition.md +0 -99
  166. package/data/script-api/dw.catalog.ProductSearchRefinementValue.md +0 -80
  167. package/data/script-api/dw.catalog.ProductSearchRefinements.md +0 -265
  168. package/data/script-api/dw.catalog.ProductVariationAttribute.md +0 -107
  169. package/data/script-api/dw.catalog.ProductVariationAttributeValue.md +0 -215
  170. package/data/script-api/dw.catalog.ProductVariationModel.md +0 -1010
  171. package/data/script-api/dw.catalog.Recommendation.md +0 -327
  172. package/data/script-api/dw.catalog.SearchModel.md +0 -769
  173. package/data/script-api/dw.catalog.SearchRefinementDefinition.md +0 -145
  174. package/data/script-api/dw.catalog.SearchRefinementValue.md +0 -194
  175. package/data/script-api/dw.catalog.SearchRefinements.md +0 -238
  176. package/data/script-api/dw.catalog.SortingOption.md +0 -120
  177. package/data/script-api/dw.catalog.SortingRule.md +0 -53
  178. package/data/script-api/dw.catalog.Store.md +0 -484
  179. package/data/script-api/dw.catalog.StoreGroup.md +0 -95
  180. package/data/script-api/dw.catalog.StoreInventoryFilter.md +0 -112
  181. package/data/script-api/dw.catalog.StoreInventoryFilterValue.md +0 -111
  182. package/data/script-api/dw.catalog.StoreMgr.md +0 -223
  183. package/data/script-api/dw.catalog.Variant.md +0 -1000
  184. package/data/script-api/dw.catalog.VariationGroup.md +0 -869
  185. package/data/script-api/dw.catalog.md +0 -50
  186. package/data/script-api/dw.content.Content.md +0 -481
  187. package/data/script-api/dw.content.ContentMgr.md +0 -147
  188. package/data/script-api/dw.content.ContentSearchModel.md +0 -618
  189. package/data/script-api/dw.content.ContentSearchRefinementDefinition.md +0 -61
  190. package/data/script-api/dw.content.ContentSearchRefinementValue.md +0 -22
  191. package/data/script-api/dw.content.ContentSearchRefinements.md +0 -218
  192. package/data/script-api/dw.content.Folder.md +0 -432
  193. package/data/script-api/dw.content.Library.md +0 -124
  194. package/data/script-api/dw.content.MarkupText.md +0 -150
  195. package/data/script-api/dw.content.MediaFile.md +0 -367
  196. package/data/script-api/dw.content.md +0 -15
  197. package/data/script-api/dw.crypto.CertificateRef.md +0 -59
  198. package/data/script-api/dw.crypto.CertificateUtils.md +0 -162
  199. package/data/script-api/dw.crypto.Cipher.md +0 -1234
  200. package/data/script-api/dw.crypto.Encoding.md +0 -193
  201. package/data/script-api/dw.crypto.JWE.md +0 -245
  202. package/data/script-api/dw.crypto.JWEHeader.md +0 -147
  203. package/data/script-api/dw.crypto.JWS.md +0 -260
  204. package/data/script-api/dw.crypto.JWSHeader.md +0 -128
  205. package/data/script-api/dw.crypto.KeyRef.md +0 -77
  206. package/data/script-api/dw.crypto.Mac.md +0 -191
  207. package/data/script-api/dw.crypto.MessageDigest.md +0 -243
  208. package/data/script-api/dw.crypto.SecureRandom.md +0 -161
  209. package/data/script-api/dw.crypto.Signature.md +0 -241
  210. package/data/script-api/dw.crypto.WeakCipher.md +0 -725
  211. package/data/script-api/dw.crypto.WeakMac.md +0 -163
  212. package/data/script-api/dw.crypto.WeakMessageDigest.md +0 -220
  213. package/data/script-api/dw.crypto.WeakSignature.md +0 -208
  214. package/data/script-api/dw.crypto.X509Certificate.md +0 -180
  215. package/data/script-api/dw.crypto.md +0 -23
  216. package/data/script-api/dw.customer.AddressBook.md +0 -158
  217. package/data/script-api/dw.customer.AgentUserMgr.md +0 -94
  218. package/data/script-api/dw.customer.AgentUserStatusCodes.md +0 -164
  219. package/data/script-api/dw.customer.AuthenticationStatus.md +0 -157
  220. package/data/script-api/dw.customer.Credentials.md +0 -524
  221. package/data/script-api/dw.customer.Customer.md +0 -488
  222. package/data/script-api/dw.customer.CustomerActiveData.md +0 -563
  223. package/data/script-api/dw.customer.CustomerAddress.md +0 -666
  224. package/data/script-api/dw.customer.CustomerCDPData.md +0 -70
  225. package/data/script-api/dw.customer.CustomerContextMgr.md +0 -62
  226. package/data/script-api/dw.customer.CustomerGroup.md +0 -146
  227. package/data/script-api/dw.customer.CustomerList.md +0 -76
  228. package/data/script-api/dw.customer.CustomerMgr.md +0 -1046
  229. package/data/script-api/dw.customer.CustomerPasswordConstraints.md +0 -125
  230. package/data/script-api/dw.customer.CustomerPaymentInstrument.md +0 -161
  231. package/data/script-api/dw.customer.CustomerStatusCodes.md +0 -55
  232. package/data/script-api/dw.customer.EncryptedObject.md +0 -34
  233. package/data/script-api/dw.customer.ExternalProfile.md +0 -154
  234. package/data/script-api/dw.customer.OrderHistory.md +0 -167
  235. package/data/script-api/dw.customer.ProductList.md +0 -870
  236. package/data/script-api/dw.customer.ProductListItem.md +0 -469
  237. package/data/script-api/dw.customer.ProductListItemPurchase.md +0 -139
  238. package/data/script-api/dw.customer.ProductListMgr.md +0 -350
  239. package/data/script-api/dw.customer.ProductListRegistrant.md +0 -165
  240. package/data/script-api/dw.customer.Profile.md +0 -940
  241. package/data/script-api/dw.customer.Wallet.md +0 -136
  242. package/data/script-api/dw.customer.consent.ConsentStatusEntry.md +0 -92
  243. package/data/script-api/dw.customer.consent.MarketingConsentSubscription.md +0 -247
  244. package/data/script-api/dw.customer.consent.ShopperConsentErrorCodes.md +0 -74
  245. package/data/script-api/dw.customer.consent.ShopperConsentException.md +0 -63
  246. package/data/script-api/dw.customer.consent.ShopperConsentMgr.md +0 -152
  247. package/data/script-api/dw.customer.consent.md +0 -10
  248. package/data/script-api/dw.customer.md +0 -31
  249. package/data/script-api/dw.customer.oauth.OAuthAccessTokenResponse.md +0 -171
  250. package/data/script-api/dw.customer.oauth.OAuthFinalizedResponse.md +0 -75
  251. package/data/script-api/dw.customer.oauth.OAuthLoginFlowMgr.md +0 -165
  252. package/data/script-api/dw.customer.oauth.OAuthUserInfoResponse.md +0 -84
  253. package/data/script-api/dw.customer.oauth.md +0 -9
  254. package/data/script-api/dw.customer.shoppercontext.ShopperContext.md +0 -369
  255. package/data/script-api/dw.customer.shoppercontext.ShopperContextErrorCodes.md +0 -111
  256. package/data/script-api/dw.customer.shoppercontext.ShopperContextException.md +0 -77
  257. package/data/script-api/dw.customer.shoppercontext.ShopperContextMgr.md +0 -209
  258. package/data/script-api/dw.customer.shoppercontext.md +0 -9
  259. package/data/script-api/dw.experience.AspectAttributeValidationException.md +0 -25
  260. package/data/script-api/dw.experience.Component.md +0 -166
  261. package/data/script-api/dw.experience.ComponentRenderSettings.md +0 -130
  262. package/data/script-api/dw.experience.ComponentScriptContext.md +0 -148
  263. package/data/script-api/dw.experience.CustomEditor.md +0 -146
  264. package/data/script-api/dw.experience.CustomEditorResources.md +0 -100
  265. package/data/script-api/dw.experience.Page.md +0 -467
  266. package/data/script-api/dw.experience.PageMgr.md +0 -549
  267. package/data/script-api/dw.experience.PageScriptContext.md +0 -200
  268. package/data/script-api/dw.experience.Region.md +0 -119
  269. package/data/script-api/dw.experience.RegionRenderSettings.md +0 -207
  270. package/data/script-api/dw.experience.cms.CMSRecord.md +0 -125
  271. package/data/script-api/dw.experience.cms.md +0 -6
  272. package/data/script-api/dw.experience.image.FocalPoint.md +0 -71
  273. package/data/script-api/dw.experience.image.Image.md +0 -101
  274. package/data/script-api/dw.experience.image.ImageMetaData.md +0 -71
  275. package/data/script-api/dw.experience.image.md +0 -8
  276. package/data/script-api/dw.experience.md +0 -16
  277. package/data/script-api/dw.extensions.applepay.ApplePayHookResult.md +0 -254
  278. package/data/script-api/dw.extensions.applepay.ApplePayHooks.md +0 -572
  279. package/data/script-api/dw.extensions.applepay.md +0 -7
  280. package/data/script-api/dw.extensions.facebook.FacebookFeedHooks.md +0 -102
  281. package/data/script-api/dw.extensions.facebook.FacebookProduct.md +0 -1343
  282. package/data/script-api/dw.extensions.facebook.md +0 -7
  283. package/data/script-api/dw.extensions.paymentapi.PaymentApiHooks.md +0 -136
  284. package/data/script-api/dw.extensions.paymentapi.md +0 -6
  285. package/data/script-api/dw.extensions.paymentrequest.PaymentRequestHookResult.md +0 -149
  286. package/data/script-api/dw.extensions.paymentrequest.PaymentRequestHooks.md +0 -356
  287. package/data/script-api/dw.extensions.paymentrequest.md +0 -7
  288. package/data/script-api/dw.extensions.payments.SalesforceAdyenPaymentIntent.md +0 -134
  289. package/data/script-api/dw.extensions.payments.SalesforceAdyenSavedPaymentMethod.md +0 -283
  290. package/data/script-api/dw.extensions.payments.SalesforceBancontactPaymentDetails.md +0 -88
  291. package/data/script-api/dw.extensions.payments.SalesforceCardPaymentDetails.md +0 -107
  292. package/data/script-api/dw.extensions.payments.SalesforceEpsPaymentDetails.md +0 -63
  293. package/data/script-api/dw.extensions.payments.SalesforceIdealPaymentDetails.md +0 -63
  294. package/data/script-api/dw.extensions.payments.SalesforceKlarnaPaymentDetails.md +0 -63
  295. package/data/script-api/dw.extensions.payments.SalesforcePayPalOrder.md +0 -263
  296. package/data/script-api/dw.extensions.payments.SalesforcePayPalOrderAddress.md +0 -171
  297. package/data/script-api/dw.extensions.payments.SalesforcePayPalOrderPayer.md +0 -110
  298. package/data/script-api/dw.extensions.payments.SalesforcePayPalPaymentDetails.md +0 -88
  299. package/data/script-api/dw.extensions.payments.SalesforcePaymentDetails.md +0 -83
  300. package/data/script-api/dw.extensions.payments.SalesforcePaymentIntent.md +0 -273
  301. package/data/script-api/dw.extensions.payments.SalesforcePaymentMethod.md +0 -368
  302. package/data/script-api/dw.extensions.payments.SalesforcePaymentRequest.md +0 -1077
  303. package/data/script-api/dw.extensions.payments.SalesforcePaymentsHooks.md +0 -190
  304. package/data/script-api/dw.extensions.payments.SalesforcePaymentsMerchantAccount.md +0 -151
  305. package/data/script-api/dw.extensions.payments.SalesforcePaymentsMerchantAccountPaymentMethod.md +0 -98
  306. package/data/script-api/dw.extensions.payments.SalesforcePaymentsMgr.md +0 -989
  307. package/data/script-api/dw.extensions.payments.SalesforcePaymentsSiteConfiguration.md +0 -202
  308. package/data/script-api/dw.extensions.payments.SalesforcePaymentsZone.md +0 -393
  309. package/data/script-api/dw.extensions.payments.SalesforceSepaDebitPaymentDetails.md +0 -63
  310. package/data/script-api/dw.extensions.payments.SalesforceVenmoPaymentDetails.md +0 -88
  311. package/data/script-api/dw.extensions.payments.md +0 -28
  312. package/data/script-api/dw.extensions.pinterest.PinterestAvailability.md +0 -85
  313. package/data/script-api/dw.extensions.pinterest.PinterestFeedHooks.md +0 -118
  314. package/data/script-api/dw.extensions.pinterest.PinterestOrder.md +0 -263
  315. package/data/script-api/dw.extensions.pinterest.PinterestOrderHooks.md +0 -89
  316. package/data/script-api/dw.extensions.pinterest.PinterestProduct.md +0 -677
  317. package/data/script-api/dw.extensions.pinterest.md +0 -10
  318. package/data/script-api/dw.io.CSVStreamReader.md +0 -128
  319. package/data/script-api/dw.io.CSVStreamWriter.md +0 -92
  320. package/data/script-api/dw.io.File.md +0 -729
  321. package/data/script-api/dw.io.FileReader.md +0 -70
  322. package/data/script-api/dw.io.FileWriter.md +0 -159
  323. package/data/script-api/dw.io.InputStream.md +0 -35
  324. package/data/script-api/dw.io.OutputStream.md +0 -38
  325. package/data/script-api/dw.io.PrintWriter.md +0 -66
  326. package/data/script-api/dw.io.RandomAccessFileReader.md +0 -183
  327. package/data/script-api/dw.io.Reader.md +0 -284
  328. package/data/script-api/dw.io.StringWriter.md +0 -89
  329. package/data/script-api/dw.io.Writer.md +0 -96
  330. package/data/script-api/dw.io.XMLIndentingStreamWriter.md +0 -121
  331. package/data/script-api/dw.io.XMLStreamConstants.md +0 -172
  332. package/data/script-api/dw.io.XMLStreamReader.md +0 -1181
  333. package/data/script-api/dw.io.XMLStreamWriter.md +0 -478
  334. package/data/script-api/dw.io.md +0 -21
  335. package/data/script-api/dw.job.JobExecution.md +0 -111
  336. package/data/script-api/dw.job.JobStepExecution.md +0 -136
  337. package/data/script-api/dw.job.md +0 -7
  338. package/data/script-api/dw.net.FTPClient.md +0 -621
  339. package/data/script-api/dw.net.FTPFileInfo.md +0 -132
  340. package/data/script-api/dw.net.HTTPClient.md +0 -775
  341. package/data/script-api/dw.net.HTTPClientLoggingConfig.md +0 -363
  342. package/data/script-api/dw.net.HTTPRequestPart.md +0 -296
  343. package/data/script-api/dw.net.Mail.md +0 -487
  344. package/data/script-api/dw.net.SFTPClient.md +0 -535
  345. package/data/script-api/dw.net.SFTPFileInfo.md +0 -128
  346. package/data/script-api/dw.net.WebDAVClient.md +0 -762
  347. package/data/script-api/dw.net.WebDAVFileInfo.md +0 -163
  348. package/data/script-api/dw.net.md +0 -15
  349. package/data/script-api/dw.object.ActiveData.md +0 -86
  350. package/data/script-api/dw.object.CustomAttributes.md +0 -165
  351. package/data/script-api/dw.object.CustomObject.md +0 -82
  352. package/data/script-api/dw.object.CustomObjectMgr.md +0 -478
  353. package/data/script-api/dw.object.Extensible.md +0 -71
  354. package/data/script-api/dw.object.ExtensibleObject.md +0 -85
  355. package/data/script-api/dw.object.Note.md +0 -118
  356. package/data/script-api/dw.object.ObjectAttributeDefinition.md +0 -542
  357. package/data/script-api/dw.object.ObjectAttributeGroup.md +0 -160
  358. package/data/script-api/dw.object.ObjectAttributeValueDefinition.md +0 -78
  359. package/data/script-api/dw.object.ObjectTypeDefinition.md +0 -239
  360. package/data/script-api/dw.object.PersistentObject.md +0 -92
  361. package/data/script-api/dw.object.SimpleExtensible.md +0 -53
  362. package/data/script-api/dw.object.SystemObjectMgr.md +0 -520
  363. package/data/script-api/dw.object.md +0 -19
  364. package/data/script-api/dw.order.AbstractItem.md +0 -220
  365. package/data/script-api/dw.order.AbstractItemCtnr.md +0 -219
  366. package/data/script-api/dw.order.Appeasement.md +0 -398
  367. package/data/script-api/dw.order.AppeasementItem.md +0 -104
  368. package/data/script-api/dw.order.Basket.md +0 -868
  369. package/data/script-api/dw.order.BasketMgr.md +0 -673
  370. package/data/script-api/dw.order.BonusDiscountLineItem.md +0 -309
  371. package/data/script-api/dw.order.CouponLineItem.md +0 -289
  372. package/data/script-api/dw.order.CreateAgentBasketLimitExceededException.md +0 -35
  373. package/data/script-api/dw.order.CreateBasketFromOrderException.md +0 -54
  374. package/data/script-api/dw.order.CreateCouponLineItemException.md +0 -67
  375. package/data/script-api/dw.order.CreateOrderException.md +0 -23
  376. package/data/script-api/dw.order.CreateTemporaryBasketLimitExceededException.md +0 -35
  377. package/data/script-api/dw.order.GiftCertificate.md +0 -530
  378. package/data/script-api/dw.order.GiftCertificateLineItem.md +0 -292
  379. package/data/script-api/dw.order.GiftCertificateMgr.md +0 -228
  380. package/data/script-api/dw.order.GiftCertificateStatusCodes.md +0 -108
  381. package/data/script-api/dw.order.Invoice.md +0 -571
  382. package/data/script-api/dw.order.InvoiceItem.md +0 -199
  383. package/data/script-api/dw.order.LineItem.md +0 -577
  384. package/data/script-api/dw.order.LineItemCtnr.md +0 -2429
  385. package/data/script-api/dw.order.LineItemTax.md +0 -142
  386. package/data/script-api/dw.order.Order.md +0 -2770
  387. package/data/script-api/dw.order.OrderAddress.md +0 -624
  388. package/data/script-api/dw.order.OrderItem.md +0 -613
  389. package/data/script-api/dw.order.OrderMgr.md +0 -1502
  390. package/data/script-api/dw.order.OrderPaymentInstrument.md +0 -231
  391. package/data/script-api/dw.order.OrderProcessStatusCodes.md +0 -146
  392. package/data/script-api/dw.order.PaymentCard.md +0 -220
  393. package/data/script-api/dw.order.PaymentInstrument.md +0 -1416
  394. package/data/script-api/dw.order.PaymentMethod.md +0 -257
  395. package/data/script-api/dw.order.PaymentMgr.md +0 -138
  396. package/data/script-api/dw.order.PaymentProcessor.md +0 -106
  397. package/data/script-api/dw.order.PaymentStatusCodes.md +0 -70
  398. package/data/script-api/dw.order.PaymentTransaction.md +0 -291
  399. package/data/script-api/dw.order.PriceAdjustment.md +0 -745
  400. package/data/script-api/dw.order.PriceAdjustmentLimitTypes.md +0 -61
  401. package/data/script-api/dw.order.ProductLineItem.md +0 -1749
  402. package/data/script-api/dw.order.ProductShippingCost.md +0 -101
  403. package/data/script-api/dw.order.ProductShippingLineItem.md +0 -336
  404. package/data/script-api/dw.order.ProductShippingModel.md +0 -143
  405. package/data/script-api/dw.order.Return.md +0 -396
  406. package/data/script-api/dw.order.ReturnCase.md +0 -463
  407. package/data/script-api/dw.order.ReturnCaseItem.md +0 -372
  408. package/data/script-api/dw.order.ReturnItem.md +0 -335
  409. package/data/script-api/dw.order.Shipment.md +0 -1132
  410. package/data/script-api/dw.order.ShipmentShippingCost.md +0 -54
  411. package/data/script-api/dw.order.ShipmentShippingModel.md +0 -203
  412. package/data/script-api/dw.order.ShippingLineItem.md +0 -315
  413. package/data/script-api/dw.order.ShippingLocation.md +0 -313
  414. package/data/script-api/dw.order.ShippingMethod.md +0 -251
  415. package/data/script-api/dw.order.ShippingMgr.md +0 -173
  416. package/data/script-api/dw.order.ShippingOrder.md +0 -630
  417. package/data/script-api/dw.order.ShippingOrderItem.md +0 -425
  418. package/data/script-api/dw.order.SumItem.md +0 -158
  419. package/data/script-api/dw.order.TaxGroup.md +0 -128
  420. package/data/script-api/dw.order.TaxItem.md +0 -74
  421. package/data/script-api/dw.order.TaxMgr.md +0 -314
  422. package/data/script-api/dw.order.TrackingInfo.md +0 -261
  423. package/data/script-api/dw.order.TrackingRef.md +0 -108
  424. package/data/script-api/dw.order.hooks.BasketMergeHooks.md +0 -87
  425. package/data/script-api/dw.order.hooks.CalculateHooks.md +0 -139
  426. package/data/script-api/dw.order.hooks.CheckoutHooks.md +0 -88
  427. package/data/script-api/dw.order.hooks.OrderHooks.md +0 -96
  428. package/data/script-api/dw.order.hooks.PaymentHooks.md +0 -325
  429. package/data/script-api/dw.order.hooks.ReturnHooks.md +0 -395
  430. package/data/script-api/dw.order.hooks.ShippingOrderHooks.md +0 -426
  431. package/data/script-api/dw.order.hooks.TaxHooks.md +0 -495
  432. package/data/script-api/dw.order.hooks.md +0 -13
  433. package/data/script-api/dw.order.md +0 -65
  434. package/data/script-api/dw.rpc.SOAPUtil.md +0 -736
  435. package/data/script-api/dw.rpc.Stub.md +0 -373
  436. package/data/script-api/dw.rpc.WebReference.md +0 -133
  437. package/data/script-api/dw.rpc.md +0 -8
  438. package/data/script-api/dw.sitemap.SitemapFile.md +0 -137
  439. package/data/script-api/dw.sitemap.SitemapMgr.md +0 -165
  440. package/data/script-api/dw.sitemap.md +0 -7
  441. package/data/script-api/dw.suggest.BrandSuggestions.md +0 -34
  442. package/data/script-api/dw.suggest.CategorySuggestions.md +0 -76
  443. package/data/script-api/dw.suggest.ContentSuggestions.md +0 -76
  444. package/data/script-api/dw.suggest.CustomSuggestions.md +0 -34
  445. package/data/script-api/dw.suggest.ProductSuggestions.md +0 -76
  446. package/data/script-api/dw.suggest.SearchPhraseSuggestions.md +0 -126
  447. package/data/script-api/dw.suggest.SuggestModel.md +0 -471
  448. package/data/script-api/dw.suggest.SuggestedCategory.md +0 -51
  449. package/data/script-api/dw.suggest.SuggestedContent.md +0 -51
  450. package/data/script-api/dw.suggest.SuggestedPhrase.md +0 -70
  451. package/data/script-api/dw.suggest.SuggestedProduct.md +0 -55
  452. package/data/script-api/dw.suggest.SuggestedTerm.md +0 -143
  453. package/data/script-api/dw.suggest.SuggestedTerms.md +0 -144
  454. package/data/script-api/dw.suggest.Suggestions.md +0 -206
  455. package/data/script-api/dw.suggest.md +0 -19
  456. package/data/script-api/dw.svc.FTPService.md +0 -140
  457. package/data/script-api/dw.svc.FTPServiceDefinition.md +0 -97
  458. package/data/script-api/dw.svc.HTTPFormService.md +0 -32
  459. package/data/script-api/dw.svc.HTTPFormServiceDefinition.md +0 -36
  460. package/data/script-api/dw.svc.HTTPService.md +0 -370
  461. package/data/script-api/dw.svc.HTTPServiceDefinition.md +0 -290
  462. package/data/script-api/dw.svc.LocalServiceRegistry.md +0 -63
  463. package/data/script-api/dw.svc.Result.md +0 -320
  464. package/data/script-api/dw.svc.SOAPService.md +0 -104
  465. package/data/script-api/dw.svc.SOAPServiceDefinition.md +0 -32
  466. package/data/script-api/dw.svc.Service.md +0 -276
  467. package/data/script-api/dw.svc.ServiceCallback.md +0 -282
  468. package/data/script-api/dw.svc.ServiceConfig.md +0 -114
  469. package/data/script-api/dw.svc.ServiceCredential.md +0 -162
  470. package/data/script-api/dw.svc.ServiceDefinition.md +0 -211
  471. package/data/script-api/dw.svc.ServiceProfile.md +0 -152
  472. package/data/script-api/dw.svc.ServiceRegistry.md +0 -118
  473. package/data/script-api/dw.svc.md +0 -22
  474. package/data/script-api/dw.system.AgentUserStatusCodes.md +0 -41
  475. package/data/script-api/dw.system.Cache.md +0 -126
  476. package/data/script-api/dw.system.CacheMgr.md +0 -70
  477. package/data/script-api/dw.system.HookMgr.md +0 -78
  478. package/data/script-api/dw.system.InternalObject.md +0 -47
  479. package/data/script-api/dw.system.JobProcessMonitor.md +0 -103
  480. package/data/script-api/dw.system.Log.md +0 -198
  481. package/data/script-api/dw.system.LogNDC.md +0 -75
  482. package/data/script-api/dw.system.Logger.md +0 -216
  483. package/data/script-api/dw.system.OrganizationPreferences.md +0 -53
  484. package/data/script-api/dw.system.Pipeline.md +0 -94
  485. package/data/script-api/dw.system.PipelineDictionary.md +0 -42
  486. package/data/script-api/dw.system.RESTErrorResponse.md +0 -102
  487. package/data/script-api/dw.system.RESTResponseMgr.md +0 -243
  488. package/data/script-api/dw.system.RESTSuccessResponse.md +0 -62
  489. package/data/script-api/dw.system.RemoteInclude.md +0 -146
  490. package/data/script-api/dw.system.Request.md +0 -785
  491. package/data/script-api/dw.system.RequestHooks.md +0 -112
  492. package/data/script-api/dw.system.Response.md +0 -612
  493. package/data/script-api/dw.system.SearchStatus.md +0 -187
  494. package/data/script-api/dw.system.Session.md +0 -469
  495. package/data/script-api/dw.system.Site.md +0 -570
  496. package/data/script-api/dw.system.SitePreferences.md +0 -90
  497. package/data/script-api/dw.system.Status.md +0 -330
  498. package/data/script-api/dw.system.StatusItem.md +0 -273
  499. package/data/script-api/dw.system.System.md +0 -224
  500. package/data/script-api/dw.system.Transaction.md +0 -107
  501. package/data/script-api/dw.system.md +0 -32
  502. package/data/script-api/dw.template.ISML.md +0 -127
  503. package/data/script-api/dw.template.Velocity.md +0 -168
  504. package/data/script-api/dw.template.md +0 -7
  505. package/data/script-api/dw.util.ArrayList.md +0 -99
  506. package/data/script-api/dw.util.Assert.md +0 -370
  507. package/data/script-api/dw.util.BigInteger.md +0 -283
  508. package/data/script-api/dw.util.Bytes.md +0 -278
  509. package/data/script-api/dw.util.Calendar.md +0 -1051
  510. package/data/script-api/dw.util.Collection.md +0 -272
  511. package/data/script-api/dw.util.Currency.md +0 -147
  512. package/data/script-api/dw.util.DateUtils.md +0 -82
  513. package/data/script-api/dw.util.Decimal.md +0 -386
  514. package/data/script-api/dw.util.FilteringCollection.md +0 -140
  515. package/data/script-api/dw.util.Geolocation.md +0 -293
  516. package/data/script-api/dw.util.HashMap.md +0 -50
  517. package/data/script-api/dw.util.HashSet.md +0 -65
  518. package/data/script-api/dw.util.Iterator.md +0 -86
  519. package/data/script-api/dw.util.LinkedHashMap.md +0 -52
  520. package/data/script-api/dw.util.LinkedHashSet.md +0 -68
  521. package/data/script-api/dw.util.List.md +0 -429
  522. package/data/script-api/dw.util.Locale.md +0 -277
  523. package/data/script-api/dw.util.Map.md +0 -251
  524. package/data/script-api/dw.util.MapEntry.md +0 -68
  525. package/data/script-api/dw.util.MappingKey.md +0 -96
  526. package/data/script-api/dw.util.MappingMgr.md +0 -113
  527. package/data/script-api/dw.util.PropertyComparator.md +0 -122
  528. package/data/script-api/dw.util.SecureEncoder.md +0 -582
  529. package/data/script-api/dw.util.SecureFilter.md +0 -572
  530. package/data/script-api/dw.util.SeekableIterator.md +0 -187
  531. package/data/script-api/dw.util.Set.md +0 -39
  532. package/data/script-api/dw.util.SortedMap.md +0 -148
  533. package/data/script-api/dw.util.SortedSet.md +0 -173
  534. package/data/script-api/dw.util.StringUtils.md +0 -655
  535. package/data/script-api/dw.util.Template.md +0 -141
  536. package/data/script-api/dw.util.UUIDUtils.md +0 -34
  537. package/data/script-api/dw.util.md +0 -37
  538. package/data/script-api/dw.value.EnumValue.md +0 -105
  539. package/data/script-api/dw.value.MimeEncodedText.md +0 -131
  540. package/data/script-api/dw.value.Money.md +0 -526
  541. package/data/script-api/dw.value.Quantity.md +0 -299
  542. package/data/script-api/dw.value.md +0 -9
  543. package/data/script-api/dw.web.CSRFProtection.md +0 -105
  544. package/data/script-api/dw.web.ClickStream.md +0 -177
  545. package/data/script-api/dw.web.ClickStreamEntry.md +0 -255
  546. package/data/script-api/dw.web.Cookie.md +0 -431
  547. package/data/script-api/dw.web.Cookies.md +0 -59
  548. package/data/script-api/dw.web.Form.md +0 -84
  549. package/data/script-api/dw.web.FormAction.md +0 -195
  550. package/data/script-api/dw.web.FormElement.md +0 -211
  551. package/data/script-api/dw.web.FormElementValidationResult.md +0 -170
  552. package/data/script-api/dw.web.FormField.md +0 -642
  553. package/data/script-api/dw.web.FormFieldOption.md +0 -211
  554. package/data/script-api/dw.web.FormFieldOptions.md +0 -49
  555. package/data/script-api/dw.web.FormGroup.md +0 -222
  556. package/data/script-api/dw.web.FormList.md +0 -134
  557. package/data/script-api/dw.web.FormListItem.md +0 -57
  558. package/data/script-api/dw.web.Forms.md +0 -25
  559. package/data/script-api/dw.web.HttpParameter.md +0 -462
  560. package/data/script-api/dw.web.HttpParameterMap.md +0 -194
  561. package/data/script-api/dw.web.LoopIterator.md +0 -231
  562. package/data/script-api/dw.web.PageMetaData.md +0 -197
  563. package/data/script-api/dw.web.PageMetaTag.md +0 -173
  564. package/data/script-api/dw.web.PagingModel.md +0 -407
  565. package/data/script-api/dw.web.Resource.md +0 -147
  566. package/data/script-api/dw.web.URL.md +0 -174
  567. package/data/script-api/dw.web.URLAction.md +0 -95
  568. package/data/script-api/dw.web.URLParameter.md +0 -52
  569. package/data/script-api/dw.web.URLRedirect.md +0 -72
  570. package/data/script-api/dw.web.URLRedirectMgr.md +0 -86
  571. package/data/script-api/dw.web.URLUtils.md +0 -1357
  572. package/data/script-api/dw.web.md +0 -34
  573. package/data/script-api/dw.ws.Port.md +0 -126
  574. package/data/script-api/dw.ws.WSUtil.md +0 -728
  575. package/data/script-api/dw.ws.WebReference2.md +0 -137
  576. package/data/script-api/dw.ws.md +0 -8
  577. package/data/script-api/index.md +0 -40
@@ -1,101 +0,0 @@
1
- <!-- prettier-ignore-start -->
2
- # Class ProductShippingCost
3
-
4
- - [TopLevel.Object](TopLevel.Object.md)
5
- - [dw.order.ProductShippingCost](dw.order.ProductShippingCost.md)
6
-
7
- Instances of ProductShippingCost represent product specific shipping costs.
8
-
9
-
10
-
11
- Use [ProductShippingModel.getShippingCost(ShippingMethod)](dw.order.ProductShippingModel.md#getshippingcostshippingmethod) to get
12
- the shipping cost for a specific product.
13
-
14
-
15
-
16
- ## Property Summary
17
-
18
- | Property | Description |
19
- | --- | --- |
20
- | [amount](#amount): [Money](dw.value.Money.md) `(read-only)` | Returns the shipping amount. |
21
- | [fixedPrice](#fixedprice): [Boolean](TopLevel.Boolean.md) `(read-only)` | Returns true if shipping cost is a fixed-price shipping cost, and false if surcharge shipping cost. |
22
- | [surcharge](#surcharge): [Boolean](TopLevel.Boolean.md) `(read-only)` | Returns true if shipping cost is a surcharge to the shipment shipping cost, and false if fixed-price shipping cost. |
23
-
24
- ## Constructor Summary
25
-
26
- This class does not have a constructor, so you cannot create it directly.
27
- ## Method Summary
28
-
29
- | Method | Description |
30
- | --- | --- |
31
- | [getAmount](dw.order.ProductShippingCost.md#getamount)() | Returns the shipping amount. |
32
- | [isFixedPrice](dw.order.ProductShippingCost.md#isfixedprice)() | Returns true if shipping cost is a fixed-price shipping cost, and false if surcharge shipping cost. |
33
- | [isSurcharge](dw.order.ProductShippingCost.md#issurcharge)() | Returns true if shipping cost is a surcharge to the shipment shipping cost, and false if fixed-price shipping cost. |
34
-
35
- ### Methods inherited from class Object
36
-
37
- [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)
38
- ## Property Details
39
-
40
- ### amount
41
- - amount: [Money](dw.value.Money.md) `(read-only)`
42
- - : Returns the shipping amount.
43
-
44
-
45
- ---
46
-
47
- ### fixedPrice
48
- - fixedPrice: [Boolean](TopLevel.Boolean.md) `(read-only)`
49
- - : Returns true if shipping cost is a fixed-price shipping cost,
50
- and false if surcharge shipping cost.
51
-
52
-
53
-
54
- ---
55
-
56
- ### surcharge
57
- - surcharge: [Boolean](TopLevel.Boolean.md) `(read-only)`
58
- - : Returns true if shipping cost is a surcharge to the shipment
59
- shipping cost, and false if fixed-price shipping cost.
60
-
61
-
62
-
63
- ---
64
-
65
- ## Method Details
66
-
67
- ### getAmount()
68
- - getAmount(): [Money](dw.value.Money.md)
69
- - : Returns the shipping amount.
70
-
71
- **Returns:**
72
- - Shipping amount
73
-
74
-
75
- ---
76
-
77
- ### isFixedPrice()
78
- - isFixedPrice(): [Boolean](TopLevel.Boolean.md)
79
- - : Returns true if shipping cost is a fixed-price shipping cost,
80
- and false if surcharge shipping cost.
81
-
82
-
83
- **Returns:**
84
- - true of fixed-price shipping cost, else false
85
-
86
-
87
- ---
88
-
89
- ### isSurcharge()
90
- - isSurcharge(): [Boolean](TopLevel.Boolean.md)
91
- - : Returns true if shipping cost is a surcharge to the shipment
92
- shipping cost, and false if fixed-price shipping cost.
93
-
94
-
95
- **Returns:**
96
- - true of surcharge shipping cost, else false
97
-
98
-
99
- ---
100
-
101
- <!-- prettier-ignore-end -->
@@ -1,336 +0,0 @@
1
- <!-- prettier-ignore-start -->
2
- # Class ProductShippingLineItem
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.order.LineItem](dw.order.LineItem.md)
8
- - [dw.order.ProductShippingLineItem](dw.order.ProductShippingLineItem.md)
9
-
10
- Represents a specific line item in a shipment. A ProductShippingLineItem defines
11
- lineitem-specific shipping costs.
12
-
13
-
14
-
15
- ## Constant Summary
16
-
17
- | Constant | Description |
18
- | --- | --- |
19
- | ~~[PRODUCT_SHIPPING_ID](#product_shipping_id): [String](TopLevel.String.md) = "PRODUCT_SHIPPING"~~ | Reserved constant. |
20
-
21
- ## Property Summary
22
-
23
- | Property | Description |
24
- | --- | --- |
25
- | [adjustedGrossPrice](#adjustedgrossprice): [Money](dw.value.Money.md) `(read-only)` | Returns the gross price of the product shipping line item after applying all product-shipping-level adjustments. |
26
- | [adjustedNetPrice](#adjustednetprice): [Money](dw.value.Money.md) `(read-only)` | Returns the net price of the product shipping line item after applying all product-shipping-level adjustments. |
27
- | [adjustedPrice](#adjustedprice): [Money](dw.value.Money.md) `(read-only)` | Returns the price of the product shipping line item after applying all pproduct-shipping-level adjustments. |
28
- | [adjustedTax](#adjustedtax): [Money](dw.value.Money.md) `(read-only)` | Returns the tax of the unit after applying adjustments, in the purchase currency. |
29
- | [priceAdjustments](#priceadjustments): [Collection](dw.util.Collection.md) `(read-only)` | Returns an iterator of price adjustments that have been applied to this product shipping line item. |
30
- | [productLineItem](#productlineitem): [ProductLineItem](dw.order.ProductLineItem.md) `(read-only)` | Returns the parent product line item this shipping line item belongs to. |
31
- | [quantity](#quantity): [Quantity](dw.value.Quantity.md) | Returns the quantity of the shipping cost. |
32
- | [shipment](#shipment): [Shipment](dw.order.Shipment.md) `(read-only)` | Returns the shipment this shipping line item belongs to. |
33
- | [surcharge](#surcharge): [Boolean](TopLevel.Boolean.md) | Returns the 'surcharge' flag. |
34
-
35
- ## Constructor Summary
36
-
37
- This class does not have a constructor, so you cannot create it directly.
38
- ## Method Summary
39
-
40
- | Method | Description |
41
- | --- | --- |
42
- | [getAdjustedGrossPrice](dw.order.ProductShippingLineItem.md#getadjustedgrossprice)() | Returns the gross price of the product shipping line item after applying all product-shipping-level adjustments. |
43
- | [getAdjustedNetPrice](dw.order.ProductShippingLineItem.md#getadjustednetprice)() | Returns the net price of the product shipping line item after applying all product-shipping-level adjustments. |
44
- | [getAdjustedPrice](dw.order.ProductShippingLineItem.md#getadjustedprice)() | Returns the price of the product shipping line item after applying all pproduct-shipping-level adjustments. |
45
- | [getAdjustedTax](dw.order.ProductShippingLineItem.md#getadjustedtax)() | Returns the tax of the unit after applying adjustments, in the purchase currency. |
46
- | [getPriceAdjustments](dw.order.ProductShippingLineItem.md#getpriceadjustments)() | Returns an iterator of price adjustments that have been applied to this product shipping line item. |
47
- | [getProductLineItem](dw.order.ProductShippingLineItem.md#getproductlineitem)() | Returns the parent product line item this shipping line item belongs to. |
48
- | [getQuantity](dw.order.ProductShippingLineItem.md#getquantity)() | Returns the quantity of the shipping cost. |
49
- | [getShipment](dw.order.ProductShippingLineItem.md#getshipment)() | Returns the shipment this shipping line item belongs to. |
50
- | [isSurcharge](dw.order.ProductShippingLineItem.md#issurcharge)() | Returns the 'surcharge' flag. |
51
- | [setPriceValue](dw.order.ProductShippingLineItem.md#setpricevaluenumber)([Number](TopLevel.Number.md)) | Sets price attributes of the line item based on the purchase currency, taxation policy and line item quantity.<br/> The method sets the 'basePrice' attribute of the line item. |
52
- | [setQuantity](dw.order.ProductShippingLineItem.md#setquantityquantity)([Quantity](dw.value.Quantity.md)) | Sets the quantity of the shipping cost. |
53
- | [setSurcharge](dw.order.ProductShippingLineItem.md#setsurchargeboolean)([Boolean](TopLevel.Boolean.md)) | Sets the 'surcharge' flag. |
54
-
55
- ### Methods inherited from class LineItem
56
-
57
- [getBasePrice](dw.order.LineItem.md#getbaseprice), [getGrossPrice](dw.order.LineItem.md#getgrossprice), [getLineItemCtnr](dw.order.LineItem.md#getlineitemctnr), [getLineItemText](dw.order.LineItem.md#getlineitemtext), [getNetPrice](dw.order.LineItem.md#getnetprice), [getPrice](dw.order.LineItem.md#getprice), [getPriceValue](dw.order.LineItem.md#getpricevalue), [getTax](dw.order.LineItem.md#gettax), [getTaxBasis](dw.order.LineItem.md#gettaxbasis), [getTaxClassID](dw.order.LineItem.md#gettaxclassid), [getTaxRate](dw.order.LineItem.md#gettaxrate), [getTaxes](dw.order.LineItem.md#gettaxes), [setBasePrice](dw.order.LineItem.md#setbasepricemoney), [setGrossPrice](dw.order.LineItem.md#setgrosspricemoney), [setLineItemText](dw.order.LineItem.md#setlineitemtextstring), [setNetPrice](dw.order.LineItem.md#setnetpricemoney), [setPriceValue](dw.order.LineItem.md#setpricevaluenumber), [setTax](dw.order.LineItem.md#settaxmoney), [setTaxClassID](dw.order.LineItem.md#settaxclassidstring), [setTaxRate](dw.order.LineItem.md#settaxratenumber), [setTaxes](dw.order.LineItem.md#settaxescollection), [updatePrice](dw.order.LineItem.md#updatepricemoney), [updateTax](dw.order.LineItem.md#updatetaxnumber), [updateTax](dw.order.LineItem.md#updatetaxnumber-money), [updateTaxAmount](dw.order.LineItem.md#updatetaxamountmoney)
58
- ### Methods inherited from class ExtensibleObject
59
-
60
- [describe](dw.object.ExtensibleObject.md#describe), [getCustom](dw.object.ExtensibleObject.md#getcustom)
61
- ### Methods inherited from class PersistentObject
62
-
63
- [getCreationDate](dw.object.PersistentObject.md#getcreationdate), [getLastModified](dw.object.PersistentObject.md#getlastmodified), [getUUID](dw.object.PersistentObject.md#getuuid)
64
- ### Methods inherited from class Object
65
-
66
- [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)
67
- ## Constant Details
68
-
69
- ### PRODUCT_SHIPPING_ID
70
-
71
- - ~~PRODUCT_SHIPPING_ID: [String](TopLevel.String.md) = "PRODUCT_SHIPPING"~~
72
- - : Reserved constant.
73
-
74
- **Deprecated:**
75
- :::warning
76
- this reserved constant is deprecated.
77
- :::
78
-
79
- ---
80
-
81
- ## Property Details
82
-
83
- ### adjustedGrossPrice
84
- - adjustedGrossPrice: [Money](dw.value.Money.md) `(read-only)`
85
- - : Returns the gross price of the product shipping line item after applying
86
- all product-shipping-level adjustments.
87
-
88
-
89
- **See Also:**
90
- - [getAdjustedNetPrice()](dw.order.ProductShippingLineItem.md#getadjustednetprice)
91
- - [getAdjustedPrice()](dw.order.ProductShippingLineItem.md#getadjustedprice)
92
-
93
-
94
- ---
95
-
96
- ### adjustedNetPrice
97
- - adjustedNetPrice: [Money](dw.value.Money.md) `(read-only)`
98
- - : Returns the net price of the product shipping line item after applying
99
- all product-shipping-level adjustments.
100
-
101
-
102
- **See Also:**
103
- - [getAdjustedGrossPrice()](dw.order.ProductShippingLineItem.md#getadjustedgrossprice)
104
- - [getAdjustedPrice()](dw.order.ProductShippingLineItem.md#getadjustedprice)
105
-
106
-
107
- ---
108
-
109
- ### adjustedPrice
110
- - adjustedPrice: [Money](dw.value.Money.md) `(read-only)`
111
- - : Returns the price of the product shipping line item after applying all
112
- pproduct-shipping-level adjustments. For net pricing the adjusted net
113
- price is returned (see [getAdjustedNetPrice()](dw.order.ProductShippingLineItem.md#getadjustednetprice)). For gross
114
- pricing, the adjusted gross price is returned (see
115
- [getAdjustedGrossPrice()](dw.order.ProductShippingLineItem.md#getadjustedgrossprice)).
116
-
117
-
118
- **See Also:**
119
- - [getAdjustedGrossPrice()](dw.order.ProductShippingLineItem.md#getadjustedgrossprice)
120
- - [getAdjustedNetPrice()](dw.order.ProductShippingLineItem.md#getadjustednetprice)
121
-
122
-
123
- ---
124
-
125
- ### adjustedTax
126
- - adjustedTax: [Money](dw.value.Money.md) `(read-only)`
127
- - : Returns the tax of the unit after applying adjustments, in the purchase
128
- currency.
129
-
130
-
131
-
132
- ---
133
-
134
- ### priceAdjustments
135
- - priceAdjustments: [Collection](dw.util.Collection.md) `(read-only)`
136
- - : Returns an iterator of price adjustments that have been applied to this
137
- product shipping line item.
138
-
139
-
140
-
141
- ---
142
-
143
- ### productLineItem
144
- - productLineItem: [ProductLineItem](dw.order.ProductLineItem.md) `(read-only)`
145
- - : Returns the parent product line item this shipping line item belongs to.
146
-
147
-
148
- ---
149
-
150
- ### quantity
151
- - quantity: [Quantity](dw.value.Quantity.md)
152
- - : Returns the quantity of the shipping cost.
153
-
154
-
155
- ---
156
-
157
- ### shipment
158
- - shipment: [Shipment](dw.order.Shipment.md) `(read-only)`
159
- - : Returns the shipment this shipping line item belongs to.
160
-
161
-
162
- ---
163
-
164
- ### surcharge
165
- - surcharge: [Boolean](TopLevel.Boolean.md)
166
- - : Returns the 'surcharge' flag.
167
-
168
-
169
- ---
170
-
171
- ## Method Details
172
-
173
- ### getAdjustedGrossPrice()
174
- - getAdjustedGrossPrice(): [Money](dw.value.Money.md)
175
- - : Returns the gross price of the product shipping line item after applying
176
- all product-shipping-level adjustments.
177
-
178
-
179
- **Returns:**
180
- - gross price after applying product-shipping-level adjustments
181
-
182
- **See Also:**
183
- - [getAdjustedNetPrice()](dw.order.ProductShippingLineItem.md#getadjustednetprice)
184
- - [getAdjustedPrice()](dw.order.ProductShippingLineItem.md#getadjustedprice)
185
-
186
-
187
- ---
188
-
189
- ### getAdjustedNetPrice()
190
- - getAdjustedNetPrice(): [Money](dw.value.Money.md)
191
- - : Returns the net price of the product shipping line item after applying
192
- all product-shipping-level adjustments.
193
-
194
-
195
- **Returns:**
196
- - net price after applying product-shipping-level adjustments
197
-
198
- **See Also:**
199
- - [getAdjustedGrossPrice()](dw.order.ProductShippingLineItem.md#getadjustedgrossprice)
200
- - [getAdjustedPrice()](dw.order.ProductShippingLineItem.md#getadjustedprice)
201
-
202
-
203
- ---
204
-
205
- ### getAdjustedPrice()
206
- - getAdjustedPrice(): [Money](dw.value.Money.md)
207
- - : Returns the price of the product shipping line item after applying all
208
- pproduct-shipping-level adjustments. For net pricing the adjusted net
209
- price is returned (see [getAdjustedNetPrice()](dw.order.ProductShippingLineItem.md#getadjustednetprice)). For gross
210
- pricing, the adjusted gross price is returned (see
211
- [getAdjustedGrossPrice()](dw.order.ProductShippingLineItem.md#getadjustedgrossprice)).
212
-
213
-
214
- **Returns:**
215
- - Adjusted net or gross price
216
-
217
- **See Also:**
218
- - [getAdjustedGrossPrice()](dw.order.ProductShippingLineItem.md#getadjustedgrossprice)
219
- - [getAdjustedNetPrice()](dw.order.ProductShippingLineItem.md#getadjustednetprice)
220
-
221
-
222
- ---
223
-
224
- ### getAdjustedTax()
225
- - getAdjustedTax(): [Money](dw.value.Money.md)
226
- - : Returns the tax of the unit after applying adjustments, in the purchase
227
- currency.
228
-
229
-
230
- **Returns:**
231
- - the tax of the unit after applying adjustments, in the purchase
232
- currency.
233
-
234
-
235
-
236
- ---
237
-
238
- ### getPriceAdjustments()
239
- - getPriceAdjustments(): [Collection](dw.util.Collection.md)
240
- - : Returns an iterator of price adjustments that have been applied to this
241
- product shipping line item.
242
-
243
-
244
- **Returns:**
245
- - a collection of price adjustments that have been applied to this
246
- product shipping line item.
247
-
248
-
249
-
250
- ---
251
-
252
- ### getProductLineItem()
253
- - getProductLineItem(): [ProductLineItem](dw.order.ProductLineItem.md)
254
- - : Returns the parent product line item this shipping line item belongs to.
255
-
256
- **Returns:**
257
- - the product line item
258
-
259
-
260
- ---
261
-
262
- ### getQuantity()
263
- - getQuantity(): [Quantity](dw.value.Quantity.md)
264
- - : Returns the quantity of the shipping cost.
265
-
266
- **Returns:**
267
- - the shipping quantity
268
-
269
-
270
- ---
271
-
272
- ### getShipment()
273
- - getShipment(): [Shipment](dw.order.Shipment.md)
274
- - : Returns the shipment this shipping line item belongs to.
275
-
276
- **Returns:**
277
- - the shipment
278
-
279
-
280
- ---
281
-
282
- ### isSurcharge()
283
- - isSurcharge(): [Boolean](TopLevel.Boolean.md)
284
- - : Returns the 'surcharge' flag.
285
-
286
- **Returns:**
287
- - true if this is a surcharge shipping cost, false if fixed shipping cost
288
-
289
-
290
- ---
291
-
292
- ### setPriceValue(Number)
293
- - setPriceValue(value: [Number](TopLevel.Number.md)): void
294
- - : Sets price attributes of the line item based on the
295
- purchase currency, taxation policy and line item quantity.
296
-
297
-
298
- The method sets the 'basePrice' attribute of the line item.
299
- Additionally, it sets the 'netPrice' attribute of the line item
300
- if the current taxation policy is 'net', and the 'grossPrice'
301
- attribute, if the current taxation policy is 'gross'. The
302
- 'netPrice'/'grossPrice' attributes are set by multiplying the
303
- specified price value with the line item quantity.
304
-
305
-
306
- If null is specified as value, the price attributes are reset to
307
- Money.NA.
308
-
309
-
310
- **Parameters:**
311
- - value - Price value or null
312
-
313
-
314
- ---
315
-
316
- ### setQuantity(Quantity)
317
- - setQuantity(quantity: [Quantity](dw.value.Quantity.md)): void
318
- - : Sets the quantity of the shipping cost.
319
-
320
- **Parameters:**
321
- - quantity - the shipping quantity
322
-
323
-
324
- ---
325
-
326
- ### setSurcharge(Boolean)
327
- - setSurcharge(flag: [Boolean](TopLevel.Boolean.md)): void
328
- - : Sets the 'surcharge' flag.
329
-
330
- **Parameters:**
331
- - flag - true if this is a surcharge shipping cost, false if this is a fixed shipping cost.
332
-
333
-
334
- ---
335
-
336
- <!-- prettier-ignore-end -->
@@ -1,143 +0,0 @@
1
- <!-- prettier-ignore-start -->
2
- # Class ProductShippingModel
3
-
4
- - [TopLevel.Object](TopLevel.Object.md)
5
- - [dw.order.ProductShippingModel](dw.order.ProductShippingModel.md)
6
-
7
- Instances of ProductShippingModel provide access to product-level
8
- shipping information, such as applicable or inapplicable shipping methods
9
- and shipping cost defined for the product for a specified shipping
10
- method.
11
-
12
-
13
- Use [ShippingMgr.getProductShippingModel(Product)](dw.order.ShippingMgr.md#getproductshippingmodelproduct) to get
14
- the shipping model for a specific product.
15
-
16
-
17
-
18
- ## Property Summary
19
-
20
- | Property | Description |
21
- | --- | --- |
22
- | [applicableShippingMethods](#applicableshippingmethods): [Collection](dw.util.Collection.md) `(read-only)` | Returns the active applicable shipping methods for the product related to this shipping model, i.e. |
23
- | [inapplicableShippingMethods](#inapplicableshippingmethods): [Collection](dw.util.Collection.md) `(read-only)` | Returns the active inapplicable shipping methods for the product related to this shipping model, i.e. |
24
- | [shippingMethodsWithShippingCost](#shippingmethodswithshippingcost): [Collection](dw.util.Collection.md) `(read-only)` | Returns the active shipping methods for which either any fixed-price or surcharge product-level shipping cost is defined for the specified product. |
25
-
26
- ## Constructor Summary
27
-
28
- This class does not have a constructor, so you cannot create it directly.
29
- ## Method Summary
30
-
31
- | Method | Description |
32
- | --- | --- |
33
- | [getApplicableShippingMethods](dw.order.ProductShippingModel.md#getapplicableshippingmethods)() | Returns the active applicable shipping methods for the product related to this shipping model, i.e. |
34
- | [getInapplicableShippingMethods](dw.order.ProductShippingModel.md#getinapplicableshippingmethods)() | Returns the active inapplicable shipping methods for the product related to this shipping model, i.e. |
35
- | [getShippingCost](dw.order.ProductShippingModel.md#getshippingcostshippingmethod)([ShippingMethod](dw.order.ShippingMethod.md)) | Returns the shipping cost object for the related product and the specified shipping method, or null if no product-level fixed-price or surcharge shipping cost are defined for the specified product. |
36
- | [getShippingMethodsWithShippingCost](dw.order.ProductShippingModel.md#getshippingmethodswithshippingcost)() | Returns the active shipping methods for which either any fixed-price or surcharge product-level shipping cost is defined for the specified product. |
37
-
38
- ### Methods inherited from class Object
39
-
40
- [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)
41
- ## Property Details
42
-
43
- ### applicableShippingMethods
44
- - applicableShippingMethods: [Collection](dw.util.Collection.md) `(read-only)`
45
- - : Returns the active applicable shipping methods for the product related
46
- to this shipping model, i.e. shipping methods the product can be shipped
47
- with. A product can be shipping with a shipping methods if the shipping
48
- method is not explicitely marked as inapplicable for this product.
49
-
50
-
51
-
52
- ---
53
-
54
- ### inapplicableShippingMethods
55
- - inapplicableShippingMethods: [Collection](dw.util.Collection.md) `(read-only)`
56
- - : Returns the active inapplicable shipping methods for the product related
57
- to this shipping model, i.e. shipping methods the product cannot be
58
- shipped with. A product cannot be shipping with a shipping methods if the
59
- shipping method is explicitely marked as inapplicable for this product.
60
-
61
-
62
-
63
- ---
64
-
65
- ### shippingMethodsWithShippingCost
66
- - shippingMethodsWithShippingCost: [Collection](dw.util.Collection.md) `(read-only)`
67
- - : Returns the active shipping methods for which either any fixed-price or
68
- surcharge product-level shipping cost is defined for the specified product.
69
-
70
- Note that this can include inapplicable shipping methods
71
- (see [getInapplicableShippingMethods()](dw.order.ProductShippingModel.md#getinapplicableshippingmethods)).
72
-
73
-
74
-
75
- ---
76
-
77
- ## Method Details
78
-
79
- ### getApplicableShippingMethods()
80
- - getApplicableShippingMethods(): [Collection](dw.util.Collection.md)
81
- - : Returns the active applicable shipping methods for the product related
82
- to this shipping model, i.e. shipping methods the product can be shipped
83
- with. A product can be shipping with a shipping methods if the shipping
84
- method is not explicitely marked as inapplicable for this product.
85
-
86
-
87
- **Returns:**
88
- - Applicable shipping methods for the product
89
-
90
-
91
- ---
92
-
93
- ### getInapplicableShippingMethods()
94
- - getInapplicableShippingMethods(): [Collection](dw.util.Collection.md)
95
- - : Returns the active inapplicable shipping methods for the product related
96
- to this shipping model, i.e. shipping methods the product cannot be
97
- shipped with. A product cannot be shipping with a shipping methods if the
98
- shipping method is explicitely marked as inapplicable for this product.
99
-
100
-
101
- **Returns:**
102
- - Inapplicable shipping methods for the product
103
-
104
-
105
- ---
106
-
107
- ### getShippingCost(ShippingMethod)
108
- - getShippingCost(shippingMethod: [ShippingMethod](dw.order.ShippingMethod.md)): [ProductShippingCost](dw.order.ProductShippingCost.md)
109
- - : Returns the shipping cost object for the related product and
110
- the specified shipping method, or null if no product-level fixed-price or
111
- surcharge shipping cost are defined for the specified product.
112
-
113
- The following rules apply:
114
-
115
- - if fixed and surcharge shipping cost is defined for a product, the fixed cost takes precedence
116
- - if a product is member of multiple shipping cost groups, the lowest shipping cost takes precedence
117
-
118
-
119
- **Parameters:**
120
- - shippingMethod - the shipping method to use.
121
-
122
- **Returns:**
123
- - Product shipping cost
124
-
125
-
126
- ---
127
-
128
- ### getShippingMethodsWithShippingCost()
129
- - getShippingMethodsWithShippingCost(): [Collection](dw.util.Collection.md)
130
- - : Returns the active shipping methods for which either any fixed-price or
131
- surcharge product-level shipping cost is defined for the specified product.
132
-
133
- Note that this can include inapplicable shipping methods
134
- (see [getInapplicableShippingMethods()](dw.order.ProductShippingModel.md#getinapplicableshippingmethods)).
135
-
136
-
137
- **Returns:**
138
- - Shipping methods with shipping cost
139
-
140
-
141
- ---
142
-
143
- <!-- prettier-ignore-end -->