@salesforce/b2c-tooling-sdk 0.0.0-nightly.20260119053920

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 (1131) hide show
  1. package/README.md +174 -0
  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 +130 -0
  647. package/dist/cjs/clients/index.js +127 -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/scapi-schemas.d.ts +132 -0
  674. package/dist/cjs/clients/scapi-schemas.generated.d.ts +328 -0
  675. package/dist/cjs/clients/scapi-schemas.generated.js +6 -0
  676. package/dist/cjs/clients/scapi-schemas.generated.js.map +1 -0
  677. package/dist/cjs/clients/scapi-schemas.js +95 -0
  678. package/dist/cjs/clients/scapi-schemas.js.map +1 -0
  679. package/dist/cjs/clients/slas-admin.d.ts +104 -0
  680. package/dist/cjs/clients/slas-admin.generated.d.ts +1434 -0
  681. package/dist/cjs/clients/slas-admin.generated.js +6 -0
  682. package/dist/cjs/clients/slas-admin.generated.js.map +1 -0
  683. package/dist/cjs/clients/slas-admin.js +79 -0
  684. package/dist/cjs/clients/slas-admin.js.map +1 -0
  685. package/dist/cjs/clients/webdav.d.ts +157 -0
  686. package/dist/cjs/clients/webdav.js +337 -0
  687. package/dist/cjs/clients/webdav.js.map +1 -0
  688. package/dist/cjs/config/dw-json.d.ts +114 -0
  689. package/dist/cjs/config/dw-json.js +142 -0
  690. package/dist/cjs/config/dw-json.js.map +1 -0
  691. package/dist/cjs/config/index.d.ts +96 -0
  692. package/dist/cjs/config/index.js +103 -0
  693. package/dist/cjs/config/index.js.map +1 -0
  694. package/dist/cjs/config/mapping.d.ts +143 -0
  695. package/dist/cjs/config/mapping.js +212 -0
  696. package/dist/cjs/config/mapping.js.map +1 -0
  697. package/dist/cjs/config/resolved-config.d.ts +31 -0
  698. package/dist/cjs/config/resolved-config.js +84 -0
  699. package/dist/cjs/config/resolved-config.js.map +1 -0
  700. package/dist/cjs/config/resolver.d.ts +190 -0
  701. package/dist/cjs/config/resolver.js +323 -0
  702. package/dist/cjs/config/resolver.js.map +1 -0
  703. package/dist/cjs/config/sources/dw-json-source.d.ts +10 -0
  704. package/dist/cjs/config/sources/dw-json-source.js +38 -0
  705. package/dist/cjs/config/sources/dw-json-source.js.map +1 -0
  706. package/dist/cjs/config/sources/index.d.ts +7 -0
  707. package/dist/cjs/config/sources/index.js +13 -0
  708. package/dist/cjs/config/sources/index.js.map +1 -0
  709. package/dist/cjs/config/sources/mobify-source.d.ts +24 -0
  710. package/dist/cjs/config/sources/mobify-source.js +79 -0
  711. package/dist/cjs/config/sources/mobify-source.js.map +1 -0
  712. package/dist/cjs/config/types.d.ts +270 -0
  713. package/dist/cjs/config/types.js +2 -0
  714. package/dist/cjs/config/types.js.map +1 -0
  715. package/dist/cjs/defaults.d.ts +22 -0
  716. package/dist/cjs/defaults.js +28 -0
  717. package/dist/cjs/defaults.js.map +1 -0
  718. package/dist/cjs/discovery/detector.d.ts +75 -0
  719. package/dist/cjs/discovery/detector.js +108 -0
  720. package/dist/cjs/discovery/detector.js.map +1 -0
  721. package/dist/cjs/discovery/index.d.ts +63 -0
  722. package/dist/cjs/discovery/index.js +70 -0
  723. package/dist/cjs/discovery/index.js.map +1 -0
  724. package/dist/cjs/discovery/patterns/cartridges.d.ts +16 -0
  725. package/dist/cjs/discovery/patterns/cartridges.js +16 -0
  726. package/dist/cjs/discovery/patterns/cartridges.js.map +1 -0
  727. package/dist/cjs/discovery/patterns/index.d.ts +21 -0
  728. package/dist/cjs/discovery/patterns/index.js +16 -0
  729. package/dist/cjs/discovery/patterns/index.js.map +1 -0
  730. package/dist/cjs/discovery/patterns/pwa-kit.d.ts +15 -0
  731. package/dist/cjs/discovery/patterns/pwa-kit.js +26 -0
  732. package/dist/cjs/discovery/patterns/pwa-kit.js.map +1 -0
  733. package/dist/cjs/discovery/patterns/sfra.d.ts +34 -0
  734. package/dist/cjs/discovery/patterns/sfra.js +50 -0
  735. package/dist/cjs/discovery/patterns/sfra.js.map +1 -0
  736. package/dist/cjs/discovery/patterns/storefront-next.d.ts +14 -0
  737. package/dist/cjs/discovery/patterns/storefront-next.js +20 -0
  738. package/dist/cjs/discovery/patterns/storefront-next.js.map +1 -0
  739. package/dist/cjs/discovery/types.d.ts +47 -0
  740. package/dist/cjs/discovery/types.js +12 -0
  741. package/dist/cjs/discovery/types.js.map +1 -0
  742. package/dist/cjs/discovery/utils.d.ts +44 -0
  743. package/dist/cjs/discovery/utils.js +82 -0
  744. package/dist/cjs/discovery/utils.js.map +1 -0
  745. package/dist/cjs/errors/http-error.d.ts +34 -0
  746. package/dist/cjs/errors/http-error.js +45 -0
  747. package/dist/cjs/errors/http-error.js.map +1 -0
  748. package/dist/cjs/errors/index.d.ts +6 -0
  749. package/dist/cjs/errors/index.js +12 -0
  750. package/dist/cjs/errors/index.js.map +1 -0
  751. package/dist/cjs/i18n/index.d.ts +144 -0
  752. package/dist/cjs/i18n/index.js +242 -0
  753. package/dist/cjs/i18n/index.js.map +1 -0
  754. package/dist/cjs/i18n/locales/de.d.ts +13 -0
  755. package/dist/cjs/i18n/locales/de.js +19 -0
  756. package/dist/cjs/i18n/locales/de.js.map +1 -0
  757. package/dist/cjs/i18n/locales/index.d.ts +28 -0
  758. package/dist/cjs/i18n/locales/index.js +25 -0
  759. package/dist/cjs/i18n/locales/index.js.map +1 -0
  760. package/dist/cjs/index.d.ts +25 -0
  761. package/dist/cjs/index.js +31 -0
  762. package/dist/cjs/index.js.map +1 -0
  763. package/dist/cjs/instance/index.d.ts +132 -0
  764. package/dist/cjs/instance/index.js +124 -0
  765. package/dist/cjs/instance/index.js.map +1 -0
  766. package/dist/cjs/logger.d.ts +66 -0
  767. package/dist/cjs/logger.js +80 -0
  768. package/dist/cjs/logger.js.map +1 -0
  769. package/dist/cjs/logging/index.d.ts +116 -0
  770. package/dist/cjs/logging/index.js +121 -0
  771. package/dist/cjs/logging/index.js.map +1 -0
  772. package/dist/cjs/logging/logger.d.ts +9 -0
  773. package/dist/cjs/logging/logger.js +111 -0
  774. package/dist/cjs/logging/logger.js.map +1 -0
  775. package/dist/cjs/logging/types.d.ts +36 -0
  776. package/dist/cjs/logging/types.js +10 -0
  777. package/dist/cjs/logging/types.js.map +1 -0
  778. package/dist/cjs/operations/code/cartridges.d.ts +46 -0
  779. package/dist/cjs/operations/code/cartridges.js +59 -0
  780. package/dist/cjs/operations/code/cartridges.js.map +1 -0
  781. package/dist/cjs/operations/code/deploy.d.ts +101 -0
  782. package/dist/cjs/operations/code/deploy.js +218 -0
  783. package/dist/cjs/operations/code/deploy.js.map +1 -0
  784. package/dist/cjs/operations/code/index.d.ts +66 -0
  785. package/dist/cjs/operations/code/index.js +72 -0
  786. package/dist/cjs/operations/code/index.js.map +1 -0
  787. package/dist/cjs/operations/code/versions.d.ts +99 -0
  788. package/dist/cjs/operations/code/versions.js +156 -0
  789. package/dist/cjs/operations/code/versions.js.map +1 -0
  790. package/dist/cjs/operations/code/watch.d.ts +58 -0
  791. package/dist/cjs/operations/code/watch.js +226 -0
  792. package/dist/cjs/operations/code/watch.js.map +1 -0
  793. package/dist/cjs/operations/docs/download.d.ts +45 -0
  794. package/dist/cjs/operations/docs/download.js +96 -0
  795. package/dist/cjs/operations/docs/download.js.map +1 -0
  796. package/dist/cjs/operations/docs/index.d.ts +44 -0
  797. package/dist/cjs/operations/docs/index.js +12 -0
  798. package/dist/cjs/operations/docs/index.js.map +1 -0
  799. package/dist/cjs/operations/docs/schema.d.ts +24 -0
  800. package/dist/cjs/operations/docs/schema.js +92 -0
  801. package/dist/cjs/operations/docs/schema.js.map +1 -0
  802. package/dist/cjs/operations/docs/search.d.ts +67 -0
  803. package/dist/cjs/operations/docs/search.js +128 -0
  804. package/dist/cjs/operations/docs/search.js.map +1 -0
  805. package/dist/cjs/operations/docs/types.d.ts +64 -0
  806. package/dist/cjs/operations/docs/types.js +15 -0
  807. package/dist/cjs/operations/docs/types.js.map +1 -0
  808. package/dist/cjs/operations/jobs/index.d.ts +66 -0
  809. package/dist/cjs/operations/jobs/index.js +72 -0
  810. package/dist/cjs/operations/jobs/index.js.map +1 -0
  811. package/dist/cjs/operations/jobs/run.d.ts +224 -0
  812. package/dist/cjs/operations/jobs/run.js +322 -0
  813. package/dist/cjs/operations/jobs/run.js.map +1 -0
  814. package/dist/cjs/operations/jobs/site-archive.d.ts +224 -0
  815. package/dist/cjs/operations/jobs/site-archive.js +354 -0
  816. package/dist/cjs/operations/jobs/site-archive.js.map +1 -0
  817. package/dist/cjs/operations/mrt/bundle.d.ts +114 -0
  818. package/dist/cjs/operations/mrt/bundle.js +166 -0
  819. package/dist/cjs/operations/mrt/bundle.js.map +1 -0
  820. package/dist/cjs/operations/mrt/env-var.d.ts +176 -0
  821. package/dist/cjs/operations/mrt/env-var.js +231 -0
  822. package/dist/cjs/operations/mrt/env-var.js.map +1 -0
  823. package/dist/cjs/operations/mrt/env.d.ts +256 -0
  824. package/dist/cjs/operations/mrt/env.js +233 -0
  825. package/dist/cjs/operations/mrt/env.js.map +1 -0
  826. package/dist/cjs/operations/mrt/index.d.ts +49 -0
  827. package/dist/cjs/operations/mrt/index.js +55 -0
  828. package/dist/cjs/operations/mrt/index.js.map +1 -0
  829. package/dist/cjs/operations/mrt/push.d.ts +109 -0
  830. package/dist/cjs/operations/mrt/push.js +149 -0
  831. package/dist/cjs/operations/mrt/push.js.map +1 -0
  832. package/dist/cjs/operations/scapi-schemas/collapse.d.ts +150 -0
  833. package/dist/cjs/operations/scapi-schemas/collapse.js +180 -0
  834. package/dist/cjs/operations/scapi-schemas/collapse.js.map +1 -0
  835. package/dist/cjs/operations/scapi-schemas/index.d.ts +53 -0
  836. package/dist/cjs/operations/scapi-schemas/index.js +59 -0
  837. package/dist/cjs/operations/scapi-schemas/index.js.map +1 -0
  838. package/dist/cjs/operations/sites/index.d.ts +56 -0
  839. package/dist/cjs/operations/sites/index.js +19 -0
  840. package/dist/cjs/operations/sites/index.js.map +1 -0
  841. package/dist/cjs/package.json +1 -0
  842. package/dist/cjs/platform/index.d.ts +38 -0
  843. package/dist/cjs/platform/index.js +42 -0
  844. package/dist/cjs/platform/index.js.map +1 -0
  845. package/dist/cjs/platform/mrt.d.ts +19 -0
  846. package/dist/cjs/platform/mrt.js +22 -0
  847. package/dist/cjs/platform/mrt.js.map +1 -0
  848. package/dist/cjs/platform/ods.d.ts +17 -0
  849. package/dist/cjs/platform/ods.js +22 -0
  850. package/dist/cjs/platform/ods.js.map +1 -0
  851. package/dist/esm/auth/api-key.d.ts +28 -0
  852. package/dist/esm/auth/api-key.js +44 -0
  853. package/dist/esm/auth/api-key.js.map +1 -0
  854. package/dist/esm/auth/basic.d.ts +7 -0
  855. package/dist/esm/auth/basic.js +18 -0
  856. package/dist/esm/auth/basic.js.map +1 -0
  857. package/dist/esm/auth/index.d.ts +65 -0
  858. package/dist/esm/auth/index.js +69 -0
  859. package/dist/esm/auth/index.js.map +1 -0
  860. package/dist/esm/auth/oauth-implicit.d.ts +74 -0
  861. package/dist/esm/auth/oauth-implicit.js +330 -0
  862. package/dist/esm/auth/oauth-implicit.js.map +1 -0
  863. package/dist/esm/auth/oauth.d.ts +48 -0
  864. package/dist/esm/auth/oauth.js +178 -0
  865. package/dist/esm/auth/oauth.js.map +1 -0
  866. package/dist/esm/auth/resolve.d.ts +100 -0
  867. package/dist/esm/auth/resolve.js +173 -0
  868. package/dist/esm/auth/resolve.js.map +1 -0
  869. package/dist/esm/auth/types.d.ts +101 -0
  870. package/dist/esm/auth/types.js +3 -0
  871. package/dist/esm/auth/types.js.map +1 -0
  872. package/dist/esm/cli/base-command.d.ts +98 -0
  873. package/dist/esm/cli/base-command.js +331 -0
  874. package/dist/esm/cli/base-command.js.map +1 -0
  875. package/dist/esm/cli/cartridge-command.d.ts +65 -0
  876. package/dist/esm/cli/cartridge-command.js +142 -0
  877. package/dist/esm/cli/cartridge-command.js.map +1 -0
  878. package/dist/esm/cli/cartridge-providers.d.ts +149 -0
  879. package/dist/esm/cli/cartridge-providers.js +103 -0
  880. package/dist/esm/cli/cartridge-providers.js.map +1 -0
  881. package/dist/esm/cli/config.d.ts +75 -0
  882. package/dist/esm/cli/config.js +65 -0
  883. package/dist/esm/cli/config.js.map +1 -0
  884. package/dist/esm/cli/hooks.d.ts +231 -0
  885. package/dist/esm/cli/hooks.js +3 -0
  886. package/dist/esm/cli/hooks.js.map +1 -0
  887. package/dist/esm/cli/index.d.ts +103 -0
  888. package/dist/esm/cli/index.js +108 -0
  889. package/dist/esm/cli/index.js.map +1 -0
  890. package/dist/esm/cli/instance-command.d.ts +121 -0
  891. package/dist/esm/cli/instance-command.js +213 -0
  892. package/dist/esm/cli/instance-command.js.map +1 -0
  893. package/dist/esm/cli/job-command.d.ts +32 -0
  894. package/dist/esm/cli/job-command.js +66 -0
  895. package/dist/esm/cli/job-command.js.map +1 -0
  896. package/dist/esm/cli/lifecycle.d.ts +189 -0
  897. package/dist/esm/cli/lifecycle.js +130 -0
  898. package/dist/esm/cli/lifecycle.js.map +1 -0
  899. package/dist/esm/cli/mrt-command.d.ts +61 -0
  900. package/dist/esm/cli/mrt-command.js +113 -0
  901. package/dist/esm/cli/mrt-command.js.map +1 -0
  902. package/dist/esm/cli/oauth-command.d.ts +70 -0
  903. package/dist/esm/cli/oauth-command.js +173 -0
  904. package/dist/esm/cli/oauth-command.js.map +1 -0
  905. package/dist/esm/cli/ods-command.d.ts +70 -0
  906. package/dist/esm/cli/ods-command.js +79 -0
  907. package/dist/esm/cli/ods-command.js.map +1 -0
  908. package/dist/esm/cli/table.d.ts +113 -0
  909. package/dist/esm/cli/table.js +175 -0
  910. package/dist/esm/cli/table.js.map +1 -0
  911. package/dist/esm/cli/webdav-command.d.ts +100 -0
  912. package/dist/esm/cli/webdav-command.js +106 -0
  913. package/dist/esm/cli/webdav-command.js.map +1 -0
  914. package/dist/esm/clients/custom-apis.d.ts +137 -0
  915. package/dist/esm/clients/custom-apis.generated.d.ts +202 -0
  916. package/dist/esm/clients/custom-apis.generated.js +6 -0
  917. package/dist/esm/clients/custom-apis.generated.js.map +1 -0
  918. package/dist/esm/clients/custom-apis.js +124 -0
  919. package/dist/esm/clients/custom-apis.js.map +1 -0
  920. package/dist/esm/clients/index.d.ts +130 -0
  921. package/dist/esm/clients/index.js +127 -0
  922. package/dist/esm/clients/index.js.map +1 -0
  923. package/dist/esm/clients/middleware-registry.d.ts +184 -0
  924. package/dist/esm/clients/middleware-registry.js +104 -0
  925. package/dist/esm/clients/middleware-registry.js.map +1 -0
  926. package/dist/esm/clients/middleware.d.ts +85 -0
  927. package/dist/esm/clients/middleware.js +210 -0
  928. package/dist/esm/clients/middleware.js.map +1 -0
  929. package/dist/esm/clients/mrt.d.ts +120 -0
  930. package/dist/esm/clients/mrt.generated.d.ts +2774 -0
  931. package/dist/esm/clients/mrt.generated.js +6 -0
  932. package/dist/esm/clients/mrt.generated.js.map +1 -0
  933. package/dist/esm/clients/mrt.js +88 -0
  934. package/dist/esm/clients/mrt.js.map +1 -0
  935. package/dist/esm/clients/ocapi.d.ts +108 -0
  936. package/dist/esm/clients/ocapi.generated.d.ts +26052 -0
  937. package/dist/esm/clients/ocapi.generated.js +6 -0
  938. package/dist/esm/clients/ocapi.generated.js.map +1 -0
  939. package/dist/esm/clients/ocapi.js +80 -0
  940. package/dist/esm/clients/ocapi.js.map +1 -0
  941. package/dist/esm/clients/ods.d.ts +133 -0
  942. package/dist/esm/clients/ods.generated.d.ts +2548 -0
  943. package/dist/esm/clients/ods.generated.js +6 -0
  944. package/dist/esm/clients/ods.generated.js.map +1 -0
  945. package/dist/esm/clients/ods.js +103 -0
  946. package/dist/esm/clients/ods.js.map +1 -0
  947. package/dist/esm/clients/scapi-schemas.d.ts +132 -0
  948. package/dist/esm/clients/scapi-schemas.generated.d.ts +328 -0
  949. package/dist/esm/clients/scapi-schemas.generated.js +6 -0
  950. package/dist/esm/clients/scapi-schemas.generated.js.map +1 -0
  951. package/dist/esm/clients/scapi-schemas.js +95 -0
  952. package/dist/esm/clients/scapi-schemas.js.map +1 -0
  953. package/dist/esm/clients/slas-admin.d.ts +104 -0
  954. package/dist/esm/clients/slas-admin.generated.d.ts +1434 -0
  955. package/dist/esm/clients/slas-admin.generated.js +6 -0
  956. package/dist/esm/clients/slas-admin.generated.js.map +1 -0
  957. package/dist/esm/clients/slas-admin.js +79 -0
  958. package/dist/esm/clients/slas-admin.js.map +1 -0
  959. package/dist/esm/clients/webdav.d.ts +157 -0
  960. package/dist/esm/clients/webdav.js +337 -0
  961. package/dist/esm/clients/webdav.js.map +1 -0
  962. package/dist/esm/config/dw-json.d.ts +114 -0
  963. package/dist/esm/config/dw-json.js +142 -0
  964. package/dist/esm/config/dw-json.js.map +1 -0
  965. package/dist/esm/config/index.d.ts +96 -0
  966. package/dist/esm/config/index.js +103 -0
  967. package/dist/esm/config/index.js.map +1 -0
  968. package/dist/esm/config/mapping.d.ts +143 -0
  969. package/dist/esm/config/mapping.js +212 -0
  970. package/dist/esm/config/mapping.js.map +1 -0
  971. package/dist/esm/config/resolved-config.d.ts +31 -0
  972. package/dist/esm/config/resolved-config.js +84 -0
  973. package/dist/esm/config/resolved-config.js.map +1 -0
  974. package/dist/esm/config/resolver.d.ts +190 -0
  975. package/dist/esm/config/resolver.js +323 -0
  976. package/dist/esm/config/resolver.js.map +1 -0
  977. package/dist/esm/config/sources/dw-json-source.d.ts +10 -0
  978. package/dist/esm/config/sources/dw-json-source.js +38 -0
  979. package/dist/esm/config/sources/dw-json-source.js.map +1 -0
  980. package/dist/esm/config/sources/index.d.ts +7 -0
  981. package/dist/esm/config/sources/index.js +13 -0
  982. package/dist/esm/config/sources/index.js.map +1 -0
  983. package/dist/esm/config/sources/mobify-source.d.ts +24 -0
  984. package/dist/esm/config/sources/mobify-source.js +79 -0
  985. package/dist/esm/config/sources/mobify-source.js.map +1 -0
  986. package/dist/esm/config/types.d.ts +270 -0
  987. package/dist/esm/config/types.js +2 -0
  988. package/dist/esm/config/types.js.map +1 -0
  989. package/dist/esm/defaults.d.ts +22 -0
  990. package/dist/esm/defaults.js +28 -0
  991. package/dist/esm/defaults.js.map +1 -0
  992. package/dist/esm/discovery/detector.d.ts +75 -0
  993. package/dist/esm/discovery/detector.js +108 -0
  994. package/dist/esm/discovery/detector.js.map +1 -0
  995. package/dist/esm/discovery/index.d.ts +63 -0
  996. package/dist/esm/discovery/index.js +70 -0
  997. package/dist/esm/discovery/index.js.map +1 -0
  998. package/dist/esm/discovery/patterns/cartridges.d.ts +16 -0
  999. package/dist/esm/discovery/patterns/cartridges.js +16 -0
  1000. package/dist/esm/discovery/patterns/cartridges.js.map +1 -0
  1001. package/dist/esm/discovery/patterns/index.d.ts +21 -0
  1002. package/dist/esm/discovery/patterns/index.js +16 -0
  1003. package/dist/esm/discovery/patterns/index.js.map +1 -0
  1004. package/dist/esm/discovery/patterns/pwa-kit.d.ts +15 -0
  1005. package/dist/esm/discovery/patterns/pwa-kit.js +26 -0
  1006. package/dist/esm/discovery/patterns/pwa-kit.js.map +1 -0
  1007. package/dist/esm/discovery/patterns/sfra.d.ts +34 -0
  1008. package/dist/esm/discovery/patterns/sfra.js +50 -0
  1009. package/dist/esm/discovery/patterns/sfra.js.map +1 -0
  1010. package/dist/esm/discovery/patterns/storefront-next.d.ts +14 -0
  1011. package/dist/esm/discovery/patterns/storefront-next.js +20 -0
  1012. package/dist/esm/discovery/patterns/storefront-next.js.map +1 -0
  1013. package/dist/esm/discovery/types.d.ts +47 -0
  1014. package/dist/esm/discovery/types.js +12 -0
  1015. package/dist/esm/discovery/types.js.map +1 -0
  1016. package/dist/esm/discovery/utils.d.ts +44 -0
  1017. package/dist/esm/discovery/utils.js +82 -0
  1018. package/dist/esm/discovery/utils.js.map +1 -0
  1019. package/dist/esm/errors/http-error.d.ts +34 -0
  1020. package/dist/esm/errors/http-error.js +45 -0
  1021. package/dist/esm/errors/http-error.js.map +1 -0
  1022. package/dist/esm/errors/index.d.ts +6 -0
  1023. package/dist/esm/errors/index.js +12 -0
  1024. package/dist/esm/errors/index.js.map +1 -0
  1025. package/dist/esm/i18n/index.d.ts +144 -0
  1026. package/dist/esm/i18n/index.js +242 -0
  1027. package/dist/esm/i18n/index.js.map +1 -0
  1028. package/dist/esm/i18n/locales/de.d.ts +13 -0
  1029. package/dist/esm/i18n/locales/de.js +19 -0
  1030. package/dist/esm/i18n/locales/de.js.map +1 -0
  1031. package/dist/esm/i18n/locales/index.d.ts +28 -0
  1032. package/dist/esm/i18n/locales/index.js +25 -0
  1033. package/dist/esm/i18n/locales/index.js.map +1 -0
  1034. package/dist/esm/index.d.ts +25 -0
  1035. package/dist/esm/index.js +31 -0
  1036. package/dist/esm/index.js.map +1 -0
  1037. package/dist/esm/instance/index.d.ts +132 -0
  1038. package/dist/esm/instance/index.js +124 -0
  1039. package/dist/esm/instance/index.js.map +1 -0
  1040. package/dist/esm/logger.d.ts +66 -0
  1041. package/dist/esm/logger.js +80 -0
  1042. package/dist/esm/logger.js.map +1 -0
  1043. package/dist/esm/logging/index.d.ts +116 -0
  1044. package/dist/esm/logging/index.js +121 -0
  1045. package/dist/esm/logging/index.js.map +1 -0
  1046. package/dist/esm/logging/logger.d.ts +9 -0
  1047. package/dist/esm/logging/logger.js +111 -0
  1048. package/dist/esm/logging/logger.js.map +1 -0
  1049. package/dist/esm/logging/types.d.ts +36 -0
  1050. package/dist/esm/logging/types.js +10 -0
  1051. package/dist/esm/logging/types.js.map +1 -0
  1052. package/dist/esm/operations/code/cartridges.d.ts +46 -0
  1053. package/dist/esm/operations/code/cartridges.js +59 -0
  1054. package/dist/esm/operations/code/cartridges.js.map +1 -0
  1055. package/dist/esm/operations/code/deploy.d.ts +101 -0
  1056. package/dist/esm/operations/code/deploy.js +218 -0
  1057. package/dist/esm/operations/code/deploy.js.map +1 -0
  1058. package/dist/esm/operations/code/index.d.ts +66 -0
  1059. package/dist/esm/operations/code/index.js +72 -0
  1060. package/dist/esm/operations/code/index.js.map +1 -0
  1061. package/dist/esm/operations/code/versions.d.ts +99 -0
  1062. package/dist/esm/operations/code/versions.js +157 -0
  1063. package/dist/esm/operations/code/versions.js.map +1 -0
  1064. package/dist/esm/operations/code/watch.d.ts +58 -0
  1065. package/dist/esm/operations/code/watch.js +226 -0
  1066. package/dist/esm/operations/code/watch.js.map +1 -0
  1067. package/dist/esm/operations/docs/download.d.ts +45 -0
  1068. package/dist/esm/operations/docs/download.js +96 -0
  1069. package/dist/esm/operations/docs/download.js.map +1 -0
  1070. package/dist/esm/operations/docs/index.d.ts +44 -0
  1071. package/dist/esm/operations/docs/index.js +12 -0
  1072. package/dist/esm/operations/docs/index.js.map +1 -0
  1073. package/dist/esm/operations/docs/schema.d.ts +24 -0
  1074. package/dist/esm/operations/docs/schema.js +92 -0
  1075. package/dist/esm/operations/docs/schema.js.map +1 -0
  1076. package/dist/esm/operations/docs/search.d.ts +67 -0
  1077. package/dist/esm/operations/docs/search.js +128 -0
  1078. package/dist/esm/operations/docs/search.js.map +1 -0
  1079. package/dist/esm/operations/docs/types.d.ts +64 -0
  1080. package/dist/esm/operations/docs/types.js +15 -0
  1081. package/dist/esm/operations/docs/types.js.map +1 -0
  1082. package/dist/esm/operations/jobs/index.d.ts +66 -0
  1083. package/dist/esm/operations/jobs/index.js +72 -0
  1084. package/dist/esm/operations/jobs/index.js.map +1 -0
  1085. package/dist/esm/operations/jobs/run.d.ts +224 -0
  1086. package/dist/esm/operations/jobs/run.js +333 -0
  1087. package/dist/esm/operations/jobs/run.js.map +1 -0
  1088. package/dist/esm/operations/jobs/site-archive.d.ts +224 -0
  1089. package/dist/esm/operations/jobs/site-archive.js +355 -0
  1090. package/dist/esm/operations/jobs/site-archive.js.map +1 -0
  1091. package/dist/esm/operations/mrt/bundle.d.ts +114 -0
  1092. package/dist/esm/operations/mrt/bundle.js +166 -0
  1093. package/dist/esm/operations/mrt/bundle.js.map +1 -0
  1094. package/dist/esm/operations/mrt/env-var.d.ts +176 -0
  1095. package/dist/esm/operations/mrt/env-var.js +231 -0
  1096. package/dist/esm/operations/mrt/env-var.js.map +1 -0
  1097. package/dist/esm/operations/mrt/env.d.ts +256 -0
  1098. package/dist/esm/operations/mrt/env.js +233 -0
  1099. package/dist/esm/operations/mrt/env.js.map +1 -0
  1100. package/dist/esm/operations/mrt/index.d.ts +49 -0
  1101. package/dist/esm/operations/mrt/index.js +55 -0
  1102. package/dist/esm/operations/mrt/index.js.map +1 -0
  1103. package/dist/esm/operations/mrt/push.d.ts +109 -0
  1104. package/dist/esm/operations/mrt/push.js +149 -0
  1105. package/dist/esm/operations/mrt/push.js.map +1 -0
  1106. package/dist/esm/operations/scapi-schemas/collapse.d.ts +150 -0
  1107. package/dist/esm/operations/scapi-schemas/collapse.js +180 -0
  1108. package/dist/esm/operations/scapi-schemas/collapse.js.map +1 -0
  1109. package/dist/esm/operations/scapi-schemas/index.d.ts +53 -0
  1110. package/dist/esm/operations/scapi-schemas/index.js +59 -0
  1111. package/dist/esm/operations/scapi-schemas/index.js.map +1 -0
  1112. package/dist/esm/operations/sites/index.d.ts +56 -0
  1113. package/dist/esm/operations/sites/index.js +67 -0
  1114. package/dist/esm/operations/sites/index.js.map +1 -0
  1115. package/dist/esm/platform/index.d.ts +38 -0
  1116. package/dist/esm/platform/index.js +42 -0
  1117. package/dist/esm/platform/index.js.map +1 -0
  1118. package/dist/esm/platform/mrt.d.ts +19 -0
  1119. package/dist/esm/platform/mrt.js +22 -0
  1120. package/dist/esm/platform/mrt.js.map +1 -0
  1121. package/dist/esm/platform/ods.d.ts +17 -0
  1122. package/dist/esm/platform/ods.js +22 -0
  1123. package/dist/esm/platform/ods.js.map +1 -0
  1124. package/package.json +284 -0
  1125. package/specs/README.md +7 -0
  1126. package/specs/custom-apis-v1.yaml +309 -0
  1127. package/specs/data-api.json +37503 -0
  1128. package/specs/mrt-api-v1.json +5555 -0
  1129. package/specs/ods-api-v1.json +3673 -0
  1130. package/specs/scapi-schemas-v1.yaml +341 -0
  1131. package/specs/slas-admin-v1.yaml +1841 -0
