@salesforce/b2c-tooling-sdk 0.0.1 → 0.0.3

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 (1106) hide show
  1. package/README.md +158 -29
  2. package/data/script-api/TopLevel.APIException.md +119 -0
  3. package/data/script-api/TopLevel.Array.md +732 -0
  4. package/data/script-api/TopLevel.ArrayBuffer.md +97 -0
  5. package/data/script-api/TopLevel.BigInt.md +154 -0
  6. package/data/script-api/TopLevel.Boolean.md +83 -0
  7. package/data/script-api/TopLevel.ConversionError.md +51 -0
  8. package/data/script-api/TopLevel.DataView.md +271 -0
  9. package/data/script-api/TopLevel.Date.md +688 -0
  10. package/data/script-api/TopLevel.ES6Iterator.md +47 -0
  11. package/data/script-api/TopLevel.Error.md +124 -0
  12. package/data/script-api/TopLevel.EvalError.md +47 -0
  13. package/data/script-api/TopLevel.Fault.md +133 -0
  14. package/data/script-api/TopLevel.Float32Array.md +186 -0
  15. package/data/script-api/TopLevel.Float64Array.md +186 -0
  16. package/data/script-api/TopLevel.Function.md +114 -0
  17. package/data/script-api/TopLevel.Generator.md +132 -0
  18. package/data/script-api/TopLevel.IOError.md +98 -0
  19. package/data/script-api/TopLevel.Int16Array.md +186 -0
  20. package/data/script-api/TopLevel.Int32Array.md +186 -0
  21. package/data/script-api/TopLevel.Int8Array.md +186 -0
  22. package/data/script-api/TopLevel.InternalError.md +47 -0
  23. package/data/script-api/TopLevel.Iterable.md +44 -0
  24. package/data/script-api/TopLevel.Iterator.md +89 -0
  25. package/data/script-api/TopLevel.JSON.md +173 -0
  26. package/data/script-api/TopLevel.Map.md +189 -0
  27. package/data/script-api/TopLevel.Math.md +948 -0
  28. package/data/script-api/TopLevel.Module.md +152 -0
  29. package/data/script-api/TopLevel.Namespace.md +152 -0
  30. package/data/script-api/TopLevel.Number.md +404 -0
  31. package/data/script-api/TopLevel.Object.md +472 -0
  32. package/data/script-api/TopLevel.QName.md +147 -0
  33. package/data/script-api/TopLevel.RangeError.md +47 -0
  34. package/data/script-api/TopLevel.ReferenceError.md +47 -0
  35. package/data/script-api/TopLevel.RegExp.md +155 -0
  36. package/data/script-api/TopLevel.Set.md +150 -0
  37. package/data/script-api/TopLevel.StopIteration.md +36 -0
  38. package/data/script-api/TopLevel.String.md +1060 -0
  39. package/data/script-api/TopLevel.Symbol.md +196 -0
  40. package/data/script-api/TopLevel.SyntaxError.md +47 -0
  41. package/data/script-api/TopLevel.SystemError.md +99 -0
  42. package/data/script-api/TopLevel.TypeError.md +47 -0
  43. package/data/script-api/TopLevel.URIError.md +47 -0
  44. package/data/script-api/TopLevel.Uint16Array.md +186 -0
  45. package/data/script-api/TopLevel.Uint32Array.md +186 -0
  46. package/data/script-api/TopLevel.Uint8Array.md +186 -0
  47. package/data/script-api/TopLevel.Uint8ClampedArray.md +186 -0
  48. package/data/script-api/TopLevel.WeakMap.md +135 -0
  49. package/data/script-api/TopLevel.WeakSet.md +96 -0
  50. package/data/script-api/TopLevel.XML.md +922 -0
  51. package/data/script-api/TopLevel.XMLList.md +418 -0
  52. package/data/script-api/TopLevel.XMLStreamError.md +115 -0
  53. package/data/script-api/TopLevel.arguments.md +56 -0
  54. package/data/script-api/TopLevel.global.md +539 -0
  55. package/data/script-api/TopLevel.md +58 -0
  56. package/data/script-api/dw.alert.Alert.md +175 -0
  57. package/data/script-api/dw.alert.Alerts.md +256 -0
  58. package/data/script-api/dw.alert.md +7 -0
  59. package/data/script-api/dw.campaign.ABTest.md +63 -0
  60. package/data/script-api/dw.campaign.ABTestMgr.md +76 -0
  61. package/data/script-api/dw.campaign.ABTestSegment.md +107 -0
  62. package/data/script-api/dw.campaign.AmountDiscount.md +70 -0
  63. package/data/script-api/dw.campaign.ApproachingDiscount.md +157 -0
  64. package/data/script-api/dw.campaign.BonusChoiceDiscount.md +190 -0
  65. package/data/script-api/dw.campaign.BonusDiscount.md +59 -0
  66. package/data/script-api/dw.campaign.Campaign.md +346 -0
  67. package/data/script-api/dw.campaign.CampaignMgr.md +436 -0
  68. package/data/script-api/dw.campaign.CampaignStatusCodes.md +103 -0
  69. package/data/script-api/dw.campaign.Coupon.md +324 -0
  70. package/data/script-api/dw.campaign.CouponMgr.md +137 -0
  71. package/data/script-api/dw.campaign.CouponRedemption.md +87 -0
  72. package/data/script-api/dw.campaign.CouponStatusCodes.md +130 -0
  73. package/data/script-api/dw.campaign.Discount.md +271 -0
  74. package/data/script-api/dw.campaign.DiscountPlan.md +322 -0
  75. package/data/script-api/dw.campaign.FixedPriceDiscount.md +74 -0
  76. package/data/script-api/dw.campaign.FixedPriceShippingDiscount.md +74 -0
  77. package/data/script-api/dw.campaign.FreeDiscount.md +24 -0
  78. package/data/script-api/dw.campaign.FreeShippingDiscount.md +24 -0
  79. package/data/script-api/dw.campaign.PercentageDiscount.md +74 -0
  80. package/data/script-api/dw.campaign.PercentageOptionDiscount.md +59 -0
  81. package/data/script-api/dw.campaign.PriceBookPriceDiscount.md +56 -0
  82. package/data/script-api/dw.campaign.Promotion.md +939 -0
  83. package/data/script-api/dw.campaign.PromotionMgr.md +478 -0
  84. package/data/script-api/dw.campaign.PromotionPlan.md +378 -0
  85. package/data/script-api/dw.campaign.SlotContent.md +131 -0
  86. package/data/script-api/dw.campaign.SourceCodeGroup.md +83 -0
  87. package/data/script-api/dw.campaign.SourceCodeInfo.md +167 -0
  88. package/data/script-api/dw.campaign.SourceCodeStatusCodes.md +61 -0
  89. package/data/script-api/dw.campaign.TotalFixedPriceDiscount.md +56 -0
  90. package/data/script-api/dw.campaign.md +36 -0
  91. package/data/script-api/dw.catalog.Catalog.md +158 -0
  92. package/data/script-api/dw.catalog.CatalogMgr.md +155 -0
  93. package/data/script-api/dw.catalog.Category.md +1212 -0
  94. package/data/script-api/dw.catalog.CategoryAssignment.md +179 -0
  95. package/data/script-api/dw.catalog.CategoryLink.md +142 -0
  96. package/data/script-api/dw.catalog.PriceBook.md +215 -0
  97. package/data/script-api/dw.catalog.PriceBookMgr.md +176 -0
  98. package/data/script-api/dw.catalog.Product.md +2492 -0
  99. package/data/script-api/dw.catalog.ProductActiveData.md +1244 -0
  100. package/data/script-api/dw.catalog.ProductAttributeModel.md +409 -0
  101. package/data/script-api/dw.catalog.ProductAvailabilityLevels.md +125 -0
  102. package/data/script-api/dw.catalog.ProductAvailabilityModel.md +516 -0
  103. package/data/script-api/dw.catalog.ProductInventoryList.md +136 -0
  104. package/data/script-api/dw.catalog.ProductInventoryMgr.md +132 -0
  105. package/data/script-api/dw.catalog.ProductInventoryRecord.md +638 -0
  106. package/data/script-api/dw.catalog.ProductLink.md +166 -0
  107. package/data/script-api/dw.catalog.ProductMgr.md +136 -0
  108. package/data/script-api/dw.catalog.ProductOption.md +189 -0
  109. package/data/script-api/dw.catalog.ProductOptionModel.md +209 -0
  110. package/data/script-api/dw.catalog.ProductOptionValue.md +132 -0
  111. package/data/script-api/dw.catalog.ProductPriceInfo.md +170 -0
  112. package/data/script-api/dw.catalog.ProductPriceModel.md +988 -0
  113. package/data/script-api/dw.catalog.ProductPriceTable.md +121 -0
  114. package/data/script-api/dw.catalog.ProductSearchHit.md +702 -0
  115. package/data/script-api/dw.catalog.ProductSearchModel.md +1894 -0
  116. package/data/script-api/dw.catalog.ProductSearchRefinementDefinition.md +99 -0
  117. package/data/script-api/dw.catalog.ProductSearchRefinementValue.md +80 -0
  118. package/data/script-api/dw.catalog.ProductSearchRefinements.md +265 -0
  119. package/data/script-api/dw.catalog.ProductVariationAttribute.md +107 -0
  120. package/data/script-api/dw.catalog.ProductVariationAttributeValue.md +215 -0
  121. package/data/script-api/dw.catalog.ProductVariationModel.md +1010 -0
  122. package/data/script-api/dw.catalog.Recommendation.md +327 -0
  123. package/data/script-api/dw.catalog.SearchModel.md +769 -0
  124. package/data/script-api/dw.catalog.SearchRefinementDefinition.md +145 -0
  125. package/data/script-api/dw.catalog.SearchRefinementValue.md +194 -0
  126. package/data/script-api/dw.catalog.SearchRefinements.md +238 -0
  127. package/data/script-api/dw.catalog.SortingOption.md +120 -0
  128. package/data/script-api/dw.catalog.SortingRule.md +53 -0
  129. package/data/script-api/dw.catalog.Store.md +484 -0
  130. package/data/script-api/dw.catalog.StoreGroup.md +95 -0
  131. package/data/script-api/dw.catalog.StoreInventoryFilter.md +112 -0
  132. package/data/script-api/dw.catalog.StoreInventoryFilterValue.md +111 -0
  133. package/data/script-api/dw.catalog.StoreMgr.md +223 -0
  134. package/data/script-api/dw.catalog.Variant.md +1000 -0
  135. package/data/script-api/dw.catalog.VariationGroup.md +869 -0
  136. package/data/script-api/dw.catalog.md +50 -0
  137. package/data/script-api/dw.content.Content.md +481 -0
  138. package/data/script-api/dw.content.ContentMgr.md +147 -0
  139. package/data/script-api/dw.content.ContentSearchModel.md +618 -0
  140. package/data/script-api/dw.content.ContentSearchRefinementDefinition.md +61 -0
  141. package/data/script-api/dw.content.ContentSearchRefinementValue.md +22 -0
  142. package/data/script-api/dw.content.ContentSearchRefinements.md +218 -0
  143. package/data/script-api/dw.content.Folder.md +432 -0
  144. package/data/script-api/dw.content.Library.md +124 -0
  145. package/data/script-api/dw.content.MarkupText.md +150 -0
  146. package/data/script-api/dw.content.MediaFile.md +367 -0
  147. package/data/script-api/dw.content.md +15 -0
  148. package/data/script-api/dw.crypto.CertificateRef.md +59 -0
  149. package/data/script-api/dw.crypto.CertificateUtils.md +162 -0
  150. package/data/script-api/dw.crypto.Cipher.md +1230 -0
  151. package/data/script-api/dw.crypto.Encoding.md +193 -0
  152. package/data/script-api/dw.crypto.JWE.md +245 -0
  153. package/data/script-api/dw.crypto.JWEHeader.md +147 -0
  154. package/data/script-api/dw.crypto.JWS.md +260 -0
  155. package/data/script-api/dw.crypto.JWSHeader.md +128 -0
  156. package/data/script-api/dw.crypto.KeyRef.md +77 -0
  157. package/data/script-api/dw.crypto.Mac.md +191 -0
  158. package/data/script-api/dw.crypto.MessageDigest.md +243 -0
  159. package/data/script-api/dw.crypto.SecureRandom.md +161 -0
  160. package/data/script-api/dw.crypto.Signature.md +241 -0
  161. package/data/script-api/dw.crypto.WeakCipher.md +725 -0
  162. package/data/script-api/dw.crypto.WeakMac.md +163 -0
  163. package/data/script-api/dw.crypto.WeakMessageDigest.md +220 -0
  164. package/data/script-api/dw.crypto.WeakSignature.md +208 -0
  165. package/data/script-api/dw.crypto.X509Certificate.md +180 -0
  166. package/data/script-api/dw.crypto.md +23 -0
  167. package/data/script-api/dw.customer.AddressBook.md +158 -0
  168. package/data/script-api/dw.customer.AgentUserMgr.md +94 -0
  169. package/data/script-api/dw.customer.AgentUserStatusCodes.md +164 -0
  170. package/data/script-api/dw.customer.AuthenticationStatus.md +157 -0
  171. package/data/script-api/dw.customer.Credentials.md +524 -0
  172. package/data/script-api/dw.customer.Customer.md +488 -0
  173. package/data/script-api/dw.customer.CustomerActiveData.md +563 -0
  174. package/data/script-api/dw.customer.CustomerAddress.md +666 -0
  175. package/data/script-api/dw.customer.CustomerCDPData.md +70 -0
  176. package/data/script-api/dw.customer.CustomerContextMgr.md +62 -0
  177. package/data/script-api/dw.customer.CustomerGroup.md +146 -0
  178. package/data/script-api/dw.customer.CustomerList.md +76 -0
  179. package/data/script-api/dw.customer.CustomerMgr.md +1046 -0
  180. package/data/script-api/dw.customer.CustomerPasswordConstraints.md +125 -0
  181. package/data/script-api/dw.customer.CustomerPaymentInstrument.md +161 -0
  182. package/data/script-api/dw.customer.CustomerStatusCodes.md +55 -0
  183. package/data/script-api/dw.customer.EncryptedObject.md +34 -0
  184. package/data/script-api/dw.customer.ExternalProfile.md +154 -0
  185. package/data/script-api/dw.customer.OrderHistory.md +167 -0
  186. package/data/script-api/dw.customer.ProductList.md +870 -0
  187. package/data/script-api/dw.customer.ProductListItem.md +469 -0
  188. package/data/script-api/dw.customer.ProductListItemPurchase.md +139 -0
  189. package/data/script-api/dw.customer.ProductListMgr.md +350 -0
  190. package/data/script-api/dw.customer.ProductListRegistrant.md +165 -0
  191. package/data/script-api/dw.customer.Profile.md +895 -0
  192. package/data/script-api/dw.customer.Wallet.md +136 -0
  193. package/data/script-api/dw.customer.md +31 -0
  194. package/data/script-api/dw.customer.oauth.OAuthAccessTokenResponse.md +171 -0
  195. package/data/script-api/dw.customer.oauth.OAuthFinalizedResponse.md +75 -0
  196. package/data/script-api/dw.customer.oauth.OAuthLoginFlowMgr.md +165 -0
  197. package/data/script-api/dw.customer.oauth.OAuthUserInfoResponse.md +84 -0
  198. package/data/script-api/dw.customer.oauth.md +9 -0
  199. package/data/script-api/dw.customer.shoppercontext.ShopperContext.md +369 -0
  200. package/data/script-api/dw.customer.shoppercontext.ShopperContextErrorCodes.md +111 -0
  201. package/data/script-api/dw.customer.shoppercontext.ShopperContextException.md +77 -0
  202. package/data/script-api/dw.customer.shoppercontext.ShopperContextMgr.md +209 -0
  203. package/data/script-api/dw.customer.shoppercontext.md +9 -0
  204. package/data/script-api/dw.experience.AspectAttributeValidationException.md +25 -0
  205. package/data/script-api/dw.experience.Component.md +166 -0
  206. package/data/script-api/dw.experience.ComponentRenderSettings.md +130 -0
  207. package/data/script-api/dw.experience.ComponentScriptContext.md +148 -0
  208. package/data/script-api/dw.experience.CustomEditor.md +146 -0
  209. package/data/script-api/dw.experience.CustomEditorResources.md +100 -0
  210. package/data/script-api/dw.experience.Page.md +467 -0
  211. package/data/script-api/dw.experience.PageMgr.md +549 -0
  212. package/data/script-api/dw.experience.PageScriptContext.md +200 -0
  213. package/data/script-api/dw.experience.Region.md +119 -0
  214. package/data/script-api/dw.experience.RegionRenderSettings.md +207 -0
  215. package/data/script-api/dw.experience.cms.CMSRecord.md +125 -0
  216. package/data/script-api/dw.experience.cms.md +6 -0
  217. package/data/script-api/dw.experience.image.FocalPoint.md +71 -0
  218. package/data/script-api/dw.experience.image.Image.md +101 -0
  219. package/data/script-api/dw.experience.image.ImageMetaData.md +71 -0
  220. package/data/script-api/dw.experience.image.md +8 -0
  221. package/data/script-api/dw.experience.md +16 -0
  222. package/data/script-api/dw.extensions.applepay.ApplePayHookResult.md +254 -0
  223. package/data/script-api/dw.extensions.applepay.ApplePayHooks.md +572 -0
  224. package/data/script-api/dw.extensions.applepay.md +7 -0
  225. package/data/script-api/dw.extensions.facebook.FacebookFeedHooks.md +102 -0
  226. package/data/script-api/dw.extensions.facebook.FacebookProduct.md +1343 -0
  227. package/data/script-api/dw.extensions.facebook.md +7 -0
  228. package/data/script-api/dw.extensions.paymentapi.PaymentApiHooks.md +136 -0
  229. package/data/script-api/dw.extensions.paymentapi.md +6 -0
  230. package/data/script-api/dw.extensions.paymentrequest.PaymentRequestHookResult.md +149 -0
  231. package/data/script-api/dw.extensions.paymentrequest.PaymentRequestHooks.md +356 -0
  232. package/data/script-api/dw.extensions.paymentrequest.md +7 -0
  233. package/data/script-api/dw.extensions.payments.SalesforceAdyenPaymentIntent.md +134 -0
  234. package/data/script-api/dw.extensions.payments.SalesforceAdyenSavedPaymentMethod.md +283 -0
  235. package/data/script-api/dw.extensions.payments.SalesforceBancontactPaymentDetails.md +88 -0
  236. package/data/script-api/dw.extensions.payments.SalesforceCardPaymentDetails.md +107 -0
  237. package/data/script-api/dw.extensions.payments.SalesforceEpsPaymentDetails.md +63 -0
  238. package/data/script-api/dw.extensions.payments.SalesforceIdealPaymentDetails.md +63 -0
  239. package/data/script-api/dw.extensions.payments.SalesforceKlarnaPaymentDetails.md +63 -0
  240. package/data/script-api/dw.extensions.payments.SalesforcePayPalOrder.md +263 -0
  241. package/data/script-api/dw.extensions.payments.SalesforcePayPalOrderAddress.md +171 -0
  242. package/data/script-api/dw.extensions.payments.SalesforcePayPalOrderPayer.md +110 -0
  243. package/data/script-api/dw.extensions.payments.SalesforcePayPalPaymentDetails.md +88 -0
  244. package/data/script-api/dw.extensions.payments.SalesforcePaymentDetails.md +83 -0
  245. package/data/script-api/dw.extensions.payments.SalesforcePaymentIntent.md +273 -0
  246. package/data/script-api/dw.extensions.payments.SalesforcePaymentMethod.md +368 -0
  247. package/data/script-api/dw.extensions.payments.SalesforcePaymentRequest.md +1077 -0
  248. package/data/script-api/dw.extensions.payments.SalesforcePaymentsHooks.md +166 -0
  249. package/data/script-api/dw.extensions.payments.SalesforcePaymentsMerchantAccount.md +151 -0
  250. package/data/script-api/dw.extensions.payments.SalesforcePaymentsMerchantAccountPaymentMethod.md +98 -0
  251. package/data/script-api/dw.extensions.payments.SalesforcePaymentsMgr.md +941 -0
  252. package/data/script-api/dw.extensions.payments.SalesforcePaymentsSiteConfiguration.md +126 -0
  253. package/data/script-api/dw.extensions.payments.SalesforcePaymentsZone.md +393 -0
  254. package/data/script-api/dw.extensions.payments.SalesforceSepaDebitPaymentDetails.md +63 -0
  255. package/data/script-api/dw.extensions.payments.SalesforceVenmoPaymentDetails.md +88 -0
  256. package/data/script-api/dw.extensions.payments.md +28 -0
  257. package/data/script-api/dw.extensions.pinterest.PinterestAvailability.md +85 -0
  258. package/data/script-api/dw.extensions.pinterest.PinterestFeedHooks.md +118 -0
  259. package/data/script-api/dw.extensions.pinterest.PinterestOrder.md +263 -0
  260. package/data/script-api/dw.extensions.pinterest.PinterestOrderHooks.md +89 -0
  261. package/data/script-api/dw.extensions.pinterest.PinterestProduct.md +677 -0
  262. package/data/script-api/dw.extensions.pinterest.md +10 -0
  263. package/data/script-api/dw.io.CSVStreamReader.md +128 -0
  264. package/data/script-api/dw.io.CSVStreamWriter.md +92 -0
  265. package/data/script-api/dw.io.File.md +729 -0
  266. package/data/script-api/dw.io.FileReader.md +70 -0
  267. package/data/script-api/dw.io.FileWriter.md +159 -0
  268. package/data/script-api/dw.io.InputStream.md +35 -0
  269. package/data/script-api/dw.io.OutputStream.md +38 -0
  270. package/data/script-api/dw.io.PrintWriter.md +66 -0
  271. package/data/script-api/dw.io.RandomAccessFileReader.md +183 -0
  272. package/data/script-api/dw.io.Reader.md +284 -0
  273. package/data/script-api/dw.io.StringWriter.md +89 -0
  274. package/data/script-api/dw.io.Writer.md +96 -0
  275. package/data/script-api/dw.io.XMLIndentingStreamWriter.md +121 -0
  276. package/data/script-api/dw.io.XMLStreamConstants.md +172 -0
  277. package/data/script-api/dw.io.XMLStreamReader.md +1181 -0
  278. package/data/script-api/dw.io.XMLStreamWriter.md +478 -0
  279. package/data/script-api/dw.io.md +21 -0
  280. package/data/script-api/dw.job.JobExecution.md +111 -0
  281. package/data/script-api/dw.job.JobStepExecution.md +136 -0
  282. package/data/script-api/dw.job.md +7 -0
  283. package/data/script-api/dw.net.FTPClient.md +621 -0
  284. package/data/script-api/dw.net.FTPFileInfo.md +132 -0
  285. package/data/script-api/dw.net.HTTPClient.md +775 -0
  286. package/data/script-api/dw.net.HTTPClientLoggingConfig.md +363 -0
  287. package/data/script-api/dw.net.HTTPRequestPart.md +296 -0
  288. package/data/script-api/dw.net.Mail.md +487 -0
  289. package/data/script-api/dw.net.SFTPClient.md +535 -0
  290. package/data/script-api/dw.net.SFTPFileInfo.md +128 -0
  291. package/data/script-api/dw.net.WebDAVClient.md +762 -0
  292. package/data/script-api/dw.net.WebDAVFileInfo.md +163 -0
  293. package/data/script-api/dw.net.md +15 -0
  294. package/data/script-api/dw.object.ActiveData.md +86 -0
  295. package/data/script-api/dw.object.CustomAttributes.md +122 -0
  296. package/data/script-api/dw.object.CustomObject.md +82 -0
  297. package/data/script-api/dw.object.CustomObjectMgr.md +478 -0
  298. package/data/script-api/dw.object.Extensible.md +71 -0
  299. package/data/script-api/dw.object.ExtensibleObject.md +85 -0
  300. package/data/script-api/dw.object.Note.md +118 -0
  301. package/data/script-api/dw.object.ObjectAttributeDefinition.md +542 -0
  302. package/data/script-api/dw.object.ObjectAttributeGroup.md +160 -0
  303. package/data/script-api/dw.object.ObjectAttributeValueDefinition.md +78 -0
  304. package/data/script-api/dw.object.ObjectTypeDefinition.md +239 -0
  305. package/data/script-api/dw.object.PersistentObject.md +92 -0
  306. package/data/script-api/dw.object.SimpleExtensible.md +53 -0
  307. package/data/script-api/dw.object.SystemObjectMgr.md +520 -0
  308. package/data/script-api/dw.object.md +19 -0
  309. package/data/script-api/dw.order.AbstractItem.md +220 -0
  310. package/data/script-api/dw.order.AbstractItemCtnr.md +219 -0
  311. package/data/script-api/dw.order.Appeasement.md +398 -0
  312. package/data/script-api/dw.order.AppeasementItem.md +104 -0
  313. package/data/script-api/dw.order.Basket.md +867 -0
  314. package/data/script-api/dw.order.BasketMgr.md +673 -0
  315. package/data/script-api/dw.order.BonusDiscountLineItem.md +309 -0
  316. package/data/script-api/dw.order.CouponLineItem.md +289 -0
  317. package/data/script-api/dw.order.CreateAgentBasketLimitExceededException.md +35 -0
  318. package/data/script-api/dw.order.CreateBasketFromOrderException.md +54 -0
  319. package/data/script-api/dw.order.CreateCouponLineItemException.md +67 -0
  320. package/data/script-api/dw.order.CreateOrderException.md +23 -0
  321. package/data/script-api/dw.order.CreateTemporaryBasketLimitExceededException.md +35 -0
  322. package/data/script-api/dw.order.GiftCertificate.md +530 -0
  323. package/data/script-api/dw.order.GiftCertificateLineItem.md +292 -0
  324. package/data/script-api/dw.order.GiftCertificateMgr.md +228 -0
  325. package/data/script-api/dw.order.GiftCertificateStatusCodes.md +108 -0
  326. package/data/script-api/dw.order.Invoice.md +571 -0
  327. package/data/script-api/dw.order.InvoiceItem.md +199 -0
  328. package/data/script-api/dw.order.LineItem.md +489 -0
  329. package/data/script-api/dw.order.LineItemCtnr.md +2399 -0
  330. package/data/script-api/dw.order.Order.md +2770 -0
  331. package/data/script-api/dw.order.OrderAddress.md +624 -0
  332. package/data/script-api/dw.order.OrderItem.md +613 -0
  333. package/data/script-api/dw.order.OrderMgr.md +1494 -0
  334. package/data/script-api/dw.order.OrderPaymentInstrument.md +231 -0
  335. package/data/script-api/dw.order.OrderProcessStatusCodes.md +146 -0
  336. package/data/script-api/dw.order.PaymentCard.md +220 -0
  337. package/data/script-api/dw.order.PaymentInstrument.md +1416 -0
  338. package/data/script-api/dw.order.PaymentMethod.md +257 -0
  339. package/data/script-api/dw.order.PaymentMgr.md +138 -0
  340. package/data/script-api/dw.order.PaymentProcessor.md +106 -0
  341. package/data/script-api/dw.order.PaymentStatusCodes.md +70 -0
  342. package/data/script-api/dw.order.PaymentTransaction.md +291 -0
  343. package/data/script-api/dw.order.PriceAdjustment.md +745 -0
  344. package/data/script-api/dw.order.PriceAdjustmentLimitTypes.md +61 -0
  345. package/data/script-api/dw.order.ProductLineItem.md +1749 -0
  346. package/data/script-api/dw.order.ProductShippingCost.md +101 -0
  347. package/data/script-api/dw.order.ProductShippingLineItem.md +336 -0
  348. package/data/script-api/dw.order.ProductShippingModel.md +143 -0
  349. package/data/script-api/dw.order.Return.md +396 -0
  350. package/data/script-api/dw.order.ReturnCase.md +463 -0
  351. package/data/script-api/dw.order.ReturnCaseItem.md +372 -0
  352. package/data/script-api/dw.order.ReturnItem.md +335 -0
  353. package/data/script-api/dw.order.Shipment.md +1124 -0
  354. package/data/script-api/dw.order.ShipmentShippingCost.md +54 -0
  355. package/data/script-api/dw.order.ShipmentShippingModel.md +203 -0
  356. package/data/script-api/dw.order.ShippingLineItem.md +315 -0
  357. package/data/script-api/dw.order.ShippingLocation.md +313 -0
  358. package/data/script-api/dw.order.ShippingMethod.md +251 -0
  359. package/data/script-api/dw.order.ShippingMgr.md +173 -0
  360. package/data/script-api/dw.order.ShippingOrder.md +630 -0
  361. package/data/script-api/dw.order.ShippingOrderItem.md +425 -0
  362. package/data/script-api/dw.order.SumItem.md +158 -0
  363. package/data/script-api/dw.order.TaxGroup.md +128 -0
  364. package/data/script-api/dw.order.TaxItem.md +74 -0
  365. package/data/script-api/dw.order.TaxMgr.md +260 -0
  366. package/data/script-api/dw.order.TrackingInfo.md +261 -0
  367. package/data/script-api/dw.order.TrackingRef.md +108 -0
  368. package/data/script-api/dw.order.hooks.BasketMergeHooks.md +87 -0
  369. package/data/script-api/dw.order.hooks.CalculateHooks.md +139 -0
  370. package/data/script-api/dw.order.hooks.CheckoutHooks.md +88 -0
  371. package/data/script-api/dw.order.hooks.OrderHooks.md +96 -0
  372. package/data/script-api/dw.order.hooks.PaymentHooks.md +325 -0
  373. package/data/script-api/dw.order.hooks.ReturnHooks.md +395 -0
  374. package/data/script-api/dw.order.hooks.ShippingOrderHooks.md +426 -0
  375. package/data/script-api/dw.order.hooks.md +12 -0
  376. package/data/script-api/dw.order.md +64 -0
  377. package/data/script-api/dw.rpc.SOAPUtil.md +736 -0
  378. package/data/script-api/dw.rpc.Stub.md +373 -0
  379. package/data/script-api/dw.rpc.WebReference.md +133 -0
  380. package/data/script-api/dw.rpc.md +8 -0
  381. package/data/script-api/dw.sitemap.SitemapFile.md +137 -0
  382. package/data/script-api/dw.sitemap.SitemapMgr.md +142 -0
  383. package/data/script-api/dw.sitemap.md +7 -0
  384. package/data/script-api/dw.suggest.BrandSuggestions.md +34 -0
  385. package/data/script-api/dw.suggest.CategorySuggestions.md +76 -0
  386. package/data/script-api/dw.suggest.ContentSuggestions.md +76 -0
  387. package/data/script-api/dw.suggest.CustomSuggestions.md +34 -0
  388. package/data/script-api/dw.suggest.ProductSuggestions.md +76 -0
  389. package/data/script-api/dw.suggest.SearchPhraseSuggestions.md +126 -0
  390. package/data/script-api/dw.suggest.SuggestModel.md +471 -0
  391. package/data/script-api/dw.suggest.SuggestedCategory.md +51 -0
  392. package/data/script-api/dw.suggest.SuggestedContent.md +51 -0
  393. package/data/script-api/dw.suggest.SuggestedPhrase.md +70 -0
  394. package/data/script-api/dw.suggest.SuggestedProduct.md +55 -0
  395. package/data/script-api/dw.suggest.SuggestedTerm.md +143 -0
  396. package/data/script-api/dw.suggest.SuggestedTerms.md +144 -0
  397. package/data/script-api/dw.suggest.Suggestions.md +206 -0
  398. package/data/script-api/dw.suggest.md +19 -0
  399. package/data/script-api/dw.svc.FTPService.md +140 -0
  400. package/data/script-api/dw.svc.FTPServiceDefinition.md +97 -0
  401. package/data/script-api/dw.svc.HTTPFormService.md +32 -0
  402. package/data/script-api/dw.svc.HTTPFormServiceDefinition.md +36 -0
  403. package/data/script-api/dw.svc.HTTPService.md +370 -0
  404. package/data/script-api/dw.svc.HTTPServiceDefinition.md +290 -0
  405. package/data/script-api/dw.svc.LocalServiceRegistry.md +63 -0
  406. package/data/script-api/dw.svc.Result.md +320 -0
  407. package/data/script-api/dw.svc.SOAPService.md +104 -0
  408. package/data/script-api/dw.svc.SOAPServiceDefinition.md +32 -0
  409. package/data/script-api/dw.svc.Service.md +276 -0
  410. package/data/script-api/dw.svc.ServiceCallback.md +282 -0
  411. package/data/script-api/dw.svc.ServiceConfig.md +114 -0
  412. package/data/script-api/dw.svc.ServiceCredential.md +162 -0
  413. package/data/script-api/dw.svc.ServiceDefinition.md +211 -0
  414. package/data/script-api/dw.svc.ServiceProfile.md +152 -0
  415. package/data/script-api/dw.svc.ServiceRegistry.md +118 -0
  416. package/data/script-api/dw.svc.md +22 -0
  417. package/data/script-api/dw.system.AgentUserStatusCodes.md +41 -0
  418. package/data/script-api/dw.system.Cache.md +126 -0
  419. package/data/script-api/dw.system.CacheMgr.md +70 -0
  420. package/data/script-api/dw.system.HookMgr.md +78 -0
  421. package/data/script-api/dw.system.InternalObject.md +47 -0
  422. package/data/script-api/dw.system.JobProcessMonitor.md +103 -0
  423. package/data/script-api/dw.system.Log.md +198 -0
  424. package/data/script-api/dw.system.LogNDC.md +75 -0
  425. package/data/script-api/dw.system.Logger.md +216 -0
  426. package/data/script-api/dw.system.OrganizationPreferences.md +53 -0
  427. package/data/script-api/dw.system.Pipeline.md +94 -0
  428. package/data/script-api/dw.system.PipelineDictionary.md +42 -0
  429. package/data/script-api/dw.system.RESTErrorResponse.md +102 -0
  430. package/data/script-api/dw.system.RESTResponseMgr.md +243 -0
  431. package/data/script-api/dw.system.RESTSuccessResponse.md +62 -0
  432. package/data/script-api/dw.system.RemoteInclude.md +146 -0
  433. package/data/script-api/dw.system.Request.md +781 -0
  434. package/data/script-api/dw.system.RequestHooks.md +112 -0
  435. package/data/script-api/dw.system.Response.md +612 -0
  436. package/data/script-api/dw.system.SearchStatus.md +187 -0
  437. package/data/script-api/dw.system.Session.md +469 -0
  438. package/data/script-api/dw.system.Site.md +570 -0
  439. package/data/script-api/dw.system.SitePreferences.md +90 -0
  440. package/data/script-api/dw.system.Status.md +330 -0
  441. package/data/script-api/dw.system.StatusItem.md +273 -0
  442. package/data/script-api/dw.system.System.md +224 -0
  443. package/data/script-api/dw.system.Transaction.md +107 -0
  444. package/data/script-api/dw.system.md +32 -0
  445. package/data/script-api/dw.template.ISML.md +127 -0
  446. package/data/script-api/dw.template.Velocity.md +168 -0
  447. package/data/script-api/dw.template.md +7 -0
  448. package/data/script-api/dw.util.ArrayList.md +99 -0
  449. package/data/script-api/dw.util.Assert.md +341 -0
  450. package/data/script-api/dw.util.BigInteger.md +283 -0
  451. package/data/script-api/dw.util.Bytes.md +278 -0
  452. package/data/script-api/dw.util.Calendar.md +1051 -0
  453. package/data/script-api/dw.util.Collection.md +272 -0
  454. package/data/script-api/dw.util.Currency.md +147 -0
  455. package/data/script-api/dw.util.DateUtils.md +82 -0
  456. package/data/script-api/dw.util.Decimal.md +386 -0
  457. package/data/script-api/dw.util.FilteringCollection.md +140 -0
  458. package/data/script-api/dw.util.Geolocation.md +293 -0
  459. package/data/script-api/dw.util.HashMap.md +50 -0
  460. package/data/script-api/dw.util.HashSet.md +65 -0
  461. package/data/script-api/dw.util.Iterator.md +86 -0
  462. package/data/script-api/dw.util.LinkedHashMap.md +52 -0
  463. package/data/script-api/dw.util.LinkedHashSet.md +68 -0
  464. package/data/script-api/dw.util.List.md +429 -0
  465. package/data/script-api/dw.util.Locale.md +274 -0
  466. package/data/script-api/dw.util.Map.md +251 -0
  467. package/data/script-api/dw.util.MapEntry.md +68 -0
  468. package/data/script-api/dw.util.MappingKey.md +96 -0
  469. package/data/script-api/dw.util.MappingMgr.md +113 -0
  470. package/data/script-api/dw.util.PropertyComparator.md +122 -0
  471. package/data/script-api/dw.util.SecureEncoder.md +582 -0
  472. package/data/script-api/dw.util.SecureFilter.md +572 -0
  473. package/data/script-api/dw.util.SeekableIterator.md +187 -0
  474. package/data/script-api/dw.util.Set.md +39 -0
  475. package/data/script-api/dw.util.SortedMap.md +148 -0
  476. package/data/script-api/dw.util.SortedSet.md +173 -0
  477. package/data/script-api/dw.util.StringUtils.md +655 -0
  478. package/data/script-api/dw.util.Template.md +141 -0
  479. package/data/script-api/dw.util.UUIDUtils.md +34 -0
  480. package/data/script-api/dw.util.md +37 -0
  481. package/data/script-api/dw.value.EnumValue.md +105 -0
  482. package/data/script-api/dw.value.MimeEncodedText.md +131 -0
  483. package/data/script-api/dw.value.Money.md +526 -0
  484. package/data/script-api/dw.value.Quantity.md +299 -0
  485. package/data/script-api/dw.value.md +9 -0
  486. package/data/script-api/dw.web.CSRFProtection.md +105 -0
  487. package/data/script-api/dw.web.ClickStream.md +177 -0
  488. package/data/script-api/dw.web.ClickStreamEntry.md +255 -0
  489. package/data/script-api/dw.web.Cookie.md +360 -0
  490. package/data/script-api/dw.web.Cookies.md +59 -0
  491. package/data/script-api/dw.web.Form.md +84 -0
  492. package/data/script-api/dw.web.FormAction.md +195 -0
  493. package/data/script-api/dw.web.FormElement.md +211 -0
  494. package/data/script-api/dw.web.FormElementValidationResult.md +170 -0
  495. package/data/script-api/dw.web.FormField.md +642 -0
  496. package/data/script-api/dw.web.FormFieldOption.md +211 -0
  497. package/data/script-api/dw.web.FormFieldOptions.md +49 -0
  498. package/data/script-api/dw.web.FormGroup.md +222 -0
  499. package/data/script-api/dw.web.FormList.md +134 -0
  500. package/data/script-api/dw.web.FormListItem.md +57 -0
  501. package/data/script-api/dw.web.Forms.md +25 -0
  502. package/data/script-api/dw.web.HttpParameter.md +462 -0
  503. package/data/script-api/dw.web.HttpParameterMap.md +194 -0
  504. package/data/script-api/dw.web.LoopIterator.md +231 -0
  505. package/data/script-api/dw.web.PageMetaData.md +197 -0
  506. package/data/script-api/dw.web.PageMetaTag.md +149 -0
  507. package/data/script-api/dw.web.PagingModel.md +407 -0
  508. package/data/script-api/dw.web.Resource.md +147 -0
  509. package/data/script-api/dw.web.URL.md +174 -0
  510. package/data/script-api/dw.web.URLAction.md +95 -0
  511. package/data/script-api/dw.web.URLParameter.md +52 -0
  512. package/data/script-api/dw.web.URLRedirect.md +72 -0
  513. package/data/script-api/dw.web.URLRedirectMgr.md +86 -0
  514. package/data/script-api/dw.web.URLUtils.md +1357 -0
  515. package/data/script-api/dw.web.md +34 -0
  516. package/data/script-api/dw.ws.Port.md +126 -0
  517. package/data/script-api/dw.ws.WSUtil.md +728 -0
  518. package/data/script-api/dw.ws.WebReference2.md +137 -0
  519. package/data/script-api/dw.ws.md +8 -0
  520. package/data/script-api/index.json +3085 -0
  521. package/data/script-api/index.md +39 -0
  522. package/data/xsd/abtest.xsd +347 -0
  523. package/data/xsd/abtestparticipants.xsd +58 -0
  524. package/data/xsd/assignment.xsd +158 -0
  525. package/data/xsd/bmext.xsd +262 -0
  526. package/data/xsd/cachesettings.xsd +75 -0
  527. package/data/xsd/catalog.xsd +1363 -0
  528. package/data/xsd/coupon.xsd +206 -0
  529. package/data/xsd/couponredemption.xsd +58 -0
  530. package/data/xsd/csrfwhitelists.xsd +81 -0
  531. package/data/xsd/customer.xsd +411 -0
  532. package/data/xsd/customeractivedata.xsd +75 -0
  533. package/data/xsd/customercdnsettings.xsd +36 -0
  534. package/data/xsd/customergroup.xsd +276 -0
  535. package/data/xsd/customerlist.xsd +72 -0
  536. package/data/xsd/customerlist2.xsd +52 -0
  537. package/data/xsd/customerpaymentinstrument.xsd +189 -0
  538. package/data/xsd/customobject.xsd +68 -0
  539. package/data/xsd/dcext.xsd +391 -0
  540. package/data/xsd/feed.xsd +76 -0
  541. package/data/xsd/form.xsd +262 -0
  542. package/data/xsd/geolocation.xsd +68 -0
  543. package/data/xsd/giftcertificate.xsd +186 -0
  544. package/data/xsd/index.json +222 -0
  545. package/data/xsd/inventory.xsd +174 -0
  546. package/data/xsd/jobs.xsd +408 -0
  547. package/data/xsd/library.xsd +547 -0
  548. package/data/xsd/locales.xsd +172 -0
  549. package/data/xsd/metadata.xsd +315 -0
  550. package/data/xsd/oauth.xsd +60 -0
  551. package/data/xsd/order.xsd +1253 -0
  552. package/data/xsd/pagemetatag.xsd +110 -0
  553. package/data/xsd/paymentmethod.xsd +216 -0
  554. package/data/xsd/paymentprocessor.xsd +86 -0
  555. package/data/xsd/preferences.xsd +74 -0
  556. package/data/xsd/priceadjustmentlimits.xsd +74 -0
  557. package/data/xsd/pricebook.xsd +166 -0
  558. package/data/xsd/productlist.xsd +246 -0
  559. package/data/xsd/promotion.xsd +1019 -0
  560. package/data/xsd/redirecturl.xsd +120 -0
  561. package/data/xsd/returnimportfeed.xsd +82 -0
  562. package/data/xsd/schedules.xsd +246 -0
  563. package/data/xsd/search.xsd +333 -0
  564. package/data/xsd/search2.xsd +439 -0
  565. package/data/xsd/services.xsd +139 -0
  566. package/data/xsd/shipping.xsd +487 -0
  567. package/data/xsd/shippingorderupdatefeed.xsd +125 -0
  568. package/data/xsd/site.xsd +89 -0
  569. package/data/xsd/sitemapconfiguration.xsd +230 -0
  570. package/data/xsd/slot.xsd +292 -0
  571. package/data/xsd/sort.xsd +298 -0
  572. package/data/xsd/sourcecode.xsd +188 -0
  573. package/data/xsd/store.xsd +194 -0
  574. package/data/xsd/tax.xsd +112 -0
  575. package/data/xsd/urlrules.xsd +273 -0
  576. package/data/xsd/xml.xsd +54 -0
  577. package/dist/cjs/auth/api-key.d.ts +28 -0
  578. package/dist/cjs/auth/api-key.js +44 -0
  579. package/dist/cjs/auth/api-key.js.map +1 -0
  580. package/dist/cjs/auth/basic.d.ts +7 -0
  581. package/dist/cjs/auth/basic.js +18 -0
  582. package/dist/cjs/auth/basic.js.map +1 -0
  583. package/dist/cjs/auth/index.d.ts +65 -0
  584. package/dist/cjs/auth/index.js +69 -0
  585. package/dist/cjs/auth/index.js.map +1 -0
  586. package/dist/cjs/auth/oauth-implicit.d.ts +74 -0
  587. package/dist/cjs/auth/oauth-implicit.js +330 -0
  588. package/dist/cjs/auth/oauth-implicit.js.map +1 -0
  589. package/dist/cjs/auth/oauth.d.ts +48 -0
  590. package/dist/cjs/auth/oauth.js +178 -0
  591. package/dist/cjs/auth/oauth.js.map +1 -0
  592. package/dist/cjs/auth/resolve.d.ts +100 -0
  593. package/dist/cjs/auth/resolve.js +173 -0
  594. package/dist/cjs/auth/resolve.js.map +1 -0
  595. package/dist/cjs/auth/types.d.ts +101 -0
  596. package/dist/cjs/auth/types.js +3 -0
  597. package/dist/cjs/auth/types.js.map +1 -0
  598. package/dist/cjs/cli/base-command.d.ts +98 -0
  599. package/dist/cjs/cli/base-command.js +331 -0
  600. package/dist/cjs/cli/base-command.js.map +1 -0
  601. package/dist/cjs/cli/cartridge-command.d.ts +65 -0
  602. package/dist/cjs/cli/cartridge-command.js +142 -0
  603. package/dist/cjs/cli/cartridge-command.js.map +1 -0
  604. package/dist/cjs/cli/cartridge-providers.d.ts +149 -0
  605. package/dist/cjs/cli/cartridge-providers.js +103 -0
  606. package/dist/cjs/cli/cartridge-providers.js.map +1 -0
  607. package/dist/cjs/cli/config.d.ts +75 -0
  608. package/dist/cjs/cli/config.js +65 -0
  609. package/dist/cjs/cli/config.js.map +1 -0
  610. package/dist/cjs/cli/hooks.d.ts +231 -0
  611. package/dist/cjs/cli/hooks.js +3 -0
  612. package/dist/cjs/cli/hooks.js.map +1 -0
  613. package/dist/cjs/cli/index.d.ts +103 -0
  614. package/dist/cjs/cli/index.js +106 -0
  615. package/dist/cjs/cli/index.js.map +1 -0
  616. package/dist/cjs/cli/instance-command.d.ts +121 -0
  617. package/dist/cjs/cli/instance-command.js +213 -0
  618. package/dist/cjs/cli/instance-command.js.map +1 -0
  619. package/dist/cjs/cli/job-command.d.ts +32 -0
  620. package/dist/cjs/cli/job-command.js +60 -0
  621. package/dist/cjs/cli/job-command.js.map +1 -0
  622. package/dist/cjs/cli/lifecycle.d.ts +189 -0
  623. package/dist/cjs/cli/lifecycle.js +130 -0
  624. package/dist/cjs/cli/lifecycle.js.map +1 -0
  625. package/dist/cjs/cli/mrt-command.d.ts +61 -0
  626. package/dist/cjs/cli/mrt-command.js +113 -0
  627. package/dist/cjs/cli/mrt-command.js.map +1 -0
  628. package/dist/cjs/cli/oauth-command.d.ts +70 -0
  629. package/dist/cjs/cli/oauth-command.js +173 -0
  630. package/dist/cjs/cli/oauth-command.js.map +1 -0
  631. package/dist/cjs/cli/ods-command.d.ts +70 -0
  632. package/dist/cjs/cli/ods-command.js +79 -0
  633. package/dist/cjs/cli/ods-command.js.map +1 -0
  634. package/dist/cjs/cli/table.d.ts +113 -0
  635. package/dist/cjs/cli/table.js +175 -0
  636. package/dist/cjs/cli/table.js.map +1 -0
  637. package/dist/cjs/cli/webdav-command.d.ts +100 -0
  638. package/dist/cjs/cli/webdav-command.js +106 -0
  639. package/dist/cjs/cli/webdav-command.js.map +1 -0
  640. package/dist/cjs/clients/custom-apis.d.ts +137 -0
  641. package/dist/cjs/clients/custom-apis.generated.d.ts +202 -0
  642. package/dist/cjs/clients/custom-apis.generated.js +6 -0
  643. package/dist/cjs/clients/custom-apis.generated.js.map +1 -0
  644. package/dist/cjs/clients/custom-apis.js +124 -0
  645. package/dist/cjs/clients/custom-apis.js.map +1 -0
  646. package/dist/cjs/clients/index.d.ts +127 -0
  647. package/dist/cjs/clients/index.js +125 -0
  648. package/dist/cjs/clients/index.js.map +1 -0
  649. package/dist/cjs/clients/middleware-registry.d.ts +184 -0
  650. package/dist/cjs/clients/middleware-registry.js +104 -0
  651. package/dist/cjs/clients/middleware-registry.js.map +1 -0
  652. package/dist/cjs/clients/middleware.d.ts +85 -0
  653. package/dist/cjs/clients/middleware.js +210 -0
  654. package/dist/cjs/clients/middleware.js.map +1 -0
  655. package/dist/cjs/clients/mrt.d.ts +120 -0
  656. package/dist/cjs/clients/mrt.generated.d.ts +2774 -0
  657. package/dist/cjs/clients/mrt.generated.js +6 -0
  658. package/dist/cjs/clients/mrt.generated.js.map +1 -0
  659. package/dist/cjs/clients/mrt.js +88 -0
  660. package/dist/cjs/clients/mrt.js.map +1 -0
  661. package/dist/cjs/clients/ocapi.d.ts +108 -0
  662. package/dist/cjs/clients/ocapi.generated.d.ts +26052 -0
  663. package/dist/cjs/clients/ocapi.generated.js +6 -0
  664. package/dist/cjs/clients/ocapi.generated.js.map +1 -0
  665. package/dist/cjs/clients/ocapi.js +80 -0
  666. package/dist/cjs/clients/ocapi.js.map +1 -0
  667. package/dist/cjs/clients/ods.d.ts +133 -0
  668. package/dist/cjs/clients/ods.generated.d.ts +2548 -0
  669. package/dist/cjs/clients/ods.generated.js +6 -0
  670. package/dist/cjs/clients/ods.generated.js.map +1 -0
  671. package/dist/cjs/clients/ods.js +103 -0
  672. package/dist/cjs/clients/ods.js.map +1 -0
  673. package/dist/cjs/clients/slas-admin.d.ts +104 -0
  674. package/dist/cjs/clients/slas-admin.generated.d.ts +1434 -0
  675. package/dist/cjs/clients/slas-admin.generated.js +6 -0
  676. package/dist/cjs/clients/slas-admin.generated.js.map +1 -0
  677. package/dist/cjs/clients/slas-admin.js +79 -0
  678. package/dist/cjs/clients/slas-admin.js.map +1 -0
  679. package/dist/cjs/clients/webdav.d.ts +157 -0
  680. package/dist/cjs/clients/webdav.js +337 -0
  681. package/dist/cjs/clients/webdav.js.map +1 -0
  682. package/dist/cjs/config/dw-json.d.ts +114 -0
  683. package/dist/cjs/config/dw-json.js +142 -0
  684. package/dist/cjs/config/dw-json.js.map +1 -0
  685. package/dist/cjs/config/index.d.ts +96 -0
  686. package/dist/cjs/config/index.js +103 -0
  687. package/dist/cjs/config/index.js.map +1 -0
  688. package/dist/cjs/config/mapping.d.ts +143 -0
  689. package/dist/cjs/config/mapping.js +212 -0
  690. package/dist/cjs/config/mapping.js.map +1 -0
  691. package/dist/cjs/config/resolved-config.d.ts +31 -0
  692. package/dist/cjs/config/resolved-config.js +84 -0
  693. package/dist/cjs/config/resolved-config.js.map +1 -0
  694. package/dist/cjs/config/resolver.d.ts +190 -0
  695. package/dist/cjs/config/resolver.js +323 -0
  696. package/dist/cjs/config/resolver.js.map +1 -0
  697. package/dist/cjs/config/sources/dw-json-source.d.ts +10 -0
  698. package/dist/cjs/config/sources/dw-json-source.js +38 -0
  699. package/dist/cjs/config/sources/dw-json-source.js.map +1 -0
  700. package/dist/cjs/config/sources/index.d.ts +7 -0
  701. package/dist/cjs/config/sources/index.js +13 -0
  702. package/dist/cjs/config/sources/index.js.map +1 -0
  703. package/dist/cjs/config/sources/mobify-source.d.ts +24 -0
  704. package/dist/cjs/config/sources/mobify-source.js +79 -0
  705. package/dist/cjs/config/sources/mobify-source.js.map +1 -0
  706. package/dist/cjs/config/types.d.ts +270 -0
  707. package/dist/cjs/config/types.js +2 -0
  708. package/dist/cjs/config/types.js.map +1 -0
  709. package/dist/cjs/defaults.d.ts +22 -0
  710. package/dist/cjs/defaults.js +28 -0
  711. package/dist/cjs/defaults.js.map +1 -0
  712. package/dist/cjs/discovery/detector.d.ts +75 -0
  713. package/dist/cjs/discovery/detector.js +108 -0
  714. package/dist/cjs/discovery/detector.js.map +1 -0
  715. package/dist/cjs/discovery/index.d.ts +63 -0
  716. package/dist/cjs/discovery/index.js +70 -0
  717. package/dist/cjs/discovery/index.js.map +1 -0
  718. package/dist/cjs/discovery/patterns/cartridges.d.ts +16 -0
  719. package/dist/cjs/discovery/patterns/cartridges.js +16 -0
  720. package/dist/cjs/discovery/patterns/cartridges.js.map +1 -0
  721. package/dist/cjs/discovery/patterns/index.d.ts +21 -0
  722. package/dist/cjs/discovery/patterns/index.js +16 -0
  723. package/dist/cjs/discovery/patterns/index.js.map +1 -0
  724. package/dist/cjs/discovery/patterns/pwa-kit.d.ts +15 -0
  725. package/dist/cjs/discovery/patterns/pwa-kit.js +26 -0
  726. package/dist/cjs/discovery/patterns/pwa-kit.js.map +1 -0
  727. package/dist/cjs/discovery/patterns/sfra.d.ts +34 -0
  728. package/dist/cjs/discovery/patterns/sfra.js +50 -0
  729. package/dist/cjs/discovery/patterns/sfra.js.map +1 -0
  730. package/dist/cjs/discovery/patterns/storefront-next.d.ts +14 -0
  731. package/dist/cjs/discovery/patterns/storefront-next.js +20 -0
  732. package/dist/cjs/discovery/patterns/storefront-next.js.map +1 -0
  733. package/dist/cjs/discovery/types.d.ts +47 -0
  734. package/dist/cjs/discovery/types.js +12 -0
  735. package/dist/cjs/discovery/types.js.map +1 -0
  736. package/dist/cjs/discovery/utils.d.ts +44 -0
  737. package/dist/cjs/discovery/utils.js +82 -0
  738. package/dist/cjs/discovery/utils.js.map +1 -0
  739. package/dist/cjs/errors/http-error.d.ts +34 -0
  740. package/dist/cjs/errors/http-error.js +45 -0
  741. package/dist/cjs/errors/http-error.js.map +1 -0
  742. package/dist/cjs/errors/index.d.ts +6 -0
  743. package/dist/cjs/errors/index.js +12 -0
  744. package/dist/cjs/errors/index.js.map +1 -0
  745. package/dist/cjs/i18n/index.d.ts +144 -0
  746. package/dist/cjs/i18n/index.js +242 -0
  747. package/dist/cjs/i18n/index.js.map +1 -0
  748. package/dist/cjs/i18n/locales/de.d.ts +13 -0
  749. package/dist/cjs/i18n/locales/de.js +19 -0
  750. package/dist/cjs/i18n/locales/de.js.map +1 -0
  751. package/dist/cjs/i18n/locales/index.d.ts +28 -0
  752. package/dist/cjs/i18n/locales/index.js +25 -0
  753. package/dist/cjs/i18n/locales/index.js.map +1 -0
  754. package/dist/cjs/index.d.ts +25 -0
  755. package/dist/cjs/index.js +31 -0
  756. package/dist/cjs/index.js.map +1 -0
  757. package/dist/cjs/instance/index.d.ts +132 -0
  758. package/dist/cjs/instance/index.js +124 -0
  759. package/dist/cjs/instance/index.js.map +1 -0
  760. package/dist/cjs/logger.d.ts +66 -0
  761. package/dist/cjs/logger.js +80 -0
  762. package/dist/cjs/logger.js.map +1 -0
  763. package/dist/cjs/logging/index.d.ts +116 -0
  764. package/dist/cjs/logging/index.js +121 -0
  765. package/dist/cjs/logging/index.js.map +1 -0
  766. package/dist/cjs/logging/logger.d.ts +9 -0
  767. package/dist/cjs/logging/logger.js +111 -0
  768. package/dist/cjs/logging/logger.js.map +1 -0
  769. package/dist/cjs/logging/types.d.ts +36 -0
  770. package/dist/cjs/logging/types.js +10 -0
  771. package/dist/cjs/logging/types.js.map +1 -0
  772. package/dist/cjs/operations/code/cartridges.d.ts +46 -0
  773. package/dist/cjs/operations/code/cartridges.js +59 -0
  774. package/dist/cjs/operations/code/cartridges.js.map +1 -0
  775. package/dist/cjs/operations/code/deploy.d.ts +101 -0
  776. package/dist/cjs/operations/code/deploy.js +218 -0
  777. package/dist/cjs/operations/code/deploy.js.map +1 -0
  778. package/dist/cjs/operations/code/index.d.ts +66 -0
  779. package/dist/cjs/operations/code/index.js +72 -0
  780. package/dist/cjs/operations/code/index.js.map +1 -0
  781. package/dist/cjs/operations/code/versions.d.ts +99 -0
  782. package/dist/cjs/operations/code/versions.js +156 -0
  783. package/dist/cjs/operations/code/versions.js.map +1 -0
  784. package/dist/cjs/operations/code/watch.d.ts +58 -0
  785. package/dist/cjs/operations/code/watch.js +226 -0
  786. package/dist/cjs/operations/code/watch.js.map +1 -0
  787. package/dist/cjs/operations/docs/download.d.ts +45 -0
  788. package/dist/cjs/operations/docs/download.js +96 -0
  789. package/dist/cjs/operations/docs/download.js.map +1 -0
  790. package/dist/cjs/operations/docs/index.d.ts +44 -0
  791. package/dist/cjs/operations/docs/index.js +12 -0
  792. package/dist/cjs/operations/docs/index.js.map +1 -0
  793. package/dist/cjs/operations/docs/schema.d.ts +24 -0
  794. package/dist/cjs/operations/docs/schema.js +92 -0
  795. package/dist/cjs/operations/docs/schema.js.map +1 -0
  796. package/dist/cjs/operations/docs/search.d.ts +67 -0
  797. package/dist/cjs/operations/docs/search.js +128 -0
  798. package/dist/cjs/operations/docs/search.js.map +1 -0
  799. package/dist/cjs/operations/docs/types.d.ts +64 -0
  800. package/dist/cjs/operations/docs/types.js +15 -0
  801. package/dist/cjs/operations/docs/types.js.map +1 -0
  802. package/dist/cjs/operations/jobs/index.d.ts +66 -0
  803. package/dist/cjs/operations/jobs/index.js +72 -0
  804. package/dist/cjs/operations/jobs/index.js.map +1 -0
  805. package/dist/cjs/operations/jobs/run.d.ts +224 -0
  806. package/dist/cjs/operations/jobs/run.js +322 -0
  807. package/dist/cjs/operations/jobs/run.js.map +1 -0
  808. package/dist/cjs/operations/jobs/site-archive.d.ts +224 -0
  809. package/dist/cjs/operations/jobs/site-archive.js +354 -0
  810. package/dist/cjs/operations/jobs/site-archive.js.map +1 -0
  811. package/dist/cjs/operations/mrt/bundle.d.ts +114 -0
  812. package/dist/cjs/operations/mrt/bundle.js +166 -0
  813. package/dist/cjs/operations/mrt/bundle.js.map +1 -0
  814. package/dist/cjs/operations/mrt/env-var.d.ts +176 -0
  815. package/dist/cjs/operations/mrt/env-var.js +231 -0
  816. package/dist/cjs/operations/mrt/env-var.js.map +1 -0
  817. package/dist/cjs/operations/mrt/env.d.ts +256 -0
  818. package/dist/cjs/operations/mrt/env.js +233 -0
  819. package/dist/cjs/operations/mrt/env.js.map +1 -0
  820. package/dist/cjs/operations/mrt/index.d.ts +49 -0
  821. package/dist/cjs/operations/mrt/index.js +55 -0
  822. package/dist/cjs/operations/mrt/index.js.map +1 -0
  823. package/dist/cjs/operations/mrt/push.d.ts +109 -0
  824. package/dist/cjs/operations/mrt/push.js +149 -0
  825. package/dist/cjs/operations/mrt/push.js.map +1 -0
  826. package/dist/cjs/operations/sites/index.d.ts +56 -0
  827. package/dist/cjs/operations/sites/index.js +19 -0
  828. package/dist/cjs/operations/sites/index.js.map +1 -0
  829. package/dist/cjs/package.json +1 -0
  830. package/dist/cjs/platform/index.d.ts +38 -0
  831. package/dist/cjs/platform/index.js +42 -0
  832. package/dist/cjs/platform/index.js.map +1 -0
  833. package/dist/cjs/platform/mrt.d.ts +19 -0
  834. package/dist/cjs/platform/mrt.js +22 -0
  835. package/dist/cjs/platform/mrt.js.map +1 -0
  836. package/dist/cjs/platform/ods.d.ts +17 -0
  837. package/dist/cjs/platform/ods.js +22 -0
  838. package/dist/cjs/platform/ods.js.map +1 -0
  839. package/dist/esm/auth/api-key.d.ts +28 -0
  840. package/dist/esm/auth/api-key.js +44 -0
  841. package/dist/esm/auth/api-key.js.map +1 -0
  842. package/dist/esm/auth/basic.d.ts +7 -0
  843. package/dist/esm/auth/basic.js +18 -0
  844. package/dist/esm/auth/basic.js.map +1 -0
  845. package/dist/esm/auth/index.d.ts +65 -0
  846. package/dist/esm/auth/index.js +69 -0
  847. package/dist/esm/auth/index.js.map +1 -0
  848. package/dist/esm/auth/oauth-implicit.d.ts +74 -0
  849. package/dist/esm/auth/oauth-implicit.js +330 -0
  850. package/dist/esm/auth/oauth-implicit.js.map +1 -0
  851. package/dist/esm/auth/oauth.d.ts +48 -0
  852. package/dist/esm/auth/oauth.js +178 -0
  853. package/dist/esm/auth/oauth.js.map +1 -0
  854. package/dist/esm/auth/resolve.d.ts +100 -0
  855. package/dist/esm/auth/resolve.js +173 -0
  856. package/dist/esm/auth/resolve.js.map +1 -0
  857. package/dist/esm/auth/types.d.ts +101 -0
  858. package/dist/esm/auth/types.js +3 -0
  859. package/dist/esm/auth/types.js.map +1 -0
  860. package/dist/esm/cli/base-command.d.ts +98 -0
  861. package/dist/esm/cli/base-command.js +331 -0
  862. package/dist/esm/cli/base-command.js.map +1 -0
  863. package/dist/esm/cli/cartridge-command.d.ts +65 -0
  864. package/dist/esm/cli/cartridge-command.js +142 -0
  865. package/dist/esm/cli/cartridge-command.js.map +1 -0
  866. package/dist/esm/cli/cartridge-providers.d.ts +149 -0
  867. package/dist/esm/cli/cartridge-providers.js +103 -0
  868. package/dist/esm/cli/cartridge-providers.js.map +1 -0
  869. package/dist/esm/cli/config.d.ts +75 -0
  870. package/dist/esm/cli/config.js +65 -0
  871. package/dist/esm/cli/config.js.map +1 -0
  872. package/dist/esm/cli/hooks.d.ts +231 -0
  873. package/dist/esm/cli/hooks.js +3 -0
  874. package/dist/esm/cli/hooks.js.map +1 -0
  875. package/dist/esm/cli/index.d.ts +103 -0
  876. package/dist/esm/cli/index.js +108 -0
  877. package/dist/esm/cli/index.js.map +1 -0
  878. package/dist/esm/cli/instance-command.d.ts +121 -0
  879. package/dist/esm/cli/instance-command.js +213 -0
  880. package/dist/esm/cli/instance-command.js.map +1 -0
  881. package/dist/esm/cli/job-command.d.ts +32 -0
  882. package/dist/esm/cli/job-command.js +66 -0
  883. package/dist/esm/cli/job-command.js.map +1 -0
  884. package/dist/esm/cli/lifecycle.d.ts +189 -0
  885. package/dist/esm/cli/lifecycle.js +130 -0
  886. package/dist/esm/cli/lifecycle.js.map +1 -0
  887. package/dist/esm/cli/mrt-command.d.ts +61 -0
  888. package/dist/esm/cli/mrt-command.js +113 -0
  889. package/dist/esm/cli/mrt-command.js.map +1 -0
  890. package/dist/esm/cli/oauth-command.d.ts +70 -0
  891. package/dist/esm/cli/oauth-command.js +173 -0
  892. package/dist/esm/cli/oauth-command.js.map +1 -0
  893. package/dist/esm/cli/ods-command.d.ts +70 -0
  894. package/dist/esm/cli/ods-command.js +79 -0
  895. package/dist/esm/cli/ods-command.js.map +1 -0
  896. package/dist/esm/cli/table.d.ts +113 -0
  897. package/dist/esm/cli/table.js +175 -0
  898. package/dist/esm/cli/table.js.map +1 -0
  899. package/dist/esm/cli/webdav-command.d.ts +100 -0
  900. package/dist/esm/cli/webdav-command.js +106 -0
  901. package/dist/esm/cli/webdav-command.js.map +1 -0
  902. package/dist/esm/clients/custom-apis.d.ts +137 -0
  903. package/dist/esm/clients/custom-apis.generated.d.ts +202 -0
  904. package/dist/esm/clients/custom-apis.generated.js +6 -0
  905. package/dist/esm/clients/custom-apis.generated.js.map +1 -0
  906. package/dist/esm/clients/custom-apis.js +124 -0
  907. package/dist/esm/clients/custom-apis.js.map +1 -0
  908. package/dist/esm/clients/index.d.ts +127 -0
  909. package/dist/esm/clients/index.js +125 -0
  910. package/dist/esm/clients/index.js.map +1 -0
  911. package/dist/esm/clients/middleware-registry.d.ts +184 -0
  912. package/dist/esm/clients/middleware-registry.js +104 -0
  913. package/dist/esm/clients/middleware-registry.js.map +1 -0
  914. package/dist/esm/clients/middleware.d.ts +85 -0
  915. package/dist/esm/clients/middleware.js +210 -0
  916. package/dist/esm/clients/middleware.js.map +1 -0
  917. package/dist/esm/clients/mrt.d.ts +120 -0
  918. package/dist/esm/clients/mrt.generated.d.ts +2774 -0
  919. package/dist/esm/clients/mrt.generated.js +6 -0
  920. package/dist/esm/clients/mrt.generated.js.map +1 -0
  921. package/dist/esm/clients/mrt.js +88 -0
  922. package/dist/esm/clients/mrt.js.map +1 -0
  923. package/dist/esm/clients/ocapi.d.ts +108 -0
  924. package/dist/esm/clients/ocapi.generated.d.ts +26052 -0
  925. package/dist/esm/clients/ocapi.generated.js +6 -0
  926. package/dist/esm/clients/ocapi.generated.js.map +1 -0
  927. package/dist/esm/clients/ocapi.js +80 -0
  928. package/dist/esm/clients/ocapi.js.map +1 -0
  929. package/dist/esm/clients/ods.d.ts +133 -0
  930. package/dist/esm/clients/ods.generated.d.ts +2548 -0
  931. package/dist/esm/clients/ods.generated.js +6 -0
  932. package/dist/esm/clients/ods.generated.js.map +1 -0
  933. package/dist/esm/clients/ods.js +103 -0
  934. package/dist/esm/clients/ods.js.map +1 -0
  935. package/dist/esm/clients/slas-admin.d.ts +104 -0
  936. package/dist/esm/clients/slas-admin.generated.d.ts +1434 -0
  937. package/dist/esm/clients/slas-admin.generated.js +6 -0
  938. package/dist/esm/clients/slas-admin.generated.js.map +1 -0
  939. package/dist/esm/clients/slas-admin.js +79 -0
  940. package/dist/esm/clients/slas-admin.js.map +1 -0
  941. package/dist/esm/clients/webdav.d.ts +157 -0
  942. package/dist/esm/clients/webdav.js +337 -0
  943. package/dist/esm/clients/webdav.js.map +1 -0
  944. package/dist/esm/config/dw-json.d.ts +114 -0
  945. package/dist/esm/config/dw-json.js +142 -0
  946. package/dist/esm/config/dw-json.js.map +1 -0
  947. package/dist/esm/config/index.d.ts +96 -0
  948. package/dist/esm/config/index.js +103 -0
  949. package/dist/esm/config/index.js.map +1 -0
  950. package/dist/esm/config/mapping.d.ts +143 -0
  951. package/dist/esm/config/mapping.js +212 -0
  952. package/dist/esm/config/mapping.js.map +1 -0
  953. package/dist/esm/config/resolved-config.d.ts +31 -0
  954. package/dist/esm/config/resolved-config.js +84 -0
  955. package/dist/esm/config/resolved-config.js.map +1 -0
  956. package/dist/esm/config/resolver.d.ts +190 -0
  957. package/dist/esm/config/resolver.js +323 -0
  958. package/dist/esm/config/resolver.js.map +1 -0
  959. package/dist/esm/config/sources/dw-json-source.d.ts +10 -0
  960. package/dist/esm/config/sources/dw-json-source.js +38 -0
  961. package/dist/esm/config/sources/dw-json-source.js.map +1 -0
  962. package/dist/esm/config/sources/index.d.ts +7 -0
  963. package/dist/esm/config/sources/index.js +13 -0
  964. package/dist/esm/config/sources/index.js.map +1 -0
  965. package/dist/esm/config/sources/mobify-source.d.ts +24 -0
  966. package/dist/esm/config/sources/mobify-source.js +79 -0
  967. package/dist/esm/config/sources/mobify-source.js.map +1 -0
  968. package/dist/esm/config/types.d.ts +270 -0
  969. package/dist/esm/config/types.js +2 -0
  970. package/dist/esm/config/types.js.map +1 -0
  971. package/dist/esm/defaults.d.ts +22 -0
  972. package/dist/esm/defaults.js +28 -0
  973. package/dist/esm/defaults.js.map +1 -0
  974. package/dist/esm/discovery/detector.d.ts +75 -0
  975. package/dist/esm/discovery/detector.js +108 -0
  976. package/dist/esm/discovery/detector.js.map +1 -0
  977. package/dist/esm/discovery/index.d.ts +63 -0
  978. package/dist/esm/discovery/index.js +70 -0
  979. package/dist/esm/discovery/index.js.map +1 -0
  980. package/dist/esm/discovery/patterns/cartridges.d.ts +16 -0
  981. package/dist/esm/discovery/patterns/cartridges.js +16 -0
  982. package/dist/esm/discovery/patterns/cartridges.js.map +1 -0
  983. package/dist/esm/discovery/patterns/index.d.ts +21 -0
  984. package/dist/esm/discovery/patterns/index.js +16 -0
  985. package/dist/esm/discovery/patterns/index.js.map +1 -0
  986. package/dist/esm/discovery/patterns/pwa-kit.d.ts +15 -0
  987. package/dist/esm/discovery/patterns/pwa-kit.js +26 -0
  988. package/dist/esm/discovery/patterns/pwa-kit.js.map +1 -0
  989. package/dist/esm/discovery/patterns/sfra.d.ts +34 -0
  990. package/dist/esm/discovery/patterns/sfra.js +50 -0
  991. package/dist/esm/discovery/patterns/sfra.js.map +1 -0
  992. package/dist/esm/discovery/patterns/storefront-next.d.ts +14 -0
  993. package/dist/esm/discovery/patterns/storefront-next.js +20 -0
  994. package/dist/esm/discovery/patterns/storefront-next.js.map +1 -0
  995. package/dist/esm/discovery/types.d.ts +47 -0
  996. package/dist/esm/discovery/types.js +12 -0
  997. package/dist/esm/discovery/types.js.map +1 -0
  998. package/dist/esm/discovery/utils.d.ts +44 -0
  999. package/dist/esm/discovery/utils.js +82 -0
  1000. package/dist/esm/discovery/utils.js.map +1 -0
  1001. package/dist/esm/errors/http-error.d.ts +34 -0
  1002. package/dist/esm/errors/http-error.js +45 -0
  1003. package/dist/esm/errors/http-error.js.map +1 -0
  1004. package/dist/esm/errors/index.d.ts +6 -0
  1005. package/dist/esm/errors/index.js +12 -0
  1006. package/dist/esm/errors/index.js.map +1 -0
  1007. package/dist/esm/i18n/index.d.ts +144 -0
  1008. package/dist/esm/i18n/index.js +242 -0
  1009. package/dist/esm/i18n/index.js.map +1 -0
  1010. package/dist/esm/i18n/locales/de.d.ts +13 -0
  1011. package/dist/esm/i18n/locales/de.js +19 -0
  1012. package/dist/esm/i18n/locales/de.js.map +1 -0
  1013. package/dist/esm/i18n/locales/index.d.ts +28 -0
  1014. package/dist/esm/i18n/locales/index.js +25 -0
  1015. package/dist/esm/i18n/locales/index.js.map +1 -0
  1016. package/dist/esm/index.d.ts +25 -0
  1017. package/dist/esm/index.js +31 -0
  1018. package/dist/esm/index.js.map +1 -0
  1019. package/dist/esm/instance/index.d.ts +132 -0
  1020. package/dist/esm/instance/index.js +124 -0
  1021. package/dist/esm/instance/index.js.map +1 -0
  1022. package/dist/esm/logger.d.ts +66 -0
  1023. package/dist/esm/logger.js +80 -0
  1024. package/dist/esm/logger.js.map +1 -0
  1025. package/dist/esm/logging/index.d.ts +116 -0
  1026. package/dist/esm/logging/index.js +121 -0
  1027. package/dist/esm/logging/index.js.map +1 -0
  1028. package/dist/esm/logging/logger.d.ts +9 -0
  1029. package/dist/esm/logging/logger.js +111 -0
  1030. package/dist/esm/logging/logger.js.map +1 -0
  1031. package/dist/esm/logging/types.d.ts +36 -0
  1032. package/dist/esm/logging/types.js +10 -0
  1033. package/dist/esm/logging/types.js.map +1 -0
  1034. package/dist/esm/operations/code/cartridges.d.ts +46 -0
  1035. package/dist/esm/operations/code/cartridges.js +59 -0
  1036. package/dist/esm/operations/code/cartridges.js.map +1 -0
  1037. package/dist/esm/operations/code/deploy.d.ts +101 -0
  1038. package/dist/esm/operations/code/deploy.js +218 -0
  1039. package/dist/esm/operations/code/deploy.js.map +1 -0
  1040. package/dist/esm/operations/code/index.d.ts +66 -0
  1041. package/dist/esm/operations/code/index.js +72 -0
  1042. package/dist/esm/operations/code/index.js.map +1 -0
  1043. package/dist/esm/operations/code/versions.d.ts +99 -0
  1044. package/dist/esm/operations/code/versions.js +157 -0
  1045. package/dist/esm/operations/code/versions.js.map +1 -0
  1046. package/dist/esm/operations/code/watch.d.ts +58 -0
  1047. package/dist/esm/operations/code/watch.js +226 -0
  1048. package/dist/esm/operations/code/watch.js.map +1 -0
  1049. package/dist/esm/operations/docs/download.d.ts +45 -0
  1050. package/dist/esm/operations/docs/download.js +96 -0
  1051. package/dist/esm/operations/docs/download.js.map +1 -0
  1052. package/dist/esm/operations/docs/index.d.ts +44 -0
  1053. package/dist/esm/operations/docs/index.js +12 -0
  1054. package/dist/esm/operations/docs/index.js.map +1 -0
  1055. package/dist/esm/operations/docs/schema.d.ts +24 -0
  1056. package/dist/esm/operations/docs/schema.js +92 -0
  1057. package/dist/esm/operations/docs/schema.js.map +1 -0
  1058. package/dist/esm/operations/docs/search.d.ts +67 -0
  1059. package/dist/esm/operations/docs/search.js +128 -0
  1060. package/dist/esm/operations/docs/search.js.map +1 -0
  1061. package/dist/esm/operations/docs/types.d.ts +64 -0
  1062. package/dist/esm/operations/docs/types.js +15 -0
  1063. package/dist/esm/operations/docs/types.js.map +1 -0
  1064. package/dist/esm/operations/jobs/index.d.ts +66 -0
  1065. package/dist/esm/operations/jobs/index.js +72 -0
  1066. package/dist/esm/operations/jobs/index.js.map +1 -0
  1067. package/dist/esm/operations/jobs/run.d.ts +224 -0
  1068. package/dist/esm/operations/jobs/run.js +333 -0
  1069. package/dist/esm/operations/jobs/run.js.map +1 -0
  1070. package/dist/esm/operations/jobs/site-archive.d.ts +224 -0
  1071. package/dist/esm/operations/jobs/site-archive.js +355 -0
  1072. package/dist/esm/operations/jobs/site-archive.js.map +1 -0
  1073. package/dist/esm/operations/mrt/bundle.d.ts +114 -0
  1074. package/dist/esm/operations/mrt/bundle.js +166 -0
  1075. package/dist/esm/operations/mrt/bundle.js.map +1 -0
  1076. package/dist/esm/operations/mrt/env-var.d.ts +176 -0
  1077. package/dist/esm/operations/mrt/env-var.js +231 -0
  1078. package/dist/esm/operations/mrt/env-var.js.map +1 -0
  1079. package/dist/esm/operations/mrt/env.d.ts +256 -0
  1080. package/dist/esm/operations/mrt/env.js +233 -0
  1081. package/dist/esm/operations/mrt/env.js.map +1 -0
  1082. package/dist/esm/operations/mrt/index.d.ts +49 -0
  1083. package/dist/esm/operations/mrt/index.js +55 -0
  1084. package/dist/esm/operations/mrt/index.js.map +1 -0
  1085. package/dist/esm/operations/mrt/push.d.ts +109 -0
  1086. package/dist/esm/operations/mrt/push.js +149 -0
  1087. package/dist/esm/operations/mrt/push.js.map +1 -0
  1088. package/dist/esm/operations/sites/index.d.ts +56 -0
  1089. package/dist/esm/operations/sites/index.js +67 -0
  1090. package/dist/esm/operations/sites/index.js.map +1 -0
  1091. package/dist/esm/platform/index.d.ts +38 -0
  1092. package/dist/esm/platform/index.js +42 -0
  1093. package/dist/esm/platform/index.js.map +1 -0
  1094. package/dist/esm/platform/mrt.d.ts +19 -0
  1095. package/dist/esm/platform/mrt.js +22 -0
  1096. package/dist/esm/platform/mrt.js.map +1 -0
  1097. package/dist/esm/platform/ods.d.ts +17 -0
  1098. package/dist/esm/platform/ods.js +22 -0
  1099. package/dist/esm/platform/ods.js.map +1 -0
  1100. package/package.json +269 -6
  1101. package/specs/README.md +7 -0
  1102. package/specs/custom-apis-v1.yaml +309 -0
  1103. package/specs/data-api.json +37503 -0
  1104. package/specs/mrt-api-v1.json +5555 -0
  1105. package/specs/ods-api-v1.json +3673 -0
  1106. package/specs/slas-admin-v1.yaml +1841 -0
@@ -0,0 +1,2399 @@
1
+ <!-- prettier-ignore-start -->
2
+ # Class LineItemCtnr
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.LineItemCtnr](dw.order.LineItemCtnr.md)
8
+
9
+ A container for line items, such as ProductLineItems, CouponLineItems, GiftCertificateLineItems. This container also
10
+ provides access to shipments, shipping adjustments (promotions), and payment instruments (credit cards).
11
+
12
+
13
+ LineItemCtnr also contains a set of methods for creating line items and adjustments, and for accessing various price
14
+ values. There are three types of price-related methods:
15
+
16
+
17
+
18
+ - _Net-based_methods represent the amount of a category **before tax has been calculated**. For example, the getMerchandizeTotalNetPrice() returns the price of all merchandise in the container whereas getShippingTotalNetPrice() returns the price of all shipments in the container.
19
+ - _Tax-based_methods return the amount of tax on a category. For example, the getMerchandizeTotalTax() returns the total tax for all merchandise and the getShippingTotalTax() returns the tax applied to all shipments.
20
+ - _Gross-based_methods represent the amount of a category **after tax has been calculated**. For example, the getMerchandizeTotalGrossPrice() returns the price of all merchandise in the container, including tax on the merchandise, whereas getShippingTotalGrossPrice() returns the price of all shipments in the container, including tax on the shipments in the container.
21
+
22
+ There are also a set of methods that provide access to 'adjusted' values. The adjusted-based methods return values
23
+ where promotions have been applied. For example, the getAdjustedMerchandizeTotalNetPrice() method returns the net
24
+ price of all merchandise after product-level and order-level promotions have been applied. Whereas the
25
+ getAdjustedMerchandizeTotalGrossPrice() method returns the price of all merchandise after product-level and
26
+ order-level promotions have been applied and includes the amount of merchandise-related tax.
27
+
28
+
29
+ Finally, there are a set of methods that return the aggregate values representing the line items in the container.
30
+ These are the total-based methods getTotalNetPrice(), getTotalTax() and getTotalGrossPrice(). These methods return
31
+ the totals of all items in the container and include any order-level promotions.
32
+
33
+
34
+ Note that all merchandise-related methods do not include 'gift certificates' values in the values they return. Gift
35
+ certificates are not considered merchandise as they do not represent a product.
36
+
37
+
38
+
39
+ ## All Known Subclasses
40
+ [Basket](dw.order.Basket.md), [Order](dw.order.Order.md)
41
+ ## Constant Summary
42
+
43
+ | Constant | Description |
44
+ | --- | --- |
45
+ | [BUSINESS_TYPE_B2B](#business_type_b2b): [Number](TopLevel.Number.md) = 2 | constant for Business Type B2B |
46
+ | [BUSINESS_TYPE_B2C](#business_type_b2c): [Number](TopLevel.Number.md) = 1 | constant for Business Type B2C |
47
+ | [CHANNEL_TYPE_CALLCENTER](#channel_type_callcenter): [Number](TopLevel.Number.md) = 2 | constant for Channel Type CallCenter |
48
+ | [CHANNEL_TYPE_CUSTOMERSERVICECENTER](#channel_type_customerservicecenter): [Number](TopLevel.Number.md) = 11 | constant for Channel Type Customer Service Center |
49
+ | [CHANNEL_TYPE_DSS](#channel_type_dss): [Number](TopLevel.Number.md) = 4 | constant for Channel Type DSS |
50
+ | [CHANNEL_TYPE_FACEBOOKADS](#channel_type_facebookads): [Number](TopLevel.Number.md) = 8 | constant for Channel Type Facebook Ads |
51
+ | [CHANNEL_TYPE_GOOGLE](#channel_type_google): [Number](TopLevel.Number.md) = 13 | constant for Channel Type Google |
52
+ | [CHANNEL_TYPE_INSTAGRAMCOMMERCE](#channel_type_instagramcommerce): [Number](TopLevel.Number.md) = 12 | constant for Channel Type Instagram Commerce |
53
+ | [CHANNEL_TYPE_MARKETPLACE](#channel_type_marketplace): [Number](TopLevel.Number.md) = 3 | constant for Channel Type Marketplace |
54
+ | [CHANNEL_TYPE_ONLINERESERVATION](#channel_type_onlinereservation): [Number](TopLevel.Number.md) = 10 | constant for Channel Type Online Reservation |
55
+ | [CHANNEL_TYPE_PINTEREST](#channel_type_pinterest): [Number](TopLevel.Number.md) = 6 | constant for Channel Type Pinterest |
56
+ | [CHANNEL_TYPE_SNAPCHAT](#channel_type_snapchat): [Number](TopLevel.Number.md) = 15 | constant for Channel Type Snapchat |
57
+ | [CHANNEL_TYPE_STORE](#channel_type_store): [Number](TopLevel.Number.md) = 5 | constant for Channel Type Store |
58
+ | [CHANNEL_TYPE_STOREFRONT](#channel_type_storefront): [Number](TopLevel.Number.md) = 1 | constant for Channel Type Storefront |
59
+ | [CHANNEL_TYPE_SUBSCRIPTIONS](#channel_type_subscriptions): [Number](TopLevel.Number.md) = 9 | constant for Channel Type Subscriptions |
60
+ | [CHANNEL_TYPE_TIKTOK](#channel_type_tiktok): [Number](TopLevel.Number.md) = 14 | constant for Channel Type TikTok |
61
+ | [CHANNEL_TYPE_TWITTER](#channel_type_twitter): [Number](TopLevel.Number.md) = 7 | constant for Channel Type Twitter |
62
+ | [CHANNEL_TYPE_WHATSAPP](#channel_type_whatsapp): [Number](TopLevel.Number.md) = 16 | constant for Channel Type WhatsApp |
63
+ | [CHANNEL_TYPE_YOUTUBE](#channel_type_youtube): [Number](TopLevel.Number.md) = 17 | constant for Channel Type YouTube |
64
+
65
+ ## Property Summary
66
+
67
+ | Property | Description |
68
+ | --- | --- |
69
+ | [adjustedMerchandizeTotalGrossPrice](#adjustedmerchandizetotalgrossprice): [Money](dw.value.Money.md) `(read-only)` | Returns the adjusted total gross price (including tax) in purchase currency. |
70
+ | [adjustedMerchandizeTotalNetPrice](#adjustedmerchandizetotalnetprice): [Money](dw.value.Money.md) `(read-only)` | Returns the total net price (excluding tax) in purchase currency. |
71
+ | [adjustedMerchandizeTotalPrice](#adjustedmerchandizetotalprice): [Money](dw.value.Money.md) `(read-only)` | Returns the adjusted merchandize total price including product-level and order-level adjustments. |
72
+ | [adjustedMerchandizeTotalTax](#adjustedmerchandizetotaltax): [Money](dw.value.Money.md) `(read-only)` | Returns the subtotal tax in purchase currency. |
73
+ | [adjustedShippingTotalGrossPrice](#adjustedshippingtotalgrossprice): [Money](dw.value.Money.md) `(read-only)` | Returns the adjusted sum of all shipping line items of the line item container, including tax after shipping adjustments have been applied. |
74
+ | [adjustedShippingTotalNetPrice](#adjustedshippingtotalnetprice): [Money](dw.value.Money.md) `(read-only)` | Returns the sum of all shipping line items of the line item container, excluding tax after shipping adjustments have been applied. |
75
+ | [adjustedShippingTotalPrice](#adjustedshippingtotalprice): [Money](dw.value.Money.md) `(read-only)` | Returns the adjusted shipping total price. |
76
+ | [adjustedShippingTotalTax](#adjustedshippingtotaltax): [Money](dw.value.Money.md) `(read-only)` | Returns the tax of all shipping line items of the line item container after shipping adjustments have been applied. |
77
+ | ~~[allGiftCertificateLineItems](#allgiftcertificatelineitems): [Collection](dw.util.Collection.md)~~ `(read-only)` | Returns all gift certificate line items of the container. |
78
+ | [allLineItems](#alllineitems): [Collection](dw.util.Collection.md) `(read-only)` | Returns all product, shipping, price adjustment, and gift certificate line items of the line item container. |
79
+ | [allProductLineItems](#allproductlineitems): [Collection](dw.util.Collection.md) `(read-only)` | Returns all product line items of the container, no matter if they are dependent or independent. |
80
+ | [allProductQuantities](#allproductquantities): [HashMap](dw.util.HashMap.md) `(read-only)` | Returns a hash mapping all products in the line item container to their total quantities. |
81
+ | [allShippingPriceAdjustments](#allshippingpriceadjustments): [Collection](dw.util.Collection.md) `(read-only)` | Returns the collection of all shipping price adjustments applied somewhere in the container. |
82
+ | [billingAddress](#billingaddress): [OrderAddress](dw.order.OrderAddress.md) `(read-only)` | Returns the billing address defined for the container. |
83
+ | [bonusDiscountLineItems](#bonusdiscountlineitems): [Collection](dw.util.Collection.md) `(read-only)` | Returns an unsorted collection of the the bonus discount line items associated with this container. |
84
+ | [bonusLineItems](#bonuslineitems): [Collection](dw.util.Collection.md) `(read-only)` | Returns the collection of product line items that are bonus items (where [ProductLineItem.isBonusProductLineItem()](dw.order.ProductLineItem.md#isbonusproductlineitem) is true). |
85
+ | [businessType](#businesstype): [EnumValue](dw.value.EnumValue.md) `(read-only)` | Returns the type of the business this order has been placed in.<br/> Possible values are [BUSINESS_TYPE_B2C](dw.order.LineItemCtnr.md#business_type_b2c) or [BUSINESS_TYPE_B2B](dw.order.LineItemCtnr.md#business_type_b2b). |
86
+ | [channelType](#channeltype): [EnumValue](dw.value.EnumValue.md) `(read-only)` | The channel type defines in which sales channel this order has been created. |
87
+ | [couponLineItems](#couponlineitems): [Collection](dw.util.Collection.md) `(read-only)` | Returns a sorted collection of the coupon line items in the container. |
88
+ | [currencyCode](#currencycode): [String](TopLevel.String.md) `(read-only)` | Returns the currency code for this line item container. |
89
+ | [customer](#customer): [Customer](dw.customer.Customer.md) `(read-only)` | Returns the customer associated with this container. |
90
+ | [customerEmail](#customeremail): [String](TopLevel.String.md) | Returns the email of the customer associated with this container. |
91
+ | [customerName](#customername): [String](TopLevel.String.md) | Returns the name of the customer associated with this container. |
92
+ | [customerNo](#customerno): [String](TopLevel.String.md) `(read-only)` | Returns the customer number of the customer associated with this container. |
93
+ | [defaultShipment](#defaultshipment): [Shipment](dw.order.Shipment.md) `(read-only)` | Returns the default shipment of the line item container. |
94
+ | [etag](#etag): [String](TopLevel.String.md) `(read-only)` | Returns the Etag of the line item container. |
95
+ | [externallyTaxed](#externallytaxed): [Boolean](TopLevel.Boolean.md) `(read-only)` | Use this method to check whether the LineItemCtnr is calculated based on external tax tables. |
96
+ | [giftCertificateLineItems](#giftcertificatelineitems): [Collection](dw.util.Collection.md) `(read-only)` | Returns all gift certificate line items of the container. |
97
+ | [giftCertificatePaymentInstruments](#giftcertificatepaymentinstruments): [Collection](dw.util.Collection.md) `(read-only)` | Returns an unsorted collection of the PaymentInstrument instances that represent GiftCertificates in this container. |
98
+ | [giftCertificateTotalGrossPrice](#giftcertificatetotalgrossprice): [Money](dw.value.Money.md) `(read-only)` | Returns the total gross price of all gift certificates in the cart. |
99
+ | [giftCertificateTotalNetPrice](#giftcertificatetotalnetprice): [Money](dw.value.Money.md) `(read-only)` | Returns the total net price (excluding tax) of all gift certificates in the cart. |
100
+ | [giftCertificateTotalPrice](#giftcertificatetotalprice): [Money](dw.value.Money.md) `(read-only)` | Returns the gift certificate total price. |
101
+ | [giftCertificateTotalTax](#giftcertificatetotaltax): [Money](dw.value.Money.md) `(read-only)` | Returns the total tax of all gift certificates in the cart. |
102
+ | [merchandizeTotalGrossPrice](#merchandizetotalgrossprice): [Money](dw.value.Money.md) `(read-only)` | Returns the total gross price (including tax) in purchase currency. |
103
+ | [merchandizeTotalNetPrice](#merchandizetotalnetprice): [Money](dw.value.Money.md) `(read-only)` | Returns the total net price (excluding tax) in purchase currency. |
104
+ | [merchandizeTotalPrice](#merchandizetotalprice): [Money](dw.value.Money.md) `(read-only)` | Returns the merchandize total price. |
105
+ | [merchandizeTotalTax](#merchandizetotaltax): [Money](dw.value.Money.md) `(read-only)` | Returns the total tax in purchase currency. |
106
+ | [notes](#notes): [List](dw.util.List.md) `(read-only)` | Returns the list of notes for this object, ordered by creation time from oldest to newest. |
107
+ | ~~[paymentInstrument](#paymentinstrument): [OrderPaymentInstrument](dw.order.OrderPaymentInstrument.md)~~ `(read-only)` | Returns the payment instrument of the line item container or null. |
108
+ | [paymentInstruments](#paymentinstruments): [Collection](dw.util.Collection.md) `(read-only)` | Returns an unsorted collection of the payment instruments in this container. |
109
+ | [priceAdjustments](#priceadjustments): [Collection](dw.util.Collection.md) `(read-only)` | Returns the collection of price adjustments that have been applied to the totals such as promotion on the purchase value (i.e. |
110
+ | [productLineItems](#productlineitems): [Collection](dw.util.Collection.md) `(read-only)` | Returns the product line items of the container that are not dependent on other product line items. |
111
+ | [productQuantities](#productquantities): [HashMap](dw.util.HashMap.md) `(read-only)` | Returns a hash map of all products in the line item container and their total quantities. |
112
+ | [productQuantityTotal](#productquantitytotal): [Number](TopLevel.Number.md) `(read-only)` | Returns the total quantity of all product line items. |
113
+ | [shipments](#shipments): [Collection](dw.util.Collection.md) `(read-only)` | Returns all shipments of the line item container.<br/> The first shipment in the returned collection is the default shipment (shipment ID always set to "me"). |
114
+ | [shippingPriceAdjustments](#shippingpriceadjustments): [Collection](dw.util.Collection.md) `(read-only)` | Returns the of shipping price adjustments applied to the shipping total of the container. |
115
+ | [shippingTotalGrossPrice](#shippingtotalgrossprice): [Money](dw.value.Money.md) `(read-only)` | Returns the sum of all shipping line items of the line item container, including tax before shipping adjustments have been applied. |
116
+ | [shippingTotalNetPrice](#shippingtotalnetprice): [Money](dw.value.Money.md) `(read-only)` | Returns the sum of all shipping line items of the line item container, excluding tax before shipping adjustments have been applied. |
117
+ | [shippingTotalPrice](#shippingtotalprice): [Money](dw.value.Money.md) `(read-only)` | Returns the shipping total price. |
118
+ | [shippingTotalTax](#shippingtotaltax): [Money](dw.value.Money.md) `(read-only)` | Returns the tax of all shipping line items of the line item container before shipping adjustments have been applied. |
119
+ | [taxRoundedAtGroup](#taxroundedatgroup): [Boolean](TopLevel.Boolean.md) `(read-only)` | Use this method to check if the LineItemCtnr was calculated with grouped taxation calculation. |
120
+ | [taxTotalsPerTaxRate](#taxtotalspertaxrate): [SortedMap](dw.util.SortedMap.md) `(read-only)` | This method returns a [SortedMap](dw.util.SortedMap.md) in which the keys are [Decimal](dw.util.Decimal.md) tax rates and the values are [Money](dw.value.Money.md) total tax for the tax rate. |
121
+ | [totalGrossPrice](#totalgrossprice): [Money](dw.value.Money.md) `(read-only)` | Returns the grand total price gross of tax for LineItemCtnr, in purchase currency. |
122
+ | [totalNetPrice](#totalnetprice): [Money](dw.value.Money.md) `(read-only)` | Returns the grand total price for LineItemCtnr net of tax, in purchase currency. |
123
+ | [totalTax](#totaltax): [Money](dw.value.Money.md) `(read-only)` | Returns the grand total tax for LineItemCtnr, in purchase currency. |
124
+
125
+ ## Constructor Summary
126
+
127
+ This class does not have a constructor, so you cannot create it directly.
128
+ ## Method Summary
129
+
130
+ | Method | Description |
131
+ | --- | --- |
132
+ | [addNote](dw.order.LineItemCtnr.md#addnotestring-string)([String](TopLevel.String.md), [String](TopLevel.String.md)) | Adds a note to the object. |
133
+ | [createBillingAddress](dw.order.LineItemCtnr.md#createbillingaddress)() | Create a billing address for the LineItemCtnr. |
134
+ | [createBonusProductLineItem](dw.order.LineItemCtnr.md#createbonusproductlineitembonusdiscountlineitem-product-productoptionmodel-shipment)([BonusDiscountLineItem](dw.order.BonusDiscountLineItem.md), [Product](dw.catalog.Product.md), [ProductOptionModel](dw.catalog.ProductOptionModel.md), [Shipment](dw.order.Shipment.md)) | Creates a product line item in the container based on the passed Product and BonusDiscountLineItem. |
135
+ | [createCouponLineItem](dw.order.LineItemCtnr.md#createcouponlineitemstring)([String](TopLevel.String.md)) | Creates a coupon line item that is not based on the B2C Commerce campaign system and associates it with the specified coupon code. |
136
+ | [createCouponLineItem](dw.order.LineItemCtnr.md#createcouponlineitemstring-boolean)([String](TopLevel.String.md), [Boolean](TopLevel.Boolean.md)) | Creates a new CouponLineItem for this container based on the supplied coupon code. |
137
+ | [createGiftCertificateLineItem](dw.order.LineItemCtnr.md#creategiftcertificatelineitemnumber-string)([Number](TopLevel.Number.md), [String](TopLevel.String.md)) | Creates a gift certificate line item. |
138
+ | [createGiftCertificatePaymentInstrument](dw.order.LineItemCtnr.md#creategiftcertificatepaymentinstrumentstring-money)([String](TopLevel.String.md), [Money](dw.value.Money.md)) | Creates an OrderPaymentInstrument representing a Gift Certificate. |
139
+ | [createPaymentInstrument](dw.order.LineItemCtnr.md#createpaymentinstrumentstring-money)([String](TopLevel.String.md), [Money](dw.value.Money.md)) | Creates a payment instrument using the specified payment method id and amount. |
140
+ | [createPaymentInstrumentFromWallet](dw.order.LineItemCtnr.md#createpaymentinstrumentfromwalletcustomerpaymentinstrument-money)([CustomerPaymentInstrument](dw.customer.CustomerPaymentInstrument.md), [Money](dw.value.Money.md)) | Creates a payment instrument using the specified wallet payment instrument and amount. |
141
+ | [createPriceAdjustment](dw.order.LineItemCtnr.md#createpriceadjustmentstring)([String](TopLevel.String.md)) | Creates an order price adjustment.<br/> The promotion id is mandatory and must not be the ID of any actual promotion defined in B2C Commerce; otherwise an exception is thrown. |
142
+ | [createPriceAdjustment](dw.order.LineItemCtnr.md#createpriceadjustmentstring-discount)([String](TopLevel.String.md), [Discount](dw.campaign.Discount.md)) | Creates an order level price adjustment for a specific discount.<br/> The promotion id is mandatory and must not be the ID of any actual promotion defined in B2C Commerce; otherwise an exception is thrown. |
143
+ | [createProductLineItem](dw.order.LineItemCtnr.md#createproductlineitemproduct-productoptionmodel-shipment)([Product](dw.catalog.Product.md), [ProductOptionModel](dw.catalog.ProductOptionModel.md), [Shipment](dw.order.Shipment.md)) | Creates a new product line item in the container and assigns it to the specified shipment. |
144
+ | [createProductLineItem](dw.order.LineItemCtnr.md#createproductlineitemproductlistitem-shipment)([ProductListItem](dw.customer.ProductListItem.md), [Shipment](dw.order.Shipment.md)) | Creates a new product line item in the basket and assigns it to the specified shipment. |
145
+ | [createProductLineItem](dw.order.LineItemCtnr.md#createproductlineitemstring-shipment)([String](TopLevel.String.md), [Shipment](dw.order.Shipment.md)) | Creates a new product line item in the container and assigns it to the specified shipment. |
146
+ | ~~[createProductLineItem](dw.order.LineItemCtnr.md#createproductlineitemstring-quantity-shipment)([String](TopLevel.String.md), [Quantity](dw.value.Quantity.md), [Shipment](dw.order.Shipment.md))~~ | Creates a new product line item in the container and assigns it to the specified shipment. |
147
+ | [createShipment](dw.order.LineItemCtnr.md#createshipmentstring)([String](TopLevel.String.md)) | Creates a standard shipment for the line item container. |
148
+ | [createShippingPriceAdjustment](dw.order.LineItemCtnr.md#createshippingpriceadjustmentstring)([String](TopLevel.String.md)) | Creates a shipping price adjustment to be applied to the container. |
149
+ | [getAdjustedMerchandizeTotalGrossPrice](dw.order.LineItemCtnr.md#getadjustedmerchandizetotalgrossprice)() | Returns the adjusted total gross price (including tax) in purchase currency. |
150
+ | [getAdjustedMerchandizeTotalNetPrice](dw.order.LineItemCtnr.md#getadjustedmerchandizetotalnetprice)() | Returns the total net price (excluding tax) in purchase currency. |
151
+ | [getAdjustedMerchandizeTotalPrice](dw.order.LineItemCtnr.md#getadjustedmerchandizetotalprice)() | Returns the adjusted merchandize total price including product-level and order-level adjustments. |
152
+ | [getAdjustedMerchandizeTotalPrice](dw.order.LineItemCtnr.md#getadjustedmerchandizetotalpriceboolean)([Boolean](TopLevel.Boolean.md)) | Returns the adjusted merchandize total price including order-level adjustments if requested. |
153
+ | [getAdjustedMerchandizeTotalTax](dw.order.LineItemCtnr.md#getadjustedmerchandizetotaltax)() | Returns the subtotal tax in purchase currency. |
154
+ | [getAdjustedShippingTotalGrossPrice](dw.order.LineItemCtnr.md#getadjustedshippingtotalgrossprice)() | Returns the adjusted sum of all shipping line items of the line item container, including tax after shipping adjustments have been applied. |
155
+ | [getAdjustedShippingTotalNetPrice](dw.order.LineItemCtnr.md#getadjustedshippingtotalnetprice)() | Returns the sum of all shipping line items of the line item container, excluding tax after shipping adjustments have been applied. |
156
+ | [getAdjustedShippingTotalPrice](dw.order.LineItemCtnr.md#getadjustedshippingtotalprice)() | Returns the adjusted shipping total price. |
157
+ | [getAdjustedShippingTotalTax](dw.order.LineItemCtnr.md#getadjustedshippingtotaltax)() | Returns the tax of all shipping line items of the line item container after shipping adjustments have been applied. |
158
+ | ~~[getAllGiftCertificateLineItems](dw.order.LineItemCtnr.md#getallgiftcertificatelineitems)()~~ | Returns all gift certificate line items of the container. |
159
+ | [getAllLineItems](dw.order.LineItemCtnr.md#getalllineitems)() | Returns all product, shipping, price adjustment, and gift certificate line items of the line item container. |
160
+ | [getAllProductLineItems](dw.order.LineItemCtnr.md#getallproductlineitems)() | Returns all product line items of the container, no matter if they are dependent or independent. |
161
+ | [getAllProductLineItems](dw.order.LineItemCtnr.md#getallproductlineitemsstring)([String](TopLevel.String.md)) | Returns all product line items of the container that have a product ID equal to the specified product ID, no matter if they are dependent or independent. |
162
+ | [getAllProductQuantities](dw.order.LineItemCtnr.md#getallproductquantities)() | Returns a hash mapping all products in the line item container to their total quantities. |
163
+ | [getAllShippingPriceAdjustments](dw.order.LineItemCtnr.md#getallshippingpriceadjustments)() | Returns the collection of all shipping price adjustments applied somewhere in the container. |
164
+ | [getBillingAddress](dw.order.LineItemCtnr.md#getbillingaddress)() | Returns the billing address defined for the container. |
165
+ | [getBonusDiscountLineItems](dw.order.LineItemCtnr.md#getbonusdiscountlineitems)() | Returns an unsorted collection of the the bonus discount line items associated with this container. |
166
+ | [getBonusLineItems](dw.order.LineItemCtnr.md#getbonuslineitems)() | Returns the collection of product line items that are bonus items (where [ProductLineItem.isBonusProductLineItem()](dw.order.ProductLineItem.md#isbonusproductlineitem) is true). |
167
+ | [getBusinessType](dw.order.LineItemCtnr.md#getbusinesstype)() | Returns the type of the business this order has been placed in.<br/> Possible values are [BUSINESS_TYPE_B2C](dw.order.LineItemCtnr.md#business_type_b2c) or [BUSINESS_TYPE_B2B](dw.order.LineItemCtnr.md#business_type_b2b). |
168
+ | [getChannelType](dw.order.LineItemCtnr.md#getchanneltype)() | The channel type defines in which sales channel this order has been created. |
169
+ | [getCouponLineItem](dw.order.LineItemCtnr.md#getcouponlineitemstring)([String](TopLevel.String.md)) | Returns the coupon line item representing the specified coupon code. |
170
+ | [getCouponLineItems](dw.order.LineItemCtnr.md#getcouponlineitems)() | Returns a sorted collection of the coupon line items in the container. |
171
+ | [getCurrencyCode](dw.order.LineItemCtnr.md#getcurrencycode)() | Returns the currency code for this line item container. |
172
+ | [getCustomer](dw.order.LineItemCtnr.md#getcustomer)() | Returns the customer associated with this container. |
173
+ | [getCustomerEmail](dw.order.LineItemCtnr.md#getcustomeremail)() | Returns the email of the customer associated with this container. |
174
+ | [getCustomerName](dw.order.LineItemCtnr.md#getcustomername)() | Returns the name of the customer associated with this container. |
175
+ | [getCustomerNo](dw.order.LineItemCtnr.md#getcustomerno)() | Returns the customer number of the customer associated with this container. |
176
+ | [getDefaultShipment](dw.order.LineItemCtnr.md#getdefaultshipment)() | Returns the default shipment of the line item container. |
177
+ | [getEtag](dw.order.LineItemCtnr.md#getetag)() | Returns the Etag of the line item container. |
178
+ | [getGiftCertificateLineItems](dw.order.LineItemCtnr.md#getgiftcertificatelineitems)() | Returns all gift certificate line items of the container. |
179
+ | [getGiftCertificateLineItems](dw.order.LineItemCtnr.md#getgiftcertificatelineitemsstring)([String](TopLevel.String.md)) | Returns all gift certificate line items of the container, no matter if they are dependent or independent. |
180
+ | [getGiftCertificatePaymentInstruments](dw.order.LineItemCtnr.md#getgiftcertificatepaymentinstruments)() | Returns an unsorted collection of the PaymentInstrument instances that represent GiftCertificates in this container. |
181
+ | [getGiftCertificatePaymentInstruments](dw.order.LineItemCtnr.md#getgiftcertificatepaymentinstrumentsstring)([String](TopLevel.String.md)) | Returns an unsorted collection containing all PaymentInstruments of type PaymentInstrument.METHOD\_GIFT\_CERTIFICATE where the specified code is the same code on the payment instrument. |
182
+ | [getGiftCertificateTotalGrossPrice](dw.order.LineItemCtnr.md#getgiftcertificatetotalgrossprice)() | Returns the total gross price of all gift certificates in the cart. |
183
+ | [getGiftCertificateTotalNetPrice](dw.order.LineItemCtnr.md#getgiftcertificatetotalnetprice)() | Returns the total net price (excluding tax) of all gift certificates in the cart. |
184
+ | [getGiftCertificateTotalPrice](dw.order.LineItemCtnr.md#getgiftcertificatetotalprice)() | Returns the gift certificate total price. |
185
+ | [getGiftCertificateTotalTax](dw.order.LineItemCtnr.md#getgiftcertificatetotaltax)() | Returns the total tax of all gift certificates in the cart. |
186
+ | [getMerchandizeTotalGrossPrice](dw.order.LineItemCtnr.md#getmerchandizetotalgrossprice)() | Returns the total gross price (including tax) in purchase currency. |
187
+ | [getMerchandizeTotalNetPrice](dw.order.LineItemCtnr.md#getmerchandizetotalnetprice)() | Returns the total net price (excluding tax) in purchase currency. |
188
+ | [getMerchandizeTotalPrice](dw.order.LineItemCtnr.md#getmerchandizetotalprice)() | Returns the merchandize total price. |
189
+ | [getMerchandizeTotalTax](dw.order.LineItemCtnr.md#getmerchandizetotaltax)() | Returns the total tax in purchase currency. |
190
+ | [getNotes](dw.order.LineItemCtnr.md#getnotes)() | Returns the list of notes for this object, ordered by creation time from oldest to newest. |
191
+ | ~~[getPaymentInstrument](dw.order.LineItemCtnr.md#getpaymentinstrument)()~~ | Returns the payment instrument of the line item container or null. |
192
+ | [getPaymentInstruments](dw.order.LineItemCtnr.md#getpaymentinstruments)() | Returns an unsorted collection of the payment instruments in this container. |
193
+ | [getPaymentInstruments](dw.order.LineItemCtnr.md#getpaymentinstrumentsstring)([String](TopLevel.String.md)) | Returns an unsorted collection of PaymentInstrument instances based on the specified payment method ID. |
194
+ | [getPriceAdjustmentByPromotionID](dw.order.LineItemCtnr.md#getpriceadjustmentbypromotionidstring)([String](TopLevel.String.md)) | Returns the price adjustment associated to the specified promotion ID. |
195
+ | [getPriceAdjustments](dw.order.LineItemCtnr.md#getpriceadjustments)() | Returns the collection of price adjustments that have been applied to the totals such as promotion on the purchase value (i.e. |
196
+ | [getProductLineItems](dw.order.LineItemCtnr.md#getproductlineitems)() | Returns the product line items of the container that are not dependent on other product line items. |
197
+ | [getProductLineItems](dw.order.LineItemCtnr.md#getproductlineitemsstring)([String](TopLevel.String.md)) | Returns the product line items of the container that have a product ID equal to the specified product ID and that are not dependent on other product line items. |
198
+ | [getProductQuantities](dw.order.LineItemCtnr.md#getproductquantities)() | Returns a hash map of all products in the line item container and their total quantities. |
199
+ | [getProductQuantities](dw.order.LineItemCtnr.md#getproductquantitiesboolean)([Boolean](TopLevel.Boolean.md)) | Returns a hash map of all products in the line item container and their total quantities. |
200
+ | [getProductQuantityTotal](dw.order.LineItemCtnr.md#getproductquantitytotal)() | Returns the total quantity of all product line items. |
201
+ | [getShipment](dw.order.LineItemCtnr.md#getshipmentstring)([String](TopLevel.String.md)) | Returns the shipment for the specified ID or `null` if no shipment with this ID exists in the line item container. |
202
+ | [getShipments](dw.order.LineItemCtnr.md#getshipments)() | Returns all shipments of the line item container.<br/> The first shipment in the returned collection is the default shipment (shipment ID always set to "me"). |
203
+ | [getShippingPriceAdjustmentByPromotionID](dw.order.LineItemCtnr.md#getshippingpriceadjustmentbypromotionidstring)([String](TopLevel.String.md)) | Returns the shipping price adjustment associated with the specified promotion ID. |
204
+ | [getShippingPriceAdjustments](dw.order.LineItemCtnr.md#getshippingpriceadjustments)() | Returns the of shipping price adjustments applied to the shipping total of the container. |
205
+ | [getShippingTotalGrossPrice](dw.order.LineItemCtnr.md#getshippingtotalgrossprice)() | Returns the sum of all shipping line items of the line item container, including tax before shipping adjustments have been applied. |
206
+ | [getShippingTotalNetPrice](dw.order.LineItemCtnr.md#getshippingtotalnetprice)() | Returns the sum of all shipping line items of the line item container, excluding tax before shipping adjustments have been applied. |
207
+ | [getShippingTotalPrice](dw.order.LineItemCtnr.md#getshippingtotalprice)() | Returns the shipping total price. |
208
+ | [getShippingTotalTax](dw.order.LineItemCtnr.md#getshippingtotaltax)() | Returns the tax of all shipping line items of the line item container before shipping adjustments have been applied. |
209
+ | [getTaxTotalsPerTaxRate](dw.order.LineItemCtnr.md#gettaxtotalspertaxrate)() | This method returns a [SortedMap](dw.util.SortedMap.md) in which the keys are [Decimal](dw.util.Decimal.md) tax rates and the values are [Money](dw.value.Money.md) total tax for the tax rate. |
210
+ | [getTotalGrossPrice](dw.order.LineItemCtnr.md#gettotalgrossprice)() | Returns the grand total price gross of tax for LineItemCtnr, in purchase currency. |
211
+ | [getTotalNetPrice](dw.order.LineItemCtnr.md#gettotalnetprice)() | Returns the grand total price for LineItemCtnr net of tax, in purchase currency. |
212
+ | [getTotalTax](dw.order.LineItemCtnr.md#gettotaltax)() | Returns the grand total tax for LineItemCtnr, in purchase currency. |
213
+ | [isExternallyTaxed](dw.order.LineItemCtnr.md#isexternallytaxed)() | Use this method to check whether the LineItemCtnr is calculated based on external tax tables. |
214
+ | [isTaxRoundedAtGroup](dw.order.LineItemCtnr.md#istaxroundedatgroup)() | Use this method to check if the LineItemCtnr was calculated with grouped taxation calculation. |
215
+ | [removeAllPaymentInstruments](dw.order.LineItemCtnr.md#removeallpaymentinstruments)() | Removes the all Payment Instruments from this container and deletes the Payment Instruments. |
216
+ | [removeBonusDiscountLineItem](dw.order.LineItemCtnr.md#removebonusdiscountlineitembonusdiscountlineitem)([BonusDiscountLineItem](dw.order.BonusDiscountLineItem.md)) | Removes the specified bonus discount line item from the line item container. |
217
+ | [removeCouponLineItem](dw.order.LineItemCtnr.md#removecouponlineitemcouponlineitem)([CouponLineItem](dw.order.CouponLineItem.md)) | Removes the specified coupon line item from the line item container. |
218
+ | [removeGiftCertificateLineItem](dw.order.LineItemCtnr.md#removegiftcertificatelineitemgiftcertificatelineitem)([GiftCertificateLineItem](dw.order.GiftCertificateLineItem.md)) | Removes the specified gift certificate line item from the line item container. |
219
+ | [removeNote](dw.order.LineItemCtnr.md#removenotenote)([Note](dw.object.Note.md)) | Removes a note from this line item container and deletes it. |
220
+ | [removePaymentInstrument](dw.order.LineItemCtnr.md#removepaymentinstrumentpaymentinstrument)([PaymentInstrument](dw.order.PaymentInstrument.md)) | Removes the specified Payment Instrument from this container and deletes the Payment Instrument. |
221
+ | [removePriceAdjustment](dw.order.LineItemCtnr.md#removepriceadjustmentpriceadjustment)([PriceAdjustment](dw.order.PriceAdjustment.md)) | Removes the specified price adjustment line item from the line item container. |
222
+ | [removeProductLineItem](dw.order.LineItemCtnr.md#removeproductlineitemproductlineitem)([ProductLineItem](dw.order.ProductLineItem.md)) | Removes the specified product line item from the line item container. |
223
+ | [removeShipment](dw.order.LineItemCtnr.md#removeshipmentshipment)([Shipment](dw.order.Shipment.md)) | Removes the specified shipment and all associated product, gift certificate, shipping and price adjustment line items from the line item container. |
224
+ | [removeShippingPriceAdjustment](dw.order.LineItemCtnr.md#removeshippingpriceadjustmentpriceadjustment)([PriceAdjustment](dw.order.PriceAdjustment.md)) | Removes the specified shipping price adjustment line item from the line item container. |
225
+ | [setCustomerEmail](dw.order.LineItemCtnr.md#setcustomeremailstring)([String](TopLevel.String.md)) | Sets the email address of the customer associated with this container. |
226
+ | [setCustomerName](dw.order.LineItemCtnr.md#setcustomernamestring)([String](TopLevel.String.md)) | Sets the name of the customer associated with this container. |
227
+ | [updateOrderLevelPriceAdjustmentTax](dw.order.LineItemCtnr.md#updateorderlevelpriceadjustmenttax)() | Calculates the tax for all shipping and order-level merchandise price adjustments in this LineItemCtnr. |
228
+ | [updateTotals](dw.order.LineItemCtnr.md#updatetotals)() | Recalculates the totals of the line item container. |
229
+ | [verifyPriceAdjustmentLimits](dw.order.LineItemCtnr.md#verifypriceadjustmentlimits)() | Verifies whether the manual price adjustments made for the line item container exceed the corresponding limits for the current user and the current site. |
230
+
231
+ ### Methods inherited from class ExtensibleObject
232
+
233
+ [describe](dw.object.ExtensibleObject.md#describe), [getCustom](dw.object.ExtensibleObject.md#getcustom)
234
+ ### Methods inherited from class PersistentObject
235
+
236
+ [getCreationDate](dw.object.PersistentObject.md#getcreationdate), [getLastModified](dw.object.PersistentObject.md#getlastmodified), [getUUID](dw.object.PersistentObject.md#getuuid)
237
+ ### Methods inherited from class Object
238
+
239
+ [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)
240
+ ## Constant Details
241
+
242
+ ### BUSINESS_TYPE_B2B
243
+
244
+ - BUSINESS_TYPE_B2B: [Number](TopLevel.Number.md) = 2
245
+ - : constant for Business Type B2B
246
+
247
+
248
+ ---
249
+
250
+ ### BUSINESS_TYPE_B2C
251
+
252
+ - BUSINESS_TYPE_B2C: [Number](TopLevel.Number.md) = 1
253
+ - : constant for Business Type B2C
254
+
255
+
256
+ ---
257
+
258
+ ### CHANNEL_TYPE_CALLCENTER
259
+
260
+ - CHANNEL_TYPE_CALLCENTER: [Number](TopLevel.Number.md) = 2
261
+ - : constant for Channel Type CallCenter
262
+
263
+
264
+ ---
265
+
266
+ ### CHANNEL_TYPE_CUSTOMERSERVICECENTER
267
+
268
+ - CHANNEL_TYPE_CUSTOMERSERVICECENTER: [Number](TopLevel.Number.md) = 11
269
+ - : constant for Channel Type Customer Service Center
270
+
271
+
272
+ ---
273
+
274
+ ### CHANNEL_TYPE_DSS
275
+
276
+ - CHANNEL_TYPE_DSS: [Number](TopLevel.Number.md) = 4
277
+ - : constant for Channel Type DSS
278
+
279
+
280
+ ---
281
+
282
+ ### CHANNEL_TYPE_FACEBOOKADS
283
+
284
+ - CHANNEL_TYPE_FACEBOOKADS: [Number](TopLevel.Number.md) = 8
285
+ - : constant for Channel Type Facebook Ads
286
+
287
+
288
+ ---
289
+
290
+ ### CHANNEL_TYPE_GOOGLE
291
+
292
+ - CHANNEL_TYPE_GOOGLE: [Number](TopLevel.Number.md) = 13
293
+ - : constant for Channel Type Google
294
+
295
+
296
+ ---
297
+
298
+ ### CHANNEL_TYPE_INSTAGRAMCOMMERCE
299
+
300
+ - CHANNEL_TYPE_INSTAGRAMCOMMERCE: [Number](TopLevel.Number.md) = 12
301
+ - : constant for Channel Type Instagram Commerce
302
+
303
+
304
+ ---
305
+
306
+ ### CHANNEL_TYPE_MARKETPLACE
307
+
308
+ - CHANNEL_TYPE_MARKETPLACE: [Number](TopLevel.Number.md) = 3
309
+ - : constant for Channel Type Marketplace
310
+
311
+
312
+ ---
313
+
314
+ ### CHANNEL_TYPE_ONLINERESERVATION
315
+
316
+ - CHANNEL_TYPE_ONLINERESERVATION: [Number](TopLevel.Number.md) = 10
317
+ - : constant for Channel Type Online Reservation
318
+
319
+
320
+ ---
321
+
322
+ ### CHANNEL_TYPE_PINTEREST
323
+
324
+ - CHANNEL_TYPE_PINTEREST: [Number](TopLevel.Number.md) = 6
325
+ - : constant for Channel Type Pinterest
326
+
327
+
328
+ ---
329
+
330
+ ### CHANNEL_TYPE_SNAPCHAT
331
+
332
+ - CHANNEL_TYPE_SNAPCHAT: [Number](TopLevel.Number.md) = 15
333
+ - : constant for Channel Type Snapchat
334
+
335
+
336
+ ---
337
+
338
+ ### CHANNEL_TYPE_STORE
339
+
340
+ - CHANNEL_TYPE_STORE: [Number](TopLevel.Number.md) = 5
341
+ - : constant for Channel Type Store
342
+
343
+
344
+ ---
345
+
346
+ ### CHANNEL_TYPE_STOREFRONT
347
+
348
+ - CHANNEL_TYPE_STOREFRONT: [Number](TopLevel.Number.md) = 1
349
+ - : constant for Channel Type Storefront
350
+
351
+
352
+ ---
353
+
354
+ ### CHANNEL_TYPE_SUBSCRIPTIONS
355
+
356
+ - CHANNEL_TYPE_SUBSCRIPTIONS: [Number](TopLevel.Number.md) = 9
357
+ - : constant for Channel Type Subscriptions
358
+
359
+
360
+ ---
361
+
362
+ ### CHANNEL_TYPE_TIKTOK
363
+
364
+ - CHANNEL_TYPE_TIKTOK: [Number](TopLevel.Number.md) = 14
365
+ - : constant for Channel Type TikTok
366
+
367
+
368
+ ---
369
+
370
+ ### CHANNEL_TYPE_TWITTER
371
+
372
+ - CHANNEL_TYPE_TWITTER: [Number](TopLevel.Number.md) = 7
373
+ - : constant for Channel Type Twitter
374
+
375
+
376
+ ---
377
+
378
+ ### CHANNEL_TYPE_WHATSAPP
379
+
380
+ - CHANNEL_TYPE_WHATSAPP: [Number](TopLevel.Number.md) = 16
381
+ - : constant for Channel Type WhatsApp
382
+
383
+
384
+ ---
385
+
386
+ ### CHANNEL_TYPE_YOUTUBE
387
+
388
+ - CHANNEL_TYPE_YOUTUBE: [Number](TopLevel.Number.md) = 17
389
+ - : constant for Channel Type YouTube
390
+
391
+
392
+ ---
393
+
394
+ ## Property Details
395
+
396
+ ### adjustedMerchandizeTotalGrossPrice
397
+ - adjustedMerchandizeTotalGrossPrice: [Money](dw.value.Money.md) `(read-only)`
398
+ - : Returns the adjusted total gross price (including tax) in purchase currency. Adjusted merchandize prices
399
+ represent the sum of product prices before services such as shipping, but after product-level and order-level
400
+ adjustments.
401
+
402
+
403
+
404
+ ---
405
+
406
+ ### adjustedMerchandizeTotalNetPrice
407
+ - adjustedMerchandizeTotalNetPrice: [Money](dw.value.Money.md) `(read-only)`
408
+ - : Returns the total net price (excluding tax) in purchase currency. Adjusted merchandize prices represent the sum
409
+ of product prices before services such as shipping, but after product-level and order-level adjustments.
410
+
411
+
412
+
413
+ ---
414
+
415
+ ### adjustedMerchandizeTotalPrice
416
+ - adjustedMerchandizeTotalPrice: [Money](dw.value.Money.md) `(read-only)`
417
+ - : Returns the adjusted merchandize total price including product-level and order-level adjustments. If the line
418
+ item container is based on net pricing the adjusted merchandize total net price is returned. If the line item
419
+ container is based on gross pricing the adjusted merchandize total gross price is returned.
420
+
421
+
422
+
423
+ ---
424
+
425
+ ### adjustedMerchandizeTotalTax
426
+ - adjustedMerchandizeTotalTax: [Money](dw.value.Money.md) `(read-only)`
427
+ - : Returns the subtotal tax in purchase currency. Adjusted merchandize prices represent the sum of product prices
428
+ before services such as shipping have been added, but after adjustment from promotions have been added.
429
+
430
+
431
+
432
+ ---
433
+
434
+ ### adjustedShippingTotalGrossPrice
435
+ - adjustedShippingTotalGrossPrice: [Money](dw.value.Money.md) `(read-only)`
436
+ - : Returns the adjusted sum of all shipping line items of the line item container, including tax after shipping
437
+ adjustments have been applied.
438
+
439
+
440
+
441
+ ---
442
+
443
+ ### adjustedShippingTotalNetPrice
444
+ - adjustedShippingTotalNetPrice: [Money](dw.value.Money.md) `(read-only)`
445
+ - : Returns the sum of all shipping line items of the line item container, excluding tax after shipping adjustments
446
+ have been applied.
447
+
448
+
449
+
450
+ ---
451
+
452
+ ### adjustedShippingTotalPrice
453
+ - adjustedShippingTotalPrice: [Money](dw.value.Money.md) `(read-only)`
454
+ - : Returns the adjusted shipping total price. If the line item container is based on net pricing the adjusted
455
+ shipping total net price is returned. If the line item container is based on gross pricing the adjusted shipping
456
+ total gross price is returned.
457
+
458
+
459
+
460
+ ---
461
+
462
+ ### adjustedShippingTotalTax
463
+ - adjustedShippingTotalTax: [Money](dw.value.Money.md) `(read-only)`
464
+ - : Returns the tax of all shipping line items of the line item container after shipping adjustments have been
465
+ applied.
466
+
467
+
468
+
469
+ ---
470
+
471
+ ### allGiftCertificateLineItems
472
+ - ~~allGiftCertificateLineItems: [Collection](dw.util.Collection.md)~~ `(read-only)`
473
+ - : Returns all gift certificate line items of the container.
474
+
475
+ **Deprecated:**
476
+ :::warning
477
+ Use [getGiftCertificateLineItems()](dw.order.LineItemCtnr.md#getgiftcertificatelineitems) to get the collection instead.
478
+ :::
479
+
480
+ ---
481
+
482
+ ### allLineItems
483
+ - allLineItems: [Collection](dw.util.Collection.md) `(read-only)`
484
+ - : Returns all product, shipping, price adjustment, and gift certificate line items of the line item container.
485
+
486
+
487
+ ---
488
+
489
+ ### allProductLineItems
490
+ - allProductLineItems: [Collection](dw.util.Collection.md) `(read-only)`
491
+ - : Returns all product line items of the container, no matter if they are dependent or independent. This includes
492
+ option, bundled and bonus line items.
493
+
494
+
495
+
496
+ ---
497
+
498
+ ### allProductQuantities
499
+ - allProductQuantities: [HashMap](dw.util.HashMap.md) `(read-only)`
500
+ - : Returns a hash mapping all products in the line item container to their total quantities. The total product
501
+ quantity is used chiefly to validate the availability of the items in the cart. This method is not appropriate to
502
+ look up prices because it returns products such as bundled line items which are included in the price of their
503
+ parent and therefore have no corresponding price.
504
+
505
+
506
+ The method counts all direct product line items, plus dependent product line items that are not option line
507
+ items. It also excludes product line items that are not associated to any catalog product.
508
+
509
+
510
+
511
+ ---
512
+
513
+ ### allShippingPriceAdjustments
514
+ - allShippingPriceAdjustments: [Collection](dw.util.Collection.md) `(read-only)`
515
+ - : Returns the collection of all shipping price adjustments applied somewhere in the container. This can be
516
+ adjustments applied to individual shipments or to the container itself. Note that the promotions engine only
517
+ applies shipping price adjustments to the the default shipping line item of shipments, and never to the
518
+ container.
519
+
520
+
521
+ **See Also:**
522
+ - [getShippingPriceAdjustments()](dw.order.LineItemCtnr.md#getshippingpriceadjustments)
523
+
524
+
525
+ ---
526
+
527
+ ### billingAddress
528
+ - billingAddress: [OrderAddress](dw.order.OrderAddress.md) `(read-only)`
529
+ - : Returns the billing address defined for the container. Returns null if no billing address has been created yet.
530
+
531
+
532
+ ---
533
+
534
+ ### bonusDiscountLineItems
535
+ - bonusDiscountLineItems: [Collection](dw.util.Collection.md) `(read-only)`
536
+ - : Returns an unsorted collection of the the bonus discount line items associated with this container.
537
+
538
+
539
+ ---
540
+
541
+ ### bonusLineItems
542
+ - bonusLineItems: [Collection](dw.util.Collection.md) `(read-only)`
543
+ - : Returns the collection of product line items that are bonus items (where
544
+ [ProductLineItem.isBonusProductLineItem()](dw.order.ProductLineItem.md#isbonusproductlineitem) is true).
545
+
546
+
547
+
548
+ ---
549
+
550
+ ### businessType
551
+ - businessType: [EnumValue](dw.value.EnumValue.md) `(read-only)`
552
+ - : Returns the type of the business this order has been placed in.
553
+
554
+ Possible values are [BUSINESS_TYPE_B2C](dw.order.LineItemCtnr.md#business_type_b2c) or [BUSINESS_TYPE_B2B](dw.order.LineItemCtnr.md#business_type_b2b).
555
+
556
+
557
+
558
+ ---
559
+
560
+ ### channelType
561
+ - channelType: [EnumValue](dw.value.EnumValue.md) `(read-only)`
562
+ - : The channel type defines in which sales channel this order has been created. This can be used to distinguish
563
+ order placed through Storefront, Call Center or Marketplace.
564
+
565
+ Possible values are [CHANNEL_TYPE_STOREFRONT](dw.order.LineItemCtnr.md#channel_type_storefront), [CHANNEL_TYPE_CALLCENTER](dw.order.LineItemCtnr.md#channel_type_callcenter),
566
+ [CHANNEL_TYPE_MARKETPLACE](dw.order.LineItemCtnr.md#channel_type_marketplace), [CHANNEL_TYPE_DSS](dw.order.LineItemCtnr.md#channel_type_dss), [CHANNEL_TYPE_STORE](dw.order.LineItemCtnr.md#channel_type_store),
567
+ [CHANNEL_TYPE_PINTEREST](dw.order.LineItemCtnr.md#channel_type_pinterest), [CHANNEL_TYPE_TWITTER](dw.order.LineItemCtnr.md#channel_type_twitter), [CHANNEL_TYPE_FACEBOOKADS](dw.order.LineItemCtnr.md#channel_type_facebookads),
568
+ [CHANNEL_TYPE_SUBSCRIPTIONS](dw.order.LineItemCtnr.md#channel_type_subscriptions), [CHANNEL_TYPE_ONLINERESERVATION](dw.order.LineItemCtnr.md#channel_type_onlinereservation),
569
+ [CHANNEL_TYPE_CUSTOMERSERVICECENTER](dw.order.LineItemCtnr.md#channel_type_customerservicecenter), [CHANNEL_TYPE_INSTAGRAMCOMMERCE](dw.order.LineItemCtnr.md#channel_type_instagramcommerce),
570
+ [CHANNEL_TYPE_GOOGLE](dw.order.LineItemCtnr.md#channel_type_google), [CHANNEL_TYPE_YOUTUBE](dw.order.LineItemCtnr.md#channel_type_youtube), [CHANNEL_TYPE_TIKTOK](dw.order.LineItemCtnr.md#channel_type_tiktok),
571
+ [CHANNEL_TYPE_SNAPCHAT](dw.order.LineItemCtnr.md#channel_type_snapchat), [CHANNEL_TYPE_WHATSAPP](dw.order.LineItemCtnr.md#channel_type_whatsapp)
572
+
573
+
574
+
575
+ ---
576
+
577
+ ### couponLineItems
578
+ - couponLineItems: [Collection](dw.util.Collection.md) `(read-only)`
579
+ - : Returns a sorted collection of the coupon line items in the container. The coupon line items are returned in the
580
+ order they were added to container.
581
+
582
+
583
+
584
+ ---
585
+
586
+ ### currencyCode
587
+ - currencyCode: [String](TopLevel.String.md) `(read-only)`
588
+ - : Returns the currency code for this line item container. The currency code is a 3-character currency mnemonic such
589
+ as 'USD' or 'EUR'. The currency code represents the currency in which the calculation is made, and in which the
590
+ buyer sees all prices in the store front.
591
+
592
+
593
+
594
+ ---
595
+
596
+ ### customer
597
+ - customer: [Customer](dw.customer.Customer.md) `(read-only)`
598
+ - : Returns the customer associated with this container.
599
+
600
+
601
+ ---
602
+
603
+ ### customerEmail
604
+ - customerEmail: [String](TopLevel.String.md)
605
+ - : Returns the email of the customer associated with this container.
606
+
607
+
608
+ ---
609
+
610
+ ### customerName
611
+ - customerName: [String](TopLevel.String.md)
612
+ - : Returns the name of the customer associated with this container.
613
+
614
+
615
+ ---
616
+
617
+ ### customerNo
618
+ - customerNo: [String](TopLevel.String.md) `(read-only)`
619
+ - : Returns the customer number of the customer associated with this container.
620
+
621
+
622
+ ---
623
+
624
+ ### defaultShipment
625
+ - defaultShipment: [Shipment](dw.order.Shipment.md) `(read-only)`
626
+ - : Returns the default shipment of the line item container. Every basket and order has a default shipment with the
627
+ id "me". If you call a process that accesses a shipment, and you don't specify the shipment, then the process
628
+ uses the default shipment. You can't remove a default shipment. Calling [removeShipment(Shipment)](dw.order.LineItemCtnr.md#removeshipmentshipment) on it
629
+ throws an exception.
630
+
631
+
632
+
633
+ ---
634
+
635
+ ### etag
636
+ - etag: [String](TopLevel.String.md) `(read-only)`
637
+ - : Returns the Etag of the line item container. The Etag is a hash that represents the overall container state
638
+ including any associated objects like line items.
639
+
640
+
641
+
642
+ ---
643
+
644
+ ### externallyTaxed
645
+ - externallyTaxed: [Boolean](TopLevel.Boolean.md) `(read-only)`
646
+ - : Use this method to check whether the LineItemCtnr is calculated based on external tax tables.
647
+
648
+ Note: a basket can only be created in EXTERNAL tax mode using SCAPI.
649
+
650
+
651
+
652
+ ---
653
+
654
+ ### giftCertificateLineItems
655
+ - giftCertificateLineItems: [Collection](dw.util.Collection.md) `(read-only)`
656
+ - : Returns all gift certificate line items of the container.
657
+
658
+
659
+ ---
660
+
661
+ ### giftCertificatePaymentInstruments
662
+ - giftCertificatePaymentInstruments: [Collection](dw.util.Collection.md) `(read-only)`
663
+ - : Returns an unsorted collection of the PaymentInstrument instances that represent GiftCertificates in this
664
+ container.
665
+
666
+
667
+
668
+ ---
669
+
670
+ ### giftCertificateTotalGrossPrice
671
+ - giftCertificateTotalGrossPrice: [Money](dw.value.Money.md) `(read-only)`
672
+ - : Returns the total gross price of all gift certificates in the cart. Should usually be equal to total net price.
673
+
674
+
675
+ ---
676
+
677
+ ### giftCertificateTotalNetPrice
678
+ - giftCertificateTotalNetPrice: [Money](dw.value.Money.md) `(read-only)`
679
+ - : Returns the total net price (excluding tax) of all gift certificates in the cart. Should usually be equal to
680
+ total gross price.
681
+
682
+
683
+
684
+ ---
685
+
686
+ ### giftCertificateTotalPrice
687
+ - giftCertificateTotalPrice: [Money](dw.value.Money.md) `(read-only)`
688
+ - : Returns the gift certificate total price. If the line item container is based on net pricing the gift certificate
689
+ total net price is returned. If the line item container is based on gross pricing the gift certificate total
690
+ gross price is returned.
691
+
692
+
693
+
694
+ ---
695
+
696
+ ### giftCertificateTotalTax
697
+ - giftCertificateTotalTax: [Money](dw.value.Money.md) `(read-only)`
698
+ - : Returns the total tax of all gift certificates in the cart. Should usually be 0.0.
699
+
700
+
701
+ ---
702
+
703
+ ### merchandizeTotalGrossPrice
704
+ - merchandizeTotalGrossPrice: [Money](dw.value.Money.md) `(read-only)`
705
+ - : Returns the total gross price (including tax) in purchase currency. Merchandize total prices represent the sum of
706
+ product prices before services such as shipping or adjustment from promotions have been added.
707
+
708
+
709
+
710
+ ---
711
+
712
+ ### merchandizeTotalNetPrice
713
+ - merchandizeTotalNetPrice: [Money](dw.value.Money.md) `(read-only)`
714
+ - : Returns the total net price (excluding tax) in purchase currency. Merchandize total prices represent the sum of
715
+ product prices before services such as shipping or adjustment from promotion have been added.
716
+
717
+
718
+
719
+ ---
720
+
721
+ ### merchandizeTotalPrice
722
+ - merchandizeTotalPrice: [Money](dw.value.Money.md) `(read-only)`
723
+ - : Returns the merchandize total price. If the line item container is based on net pricing the merchandize total net
724
+ price is returned. If the line item container is based on gross pricing the merchandize total gross price is
725
+ returned.
726
+
727
+
728
+
729
+ ---
730
+
731
+ ### merchandizeTotalTax
732
+ - merchandizeTotalTax: [Money](dw.value.Money.md) `(read-only)`
733
+ - : Returns the total tax in purchase currency. Merchandize total prices represent the sum of product prices before
734
+ services such as shipping or adjustment from promotions have been added.
735
+
736
+
737
+
738
+ ---
739
+
740
+ ### notes
741
+ - notes: [List](dw.util.List.md) `(read-only)`
742
+ - : Returns the list of notes for this object, ordered by creation time from oldest to newest.
743
+
744
+
745
+ ---
746
+
747
+ ### paymentInstrument
748
+ - ~~paymentInstrument: [OrderPaymentInstrument](dw.order.OrderPaymentInstrument.md)~~ `(read-only)`
749
+ - : Returns the payment instrument of the line item container or null. This method is deprecated. You should use
750
+ getPaymentInstruments() or getGiftCertificatePaymentInstruments() instead.
751
+
752
+
753
+ **Deprecated:**
754
+ :::warning
755
+ Use [getPaymentInstruments()](dw.order.LineItemCtnr.md#getpaymentinstruments) or [getGiftCertificatePaymentInstruments()](dw.order.LineItemCtnr.md#getgiftcertificatepaymentinstruments) to get the
756
+ set of payment instruments.
757
+
758
+ :::
759
+
760
+ ---
761
+
762
+ ### paymentInstruments
763
+ - paymentInstruments: [Collection](dw.util.Collection.md) `(read-only)`
764
+ - : Returns an unsorted collection of the payment instruments in this container.
765
+
766
+
767
+ ---
768
+
769
+ ### priceAdjustments
770
+ - priceAdjustments: [Collection](dw.util.Collection.md) `(read-only)`
771
+ - : Returns the collection of price adjustments that have been applied to the totals such as promotion on the
772
+ purchase value (i.e. $10 Off or 10% Off). The price adjustments are sorted by the order in which they were
773
+ applied to the order by the promotions engine.
774
+
775
+
776
+
777
+ ---
778
+
779
+ ### productLineItems
780
+ - productLineItems: [Collection](dw.util.Collection.md) `(read-only)`
781
+ - : Returns the product line items of the container that are not dependent on other product line items. This includes
782
+ line items representing bonus products in the container but excludes option, bundled, and bonus line items. The
783
+ returned collection is sorted by the position attribute of the product line items.
784
+
785
+
786
+
787
+ ---
788
+
789
+ ### productQuantities
790
+ - productQuantities: [HashMap](dw.util.HashMap.md) `(read-only)`
791
+ - : Returns a hash map of all products in the line item container and their total quantities. The total product
792
+ quantity is for example used to lookup the product price.
793
+
794
+
795
+ The method counts all direct product line items, plus dependent product line items that are not bundled line
796
+ items and no option line items. It also excludes product line items that are not associated to any catalog
797
+ product, and bonus product line items.
798
+
799
+
800
+ **See Also:**
801
+ - [getProductQuantities(Boolean)](dw.order.LineItemCtnr.md#getproductquantitiesboolean)
802
+
803
+
804
+ ---
805
+
806
+ ### productQuantityTotal
807
+ - productQuantityTotal: [Number](TopLevel.Number.md) `(read-only)`
808
+ - : Returns the total quantity of all product line items. Not included are bundled line items and option line items.
809
+
810
+
811
+ ---
812
+
813
+ ### shipments
814
+ - shipments: [Collection](dw.util.Collection.md) `(read-only)`
815
+ - : Returns all shipments of the line item container.
816
+
817
+ The first shipment in the returned collection is the default shipment (shipment ID always set to "me"). All other
818
+ shipments are sorted ascending by shipment ID.
819
+
820
+
821
+
822
+ ---
823
+
824
+ ### shippingPriceAdjustments
825
+ - shippingPriceAdjustments: [Collection](dw.util.Collection.md) `(read-only)`
826
+ - : Returns the of shipping price adjustments applied to the shipping total of the container. Note that the
827
+ promotions engine only applies shipping price adjustments to the the default shipping line item of shipments, and
828
+ never to the container.
829
+
830
+
831
+ **See Also:**
832
+ - [getAllShippingPriceAdjustments()](dw.order.LineItemCtnr.md#getallshippingpriceadjustments)
833
+
834
+
835
+ ---
836
+
837
+ ### shippingTotalGrossPrice
838
+ - shippingTotalGrossPrice: [Money](dw.value.Money.md) `(read-only)`
839
+ - : Returns the sum of all shipping line items of the line item container, including tax before shipping adjustments
840
+ have been applied.
841
+
842
+
843
+
844
+ ---
845
+
846
+ ### shippingTotalNetPrice
847
+ - shippingTotalNetPrice: [Money](dw.value.Money.md) `(read-only)`
848
+ - : Returns the sum of all shipping line items of the line item container, excluding tax before shipping adjustments
849
+ have been applied.
850
+
851
+
852
+
853
+ ---
854
+
855
+ ### shippingTotalPrice
856
+ - shippingTotalPrice: [Money](dw.value.Money.md) `(read-only)`
857
+ - : Returns the shipping total price. If the line item container is based on net pricing the shipping total net price
858
+ is returned. If the line item container is based on gross pricing the shipping total gross price is returned.
859
+
860
+
861
+
862
+ ---
863
+
864
+ ### shippingTotalTax
865
+ - shippingTotalTax: [Money](dw.value.Money.md) `(read-only)`
866
+ - : Returns the tax of all shipping line items of the line item container before shipping adjustments have been
867
+ applied.
868
+
869
+
870
+
871
+ ---
872
+
873
+ ### taxRoundedAtGroup
874
+ - taxRoundedAtGroup: [Boolean](TopLevel.Boolean.md) `(read-only)`
875
+ - : Use this method to check if the LineItemCtnr was calculated with grouped taxation calculation.
876
+
877
+
878
+ If the tax is rounded on group level, the tax is applied to the summed-up tax basis for each tax rate.
879
+
880
+
881
+
882
+ ---
883
+
884
+ ### taxTotalsPerTaxRate
885
+ - taxTotalsPerTaxRate: [SortedMap](dw.util.SortedMap.md) `(read-only)`
886
+ - : This method returns a [SortedMap](dw.util.SortedMap.md) in which the keys are [Decimal](dw.util.Decimal.md) tax rates and the values
887
+ are [Money](dw.value.Money.md) total tax for the tax rate. The map is unmodifiable.
888
+
889
+
890
+
891
+ ---
892
+
893
+ ### totalGrossPrice
894
+ - totalGrossPrice: [Money](dw.value.Money.md) `(read-only)`
895
+ - : Returns the grand total price gross of tax for LineItemCtnr, in purchase currency. Total prices represent the sum
896
+ of product prices, services prices and adjustments.
897
+
898
+
899
+
900
+ ---
901
+
902
+ ### totalNetPrice
903
+ - totalNetPrice: [Money](dw.value.Money.md) `(read-only)`
904
+ - : Returns the grand total price for LineItemCtnr net of tax, in purchase currency. Total prices represent the sum
905
+ of product prices, services prices and adjustments.
906
+
907
+
908
+
909
+ ---
910
+
911
+ ### totalTax
912
+ - totalTax: [Money](dw.value.Money.md) `(read-only)`
913
+ - : Returns the grand total tax for LineItemCtnr, in purchase currency. Total prices represent the sum of product
914
+ prices, services prices and adjustments.
915
+
916
+
917
+
918
+ ---
919
+
920
+ ## Method Details
921
+
922
+ ### addNote(String, String)
923
+ - addNote(subject: [String](TopLevel.String.md), text: [String](TopLevel.String.md)): [Note](dw.object.Note.md)
924
+ - : Adds a note to the object.
925
+
926
+ **Parameters:**
927
+ - subject - The subject of the note.
928
+ - text - The text of the note. Must be no more than 4000 characters or an exception is thrown.
929
+
930
+ **Returns:**
931
+ - the added note.
932
+
933
+
934
+ ---
935
+
936
+ ### createBillingAddress()
937
+ - createBillingAddress(): [OrderAddress](dw.order.OrderAddress.md)
938
+ - : Create a billing address for the LineItemCtnr. A LineItemCtnr (e.g. basket) initially has no billing address.
939
+ This method creates a billing address for the LineItemCtnr and replaces an existing billing address.
940
+
941
+
942
+ **Returns:**
943
+ - The new billing address of the LineItemCtnr.
944
+
945
+
946
+ ---
947
+
948
+ ### createBonusProductLineItem(BonusDiscountLineItem, Product, ProductOptionModel, Shipment)
949
+ - createBonusProductLineItem(bonusDiscountLineItem: [BonusDiscountLineItem](dw.order.BonusDiscountLineItem.md), product: [Product](dw.catalog.Product.md), optionModel: [ProductOptionModel](dw.catalog.ProductOptionModel.md), shipment: [Shipment](dw.order.Shipment.md)): [ProductLineItem](dw.order.ProductLineItem.md)
950
+ - : Creates a product line item in the container based on the passed Product and BonusDiscountLineItem. The product
951
+ must be assigned to the current site catalog and must also be a bonus product of the specified
952
+ BonusDiscountLineItem or an exception is thrown. The line item is always created in the default shipment. If
953
+ successful, the operation always creates a new ProductLineItem and never simply increments the quantity of an
954
+ existing ProductLineItem. An option model can optionally be specified.
955
+
956
+
957
+ **Parameters:**
958
+ - bonusDiscountLineItem - Line item representing an applied BonusChoiceDiscount in the LineItemCtnr, must not be null.
959
+ - product - Product The product to add to the LineItemCtnr. Must not be null and must be a bonus product of bonusDiscountLineItem.
960
+ - optionModel - ProductOptionModel or null.
961
+ - shipment - The shipment to add the bonus product to. If null, the product is added to the default shipment.
962
+
963
+
964
+ ---
965
+
966
+ ### createCouponLineItem(String)
967
+ - createCouponLineItem(couponCode: [String](TopLevel.String.md)): [CouponLineItem](dw.order.CouponLineItem.md)
968
+ - : Creates a coupon line item that is not based on the B2C Commerce campaign system and associates it with the
969
+ specified coupon code.
970
+
971
+
972
+ There may not be any other coupon line item in the container with the specific coupon code, otherwise an
973
+ exception is thrown.
974
+
975
+
976
+ If you want to create a coupon line item based on the B2C Commerce campaign system, you must use
977
+ [createCouponLineItem(String, Boolean)](dw.order.LineItemCtnr.md#createcouponlineitemstring-boolean) with campaignBased = true.
978
+
979
+
980
+ **Parameters:**
981
+ - couponCode - couponCode represented by the coupon line item.
982
+
983
+ **Returns:**
984
+ - New coupon line item.
985
+
986
+
987
+ ---
988
+
989
+ ### createCouponLineItem(String, Boolean)
990
+ - createCouponLineItem(couponCode: [String](TopLevel.String.md), campaignBased: [Boolean](TopLevel.Boolean.md)): [CouponLineItem](dw.order.CouponLineItem.md)
991
+ - : Creates a new CouponLineItem for this container based on the supplied coupon code.
992
+
993
+
994
+ The created coupon line item is based on the B2C Commerce campaign system if campaignBased parameter is true. In
995
+ that case, if the supplied coupon code is not valid, APIException with type 'CreateCouponLineItemException' is
996
+ thrown.
997
+
998
+
999
+ If you want to create a custom coupon line item, you must call this method with campaignBased = false or to use
1000
+ [createCouponLineItem(String)](dw.order.LineItemCtnr.md#createcouponlineitemstring).
1001
+
1002
+
1003
+
1004
+
1005
+ Example:
1006
+
1007
+
1008
+
1009
+
1010
+ ```
1011
+ try {
1012
+ var cli : CouponLineItem = basket.createCouponLineItem(couponCode, true);
1013
+ } catch (e if e instanceof APIException && e.type === 'CreateCouponLineItemException')
1014
+ if (e.errorCode == CouponStatusCodes.COUPON_CODE_ALREADY_IN_BASKET) {
1015
+ ...
1016
+ }
1017
+ }
1018
+ ```
1019
+
1020
+
1021
+ An dw.order.CreateCouponLineItemException is thrown in case of campaignBased = true only. Indicates that the
1022
+ provided coupon code is not a valid coupon code to create a coupon line item based on the B2C Commerce campaign
1023
+ system. The error code property (CreateCouponLineItemException.errorCode) will be set to one of the following
1024
+ values:
1025
+
1026
+ - [CouponStatusCodes.COUPON_CODE_ALREADY_IN_BASKET](dw.campaign.CouponStatusCodes.md#coupon_code_already_in_basket)= Indicates that coupon code has already been added to basket.
1027
+ - [CouponStatusCodes.COUPON_ALREADY_IN_BASKET](dw.campaign.CouponStatusCodes.md#coupon_already_in_basket)= Indicates that another code of the same MultiCode/System coupon has already been added to basket.
1028
+ - [CouponStatusCodes.COUPON_CODE_ALREADY_REDEEMED](dw.campaign.CouponStatusCodes.md#coupon_code_already_redeemed)= Indicates that code of MultiCode/System coupon has already been redeemed.
1029
+ - [CouponStatusCodes.COUPON_CODE_UNKNOWN](dw.campaign.CouponStatusCodes.md#coupon_code_unknown)= Indicates that coupon not found for given coupon code or that the code itself was not found.
1030
+ - [CouponStatusCodes.COUPON_DISABLED](dw.campaign.CouponStatusCodes.md#coupon_disabled)= Indicates that coupon is not enabled.
1031
+ - [CouponStatusCodes.REDEMPTION_LIMIT_EXCEEDED](dw.campaign.CouponStatusCodes.md#redemption_limit_exceeded)= Indicates that number of redemptions per code exceeded.
1032
+ - [CouponStatusCodes.CUSTOMER_REDEMPTION_LIMIT_EXCEEDED](dw.campaign.CouponStatusCodes.md#customer_redemption_limit_exceeded)= Indicates that number of redemptions per code and customer exceeded.
1033
+ - [CouponStatusCodes.TIMEFRAME_REDEMPTION_LIMIT_EXCEEDED](dw.campaign.CouponStatusCodes.md#timeframe_redemption_limit_exceeded)= Indicates that number of redemptions per code, customer and time exceeded.
1034
+ - [CouponStatusCodes.NO_ACTIVE_PROMOTION](dw.campaign.CouponStatusCodes.md#no_active_promotion)= Indicates that coupon is not assigned to an active promotion.
1035
+
1036
+
1037
+ **Parameters:**
1038
+ - couponCode - the coupon code to be represented by the coupon line item
1039
+ - campaignBased - the flag if the created coupon line item should be based on the B2C Commerce campaign system
1040
+
1041
+ **Returns:**
1042
+ - the created coupon line item
1043
+
1044
+
1045
+ ---
1046
+
1047
+ ### createGiftCertificateLineItem(Number, String)
1048
+ - createGiftCertificateLineItem(amount: [Number](TopLevel.Number.md), recipientEmail: [String](TopLevel.String.md)): [GiftCertificateLineItem](dw.order.GiftCertificateLineItem.md)
1049
+ - : Creates a gift certificate line item.
1050
+
1051
+ **Parameters:**
1052
+ - amount - the amount of the gift certificate - mandatory
1053
+ - recipientEmail - the recipient's email address - mandatory
1054
+
1055
+ **Returns:**
1056
+ - The new gift certificate line item
1057
+
1058
+
1059
+ ---
1060
+
1061
+ ### createGiftCertificatePaymentInstrument(String, Money)
1062
+ - createGiftCertificatePaymentInstrument(giftCertificateCode: [String](TopLevel.String.md), amount: [Money](dw.value.Money.md)): [OrderPaymentInstrument](dw.order.OrderPaymentInstrument.md)
1063
+ - : Creates an OrderPaymentInstrument representing a Gift Certificate. The amount is set on a PaymentTransaction that
1064
+ is accessible via the OrderPaymentInstrument. By default, the status of the PaymentTransaction is set to CREATE.
1065
+ The PaymentTransaction must be processed at a later time.
1066
+
1067
+
1068
+ **Parameters:**
1069
+ - giftCertificateCode - the redemption code of the Gift Certificate.
1070
+ - amount - the amount to set on the PaymentTransaction. If the OrderPaymentInstrument is actually redeemed, this is the amount that will be deducted from the Gift Certificate.
1071
+
1072
+ **Returns:**
1073
+ - the OrderPaymentInstrument.
1074
+
1075
+
1076
+ ---
1077
+
1078
+ ### createPaymentInstrument(String, Money)
1079
+ - createPaymentInstrument(paymentMethodId: [String](TopLevel.String.md), amount: [Money](dw.value.Money.md)): [OrderPaymentInstrument](dw.order.OrderPaymentInstrument.md)
1080
+ - : Creates a payment instrument using the specified payment method id and amount. The amount is set on the
1081
+ [PaymentTransaction](dw.order.PaymentTransaction.md) that is attached to the payment instrument.
1082
+
1083
+
1084
+ **Parameters:**
1085
+ - paymentMethodId - The payment method id. See the [PaymentInstrument](dw.order.PaymentInstrument.md) class for payment method types
1086
+ - amount - The payment amount or null
1087
+
1088
+ **Returns:**
1089
+ - The new payment instrument
1090
+
1091
+
1092
+ ---
1093
+
1094
+ ### createPaymentInstrumentFromWallet(CustomerPaymentInstrument, Money)
1095
+ - createPaymentInstrumentFromWallet(walletPaymentInstrument: [CustomerPaymentInstrument](dw.customer.CustomerPaymentInstrument.md), amount: [Money](dw.value.Money.md)): [OrderPaymentInstrument](dw.order.OrderPaymentInstrument.md)
1096
+ - : Creates a payment instrument using the specified wallet payment instrument and amount. The amount is set on the
1097
+ [PaymentTransaction](dw.order.PaymentTransaction.md) that is attached to the payment instrument. All data from the wallet payment
1098
+ instrument will be copied over to the created payment instrument.
1099
+
1100
+
1101
+ **Parameters:**
1102
+ - walletPaymentInstrument - The payment instrument from the customer's walled.
1103
+ - amount - The payment amount or null
1104
+
1105
+ **Returns:**
1106
+ - The new payment instrument
1107
+
1108
+
1109
+ ---
1110
+
1111
+ ### createPriceAdjustment(String)
1112
+ - createPriceAdjustment(promotionID: [String](TopLevel.String.md)): [PriceAdjustment](dw.order.PriceAdjustment.md)
1113
+ - : Creates an order price adjustment.
1114
+
1115
+ The promotion id is mandatory and must not be the ID of any actual promotion defined in B2C Commerce; otherwise
1116
+ an exception is thrown.
1117
+
1118
+
1119
+ **Parameters:**
1120
+ - promotionID - Promotion ID
1121
+
1122
+ **Returns:**
1123
+ - The new price adjustment
1124
+
1125
+
1126
+ ---
1127
+
1128
+ ### createPriceAdjustment(String, Discount)
1129
+ - createPriceAdjustment(promotionID: [String](TopLevel.String.md), discount: [Discount](dw.campaign.Discount.md)): [PriceAdjustment](dw.order.PriceAdjustment.md)
1130
+ - : Creates an order level price adjustment for a specific discount.
1131
+
1132
+ The promotion id is mandatory and must not be the ID of any actual promotion defined in B2C Commerce; otherwise
1133
+ an exception is thrown.
1134
+
1135
+ The possible discount types are supported: [PercentageDiscount](dw.campaign.PercentageDiscount.md) and
1136
+ [AmountDiscount](dw.campaign.AmountDiscount.md).
1137
+
1138
+ Examples:
1139
+
1140
+
1141
+ `
1142
+ var myOrder : dw.order.Order; // assume known
1143
+
1144
+ var paTenPercent : dw.order.PriceAdjustment = myOrder.createPriceAdjustment("myPromotionID1", new dw.campaign.PercentageDiscount(10));
1145
+
1146
+ var paReduceBy20 : dw.order.PriceAdjustment = myOrder.createPriceAdjustment("myPromotionID2", new dw.campaign.AmountDiscount(20);
1147
+
1148
+ `
1149
+
1150
+
1151
+ **Parameters:**
1152
+ - promotionID - Promotion ID
1153
+ - discount - The discount
1154
+
1155
+ **Returns:**
1156
+ - The new price adjustment
1157
+
1158
+
1159
+ ---
1160
+
1161
+ ### createProductLineItem(Product, ProductOptionModel, Shipment)
1162
+ - createProductLineItem(product: [Product](dw.catalog.Product.md), optionModel: [ProductOptionModel](dw.catalog.ProductOptionModel.md), shipment: [Shipment](dw.order.Shipment.md)): [ProductLineItem](dw.order.ProductLineItem.md)
1163
+ - : Creates a new product line item in the container and assigns it to the specified shipment. An option model can be
1164
+ specified.
1165
+
1166
+ Please note that the product must be assigned to the current site catalog.
1167
+
1168
+
1169
+ **Parameters:**
1170
+ - product - Product
1171
+ - optionModel - ProductOptionModel or null
1172
+ - shipment - Shipment
1173
+
1174
+
1175
+ ---
1176
+
1177
+ ### createProductLineItem(ProductListItem, Shipment)
1178
+ - createProductLineItem(productListItem: [ProductListItem](dw.customer.ProductListItem.md), shipment: [Shipment](dw.order.Shipment.md)): [ProductLineItem](dw.order.ProductLineItem.md)
1179
+ - : Creates a new product line item in the basket and assigns it to the specified shipment.
1180
+
1181
+
1182
+ If the product list item references a product in the site catalog, the method will associate the product line
1183
+ item with that catalog product and will copy all order-relevant information, like the quantity unit, from the
1184
+ catalog product. The quantity of the product line item is initialized with 1.0 or - if defined - the minimum
1185
+ order quantity of the product.
1186
+
1187
+
1188
+ If the product list item references an option product, the option values are copied from the product list item.
1189
+
1190
+
1191
+ If the product list item is associated with an existing product line item, and the BasketAddProductBehaviour
1192
+ setting is MergeQuantities, then the product line item quantity is increased by 1.0 or, if defined, the minimum
1193
+ order quantity of the product.
1194
+
1195
+
1196
+ An exception is thrown if
1197
+
1198
+ - the line item container is no basket.
1199
+ - the type of the product list item is not PRODUCT.
1200
+ - the product list item references a product which is not assigned to the site catalog.
1201
+
1202
+
1203
+ **Parameters:**
1204
+ - productListItem - the product list item
1205
+ - shipment - the shipment the created product line item will be assigned to
1206
+
1207
+ **Returns:**
1208
+ - The new product line item
1209
+
1210
+
1211
+ ---
1212
+
1213
+ ### createProductLineItem(String, Shipment)
1214
+ - createProductLineItem(productID: [String](TopLevel.String.md), shipment: [Shipment](dw.order.Shipment.md)): [ProductLineItem](dw.order.ProductLineItem.md)
1215
+ - : Creates a new product line item in the container and assigns it to the specified shipment.
1216
+
1217
+ If the specified productID represents a product in the site catalog, the method will associate the product line
1218
+ item with that catalog product and will copy all order-relevant information, like the quantity unit, from the
1219
+ catalog product. The quantity of the product line item is initialized with 1.0 or - if defined - the minimum
1220
+ order quantity of the product.
1221
+
1222
+ If the product represents a product in the site catalog and is an option product, the product is added with it's
1223
+ default option values.
1224
+
1225
+ If the specified productID does not represent a product of the site catalog, the method creates a new product
1226
+ line item and initializes it with the specified product ID and with a quantity, minimum order quantity, and step
1227
+ quantity value of 1.0.
1228
+
1229
+ If the provided SKU references a product that is not available as described in method [ProductLineItem.isCatalogProduct()](dw.order.ProductLineItem.md#iscatalogproduct), the new product line item is considered a non-catalog product line item without a connection to a product. Such product line items are not included in reservation requests in either OCI-based inventory or eCom-based inventory when calling [Basket.reserveInventory()](dw.order.Basket.md#reserveinventory) or [OrderMgr.createOrder(Basket)](dw.order.OrderMgr.md#createorderbasket).
1230
+
1231
+
1232
+ **Parameters:**
1233
+ - productID - The product ID.
1234
+ - shipment - Shipment
1235
+
1236
+ **Returns:**
1237
+ - The new product line item
1238
+
1239
+
1240
+ ---
1241
+
1242
+ ### createProductLineItem(String, Quantity, Shipment)
1243
+ - ~~createProductLineItem(productID: [String](TopLevel.String.md), quantity: [Quantity](dw.value.Quantity.md), shipment: [Shipment](dw.order.Shipment.md)): [ProductLineItem](dw.order.ProductLineItem.md)~~
1244
+ - : Creates a new product line item in the container and assigns it to the specified shipment.
1245
+
1246
+ If the specified productID represents a product in the site catalog, the method will associate the product line
1247
+ item with that catalog product and will copy all order-relevant information, like the quantity unit, from the
1248
+ catalog product.
1249
+
1250
+ If the specified productID does not represent a product of the site catalog, the method creates a new product
1251
+ line item and initializes it with the specified product ID and quantity. If the passed in quantity value is not a
1252
+ positive integer, it will be rounded to the nearest positive integer. The minimum order quantity and step
1253
+ quantity will be set to 1.0.
1254
+
1255
+ For catalog products, the method follows the configured 'Add2Basket' strategy to either increment the quantity of
1256
+ an existing product line item or create a new product line item for the same product. For non-catalog products,
1257
+ the method creates a new product line item no matter if the same product is already in the line item container.
1258
+ If a negative quantity is specified, it is automatically changed to 1.0.
1259
+
1260
+
1261
+ **Parameters:**
1262
+ - productID - The product ID.
1263
+ - quantity - The quantity of the product.
1264
+ - shipment - Shipment
1265
+
1266
+ **Returns:**
1267
+ - the product line item
1268
+
1269
+ **Deprecated:**
1270
+ :::warning
1271
+ Use [createProductLineItem(String, Shipment)](dw.order.LineItemCtnr.md#createproductlineitemstring-shipment) or
1272
+ [ProductLineItem.updateQuantity(Number)](dw.order.ProductLineItem.md#updatequantitynumber) instead.
1273
+
1274
+ :::
1275
+
1276
+ ---
1277
+
1278
+ ### createShipment(String)
1279
+ - createShipment(id: [String](TopLevel.String.md)): [Shipment](dw.order.Shipment.md)
1280
+ - : Creates a standard shipment for the line item container. The specified ID must not yet be in use for another
1281
+ shipment of this line item container.
1282
+
1283
+
1284
+ **Parameters:**
1285
+ - id - ID of the shipment.
1286
+
1287
+
1288
+ ---
1289
+
1290
+ ### createShippingPriceAdjustment(String)
1291
+ - createShippingPriceAdjustment(promotionID: [String](TopLevel.String.md)): [PriceAdjustment](dw.order.PriceAdjustment.md)
1292
+ - : Creates a shipping price adjustment to be applied to the container.
1293
+
1294
+ The promotion ID is mandatory and must not be the ID of any actual promotion defined in B2C Commerce; otherwise
1295
+ the method will throw an exception.
1296
+
1297
+ If there already exists a shipping price adjustment referring to the specified promotion ID, an exception is
1298
+ thrown.
1299
+
1300
+
1301
+ **Parameters:**
1302
+ - promotionID - Promotion ID
1303
+
1304
+ **Returns:**
1305
+ - The new price adjustment
1306
+
1307
+
1308
+ ---
1309
+
1310
+ ### getAdjustedMerchandizeTotalGrossPrice()
1311
+ - getAdjustedMerchandizeTotalGrossPrice(): [Money](dw.value.Money.md)
1312
+ - : Returns the adjusted total gross price (including tax) in purchase currency. Adjusted merchandize prices
1313
+ represent the sum of product prices before services such as shipping, but after product-level and order-level
1314
+ adjustments.
1315
+
1316
+
1317
+ **Returns:**
1318
+ - the adjusted total gross price (including tax) in purchase currency.
1319
+
1320
+
1321
+ ---
1322
+
1323
+ ### getAdjustedMerchandizeTotalNetPrice()
1324
+ - getAdjustedMerchandizeTotalNetPrice(): [Money](dw.value.Money.md)
1325
+ - : Returns the total net price (excluding tax) in purchase currency. Adjusted merchandize prices represent the sum
1326
+ of product prices before services such as shipping, but after product-level and order-level adjustments.
1327
+
1328
+
1329
+ **Returns:**
1330
+ - the total net price (excluding tax) in purchase currency.
1331
+
1332
+
1333
+ ---
1334
+
1335
+ ### getAdjustedMerchandizeTotalPrice()
1336
+ - getAdjustedMerchandizeTotalPrice(): [Money](dw.value.Money.md)
1337
+ - : Returns the adjusted merchandize total price including product-level and order-level adjustments. If the line
1338
+ item container is based on net pricing the adjusted merchandize total net price is returned. If the line item
1339
+ container is based on gross pricing the adjusted merchandize total gross price is returned.
1340
+
1341
+
1342
+ **Returns:**
1343
+ - either the adjusted merchandize total net or gross price
1344
+
1345
+
1346
+ ---
1347
+
1348
+ ### getAdjustedMerchandizeTotalPrice(Boolean)
1349
+ - getAdjustedMerchandizeTotalPrice(applyOrderLevelAdjustments: [Boolean](TopLevel.Boolean.md)): [Money](dw.value.Money.md)
1350
+ - : Returns the adjusted merchandize total price including order-level adjustments if requested. If the line item
1351
+ container is based on net pricing the adjusted merchandize total net price is returned. If the line item
1352
+ container is based on gross pricing the adjusted merchandize total gross price is returned.
1353
+
1354
+
1355
+ **Parameters:**
1356
+ - applyOrderLevelAdjustments - controls if order-level price adjustements are applied. If true, the price that is returned includes order-level price adjustments. If false, only product-level price adjustments are applied.
1357
+
1358
+ **Returns:**
1359
+ - a price representing the adjusted merchandize total controlled by the applyOrderLevelAdjustments
1360
+ parameter.
1361
+
1362
+
1363
+
1364
+ ---
1365
+
1366
+ ### getAdjustedMerchandizeTotalTax()
1367
+ - getAdjustedMerchandizeTotalTax(): [Money](dw.value.Money.md)
1368
+ - : Returns the subtotal tax in purchase currency. Adjusted merchandize prices represent the sum of product prices
1369
+ before services such as shipping have been added, but after adjustment from promotions have been added.
1370
+
1371
+
1372
+ **Returns:**
1373
+ - the subtotal tax in purchase currency.
1374
+
1375
+
1376
+ ---
1377
+
1378
+ ### getAdjustedShippingTotalGrossPrice()
1379
+ - getAdjustedShippingTotalGrossPrice(): [Money](dw.value.Money.md)
1380
+ - : Returns the adjusted sum of all shipping line items of the line item container, including tax after shipping
1381
+ adjustments have been applied.
1382
+
1383
+
1384
+ **Returns:**
1385
+ - the adjusted sum of all shipping line items of the line item container, including tax after shipping
1386
+ adjustments have been applied.
1387
+
1388
+
1389
+
1390
+ ---
1391
+
1392
+ ### getAdjustedShippingTotalNetPrice()
1393
+ - getAdjustedShippingTotalNetPrice(): [Money](dw.value.Money.md)
1394
+ - : Returns the sum of all shipping line items of the line item container, excluding tax after shipping adjustments
1395
+ have been applied.
1396
+
1397
+
1398
+ **Returns:**
1399
+ - the sum of all shipping line items of the line item container, excluding tax after shipping adjustments
1400
+ have been applied.
1401
+
1402
+
1403
+
1404
+ ---
1405
+
1406
+ ### getAdjustedShippingTotalPrice()
1407
+ - getAdjustedShippingTotalPrice(): [Money](dw.value.Money.md)
1408
+ - : Returns the adjusted shipping total price. If the line item container is based on net pricing the adjusted
1409
+ shipping total net price is returned. If the line item container is based on gross pricing the adjusted shipping
1410
+ total gross price is returned.
1411
+
1412
+
1413
+ **Returns:**
1414
+ - either the adjusted shipping total net or gross price
1415
+
1416
+
1417
+ ---
1418
+
1419
+ ### getAdjustedShippingTotalTax()
1420
+ - getAdjustedShippingTotalTax(): [Money](dw.value.Money.md)
1421
+ - : Returns the tax of all shipping line items of the line item container after shipping adjustments have been
1422
+ applied.
1423
+
1424
+
1425
+ **Returns:**
1426
+ - the tax of all shipping line items of the line item container after shipping adjustments have been
1427
+ applied.
1428
+
1429
+
1430
+
1431
+ ---
1432
+
1433
+ ### getAllGiftCertificateLineItems()
1434
+ - ~~getAllGiftCertificateLineItems(): [Collection](dw.util.Collection.md)~~
1435
+ - : Returns all gift certificate line items of the container.
1436
+
1437
+ **Returns:**
1438
+ - A collection of all GiftCertificateLineItems of the container.
1439
+
1440
+ **Deprecated:**
1441
+ :::warning
1442
+ Use [getGiftCertificateLineItems()](dw.order.LineItemCtnr.md#getgiftcertificatelineitems) to get the collection instead.
1443
+ :::
1444
+
1445
+ ---
1446
+
1447
+ ### getAllLineItems()
1448
+ - getAllLineItems(): [Collection](dw.util.Collection.md)
1449
+ - : Returns all product, shipping, price adjustment, and gift certificate line items of the line item container.
1450
+
1451
+ **Returns:**
1452
+ - A collection of all product, shipping, price adjustment, and gift certificate line items of the
1453
+ container, in that order.
1454
+
1455
+
1456
+
1457
+ ---
1458
+
1459
+ ### getAllProductLineItems()
1460
+ - getAllProductLineItems(): [Collection](dw.util.Collection.md)
1461
+ - : Returns all product line items of the container, no matter if they are dependent or independent. This includes
1462
+ option, bundled and bonus line items.
1463
+
1464
+
1465
+ **Returns:**
1466
+ - An unsorted collection of all ProductLineItem instances of the container.
1467
+
1468
+
1469
+ ---
1470
+
1471
+ ### getAllProductLineItems(String)
1472
+ - getAllProductLineItems(productID: [String](TopLevel.String.md)): [Collection](dw.util.Collection.md)
1473
+ - : Returns all product line items of the container that have a product ID equal to the specified product ID, no
1474
+ matter if they are dependent or independent. This includes option, bundled and bonus line items.
1475
+
1476
+
1477
+ **Parameters:**
1478
+ - productID - The product ID used to filter the product line items.
1479
+
1480
+ **Returns:**
1481
+ - An unsorted collection of all ProductLineItem instances which have the specified product ID.
1482
+
1483
+
1484
+ ---
1485
+
1486
+ ### getAllProductQuantities()
1487
+ - getAllProductQuantities(): [HashMap](dw.util.HashMap.md)
1488
+ - : Returns a hash mapping all products in the line item container to their total quantities. The total product
1489
+ quantity is used chiefly to validate the availability of the items in the cart. This method is not appropriate to
1490
+ look up prices because it returns products such as bundled line items which are included in the price of their
1491
+ parent and therefore have no corresponding price.
1492
+
1493
+
1494
+ The method counts all direct product line items, plus dependent product line items that are not option line
1495
+ items. It also excludes product line items that are not associated to any catalog product.
1496
+
1497
+
1498
+ **Returns:**
1499
+ - A map of products and their total quantities.
1500
+
1501
+
1502
+ ---
1503
+
1504
+ ### getAllShippingPriceAdjustments()
1505
+ - getAllShippingPriceAdjustments(): [Collection](dw.util.Collection.md)
1506
+ - : Returns the collection of all shipping price adjustments applied somewhere in the container. This can be
1507
+ adjustments applied to individual shipments or to the container itself. Note that the promotions engine only
1508
+ applies shipping price adjustments to the the default shipping line item of shipments, and never to the
1509
+ container.
1510
+
1511
+
1512
+ **Returns:**
1513
+ - an unsorted collection of the shipping PriceAdjustment instances associated with this container.
1514
+
1515
+ **See Also:**
1516
+ - [getShippingPriceAdjustments()](dw.order.LineItemCtnr.md#getshippingpriceadjustments)
1517
+
1518
+
1519
+ ---
1520
+
1521
+ ### getBillingAddress()
1522
+ - getBillingAddress(): [OrderAddress](dw.order.OrderAddress.md)
1523
+ - : Returns the billing address defined for the container. Returns null if no billing address has been created yet.
1524
+
1525
+ **Returns:**
1526
+ - the billing address or null.
1527
+
1528
+
1529
+ ---
1530
+
1531
+ ### getBonusDiscountLineItems()
1532
+ - getBonusDiscountLineItems(): [Collection](dw.util.Collection.md)
1533
+ - : Returns an unsorted collection of the the bonus discount line items associated with this container.
1534
+
1535
+ **Returns:**
1536
+ - An unsorted collection of BonusDiscountLine instances in the container.
1537
+
1538
+
1539
+ ---
1540
+
1541
+ ### getBonusLineItems()
1542
+ - getBonusLineItems(): [Collection](dw.util.Collection.md)
1543
+ - : Returns the collection of product line items that are bonus items (where
1544
+ [ProductLineItem.isBonusProductLineItem()](dw.order.ProductLineItem.md#isbonusproductlineitem) is true).
1545
+
1546
+
1547
+ **Returns:**
1548
+ - the collection of product line items that are bonus items.
1549
+
1550
+
1551
+ ---
1552
+
1553
+ ### getBusinessType()
1554
+ - getBusinessType(): [EnumValue](dw.value.EnumValue.md)
1555
+ - : Returns the type of the business this order has been placed in.
1556
+
1557
+ Possible values are [BUSINESS_TYPE_B2C](dw.order.LineItemCtnr.md#business_type_b2c) or [BUSINESS_TYPE_B2B](dw.order.LineItemCtnr.md#business_type_b2b).
1558
+
1559
+
1560
+ **Returns:**
1561
+ - the type of the business this order has been placed in. or null, if the business type is not set
1562
+
1563
+
1564
+ ---
1565
+
1566
+ ### getChannelType()
1567
+ - getChannelType(): [EnumValue](dw.value.EnumValue.md)
1568
+ - : The channel type defines in which sales channel this order has been created. This can be used to distinguish
1569
+ order placed through Storefront, Call Center or Marketplace.
1570
+
1571
+ Possible values are [CHANNEL_TYPE_STOREFRONT](dw.order.LineItemCtnr.md#channel_type_storefront), [CHANNEL_TYPE_CALLCENTER](dw.order.LineItemCtnr.md#channel_type_callcenter),
1572
+ [CHANNEL_TYPE_MARKETPLACE](dw.order.LineItemCtnr.md#channel_type_marketplace), [CHANNEL_TYPE_DSS](dw.order.LineItemCtnr.md#channel_type_dss), [CHANNEL_TYPE_STORE](dw.order.LineItemCtnr.md#channel_type_store),
1573
+ [CHANNEL_TYPE_PINTEREST](dw.order.LineItemCtnr.md#channel_type_pinterest), [CHANNEL_TYPE_TWITTER](dw.order.LineItemCtnr.md#channel_type_twitter), [CHANNEL_TYPE_FACEBOOKADS](dw.order.LineItemCtnr.md#channel_type_facebookads),
1574
+ [CHANNEL_TYPE_SUBSCRIPTIONS](dw.order.LineItemCtnr.md#channel_type_subscriptions), [CHANNEL_TYPE_ONLINERESERVATION](dw.order.LineItemCtnr.md#channel_type_onlinereservation),
1575
+ [CHANNEL_TYPE_CUSTOMERSERVICECENTER](dw.order.LineItemCtnr.md#channel_type_customerservicecenter), [CHANNEL_TYPE_INSTAGRAMCOMMERCE](dw.order.LineItemCtnr.md#channel_type_instagramcommerce),
1576
+ [CHANNEL_TYPE_GOOGLE](dw.order.LineItemCtnr.md#channel_type_google), [CHANNEL_TYPE_YOUTUBE](dw.order.LineItemCtnr.md#channel_type_youtube), [CHANNEL_TYPE_TIKTOK](dw.order.LineItemCtnr.md#channel_type_tiktok),
1577
+ [CHANNEL_TYPE_SNAPCHAT](dw.order.LineItemCtnr.md#channel_type_snapchat), [CHANNEL_TYPE_WHATSAPP](dw.order.LineItemCtnr.md#channel_type_whatsapp)
1578
+
1579
+
1580
+ **Returns:**
1581
+ - the sales channel this order has been placed in or null, if the order channel is not set
1582
+
1583
+
1584
+ ---
1585
+
1586
+ ### getCouponLineItem(String)
1587
+ - getCouponLineItem(couponCode: [String](TopLevel.String.md)): [CouponLineItem](dw.order.CouponLineItem.md)
1588
+ - : Returns the coupon line item representing the specified coupon code.
1589
+
1590
+ **Parameters:**
1591
+ - couponCode - the coupon code.
1592
+
1593
+ **Returns:**
1594
+ - coupon line item or null.
1595
+
1596
+
1597
+ ---
1598
+
1599
+ ### getCouponLineItems()
1600
+ - getCouponLineItems(): [Collection](dw.util.Collection.md)
1601
+ - : Returns a sorted collection of the coupon line items in the container. The coupon line items are returned in the
1602
+ order they were added to container.
1603
+
1604
+
1605
+ **Returns:**
1606
+ - A sorted list of the CouponLineItem instances in the container.
1607
+
1608
+
1609
+ ---
1610
+
1611
+ ### getCurrencyCode()
1612
+ - getCurrencyCode(): [String](TopLevel.String.md)
1613
+ - : Returns the currency code for this line item container. The currency code is a 3-character currency mnemonic such
1614
+ as 'USD' or 'EUR'. The currency code represents the currency in which the calculation is made, and in which the
1615
+ buyer sees all prices in the store front.
1616
+
1617
+
1618
+ **Returns:**
1619
+ - the currency code for this line item container.
1620
+
1621
+
1622
+ ---
1623
+
1624
+ ### getCustomer()
1625
+ - getCustomer(): [Customer](dw.customer.Customer.md)
1626
+ - : Returns the customer associated with this container.
1627
+
1628
+ **Returns:**
1629
+ - the customer associated with this container.
1630
+
1631
+
1632
+ ---
1633
+
1634
+ ### getCustomerEmail()
1635
+ - getCustomerEmail(): [String](TopLevel.String.md)
1636
+ - : Returns the email of the customer associated with this container.
1637
+
1638
+ **Returns:**
1639
+ - the email of the customer associated with this container.
1640
+
1641
+
1642
+ ---
1643
+
1644
+ ### getCustomerName()
1645
+ - getCustomerName(): [String](TopLevel.String.md)
1646
+ - : Returns the name of the customer associated with this container.
1647
+
1648
+ **Returns:**
1649
+ - the name of the customer associated with this container.
1650
+
1651
+
1652
+ ---
1653
+
1654
+ ### getCustomerNo()
1655
+ - getCustomerNo(): [String](TopLevel.String.md)
1656
+ - : Returns the customer number of the customer associated with this container.
1657
+
1658
+ **Returns:**
1659
+ - the customer number of the customer associated with this container.
1660
+
1661
+
1662
+ ---
1663
+
1664
+ ### getDefaultShipment()
1665
+ - getDefaultShipment(): [Shipment](dw.order.Shipment.md)
1666
+ - : Returns the default shipment of the line item container. Every basket and order has a default shipment with the
1667
+ id "me". If you call a process that accesses a shipment, and you don't specify the shipment, then the process
1668
+ uses the default shipment. You can't remove a default shipment. Calling [removeShipment(Shipment)](dw.order.LineItemCtnr.md#removeshipmentshipment) on it
1669
+ throws an exception.
1670
+
1671
+
1672
+ **Returns:**
1673
+ - the default shipment of the container
1674
+
1675
+
1676
+ ---
1677
+
1678
+ ### getEtag()
1679
+ - getEtag(): [String](TopLevel.String.md)
1680
+ - : Returns the Etag of the line item container. The Etag is a hash that represents the overall container state
1681
+ including any associated objects like line items.
1682
+
1683
+
1684
+ **Returns:**
1685
+ - the Etag value
1686
+
1687
+
1688
+ ---
1689
+
1690
+ ### getGiftCertificateLineItems()
1691
+ - getGiftCertificateLineItems(): [Collection](dw.util.Collection.md)
1692
+ - : Returns all gift certificate line items of the container.
1693
+
1694
+ **Returns:**
1695
+ - A collection of all GiftCertificateLineItems of the container.
1696
+
1697
+
1698
+ ---
1699
+
1700
+ ### getGiftCertificateLineItems(String)
1701
+ - getGiftCertificateLineItems(giftCertificateId: [String](TopLevel.String.md)): [Collection](dw.util.Collection.md)
1702
+ - : Returns all gift certificate line items of the container, no matter if they are dependent or independent.
1703
+
1704
+ **Parameters:**
1705
+ - giftCertificateId - the gift certificate identifier.
1706
+
1707
+ **Returns:**
1708
+ - A collection of all GiftCertificateLineItems of the container.
1709
+
1710
+
1711
+ ---
1712
+
1713
+ ### getGiftCertificatePaymentInstruments()
1714
+ - getGiftCertificatePaymentInstruments(): [Collection](dw.util.Collection.md)
1715
+ - : Returns an unsorted collection of the PaymentInstrument instances that represent GiftCertificates in this
1716
+ container.
1717
+
1718
+
1719
+ **Returns:**
1720
+ - an unsorted collection containing the set of PaymentInstrument instances that represent GiftCertificates.
1721
+
1722
+
1723
+ ---
1724
+
1725
+ ### getGiftCertificatePaymentInstruments(String)
1726
+ - getGiftCertificatePaymentInstruments(giftCertificateCode: [String](TopLevel.String.md)): [Collection](dw.util.Collection.md)
1727
+ - : Returns an unsorted collection containing all PaymentInstruments of type
1728
+ PaymentInstrument.METHOD\_GIFT\_CERTIFICATE where the specified code is the same code on the payment instrument.
1729
+
1730
+
1731
+ **Parameters:**
1732
+ - giftCertificateCode - the gift certificate code.
1733
+
1734
+ **Returns:**
1735
+ - an unsorted collection containing all PaymentInstruments of type
1736
+ PaymentInstrument.METHOD\_GIFT\_CERTIFICATE where the specified code is the same code on the payment
1737
+ instrument.
1738
+
1739
+
1740
+
1741
+ ---
1742
+
1743
+ ### getGiftCertificateTotalGrossPrice()
1744
+ - getGiftCertificateTotalGrossPrice(): [Money](dw.value.Money.md)
1745
+ - : Returns the total gross price of all gift certificates in the cart. Should usually be equal to total net price.
1746
+
1747
+ **Returns:**
1748
+ - the total gross price of all gift certificate line items
1749
+
1750
+
1751
+ ---
1752
+
1753
+ ### getGiftCertificateTotalNetPrice()
1754
+ - getGiftCertificateTotalNetPrice(): [Money](dw.value.Money.md)
1755
+ - : Returns the total net price (excluding tax) of all gift certificates in the cart. Should usually be equal to
1756
+ total gross price.
1757
+
1758
+
1759
+ **Returns:**
1760
+ - the total net price of all gift certificate line items
1761
+
1762
+
1763
+ ---
1764
+
1765
+ ### getGiftCertificateTotalPrice()
1766
+ - getGiftCertificateTotalPrice(): [Money](dw.value.Money.md)
1767
+ - : Returns the gift certificate total price. If the line item container is based on net pricing the gift certificate
1768
+ total net price is returned. If the line item container is based on gross pricing the gift certificate total
1769
+ gross price is returned.
1770
+
1771
+
1772
+ **Returns:**
1773
+ - either the gift certificate total net or gross price
1774
+
1775
+
1776
+ ---
1777
+
1778
+ ### getGiftCertificateTotalTax()
1779
+ - getGiftCertificateTotalTax(): [Money](dw.value.Money.md)
1780
+ - : Returns the total tax of all gift certificates in the cart. Should usually be 0.0.
1781
+
1782
+ **Returns:**
1783
+ - the total tax of all gift certificate line items
1784
+
1785
+
1786
+ ---
1787
+
1788
+ ### getMerchandizeTotalGrossPrice()
1789
+ - getMerchandizeTotalGrossPrice(): [Money](dw.value.Money.md)
1790
+ - : Returns the total gross price (including tax) in purchase currency. Merchandize total prices represent the sum of
1791
+ product prices before services such as shipping or adjustment from promotions have been added.
1792
+
1793
+
1794
+ **Returns:**
1795
+ - the total gross price (including tax) in purchase currency.
1796
+
1797
+
1798
+ ---
1799
+
1800
+ ### getMerchandizeTotalNetPrice()
1801
+ - getMerchandizeTotalNetPrice(): [Money](dw.value.Money.md)
1802
+ - : Returns the total net price (excluding tax) in purchase currency. Merchandize total prices represent the sum of
1803
+ product prices before services such as shipping or adjustment from promotion have been added.
1804
+
1805
+
1806
+ **Returns:**
1807
+ - the total net price (excluding tax) in purchase currency.
1808
+
1809
+
1810
+ ---
1811
+
1812
+ ### getMerchandizeTotalPrice()
1813
+ - getMerchandizeTotalPrice(): [Money](dw.value.Money.md)
1814
+ - : Returns the merchandize total price. If the line item container is based on net pricing the merchandize total net
1815
+ price is returned. If the line item container is based on gross pricing the merchandize total gross price is
1816
+ returned.
1817
+
1818
+
1819
+ **Returns:**
1820
+ - either the merchandize total net or gross price
1821
+
1822
+
1823
+ ---
1824
+
1825
+ ### getMerchandizeTotalTax()
1826
+ - getMerchandizeTotalTax(): [Money](dw.value.Money.md)
1827
+ - : Returns the total tax in purchase currency. Merchandize total prices represent the sum of product prices before
1828
+ services such as shipping or adjustment from promotions have been added.
1829
+
1830
+
1831
+ **Returns:**
1832
+ - the total tax in purchase currency.
1833
+
1834
+
1835
+ ---
1836
+
1837
+ ### getNotes()
1838
+ - getNotes(): [List](dw.util.List.md)
1839
+ - : Returns the list of notes for this object, ordered by creation time from oldest to newest.
1840
+
1841
+ **Returns:**
1842
+ - the list of notes for this object, ordered by creation time from oldest to newest.
1843
+
1844
+
1845
+ ---
1846
+
1847
+ ### getPaymentInstrument()
1848
+ - ~~getPaymentInstrument(): [OrderPaymentInstrument](dw.order.OrderPaymentInstrument.md)~~
1849
+ - : Returns the payment instrument of the line item container or null. This method is deprecated. You should use
1850
+ getPaymentInstruments() or getGiftCertificatePaymentInstruments() instead.
1851
+
1852
+
1853
+ **Returns:**
1854
+ - the order payment instrument of the line item container or null.
1855
+
1856
+ **Deprecated:**
1857
+ :::warning
1858
+ Use [getPaymentInstruments()](dw.order.LineItemCtnr.md#getpaymentinstruments) or [getGiftCertificatePaymentInstruments()](dw.order.LineItemCtnr.md#getgiftcertificatepaymentinstruments) to get the
1859
+ set of payment instruments.
1860
+
1861
+ :::
1862
+
1863
+ ---
1864
+
1865
+ ### getPaymentInstruments()
1866
+ - getPaymentInstruments(): [Collection](dw.util.Collection.md)
1867
+ - : Returns an unsorted collection of the payment instruments in this container.
1868
+
1869
+ **Returns:**
1870
+ - an unsorted collection containing the set of PaymentInstrument instances associated with this container.
1871
+
1872
+
1873
+ ---
1874
+
1875
+ ### getPaymentInstruments(String)
1876
+ - getPaymentInstruments(paymentMethodID: [String](TopLevel.String.md)): [Collection](dw.util.Collection.md)
1877
+ - : Returns an unsorted collection of PaymentInstrument instances based on the specified payment method ID.
1878
+
1879
+ **Parameters:**
1880
+ - paymentMethodID - the ID of the payment method used.
1881
+
1882
+ **Returns:**
1883
+ - an unsorted collection of OrderPaymentInstrument instances based on the payment method.
1884
+
1885
+
1886
+ ---
1887
+
1888
+ ### getPriceAdjustmentByPromotionID(String)
1889
+ - getPriceAdjustmentByPromotionID(promotionID: [String](TopLevel.String.md)): [PriceAdjustment](dw.order.PriceAdjustment.md)
1890
+ - : Returns the price adjustment associated to the specified promotion ID.
1891
+
1892
+ **Parameters:**
1893
+ - promotionID - Promotion id
1894
+
1895
+ **Returns:**
1896
+ - The price adjustment associated with the specified promotion ID or null if none was found.
1897
+
1898
+
1899
+ ---
1900
+
1901
+ ### getPriceAdjustments()
1902
+ - getPriceAdjustments(): [Collection](dw.util.Collection.md)
1903
+ - : Returns the collection of price adjustments that have been applied to the totals such as promotion on the
1904
+ purchase value (i.e. $10 Off or 10% Off). The price adjustments are sorted by the order in which they were
1905
+ applied to the order by the promotions engine.
1906
+
1907
+
1908
+ **Returns:**
1909
+ - the sorted collection of PriceAdjustment instances.
1910
+
1911
+
1912
+ ---
1913
+
1914
+ ### getProductLineItems()
1915
+ - getProductLineItems(): [Collection](dw.util.Collection.md)
1916
+ - : Returns the product line items of the container that are not dependent on other product line items. This includes
1917
+ line items representing bonus products in the container but excludes option, bundled, and bonus line items. The
1918
+ returned collection is sorted by the position attribute of the product line items.
1919
+
1920
+
1921
+ **Returns:**
1922
+ - A sorted collection of ProductLineItem instances which are not dependent on other product line items.
1923
+
1924
+
1925
+ ---
1926
+
1927
+ ### getProductLineItems(String)
1928
+ - getProductLineItems(productID: [String](TopLevel.String.md)): [Collection](dw.util.Collection.md)
1929
+ - : Returns the product line items of the container that have a product ID equal to the specified product ID and that
1930
+ are not dependent on other product line items. This includes line items representing bonus products in the
1931
+ container, but excludes option, bundled and bonus line items. The returned collection is sorted by the position
1932
+ attribute of the product line items.
1933
+
1934
+
1935
+ **Parameters:**
1936
+ - productID - The Product ID used to filter the product line items.
1937
+
1938
+ **Returns:**
1939
+ - A sorted collection of ProductLineItem instances which have the specified product ID and are not
1940
+ dependent on other product line items.
1941
+
1942
+
1943
+
1944
+ ---
1945
+
1946
+ ### getProductQuantities()
1947
+ - getProductQuantities(): [HashMap](dw.util.HashMap.md)
1948
+ - : Returns a hash map of all products in the line item container and their total quantities. The total product
1949
+ quantity is for example used to lookup the product price.
1950
+
1951
+
1952
+ The method counts all direct product line items, plus dependent product line items that are not bundled line
1953
+ items and no option line items. It also excludes product line items that are not associated to any catalog
1954
+ product, and bonus product line items.
1955
+
1956
+
1957
+ **Returns:**
1958
+ - a map of products and their total quantities.
1959
+
1960
+ **See Also:**
1961
+ - [getProductQuantities(Boolean)](dw.order.LineItemCtnr.md#getproductquantitiesboolean)
1962
+
1963
+
1964
+ ---
1965
+
1966
+ ### getProductQuantities(Boolean)
1967
+ - getProductQuantities(includeBonusProducts: [Boolean](TopLevel.Boolean.md)): [HashMap](dw.util.HashMap.md)
1968
+ - : Returns a hash map of all products in the line item container and their total quantities. The total product
1969
+ quantity is for example used to lookup the product price in the cart.
1970
+
1971
+
1972
+ The method counts all direct product line items, plus dependent product line items that are not bundled line
1973
+ items and no option line items. It also excludes product line items that are not associated to any catalog
1974
+ product.
1975
+
1976
+
1977
+ If the parameter 'includeBonusProducts' is set to true, the method also counts bonus product line items.
1978
+
1979
+
1980
+ **Parameters:**
1981
+ - includeBonusProducts - if true also bonus product line item are counted
1982
+
1983
+ **Returns:**
1984
+ - A map of products and their total quantities.
1985
+
1986
+
1987
+ ---
1988
+
1989
+ ### getProductQuantityTotal()
1990
+ - getProductQuantityTotal(): [Number](TopLevel.Number.md)
1991
+ - : Returns the total quantity of all product line items. Not included are bundled line items and option line items.
1992
+
1993
+ **Returns:**
1994
+ - The total quantity of all line items of the container.
1995
+
1996
+
1997
+ ---
1998
+
1999
+ ### getShipment(String)
2000
+ - getShipment(id: [String](TopLevel.String.md)): [Shipment](dw.order.Shipment.md)
2001
+ - : Returns the shipment for the specified ID or `null` if no shipment with this ID exists in the line
2002
+ item container. Using "me" always returns the default shipment.
2003
+
2004
+
2005
+ **Parameters:**
2006
+ - id - the shipment identifier
2007
+
2008
+ **Returns:**
2009
+ - the shipment or `null`
2010
+
2011
+
2012
+ ---
2013
+
2014
+ ### getShipments()
2015
+ - getShipments(): [Collection](dw.util.Collection.md)
2016
+ - : Returns all shipments of the line item container.
2017
+
2018
+ The first shipment in the returned collection is the default shipment (shipment ID always set to "me"). All other
2019
+ shipments are sorted ascending by shipment ID.
2020
+
2021
+
2022
+ **Returns:**
2023
+ - all shipments of the line item container
2024
+
2025
+
2026
+ ---
2027
+
2028
+ ### getShippingPriceAdjustmentByPromotionID(String)
2029
+ - getShippingPriceAdjustmentByPromotionID(promotionID: [String](TopLevel.String.md)): [PriceAdjustment](dw.order.PriceAdjustment.md)
2030
+ - : Returns the shipping price adjustment associated with the specified promotion ID.
2031
+
2032
+ **Parameters:**
2033
+ - promotionID - Promotion id
2034
+
2035
+ **Returns:**
2036
+ - The price adjustment associated with the specified promotion ID or null if none was found.
2037
+
2038
+
2039
+ ---
2040
+
2041
+ ### getShippingPriceAdjustments()
2042
+ - getShippingPriceAdjustments(): [Collection](dw.util.Collection.md)
2043
+ - : Returns the of shipping price adjustments applied to the shipping total of the container. Note that the
2044
+ promotions engine only applies shipping price adjustments to the the default shipping line item of shipments, and
2045
+ never to the container.
2046
+
2047
+
2048
+ **Returns:**
2049
+ - a collection of shipping price adjustments.
2050
+
2051
+ **See Also:**
2052
+ - [getAllShippingPriceAdjustments()](dw.order.LineItemCtnr.md#getallshippingpriceadjustments)
2053
+
2054
+
2055
+ ---
2056
+
2057
+ ### getShippingTotalGrossPrice()
2058
+ - getShippingTotalGrossPrice(): [Money](dw.value.Money.md)
2059
+ - : Returns the sum of all shipping line items of the line item container, including tax before shipping adjustments
2060
+ have been applied.
2061
+
2062
+
2063
+ **Returns:**
2064
+ - the sum of all shipping line items of the line item container, including tax before shipping adjustments
2065
+ have been applied.
2066
+
2067
+
2068
+
2069
+ ---
2070
+
2071
+ ### getShippingTotalNetPrice()
2072
+ - getShippingTotalNetPrice(): [Money](dw.value.Money.md)
2073
+ - : Returns the sum of all shipping line items of the line item container, excluding tax before shipping adjustments
2074
+ have been applied.
2075
+
2076
+
2077
+ **Returns:**
2078
+ - the sum of all shipping line items of the line item container, excluding tax before shipping adjustments
2079
+ have been applied.
2080
+
2081
+
2082
+
2083
+ ---
2084
+
2085
+ ### getShippingTotalPrice()
2086
+ - getShippingTotalPrice(): [Money](dw.value.Money.md)
2087
+ - : Returns the shipping total price. If the line item container is based on net pricing the shipping total net price
2088
+ is returned. If the line item container is based on gross pricing the shipping total gross price is returned.
2089
+
2090
+
2091
+ **Returns:**
2092
+ - either the shipping total net or gross price
2093
+
2094
+
2095
+ ---
2096
+
2097
+ ### getShippingTotalTax()
2098
+ - getShippingTotalTax(): [Money](dw.value.Money.md)
2099
+ - : Returns the tax of all shipping line items of the line item container before shipping adjustments have been
2100
+ applied.
2101
+
2102
+
2103
+ **Returns:**
2104
+ - the tax of all shipping line items of the line item container before shipping adjustments have been
2105
+ applied.
2106
+
2107
+
2108
+
2109
+ ---
2110
+
2111
+ ### getTaxTotalsPerTaxRate()
2112
+ - getTaxTotalsPerTaxRate(): [SortedMap](dw.util.SortedMap.md)
2113
+ - : This method returns a [SortedMap](dw.util.SortedMap.md) in which the keys are [Decimal](dw.util.Decimal.md) tax rates and the values
2114
+ are [Money](dw.value.Money.md) total tax for the tax rate. The map is unmodifiable.
2115
+
2116
+
2117
+ **Returns:**
2118
+ - sorted map of tax rate against total tax
2119
+
2120
+
2121
+ ---
2122
+
2123
+ ### getTotalGrossPrice()
2124
+ - getTotalGrossPrice(): [Money](dw.value.Money.md)
2125
+ - : Returns the grand total price gross of tax for LineItemCtnr, in purchase currency. Total prices represent the sum
2126
+ of product prices, services prices and adjustments.
2127
+
2128
+
2129
+ **Returns:**
2130
+ - the grand total price.
2131
+
2132
+
2133
+ ---
2134
+
2135
+ ### getTotalNetPrice()
2136
+ - getTotalNetPrice(): [Money](dw.value.Money.md)
2137
+ - : Returns the grand total price for LineItemCtnr net of tax, in purchase currency. Total prices represent the sum
2138
+ of product prices, services prices and adjustments.
2139
+
2140
+
2141
+ **Returns:**
2142
+ - the grand total price.
2143
+
2144
+
2145
+ ---
2146
+
2147
+ ### getTotalTax()
2148
+ - getTotalTax(): [Money](dw.value.Money.md)
2149
+ - : Returns the grand total tax for LineItemCtnr, in purchase currency. Total prices represent the sum of product
2150
+ prices, services prices and adjustments.
2151
+
2152
+
2153
+ **Returns:**
2154
+ - the grand total tax.
2155
+
2156
+
2157
+ ---
2158
+
2159
+ ### isExternallyTaxed()
2160
+ - isExternallyTaxed(): [Boolean](TopLevel.Boolean.md)
2161
+ - : Use this method to check whether the LineItemCtnr is calculated based on external tax tables.
2162
+
2163
+ Note: a basket can only be created in EXTERNAL tax mode using SCAPI.
2164
+
2165
+
2166
+ **Returns:**
2167
+ - `true` if the LineItemCtnr was calculated based on external tax tables.
2168
+
2169
+
2170
+ ---
2171
+
2172
+ ### isTaxRoundedAtGroup()
2173
+ - isTaxRoundedAtGroup(): [Boolean](TopLevel.Boolean.md)
2174
+ - : Use this method to check if the LineItemCtnr was calculated with grouped taxation calculation.
2175
+
2176
+
2177
+ If the tax is rounded on group level, the tax is applied to the summed-up tax basis for each tax rate.
2178
+
2179
+
2180
+ **Returns:**
2181
+ - `true` if the LineItemCtnr was calculated with grouped taxation
2182
+
2183
+
2184
+ ---
2185
+
2186
+ ### removeAllPaymentInstruments()
2187
+ - removeAllPaymentInstruments(): void
2188
+ - : Removes the all Payment Instruments from this container and deletes the Payment Instruments.
2189
+
2190
+
2191
+ ---
2192
+
2193
+ ### removeBonusDiscountLineItem(BonusDiscountLineItem)
2194
+ - removeBonusDiscountLineItem(bonusDiscountLineItem: [BonusDiscountLineItem](dw.order.BonusDiscountLineItem.md)): void
2195
+ - : Removes the specified bonus discount line item from the line item container.
2196
+
2197
+ **Parameters:**
2198
+ - bonusDiscountLineItem - The bonus discount line item to remove, must not be null.
2199
+
2200
+
2201
+ ---
2202
+
2203
+ ### removeCouponLineItem(CouponLineItem)
2204
+ - removeCouponLineItem(couponLineItem: [CouponLineItem](dw.order.CouponLineItem.md)): void
2205
+ - : Removes the specified coupon line item from the line item container.
2206
+
2207
+ **Parameters:**
2208
+ - couponLineItem - The coupon line item to remove
2209
+
2210
+
2211
+ ---
2212
+
2213
+ ### removeGiftCertificateLineItem(GiftCertificateLineItem)
2214
+ - removeGiftCertificateLineItem(giftCertificateLineItem: [GiftCertificateLineItem](dw.order.GiftCertificateLineItem.md)): void
2215
+ - : Removes the specified gift certificate line item from the line item container.
2216
+
2217
+ **Parameters:**
2218
+ - giftCertificateLineItem - The gift certificate line item to remove
2219
+
2220
+
2221
+ ---
2222
+
2223
+ ### removeNote(Note)
2224
+ - removeNote(note: [Note](dw.object.Note.md)): void
2225
+ - : Removes a note from this line item container and deletes it.
2226
+
2227
+ **Parameters:**
2228
+ - note - The note to remove. Must not be null. Must belong to this line item container.
2229
+
2230
+
2231
+ ---
2232
+
2233
+ ### removePaymentInstrument(PaymentInstrument)
2234
+ - removePaymentInstrument(pi: [PaymentInstrument](dw.order.PaymentInstrument.md)): void
2235
+ - : Removes the specified Payment Instrument from this container and deletes the Payment Instrument.
2236
+
2237
+ **Parameters:**
2238
+ - pi - the Payment Instrument to remove.
2239
+
2240
+
2241
+ ---
2242
+
2243
+ ### removePriceAdjustment(PriceAdjustment)
2244
+ - removePriceAdjustment(priceAdjustment: [PriceAdjustment](dw.order.PriceAdjustment.md)): void
2245
+ - : Removes the specified price adjustment line item from the line item container.
2246
+
2247
+ **Parameters:**
2248
+ - priceAdjustment - The price adjustment line item to remove, must not be null.
2249
+
2250
+
2251
+ ---
2252
+
2253
+ ### removeProductLineItem(ProductLineItem)
2254
+ - removeProductLineItem(productLineItem: [ProductLineItem](dw.order.ProductLineItem.md)): void
2255
+ - : Removes the specified product line item from the line item container.
2256
+
2257
+ **Parameters:**
2258
+ - productLineItem - The product line item to remove, must not be null.
2259
+
2260
+
2261
+ ---
2262
+
2263
+ ### removeShipment(Shipment)
2264
+ - removeShipment(shipment: [Shipment](dw.order.Shipment.md)): void
2265
+ - : Removes the specified shipment and all associated product, gift certificate, shipping and price adjustment line
2266
+ items from the line item container. It is not permissible to remove the default shipment.
2267
+
2268
+
2269
+ **Parameters:**
2270
+ - shipment - Shipment to be removed, must not be null.
2271
+
2272
+
2273
+ ---
2274
+
2275
+ ### removeShippingPriceAdjustment(PriceAdjustment)
2276
+ - removeShippingPriceAdjustment(priceAdjustment: [PriceAdjustment](dw.order.PriceAdjustment.md)): void
2277
+ - : Removes the specified shipping price adjustment line item from the line item container.
2278
+
2279
+ **Parameters:**
2280
+ - priceAdjustment - The price adjustment line item to remove, must not be null.
2281
+
2282
+
2283
+ ---
2284
+
2285
+ ### setCustomerEmail(String)
2286
+ - setCustomerEmail(aValue: [String](TopLevel.String.md)): void
2287
+ - : Sets the email address of the customer associated with this container.
2288
+
2289
+ **Parameters:**
2290
+ - aValue - the email address of the customer associated with this container.
2291
+
2292
+
2293
+ ---
2294
+
2295
+ ### setCustomerName(String)
2296
+ - setCustomerName(aValue: [String](TopLevel.String.md)): void
2297
+ - : Sets the name of the customer associated with this container.
2298
+
2299
+ **Parameters:**
2300
+ - aValue - the name of the customer associated with this container.
2301
+
2302
+
2303
+ ---
2304
+
2305
+ ### updateOrderLevelPriceAdjustmentTax()
2306
+ - updateOrderLevelPriceAdjustmentTax(): void
2307
+ - : Calculates the tax for all shipping and order-level merchandise price adjustments in this LineItemCtnr.
2308
+
2309
+
2310
+ The tax on each adjustment is calculated from the taxes of the line items the adjustment applies across.
2311
+
2312
+
2313
+ **This method must be invoked at the end of tax calculation of a basket or an order.**
2314
+
2315
+
2316
+
2317
+ ---
2318
+
2319
+ ### updateTotals()
2320
+ - updateTotals(): void
2321
+ - : Recalculates the totals of the line item container. It is necessary to call this method after any type of
2322
+ modification to the basket.
2323
+
2324
+
2325
+
2326
+ ---
2327
+
2328
+ ### verifyPriceAdjustmentLimits()
2329
+ - verifyPriceAdjustmentLimits(): [Status](dw.system.Status.md)
2330
+ - : Verifies whether the manual price adjustments made for the line item container exceed the corresponding limits
2331
+ for the current user and the current site.
2332
+
2333
+
2334
+ The results of this method are based on the current values held in the [LineItemCtnr](dw.order.LineItemCtnr.md), such as the
2335
+ base price of manual price adjustments. It is important the method is only called after the calculation process
2336
+ has completed.
2337
+
2338
+
2339
+
2340
+
2341
+ Status.OK is returned if NONE of the manual price adjustments exceed the correspondent limits.
2342
+
2343
+
2344
+ Status.ERROR is returned if ANY of the manual price adjustments exceed the correspondent limits. If this case
2345
+ [Status.getItems()](dw.system.Status.md#getitems) returns all price adjustment limit violations. The code of each
2346
+ [StatusItem](dw.system.StatusItem.md) represents the violated price adjustment type (see
2347
+ [PriceAdjustmentLimitTypes](dw.order.PriceAdjustmentLimitTypes.md)). [StatusItem.getDetails()](dw.system.StatusItem.md#getdetails) returns a
2348
+ [Map](dw.util.Map.md) with the max amount and (where relevant) the item to which the violation applies.
2349
+
2350
+
2351
+ Usage:
2352
+
2353
+
2354
+ ```
2355
+ var order : Order; // known
2356
+
2357
+ var status : Status = order.verifyPriceAdjustmentLimits();
2358
+ if (status.status == Status.ERROR)
2359
+ {
2360
+ for each (var statusItem : StatusItem in status.items)
2361
+ {
2362
+ var statusDetail : MapEntry = statusItem.details.entrySet().iterator().next();
2363
+ var maxAllowedLimit : Number = (Number) (statusDetail.key);
2364
+
2365
+ if (statusItem.code == PriceAdjustmentLimitTypes.TYPE_ORDER)
2366
+ {
2367
+ // fix order price adjustment considering maxAllowedLimit
2368
+ }
2369
+ else if (statusItem.code == PriceAdjustmentLimitTypes.TYPE_ITEM)
2370
+ {
2371
+ var pli : ProductLineItem = (ProductLineItem) (statusDetail.value);
2372
+ // fix pli price adjustment considering maxAllowedLimit
2373
+ }
2374
+ else if (statusItem.code == PriceAdjustmentLimitTypes.TYPE_SHIPPING)
2375
+ {
2376
+ if (statusDetail.value == null)
2377
+ {
2378
+ // fix order level shipping price adjustment considering maxAllowedLimit
2379
+ }
2380
+ else
2381
+ {
2382
+ var sli : ShippingLineItem = (ShippingLineItem) (statusDetail.value);
2383
+ // fix sli price adjustment considering maxAllowedLimit
2384
+ }
2385
+ }
2386
+ }
2387
+ }
2388
+ ```
2389
+
2390
+
2391
+ **Returns:**
2392
+ - a Status instance with - Status.OK if all manual price adjustments do not exceed the correspondent
2393
+ limits, otherwise Status.ERROR
2394
+
2395
+
2396
+
2397
+ ---
2398
+
2399
+ <!-- prettier-ignore-end -->