@@ -0,0 +1,2770 @@
1
+ <!-- prettier-ignore-start -->
2
+ # Class Order
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
+ - [dw.order.Order](dw.order.Order.md)
9
+
10
+ The Order class represents an order. The correct way to retrieve an order is described in [OrderMgr](dw.order.OrderMgr.md).
11
+
12
+
13
+ ## Constant Summary
14
+
15
+ | Constant | Description |
16
+ | --- | --- |
17
+ | [CONFIRMATION_STATUS_CONFIRMED](#confirmation_status_confirmed): [Number](TopLevel.Number.md) = 2 | constant for when Confirmation Status is Confirmed |
18
+ | [CONFIRMATION_STATUS_NOTCONFIRMED](#confirmation_status_notconfirmed): [Number](TopLevel.Number.md) = 0 | constant for when Confirmation Status is Not Confirmed |
19
+ | [ENCRYPTION_ALGORITHM_RSA_ECB_OAEPWITHSHA_256ANDMGF1PADDING](#encryption_algorithm_rsa_ecb_oaepwithsha_256andmgf1padding): [String](TopLevel.String.md) = "RSA/ECB/OAEPWithSHA-256AndMGF1Padding" | The encryption algorithm "RSA/ECB/OAEPWithSHA-256AndMGF1Padding". |
20
+ | ~~[ENCRYPTION_ALGORITHM_RSA_ECB_PKCS1PADDING](#encryption_algorithm_rsa_ecb_pkcs1padding): [String](TopLevel.String.md) = "RSA/ECB/PKCS1Padding"~~ | The outdated encryption algorithm "RSA/ECB/PKCS1Padding". |
21
+ | [EXPORT_STATUS_EXPORTED](#export_status_exported): [Number](TopLevel.Number.md) = 1 | constant for when Export Status is Exported |
22
+ | [EXPORT_STATUS_FAILED](#export_status_failed): [Number](TopLevel.Number.md) = 3 | constant for when Export Status is Failed |
23
+ | [EXPORT_STATUS_NOTEXPORTED](#export_status_notexported): [Number](TopLevel.Number.md) = 0 | constant for when Export Status is Not Exported |
24
+ | [EXPORT_STATUS_READY](#export_status_ready): [Number](TopLevel.Number.md) = 2 | constant for when Export Status is ready to be exported. |
25
+ | [ORDER_STATUS_CANCELLED](#order_status_cancelled): [Number](TopLevel.Number.md) = 6 | constant for when Order Status is Cancelled |
26
+ | [ORDER_STATUS_COMPLETED](#order_status_completed): [Number](TopLevel.Number.md) = 5 | constant for when Order Status is Completed |
27
+ | [ORDER_STATUS_CREATED](#order_status_created): [Number](TopLevel.Number.md) = 0 | constant for when Order Status is Created |
28
+ | [ORDER_STATUS_FAILED](#order_status_failed): [Number](TopLevel.Number.md) = 8 | constant for when Order Status is Failed |
29
+ | [ORDER_STATUS_NEW](#order_status_new): [Number](TopLevel.Number.md) = 3 | constant for when Order Status is New |
30
+ | [ORDER_STATUS_OPEN](#order_status_open): [Number](TopLevel.Number.md) = 4 | constant for when Order Status is Open |
31
+ | [ORDER_STATUS_REPLACED](#order_status_replaced): [Number](TopLevel.Number.md) = 7 | constant for when Order Status is Replaced |
32
+ | [PAYMENT_STATUS_NOTPAID](#payment_status_notpaid): [Number](TopLevel.Number.md) = 0 | constant for when Payment Status is Not Paid |
33
+ | [PAYMENT_STATUS_PAID](#payment_status_paid): [Number](TopLevel.Number.md) = 2 | constant for when Payment Status is Paid |
34
+ | [PAYMENT_STATUS_PARTPAID](#payment_status_partpaid): [Number](TopLevel.Number.md) = 1 | constant for when Payment Status is Part Paid |
35
+ | [SHIPPING_STATUS_NOTSHIPPED](#shipping_status_notshipped): [Number](TopLevel.Number.md) = 0 | constant for when Shipping Status is Not shipped |
36
+ | [SHIPPING_STATUS_PARTSHIPPED](#shipping_status_partshipped): [Number](TopLevel.Number.md) = 1 | constant for when Shipping Status is Part Shipped |
37
+ | [SHIPPING_STATUS_SHIPPED](#shipping_status_shipped): [Number](TopLevel.Number.md) = 2 | constant for when Shipping Status is Shipped |
38
+
39
+ ## Property Summary
40
+
41
+ | Property | Description |
42
+ | --- | --- |
43
+ | [affiliatePartnerID](#affiliatepartnerid): [String](TopLevel.String.md) | Returns the affiliate partner ID value, or null. |
44
+ | [affiliatePartnerName](#affiliatepartnername): [String](TopLevel.String.md) | Returns the affiliate partner name value, or null. |
45
+ | [appeasementItems](#appeasementitems): [FilteringCollection](dw.util.FilteringCollection.md) `(read-only)` | Returns the collection of [AppeasementItem](dw.order.AppeasementItem.md)s associated with this order. |
46
+ | [appeasements](#appeasements): [FilteringCollection](dw.util.FilteringCollection.md) `(read-only)` | Returns the collection of [Appeasement](dw.order.Appeasement.md)s associated with this order. |
47
+ | [cancelCode](#cancelcode): [EnumValue](dw.value.EnumValue.md) | If this order was cancelled, returns the value of the cancel code or null. |
48
+ | [cancelDescription](#canceldescription): [String](TopLevel.String.md) | If this order was cancelled, returns the text describing why the order was cancelled or null. |
49
+ | [capturedAmount](#capturedamount): [Money](dw.value.Money.md) `(read-only)` | Returns the sum of the captured amounts. |
50
+ | [confirmationStatus](#confirmationstatus): [EnumValue](dw.value.EnumValue.md) | Returns the confirmation status of the order.<br/> Possible values are [CONFIRMATION_STATUS_NOTCONFIRMED](dw.order.Order.md#confirmation_status_notconfirmed) and [CONFIRMATION_STATUS_CONFIRMED](dw.order.Order.md#confirmation_status_confirmed). |
51
+ | [createdBy](#createdby): [String](TopLevel.String.md) `(read-only)` | Returns the name of the user who has created the order. |
52
+ | [currentOrder](#currentorder): [Order](dw.order.Order.md) `(read-only)` | Returns the current order. |
53
+ | [currentOrderNo](#currentorderno): [String](TopLevel.String.md) `(read-only)` | Returns the order number of the current order. |
54
+ | [customerLocaleID](#customerlocaleid): [String](TopLevel.String.md) `(read-only)` | Returns the ID of the locale that was in effect when the order was placed. |
55
+ | [customerOrderReference](#customerorderreference): [String](TopLevel.String.md) | Returns the customer-specific reference information for the order, or null. |
56
+ | [exportAfter](#exportafter): [Date](TopLevel.Date.md) | Returns a date after which an order can be exported. |
57
+ | [exportStatus](#exportstatus): [EnumValue](dw.value.EnumValue.md) | Returns the export status of the order.<br/> Possible values are: [EXPORT_STATUS_NOTEXPORTED](dw.order.Order.md#export_status_notexported), [EXPORT_STATUS_EXPORTED](dw.order.Order.md#export_status_exported), [EXPORT_STATUS_READY](dw.order.Order.md#export_status_ready), and [EXPORT_STATUS_FAILED](dw.order.Order.md#export_status_failed). |
58
+ | [externalOrderNo](#externalorderno): [String](TopLevel.String.md) | Returns the value of an external order number associated with this order, or null. |
59
+ | [externalOrderStatus](#externalorderstatus): [String](TopLevel.String.md) | Returns the status of an external order associated with this order, or null. |
60
+ | [externalOrderText](#externalordertext): [String](TopLevel.String.md) | Returns the text describing the external order, or null. |
61
+ | [globalPartyID](#globalpartyid): [String](TopLevel.String.md) `(read-only)` | The Global Party ID reconciles customer identity across multiple systems. |
62
+ | [imported](#imported): [Boolean](TopLevel.Boolean.md) `(read-only)` | Returns `true`, if the order is imported and `false` otherwise. |
63
+ | [invoiceItems](#invoiceitems): [FilteringCollection](dw.util.FilteringCollection.md) `(read-only)` | Returns the collection of [InvoiceItem](dw.order.InvoiceItem.md)s associated with this order. |
64
+ | [invoiceNo](#invoiceno): [String](TopLevel.String.md) | Returns the invoice number for this Order. |
65
+ | [invoices](#invoices): [FilteringCollection](dw.util.FilteringCollection.md) `(read-only)` | Returns the collection of [Invoice](dw.order.Invoice.md)s associated with this order. |
66
+ | [orderExportXML](#orderexportxml): [String](TopLevel.String.md) `(read-only)` | Returns the order export XML as String object. |
67
+ | [orderNo](#orderno): [String](TopLevel.String.md) `(read-only)` | Returns the order number for this order. |
68
+ | [orderToken](#ordertoken): [String](TopLevel.String.md) `(read-only)` | Returns the token for this order. |
69
+ | [originalOrder](#originalorder): [Order](dw.order.Order.md) `(read-only)` | Returns the original order associated with this order. |
70
+ | [originalOrderNo](#originalorderno): [String](TopLevel.String.md) `(read-only)` | Returns the order number of the original order associated with this order. |
71
+ | [paymentStatus](#paymentstatus): [EnumValue](dw.value.EnumValue.md) | Returns the order payment status value.<br/> Possible values are [PAYMENT_STATUS_NOTPAID](dw.order.Order.md#payment_status_notpaid), [PAYMENT_STATUS_PARTPAID](dw.order.Order.md#payment_status_partpaid) or [PAYMENT_STATUS_PAID](dw.order.Order.md#payment_status_paid). |
72
+ | ~~[paymentTransaction](#paymenttransaction): [PaymentTransaction](dw.order.PaymentTransaction.md)~~ `(read-only)` | Returns the payment transaction associated with this order. |
73
+ | [refundedAmount](#refundedamount): [Money](dw.value.Money.md) `(read-only)` | Returns the sum of the refunded amounts. |
74
+ | [remoteHost](#remotehost): [String](TopLevel.String.md) `(read-only)` | Returns the IP address of the remote host from which the order was created. |
75
+ | [replaceCode](#replacecode): [EnumValue](dw.value.EnumValue.md) | If this order was replaced by another order, returns the value of the replace code. |
76
+ | [replaceDescription](#replacedescription): [String](TopLevel.String.md) | If this order was replaced by another order, returns the value of the replace description. |
77
+ | [replacedOrder](#replacedorder): [Order](dw.order.Order.md) `(read-only)` | Returns the order that this order replaced or null. |
78
+ | [replacedOrderNo](#replacedorderno): [String](TopLevel.String.md) `(read-only)` | Returns the order number that this order replaced or null if this order did not replace an order. |
79
+ | [replacementOrder](#replacementorder): [Order](dw.order.Order.md) `(read-only)` | Returns the order that replaced this order, or null. |
80
+ | [replacementOrderNo](#replacementorderno): [String](TopLevel.String.md) `(read-only)` | If this order was replaced by another order, returns the order number that replaced this order. |
81
+ | [returnCaseItems](#returncaseitems): [FilteringCollection](dw.util.FilteringCollection.md) `(read-only)` | Returns the collection of [ReturnCaseItem](dw.order.ReturnCaseItem.md)s associated with this order. |
82
+ | [returnCases](#returncases): [FilteringCollection](dw.util.FilteringCollection.md) `(read-only)` | Returns the collection of [ReturnCase](dw.order.ReturnCase.md)s associated with this order. |
83
+ | [returnItems](#returnitems): [FilteringCollection](dw.util.FilteringCollection.md) `(read-only)` | Returns the collection of [ReturnItem](dw.order.ReturnItem.md)s associated with this order. |
84
+ | [returns](#returns): [FilteringCollection](dw.util.FilteringCollection.md) `(read-only)` | Returns the collection of [Return](dw.order.Return.md)s associated with this order. |
85
+ | [shippingOrderItems](#shippingorderitems): [FilteringCollection](dw.util.FilteringCollection.md) `(read-only)` | Returns the collection of [ShippingOrderItem](dw.order.ShippingOrderItem.md)s associated with this order. |
86
+ | [shippingOrders](#shippingorders): [FilteringCollection](dw.util.FilteringCollection.md) `(read-only)` | Returns the collection of [ShippingOrder](dw.order.ShippingOrder.md)s associated with this order. |
87
+ | [shippingStatus](#shippingstatus): [EnumValue](dw.value.EnumValue.md) | Returns the order shipping status.<br/> Possible values are [SHIPPING_STATUS_NOTSHIPPED](dw.order.Order.md#shipping_status_notshipped), [SHIPPING_STATUS_PARTSHIPPED](dw.order.Order.md#shipping_status_partshipped) or [SHIPPING_STATUS_SHIPPED](dw.order.Order.md#shipping_status_shipped). |
88
+ | [sourceCode](#sourcecode): [String](TopLevel.String.md) `(read-only)` | Returns the source code stored with the order or `null` if no source code is attached to the order. |
89
+ | [sourceCodeGroup](#sourcecodegroup): [SourceCodeGroup](dw.campaign.SourceCodeGroup.md) `(read-only)` | Returns the source code group attached to the order or `null` if no source code group is attached to the order. |
90
+ | [sourceCodeGroupID](#sourcecodegroupid): [String](TopLevel.String.md) `(read-only)` | Returns the source code group id stored with the order or `null` if no source code group is attached to the order. |
91
+ | [status](#status): [EnumValue](dw.value.EnumValue.md) | Returns the status of the order.<br/> Possible values are: <ul> <li>[ORDER_STATUS_CREATED](dw.order.Order.md#order_status_created)</li> <li>[ORDER_STATUS_NEW](dw.order.Order.md#order_status_new)</li> <li>[ORDER_STATUS_OPEN](dw.order.Order.md#order_status_open)</li> <li>[ORDER_STATUS_COMPLETED](dw.order.Order.md#order_status_completed)</li> <li>[ORDER_STATUS_CANCELLED](dw.order.Order.md#order_status_cancelled)</li> <li>[ORDER_STATUS_FAILED](dw.order.Order.md#order_status_failed)</li> <li>[ORDER_STATUS_REPLACED](dw.order.Order.md#order_status_replaced)</li> </ul> |
92
+ | [taxRoundedAtGroup](#taxroundedatgroup): [Boolean](TopLevel.Boolean.md) `(read-only)` | Use this method to check if the Order was created with grouped taxation calculation. |
93
+
94
+ ## Constructor Summary
95
+
96
+ This class does not have a constructor, so you cannot create it directly.
97
+ ## Method Summary
98
+
99
+ | Method | Description |
100
+ | --- | --- |
101
+ | [createAppeasement](dw.order.Order.md#createappeasement)() | Creates a new [Appeasement](dw.order.Appeasement.md) associated with this order. |
102
+ | [createAppeasement](dw.order.Order.md#createappeasementstring)([String](TopLevel.String.md)) | Creates a new [Appeasement](dw.order.Appeasement.md) associated with this order. |
103
+ | [createReturnCase](dw.order.Order.md#createreturncaseboolean)([Boolean](TopLevel.Boolean.md)) | Creates a new [ReturnCase](dw.order.ReturnCase.md) associated with this order specifying whether the ReturnCase is an RMA (return merchandise authorization). |
104
+ | [createReturnCase](dw.order.Order.md#createreturncasestring-boolean)([String](TopLevel.String.md), [Boolean](TopLevel.Boolean.md)) | Creates a new [ReturnCase](dw.order.ReturnCase.md) associated with this order specifying whether the ReturnCase is an RMA (return merchandise authorization). |
105
+ | [createServiceItem](dw.order.Order.md#createserviceitemstring-string)([String](TopLevel.String.md), [String](TopLevel.String.md)) | Returns the [order item](dw.order.OrderItem.md) with the given status which wraps a new [service item](dw.order.ShippingLineItem.md) which is created and added to the order. |
106
+ | [createShippingOrder](dw.order.Order.md#createshippingorder)() | Creates a new [ShippingOrder](dw.order.ShippingOrder.md) for this order. |
107
+ | [createShippingOrder](dw.order.Order.md#createshippingorderstring)([String](TopLevel.String.md)) | Creates a new [ShippingOrder](dw.order.ShippingOrder.md) for this order. |
108
+ | [getAffiliatePartnerID](dw.order.Order.md#getaffiliatepartnerid)() | Returns the affiliate partner ID value, or null. |
109
+ | [getAffiliatePartnerName](dw.order.Order.md#getaffiliatepartnername)() | Returns the affiliate partner name value, or null. |
110
+ | [getAppeasement](dw.order.Order.md#getappeasementstring)([String](TopLevel.String.md)) | Returns the [Appeasement](dw.order.Appeasement.md) associated with this order with the given appeasementNumber. |
111
+ | [getAppeasementItem](dw.order.Order.md#getappeasementitemstring)([String](TopLevel.String.md)) | Returns the [AppeasementItem](dw.order.AppeasementItem.md) associated with this Order with the given appeasementItemID. |
112
+ | [getAppeasementItems](dw.order.Order.md#getappeasementitems)() | Returns the collection of [AppeasementItem](dw.order.AppeasementItem.md)s associated with this order. |
113
+ | [getAppeasements](dw.order.Order.md#getappeasements)() | Returns the collection of [Appeasement](dw.order.Appeasement.md)s associated with this order. |
114
+ | [getCancelCode](dw.order.Order.md#getcancelcode)() | If this order was cancelled, returns the value of the cancel code or null. |
115
+ | [getCancelDescription](dw.order.Order.md#getcanceldescription)() | If this order was cancelled, returns the text describing why the order was cancelled or null. |
116
+ | [getCapturedAmount](dw.order.Order.md#getcapturedamount)() | Returns the sum of the captured amounts. |
117
+ | [getConfirmationStatus](dw.order.Order.md#getconfirmationstatus)() | Returns the confirmation status of the order.<br/> Possible values are [CONFIRMATION_STATUS_NOTCONFIRMED](dw.order.Order.md#confirmation_status_notconfirmed) and [CONFIRMATION_STATUS_CONFIRMED](dw.order.Order.md#confirmation_status_confirmed). |
118
+ | [getCreatedBy](dw.order.Order.md#getcreatedby)() | Returns the name of the user who has created the order. |
119
+ | [getCurrentOrder](dw.order.Order.md#getcurrentorder)() | Returns the current order. |
120
+ | [getCurrentOrderNo](dw.order.Order.md#getcurrentorderno)() | Returns the order number of the current order. |
121
+ | [getCustomerLocaleID](dw.order.Order.md#getcustomerlocaleid)() | Returns the ID of the locale that was in effect when the order was placed. |
122
+ | [getCustomerOrderReference](dw.order.Order.md#getcustomerorderreference)() | Returns the customer-specific reference information for the order, or null. |
123
+ | [getExportAfter](dw.order.Order.md#getexportafter)() | Returns a date after which an order can be exported. |
124
+ | [getExportStatus](dw.order.Order.md#getexportstatus)() | Returns the export status of the order.<br/> Possible values are: [EXPORT_STATUS_NOTEXPORTED](dw.order.Order.md#export_status_notexported), [EXPORT_STATUS_EXPORTED](dw.order.Order.md#export_status_exported), [EXPORT_STATUS_READY](dw.order.Order.md#export_status_ready), and [EXPORT_STATUS_FAILED](dw.order.Order.md#export_status_failed). |
125
+ | [getExternalOrderNo](dw.order.Order.md#getexternalorderno)() | Returns the value of an external order number associated with this order, or null. |
126
+ | [getExternalOrderStatus](dw.order.Order.md#getexternalorderstatus)() | Returns the status of an external order associated with this order, or null. |
127
+ | [getExternalOrderText](dw.order.Order.md#getexternalordertext)() | Returns the text describing the external order, or null. |
128
+ | [getGlobalPartyID](dw.order.Order.md#getglobalpartyid)() | The Global Party ID reconciles customer identity across multiple systems. |
129
+ | [getInvoice](dw.order.Order.md#getinvoicestring)([String](TopLevel.String.md)) | Returns the [Invoice](dw.order.Invoice.md) associated with this order with the given invoiceNumber. |
130
+ | [getInvoiceItem](dw.order.Order.md#getinvoiceitemstring)([String](TopLevel.String.md)) | Returns the [InvoiceItem](dw.order.InvoiceItem.md) associated with this order with the given ID. |
131
+ | [getInvoiceItems](dw.order.Order.md#getinvoiceitems)() | Returns the collection of [InvoiceItem](dw.order.InvoiceItem.md)s associated with this order. |
132
+ | [getInvoiceNo](dw.order.Order.md#getinvoiceno)() | Returns the invoice number for this Order. |
133
+ | [getInvoices](dw.order.Order.md#getinvoices)() | Returns the collection of [Invoice](dw.order.Invoice.md)s associated with this order. |
134
+ | [getOrderExportXML](dw.order.Order.md#getorderexportxml)() | Returns the order export XML as String object. |
135
+ | [getOrderExportXML](dw.order.Order.md#getorderexportxmlstring-string---variant-1)([String](TopLevel.String.md), [String](TopLevel.String.md)) | Returns the order export XML as String object, with payment instrument data re-encrypted using the given encryption algorithm and key. |
136
+ | ~~[getOrderExportXML](dw.order.Order.md#getorderexportxmlstring-string-boolean---variant-1)([String](TopLevel.String.md), [String](TopLevel.String.md), [Boolean](TopLevel.Boolean.md))~~ | Returns the order export XML as String object, with payment instrument data re-encrypted using the given encryption algorithm and key. |
137
+ | [getOrderExportXML](dw.order.Order.md#getorderexportxmlstring-string---variant-2)([String](TopLevel.String.md), [String](TopLevel.String.md)) | Returns the order export XML as String object, with payment instrument data re-encrypted using the given encryption algorithm and key. |
138
+ | [getOrderItem](dw.order.Order.md#getorderitemstring)([String](TopLevel.String.md)) | Returns the [OrderItem](dw.order.OrderItem.md) for the itemID. |
139
+ | [getOrderNo](dw.order.Order.md#getorderno)() | Returns the order number for this order. |
140
+ | [getOrderToken](dw.order.Order.md#getordertoken)() | Returns the token for this order. |
141
+ | [getOriginalOrder](dw.order.Order.md#getoriginalorder)() | Returns the original order associated with this order. |
142
+ | [getOriginalOrderNo](dw.order.Order.md#getoriginalorderno)() | Returns the order number of the original order associated with this order. |
143
+ | [getPaymentStatus](dw.order.Order.md#getpaymentstatus)() | Returns the order payment status value.<br/> Possible values are [PAYMENT_STATUS_NOTPAID](dw.order.Order.md#payment_status_notpaid), [PAYMENT_STATUS_PARTPAID](dw.order.Order.md#payment_status_partpaid) or [PAYMENT_STATUS_PAID](dw.order.Order.md#payment_status_paid). |
144
+ | ~~[getPaymentTransaction](dw.order.Order.md#getpaymenttransaction)()~~ | Returns the payment transaction associated with this order. |
145
+ | [getRefundedAmount](dw.order.Order.md#getrefundedamount)() | Returns the sum of the refunded amounts. |
146
+ | [getRemoteHost](dw.order.Order.md#getremotehost)() | Returns the IP address of the remote host from which the order was created. |
147
+ | [getReplaceCode](dw.order.Order.md#getreplacecode)() | If this order was replaced by another order, returns the value of the replace code. |
148
+ | [getReplaceDescription](dw.order.Order.md#getreplacedescription)() | If this order was replaced by another order, returns the value of the replace description. |
149
+ | [getReplacedOrder](dw.order.Order.md#getreplacedorder)() | Returns the order that this order replaced or null. |
150
+ | [getReplacedOrderNo](dw.order.Order.md#getreplacedorderno)() | Returns the order number that this order replaced or null if this order did not replace an order. |
151
+ | [getReplacementOrder](dw.order.Order.md#getreplacementorder)() | Returns the order that replaced this order, or null. |
152
+ | [getReplacementOrderNo](dw.order.Order.md#getreplacementorderno)() | If this order was replaced by another order, returns the order number that replaced this order. |
153
+ | [getReturn](dw.order.Order.md#getreturnstring)([String](TopLevel.String.md)) | Returns the [Return](dw.order.Return.md) associated with this order with the given returnNumber. |
154
+ | [getReturnCase](dw.order.Order.md#getreturncasestring)([String](TopLevel.String.md)) | Returns the [ReturnCase](dw.order.ReturnCase.md) associated with this order with the given returnCaseNumber. |
155
+ | [getReturnCaseItem](dw.order.Order.md#getreturncaseitemstring)([String](TopLevel.String.md)) | Returns the [ReturnCaseItem](dw.order.ReturnCaseItem.md) associated with this order with the given returnCaseItemID. |
156
+ | [getReturnCaseItems](dw.order.Order.md#getreturncaseitems)() | Returns the collection of [ReturnCaseItem](dw.order.ReturnCaseItem.md)s associated with this order. |
157
+ | [getReturnCases](dw.order.Order.md#getreturncases)() | Returns the collection of [ReturnCase](dw.order.ReturnCase.md)s associated with this order. |
158
+ | [getReturnItem](dw.order.Order.md#getreturnitemstring)([String](TopLevel.String.md)) | Returns the [ReturnItem](dw.order.ReturnItem.md) associated with this order with the given ID. |
159
+ | [getReturnItems](dw.order.Order.md#getreturnitems)() | Returns the collection of [ReturnItem](dw.order.ReturnItem.md)s associated with this order. |
160
+ | [getReturns](dw.order.Order.md#getreturns)() | Returns the collection of [Return](dw.order.Return.md)s associated with this order. |
161
+ | [getShippingOrder](dw.order.Order.md#getshippingorderstring)([String](TopLevel.String.md)) | Returns the [ShippingOrder](dw.order.ShippingOrder.md) associated with this order with the given shippingOrderNumber. |
162
+ | [getShippingOrderItem](dw.order.Order.md#getshippingorderitemstring)([String](TopLevel.String.md)) | Returns the [ShippingOrderItem](dw.order.ShippingOrderItem.md) associated with this order with the given shippingOrderItemID. |
163
+ | [getShippingOrderItems](dw.order.Order.md#getshippingorderitems)() | Returns the collection of [ShippingOrderItem](dw.order.ShippingOrderItem.md)s associated with this order. |
164
+ | [getShippingOrders](dw.order.Order.md#getshippingorders)() | Returns the collection of [ShippingOrder](dw.order.ShippingOrder.md)s associated with this order. |
165
+ | [getShippingStatus](dw.order.Order.md#getshippingstatus)() | Returns the order shipping status.<br/> Possible values are [SHIPPING_STATUS_NOTSHIPPED](dw.order.Order.md#shipping_status_notshipped), [SHIPPING_STATUS_PARTSHIPPED](dw.order.Order.md#shipping_status_partshipped) or [SHIPPING_STATUS_SHIPPED](dw.order.Order.md#shipping_status_shipped). |
166
+ | [getSourceCode](dw.order.Order.md#getsourcecode)() | Returns the source code stored with the order or `null` if no source code is attached to the order. |
167
+ | [getSourceCodeGroup](dw.order.Order.md#getsourcecodegroup)() | Returns the source code group attached to the order or `null` if no source code group is attached to the order. |
168
+ | [getSourceCodeGroupID](dw.order.Order.md#getsourcecodegroupid)() | Returns the source code group id stored with the order or `null` if no source code group is attached to the order. |
169
+ | [getStatus](dw.order.Order.md#getstatus)() | Returns the status of the order.<br/> Possible values are: <ul> <li>[ORDER_STATUS_CREATED](dw.order.Order.md#order_status_created)</li> <li>[ORDER_STATUS_NEW](dw.order.Order.md#order_status_new)</li> <li>[ORDER_STATUS_OPEN](dw.order.Order.md#order_status_open)</li> <li>[ORDER_STATUS_COMPLETED](dw.order.Order.md#order_status_completed)</li> <li>[ORDER_STATUS_CANCELLED](dw.order.Order.md#order_status_cancelled)</li> <li>[ORDER_STATUS_FAILED](dw.order.Order.md#order_status_failed)</li> <li>[ORDER_STATUS_REPLACED](dw.order.Order.md#order_status_replaced)</li> </ul> |
170
+ | [isImported](dw.order.Order.md#isimported)() | Returns `true`, if the order is imported and `false` otherwise. |
171
+ | [isTaxRoundedAtGroup](dw.order.Order.md#istaxroundedatgroup)() | Use this method to check if the Order was created with grouped taxation calculation. |
172
+ | [reauthorize](dw.order.Order.md#reauthorize)() | Ensures that the order is authorized. |
173
+ | [removeRemoteHost](dw.order.Order.md#removeremotehost)() | Removes the IP address of the remote host if stored. |
174
+ | [setAffiliatePartnerID](dw.order.Order.md#setaffiliatepartneridstring)([String](TopLevel.String.md)) | Sets the affiliate partner ID value. |
175
+ | [setAffiliatePartnerName](dw.order.Order.md#setaffiliatepartnernamestring)([String](TopLevel.String.md)) | Sets the affiliate partner name value. |
176
+ | [setCancelCode](dw.order.Order.md#setcancelcodestring)([String](TopLevel.String.md)) | Sets the cancel code value. |
177
+ | [setCancelDescription](dw.order.Order.md#setcanceldescriptionstring)([String](TopLevel.String.md)) | Sets the description as to why the order was cancelled. |
178
+ | [setConfirmationStatus](dw.order.Order.md#setconfirmationstatusnumber)([Number](TopLevel.Number.md)) | Sets the confirmation status value.<br/> Possible values are [CONFIRMATION_STATUS_NOTCONFIRMED](dw.order.Order.md#confirmation_status_notconfirmed) or [CONFIRMATION_STATUS_CONFIRMED](dw.order.Order.md#confirmation_status_confirmed). |
179
+ | [setCustomer](dw.order.Order.md#setcustomercustomer)([Customer](dw.customer.Customer.md)) | This method is used to associate the order object with the specified customer object. |
180
+ | [setCustomerNo](dw.order.Order.md#setcustomernostring)([String](TopLevel.String.md)) | Sets the customer number associated with this order. |
181
+ | [setCustomerOrderReference](dw.order.Order.md#setcustomerorderreferencestring)([String](TopLevel.String.md)) | Sets the customer-specific reference information for the order. |
182
+ | [setExportAfter](dw.order.Order.md#setexportafterdate)([Date](TopLevel.Date.md)) | Sets the date after which an order can be exported. |
183
+ | [setExportStatus](dw.order.Order.md#setexportstatusnumber)([Number](TopLevel.Number.md)) | Sets the export status of the order.<br/> Possible values are: [EXPORT_STATUS_NOTEXPORTED](dw.order.Order.md#export_status_notexported), [EXPORT_STATUS_EXPORTED](dw.order.Order.md#export_status_exported), [EXPORT_STATUS_READY](dw.order.Order.md#export_status_ready), and [EXPORT_STATUS_FAILED](dw.order.Order.md#export_status_failed). |
184
+ | [setExternalOrderNo](dw.order.Order.md#setexternalordernostring)([String](TopLevel.String.md)) | Sets the value of an external order number associated with this order |
185
+ | [setExternalOrderStatus](dw.order.Order.md#setexternalorderstatusstring)([String](TopLevel.String.md)) | Sets the status of an external order associated with this order |
186
+ | [setExternalOrderText](dw.order.Order.md#setexternalordertextstring)([String](TopLevel.String.md)) | Sets the text describing the external order. |
187
+ | [setInvoiceNo](dw.order.Order.md#setinvoicenostring)([String](TopLevel.String.md)) | Sets the invoice number for this Order. |
188
+ | ~~[setOrderStatus](dw.order.Order.md#setorderstatusnumber)([Number](TopLevel.Number.md))~~ | Sets the order status. |
189
+ | [setPaymentStatus](dw.order.Order.md#setpaymentstatusnumber)([Number](TopLevel.Number.md)) | Sets the order payment status.<br/> Possible values are [PAYMENT_STATUS_NOTPAID](dw.order.Order.md#payment_status_notpaid), [PAYMENT_STATUS_PARTPAID](dw.order.Order.md#payment_status_partpaid) or [PAYMENT_STATUS_PAID](dw.order.Order.md#payment_status_paid). |
190
+ | [setReplaceCode](dw.order.Order.md#setreplacecodestring)([String](TopLevel.String.md)) | Sets the value of the replace code. |
191
+ | [setReplaceDescription](dw.order.Order.md#setreplacedescriptionstring)([String](TopLevel.String.md)) | Sets the value of the replace description. |
192
+ | [setShippingStatus](dw.order.Order.md#setshippingstatusnumber)([Number](TopLevel.Number.md)) | Sets the order shipping status value.<br/> Possible values are [SHIPPING_STATUS_NOTSHIPPED](dw.order.Order.md#shipping_status_notshipped), [SHIPPING_STATUS_PARTSHIPPED](dw.order.Order.md#shipping_status_partshipped) or [SHIPPING_STATUS_SHIPPED](dw.order.Order.md#shipping_status_shipped). |
193
+ | [setStatus](dw.order.Order.md#setstatusnumber)([Number](TopLevel.Number.md)) | Sets the status of the order. |
194
+ | [trackOrderChange](dw.order.Order.md#trackorderchangestring)([String](TopLevel.String.md)) | Tracks an order change. |
195
+
196
+ ### Methods inherited from class LineItemCtnr
197
+
198
+ [addNote](dw.order.LineItemCtnr.md#addnotestring-string), [createBillingAddress](dw.order.LineItemCtnr.md#createbillingaddress), [createBonusProductLineItem](dw.order.LineItemCtnr.md#createbonusproductlineitembonusdiscountlineitem-product-productoptionmodel-shipment), [createCouponLineItem](dw.order.LineItemCtnr.md#createcouponlineitemstring), [createCouponLineItem](dw.order.LineItemCtnr.md#createcouponlineitemstring-boolean), [createGiftCertificateLineItem](dw.order.LineItemCtnr.md#creategiftcertificatelineitemnumber-string), [createGiftCertificatePaymentInstrument](dw.order.LineItemCtnr.md#creategiftcertificatepaymentinstrumentstring-money), [createPaymentInstrument](dw.order.LineItemCtnr.md#createpaymentinstrumentstring-money), [createPaymentInstrumentFromWallet](dw.order.LineItemCtnr.md#createpaymentinstrumentfromwalletcustomerpaymentinstrument-money), [createPriceAdjustment](dw.order.LineItemCtnr.md#createpriceadjustmentstring), [createPriceAdjustment](dw.order.LineItemCtnr.md#createpriceadjustmentstring-discount), [createProductLineItem](dw.order.LineItemCtnr.md#createproductlineitemproduct-productoptionmodel-shipment), [createProductLineItem](dw.order.LineItemCtnr.md#createproductlineitemproductlistitem-shipment), [createProductLineItem](dw.order.LineItemCtnr.md#createproductlineitemstring-shipment), [createProductLineItem](dw.order.LineItemCtnr.md#createproductlineitemstring-quantity-shipment), [createShipment](dw.order.LineItemCtnr.md#createshipmentstring), [createShippingPriceAdjustment](dw.order.LineItemCtnr.md#createshippingpriceadjustmentstring), [getAdjustedMerchandizeTotalGrossPrice](dw.order.LineItemCtnr.md#getadjustedmerchandizetotalgrossprice), [getAdjustedMerchandizeTotalNetPrice](dw.order.LineItemCtnr.md#getadjustedmerchandizetotalnetprice), [getAdjustedMerchandizeTotalPrice](dw.order.LineItemCtnr.md#getadjustedmerchandizetotalprice), [getAdjustedMerchandizeTotalPrice](dw.order.LineItemCtnr.md#getadjustedmerchandizetotalpriceboolean), [getAdjustedMerchandizeTotalTax](dw.order.LineItemCtnr.md#getadjustedmerchandizetotaltax), [getAdjustedShippingTotalGrossPrice](dw.order.LineItemCtnr.md#getadjustedshippingtotalgrossprice), [getAdjustedShippingTotalNetPrice](dw.order.LineItemCtnr.md#getadjustedshippingtotalnetprice), [getAdjustedShippingTotalPrice](dw.order.LineItemCtnr.md#getadjustedshippingtotalprice), [getAdjustedShippingTotalTax](dw.order.LineItemCtnr.md#getadjustedshippingtotaltax), [getAllGiftCertificateLineItems](dw.order.LineItemCtnr.md#getallgiftcertificatelineitems), [getAllLineItems](dw.order.LineItemCtnr.md#getalllineitems), [getAllProductLineItems](dw.order.LineItemCtnr.md#getallproductlineitems), [getAllProductLineItems](dw.order.LineItemCtnr.md#getallproductlineitemsstring), [getAllProductQuantities](dw.order.LineItemCtnr.md#getallproductquantities), [getAllShippingPriceAdjustments](dw.order.LineItemCtnr.md#getallshippingpriceadjustments), [getBillingAddress](dw.order.LineItemCtnr.md#getbillingaddress), [getBonusDiscountLineItems](dw.order.LineItemCtnr.md#getbonusdiscountlineitems), [getBonusLineItems](dw.order.LineItemCtnr.md#getbonuslineitems), [getBusinessType](dw.order.LineItemCtnr.md#getbusinesstype), [getChannelType](dw.order.LineItemCtnr.md#getchanneltype), [getCouponLineItem](dw.order.LineItemCtnr.md#getcouponlineitemstring), [getCouponLineItems](dw.order.LineItemCtnr.md#getcouponlineitems), [getCurrencyCode](dw.order.LineItemCtnr.md#getcurrencycode), [getCustomer](dw.order.LineItemCtnr.md#getcustomer), [getCustomerEmail](dw.order.LineItemCtnr.md#getcustomeremail), [getCustomerName](dw.order.LineItemCtnr.md#getcustomername), [getCustomerNo](dw.order.LineItemCtnr.md#getcustomerno), [getDefaultShipment](dw.order.LineItemCtnr.md#getdefaultshipment), [getEtag](dw.order.LineItemCtnr.md#getetag), [getGiftCertificateLineItems](dw.order.LineItemCtnr.md#getgiftcertificatelineitems), [getGiftCertificateLineItems](dw.order.LineItemCtnr.md#getgiftcertificatelineitemsstring), [getGiftCertificatePaymentInstruments](dw.order.LineItemCtnr.md#getgiftcertificatepaymentinstruments), [getGiftCertificatePaymentInstruments](dw.order.LineItemCtnr.md#getgiftcertificatepaymentinstrumentsstring), [getGiftCertificateTotalGrossPrice](dw.order.LineItemCtnr.md#getgiftcertificatetotalgrossprice), [getGiftCertificateTotalNetPrice](dw.order.LineItemCtnr.md#getgiftcertificatetotalnetprice), [getGiftCertificateTotalPrice](dw.order.LineItemCtnr.md#getgiftcertificatetotalprice), [getGiftCertificateTotalTax](dw.order.LineItemCtnr.md#getgiftcertificatetotaltax), [getMerchandizeTotalGrossPrice](dw.order.LineItemCtnr.md#getmerchandizetotalgrossprice), [getMerchandizeTotalNetPrice](dw.order.LineItemCtnr.md#getmerchandizetotalnetprice), [getMerchandizeTotalPrice](dw.order.LineItemCtnr.md#getmerchandizetotalprice), [getMerchandizeTotalTax](dw.order.LineItemCtnr.md#getmerchandizetotaltax), [getNotes](dw.order.LineItemCtnr.md#getnotes), [getPaymentInstrument](dw.order.LineItemCtnr.md#getpaymentinstrument), [getPaymentInstruments](dw.order.LineItemCtnr.md#getpaymentinstruments), [getPaymentInstruments](dw.order.LineItemCtnr.md#getpaymentinstrumentsstring), [getPriceAdjustmentByPromotionID](dw.order.LineItemCtnr.md#getpriceadjustmentbypromotionidstring), [getPriceAdjustments](dw.order.LineItemCtnr.md#getpriceadjustments), [getProductLineItems](dw.order.LineItemCtnr.md#getproductlineitems), [getProductLineItems](dw.order.LineItemCtnr.md#getproductlineitemsstring), [getProductQuantities](dw.order.LineItemCtnr.md#getproductquantities), [getProductQuantities](dw.order.LineItemCtnr.md#getproductquantitiesboolean), [getProductQuantityTotal](dw.order.LineItemCtnr.md#getproductquantitytotal), [getShipment](dw.order.LineItemCtnr.md#getshipmentstring), [getShipments](dw.order.LineItemCtnr.md#getshipments), [getShippingPriceAdjustmentByPromotionID](dw.order.LineItemCtnr.md#getshippingpriceadjustmentbypromotionidstring), [getShippingPriceAdjustments](dw.order.LineItemCtnr.md#getshippingpriceadjustments), [getShippingTotalGrossPrice](dw.order.LineItemCtnr.md#getshippingtotalgrossprice), [getShippingTotalNetPrice](dw.order.LineItemCtnr.md#getshippingtotalnetprice), [getShippingTotalPrice](dw.order.LineItemCtnr.md#getshippingtotalprice), [getShippingTotalTax](dw.order.LineItemCtnr.md#getshippingtotaltax), [getTaxTotalsPerTaxRate](dw.order.LineItemCtnr.md#gettaxtotalspertaxrate), [getTotalGrossPrice](dw.order.LineItemCtnr.md#gettotalgrossprice), [getTotalNetPrice](dw.order.LineItemCtnr.md#gettotalnetprice), [getTotalTax](dw.order.LineItemCtnr.md#gettotaltax), [isExternallyTaxed](dw.order.LineItemCtnr.md#isexternallytaxed), [isTaxRoundedAtGroup](dw.order.LineItemCtnr.md#istaxroundedatgroup), [removeAllPaymentInstruments](dw.order.LineItemCtnr.md#removeallpaymentinstruments), [removeBonusDiscountLineItem](dw.order.LineItemCtnr.md#removebonusdiscountlineitembonusdiscountlineitem), [removeCouponLineItem](dw.order.LineItemCtnr.md#removecouponlineitemcouponlineitem), [removeGiftCertificateLineItem](dw.order.LineItemCtnr.md#removegiftcertificatelineitemgiftcertificatelineitem), [removeNote](dw.order.LineItemCtnr.md#removenotenote), [removePaymentInstrument](dw.order.LineItemCtnr.md#removepaymentinstrumentpaymentinstrument), [removePriceAdjustment](dw.order.LineItemCtnr.md#removepriceadjustmentpriceadjustment), [removeProductLineItem](dw.order.LineItemCtnr.md#removeproductlineitemproductlineitem), [removeShipment](dw.order.LineItemCtnr.md#removeshipmentshipment), [removeShippingPriceAdjustment](dw.order.LineItemCtnr.md#removeshippingpriceadjustmentpriceadjustment), [setCustomerEmail](dw.order.LineItemCtnr.md#setcustomeremailstring), [setCustomerName](dw.order.LineItemCtnr.md#setcustomernamestring), [updateOrderLevelPriceAdjustmentTax](dw.order.LineItemCtnr.md#updateorderlevelpriceadjustmenttax), [updateTotals](dw.order.LineItemCtnr.md#updatetotals), [verifyPriceAdjustmentLimits](dw.order.LineItemCtnr.md#verifypriceadjustmentlimits)
199
+ ### Methods inherited from class ExtensibleObject
200
+
201
+ [describe](dw.object.ExtensibleObject.md#describe), [getCustom](dw.object.ExtensibleObject.md#getcustom)
202
+ ### Methods inherited from class PersistentObject
203
+
204
+ [getCreationDate](dw.object.PersistentObject.md#getcreationdate), [getLastModified](dw.object.PersistentObject.md#getlastmodified), [getUUID](dw.object.PersistentObject.md#getuuid)
205
+ ### Methods inherited from class Object
206
+
207
+ [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)
208
+ ## Constant Details
209
+
210
+ ### CONFIRMATION_STATUS_CONFIRMED
211
+
212
+ - CONFIRMATION_STATUS_CONFIRMED: [Number](TopLevel.Number.md) = 2
213
+ - : constant for when Confirmation Status is Confirmed
214
+
215
+
216
+ ---
217
+
218
+ ### CONFIRMATION_STATUS_NOTCONFIRMED
219
+
220
+ - CONFIRMATION_STATUS_NOTCONFIRMED: [Number](TopLevel.Number.md) = 0
221
+ - : constant for when Confirmation Status is Not Confirmed
222
+
223
+
224
+ ---
225
+
226
+ ### ENCRYPTION_ALGORITHM_RSA_ECB_OAEPWITHSHA_256ANDMGF1PADDING
227
+
228
+ - ENCRYPTION_ALGORITHM_RSA_ECB_OAEPWITHSHA_256ANDMGF1PADDING: [String](TopLevel.String.md) = "RSA/ECB/OAEPWithSHA-256AndMGF1Padding"
229
+ - : The encryption algorithm "RSA/ECB/OAEPWithSHA-256AndMGF1Padding".
230
+
231
+
232
+ ---
233
+
234
+ ### ENCRYPTION_ALGORITHM_RSA_ECB_PKCS1PADDING
235
+
236
+ - ~~ENCRYPTION_ALGORITHM_RSA_ECB_PKCS1PADDING: [String](TopLevel.String.md) = "RSA/ECB/PKCS1Padding"~~
237
+ - : The outdated encryption algorithm "RSA/ECB/PKCS1Padding". Please do not use anymore!
238
+
239
+ **Deprecated:**
240
+ :::warning
241
+ Support for this algorithm will be removed in a future release. Please use
242
+ [ENCRYPTION_ALGORITHM_RSA_ECB_OAEPWITHSHA_256ANDMGF1PADDING](dw.order.Order.md#encryption_algorithm_rsa_ecb_oaepwithsha_256andmgf1padding) instead.
243
+
244
+ :::
245
+
246
+ ---
247
+
248
+ ### EXPORT_STATUS_EXPORTED
249
+
250
+ - EXPORT_STATUS_EXPORTED: [Number](TopLevel.Number.md) = 1
251
+ - : constant for when Export Status is Exported
252
+
253
+
254
+ ---
255
+
256
+ ### EXPORT_STATUS_FAILED
257
+
258
+ - EXPORT_STATUS_FAILED: [Number](TopLevel.Number.md) = 3
259
+ - : constant for when Export Status is Failed
260
+
261
+
262
+ ---
263
+
264
+ ### EXPORT_STATUS_NOTEXPORTED
265
+
266
+ - EXPORT_STATUS_NOTEXPORTED: [Number](TopLevel.Number.md) = 0
267
+ - : constant for when Export Status is Not Exported
268
+
269
+
270
+ ---
271
+
272
+ ### EXPORT_STATUS_READY
273
+
274
+ - EXPORT_STATUS_READY: [Number](TopLevel.Number.md) = 2
275
+ - : constant for when Export Status is ready to be exported.
276
+
277
+
278
+ ---
279
+
280
+ ### ORDER_STATUS_CANCELLED
281
+
282
+ - ORDER_STATUS_CANCELLED: [Number](TopLevel.Number.md) = 6
283
+ - : constant for when Order Status is Cancelled
284
+
285
+
286
+ ---
287
+
288
+ ### ORDER_STATUS_COMPLETED
289
+
290
+ - ORDER_STATUS_COMPLETED: [Number](TopLevel.Number.md) = 5
291
+ - : constant for when Order Status is Completed
292
+
293
+
294
+ ---
295
+
296
+ ### ORDER_STATUS_CREATED
297
+
298
+ - ORDER_STATUS_CREATED: [Number](TopLevel.Number.md) = 0
299
+ - : constant for when Order Status is Created
300
+
301
+
302
+ ---
303
+
304
+ ### ORDER_STATUS_FAILED
305
+
306
+ - ORDER_STATUS_FAILED: [Number](TopLevel.Number.md) = 8
307
+ - : constant for when Order Status is Failed
308
+
309
+
310
+ ---
311
+
312
+ ### ORDER_STATUS_NEW
313
+
314
+ - ORDER_STATUS_NEW: [Number](TopLevel.Number.md) = 3
315
+ - : constant for when Order Status is New
316
+
317
+
318
+ ---
319
+
320
+ ### ORDER_STATUS_OPEN
321
+
322
+ - ORDER_STATUS_OPEN: [Number](TopLevel.Number.md) = 4
323
+ - : constant for when Order Status is Open
324
+
325
+
326
+ ---
327
+
328
+ ### ORDER_STATUS_REPLACED
329
+
330
+ - ORDER_STATUS_REPLACED: [Number](TopLevel.Number.md) = 7
331
+ - : constant for when Order Status is Replaced
332
+
333
+
334
+ ---
335
+
336
+ ### PAYMENT_STATUS_NOTPAID
337
+
338
+ - PAYMENT_STATUS_NOTPAID: [Number](TopLevel.Number.md) = 0
339
+ - : constant for when Payment Status is Not Paid
340
+
341
+
342
+ ---
343
+
344
+ ### PAYMENT_STATUS_PAID
345
+
346
+ - PAYMENT_STATUS_PAID: [Number](TopLevel.Number.md) = 2
347
+ - : constant for when Payment Status is Paid
348
+
349
+
350
+ ---
351
+
352
+ ### PAYMENT_STATUS_PARTPAID
353
+
354
+ - PAYMENT_STATUS_PARTPAID: [Number](TopLevel.Number.md) = 1
355
+ - : constant for when Payment Status is Part Paid
356
+
357
+
358
+ ---
359
+
360
+ ### SHIPPING_STATUS_NOTSHIPPED
361
+
362
+ - SHIPPING_STATUS_NOTSHIPPED: [Number](TopLevel.Number.md) = 0
363
+ - : constant for when Shipping Status is Not shipped
364
+
365
+
366
+ ---
367
+
368
+ ### SHIPPING_STATUS_PARTSHIPPED
369
+
370
+ - SHIPPING_STATUS_PARTSHIPPED: [Number](TopLevel.Number.md) = 1
371
+ - : constant for when Shipping Status is Part Shipped
372
+
373
+
374
+ ---
375
+
376
+ ### SHIPPING_STATUS_SHIPPED
377
+
378
+ - SHIPPING_STATUS_SHIPPED: [Number](TopLevel.Number.md) = 2
379
+ - : constant for when Shipping Status is Shipped
380
+
381
+
382
+ ---
383
+
384
+ ## Property Details
385
+
386
+ ### affiliatePartnerID
387
+ - affiliatePartnerID: [String](TopLevel.String.md)
388
+ - : Returns the affiliate partner ID value, or null.
389
+
390
+
391
+ ---
392
+
393
+ ### affiliatePartnerName
394
+ - affiliatePartnerName: [String](TopLevel.String.md)
395
+ - : Returns the affiliate partner name value, or null.
396
+
397
+
398
+ ---
399
+
400
+ ### appeasementItems
401
+ - appeasementItems: [FilteringCollection](dw.util.FilteringCollection.md) `(read-only)`
402
+ - : Returns the collection of [AppeasementItem](dw.order.AppeasementItem.md)s associated with this order.
403
+
404
+
405
+ ---
406
+
407
+ ### appeasements
408
+ - appeasements: [FilteringCollection](dw.util.FilteringCollection.md) `(read-only)`
409
+ - : Returns the collection of [Appeasement](dw.order.Appeasement.md)s associated with this order.
410
+
411
+
412
+ ---
413
+
414
+ ### cancelCode
415
+ - cancelCode: [EnumValue](dw.value.EnumValue.md)
416
+ - : If this order was cancelled, returns the value of the
417
+ cancel code or null.
418
+
419
+
420
+
421
+ ---
422
+
423
+ ### cancelDescription
424
+ - cancelDescription: [String](TopLevel.String.md)
425
+ - : If this order was cancelled, returns the text describing why
426
+ the order was cancelled or null.
427
+
428
+
429
+
430
+ ---
431
+
432
+ ### capturedAmount
433
+ - capturedAmount: [Money](dw.value.Money.md) `(read-only)`
434
+ - : Returns the sum of the captured amounts. The captured amounts
435
+ are calculated on the fly. Associate a payment capture for an [PaymentInstrument](dw.order.PaymentInstrument.md) with an [Invoice](dw.order.Invoice.md)
436
+ using [Invoice.addCaptureTransaction(OrderPaymentInstrument, Money)](dw.order.Invoice.md#addcapturetransactionorderpaymentinstrument-money).
437
+
438
+
439
+
440
+ ---
441
+
442
+ ### confirmationStatus
443
+ - confirmationStatus: [EnumValue](dw.value.EnumValue.md)
444
+ - : Returns the confirmation status of the order.
445
+
446
+ Possible values are [CONFIRMATION_STATUS_NOTCONFIRMED](dw.order.Order.md#confirmation_status_notconfirmed) and
447
+ [CONFIRMATION_STATUS_CONFIRMED](dw.order.Order.md#confirmation_status_confirmed).
448
+
449
+
450
+
451
+ ---
452
+
453
+ ### createdBy
454
+ - createdBy: [String](TopLevel.String.md) `(read-only)`
455
+ - : Returns the name of the user who has created the order.
456
+ If an agent user has created the order, the agent user's name
457
+ is returned. Otherwise "Customer" is returned.
458
+
459
+
460
+
461
+ ---
462
+
463
+ ### currentOrder
464
+ - currentOrder: [Order](dw.order.Order.md) `(read-only)`
465
+ - : Returns the current order. The current order
466
+ represents the most recent order in a chain of orders.
467
+ For example, if Order1 was replaced by Order2, Order2 is the current
468
+ representation of the order and Order1 is the original representation
469
+ of the order. If you replace Order2 with Order3, Order 3 is now the
470
+ current order and Order1 is still the original representation of the
471
+ order. If this order has not been replaced, this method returns this
472
+ order because this order is the current order.
473
+
474
+
475
+ **See Also:**
476
+ - [getOriginalOrderNo()](dw.order.Order.md#getoriginalorderno)
477
+ - [getOriginalOrder()](dw.order.Order.md#getoriginalorder)
478
+ - [getReplacedOrderNo()](dw.order.Order.md#getreplacedorderno)
479
+ - [getReplacedOrder()](dw.order.Order.md#getreplacedorder)
480
+ - [getReplacementOrderNo()](dw.order.Order.md#getreplacementorderno)
481
+ - [getReplacementOrder()](dw.order.Order.md#getreplacementorder)
482
+
483
+
484
+ ---
485
+
486
+ ### currentOrderNo
487
+ - currentOrderNo: [String](TopLevel.String.md) `(read-only)`
488
+ - : Returns the order number of the current order. The current order
489
+ represents the most recent order in a chain of orders.
490
+ For example, if Order1 was replaced by Order2, Order2 is the current
491
+ representation of the order and Order1 is the original representation
492
+ of the order. If you replace Order2 with Order3, Order 3 is now the
493
+ current order and Order1 is still the original representation of the
494
+ order. If this order has not been replaced, calling this method returns the
495
+ same value as the [getOrderNo()](dw.order.Order.md#getorderno) method because this order is the
496
+ current order.
497
+
498
+
499
+ **See Also:**
500
+ - [getOriginalOrderNo()](dw.order.Order.md#getoriginalorderno)
501
+ - [getOriginalOrder()](dw.order.Order.md#getoriginalorder)
502
+ - [getReplacedOrderNo()](dw.order.Order.md#getreplacedorderno)
503
+ - [getReplacedOrder()](dw.order.Order.md#getreplacedorder)
504
+ - [getReplacementOrderNo()](dw.order.Order.md#getreplacementorderno)
505
+ - [getReplacementOrder()](dw.order.Order.md#getreplacementorder)
506
+
507
+
508
+ ---
509
+
510
+ ### customerLocaleID
511
+ - customerLocaleID: [String](TopLevel.String.md) `(read-only)`
512
+ - : Returns the ID of the locale that was in effect when the order
513
+ was placed. This is the customer's locale.
514
+
515
+
516
+
517
+ ---
518
+
519
+ ### customerOrderReference
520
+ - customerOrderReference: [String](TopLevel.String.md)
521
+ - : Returns the customer-specific reference information for the order, or null.
522
+
523
+
524
+ ---
525
+
526
+ ### exportAfter
527
+ - exportAfter: [Date](TopLevel.Date.md)
528
+ - : Returns a date after which an order can be exported.
529
+
530
+
531
+ ---
532
+
533
+ ### exportStatus
534
+ - exportStatus: [EnumValue](dw.value.EnumValue.md)
535
+ - : Returns the export status of the order.
536
+
537
+ Possible values are: [EXPORT_STATUS_NOTEXPORTED](dw.order.Order.md#export_status_notexported),
538
+ [EXPORT_STATUS_EXPORTED](dw.order.Order.md#export_status_exported), [EXPORT_STATUS_READY](dw.order.Order.md#export_status_ready),
539
+ and [EXPORT_STATUS_FAILED](dw.order.Order.md#export_status_failed).
540
+
541
+
542
+
543
+ ---
544
+
545
+ ### externalOrderNo
546
+ - externalOrderNo: [String](TopLevel.String.md)
547
+ - : Returns the value of an external order number associated
548
+ with this order, or null.
549
+
550
+
551
+
552
+ ---
553
+
554
+ ### externalOrderStatus
555
+ - externalOrderStatus: [String](TopLevel.String.md)
556
+ - : Returns the status of an external order associated
557
+ with this order, or null.
558
+
559
+
560
+
561
+ ---
562
+
563
+ ### externalOrderText
564
+ - externalOrderText: [String](TopLevel.String.md)
565
+ - : Returns the text describing the external order, or null.
566
+
567
+
568
+ ---
569
+
570
+ ### globalPartyID
571
+ - globalPartyID: [String](TopLevel.String.md) `(read-only)`
572
+ - : The Global Party ID reconciles customer identity across multiple systems. For example, as part of the Service for
573
+ Commerce experience, service agents can find information for customers who have never called into the call
574
+ center, but have created a profile on the website. Service agents can find guest order data from B2C Commerce and
575
+ easily create accounts for customers. Customer 360 Data Manager matches records from multiple data sources to
576
+ determine all the records associated with a specific customer.
577
+
578
+
579
+
580
+ ---
581
+
582
+ ### imported
583
+ - imported: [Boolean](TopLevel.Boolean.md) `(read-only)`
584
+ - : Returns `true`, if the order is imported and `false`
585
+ otherwise.
586
+
587
+
588
+
589
+ ---
590
+
591
+ ### invoiceItems
592
+ - invoiceItems: [FilteringCollection](dw.util.FilteringCollection.md) `(read-only)`
593
+ - : Returns the collection of [InvoiceItem](dw.order.InvoiceItem.md)s associated with this order.
594
+
595
+
596
+ Order post-processing APIs (gillian) are now inactive by default and will throw
597
+ an exception if accessed. Activation needs preliminary approval by Product Management.
598
+ Please contact support in this case. Existing customers using these APIs are not
599
+ affected by this change and can use the APIs until further notice.
600
+
601
+
602
+
603
+ ---
604
+
605
+ ### invoiceNo
606
+ - invoiceNo: [String](TopLevel.String.md)
607
+ - : Returns the invoice number for this Order.
608
+
609
+
610
+ When an order is placed (e.g. with [OrderMgr.placeOrder(Order)](dw.order.OrderMgr.md#placeorderorder)) invoice number will be filled
611
+ using a sequence. Before order was placed `null` will be returned unless it was set with
612
+ [setInvoiceNo(String)](dw.order.Order.md#setinvoicenostring).
613
+
614
+
615
+
616
+ ---
617
+
618
+ ### invoices
619
+ - invoices: [FilteringCollection](dw.util.FilteringCollection.md) `(read-only)`
620
+ - : Returns the collection of [Invoice](dw.order.Invoice.md)s associated with this order.
621
+
622
+
623
+ Order post-processing APIs (gillian) are now inactive by default and will throw
624
+ an exception if accessed. Activation needs preliminary approval by Product Management.
625
+ Please contact support in this case. Existing customers using these APIs are not
626
+ affected by this change and can use the APIs until further notice.
627
+
628
+
629
+
630
+ ---
631
+
632
+ ### orderExportXML
633
+ - orderExportXML: [String](TopLevel.String.md) `(read-only)`
634
+ - : Returns the order export XML as String object.
635
+
636
+
637
+ NOTE: This method will return payment instrument data masked. If payment instrument re-encryption is needed
638
+ please use [getOrderExportXML(String, String)](dw.order.Order.md#getorderexportxmlstring-string---variant-2) instead.
639
+
640
+
641
+ Example:
642
+
643
+
644
+ ```
645
+ var orderXMLAsString : String = order.getOrderExportXML();
646
+ var orderXML : XML = new XML(orderXMLAsString);
647
+ ```
648
+
649
+
650
+
651
+ ---
652
+
653
+ ### orderNo
654
+ - orderNo: [String](TopLevel.String.md) `(read-only)`
655
+ - : Returns the order number for this order.
656
+
657
+
658
+ ---
659
+
660
+ ### orderToken
661
+ - orderToken: [String](TopLevel.String.md) `(read-only)`
662
+ - : Returns the token for this order. The order token is a string (length 32 bytes) associated
663
+ with this one order. The order token is random. It reduces the capability of malicious
664
+ users to access an order through guessing. Order token can be used to **further** validate order
665
+ ownership, but should never be used to solely validate ownership. In addition, the storefront
666
+ should ensure authentication and authorization. See the [Security Best Practices for Developers](https://help.salesforce.com/s/articleView?id=cc.b2c\_developer\_authentication\_and\_authorization.htm) for details.
667
+
668
+
669
+
670
+ ---
671
+
672
+ ### originalOrder
673
+ - originalOrder: [Order](dw.order.Order.md) `(read-only)`
674
+ - : Returns the original order associated with
675
+ this order. The original order represents an order that was the
676
+ first ancestor in a chain of orders.
677
+ For example, if Order1 was replaced by Order2, Order2 is the current
678
+ representation of the order and Order1 is the original representation
679
+ of the order. If you replace Order2 with Order3, Order1 is still the
680
+ original representation of the order. If this order is the first
681
+ ancestor, this method returns this order.
682
+
683
+
684
+ **See Also:**
685
+ - [getCurrentOrderNo()](dw.order.Order.md#getcurrentorderno)
686
+ - [getCurrentOrder()](dw.order.Order.md#getcurrentorder)
687
+ - [getReplacedOrderNo()](dw.order.Order.md#getreplacedorderno)
688
+ - [getReplacedOrder()](dw.order.Order.md#getreplacedorder)
689
+ - [getReplacementOrderNo()](dw.order.Order.md#getreplacementorderno)
690
+ - [getReplacementOrder()](dw.order.Order.md#getreplacementorder)
691
+
692
+
693
+ ---
694
+
695
+ ### originalOrderNo
696
+ - originalOrderNo: [String](TopLevel.String.md) `(read-only)`
697
+ - : Returns the order number of the original order associated with
698
+ this order. The original order represents an order that was the
699
+ first ancestor in a chain of orders.
700
+ For example, if Order1 was replaced by Order2, Order2 is the current
701
+ representation of the order and Order1 is the original representation
702
+ of the order. If you replace Order2 with Order3, Order1 is still the
703
+ original representation of the order. If this order is the first
704
+ ancestor, this method returns the value of getOrderNo().
705
+
706
+
707
+ **See Also:**
708
+ - [getCurrentOrderNo()](dw.order.Order.md#getcurrentorderno)
709
+ - [getCurrentOrder()](dw.order.Order.md#getcurrentorder)
710
+ - [getReplacedOrderNo()](dw.order.Order.md#getreplacedorderno)
711
+ - [getReplacedOrder()](dw.order.Order.md#getreplacedorder)
712
+ - [getReplacementOrderNo()](dw.order.Order.md#getreplacementorderno)
713
+ - [getReplacementOrder()](dw.order.Order.md#getreplacementorder)
714
+
715
+
716
+ ---
717
+
718
+ ### paymentStatus
719
+ - paymentStatus: [EnumValue](dw.value.EnumValue.md)
720
+ - : Returns the order payment status value.
721
+
722
+ Possible values are [PAYMENT_STATUS_NOTPAID](dw.order.Order.md#payment_status_notpaid), [PAYMENT_STATUS_PARTPAID](dw.order.Order.md#payment_status_partpaid)
723
+ or [PAYMENT_STATUS_PAID](dw.order.Order.md#payment_status_paid).
724
+
725
+
726
+
727
+ ---
728
+
729
+ ### paymentTransaction
730
+ - ~~paymentTransaction: [PaymentTransaction](dw.order.PaymentTransaction.md)~~ `(read-only)`
731
+ - : Returns the payment transaction associated with this order.
732
+ It is possible that there are multiple payment transactions
733
+ associated with the order. In this case, this method returns
734
+ the transaction associated with the first PaymentInstrument
735
+ returned by `getPaymentInstruments()`.
736
+
737
+
738
+ **Deprecated:**
739
+ :::warning
740
+ Use [LineItemCtnr.getPaymentInstruments()](dw.order.LineItemCtnr.md#getpaymentinstruments)
741
+ to get the list of PaymentInstrument instances and then use
742
+ getPaymentTransaction() method on each PaymentInstrument to access
743
+ the individual transactions.
744
+
745
+ :::
746
+
747
+ ---
748
+
749
+ ### refundedAmount
750
+ - refundedAmount: [Money](dw.value.Money.md) `(read-only)`
751
+ - : Returns the sum of the refunded amounts. The refunded amounts are
752
+ calculated on the fly. Associate a payment refund for an [PaymentInstrument](dw.order.PaymentInstrument.md) with an [Invoice](dw.order.Invoice.md)
753
+ using [Invoice.addRefundTransaction(OrderPaymentInstrument, Money)](dw.order.Invoice.md#addrefundtransactionorderpaymentinstrument-money).
754
+
755
+
756
+
757
+ ---
758
+
759
+ ### remoteHost
760
+ - remoteHost: [String](TopLevel.String.md) `(read-only)`
761
+ - : Returns the IP address of the remote host from which the order was created.
762
+
763
+
764
+ If the IP address was not captured for the order because order IP logging
765
+ was disabled at the time the order was created, null will be returned.
766
+
767
+
768
+
769
+ ---
770
+
771
+ ### replaceCode
772
+ - replaceCode: [EnumValue](dw.value.EnumValue.md)
773
+ - : If this order was replaced by another order,
774
+ returns the value of the replace code. Otherwise.
775
+ returns null.
776
+
777
+
778
+
779
+ ---
780
+
781
+ ### replaceDescription
782
+ - replaceDescription: [String](TopLevel.String.md)
783
+ - : If this order was replaced by another order,
784
+ returns the value of the replace description. Otherwise
785
+ returns null.
786
+
787
+
788
+
789
+ ---
790
+
791
+ ### replacedOrder
792
+ - replacedOrder: [Order](dw.order.Order.md) `(read-only)`
793
+ - : Returns the order that this order replaced or null. For example, if you
794
+ have three orders where Order1 was replaced by Order2 and Order2 was
795
+ replaced by Order3, calling this method on Order3 will return Order2.
796
+ Similarly, calling this method on Order1 will return null as Order1 was
797
+ the original order.
798
+
799
+
800
+ **See Also:**
801
+ - [getCurrentOrderNo()](dw.order.Order.md#getcurrentorderno)
802
+ - [getCurrentOrder()](dw.order.Order.md#getcurrentorder)
803
+ - [getOriginalOrderNo()](dw.order.Order.md#getoriginalorderno)
804
+ - [getOriginalOrder()](dw.order.Order.md#getoriginalorder)
805
+ - [getReplacementOrderNo()](dw.order.Order.md#getreplacementorderno)
806
+ - [getReplacementOrder()](dw.order.Order.md#getreplacementorder)
807
+
808
+
809
+ ---
810
+
811
+ ### replacedOrderNo
812
+ - replacedOrderNo: [String](TopLevel.String.md) `(read-only)`
813
+ - : Returns the order number that this order replaced or null if this order
814
+ did not replace an order. For example, if you have three orders
815
+ where Order1 was replaced by Order2 and Order2 was replaced by Order3,
816
+ calling this method on Order3 will return the order number for
817
+ Order2. Similarly, calling this method on Order1 will return null as
818
+ Order1 was the original order.
819
+
820
+
821
+ **See Also:**
822
+ - [getCurrentOrderNo()](dw.order.Order.md#getcurrentorderno)
823
+ - [getCurrentOrder()](dw.order.Order.md#getcurrentorder)
824
+ - [getOriginalOrderNo()](dw.order.Order.md#getoriginalorderno)
825
+ - [getOriginalOrder()](dw.order.Order.md#getoriginalorder)
826
+ - [getReplacementOrderNo()](dw.order.Order.md#getreplacementorderno)
827
+ - [getReplacementOrder()](dw.order.Order.md#getreplacementorder)
828
+
829
+
830
+ ---
831
+
832
+ ### replacementOrder
833
+ - replacementOrder: [Order](dw.order.Order.md) `(read-only)`
834
+ - : Returns the order that replaced this order, or null.
835
+
836
+ **See Also:**
837
+ - [getCurrentOrderNo()](dw.order.Order.md#getcurrentorderno)
838
+ - [getCurrentOrder()](dw.order.Order.md#getcurrentorder)
839
+ - [getOriginalOrderNo()](dw.order.Order.md#getoriginalorderno)
840
+ - [getOriginalOrder()](dw.order.Order.md#getoriginalorder)
841
+ - [getReplacedOrderNo()](dw.order.Order.md#getreplacedorderno)
842
+ - [getReplacedOrder()](dw.order.Order.md#getreplacedorder)
843
+
844
+
845
+ ---
846
+
847
+ ### replacementOrderNo
848
+ - replacementOrderNo: [String](TopLevel.String.md) `(read-only)`
849
+ - : If this order was replaced by another order,
850
+ returns the order number that replaced this order. Otherwise
851
+ returns null.
852
+
853
+
854
+ **See Also:**
855
+ - [getCurrentOrderNo()](dw.order.Order.md#getcurrentorderno)
856
+ - [getCurrentOrder()](dw.order.Order.md#getcurrentorder)
857
+ - [getOriginalOrderNo()](dw.order.Order.md#getoriginalorderno)
858
+ - [getOriginalOrder()](dw.order.Order.md#getoriginalorder)
859
+ - [getReplacedOrderNo()](dw.order.Order.md#getreplacedorderno)
860
+ - [getReplacedOrder()](dw.order.Order.md#getreplacedorder)
861
+
862
+
863
+ ---
864
+
865
+ ### returnCaseItems
866
+ - returnCaseItems: [FilteringCollection](dw.util.FilteringCollection.md) `(read-only)`
867
+ - : Returns the collection of [ReturnCaseItem](dw.order.ReturnCaseItem.md)s associated with this order.
868
+
869
+
870
+ Order post-processing APIs (gillian) are now inactive by default and will throw
871
+ an exception if accessed. Activation needs preliminary approval by Product Management.
872
+ Please contact support in this case. Existing customers using these APIs are not
873
+ affected by this change and can use the APIs until further notice.
874
+
875
+
876
+
877
+ ---
878
+
879
+ ### returnCases
880
+ - returnCases: [FilteringCollection](dw.util.FilteringCollection.md) `(read-only)`
881
+ - : Returns the collection of [ReturnCase](dw.order.ReturnCase.md)s associated with this order.
882
+
883
+
884
+ Order post-processing APIs (gillian) are now inactive by default and will throw
885
+ an exception if accessed. Activation needs preliminary approval by Product Management.
886
+ Please contact support in this case. Existing customers using these APIs are not
887
+ affected by this change and can use the APIs until further notice.
888
+
889
+
890
+
891
+ ---
892
+
893
+ ### returnItems
894
+ - returnItems: [FilteringCollection](dw.util.FilteringCollection.md) `(read-only)`
895
+ - : Returns the collection of [ReturnItem](dw.order.ReturnItem.md)s associated with this order.
896
+
897
+
898
+ Order post-processing APIs (gillian) are now inactive by default and will throw
899
+ an exception if accessed. Activation needs preliminary approval by Product Management.
900
+ Please contact support in this case. Existing customers using these APIs are not
901
+ affected by this change and can use the APIs until further notice.
902
+
903
+
904
+
905
+ ---
906
+
907
+ ### returns
908
+ - returns: [FilteringCollection](dw.util.FilteringCollection.md) `(read-only)`
909
+ - : Returns the collection of [Return](dw.order.Return.md)s associated with this order.
910
+
911
+
912
+ Order post-processing APIs (gillian) are now inactive by default and will throw
913
+ an exception if accessed. Activation needs preliminary approval by Product Management.
914
+ Please contact support in this case. Existing customers using these APIs are not
915
+ affected by this change and can use the APIs until further notice.
916
+
917
+
918
+
919
+ ---
920
+
921
+ ### shippingOrderItems
922
+ - shippingOrderItems: [FilteringCollection](dw.util.FilteringCollection.md) `(read-only)`
923
+ - : Returns the collection of [ShippingOrderItem](dw.order.ShippingOrderItem.md)s associated with this order.
924
+
925
+
926
+ Order post-processing APIs (gillian) are now inactive by default and will throw
927
+ an exception if accessed. Activation needs preliminary approval by Product Management.
928
+ Please contact support in this case. Existing customers using these APIs are not
929
+ affected by this change and can use the APIs until further notice.
930
+
931
+
932
+
933
+ ---
934
+
935
+ ### shippingOrders
936
+ - shippingOrders: [FilteringCollection](dw.util.FilteringCollection.md) `(read-only)`
937
+ - : Returns the collection of [ShippingOrder](dw.order.ShippingOrder.md)s associated with this order.
938
+
939
+
940
+ Order post-processing APIs (gillian) are now inactive by default and will throw
941
+ an exception if accessed. Activation needs preliminary approval by Product Management.
942
+ Please contact support in this case. Existing customers using these APIs are not
943
+ affected by this change and can use the APIs until further notice.
944
+
945
+
946
+
947
+ ---
948
+
949
+ ### shippingStatus
950
+ - shippingStatus: [EnumValue](dw.value.EnumValue.md)
951
+ - : Returns the order shipping status.
952
+
953
+ Possible values are [SHIPPING_STATUS_NOTSHIPPED](dw.order.Order.md#shipping_status_notshipped),
954
+ [SHIPPING_STATUS_PARTSHIPPED](dw.order.Order.md#shipping_status_partshipped) or [SHIPPING_STATUS_SHIPPED](dw.order.Order.md#shipping_status_shipped).
955
+
956
+
957
+
958
+ ---
959
+
960
+ ### sourceCode
961
+ - sourceCode: [String](TopLevel.String.md) `(read-only)`
962
+ - : Returns the source code stored with the order or `null` if no source code is attached to the order.
963
+
964
+
965
+ ---
966
+
967
+ ### sourceCodeGroup
968
+ - sourceCodeGroup: [SourceCodeGroup](dw.campaign.SourceCodeGroup.md) `(read-only)`
969
+ - : Returns the source code group attached to the order or `null` if no source code group is attached to
970
+ the order.
971
+
972
+
973
+
974
+ ---
975
+
976
+ ### sourceCodeGroupID
977
+ - sourceCodeGroupID: [String](TopLevel.String.md) `(read-only)`
978
+ - : Returns the source code group id stored with the order or `null` if no source code group is attached
979
+ to the order.
980
+
981
+
982
+
983
+ ---
984
+
985
+ ### status
986
+ - status: [EnumValue](dw.value.EnumValue.md)
987
+ - : Returns the status of the order.
988
+
989
+ Possible values are:
990
+
991
+ - [ORDER_STATUS_CREATED](dw.order.Order.md#order_status_created)
992
+ - [ORDER_STATUS_NEW](dw.order.Order.md#order_status_new)
993
+ - [ORDER_STATUS_OPEN](dw.order.Order.md#order_status_open)
994
+ - [ORDER_STATUS_COMPLETED](dw.order.Order.md#order_status_completed)
995
+ - [ORDER_STATUS_CANCELLED](dw.order.Order.md#order_status_cancelled)
996
+ - [ORDER_STATUS_FAILED](dw.order.Order.md#order_status_failed)
997
+ - [ORDER_STATUS_REPLACED](dw.order.Order.md#order_status_replaced)
998
+
999
+
1000
+
1001
+ The order status usually changes when a process action is initiated. Most status changes have an action which
1002
+ needs to executed in order to end having the order in a specific order status. When an order is created with e.g.
1003
+ [OrderMgr.createOrder(Basket)](dw.order.OrderMgr.md#createorderbasket) the order status will be [ORDER_STATUS_CREATED](dw.order.Order.md#order_status_created). The usual
1004
+ flow is that payment authorization will be added to the order. Once the order is considered as valid (payed,
1005
+ fraud checked, ...) the order gets placed. This can be done by calling
1006
+ [OrderMgr.placeOrder(Order)](dw.order.OrderMgr.md#placeorderorder). The result of placing an order will be status
1007
+ [ORDER_STATUS_OPEN](dw.order.Order.md#order_status_open) (from a process standpoint [ORDER_STATUS_NEW](dw.order.Order.md#order_status_new) which has the same meaning).
1008
+ Status [ORDER_STATUS_REPLACED](dw.order.Order.md#order_status_replaced) is related to functionality
1009
+ [BasketMgr.createBasketFromOrder(Order)](dw.order.BasketMgr.md#createbasketfromorderorder). [ORDER_STATUS_COMPLETED](dw.order.Order.md#order_status_completed) has no meaning by
1010
+ default but can be used by custom implementations but is a synonym for NEW/OPEN. Below you will find the most important status changes:
1011
+
1012
+
1013
+
1014
+ | Status before | Action | Status after | Business meaning |
1015
+ | --- |--- |--- |--- |
1016
+ | - | [OrderMgr.createOrder(Basket)](dw.order.OrderMgr.md#createorderbasket) | CREATED | Order was created from a basket. |
1017
+ | CREATED | [OrderMgr.placeOrder(Order)](dw.order.OrderMgr.md#placeorderorder) | OPEN/NEW | Order was considered as valid. Order can now be exported to 3rd party systems. |
1018
+ | CREATED | [OrderMgr.failOrder(Order)](dw.order.OrderMgr.md#failorderorder) | FAILED | Order was considered not valid. E.g. payment authorization was wrong or fraud check was not successful. |
1019
+ | OPEN/NEW | [OrderMgr.cancelOrder(Order)](dw.order.OrderMgr.md#cancelorderorder) | CANCELLED | Order was cancelled. |
1020
+ | CANCELLED | [OrderMgr.undoCancelOrder(Order)](dw.order.OrderMgr.md#undocancelorderorder) | OPEN/NEW | Order was cancelled by mistake and this needs to be undone. |
1021
+ | FAILED | [OrderMgr.undoFailOrder(Order)](dw.order.OrderMgr.md#undofailorderorder) | CREATED | Order was failed by mistake and this needs to be undone. |
1022
+
1023
+
1024
+ Every status change will trigger a change in the order journal which is the base for GMV calculations.
1025
+
1026
+
1027
+ **See Also:**
1028
+ - [LineItemCtnr](dw.order.LineItemCtnr.md)
1029
+
1030
+
1031
+ ---
1032
+
1033
+ ### taxRoundedAtGroup
1034
+ - taxRoundedAtGroup: [Boolean](TopLevel.Boolean.md) `(read-only)`
1035
+ - : Use this method to check if the Order was created with grouped taxation calculation.
1036
+
1037
+
1038
+ If the tax is rounded on group level, the tax is applied to the summed-up tax basis for each tax rate.
1039
+
1040
+
1041
+
1042
+ ---
1043
+
1044
+ ## Method Details
1045
+
1046
+ ### createAppeasement()
1047
+ - createAppeasement(): [Appeasement](dw.order.Appeasement.md)
1048
+ - : Creates a new [Appeasement](dw.order.Appeasement.md) associated with this order.
1049
+
1050
+ The new Appeasement
1051
+ will have an appeasementNumber based on the [getOrderNo()](dw.order.Order.md#getorderno).
1052
+
1053
+
1054
+ Order post-processing APIs (gillian) are now inactive by default and will throw
1055
+ an exception if accessed. Activation needs preliminary approval by Product Management.
1056
+ Please contact support in this case. Existing customers using these APIs are not
1057
+ affected by this change and can use the APIs until further notice.
1058
+
1059
+
1060
+ **Returns:**
1061
+ - the created appeasement
1062
+
1063
+
1064
+ ---
1065
+
1066
+ ### createAppeasement(String)
1067
+ - createAppeasement(appeasementNumber: [String](TopLevel.String.md)): [Appeasement](dw.order.Appeasement.md)
1068
+ - : Creates a new [Appeasement](dw.order.Appeasement.md) associated with this order.
1069
+
1070
+
1071
+ An appeasementNumber must be specified.
1072
+
1073
+
1074
+ If an Appeasement already exists for the appeasementNumber, the method fails with an
1075
+ exception.
1076
+
1077
+
1078
+ Order post-processing APIs (gillian) are now inactive by default and will throw
1079
+ an exception if accessed. Activation needs preliminary approval by Product Management.
1080
+ Please contact support in this case. Existing customers using these APIs are not
1081
+ affected by this change and can use the APIs until further notice.
1082
+
1083
+
1084
+ **Parameters:**
1085
+ - appeasementNumber - the appeasementNumber to be assigned to the newly created appeasement
1086
+
1087
+ **Returns:**
1088
+ - the created appeasement
1089
+
1090
+ **Throws:**
1091
+ - IllegalArgumentException - if an Appeasement already exists with the number.
1092
+
1093
+
1094
+ ---
1095
+
1096
+ ### createReturnCase(Boolean)
1097
+ - createReturnCase(isRMA: [Boolean](TopLevel.Boolean.md)): [ReturnCase](dw.order.ReturnCase.md)
1098
+ - : Creates a new [ReturnCase](dw.order.ReturnCase.md) associated with this order
1099
+ specifying whether the ReturnCase is an RMA (return merchandise authorization).
1100
+
1101
+
1102
+ The new ReturnCase
1103
+ will have a returnCaseNumber based on the [getOrderNo()](dw.order.Order.md#getorderno), e.g. for an order-no 1234 the
1104
+ return cases will have the numbers 1234\#RC1, 1234\#RC2, 1234\#RC3...
1105
+
1106
+
1107
+ Order post-processing APIs (gillian) are now inactive by default and will throw
1108
+ an exception if accessed. Activation needs preliminary approval by Product Management.
1109
+ Please contact support in this case. Existing customers using these APIs are not
1110
+ affected by this change and can use the APIs until further notice.
1111
+
1112
+
1113
+ **Parameters:**
1114
+ - isRMA - whether the new ReturnCase is an RMA (return merchandise authorization)
1115
+
1116
+ **Returns:**
1117
+ - the created ReturnCase
1118
+
1119
+
1120
+ ---
1121
+
1122
+ ### createReturnCase(String, Boolean)
1123
+ - createReturnCase(returnCaseNumber: [String](TopLevel.String.md), isRMA: [Boolean](TopLevel.Boolean.md)): [ReturnCase](dw.order.ReturnCase.md)
1124
+ - : Creates a new [ReturnCase](dw.order.ReturnCase.md) associated with this order
1125
+ specifying whether the ReturnCase is an RMA (return merchandise authorization).
1126
+
1127
+
1128
+ A returnCaseNumber must be specified.
1129
+
1130
+
1131
+ If a ReturnCase already exists for the returnCaseNumber, the method fails with an
1132
+ exception.
1133
+
1134
+
1135
+ Order post-processing APIs (gillian) are now inactive by default and will throw
1136
+ an exception if accessed. Activation needs preliminary approval by Product Management.
1137
+ Please contact support in this case. Existing customers using these APIs are not
1138
+ affected by this change and can use the APIs until further notice.
1139
+
1140
+
1141
+ **Parameters:**
1142
+ - returnCaseNumber - returnCaseNumber to use
1143
+ - isRMA - whether the new ReturnCase is an RMA (return merchandise authorization)
1144
+
1145
+ **Returns:**
1146
+ - null or the ReturnCase associated with the given returnCaseNumber
1147
+
1148
+ **Throws:**
1149
+ - IllegalArgumentException - if a ReturnCase already exists with the number.
1150
+
1151
+
1152
+ ---
1153
+
1154
+ ### createServiceItem(String, String)
1155
+ - createServiceItem(ID: [String](TopLevel.String.md), status: [String](TopLevel.String.md)): [OrderItem](dw.order.OrderItem.md)
1156
+ - : Returns the [order item](dw.order.OrderItem.md) with the given status which wraps a new
1157
+ [service item](dw.order.ShippingLineItem.md) which is created and added to the order.
1158
+
1159
+
1160
+ **Parameters:**
1161
+ - ID - the ID of the new service item. This ID will be returned when [ShippingLineItem.getID()](dw.order.ShippingLineItem.md#getid) is called.
1162
+ - status - the status of the order item, use one of <li>[OrderItem.STATUS_NEW](dw.order.OrderItem.md#status_new)</li> <li>[OrderItem.STATUS_OPEN](dw.order.OrderItem.md#status_open)</li> <li>[OrderItem.STATUS_SHIPPED](dw.order.OrderItem.md#status_shipped)</li> </ul> Order post-processing APIs (gillian) are now inactive by default and will throw an exception if accessed. Activation needs preliminary approval by Product Management. Please contact support in this case. Existing customers using these APIs are not affected by this change and can use the APIs until further notice.
1163
+
1164
+ **Returns:**
1165
+ - the created order item
1166
+
1167
+
1168
+ ---
1169
+
1170
+ ### createShippingOrder()
1171
+ - createShippingOrder(): [ShippingOrder](dw.order.ShippingOrder.md)
1172
+ - : Creates a new [ShippingOrder](dw.order.ShippingOrder.md) for this order.
1173
+
1174
+
1175
+ Generates a default shipping order number. Use
1176
+ [createShippingOrder(String)](dw.order.Order.md#createshippingorderstring) for a defined shipping order number.
1177
+
1178
+
1179
+ Order post-processing APIs (gillian) are now inactive by default and will throw
1180
+ an exception if accessed. Activation needs preliminary approval by Product Management.
1181
+ Please contact support in this case. Existing customers using these APIs are not
1182
+ affected by this change and can use the APIs until further notice.
1183
+
1184
+
1185
+ **Returns:**
1186
+ - the created shipping order
1187
+
1188
+ **See Also:**
1189
+ - [ShippingOrder](dw.order.ShippingOrder.md)
1190
+
1191
+
1192
+ ---
1193
+
1194
+ ### createShippingOrder(String)
1195
+ - createShippingOrder(shippingOrderNumber: [String](TopLevel.String.md)): [ShippingOrder](dw.order.ShippingOrder.md)
1196
+ - : Creates a new [ShippingOrder](dw.order.ShippingOrder.md) for this order.
1197
+
1198
+
1199
+ Order post-processing APIs (gillian) are now inactive by default and will throw
1200
+ an exception if accessed. Activation needs preliminary approval by Product Management.
1201
+ Please contact support in this case. Existing customers using these APIs are not
1202
+ affected by this change and can use the APIs until further notice.
1203
+
1204
+
1205
+ **Parameters:**
1206
+ - shippingOrderNumber - the document number to be used
1207
+
1208
+ **Returns:**
1209
+ - the created shipping order
1210
+
1211
+ **See Also:**
1212
+ - [ShippingOrder](dw.order.ShippingOrder.md)
1213
+
1214
+
1215
+ ---
1216
+
1217
+ ### getAffiliatePartnerID()
1218
+ - getAffiliatePartnerID(): [String](TopLevel.String.md)
1219
+ - : Returns the affiliate partner ID value, or null.
1220
+
1221
+ **Returns:**
1222
+ - the affiliate partner ID value, or null.
1223
+
1224
+
1225
+ ---
1226
+
1227
+ ### getAffiliatePartnerName()
1228
+ - getAffiliatePartnerName(): [String](TopLevel.String.md)
1229
+ - : Returns the affiliate partner name value, or null.
1230
+
1231
+ **Returns:**
1232
+ - the affiliate partner name value, or null.
1233
+
1234
+
1235
+ ---
1236
+
1237
+ ### getAppeasement(String)
1238
+ - getAppeasement(appeasementNumber: [String](TopLevel.String.md)): [Appeasement](dw.order.Appeasement.md)
1239
+ - : Returns the [Appeasement](dw.order.Appeasement.md) associated with this order with the given appeasementNumber.
1240
+ The method returns `null` if no instance can be found.
1241
+
1242
+
1243
+ **Parameters:**
1244
+ - appeasementNumber - the appeasement number
1245
+
1246
+ **Returns:**
1247
+ - the Appeasement associated with the given appeasementNumber
1248
+
1249
+
1250
+ ---
1251
+
1252
+ ### getAppeasementItem(String)
1253
+ - getAppeasementItem(appeasementItemID: [String](TopLevel.String.md)): [AppeasementItem](dw.order.AppeasementItem.md)
1254
+ - : Returns the [AppeasementItem](dw.order.AppeasementItem.md) associated with this Order with the given appeasementItemID.
1255
+ The method returns `null` if no instance can be found.
1256
+
1257
+
1258
+ **Parameters:**
1259
+ - appeasementItemID - the ID
1260
+
1261
+ **Returns:**
1262
+ - the AppeasementItem associated with the given appeasementItemID.
1263
+
1264
+
1265
+ ---
1266
+
1267
+ ### getAppeasementItems()
1268
+ - getAppeasementItems(): [FilteringCollection](dw.util.FilteringCollection.md)
1269
+ - : Returns the collection of [AppeasementItem](dw.order.AppeasementItem.md)s associated with this order.
1270
+
1271
+ **Returns:**
1272
+ - the appeasement items belonging to this order
1273
+
1274
+
1275
+ ---
1276
+
1277
+ ### getAppeasements()
1278
+ - getAppeasements(): [FilteringCollection](dw.util.FilteringCollection.md)
1279
+ - : Returns the collection of [Appeasement](dw.order.Appeasement.md)s associated with this order.
1280
+
1281
+ **Returns:**
1282
+ - the appeasements associated with this order
1283
+
1284
+
1285
+ ---
1286
+
1287
+ ### getCancelCode()
1288
+ - getCancelCode(): [EnumValue](dw.value.EnumValue.md)
1289
+ - : If this order was cancelled, returns the value of the
1290
+ cancel code or null.
1291
+
1292
+
1293
+ **Returns:**
1294
+ - the value of the cancel code.
1295
+
1296
+
1297
+ ---
1298
+
1299
+ ### getCancelDescription()
1300
+ - getCancelDescription(): [String](TopLevel.String.md)
1301
+ - : If this order was cancelled, returns the text describing why
1302
+ the order was cancelled or null.
1303
+
1304
+
1305
+ **Returns:**
1306
+ - the description as to why the order was cancelled or null.
1307
+
1308
+
1309
+ ---
1310
+
1311
+ ### getCapturedAmount()
1312
+ - getCapturedAmount(): [Money](dw.value.Money.md)
1313
+ - : Returns the sum of the captured amounts. The captured amounts
1314
+ are calculated on the fly. Associate a payment capture for an [PaymentInstrument](dw.order.PaymentInstrument.md) with an [Invoice](dw.order.Invoice.md)
1315
+ using [Invoice.addCaptureTransaction(OrderPaymentInstrument, Money)](dw.order.Invoice.md#addcapturetransactionorderpaymentinstrument-money).
1316
+
1317
+
1318
+ **Returns:**
1319
+ - sum of captured amounts
1320
+
1321
+
1322
+ ---
1323
+
1324
+ ### getConfirmationStatus()
1325
+ - getConfirmationStatus(): [EnumValue](dw.value.EnumValue.md)
1326
+ - : Returns the confirmation status of the order.
1327
+
1328
+ Possible values are [CONFIRMATION_STATUS_NOTCONFIRMED](dw.order.Order.md#confirmation_status_notconfirmed) and
1329
+ [CONFIRMATION_STATUS_CONFIRMED](dw.order.Order.md#confirmation_status_confirmed).
1330
+
1331
+
1332
+ **Returns:**
1333
+ - Order confirmation status
1334
+
1335
+
1336
+ ---
1337
+
1338
+ ### getCreatedBy()
1339
+ - getCreatedBy(): [String](TopLevel.String.md)
1340
+ - : Returns the name of the user who has created the order.
1341
+ If an agent user has created the order, the agent user's name
1342
+ is returned. Otherwise "Customer" is returned.
1343
+
1344
+
1345
+ **Returns:**
1346
+ - the name of the user who created the order.
1347
+
1348
+
1349
+ ---
1350
+
1351
+ ### getCurrentOrder()
1352
+ - getCurrentOrder(): [Order](dw.order.Order.md)
1353
+ - : Returns the current order. The current order
1354
+ represents the most recent order in a chain of orders.
1355
+ For example, if Order1 was replaced by Order2, Order2 is the current
1356
+ representation of the order and Order1 is the original representation
1357
+ of the order. If you replace Order2 with Order3, Order 3 is now the
1358
+ current order and Order1 is still the original representation of the
1359
+ order. If this order has not been replaced, this method returns this
1360
+ order because this order is the current order.
1361
+
1362
+
1363
+ **Returns:**
1364
+ - the current order.
1365
+
1366
+ **See Also:**
1367
+ - [getOriginalOrderNo()](dw.order.Order.md#getoriginalorderno)
1368
+ - [getOriginalOrder()](dw.order.Order.md#getoriginalorder)
1369
+ - [getReplacedOrderNo()](dw.order.Order.md#getreplacedorderno)
1370
+ - [getReplacedOrder()](dw.order.Order.md#getreplacedorder)
1371
+ - [getReplacementOrderNo()](dw.order.Order.md#getreplacementorderno)
1372
+ - [getReplacementOrder()](dw.order.Order.md#getreplacementorder)
1373
+
1374
+
1375
+ ---
1376
+
1377
+ ### getCurrentOrderNo()
1378
+ - getCurrentOrderNo(): [String](TopLevel.String.md)
1379
+ - : Returns the order number of the current order. The current order
1380
+ represents the most recent order in a chain of orders.
1381
+ For example, if Order1 was replaced by Order2, Order2 is the current
1382
+ representation of the order and Order1 is the original representation
1383
+ of the order. If you replace Order2 with Order3, Order 3 is now the
1384
+ current order and Order1 is still the original representation of the
1385
+ order. If this order has not been replaced, calling this method returns the
1386
+ same value as the [getOrderNo()](dw.order.Order.md#getorderno) method because this order is the
1387
+ current order.
1388
+
1389
+
1390
+ **Returns:**
1391
+ - the order number of the current order
1392
+
1393
+ **See Also:**
1394
+ - [getOriginalOrderNo()](dw.order.Order.md#getoriginalorderno)
1395
+ - [getOriginalOrder()](dw.order.Order.md#getoriginalorder)
1396
+ - [getReplacedOrderNo()](dw.order.Order.md#getreplacedorderno)
1397
+ - [getReplacedOrder()](dw.order.Order.md#getreplacedorder)
1398
+ - [getReplacementOrderNo()](dw.order.Order.md#getreplacementorderno)
1399
+ - [getReplacementOrder()](dw.order.Order.md#getreplacementorder)
1400
+
1401
+
1402
+ ---
1403
+
1404
+ ### getCustomerLocaleID()
1405
+ - getCustomerLocaleID(): [String](TopLevel.String.md)
1406
+ - : Returns the ID of the locale that was in effect when the order
1407
+ was placed. This is the customer's locale.
1408
+
1409
+
1410
+ **Returns:**
1411
+ - the ID of the locale associated with this order, or null.
1412
+
1413
+
1414
+ ---
1415
+
1416
+ ### getCustomerOrderReference()
1417
+ - getCustomerOrderReference(): [String](TopLevel.String.md)
1418
+ - : Returns the customer-specific reference information for the order, or null.
1419
+
1420
+ **Returns:**
1421
+ - the customer-specific reference information for the order, or null.
1422
+
1423
+
1424
+ ---
1425
+
1426
+ ### getExportAfter()
1427
+ - getExportAfter(): [Date](TopLevel.Date.md)
1428
+ - : Returns a date after which an order can be exported.
1429
+
1430
+ **Returns:**
1431
+ - a date after which an order can be exported.
1432
+
1433
+
1434
+ ---
1435
+
1436
+ ### getExportStatus()
1437
+ - getExportStatus(): [EnumValue](dw.value.EnumValue.md)
1438
+ - : Returns the export status of the order.
1439
+
1440
+ Possible values are: [EXPORT_STATUS_NOTEXPORTED](dw.order.Order.md#export_status_notexported),
1441
+ [EXPORT_STATUS_EXPORTED](dw.order.Order.md#export_status_exported), [EXPORT_STATUS_READY](dw.order.Order.md#export_status_ready),
1442
+ and [EXPORT_STATUS_FAILED](dw.order.Order.md#export_status_failed).
1443
+
1444
+
1445
+ **Returns:**
1446
+ - Order export status
1447
+
1448
+
1449
+ ---
1450
+
1451
+ ### getExternalOrderNo()
1452
+ - getExternalOrderNo(): [String](TopLevel.String.md)
1453
+ - : Returns the value of an external order number associated
1454
+ with this order, or null.
1455
+
1456
+
1457
+ **Returns:**
1458
+ - the value of an external order number associated
1459
+ with this order, or null.
1460
+
1461
+
1462
+
1463
+ ---
1464
+
1465
+ ### getExternalOrderStatus()
1466
+ - getExternalOrderStatus(): [String](TopLevel.String.md)
1467
+ - : Returns the status of an external order associated
1468
+ with this order, or null.
1469
+
1470
+
1471
+ **Returns:**
1472
+ - the status of an external order associated
1473
+ with this order, or null.
1474
+
1475
+
1476
+
1477
+ ---
1478
+
1479
+ ### getExternalOrderText()
1480
+ - getExternalOrderText(): [String](TopLevel.String.md)
1481
+ - : Returns the text describing the external order, or null.
1482
+
1483
+ **Returns:**
1484
+ - the text describing the external order, or null.
1485
+
1486
+
1487
+ ---
1488
+
1489
+ ### getGlobalPartyID()
1490
+ - getGlobalPartyID(): [String](TopLevel.String.md)
1491
+ - : The Global Party ID reconciles customer identity across multiple systems. For example, as part of the Service for
1492
+ Commerce experience, service agents can find information for customers who have never called into the call
1493
+ center, but have created a profile on the website. Service agents can find guest order data from B2C Commerce and
1494
+ easily create accounts for customers. Customer 360 Data Manager matches records from multiple data sources to
1495
+ determine all the records associated with a specific customer.
1496
+
1497
+
1498
+ **Returns:**
1499
+ - the Global Party ID associated with this order, or null.
1500
+
1501
+
1502
+ ---
1503
+
1504
+ ### getInvoice(String)
1505
+ - getInvoice(invoiceNumber: [String](TopLevel.String.md)): [Invoice](dw.order.Invoice.md)
1506
+ - : Returns the [Invoice](dw.order.Invoice.md) associated with this order with the given invoiceNumber.
1507
+ The method returns `null` if no instance can be found.
1508
+
1509
+
1510
+ Order post-processing APIs (gillian) are now inactive by default and will throw
1511
+ an exception if accessed. Activation needs preliminary approval by Product Management.
1512
+ Please contact support in this case. Existing customers using these APIs are not
1513
+ affected by this change and can use the APIs until further notice.
1514
+
1515
+
1516
+ **Parameters:**
1517
+ - invoiceNumber - the invoice number
1518
+
1519
+ **Returns:**
1520
+ - the invoice associated with the given invoiceNumber
1521
+
1522
+
1523
+ ---
1524
+
1525
+ ### getInvoiceItem(String)
1526
+ - getInvoiceItem(invoiceItemID: [String](TopLevel.String.md)): [InvoiceItem](dw.order.InvoiceItem.md)
1527
+ - : Returns the [InvoiceItem](dw.order.InvoiceItem.md) associated with this order with the given ID.
1528
+ The method returns `null` if no instance can be found.
1529
+
1530
+
1531
+ Order post-processing APIs (gillian) are now inactive by default and will throw
1532
+ an exception if accessed. Activation needs preliminary approval by Product Management.
1533
+ Please contact support in this case. Existing customers using these APIs are not
1534
+ affected by this change and can use the APIs until further notice.
1535
+
1536
+
1537
+ **Parameters:**
1538
+ - invoiceItemID - the item ID
1539
+
1540
+ **Returns:**
1541
+ - the invoice item associated with the given ID
1542
+
1543
+
1544
+ ---
1545
+
1546
+ ### getInvoiceItems()
1547
+ - getInvoiceItems(): [FilteringCollection](dw.util.FilteringCollection.md)
1548
+ - : Returns the collection of [InvoiceItem](dw.order.InvoiceItem.md)s associated with this order.
1549
+
1550
+
1551
+ Order post-processing APIs (gillian) are now inactive by default and will throw
1552
+ an exception if accessed. Activation needs preliminary approval by Product Management.
1553
+ Please contact support in this case. Existing customers using these APIs are not
1554
+ affected by this change and can use the APIs until further notice.
1555
+
1556
+
1557
+ **Returns:**
1558
+ - invoice items belonging to this order
1559
+
1560
+
1561
+ ---
1562
+
1563
+ ### getInvoiceNo()
1564
+ - getInvoiceNo(): [String](TopLevel.String.md)
1565
+ - : Returns the invoice number for this Order.
1566
+
1567
+
1568
+ When an order is placed (e.g. with [OrderMgr.placeOrder(Order)](dw.order.OrderMgr.md#placeorderorder)) invoice number will be filled
1569
+ using a sequence. Before order was placed `null` will be returned unless it was set with
1570
+ [setInvoiceNo(String)](dw.order.Order.md#setinvoicenostring).
1571
+
1572
+
1573
+ **Returns:**
1574
+ - the invoice number for this Order.
1575
+
1576
+
1577
+ ---
1578
+
1579
+ ### getInvoices()
1580
+ - getInvoices(): [FilteringCollection](dw.util.FilteringCollection.md)
1581
+ - : Returns the collection of [Invoice](dw.order.Invoice.md)s associated with this order.
1582
+
1583
+
1584
+ Order post-processing APIs (gillian) are now inactive by default and will throw
1585
+ an exception if accessed. Activation needs preliminary approval by Product Management.
1586
+ Please contact support in this case. Existing customers using these APIs are not
1587
+ affected by this change and can use the APIs until further notice.
1588
+
1589
+
1590
+ **Returns:**
1591
+ - invoices belonging to this order
1592
+
1593
+
1594
+ ---
1595
+
1596
+ ### getOrderExportXML()
1597
+ - getOrderExportXML(): [String](TopLevel.String.md)
1598
+ - : Returns the order export XML as String object.
1599
+
1600
+
1601
+ NOTE: This method will return payment instrument data masked. If payment instrument re-encryption is needed
1602
+ please use [getOrderExportXML(String, String)](dw.order.Order.md#getorderexportxmlstring-string---variant-2) instead.
1603
+
1604
+
1605
+ Example:
1606
+
1607
+
1608
+ ```
1609
+ var orderXMLAsString : String = order.getOrderExportXML();
1610
+ var orderXML : XML = new XML(orderXMLAsString);
1611
+ ```
1612
+
1613
+
1614
+ **Returns:**
1615
+ - the order export XML
1616
+
1617
+ **Throws:**
1618
+ - IllegalStateException - If the method is called in a transaction with changes.
1619
+ - IllegalStateException - If the order is not placed. This method can be called for placed orders only.
1620
+ - IllegalStateException - If the order export XML could not be generated.
1621
+
1622
+
1623
+ ---
1624
+
1625
+ ### getOrderExportXML(String, String) - Variant 1
1626
+ - getOrderExportXML(encryptionAlgorithm: [String](TopLevel.String.md), encryptionKey: [String](TopLevel.String.md)): [String](TopLevel.String.md)
1627
+ - : Returns the order export XML as String object, with payment instrument data re-encrypted using the given
1628
+ encryption algorithm and key.
1629
+
1630
+
1631
+ NOTE: If no encryption is needed or desired please always use [getOrderExportXML()](dw.order.Order.md#getorderexportxml) instead, which returns
1632
+ the payment instrument data masked. Do **not** pass in any null arguments!
1633
+
1634
+
1635
+ Example:
1636
+
1637
+
1638
+ ```
1639
+ var orderXMLAsString : String = order.getOrderExportXML( "RSA/ECB/PKCS1Padding", "[key]" );
1640
+ var orderXML : XML = new XML( orderXMLAsString );
1641
+ ```
1642
+
1643
+
1644
+ **Parameters:**
1645
+ - encryptionAlgorithm - The encryption algorithm to be used for the re-encryption of the payment instrument data (credit card number, bank account number, bank account driver's license number). Must be a valid, non-null algorithm. Currently, only [ENCRYPTION_ALGORITHM_RSA_ECB_PKCS1PADDING](dw.order.Order.md#encryption_algorithm_rsa_ecb_pkcs1padding) is supported, but this will be fixed and support for [ENCRYPTION_ALGORITHM_RSA_ECB_OAEPWITHSHA_256ANDMGF1PADDING](dw.order.Order.md#encryption_algorithm_rsa_ecb_oaepwithsha_256andmgf1padding) will be added soon.
1646
+ - encryptionKey - The Base64 encoded form of the public key to be used for the re-encryption of the payment instrument data. Must be a valid, non-blank key.
1647
+
1648
+ **Returns:**
1649
+ - the order export XML
1650
+
1651
+ **Throws:**
1652
+ - IllegalStateException - If the method is called in a transaction with changes.
1653
+ - IllegalStateException - If the order is not placed. This method can be called for placed orders only.
1654
+ - IllegalStateException - If the order export XML could not be generated.
1655
+
1656
+ **API Version:**
1657
+ :::note
1658
+ No longer available as of version 22.7.
1659
+ undefined behaviour for invalid arguments (e.g. null)
1660
+ :::
1661
+
1662
+ ---
1663
+
1664
+ ### getOrderExportXML(String, String, Boolean) - Variant 1
1665
+ - ~~getOrderExportXML(encryptionAlgorithm: [String](TopLevel.String.md), encryptionKey: [String](TopLevel.String.md), encryptUsingEKID: [Boolean](TopLevel.Boolean.md)): [String](TopLevel.String.md)~~
1666
+ - : Returns the order export XML as String object, with payment instrument data re-encrypted using the given
1667
+ encryption algorithm and key.
1668
+
1669
+
1670
+ NOTE: If no encryption is needed or desired please always use [getOrderExportXML()](dw.order.Order.md#getorderexportxml) instead, which returns
1671
+ the payment instrument data masked. Do **not** pass in any null arguments!
1672
+
1673
+
1674
+ Example:
1675
+
1676
+
1677
+ ```
1678
+ var orderXMLAsString : String = order.getOrderExportXML( "RSA/ECB/PKCS1Padding", "[key]", false );
1679
+ var orderXML : XML = new XML( orderXMLAsString );
1680
+ ```
1681
+
1682
+
1683
+ **Parameters:**
1684
+ - encryptionAlgorithm - The encryption algorithm to be used for the re-encryption of the payment instrument data (credit card number, bank account number, bank account driver's license number). Must be a valid, non-null algorithm. Currently, only [ENCRYPTION_ALGORITHM_RSA_ECB_PKCS1PADDING](dw.order.Order.md#encryption_algorithm_rsa_ecb_pkcs1padding) is supported, but this will be fixed and support for [ENCRYPTION_ALGORITHM_RSA_ECB_OAEPWITHSHA_256ANDMGF1PADDING](dw.order.Order.md#encryption_algorithm_rsa_ecb_oaepwithsha_256andmgf1padding) will be added soon.
1685
+ - encryptionKey - The Base64 encoded form of the public key to be used for the re-encryption of the payment instrument data. Must be a valid, non-blank key.
1686
+ - encryptUsingEKID - ignored
1687
+
1688
+ **Returns:**
1689
+ - the order export XML
1690
+
1691
+ **Throws:**
1692
+ - IllegalStateException - If the method is called in a transaction with changes.
1693
+ - IllegalStateException - If the order is not placed. This method can be called for placed orders only.
1694
+ - IllegalStateException - If the order export XML could not be generated.
1695
+
1696
+ **Deprecated:**
1697
+ :::warning
1698
+ This method will be removed soon. Please use the following methods instead:
1699
+
1700
+ - [getOrderExportXML()](dw.order.Order.md#getorderexportxml)– if payment instrument data should be masked - [getOrderExportXML(String, String)](dw.order.Order.md#getorderexportxmlstring-string---variant-1)– if payment instrument data should be re-encrypted
1701
+
1702
+ :::
1703
+ **API Version:**
1704
+ :::note
1705
+ No longer available as of version 22.7.
1706
+ undefined behaviour for invalid arguments (e.g. null)
1707
+ :::
1708
+
1709
+ ---
1710
+
1711
+ ### getOrderExportXML(String, String) - Variant 2
1712
+ - getOrderExportXML(encryptionAlgorithm: [String](TopLevel.String.md), encryptionKey: [String](TopLevel.String.md)): [String](TopLevel.String.md)
1713
+ - : Returns the order export XML as String object, with payment instrument data re-encrypted using the given
1714
+ encryption algorithm and key.
1715
+
1716
+
1717
+ NOTE: If no encryption is needed or desired please always use [getOrderExportXML()](dw.order.Order.md#getorderexportxml) instead, which returns
1718
+ the payment instrument data masked.
1719
+
1720
+
1721
+ Example:
1722
+
1723
+
1724
+ ```
1725
+ var orderXMLAsString : String = order.getOrderExportXML( "RSA/ECB/PKCS1Padding", "[key]" );
1726
+ var orderXML : XML = new XML( orderXMLAsString );
1727
+ ```
1728
+
1729
+
1730
+ **Parameters:**
1731
+ - encryptionAlgorithm - The encryption algorithm used for the re-encryption of the payment instrument data (credit card number, bank account number, bank account driver's license number). Must be one of the following: <li>[ENCRYPTION_ALGORITHM_RSA_ECB_OAEPWITHSHA_256ANDMGF1PADDING](dw.order.Order.md#encryption_algorithm_rsa_ecb_oaepwithsha_256andmgf1padding) – The current and preferred algorithm. <li>[ENCRYPTION_ALGORITHM_RSA_ECB_PKCS1PADDING](dw.order.Order.md#encryption_algorithm_rsa_ecb_pkcs1padding) – This algorithm is outdated/deprecated and will be removed in a future release. Please do **not** use anymore. </ul>
1732
+ - encryptionKey - The Base64 encoded form of the public key used for the re-encryption of the payment instrument data. Must be a valid, non-blank key.
1733
+
1734
+ **Returns:**
1735
+ - the order export XML
1736
+
1737
+ **Throws:**
1738
+ - IllegalArgumentException - If `encryptionAlgorithm` is not a valid known algorithm.
1739
+ - IllegalArgumentException - If `encryptionKey` is a blank string.
1740
+ - IllegalStateException - If the method is called in a transaction with changes.
1741
+ - IllegalStateException - If the order is not placed. This method can be called for placed orders only.
1742
+ - IllegalStateException - If the order export XML could not be generated.
1743
+
1744
+ **API Version:**
1745
+ :::note
1746
+ Available from version 22.7.
1747
+ strict encryption argument checks; no null or otherwise invalid values allowed
1748
+ :::
1749
+
1750
+ ---
1751
+
1752
+ ### getOrderItem(String)
1753
+ - getOrderItem(itemID: [String](TopLevel.String.md)): [OrderItem](dw.order.OrderItem.md)
1754
+ - : Returns the [OrderItem](dw.order.OrderItem.md) for the itemID.
1755
+ An OrderItem will only exist for [ProductLineItem](dw.order.ProductLineItem.md)s or
1756
+ [ShippingLineItem](dw.order.ShippingLineItem.md)s which belong to the order.
1757
+ The method fails with an exception if no instance can be found.
1758
+
1759
+
1760
+ **Parameters:**
1761
+ - itemID - the itemID
1762
+
1763
+ **Returns:**
1764
+ - the order item for itemID
1765
+
1766
+ **Throws:**
1767
+ - IllegalArgumentException - if no instance is found
1768
+
1769
+ **See Also:**
1770
+ - [ProductLineItem.getOrderItem()](dw.order.ProductLineItem.md#getorderitem)
1771
+ - [ShippingLineItem.getOrderItem()](dw.order.ShippingLineItem.md#getorderitem)
1772
+
1773
+
1774
+ ---
1775
+
1776
+ ### getOrderNo()
1777
+ - getOrderNo(): [String](TopLevel.String.md)
1778
+ - : Returns the order number for this order.
1779
+
1780
+ **Returns:**
1781
+ - the order number for this order.
1782
+
1783
+
1784
+ ---
1785
+
1786
+ ### getOrderToken()
1787
+ - getOrderToken(): [String](TopLevel.String.md)
1788
+ - : Returns the token for this order. The order token is a string (length 32 bytes) associated
1789
+ with this one order. The order token is random. It reduces the capability of malicious
1790
+ users to access an order through guessing. Order token can be used to **further** validate order
1791
+ ownership, but should never be used to solely validate ownership. In addition, the storefront
1792
+ should ensure authentication and authorization. See the [Security Best Practices for Developers](https://help.salesforce.com/s/articleView?id=cc.b2c\_developer\_authentication\_and\_authorization.htm) for details.
1793
+
1794
+
1795
+ **Returns:**
1796
+ - the token for this order.
1797
+
1798
+
1799
+ ---
1800
+
1801
+ ### getOriginalOrder()
1802
+ - getOriginalOrder(): [Order](dw.order.Order.md)
1803
+ - : Returns the original order associated with
1804
+ this order. The original order represents an order that was the
1805
+ first ancestor in a chain of orders.
1806
+ For example, if Order1 was replaced by Order2, Order2 is the current
1807
+ representation of the order and Order1 is the original representation
1808
+ of the order. If you replace Order2 with Order3, Order1 is still the
1809
+ original representation of the order. If this order is the first
1810
+ ancestor, this method returns this order.
1811
+
1812
+
1813
+ **Returns:**
1814
+ - the order number of the original order associated with
1815
+ this order.
1816
+
1817
+
1818
+ **See Also:**
1819
+ - [getCurrentOrderNo()](dw.order.Order.md#getcurrentorderno)
1820
+ - [getCurrentOrder()](dw.order.Order.md#getcurrentorder)
1821
+ - [getReplacedOrderNo()](dw.order.Order.md#getreplacedorderno)
1822
+ - [getReplacedOrder()](dw.order.Order.md#getreplacedorder)
1823
+ - [getReplacementOrderNo()](dw.order.Order.md#getreplacementorderno)
1824
+ - [getReplacementOrder()](dw.order.Order.md#getreplacementorder)
1825
+
1826
+
1827
+ ---
1828
+
1829
+ ### getOriginalOrderNo()
1830
+ - getOriginalOrderNo(): [String](TopLevel.String.md)
1831
+ - : Returns the order number of the original order associated with
1832
+ this order. The original order represents an order that was the
1833
+ first ancestor in a chain of orders.
1834
+ For example, if Order1 was replaced by Order2, Order2 is the current
1835
+ representation of the order and Order1 is the original representation
1836
+ of the order. If you replace Order2 with Order3, Order1 is still the
1837
+ original representation of the order. If this order is the first
1838
+ ancestor, this method returns the value of getOrderNo().
1839
+
1840
+
1841
+ **Returns:**
1842
+ - the order number of the original order associated with
1843
+ this order.
1844
+
1845
+
1846
+ **See Also:**
1847
+ - [getCurrentOrderNo()](dw.order.Order.md#getcurrentorderno)
1848
+ - [getCurrentOrder()](dw.order.Order.md#getcurrentorder)
1849
+ - [getReplacedOrderNo()](dw.order.Order.md#getreplacedorderno)
1850
+ - [getReplacedOrder()](dw.order.Order.md#getreplacedorder)
1851
+ - [getReplacementOrderNo()](dw.order.Order.md#getreplacementorderno)
1852
+ - [getReplacementOrder()](dw.order.Order.md#getreplacementorder)
1853
+
1854
+
1855
+ ---
1856
+
1857
+ ### getPaymentStatus()
1858
+ - getPaymentStatus(): [EnumValue](dw.value.EnumValue.md)
1859
+ - : Returns the order payment status value.
1860
+
1861
+ Possible values are [PAYMENT_STATUS_NOTPAID](dw.order.Order.md#payment_status_notpaid), [PAYMENT_STATUS_PARTPAID](dw.order.Order.md#payment_status_partpaid)
1862
+ or [PAYMENT_STATUS_PAID](dw.order.Order.md#payment_status_paid).
1863
+
1864
+
1865
+ **Returns:**
1866
+ - Order payment status
1867
+
1868
+
1869
+ ---
1870
+
1871
+ ### getPaymentTransaction()
1872
+ - ~~getPaymentTransaction(): [PaymentTransaction](dw.order.PaymentTransaction.md)~~
1873
+ - : Returns the payment transaction associated with this order.
1874
+ It is possible that there are multiple payment transactions
1875
+ associated with the order. In this case, this method returns
1876
+ the transaction associated with the first PaymentInstrument
1877
+ returned by `getPaymentInstruments()`.
1878
+
1879
+
1880
+ **Returns:**
1881
+ - the payment transaction or null if there is no transaction.
1882
+
1883
+ **Deprecated:**
1884
+ :::warning
1885
+ Use [LineItemCtnr.getPaymentInstruments()](dw.order.LineItemCtnr.md#getpaymentinstruments)
1886
+ to get the list of PaymentInstrument instances and then use
1887
+ getPaymentTransaction() method on each PaymentInstrument to access
1888
+ the individual transactions.
1889
+
1890
+ :::
1891
+
1892
+ ---
1893
+
1894
+ ### getRefundedAmount()
1895
+ - getRefundedAmount(): [Money](dw.value.Money.md)
1896
+ - : Returns the sum of the refunded amounts. The refunded amounts are
1897
+ calculated on the fly. Associate a payment refund for an [PaymentInstrument](dw.order.PaymentInstrument.md) with an [Invoice](dw.order.Invoice.md)
1898
+ using [Invoice.addRefundTransaction(OrderPaymentInstrument, Money)](dw.order.Invoice.md#addrefundtransactionorderpaymentinstrument-money).
1899
+
1900
+
1901
+ **Returns:**
1902
+ - sum of refunded amounts
1903
+
1904
+
1905
+ ---
1906
+
1907
+ ### getRemoteHost()
1908
+ - getRemoteHost(): [String](TopLevel.String.md)
1909
+ - : Returns the IP address of the remote host from which the order was created.
1910
+
1911
+
1912
+ If the IP address was not captured for the order because order IP logging
1913
+ was disabled at the time the order was created, null will be returned.
1914
+
1915
+
1916
+ **Returns:**
1917
+ - The IP address of the remote host captured for the order or null
1918
+
1919
+
1920
+ ---
1921
+
1922
+ ### getReplaceCode()
1923
+ - getReplaceCode(): [EnumValue](dw.value.EnumValue.md)
1924
+ - : If this order was replaced by another order,
1925
+ returns the value of the replace code. Otherwise.
1926
+ returns null.
1927
+
1928
+
1929
+ **Returns:**
1930
+ - the replace code
1931
+
1932
+
1933
+ ---
1934
+
1935
+ ### getReplaceDescription()
1936
+ - getReplaceDescription(): [String](TopLevel.String.md)
1937
+ - : If this order was replaced by another order,
1938
+ returns the value of the replace description. Otherwise
1939
+ returns null.
1940
+
1941
+
1942
+ **Returns:**
1943
+ - the value of the replace code or null.
1944
+
1945
+
1946
+ ---
1947
+
1948
+ ### getReplacedOrder()
1949
+ - getReplacedOrder(): [Order](dw.order.Order.md)
1950
+ - : Returns the order that this order replaced or null. For example, if you
1951
+ have three orders where Order1 was replaced by Order2 and Order2 was
1952
+ replaced by Order3, calling this method on Order3 will return Order2.
1953
+ Similarly, calling this method on Order1 will return null as Order1 was
1954
+ the original order.
1955
+
1956
+
1957
+ **Returns:**
1958
+ - the order that replaced this order, or null.
1959
+
1960
+ **See Also:**
1961
+ - [getCurrentOrderNo()](dw.order.Order.md#getcurrentorderno)
1962
+ - [getCurrentOrder()](dw.order.Order.md#getcurrentorder)
1963
+ - [getOriginalOrderNo()](dw.order.Order.md#getoriginalorderno)
1964
+ - [getOriginalOrder()](dw.order.Order.md#getoriginalorder)
1965
+ - [getReplacementOrderNo()](dw.order.Order.md#getreplacementorderno)
1966
+ - [getReplacementOrder()](dw.order.Order.md#getreplacementorder)
1967
+
1968
+
1969
+ ---
1970
+
1971
+ ### getReplacedOrderNo()
1972
+ - getReplacedOrderNo(): [String](TopLevel.String.md)
1973
+ - : Returns the order number that this order replaced or null if this order
1974
+ did not replace an order. For example, if you have three orders
1975
+ where Order1 was replaced by Order2 and Order2 was replaced by Order3,
1976
+ calling this method on Order3 will return the order number for
1977
+ Order2. Similarly, calling this method on Order1 will return null as
1978
+ Order1 was the original order.
1979
+
1980
+
1981
+ **Returns:**
1982
+ - the order number of the order that this order replaced or null.
1983
+
1984
+ **See Also:**
1985
+ - [getCurrentOrderNo()](dw.order.Order.md#getcurrentorderno)
1986
+ - [getCurrentOrder()](dw.order.Order.md#getcurrentorder)
1987
+ - [getOriginalOrderNo()](dw.order.Order.md#getoriginalorderno)
1988
+ - [getOriginalOrder()](dw.order.Order.md#getoriginalorder)
1989
+ - [getReplacementOrderNo()](dw.order.Order.md#getreplacementorderno)
1990
+ - [getReplacementOrder()](dw.order.Order.md#getreplacementorder)
1991
+
1992
+
1993
+ ---
1994
+
1995
+ ### getReplacementOrder()
1996
+ - getReplacementOrder(): [Order](dw.order.Order.md)
1997
+ - : Returns the order that replaced this order, or null.
1998
+
1999
+ **Returns:**
2000
+ - the order that replaced this order, or null.
2001
+
2002
+ **See Also:**
2003
+ - [getCurrentOrderNo()](dw.order.Order.md#getcurrentorderno)
2004
+ - [getCurrentOrder()](dw.order.Order.md#getcurrentorder)
2005
+ - [getOriginalOrderNo()](dw.order.Order.md#getoriginalorderno)
2006
+ - [getOriginalOrder()](dw.order.Order.md#getoriginalorder)
2007
+ - [getReplacedOrderNo()](dw.order.Order.md#getreplacedorderno)
2008
+ - [getReplacedOrder()](dw.order.Order.md#getreplacedorder)
2009
+
2010
+
2011
+ ---
2012
+
2013
+ ### getReplacementOrderNo()
2014
+ - getReplacementOrderNo(): [String](TopLevel.String.md)
2015
+ - : If this order was replaced by another order,
2016
+ returns the order number that replaced this order. Otherwise
2017
+ returns null.
2018
+
2019
+
2020
+ **Returns:**
2021
+ - the order that replaced this order, or null.
2022
+
2023
+ **See Also:**
2024
+ - [getCurrentOrderNo()](dw.order.Order.md#getcurrentorderno)
2025
+ - [getCurrentOrder()](dw.order.Order.md#getcurrentorder)
2026
+ - [getOriginalOrderNo()](dw.order.Order.md#getoriginalorderno)
2027
+ - [getOriginalOrder()](dw.order.Order.md#getoriginalorder)
2028
+ - [getReplacedOrderNo()](dw.order.Order.md#getreplacedorderno)
2029
+ - [getReplacedOrder()](dw.order.Order.md#getreplacedorder)
2030
+
2031
+
2032
+ ---
2033
+
2034
+ ### getReturn(String)
2035
+ - getReturn(returnNumber: [String](TopLevel.String.md)): [Return](dw.order.Return.md)
2036
+ - : Returns the [Return](dw.order.Return.md) associated with this order with the given returnNumber.
2037
+ The method returns `null` if no instance can be found.
2038
+
2039
+
2040
+ Order post-processing APIs (gillian) are now inactive by default and will throw
2041
+ an exception if accessed. Activation needs preliminary approval by Product Management.
2042
+ Please contact support in this case. Existing customers using these APIs are not
2043
+ affected by this change and can use the APIs until further notice.
2044
+
2045
+
2046
+ **Parameters:**
2047
+ - returnNumber - the return number
2048
+
2049
+ **Returns:**
2050
+ - the return associated with the given returnNumber
2051
+
2052
+
2053
+ ---
2054
+
2055
+ ### getReturnCase(String)
2056
+ - getReturnCase(returnCaseNumber: [String](TopLevel.String.md)): [ReturnCase](dw.order.ReturnCase.md)
2057
+ - : Returns the [ReturnCase](dw.order.ReturnCase.md) associated with this order with the given returnCaseNumber.
2058
+ The method returns `null` if no instance can be found.
2059
+
2060
+
2061
+ Order post-processing APIs (gillian) are now inactive by default and will throw
2062
+ an exception if accessed. Activation needs preliminary approval by Product Management.
2063
+ Please contact support in this case. Existing customers using these APIs are not
2064
+ affected by this change and can use the APIs until further notice.
2065
+
2066
+
2067
+ **Parameters:**
2068
+ - returnCaseNumber - the return case number
2069
+
2070
+ **Returns:**
2071
+ - the return case associated with the given returnCaseNumber
2072
+
2073
+
2074
+ ---
2075
+
2076
+ ### getReturnCaseItem(String)
2077
+ - getReturnCaseItem(returnCaseItemID: [String](TopLevel.String.md)): [ReturnCaseItem](dw.order.ReturnCaseItem.md)
2078
+ - : Returns the [ReturnCaseItem](dw.order.ReturnCaseItem.md) associated with this order with the given returnCaseItemID.
2079
+ The method returns `null` if no instance can be found.
2080
+
2081
+
2082
+ Order post-processing APIs (gillian) are now inactive by default and will throw
2083
+ an exception if accessed. Activation needs preliminary approval by Product Management.
2084
+ Please contact support in this case. Existing customers using these APIs are not
2085
+ affected by this change and can use the APIs until further notice.
2086
+
2087
+
2088
+ **Parameters:**
2089
+ - returnCaseItemID - the ID
2090
+
2091
+ **Returns:**
2092
+ - the return case item associated with the given returnCaseItemID
2093
+
2094
+
2095
+ ---
2096
+
2097
+ ### getReturnCaseItems()
2098
+ - getReturnCaseItems(): [FilteringCollection](dw.util.FilteringCollection.md)
2099
+ - : Returns the collection of [ReturnCaseItem](dw.order.ReturnCaseItem.md)s associated with this order.
2100
+
2101
+
2102
+ Order post-processing APIs (gillian) are now inactive by default and will throw
2103
+ an exception if accessed. Activation needs preliminary approval by Product Management.
2104
+ Please contact support in this case. Existing customers using these APIs are not
2105
+ affected by this change and can use the APIs until further notice.
2106
+
2107
+
2108
+ **Returns:**
2109
+ - return case items belonging to this order
2110
+
2111
+
2112
+ ---
2113
+
2114
+ ### getReturnCases()
2115
+ - getReturnCases(): [FilteringCollection](dw.util.FilteringCollection.md)
2116
+ - : Returns the collection of [ReturnCase](dw.order.ReturnCase.md)s associated with this order.
2117
+
2118
+
2119
+ Order post-processing APIs (gillian) are now inactive by default and will throw
2120
+ an exception if accessed. Activation needs preliminary approval by Product Management.
2121
+ Please contact support in this case. Existing customers using these APIs are not
2122
+ affected by this change and can use the APIs until further notice.
2123
+
2124
+
2125
+ **Returns:**
2126
+ - return cases belonging to this order
2127
+
2128
+
2129
+ ---
2130
+
2131
+ ### getReturnItem(String)
2132
+ - getReturnItem(returnItemID: [String](TopLevel.String.md)): [ReturnItem](dw.order.ReturnItem.md)
2133
+ - : Returns the [ReturnItem](dw.order.ReturnItem.md) associated with this order with the given ID.
2134
+ The method returns `null` if no instance can be found.
2135
+
2136
+
2137
+ Order post-processing APIs (gillian) are now inactive by default and will throw
2138
+ an exception if accessed. Activation needs preliminary approval by Product Management.
2139
+ Please contact support in this case. Existing customers using these APIs are not
2140
+ affected by this change and can use the APIs until further notice.
2141
+
2142
+
2143
+ **Parameters:**
2144
+ - returnItemID - the ID
2145
+
2146
+ **Returns:**
2147
+ - the return item associated with the given returnItemID
2148
+
2149
+
2150
+ ---
2151
+
2152
+ ### getReturnItems()
2153
+ - getReturnItems(): [FilteringCollection](dw.util.FilteringCollection.md)
2154
+ - : Returns the collection of [ReturnItem](dw.order.ReturnItem.md)s associated with this order.
2155
+
2156
+
2157
+ Order post-processing APIs (gillian) are now inactive by default and will throw
2158
+ an exception if accessed. Activation needs preliminary approval by Product Management.
2159
+ Please contact support in this case. Existing customers using these APIs are not
2160
+ affected by this change and can use the APIs until further notice.
2161
+
2162
+
2163
+ **Returns:**
2164
+ - return items belonging to this order
2165
+
2166
+
2167
+ ---
2168
+
2169
+ ### getReturns()
2170
+ - getReturns(): [FilteringCollection](dw.util.FilteringCollection.md)
2171
+ - : Returns the collection of [Return](dw.order.Return.md)s associated with this order.
2172
+
2173
+
2174
+ Order post-processing APIs (gillian) are now inactive by default and will throw
2175
+ an exception if accessed. Activation needs preliminary approval by Product Management.
2176
+ Please contact support in this case. Existing customers using these APIs are not
2177
+ affected by this change and can use the APIs until further notice.
2178
+
2179
+
2180
+ **Returns:**
2181
+ - returns belonging to this order
2182
+
2183
+
2184
+ ---
2185
+
2186
+ ### getShippingOrder(String)
2187
+ - getShippingOrder(shippingOrderNumber: [String](TopLevel.String.md)): [ShippingOrder](dw.order.ShippingOrder.md)
2188
+ - : Returns the [ShippingOrder](dw.order.ShippingOrder.md) associated with this order with the given shippingOrderNumber.
2189
+ The method returns `null` if no instance can be found.
2190
+
2191
+
2192
+ Order post-processing APIs (gillian) are now inactive by default and will throw
2193
+ an exception if accessed. Activation needs preliminary approval by Product Management.
2194
+ Please contact support in this case. Existing customers using these APIs are not
2195
+ affected by this change and can use the APIs until further notice.
2196
+
2197
+
2198
+ **Parameters:**
2199
+ - shippingOrderNumber - the shipping order number
2200
+
2201
+ **Returns:**
2202
+ - the shipping order associated with the given shippingOrderNumber
2203
+
2204
+
2205
+ ---
2206
+
2207
+ ### getShippingOrderItem(String)
2208
+ - getShippingOrderItem(shippingOrderItemID: [String](TopLevel.String.md)): [ShippingOrderItem](dw.order.ShippingOrderItem.md)
2209
+ - : Returns the [ShippingOrderItem](dw.order.ShippingOrderItem.md) associated with this order with the given shippingOrderItemID.
2210
+ The method returns `null` if no instance can be found.
2211
+
2212
+
2213
+ Order post-processing APIs (gillian) are now inactive by default and will throw
2214
+ an exception if accessed. Activation needs preliminary approval by Product Management.
2215
+ Please contact support in this case. Existing customers using these APIs are not
2216
+ affected by this change and can use the APIs until further notice.
2217
+
2218
+
2219
+ **Parameters:**
2220
+ - shippingOrderItemID - the ID
2221
+
2222
+ **Returns:**
2223
+ - the shipping order item associated with the given shippingOrderItemID
2224
+
2225
+
2226
+ ---
2227
+
2228
+ ### getShippingOrderItems()
2229
+ - getShippingOrderItems(): [FilteringCollection](dw.util.FilteringCollection.md)
2230
+ - : Returns the collection of [ShippingOrderItem](dw.order.ShippingOrderItem.md)s associated with this order.
2231
+
2232
+
2233
+ Order post-processing APIs (gillian) are now inactive by default and will throw
2234
+ an exception if accessed. Activation needs preliminary approval by Product Management.
2235
+ Please contact support in this case. Existing customers using these APIs are not
2236
+ affected by this change and can use the APIs until further notice.
2237
+
2238
+
2239
+ **Returns:**
2240
+ - shipping order items belonging to this order
2241
+
2242
+
2243
+ ---
2244
+
2245
+ ### getShippingOrders()
2246
+ - getShippingOrders(): [FilteringCollection](dw.util.FilteringCollection.md)
2247
+ - : Returns the collection of [ShippingOrder](dw.order.ShippingOrder.md)s associated with this order.
2248
+
2249
+
2250
+ Order post-processing APIs (gillian) are now inactive by default and will throw
2251
+ an exception if accessed. Activation needs preliminary approval by Product Management.
2252
+ Please contact support in this case. Existing customers using these APIs are not
2253
+ affected by this change and can use the APIs until further notice.
2254
+
2255
+
2256
+ **Returns:**
2257
+ - shipping orders belonging to this order
2258
+
2259
+
2260
+ ---
2261
+
2262
+ ### getShippingStatus()
2263
+ - getShippingStatus(): [EnumValue](dw.value.EnumValue.md)
2264
+ - : Returns the order shipping status.
2265
+
2266
+ Possible values are [SHIPPING_STATUS_NOTSHIPPED](dw.order.Order.md#shipping_status_notshipped),
2267
+ [SHIPPING_STATUS_PARTSHIPPED](dw.order.Order.md#shipping_status_partshipped) or [SHIPPING_STATUS_SHIPPED](dw.order.Order.md#shipping_status_shipped).
2268
+
2269
+
2270
+ **Returns:**
2271
+ - Order shipping status
2272
+
2273
+
2274
+ ---
2275
+
2276
+ ### getSourceCode()
2277
+ - getSourceCode(): [String](TopLevel.String.md)
2278
+ - : Returns the source code stored with the order or `null` if no source code is attached to the order.
2279
+
2280
+ **Returns:**
2281
+ - the source code stored with the order or `null` if no source code is attached to the order.
2282
+
2283
+
2284
+ ---
2285
+
2286
+ ### getSourceCodeGroup()
2287
+ - getSourceCodeGroup(): [SourceCodeGroup](dw.campaign.SourceCodeGroup.md)
2288
+ - : Returns the source code group attached to the order or `null` if no source code group is attached to
2289
+ the order.
2290
+
2291
+
2292
+ **Returns:**
2293
+ - the source code group attached to the order or `null` if no source code group is attached to
2294
+ the order.
2295
+
2296
+
2297
+
2298
+ ---
2299
+
2300
+ ### getSourceCodeGroupID()
2301
+ - getSourceCodeGroupID(): [String](TopLevel.String.md)
2302
+ - : Returns the source code group id stored with the order or `null` if no source code group is attached
2303
+ to the order.
2304
+
2305
+
2306
+ **Returns:**
2307
+ - the source code group id stored with the order or `null` if no source code group is attached
2308
+ to the order.
2309
+
2310
+
2311
+
2312
+ ---
2313
+
2314
+ ### getStatus()
2315
+ - getStatus(): [EnumValue](dw.value.EnumValue.md)
2316
+ - : Returns the status of the order.
2317
+
2318
+ Possible values are:
2319
+
2320
+ - [ORDER_STATUS_CREATED](dw.order.Order.md#order_status_created)
2321
+ - [ORDER_STATUS_NEW](dw.order.Order.md#order_status_new)
2322
+ - [ORDER_STATUS_OPEN](dw.order.Order.md#order_status_open)
2323
+ - [ORDER_STATUS_COMPLETED](dw.order.Order.md#order_status_completed)
2324
+ - [ORDER_STATUS_CANCELLED](dw.order.Order.md#order_status_cancelled)
2325
+ - [ORDER_STATUS_FAILED](dw.order.Order.md#order_status_failed)
2326
+ - [ORDER_STATUS_REPLACED](dw.order.Order.md#order_status_replaced)
2327
+
2328
+
2329
+
2330
+ The order status usually changes when a process action is initiated. Most status changes have an action which
2331
+ needs to executed in order to end having the order in a specific order status. When an order is created with e.g.
2332
+ [OrderMgr.createOrder(Basket)](dw.order.OrderMgr.md#createorderbasket) the order status will be [ORDER_STATUS_CREATED](dw.order.Order.md#order_status_created). The usual
2333
+ flow is that payment authorization will be added to the order. Once the order is considered as valid (payed,
2334
+ fraud checked, ...) the order gets placed. This can be done by calling
2335
+ [OrderMgr.placeOrder(Order)](dw.order.OrderMgr.md#placeorderorder). The result of placing an order will be status
2336
+ [ORDER_STATUS_OPEN](dw.order.Order.md#order_status_open) (from a process standpoint [ORDER_STATUS_NEW](dw.order.Order.md#order_status_new) which has the same meaning).
2337
+ Status [ORDER_STATUS_REPLACED](dw.order.Order.md#order_status_replaced) is related to functionality
2338
+ [BasketMgr.createBasketFromOrder(Order)](dw.order.BasketMgr.md#createbasketfromorderorder). [ORDER_STATUS_COMPLETED](dw.order.Order.md#order_status_completed) has no meaning by
2339
+ default but can be used by custom implementations but is a synonym for NEW/OPEN. Below you will find the most important status changes:
2340
+
2341
+
2342
+
2343
+ | Status before | Action | Status after | Business meaning |
2344
+ | --- |--- |--- |--- |
2345
+ | - | [OrderMgr.createOrder(Basket)](dw.order.OrderMgr.md#createorderbasket) | CREATED | Order was created from a basket. |
2346
+ | CREATED | [OrderMgr.placeOrder(Order)](dw.order.OrderMgr.md#placeorderorder) | OPEN/NEW | Order was considered as valid. Order can now be exported to 3rd party systems. |
2347
+ | CREATED | [OrderMgr.failOrder(Order)](dw.order.OrderMgr.md#failorderorder) | FAILED | Order was considered not valid. E.g. payment authorization was wrong or fraud check was not successful. |
2348
+ | OPEN/NEW | [OrderMgr.cancelOrder(Order)](dw.order.OrderMgr.md#cancelorderorder) | CANCELLED | Order was cancelled. |
2349
+ | CANCELLED | [OrderMgr.undoCancelOrder(Order)](dw.order.OrderMgr.md#undocancelorderorder) | OPEN/NEW | Order was cancelled by mistake and this needs to be undone. |
2350
+ | FAILED | [OrderMgr.undoFailOrder(Order)](dw.order.OrderMgr.md#undofailorderorder) | CREATED | Order was failed by mistake and this needs to be undone. |
2351
+
2352
+
2353
+ Every status change will trigger a change in the order journal which is the base for GMV calculations.
2354
+
2355
+
2356
+ **Returns:**
2357
+ - Status of the order.
2358
+
2359
+ **See Also:**
2360
+ - [LineItemCtnr](dw.order.LineItemCtnr.md)
2361
+
2362
+
2363
+ ---
2364
+
2365
+ ### isImported()
2366
+ - isImported(): [Boolean](TopLevel.Boolean.md)
2367
+ - : Returns `true`, if the order is imported and `false`
2368
+ otherwise.
2369
+
2370
+
2371
+ **Returns:**
2372
+ - true, if the order was imported, false otherwise.
2373
+
2374
+
2375
+ ---
2376
+
2377
+ ### isTaxRoundedAtGroup()
2378
+ - isTaxRoundedAtGroup(): [Boolean](TopLevel.Boolean.md)
2379
+ - : Use this method to check if the Order was created with grouped taxation calculation.
2380
+
2381
+
2382
+ If the tax is rounded on group level, the tax is applied to the summed-up tax basis for each tax rate.
2383
+
2384
+
2385
+ **Returns:**
2386
+ - `true` if the Order was created with grouped taxation
2387
+
2388
+
2389
+ ---
2390
+
2391
+ ### reauthorize()
2392
+ - reauthorize(): [Status](dw.system.Status.md)
2393
+ - : Ensures that the order is authorized.
2394
+
2395
+
2396
+ Checks if the order is authorized by calling the hook
2397
+ [PaymentHooks.validateAuthorization(Order)](dw.order.hooks.PaymentHooks.md#validateauthorizationorder). If the authorization
2398
+ is not valid it reauthorizes the order by calling the
2399
+ [PaymentHooks.reauthorize(Order)](dw.order.hooks.PaymentHooks.md#reauthorizeorder).
2400
+
2401
+
2402
+ **Returns:**
2403
+ - the status of the operation, will be Status.OK if the order is
2404
+ authorized after this call
2405
+
2406
+
2407
+
2408
+ ---
2409
+
2410
+ ### removeRemoteHost()
2411
+ - removeRemoteHost(): void
2412
+ - : Removes the IP address of the remote host if stored.
2413
+
2414
+
2415
+ If IP logging was enabled during order creation the IP address of the customer will be stored and can be
2416
+ retrieved using [getRemoteHost()](dw.order.Order.md#getremotehost).
2417
+
2418
+
2419
+ **See Also:**
2420
+ - [getRemoteHost()](dw.order.Order.md#getremotehost)
2421
+
2422
+
2423
+ ---
2424
+
2425
+ ### setAffiliatePartnerID(String)
2426
+ - setAffiliatePartnerID(affiliatePartnerID: [String](TopLevel.String.md)): void
2427
+ - : Sets the affiliate partner ID value.
2428
+
2429
+ **Parameters:**
2430
+ - affiliatePartnerID - the affiliate partner ID value.
2431
+
2432
+
2433
+ ---
2434
+
2435
+ ### setAffiliatePartnerName(String)
2436
+ - setAffiliatePartnerName(affiliatePartnerName: [String](TopLevel.String.md)): void
2437
+ - : Sets the affiliate partner name value.
2438
+
2439
+ **Parameters:**
2440
+ - affiliatePartnerName - the affiliate partner name value.
2441
+
2442
+
2443
+ ---
2444
+
2445
+ ### setCancelCode(String)
2446
+ - setCancelCode(cancelCode: [String](TopLevel.String.md)): void
2447
+ - : Sets the cancel code value.
2448
+
2449
+ **Parameters:**
2450
+ - cancelCode - the cancel code value.
2451
+
2452
+
2453
+ ---
2454
+
2455
+ ### setCancelDescription(String)
2456
+ - setCancelDescription(cancelDescription: [String](TopLevel.String.md)): void
2457
+ - : Sets the description as to why the order was cancelled.
2458
+
2459
+ **Parameters:**
2460
+ - cancelDescription - the description for why the order was cancelled.
2461
+
2462
+
2463
+ ---
2464
+
2465
+ ### setConfirmationStatus(Number)
2466
+ - setConfirmationStatus(status: [Number](TopLevel.Number.md)): void
2467
+ - : Sets the confirmation status value.
2468
+
2469
+ Possible values are [CONFIRMATION_STATUS_NOTCONFIRMED](dw.order.Order.md#confirmation_status_notconfirmed) or
2470
+ [CONFIRMATION_STATUS_CONFIRMED](dw.order.Order.md#confirmation_status_confirmed).
2471
+
2472
+
2473
+ **Parameters:**
2474
+ - status - Order confirmation status
2475
+
2476
+
2477
+ ---
2478
+
2479
+ ### setCustomer(Customer)
2480
+ - setCustomer(customer: [Customer](dw.customer.Customer.md)): void
2481
+ - : This method is used to associate the order object with the specified customer object.
2482
+
2483
+
2484
+ If the customer object represents a registered customer, the order will be assigned
2485
+ to this registered customer and the order's customer number
2486
+ ([LineItemCtnr.getCustomerNo()](dw.order.LineItemCtnr.md#getcustomerno)) will be updated.
2487
+
2488
+
2489
+ If the customer object represents an unregistered (anonymous) customer, the
2490
+ order will become an anonymous order and the order's customer number
2491
+ will be set to null.
2492
+
2493
+
2494
+ **Parameters:**
2495
+ - customer - The customer to be associated with the order.
2496
+
2497
+ **Throws:**
2498
+ - NullArgumentException - If specified customer is null.
2499
+
2500
+
2501
+ ---
2502
+
2503
+ ### setCustomerNo(String)
2504
+ - setCustomerNo(customerNo: [String](TopLevel.String.md)): void
2505
+ - : Sets the customer number associated with this order.
2506
+
2507
+
2508
+ Note it is recommended to use ([setCustomer(Customer)](dw.order.Order.md#setcustomercustomer)) instead of this method. This method
2509
+ only sets the customer number and should be used with care as it does _not re-link the order with a customer
2510
+ profile</> object which can lead to an inconsistency! Ensure that the customer number used is not already taken
2511
+ by a different customer profile.
2512
+
2513
+
2514
+ **Parameters:**
2515
+ - customerNo - the customer number associated with this order.
2516
+
2517
+
2518
+ ---
2519
+
2520
+ ### setCustomerOrderReference(String)
2521
+ - setCustomerOrderReference(reference: [String](TopLevel.String.md)): void
2522
+ - : Sets the customer-specific reference information for the order.
2523
+
2524
+ **Parameters:**
2525
+ - reference - the customer-specific reference information for the order.
2526
+
2527
+
2528
+ ---
2529
+
2530
+ ### setExportAfter(Date)
2531
+ - setExportAfter(date: [Date](TopLevel.Date.md)): void
2532
+ - : Sets the date after which an order can be exported.
2533
+
2534
+ **Parameters:**
2535
+ - date - the date after which an order can be exported.
2536
+
2537
+
2538
+ ---
2539
+
2540
+ ### setExportStatus(Number)
2541
+ - setExportStatus(status: [Number](TopLevel.Number.md)): void
2542
+ - : Sets the export status of the order.
2543
+
2544
+ Possible values are: [EXPORT_STATUS_NOTEXPORTED](dw.order.Order.md#export_status_notexported), [EXPORT_STATUS_EXPORTED](dw.order.Order.md#export_status_exported),
2545
+ [EXPORT_STATUS_READY](dw.order.Order.md#export_status_ready), and [EXPORT_STATUS_FAILED](dw.order.Order.md#export_status_failed).
2546
+
2547
+
2548
+ Setting the status to [EXPORT_STATUS_EXPORTED](dw.order.Order.md#export_status_exported) will also trigger the finalization of on order inventory
2549
+ transactions for this order meaning that all inventory transactions with type on order will be moved into final
2550
+ inventory transactions. This is only relevant when On Order Inventory is turned on for the inventory list ordered
2551
+ products are in.
2552
+
2553
+
2554
+
2555
+
2556
+ In case of an exception the current transaction is marked as rollback only.
2557
+
2558
+
2559
+ **Parameters:**
2560
+ - status - Order export status
2561
+
2562
+
2563
+ ---
2564
+
2565
+ ### setExternalOrderNo(String)
2566
+ - setExternalOrderNo(externalOrderNo: [String](TopLevel.String.md)): void
2567
+ - : Sets the value of an external order number associated
2568
+ with this order
2569
+
2570
+
2571
+ **Parameters:**
2572
+ - externalOrderNo - the value of an external order number associated with this order.
2573
+
2574
+
2575
+ ---
2576
+
2577
+ ### setExternalOrderStatus(String)
2578
+ - setExternalOrderStatus(status: [String](TopLevel.String.md)): void
2579
+ - : Sets the status of an external order associated
2580
+ with this order
2581
+
2582
+
2583
+ **Parameters:**
2584
+ - status - the status of the external order.
2585
+
2586
+
2587
+ ---
2588
+
2589
+ ### setExternalOrderText(String)
2590
+ - setExternalOrderText(text: [String](TopLevel.String.md)): void
2591
+ - : Sets the text describing the external order.
2592
+
2593
+ **Parameters:**
2594
+ - text - the text describing the external order.
2595
+
2596
+
2597
+ ---
2598
+
2599
+ ### setInvoiceNo(String)
2600
+ - setInvoiceNo(invoiceNumber: [String](TopLevel.String.md)): void
2601
+ - : Sets the invoice number for this Order.
2602
+
2603
+
2604
+ Notice that this value might be overwritten during order placement (e.g. with [OrderMgr.placeOrder(Order)](dw.order.OrderMgr.md#placeorderorder)).
2605
+
2606
+
2607
+ **Parameters:**
2608
+ - invoiceNumber - the invoice number for this Order.
2609
+
2610
+ **See Also:**
2611
+ - [getInvoiceNo()](dw.order.Order.md#getinvoiceno)
2612
+
2613
+
2614
+ ---
2615
+
2616
+ ### setOrderStatus(Number)
2617
+ - ~~setOrderStatus(status: [Number](TopLevel.Number.md)): void~~
2618
+ - : Sets the order status.
2619
+
2620
+
2621
+ Use this method when using Order Post Processing such as the creation of [shipping orders](dw.order.ShippingOrder.md). The only supported values are [ORDER_STATUS_OPEN](dw.order.Order.md#order_status_open), [ORDER_STATUS_CANCELLED](dw.order.Order.md#order_status_cancelled). Setting the
2622
+ status will adjust the order item status when applicable (item status not SHIPPED or CANCELLED). Note that the
2623
+ order status and the status of the items are directly related and dependent on one another.
2624
+
2625
+
2626
+ See [OrderItem.setStatus(String)](dw.order.OrderItem.md#setstatusstring) for more information about possible status transitions.
2627
+
2628
+
2629
+ Warning: This method will _not_ undo coupon redemptions upon cancellation of an order. Re-opening such an
2630
+ order later with [OrderMgr.undoCancelOrder(Order)](dw.order.OrderMgr.md#undocancelorderorder) or [OrderItem.setStatus(String)](dw.order.OrderItem.md#setstatusstring)
2631
+ with [ORDER_STATUS_OPEN](dw.order.Order.md#order_status_open) will result in an additional application of the same coupon code which in turn
2632
+ might fail.
2633
+
2634
+
2635
+ Order post-processing APIs (gillian) are now inactive by default and will throw
2636
+ an exception if accessed. Activation needs preliminary approval by Product Management.
2637
+ Please contact support in this case. Existing customers using these APIs are not
2638
+ affected by this change and can use the APIs until further notice.
2639
+
2640
+
2641
+ **Parameters:**
2642
+ - status - the status to be set, use one of: <li>[ORDER_STATUS_OPEN](dw.order.Order.md#order_status_open)</li> <li>[ORDER_STATUS_CANCELLED](dw.order.Order.md#order_status_cancelled)</li> </ul>
2643
+
2644
+ **Throws:**
2645
+ - IllegalArgumentException - on attempt to set an unsupported status value
2646
+
2647
+ **Deprecated:**
2648
+ :::warning
2649
+ use [setStatus(Number)](dw.order.Order.md#setstatusnumber) instead
2650
+ :::
2651
+
2652
+ ---
2653
+
2654
+ ### setPaymentStatus(Number)
2655
+ - setPaymentStatus(status: [Number](TopLevel.Number.md)): void
2656
+ - : Sets the order payment status.
2657
+
2658
+ Possible values are [PAYMENT_STATUS_NOTPAID](dw.order.Order.md#payment_status_notpaid), [PAYMENT_STATUS_PARTPAID](dw.order.Order.md#payment_status_partpaid)
2659
+ or [PAYMENT_STATUS_PAID](dw.order.Order.md#payment_status_paid).
2660
+
2661
+
2662
+ **Parameters:**
2663
+ - status - Order payment status
2664
+
2665
+
2666
+ ---
2667
+
2668
+ ### setReplaceCode(String)
2669
+ - setReplaceCode(replaceCode: [String](TopLevel.String.md)): void
2670
+ - : Sets the value of the replace code.
2671
+
2672
+ **Parameters:**
2673
+ - replaceCode - the value of the replace code.
2674
+
2675
+
2676
+ ---
2677
+
2678
+ ### setReplaceDescription(String)
2679
+ - setReplaceDescription(replaceDescription: [String](TopLevel.String.md)): void
2680
+ - : Sets the value of the replace description.
2681
+
2682
+ **Parameters:**
2683
+ - replaceDescription - the value of the replace description.
2684
+
2685
+
2686
+ ---
2687
+
2688
+ ### setShippingStatus(Number)
2689
+ - setShippingStatus(status: [Number](TopLevel.Number.md)): void
2690
+ - : Sets the order shipping status value.
2691
+
2692
+ Possible values are [SHIPPING_STATUS_NOTSHIPPED](dw.order.Order.md#shipping_status_notshipped),
2693
+ [SHIPPING_STATUS_PARTSHIPPED](dw.order.Order.md#shipping_status_partshipped) or [SHIPPING_STATUS_SHIPPED](dw.order.Order.md#shipping_status_shipped).
2694
+
2695
+
2696
+ **Parameters:**
2697
+ - status - Order shipping status
2698
+
2699
+
2700
+ ---
2701
+
2702
+ ### setStatus(Number)
2703
+ - setStatus(status: [Number](TopLevel.Number.md)): void
2704
+ - : Sets the status of the order.
2705
+
2706
+
2707
+ Possible values are:
2708
+
2709
+ - [ORDER_STATUS_NEW](dw.order.Order.md#order_status_new)
2710
+ - [ORDER_STATUS_OPEN](dw.order.Order.md#order_status_open)
2711
+ - [ORDER_STATUS_COMPLETED](dw.order.Order.md#order_status_completed)
2712
+ - [ORDER_STATUS_CANCELLED](dw.order.Order.md#order_status_cancelled)
2713
+ - [ORDER_STATUS_REPLACED](dw.order.Order.md#order_status_replaced)
2714
+
2715
+ This method does not support order statuses [ORDER_STATUS_CREATED](dw.order.Order.md#order_status_created) or [ORDER_STATUS_FAILED](dw.order.Order.md#order_status_failed). Please
2716
+ use [OrderMgr.placeOrder(Order)](dw.order.OrderMgr.md#placeorderorder) or [OrderMgr.failOrder(Order)](dw.order.OrderMgr.md#failorderorder).
2717
+
2718
+
2719
+ Setting the order status to [ORDER_STATUS_CANCELLED](dw.order.Order.md#order_status_cancelled) will have the same effect as calling
2720
+ [OrderMgr.cancelOrder(Order)](dw.order.OrderMgr.md#cancelorderorder). Setting a canceled order to [ORDER_STATUS_NEW](dw.order.Order.md#order_status_new),
2721
+ [ORDER_STATUS_OPEN](dw.order.Order.md#order_status_open) or [ORDER_STATUS_COMPLETED](dw.order.Order.md#order_status_completed) will have the same effect as calling
2722
+ [OrderMgr.undoCancelOrder(Order)](dw.order.OrderMgr.md#undocancelorderorder). It is recommended to use the methods in
2723
+ [OrderMgr](dw.order.OrderMgr.md) directly to be able to do error processing with the return code.
2724
+
2725
+
2726
+ **Parameters:**
2727
+ - status - Order status
2728
+
2729
+ **Throws:**
2730
+ - IllegalArgumentException - on attempt to set status CREATED or FAILED, or status transition while cancel order or undo cancel order returns with an error code.
2731
+
2732
+
2733
+ ---
2734
+
2735
+ ### trackOrderChange(String)
2736
+ - trackOrderChange(text: [String](TopLevel.String.md)): [Note](dw.object.Note.md)
2737
+ - : Tracks an order change.
2738
+
2739
+
2740
+ This adds a history entry to the order. Focus of history entries are changes through business logic, both custom
2741
+ and internal logic. Tracked order changes are read-only and can be accessed in the Business Manager order
2742
+ history. The following attributes of the created [history entry](dw.object.Note.md) are initialized:
2743
+
2744
+ - [Note.getCreatedBy()](dw.object.Note.md#getcreatedby)gets the current user assigned
2745
+ - [Note.getCreationDate()](dw.object.Note.md#getcreationdate)gets the current date assigned
2746
+
2747
+
2748
+
2749
+
2750
+
2751
+ This feature is intended to track important changes in custom order flow which should become visible in Business
2752
+ Manager's history tab. It is NOT intended as auditing feature for every change to an order. A warning will be
2753
+ produced after 600 notes are added to an order. The warning can be reviewed in Business Manager's Quota Status
2754
+ screen. Attempting to add a note to an order which already has 1000 notes results in an exception. Please bear in
2755
+ mind that internal changes, such as order status changes, also track changes. Avoid using this feature in
2756
+ recurring jobs which may re-process orders multiple times as the limit needs to be considered each time a change
2757
+ is tracked. The same limit on the number of notes added also applies when using method
2758
+ [LineItemCtnr.addNote(String, String)](dw.order.LineItemCtnr.md#addnotestring-string) to add notes.
2759
+
2760
+
2761
+ **Parameters:**
2762
+ - text - the text of the history entry
2763
+
2764
+ **Returns:**
2765
+ - the created history entry
2766
+
2767
+
2768
+ ---
2769
+
2770
+ <!-- prettier-ignore-end -->