This is page 61 of 61. Use http://codebase.md/taurgis/sfcc-dev-mcp?lines=true&page={x} to view the full context.
# Directory Structure
```
├── .DS_Store
├── .github
│ ├── dependabot.yml
│ ├── instructions
│ │ ├── mcp-node-tests.instructions.md
│ │ └── mcp-yml-tests.instructions.md
│ ├── ISSUE_TEMPLATE
│ │ ├── bug_report.yml
│ │ ├── config.yml
│ │ ├── documentation.yml
│ │ ├── feature_request.yml
│ │ └── question.yml
│ ├── PULL_REQUEST_TEMPLATE
│ │ ├── bug_fix.md
│ │ ├── documentation.md
│ │ └── new_tool.md
│ ├── pull_request_template.md
│ └── workflows
│ ├── ci.yml
│ ├── deploy-pages.yml
│ ├── publish.yml
│ └── update-docs.yml
├── .gitignore
├── .husky
│ └── pre-commit
├── aegis.config.docs-only.json
├── aegis.config.json
├── aegis.config.with-dw.json
├── AGENTS.md
├── ai-instructions
│ ├── claude-desktop
│ │ └── claude_custom_instructions.md
│ ├── cursor
│ │ └── .cursor
│ │ └── rules
│ │ ├── debugging-workflows.mdc
│ │ ├── hooks-development.mdc
│ │ ├── isml-templates.mdc
│ │ ├── job-framework.mdc
│ │ ├── performance-optimization.mdc
│ │ ├── scapi-endpoints.mdc
│ │ ├── security-patterns.mdc
│ │ ├── sfcc-development.mdc
│ │ ├── sfra-controllers.mdc
│ │ ├── sfra-models.mdc
│ │ ├── system-objects.mdc
│ │ └── testing-patterns.mdc
│ └── github-copilot
│ └── copilot-instructions.md
├── CHANGELOG.md
├── CONTRIBUTING.md
├── docs
│ ├── best-practices
│ │ ├── cartridge_creation.md
│ │ ├── isml_templates.md
│ │ ├── job_framework.md
│ │ ├── localserviceregistry.md
│ │ ├── ocapi_hooks.md
│ │ ├── performance.md
│ │ ├── scapi_custom_endpoint.md
│ │ ├── scapi_hooks.md
│ │ ├── security.md
│ │ ├── sfra_client_side_js.md
│ │ ├── sfra_controllers.md
│ │ ├── sfra_models.md
│ │ └── sfra_scss.md
│ ├── dw_campaign
│ │ ├── ABTest.md
│ │ ├── ABTestMgr.md
│ │ ├── ABTestSegment.md
│ │ ├── AmountDiscount.md
│ │ ├── ApproachingDiscount.md
│ │ ├── BonusChoiceDiscount.md
│ │ ├── BonusDiscount.md
│ │ ├── Campaign.md
│ │ ├── CampaignMgr.md
│ │ ├── CampaignStatusCodes.md
│ │ ├── Coupon.md
│ │ ├── CouponMgr.md
│ │ ├── CouponRedemption.md
│ │ ├── CouponStatusCodes.md
│ │ ├── Discount.md
│ │ ├── DiscountPlan.md
│ │ ├── FixedPriceDiscount.md
│ │ ├── FixedPriceShippingDiscount.md
│ │ ├── FreeDiscount.md
│ │ ├── FreeShippingDiscount.md
│ │ ├── PercentageDiscount.md
│ │ ├── PercentageOptionDiscount.md
│ │ ├── PriceBookPriceDiscount.md
│ │ ├── Promotion.md
│ │ ├── PromotionMgr.md
│ │ ├── PromotionPlan.md
│ │ ├── SlotContent.md
│ │ ├── SourceCodeGroup.md
│ │ ├── SourceCodeInfo.md
│ │ ├── SourceCodeStatusCodes.md
│ │ └── TotalFixedPriceDiscount.md
│ ├── dw_catalog
│ │ ├── Catalog.md
│ │ ├── CatalogMgr.md
│ │ ├── Category.md
│ │ ├── CategoryAssignment.md
│ │ ├── CategoryLink.md
│ │ ├── PriceBook.md
│ │ ├── PriceBookMgr.md
│ │ ├── Product.md
│ │ ├── ProductActiveData.md
│ │ ├── ProductAttributeModel.md
│ │ ├── ProductAvailabilityLevels.md
│ │ ├── ProductAvailabilityModel.md
│ │ ├── ProductInventoryList.md
│ │ ├── ProductInventoryMgr.md
│ │ ├── ProductInventoryRecord.md
│ │ ├── ProductLink.md
│ │ ├── ProductMgr.md
│ │ ├── ProductOption.md
│ │ ├── ProductOptionModel.md
│ │ ├── ProductOptionValue.md
│ │ ├── ProductPriceInfo.md
│ │ ├── ProductPriceModel.md
│ │ ├── ProductPriceTable.md
│ │ ├── ProductSearchHit.md
│ │ ├── ProductSearchModel.md
│ │ ├── ProductSearchRefinementDefinition.md
│ │ ├── ProductSearchRefinements.md
│ │ ├── ProductSearchRefinementValue.md
│ │ ├── ProductVariationAttribute.md
│ │ ├── ProductVariationAttributeValue.md
│ │ ├── ProductVariationModel.md
│ │ ├── Recommendation.md
│ │ ├── SearchModel.md
│ │ ├── SearchRefinementDefinition.md
│ │ ├── SearchRefinements.md
│ │ ├── SearchRefinementValue.md
│ │ ├── SortingOption.md
│ │ ├── SortingRule.md
│ │ ├── Store.md
│ │ ├── StoreGroup.md
│ │ ├── StoreInventoryFilter.md
│ │ ├── StoreInventoryFilterValue.md
│ │ ├── StoreMgr.md
│ │ ├── Variant.md
│ │ └── VariationGroup.md
│ ├── dw_content
│ │ ├── Content.md
│ │ ├── ContentMgr.md
│ │ ├── ContentSearchModel.md
│ │ ├── ContentSearchRefinementDefinition.md
│ │ ├── ContentSearchRefinements.md
│ │ ├── ContentSearchRefinementValue.md
│ │ ├── Folder.md
│ │ ├── Library.md
│ │ ├── MarkupText.md
│ │ └── MediaFile.md
│ ├── dw_crypto
│ │ ├── CertificateRef.md
│ │ ├── CertificateUtils.md
│ │ ├── Cipher.md
│ │ ├── Encoding.md
│ │ ├── JWE.md
│ │ ├── JWEHeader.md
│ │ ├── JWS.md
│ │ ├── JWSHeader.md
│ │ ├── KeyRef.md
│ │ ├── Mac.md
│ │ ├── MessageDigest.md
│ │ ├── SecureRandom.md
│ │ ├── Signature.md
│ │ ├── WeakCipher.md
│ │ ├── WeakMac.md
│ │ ├── WeakMessageDigest.md
│ │ ├── WeakSignature.md
│ │ └── X509Certificate.md
│ ├── dw_customer
│ │ ├── AddressBook.md
│ │ ├── AgentUserMgr.md
│ │ ├── AgentUserStatusCodes.md
│ │ ├── AuthenticationStatus.md
│ │ ├── Credentials.md
│ │ ├── Customer.md
│ │ ├── CustomerActiveData.md
│ │ ├── CustomerAddress.md
│ │ ├── CustomerCDPData.md
│ │ ├── CustomerContextMgr.md
│ │ ├── CustomerGroup.md
│ │ ├── CustomerList.md
│ │ ├── CustomerMgr.md
│ │ ├── CustomerPasswordConstraints.md
│ │ ├── CustomerPaymentInstrument.md
│ │ ├── CustomerStatusCodes.md
│ │ ├── EncryptedObject.md
│ │ ├── ExternalProfile.md
│ │ ├── OrderHistory.md
│ │ ├── ProductList.md
│ │ ├── ProductListItem.md
│ │ ├── ProductListItemPurchase.md
│ │ ├── ProductListMgr.md
│ │ ├── ProductListRegistrant.md
│ │ ├── Profile.md
│ │ └── Wallet.md
│ ├── dw_extensions.applepay
│ │ ├── ApplePayHookResult.md
│ │ └── ApplePayHooks.md
│ ├── dw_extensions.facebook
│ │ ├── FacebookFeedHooks.md
│ │ └── FacebookProduct.md
│ ├── dw_extensions.paymentrequest
│ │ ├── PaymentRequestHookResult.md
│ │ └── PaymentRequestHooks.md
│ ├── dw_extensions.payments
│ │ ├── SalesforceBancontactPaymentDetails.md
│ │ ├── SalesforceCardPaymentDetails.md
│ │ ├── SalesforceEpsPaymentDetails.md
│ │ ├── SalesforceIdealPaymentDetails.md
│ │ ├── SalesforceKlarnaPaymentDetails.md
│ │ ├── SalesforcePaymentDetails.md
│ │ ├── SalesforcePaymentIntent.md
│ │ ├── SalesforcePaymentMethod.md
│ │ ├── SalesforcePaymentRequest.md
│ │ ├── SalesforcePaymentsHooks.md
│ │ ├── SalesforcePaymentsMgr.md
│ │ ├── SalesforcePaymentsSiteConfiguration.md
│ │ ├── SalesforcePayPalOrder.md
│ │ ├── SalesforcePayPalOrderAddress.md
│ │ ├── SalesforcePayPalOrderPayer.md
│ │ ├── SalesforcePayPalPaymentDetails.md
│ │ ├── SalesforceSepaDebitPaymentDetails.md
│ │ └── SalesforceVenmoPaymentDetails.md
│ ├── dw_extensions.pinterest
│ │ ├── PinterestAvailability.md
│ │ ├── PinterestFeedHooks.md
│ │ ├── PinterestOrder.md
│ │ ├── PinterestOrderHooks.md
│ │ └── PinterestProduct.md
│ ├── dw_io
│ │ ├── CSVStreamReader.md
│ │ ├── CSVStreamWriter.md
│ │ ├── File.md
│ │ ├── FileReader.md
│ │ ├── FileWriter.md
│ │ ├── InputStream.md
│ │ ├── OutputStream.md
│ │ ├── PrintWriter.md
│ │ ├── RandomAccessFileReader.md
│ │ ├── Reader.md
│ │ ├── StringWriter.md
│ │ ├── Writer.md
│ │ ├── XMLIndentingStreamWriter.md
│ │ ├── XMLStreamConstants.md
│ │ ├── XMLStreamReader.md
│ │ └── XMLStreamWriter.md
│ ├── dw_job
│ │ ├── JobExecution.md
│ │ └── JobStepExecution.md
│ ├── dw_net
│ │ ├── FTPClient.md
│ │ ├── FTPFileInfo.md
│ │ ├── HTTPClient.md
│ │ ├── HTTPRequestPart.md
│ │ ├── Mail.md
│ │ ├── SFTPClient.md
│ │ ├── SFTPFileInfo.md
│ │ ├── WebDAVClient.md
│ │ └── WebDAVFileInfo.md
│ ├── dw_object
│ │ ├── ActiveData.md
│ │ ├── CustomAttributes.md
│ │ ├── CustomObject.md
│ │ ├── CustomObjectMgr.md
│ │ ├── Extensible.md
│ │ ├── ExtensibleObject.md
│ │ ├── Note.md
│ │ ├── ObjectAttributeDefinition.md
│ │ ├── ObjectAttributeGroup.md
│ │ ├── ObjectAttributeValueDefinition.md
│ │ ├── ObjectTypeDefinition.md
│ │ ├── PersistentObject.md
│ │ ├── SimpleExtensible.md
│ │ └── SystemObjectMgr.md
│ ├── dw_order
│ │ ├── AbstractItem.md
│ │ ├── AbstractItemCtnr.md
│ │ ├── Appeasement.md
│ │ ├── AppeasementItem.md
│ │ ├── Basket.md
│ │ ├── BasketMgr.md
│ │ ├── BonusDiscountLineItem.md
│ │ ├── CouponLineItem.md
│ │ ├── CreateAgentBasketLimitExceededException.md
│ │ ├── CreateBasketFromOrderException.md
│ │ ├── CreateCouponLineItemException.md
│ │ ├── CreateOrderException.md
│ │ ├── CreateTemporaryBasketLimitExceededException.md
│ │ ├── GiftCertificate.md
│ │ ├── GiftCertificateLineItem.md
│ │ ├── GiftCertificateMgr.md
│ │ ├── GiftCertificateStatusCodes.md
│ │ ├── Invoice.md
│ │ ├── InvoiceItem.md
│ │ ├── LineItem.md
│ │ ├── LineItemCtnr.md
│ │ ├── Order.md
│ │ ├── OrderAddress.md
│ │ ├── OrderItem.md
│ │ ├── OrderMgr.md
│ │ ├── OrderPaymentInstrument.md
│ │ ├── OrderProcessStatusCodes.md
│ │ ├── PaymentCard.md
│ │ ├── PaymentInstrument.md
│ │ ├── PaymentMethod.md
│ │ ├── PaymentMgr.md
│ │ ├── PaymentProcessor.md
│ │ ├── PaymentStatusCodes.md
│ │ ├── PaymentTransaction.md
│ │ ├── PriceAdjustment.md
│ │ ├── PriceAdjustmentLimitTypes.md
│ │ ├── ProductLineItem.md
│ │ ├── ProductShippingCost.md
│ │ ├── ProductShippingLineItem.md
│ │ ├── ProductShippingModel.md
│ │ ├── Return.md
│ │ ├── ReturnCase.md
│ │ ├── ReturnCaseItem.md
│ │ ├── ReturnItem.md
│ │ ├── Shipment.md
│ │ ├── ShipmentShippingCost.md
│ │ ├── ShipmentShippingModel.md
│ │ ├── ShippingLineItem.md
│ │ ├── ShippingLocation.md
│ │ ├── ShippingMethod.md
│ │ ├── ShippingMgr.md
│ │ ├── ShippingOrder.md
│ │ ├── ShippingOrderItem.md
│ │ ├── SumItem.md
│ │ ├── TaxGroup.md
│ │ ├── TaxItem.md
│ │ ├── TaxMgr.md
│ │ ├── TrackingInfo.md
│ │ └── TrackingRef.md
│ ├── dw_order.hooks
│ │ ├── CalculateHooks.md
│ │ ├── OrderHooks.md
│ │ ├── PaymentHooks.md
│ │ ├── ReturnHooks.md
│ │ └── ShippingOrderHooks.md
│ ├── dw_rpc
│ │ ├── SOAPUtil.md
│ │ ├── Stub.md
│ │ └── WebReference.md
│ ├── dw_suggest
│ │ ├── BrandSuggestions.md
│ │ ├── CategorySuggestions.md
│ │ ├── ContentSuggestions.md
│ │ ├── CustomSuggestions.md
│ │ ├── ProductSuggestions.md
│ │ ├── SearchPhraseSuggestions.md
│ │ ├── SuggestedCategory.md
│ │ ├── SuggestedContent.md
│ │ ├── SuggestedPhrase.md
│ │ ├── SuggestedProduct.md
│ │ ├── SuggestedTerm.md
│ │ ├── SuggestedTerms.md
│ │ ├── Suggestions.md
│ │ └── SuggestModel.md
│ ├── dw_svc
│ │ ├── FTPService.md
│ │ ├── FTPServiceDefinition.md
│ │ ├── HTTPFormService.md
│ │ ├── HTTPFormServiceDefinition.md
│ │ ├── HTTPService.md
│ │ ├── HTTPServiceDefinition.md
│ │ ├── LocalServiceRegistry.md
│ │ ├── Result.md
│ │ ├── Service.md
│ │ ├── ServiceCallback.md
│ │ ├── ServiceConfig.md
│ │ ├── ServiceCredential.md
│ │ ├── ServiceDefinition.md
│ │ ├── ServiceProfile.md
│ │ ├── ServiceRegistry.md
│ │ ├── SOAPService.md
│ │ └── SOAPServiceDefinition.md
│ ├── dw_system
│ │ ├── AgentUserStatusCodes.md
│ │ ├── Cache.md
│ │ ├── CacheMgr.md
│ │ ├── HookMgr.md
│ │ ├── InternalObject.md
│ │ ├── JobProcessMonitor.md
│ │ ├── Log.md
│ │ ├── Logger.md
│ │ ├── LogNDC.md
│ │ ├── OrganizationPreferences.md
│ │ ├── Pipeline.md
│ │ ├── PipelineDictionary.md
│ │ ├── RemoteInclude.md
│ │ ├── Request.md
│ │ ├── RequestHooks.md
│ │ ├── Response.md
│ │ ├── RESTErrorResponse.md
│ │ ├── RESTResponseMgr.md
│ │ ├── RESTSuccessResponse.md
│ │ ├── SearchStatus.md
│ │ ├── Session.md
│ │ ├── Site.md
│ │ ├── SitePreferences.md
│ │ ├── Status.md
│ │ ├── StatusItem.md
│ │ ├── System.md
│ │ └── Transaction.md
│ ├── dw_util
│ │ ├── ArrayList.md
│ │ ├── Assert.md
│ │ ├── BigInteger.md
│ │ ├── Bytes.md
│ │ ├── Calendar.md
│ │ ├── Collection.md
│ │ ├── Currency.md
│ │ ├── DateUtils.md
│ │ ├── Decimal.md
│ │ ├── FilteringCollection.md
│ │ ├── Geolocation.md
│ │ ├── HashMap.md
│ │ ├── HashSet.md
│ │ ├── Iterator.md
│ │ ├── LinkedHashMap.md
│ │ ├── LinkedHashSet.md
│ │ ├── List.md
│ │ ├── Locale.md
│ │ ├── Map.md
│ │ ├── MapEntry.md
│ │ ├── MappingKey.md
│ │ ├── MappingMgr.md
│ │ ├── PropertyComparator.md
│ │ ├── SecureEncoder.md
│ │ ├── SecureFilter.md
│ │ ├── SeekableIterator.md
│ │ ├── Set.md
│ │ ├── SortedMap.md
│ │ ├── SortedSet.md
│ │ ├── StringUtils.md
│ │ ├── Template.md
│ │ └── UUIDUtils.md
│ ├── dw_value
│ │ ├── EnumValue.md
│ │ ├── MimeEncodedText.md
│ │ ├── Money.md
│ │ └── Quantity.md
│ ├── dw_web
│ │ ├── ClickStream.md
│ │ ├── ClickStreamEntry.md
│ │ ├── Cookie.md
│ │ ├── Cookies.md
│ │ ├── CSRFProtection.md
│ │ ├── Form.md
│ │ ├── FormAction.md
│ │ ├── FormElement.md
│ │ ├── FormElementValidationResult.md
│ │ ├── FormField.md
│ │ ├── FormFieldOption.md
│ │ ├── FormFieldOptions.md
│ │ ├── FormGroup.md
│ │ ├── FormList.md
│ │ ├── FormListItem.md
│ │ ├── Forms.md
│ │ ├── HttpParameter.md
│ │ ├── HttpParameterMap.md
│ │ ├── LoopIterator.md
│ │ ├── PageMetaData.md
│ │ ├── PageMetaTag.md
│ │ ├── PagingModel.md
│ │ ├── Resource.md
│ │ ├── URL.md
│ │ ├── URLAction.md
│ │ ├── URLParameter.md
│ │ ├── URLRedirect.md
│ │ ├── URLRedirectMgr.md
│ │ └── URLUtils.md
│ ├── sfra
│ │ ├── account.md
│ │ ├── address.md
│ │ ├── billing.md
│ │ ├── cart.md
│ │ ├── categories.md
│ │ ├── content.md
│ │ ├── locale.md
│ │ ├── order.md
│ │ ├── payment.md
│ │ ├── price-default.md
│ │ ├── price-range.md
│ │ ├── price-tiered.md
│ │ ├── product-bundle.md
│ │ ├── product-full.md
│ │ ├── product-line-items.md
│ │ ├── product-search.md
│ │ ├── product-tile.md
│ │ ├── querystring.md
│ │ ├── render.md
│ │ ├── request.md
│ │ ├── response.md
│ │ ├── server.md
│ │ ├── shipping.md
│ │ ├── store.md
│ │ ├── stores.md
│ │ └── totals.md
│ └── TopLevel
│ ├── APIException.md
│ ├── arguments.md
│ ├── Array.md
│ ├── ArrayBuffer.md
│ ├── BigInt.md
│ ├── Boolean.md
│ ├── ConversionError.md
│ ├── DataView.md
│ ├── Date.md
│ ├── Error.md
│ ├── ES6Iterator.md
│ ├── EvalError.md
│ ├── Fault.md
│ ├── Float32Array.md
│ ├── Float64Array.md
│ ├── Function.md
│ ├── Generator.md
│ ├── global.md
│ ├── Int16Array.md
│ ├── Int32Array.md
│ ├── Int8Array.md
│ ├── InternalError.md
│ ├── IOError.md
│ ├── Iterable.md
│ ├── Iterator.md
│ ├── JSON.md
│ ├── Map.md
│ ├── Math.md
│ ├── Module.md
│ ├── Namespace.md
│ ├── Number.md
│ ├── Object.md
│ ├── QName.md
│ ├── RangeError.md
│ ├── ReferenceError.md
│ ├── RegExp.md
│ ├── Set.md
│ ├── StopIteration.md
│ ├── String.md
│ ├── Symbol.md
│ ├── SyntaxError.md
│ ├── SystemError.md
│ ├── TypeError.md
│ ├── Uint16Array.md
│ ├── Uint32Array.md
│ ├── Uint8Array.md
│ ├── Uint8ClampedArray.md
│ ├── URIError.md
│ ├── WeakMap.md
│ ├── WeakSet.md
│ ├── XML.md
│ ├── XMLList.md
│ └── XMLStreamError.md
├── docs-site
│ ├── .gitignore
│ ├── App.tsx
│ ├── components
│ │ ├── Badge.tsx
│ │ ├── BreadcrumbSchema.tsx
│ │ ├── CodeBlock.tsx
│ │ ├── Collapsible.tsx
│ │ ├── ConfigBuilder.tsx
│ │ ├── ConfigHero.tsx
│ │ ├── ConfigModeTabs.tsx
│ │ ├── icons.tsx
│ │ ├── Layout.tsx
│ │ ├── LightCodeContainer.tsx
│ │ ├── NewcomerCTA.tsx
│ │ ├── NextStepsStrip.tsx
│ │ ├── OnThisPage.tsx
│ │ ├── Search.tsx
│ │ ├── SEO.tsx
│ │ ├── Sidebar.tsx
│ │ ├── StructuredData.tsx
│ │ ├── ToolCard.tsx
│ │ ├── ToolFilters.tsx
│ │ ├── Typography.tsx
│ │ └── VersionBadge.tsx
│ ├── constants.tsx
│ ├── index.html
│ ├── main.tsx
│ ├── metadata.json
│ ├── package-lock.json
│ ├── package.json
│ ├── pages
│ │ ├── AIInterfacesPage.tsx
│ │ ├── ConfigurationPage.tsx
│ │ ├── DevelopmentPage.tsx
│ │ ├── ExamplesPage.tsx
│ │ ├── FeaturesPage.tsx
│ │ ├── HomePage.tsx
│ │ ├── SecurityPage.tsx
│ │ ├── ToolsPage.tsx
│ │ └── TroubleshootingPage.tsx
│ ├── postcss.config.js
│ ├── public
│ │ ├── .well-known
│ │ │ └── security.txt
│ │ ├── 404.html
│ │ ├── android-chrome-192x192.png
│ │ ├── android-chrome-512x512.png
│ │ ├── apple-touch-icon.png
│ │ ├── explain-product-pricing-methods-no-mcp.png
│ │ ├── explain-product-pricing-methods.png
│ │ ├── favicon-16x16.png
│ │ ├── favicon-32x32.png
│ │ ├── favicon.ico
│ │ ├── llms.txt
│ │ ├── robots.txt
│ │ ├── site.webmanifest
│ │ └── sitemap.xml
│ ├── README.md
│ ├── scripts
│ │ ├── generate-search-index.js
│ │ ├── generate-sitemap.js
│ │ └── search-dev.js
│ ├── src
│ │ └── styles
│ │ ├── input.css
│ │ └── prism-theme.css
│ ├── tailwind.config.js
│ ├── tsconfig.json
│ ├── types.ts
│ ├── utils
│ │ ├── search.ts
│ │ └── toolsData.ts
│ └── vite.config.ts
├── eslint.config.js
├── jest.config.js
├── LICENSE
├── package-lock.json
├── package.json
├── README.md
├── scripts
│ └── convert-docs.js
├── SECURITY.md
├── server.json
├── src
│ ├── clients
│ │ ├── base
│ │ │ ├── http-client.ts
│ │ │ ├── oauth-token.ts
│ │ │ └── ocapi-auth-client.ts
│ │ ├── best-practices-client.ts
│ │ ├── cartridge-generation-client.ts
│ │ ├── docs
│ │ │ ├── class-content-parser.ts
│ │ │ ├── class-name-resolver.ts
│ │ │ ├── documentation-scanner.ts
│ │ │ ├── index.ts
│ │ │ └── referenced-types-extractor.ts
│ │ ├── docs-client.ts
│ │ ├── log-client.ts
│ │ ├── logs
│ │ │ ├── index.ts
│ │ │ ├── log-analyzer.ts
│ │ │ ├── log-client.ts
│ │ │ ├── log-constants.ts
│ │ │ ├── log-file-discovery.ts
│ │ │ ├── log-file-reader.ts
│ │ │ ├── log-formatter.ts
│ │ │ ├── log-processor.ts
│ │ │ ├── log-types.ts
│ │ │ └── webdav-client-manager.ts
│ │ ├── ocapi
│ │ │ ├── code-versions-client.ts
│ │ │ ├── site-preferences-client.ts
│ │ │ └── system-objects-client.ts
│ │ ├── ocapi-client.ts
│ │ └── sfra-client.ts
│ ├── config
│ │ ├── configuration-factory.ts
│ │ └── dw-json-loader.ts
│ ├── core
│ │ ├── handlers
│ │ │ ├── abstract-log-tool-handler.ts
│ │ │ ├── base-handler.ts
│ │ │ ├── best-practices-handler.ts
│ │ │ ├── cartridge-handler.ts
│ │ │ ├── client-factory.ts
│ │ │ ├── code-version-handler.ts
│ │ │ ├── docs-handler.ts
│ │ │ ├── job-log-handler.ts
│ │ │ ├── job-log-tool-config.ts
│ │ │ ├── log-handler.ts
│ │ │ ├── log-tool-config.ts
│ │ │ ├── sfra-handler.ts
│ │ │ ├── system-object-handler.ts
│ │ │ └── validation-helpers.ts
│ │ ├── server.ts
│ │ └── tool-definitions.ts
│ ├── index.ts
│ ├── main.ts
│ ├── services
│ │ ├── file-system-service.ts
│ │ ├── index.ts
│ │ └── path-service.ts
│ ├── tool-configs
│ │ ├── best-practices-tool-config.ts
│ │ ├── cartridge-tool-config.ts
│ │ ├── code-version-tool-config.ts
│ │ ├── docs-tool-config.ts
│ │ ├── job-log-tool-config.ts
│ │ ├── log-tool-config.ts
│ │ ├── sfra-tool-config.ts
│ │ └── system-object-tool-config.ts
│ ├── types
│ │ └── types.ts
│ └── utils
│ ├── cache.ts
│ ├── job-log-tool-config.ts
│ ├── job-log-utils.ts
│ ├── log-cache.ts
│ ├── log-tool-config.ts
│ ├── log-tool-constants.ts
│ ├── log-tool-utils.ts
│ ├── logger.ts
│ ├── ocapi-url-builder.ts
│ ├── path-resolver.ts
│ ├── query-builder.ts
│ ├── utils.ts
│ └── validator.ts
├── tests
│ ├── __mocks__
│ │ ├── docs-client.ts
│ │ ├── src
│ │ │ └── clients
│ │ │ └── base
│ │ │ └── http-client.js
│ │ └── webdav.js
│ ├── base-handler.test.ts
│ ├── base-http-client.test.ts
│ ├── best-practices-handler.test.ts
│ ├── cache.test.ts
│ ├── cartridge-handler.test.ts
│ ├── class-content-parser.test.ts
│ ├── class-name-resolver.test.ts
│ ├── client-factory.test.ts
│ ├── code-version-handler.test.ts
│ ├── code-versions-client.test.ts
│ ├── config.test.ts
│ ├── configuration-factory.test.ts
│ ├── docs-handler.test.ts
│ ├── documentation-scanner.test.ts
│ ├── file-system-service.test.ts
│ ├── job-log-handler.test.ts
│ ├── job-log-utils.test.ts
│ ├── log-client.test.ts
│ ├── log-handler.test.ts
│ ├── log-processor.test.ts
│ ├── logger.test.ts
│ ├── mcp
│ │ ├── AGENTS.md
│ │ ├── node
│ │ │ ├── activate-code-version-advanced.full-mode.programmatic.test.js
│ │ │ ├── code-versions.full-mode.programmatic.test.js
│ │ │ ├── generate-cartridge-structure.docs-only.programmatic.test.js
│ │ │ ├── get-available-best-practice-guides.docs-only.programmatic.test.js
│ │ │ ├── get-available-sfra-documents.programmatic.test.js
│ │ │ ├── get-best-practice-guide.docs-only.programmatic.test.js
│ │ │ ├── get-hook-reference.docs-only.programmatic.test.js
│ │ │ ├── get-job-execution-summary.full-mode.programmatic.test.js
│ │ │ ├── get-job-log-entries.full-mode.programmatic.test.js
│ │ │ ├── get-latest-debug.full-mode.programmatic.test.js
│ │ │ ├── get-latest-error.full-mode.programmatic.test.js
│ │ │ ├── get-latest-info.full-mode.programmatic.test.js
│ │ │ ├── get-latest-job-log-files.full-mode.programmatic.test.js
│ │ │ ├── get-latest-warn.full-mode.programmatic.test.js
│ │ │ ├── get-log-file-contents.full-mode.programmatic.test.js
│ │ │ ├── get-sfcc-class-documentation.docs-only.programmatic.test.js
│ │ │ ├── get-sfcc-class-info.docs-only.programmatic.test.js
│ │ │ ├── get-sfra-categories.docs-only.programmatic.test.js
│ │ │ ├── get-sfra-document.programmatic.test.js
│ │ │ ├── get-sfra-documents-by-category.docs-only.programmatic.test.js
│ │ │ ├── get-system-object-definition.full-mode.programmatic.test.js
│ │ │ ├── get-system-object-definitions.docs-only.programmatic.test.js
│ │ │ ├── get-system-object-definitions.full-mode.programmatic.test.js
│ │ │ ├── list-log-files.full-mode.programmatic.test.js
│ │ │ ├── list-sfcc-classes.docs-only.programmatic.test.js
│ │ │ ├── search-best-practices.docs-only.programmatic.test.js
│ │ │ ├── search-custom-object-attribute-definitions.full-mode.programmatic.test.js
│ │ │ ├── search-job-logs-by-name.full-mode.programmatic.test.js
│ │ │ ├── search-job-logs.full-mode.programmatic.test.js
│ │ │ ├── search-logs.full-mode.programmatic.test.js
│ │ │ ├── search-sfcc-classes.docs-only.programmatic.test.js
│ │ │ ├── search-sfcc-methods.docs-only.programmatic.test.js
│ │ │ ├── search-sfra-documentation.docs-only.programmatic.test.js
│ │ │ ├── search-site-preferences.full-mode.programmatic.test.js
│ │ │ ├── search-system-object-attribute-definitions.full-mode.programmatic.test.js
│ │ │ ├── search-system-object-attribute-groups.full-mode.programmatic.test.js
│ │ │ ├── summarize-logs.full-mode.programmatic.test.js
│ │ │ ├── tools.docs-only.programmatic.test.js
│ │ │ └── tools.full-mode.programmatic.test.js
│ │ ├── README.md
│ │ ├── test-fixtures
│ │ │ └── dw.json
│ │ └── yaml
│ │ ├── activate-code-version.docs-only.test.mcp.yml
│ │ ├── activate-code-version.full-mode.test.mcp.yml
│ │ ├── get_latest_error.test.mcp.yml
│ │ ├── get-available-best-practice-guides.docs-only.test.mcp.yml
│ │ ├── get-available-best-practice-guides.full-mode.test.mcp.yml
│ │ ├── get-available-sfra-documents.docs-only.test.mcp.yml
│ │ ├── get-available-sfra-documents.full-mode.test.mcp.yml
│ │ ├── get-best-practice-guide.docs-only.test.mcp.yml
│ │ ├── get-best-practice-guide.full-mode.test.mcp.yml
│ │ ├── get-code-versions.docs-only.test.mcp.yml
│ │ ├── get-code-versions.full-mode.test.mcp.yml
│ │ ├── get-hook-reference.docs-only.test.mcp.yml
│ │ ├── get-hook-reference.full-mode.test.mcp.yml
│ │ ├── get-job-execution-summary.full-mode.test.mcp.yml
│ │ ├── get-job-log-entries.full-mode.test.mcp.yml
│ │ ├── get-latest-debug.full-mode.test.mcp.yml
│ │ ├── get-latest-error.full-mode.test.mcp.yml
│ │ ├── get-latest-info.full-mode.test.mcp.yml
│ │ ├── get-latest-job-log-files.full-mode.test.mcp.yml
│ │ ├── get-latest-warn.full-mode.test.mcp.yml
│ │ ├── get-log-file-contents.full-mode.test.mcp.yml
│ │ ├── get-sfcc-class-documentation.docs-only.test.mcp.yml
│ │ ├── get-sfcc-class-documentation.full-mode.test.mcp.yml
│ │ ├── get-sfcc-class-info.docs-only.test.mcp.yml
│ │ ├── get-sfcc-class-info.full-mode.test.mcp.yml
│ │ ├── get-sfra-categories.docs-only.test.mcp.yml
│ │ ├── get-sfra-categories.full-mode.test.mcp.yml
│ │ ├── get-sfra-document.docs-only.test.mcp.yml
│ │ ├── get-sfra-document.full-mode.test.mcp.yml
│ │ ├── get-sfra-documents-by-category.docs-only.test.mcp.yml
│ │ ├── get-sfra-documents-by-category.full-mode.test.mcp.yml
│ │ ├── get-system-object-definition.docs-only.test.mcp.yml
│ │ ├── get-system-object-definition.full-mode.test.mcp.yml
│ │ ├── get-system-object-definitions.docs-only.test.mcp.yml
│ │ ├── get-system-object-definitions.full-mode.test.mcp.yml
│ │ ├── list-log-files.full-mode.test.mcp.yml
│ │ ├── list-sfcc-classes.docs-only.test.mcp.yml
│ │ ├── list-sfcc-classes.full-mode.test.mcp.yml
│ │ ├── search-best-practices.docs-only.test.mcp.yml
│ │ ├── search-best-practices.full-mode.test.mcp.yml
│ │ ├── search-custom-object-attribute-definitions.docs-only.test.mcp.yml
│ │ ├── search-custom-object-attribute-definitions.test.mcp.yml
│ │ ├── search-job-logs-by-name.full-mode.test.mcp.yml
│ │ ├── search-job-logs.full-mode.test.mcp.yml
│ │ ├── search-logs.full-mode.test.mcp.yml
│ │ ├── search-sfcc-classes.docs-only.test.mcp.yml
│ │ ├── search-sfcc-classes.full-mode.test.mcp.yml
│ │ ├── search-sfcc-methods.docs-only.test.mcp.yml
│ │ ├── search-sfcc-methods.full-mode.test.mcp.yml
│ │ ├── search-sfra-documentation.docs-only.test.mcp.yml
│ │ ├── search-sfra-documentation.full-mode.test.mcp.yml
│ │ ├── search-site-preferences.docs-only.test.mcp.yml
│ │ ├── search-site-preferences.full-mode.test.mcp.yml
│ │ ├── search-system-object-attribute-definitions.docs-only.test.mcp.yml
│ │ ├── search-system-object-attribute-definitions.full-mode.test.mcp.yml
│ │ ├── search-system-object-attribute-groups.docs-only.test.mcp.yml
│ │ ├── search-system-object-attribute-groups.full-mode.test.mcp.yml
│ │ ├── summarize-logs.full-mode.test.mcp.yml
│ │ ├── tools.docs-only.test.mcp.yml
│ │ └── tools.full-mode.test.mcp.yml
│ ├── oauth-token.test.ts
│ ├── ocapi-auth-client.test.ts
│ ├── ocapi-client.test.ts
│ ├── path-service.test.ts
│ ├── query-builder.test.ts
│ ├── referenced-types-extractor.test.ts
│ ├── servers
│ │ ├── sfcc-mock-server
│ │ │ ├── mock-data
│ │ │ │ └── ocapi
│ │ │ │ ├── code-versions.json
│ │ │ │ ├── custom-object-attributes-customapi.json
│ │ │ │ ├── custom-object-attributes-globalsettings.json
│ │ │ │ ├── custom-object-attributes-versionhistory.json
│ │ │ │ ├── site-preferences-ccv.json
│ │ │ │ ├── site-preferences-fastforward.json
│ │ │ │ ├── site-preferences-sfra.json
│ │ │ │ ├── site-preferences-storefront.json
│ │ │ │ ├── site-preferences-system.json
│ │ │ │ ├── system-object-attribute-groups-campaign.json
│ │ │ │ ├── system-object-attribute-groups-category.json
│ │ │ │ ├── system-object-attribute-groups-order.json
│ │ │ │ ├── system-object-attribute-groups-product.json
│ │ │ │ ├── system-object-attribute-groups-sitepreferences.json
│ │ │ │ ├── system-object-attributes-customeraddress.json
│ │ │ │ ├── system-object-attributes-product-expanded.json
│ │ │ │ ├── system-object-attributes-product.json
│ │ │ │ ├── system-object-definition-category.json
│ │ │ │ ├── system-object-definition-customer.json
│ │ │ │ ├── system-object-definition-customeraddress.json
│ │ │ │ ├── system-object-definition-order.json
│ │ │ │ ├── system-object-definition-product.json
│ │ │ │ ├── system-object-definitions-old.json
│ │ │ │ └── system-object-definitions.json
│ │ │ ├── package-lock.json
│ │ │ ├── package.json
│ │ │ ├── README.md
│ │ │ ├── scripts
│ │ │ │ └── setup-logs.js
│ │ │ ├── server.js
│ │ │ └── src
│ │ │ ├── app.js
│ │ │ ├── config
│ │ │ │ └── server-config.js
│ │ │ ├── middleware
│ │ │ │ ├── auth.js
│ │ │ │ ├── cors.js
│ │ │ │ └── logging.js
│ │ │ ├── routes
│ │ │ │ ├── ocapi
│ │ │ │ │ ├── code-versions-handler.js
│ │ │ │ │ ├── oauth-handler.js
│ │ │ │ │ ├── ocapi-error-utils.js
│ │ │ │ │ ├── ocapi-utils.js
│ │ │ │ │ ├── site-preferences-handler.js
│ │ │ │ │ └── system-objects-handler.js
│ │ │ │ ├── ocapi.js
│ │ │ │ └── webdav.js
│ │ │ └── utils
│ │ │ ├── mock-data-loader.js
│ │ │ └── webdav-xml.js
│ │ └── sfcc-mock-server-manager.ts
│ ├── sfcc-mock-server.test.ts
│ ├── site-preferences-client.test.ts
│ ├── system-objects-client.test.ts
│ ├── utils.test.ts
│ ├── validation-helpers.test.ts
│ └── validator.test.ts
├── tsconfig.json
└── tsconfig.test.json
```
# Files
--------------------------------------------------------------------------------
/docs/dw_order/Order.md:
--------------------------------------------------------------------------------
```markdown
1 | ## Package: dw.order
2 |
3 | # Class Order
4 |
5 | ## Inheritance Hierarchy
6 |
7 | - Object
8 | - dw.object.PersistentObject
9 | - dw.object.ExtensibleObject
10 | - dw.order.LineItemCtnr
11 | - dw.order.Order
12 |
13 | ## Description
14 |
15 | The Order class represents an order. The correct way to retrieve an order is described in OrderMgr.
16 |
17 | ## Constants
18 |
19 | ### CONFIRMATION_STATUS_CONFIRMED
20 |
21 | **Type:** Number = 2
22 |
23 | constant for when Confirmation Status is Confirmed
24 |
25 | ### CONFIRMATION_STATUS_NOTCONFIRMED
26 |
27 | **Type:** Number = 0
28 |
29 | constant for when Confirmation Status is Not Confirmed
30 |
31 | ### ENCRYPTION_ALGORITHM_RSA_ECB_OAEPWITHSHA_256ANDMGF1PADDING
32 |
33 | **Type:** String = "RSA/ECB/OAEPWithSHA-256AndMGF1Padding"
34 |
35 | The encryption algorithm "RSA/ECB/OAEPWithSHA-256AndMGF1Padding".
36 |
37 | ### ENCRYPTION_ALGORITHM_RSA_ECB_PKCS1PADDING
38 |
39 | **Type:** String = "RSA/ECB/PKCS1Padding"
40 |
41 | The outdated encryption algorithm "RSA/ECB/PKCS1Padding". Please do not use anymore!
42 |
43 | ### EXPORT_STATUS_EXPORTED
44 |
45 | **Type:** Number = 1
46 |
47 | constant for when Export Status is Exported
48 |
49 | ### EXPORT_STATUS_FAILED
50 |
51 | **Type:** Number = 3
52 |
53 | constant for when Export Status is Failed
54 |
55 | ### EXPORT_STATUS_NOTEXPORTED
56 |
57 | **Type:** Number = 0
58 |
59 | constant for when Export Status is Not Exported
60 |
61 | ### EXPORT_STATUS_READY
62 |
63 | **Type:** Number = 2
64 |
65 | constant for when Export Status is ready to be exported.
66 |
67 | ### ORDER_STATUS_CANCELLED
68 |
69 | **Type:** Number = 6
70 |
71 | constant for when Order Status is Cancelled
72 |
73 | ### ORDER_STATUS_COMPLETED
74 |
75 | **Type:** Number = 5
76 |
77 | constant for when Order Status is Completed
78 |
79 | ### ORDER_STATUS_CREATED
80 |
81 | **Type:** Number = 0
82 |
83 | constant for when Order Status is Created
84 |
85 | ### ORDER_STATUS_FAILED
86 |
87 | **Type:** Number = 8
88 |
89 | constant for when Order Status is Failed
90 |
91 | ### ORDER_STATUS_NEW
92 |
93 | **Type:** Number = 3
94 |
95 | constant for when Order Status is New
96 |
97 | ### ORDER_STATUS_OPEN
98 |
99 | **Type:** Number = 4
100 |
101 | constant for when Order Status is Open
102 |
103 | ### ORDER_STATUS_REPLACED
104 |
105 | **Type:** Number = 7
106 |
107 | constant for when Order Status is Replaced
108 |
109 | ### PAYMENT_STATUS_NOTPAID
110 |
111 | **Type:** Number = 0
112 |
113 | constant for when Payment Status is Not Paid
114 |
115 | ### PAYMENT_STATUS_PAID
116 |
117 | **Type:** Number = 2
118 |
119 | constant for when Payment Status is Paid
120 |
121 | ### PAYMENT_STATUS_PARTPAID
122 |
123 | **Type:** Number = 1
124 |
125 | constant for when Payment Status is Part Paid
126 |
127 | ### SHIPPING_STATUS_NOTSHIPPED
128 |
129 | **Type:** Number = 0
130 |
131 | constant for when Shipping Status is Not shipped
132 |
133 | ### SHIPPING_STATUS_PARTSHIPPED
134 |
135 | **Type:** Number = 1
136 |
137 | constant for when Shipping Status is Part Shipped
138 |
139 | ### SHIPPING_STATUS_SHIPPED
140 |
141 | **Type:** Number = 2
142 |
143 | constant for when Shipping Status is Shipped
144 |
145 | ## Properties
146 |
147 | ### affiliatePartnerID
148 |
149 | **Type:** String
150 |
151 | The affiliate partner ID value, or null.
152 |
153 | ### affiliatePartnerName
154 |
155 | **Type:** String
156 |
157 | The affiliate partner name value, or null.
158 |
159 | ### appeasementItems
160 |
161 | **Type:** FilteringCollection (Read Only)
162 |
163 | The collection of AppeasementItems associated with this order.
164 |
165 | ### appeasements
166 |
167 | **Type:** FilteringCollection (Read Only)
168 |
169 | The collection of Appeasements associated with this order.
170 |
171 | ### cancelCode
172 |
173 | **Type:** EnumValue
174 |
175 | If this order was cancelled, returns the value of the
176 | cancel code or null.
177 |
178 | ### cancelDescription
179 |
180 | **Type:** String
181 |
182 | If this order was cancelled, returns the text describing why
183 | the order was cancelled or null.
184 |
185 | ### capturedAmount
186 |
187 | **Type:** Money (Read Only)
188 |
189 | The sum of the captured amounts. The captured amounts
190 | are calculated on the fly. Associate a payment capture for an PaymentInstrument with an Invoice
191 | using Invoice.addCaptureTransaction(OrderPaymentInstrument, Money).
192 |
193 | ### confirmationStatus
194 |
195 | **Type:** EnumValue
196 |
197 | The confirmation status of the order.
198 | Possible values are CONFIRMATION_STATUS_NOTCONFIRMED and
199 | CONFIRMATION_STATUS_CONFIRMED.
200 |
201 | ### createdBy
202 |
203 | **Type:** String (Read Only)
204 |
205 | The name of the user who has created the order.
206 | If an agent user has created the order, the agent user's name
207 | is returned. Otherwise "Customer" is returned.
208 |
209 | ### currentOrder
210 |
211 | **Type:** Order (Read Only)
212 |
213 | The current order. The current order
214 | represents the most recent order in a chain of orders.
215 | For example, if Order1 was replaced by Order2, Order2 is the current
216 | representation of the order and Order1 is the original representation
217 | of the order. If you replace Order2 with Order3, Order 3 is now the
218 | current order and Order1 is still the original representation of the
219 | order. If this order has not been replaced, this method returns this
220 | order because this order is the current order.
221 |
222 | ### currentOrderNo
223 |
224 | **Type:** String (Read Only)
225 |
226 | The order number of the current order. The current order
227 | represents the most recent order in a chain of orders.
228 | For example, if Order1 was replaced by Order2, Order2 is the current
229 | representation of the order and Order1 is the original representation
230 | of the order. If you replace Order2 with Order3, Order 3 is now the
231 | current order and Order1 is still the original representation of the
232 | order. If this order has not been replaced, calling this method returns the
233 | same value as the getOrderNo() method because this order is the
234 | current order.
235 |
236 | ### customerLocaleID
237 |
238 | **Type:** String (Read Only)
239 |
240 | The ID of the locale that was in effect when the order
241 | was placed. This is the customer's locale.
242 |
243 | ### customerOrderReference
244 |
245 | **Type:** String
246 |
247 | The customer-specific reference information for the order, or null.
248 |
249 | ### exportAfter
250 |
251 | **Type:** Date
252 |
253 | A date after which an order can be exported.
254 |
255 | ### exportStatus
256 |
257 | **Type:** EnumValue
258 |
259 | The export status of the order.
260 | Possible values are: EXPORT_STATUS_NOTEXPORTED,
261 | EXPORT_STATUS_EXPORTED, EXPORT_STATUS_READY,
262 | and EXPORT_STATUS_FAILED.
263 |
264 | ### externalOrderNo
265 |
266 | **Type:** String
267 |
268 | The value of an external order number associated
269 | with this order, or null.
270 |
271 | ### externalOrderStatus
272 |
273 | **Type:** String
274 |
275 | The status of an external order associated
276 | with this order, or null.
277 |
278 | ### externalOrderText
279 |
280 | **Type:** String
281 |
282 | The text describing the external order, or null.
283 |
284 | ### globalPartyID
285 |
286 | **Type:** String (Read Only)
287 |
288 | The Global Party ID reconciles customer identity across multiple systems. For example, as part of the Service for
289 | Commerce experience, service agents can find information for customers who have never called into the call
290 | center, but have created a profile on the website. Service agents can find guest order data from B2C Commerce and
291 | easily create accounts for customers. Customer 360 Data Manager matches records from multiple data sources to
292 | determine all the records associated with a specific customer.
293 |
294 | ### imported
295 |
296 | **Type:** boolean (Read Only)
297 |
298 | Returns true, if the order is imported and false
299 | otherwise.
300 |
301 | ### invoiceItems
302 |
303 | **Type:** FilteringCollection (Read Only)
304 |
305 | The collection of InvoiceItems associated with this order.
306 |
307 | Order post-processing APIs (gillian) are now inactive by default and will throw
308 | an exception if accessed. Activation needs preliminary approval by Product Management.
309 | Please contact support in this case. Existing customers using these APIs are not
310 | affected by this change and can use the APIs until further notice.
311 |
312 | ### invoiceNo
313 |
314 | **Type:** String
315 |
316 | The invoice number for this Order.
317 |
318 | When an order is placed (e.g. with OrderMgr.placeOrder(Order)) invoice number will be filled
319 | using a sequence. Before order was placed null will be returned unless it was set with
320 | setInvoiceNo(String).
321 |
322 | ### invoices
323 |
324 | **Type:** FilteringCollection (Read Only)
325 |
326 | The collection of Invoices associated with this order.
327 |
328 | Order post-processing APIs (gillian) are now inactive by default and will throw
329 | an exception if accessed. Activation needs preliminary approval by Product Management.
330 | Please contact support in this case. Existing customers using these APIs are not
331 | affected by this change and can use the APIs until further notice.
332 |
333 | ### orderExportXML
334 |
335 | **Type:** String (Read Only)
336 |
337 | The order export XML as String object.
338 |
339 | NOTE: This method will return payment instrument data masked. If payment instrument re-encryption is needed
340 | please use getOrderExportXML(String, String) instead.
341 |
342 | Example:
343 |
344 | var orderXMLAsString : String = order.getOrderExportXML();
345 | var orderXML : XML = new XML(orderXMLAsString);
346 |
347 | ### orderNo
348 |
349 | **Type:** String (Read Only)
350 |
351 | The order number for this order.
352 |
353 | ### orderToken
354 |
355 | **Type:** String (Read Only)
356 |
357 | The token for this order. The order token is a string (length 32 bytes) associated
358 | with this one order. The order token is random. It reduces the capability of malicious
359 | users to access an order through guessing. Order token can be used to further validate order
360 | ownership, but should never be used to solely validate ownership. In addition, the storefront
361 | should ensure authentication and authorization. See the Security Best Practices for Developers for details.
362 |
363 | ### originalOrder
364 |
365 | **Type:** Order (Read Only)
366 |
367 | The original order associated with
368 | this order. The original order represents an order that was the
369 | first ancestor in a chain of orders.
370 | For example, if Order1 was replaced by Order2, Order2 is the current
371 | representation of the order and Order1 is the original representation
372 | of the order. If you replace Order2 with Order3, Order1 is still the
373 | original representation of the order. If this order is the first
374 | ancestor, this method returns this order.
375 |
376 | ### originalOrderNo
377 |
378 | **Type:** String (Read Only)
379 |
380 | The order number of the original order associated with
381 | this order. The original order represents an order that was the
382 | first ancestor in a chain of orders.
383 | For example, if Order1 was replaced by Order2, Order2 is the current
384 | representation of the order and Order1 is the original representation
385 | of the order. If you replace Order2 with Order3, Order1 is still the
386 | original representation of the order. If this order is the first
387 | ancestor, this method returns the value of getOrderNo().
388 |
389 | ### paymentStatus
390 |
391 | **Type:** EnumValue
392 |
393 | The order payment status value.
394 | Possible values are PAYMENT_STATUS_NOTPAID, PAYMENT_STATUS_PARTPAID
395 | or PAYMENT_STATUS_PAID.
396 |
397 | ### paymentTransaction
398 |
399 | **Type:** PaymentTransaction (Read Only)
400 |
401 | The payment transaction associated with this order.
402 | It is possible that there are multiple payment transactions
403 | associated with the order. In this case, this method returns
404 | the transaction associated with the first PaymentInstrument
405 | returned by getPaymentInstruments().
406 |
407 | ### refundedAmount
408 |
409 | **Type:** Money (Read Only)
410 |
411 | The sum of the refunded amounts. The refunded amounts are
412 | calculated on the fly. Associate a payment refund for an PaymentInstrument with an Invoice
413 | using Invoice.addRefundTransaction(OrderPaymentInstrument, Money).
414 |
415 | ### remoteHost
416 |
417 | **Type:** String (Read Only)
418 |
419 | The IP address of the remote host from which the order was created.
420 |
421 | If the IP address was not captured for the order because order IP logging
422 | was disabled at the time the order was created, null will be returned.
423 |
424 | ### replaceCode
425 |
426 | **Type:** EnumValue
427 |
428 | If this order was replaced by another order,
429 | returns the value of the replace code. Otherwise.
430 | returns null.
431 |
432 | ### replaceDescription
433 |
434 | **Type:** String
435 |
436 | If this order was replaced by another order,
437 | returns the value of the replace description. Otherwise
438 | returns null.
439 |
440 | ### replacedOrder
441 |
442 | **Type:** Order (Read Only)
443 |
444 | The order that this order replaced or null. For example, if you
445 | have three orders where Order1 was replaced by Order2 and Order2 was
446 | replaced by Order3, calling this method on Order3 will return Order2.
447 | Similarly, calling this method on Order1 will return null as Order1 was
448 | the original order.
449 |
450 | ### replacedOrderNo
451 |
452 | **Type:** String (Read Only)
453 |
454 | The order number that this order replaced or null if this order
455 | did not replace an order. For example, if you have three orders
456 | where Order1 was replaced by Order2 and Order2 was replaced by Order3,
457 | calling this method on Order3 will return the order number for
458 | Order2. Similarly, calling this method on Order1 will return null as
459 | Order1 was the original order.
460 |
461 | ### replacementOrder
462 |
463 | **Type:** Order (Read Only)
464 |
465 | The order that replaced this order, or null.
466 |
467 | ### replacementOrderNo
468 |
469 | **Type:** String (Read Only)
470 |
471 | If this order was replaced by another order,
472 | returns the order number that replaced this order. Otherwise
473 | returns null.
474 |
475 | ### returnCaseItems
476 |
477 | **Type:** FilteringCollection (Read Only)
478 |
479 | The collection of ReturnCaseItems associated with this order.
480 |
481 | Order post-processing APIs (gillian) are now inactive by default and will throw
482 | an exception if accessed. Activation needs preliminary approval by Product Management.
483 | Please contact support in this case. Existing customers using these APIs are not
484 | affected by this change and can use the APIs until further notice.
485 |
486 | ### returnCases
487 |
488 | **Type:** FilteringCollection (Read Only)
489 |
490 | The collection of ReturnCases associated with this order.
491 |
492 | Order post-processing APIs (gillian) are now inactive by default and will throw
493 | an exception if accessed. Activation needs preliminary approval by Product Management.
494 | Please contact support in this case. Existing customers using these APIs are not
495 | affected by this change and can use the APIs until further notice.
496 |
497 | ### returnItems
498 |
499 | **Type:** FilteringCollection (Read Only)
500 |
501 | The collection of ReturnItems associated with this order.
502 |
503 | Order post-processing APIs (gillian) are now inactive by default and will throw
504 | an exception if accessed. Activation needs preliminary approval by Product Management.
505 | Please contact support in this case. Existing customers using these APIs are not
506 | affected by this change and can use the APIs until further notice.
507 |
508 | ### returns
509 |
510 | **Type:** FilteringCollection (Read Only)
511 |
512 | The collection of Returns associated with this order.
513 |
514 | Order post-processing APIs (gillian) are now inactive by default and will throw
515 | an exception if accessed. Activation needs preliminary approval by Product Management.
516 | Please contact support in this case. Existing customers using these APIs are not
517 | affected by this change and can use the APIs until further notice.
518 |
519 | ### shippingOrderItems
520 |
521 | **Type:** FilteringCollection (Read Only)
522 |
523 | The collection of ShippingOrderItems associated with this order.
524 |
525 | Order post-processing APIs (gillian) are now inactive by default and will throw
526 | an exception if accessed. Activation needs preliminary approval by Product Management.
527 | Please contact support in this case. Existing customers using these APIs are not
528 | affected by this change and can use the APIs until further notice.
529 |
530 | ### shippingOrders
531 |
532 | **Type:** FilteringCollection (Read Only)
533 |
534 | The collection of ShippingOrders associated with this order.
535 |
536 | Order post-processing APIs (gillian) are now inactive by default and will throw
537 | an exception if accessed. Activation needs preliminary approval by Product Management.
538 | Please contact support in this case. Existing customers using these APIs are not
539 | affected by this change and can use the APIs until further notice.
540 |
541 | ### shippingStatus
542 |
543 | **Type:** EnumValue
544 |
545 | The order shipping status.
546 | Possible values are SHIPPING_STATUS_NOTSHIPPED,
547 | SHIPPING_STATUS_PARTSHIPPED or SHIPPING_STATUS_SHIPPED.
548 |
549 | ### sourceCode
550 |
551 | **Type:** String (Read Only)
552 |
553 | The source code stored with the order or null if no source code is attached to the order.
554 |
555 | ### sourceCodeGroup
556 |
557 | **Type:** SourceCodeGroup (Read Only)
558 |
559 | The source code group attached to the order or null if no source code group is attached to
560 | the order.
561 |
562 | ### sourceCodeGroupID
563 |
564 | **Type:** String (Read Only)
565 |
566 | The source code group id stored with the order or null if no source code group is attached
567 | to the order.
568 |
569 | ### status
570 |
571 | **Type:** EnumValue
572 |
573 | The status of the order.
574 | Possible values are:
575 |
576 | ORDER_STATUS_CREATED
577 | ORDER_STATUS_NEW
578 | ORDER_STATUS_OPEN
579 | ORDER_STATUS_COMPLETED
580 | ORDER_STATUS_CANCELLED
581 | ORDER_STATUS_FAILED
582 | ORDER_STATUS_REPLACED
583 |
584 |
585 | The order status usually changes when a process action is initiated. Most status changes have an action which
586 | needs to executed in order to end having the order in a specific order status. When an order is created with e.g.
587 | OrderMgr.createOrder(Basket) the order status will be ORDER_STATUS_CREATED. The usual
588 | flow is that payment authorization will be added to the order. Once the order is considered as valid (payed,
589 | fraud checked, ...) the order gets placed. This can be done by calling
590 | OrderMgr.placeOrder(Order). The result of placing an order will be status
591 | ORDER_STATUS_OPEN (from a process standpoint ORDER_STATUS_NEW which has the same meaning).
592 | Status ORDER_STATUS_REPLACED is related to functionality
593 | BasketMgr.createBasketFromOrder(Order). ORDER_STATUS_COMPLETED has no meaning by
594 | default but can be used by custom implementations but is a synonym for NEW/OPEN. Below you will find the most important status changes:
595 |
596 |
597 |
598 | Status beforeActionStatus afterBusiness meaning
599 | -OrderMgr.createOrder(Basket)CREATEDOrder was created from a basket.
600 | CREATEDOrderMgr.placeOrder(Order)OPEN/NEWOrder was considered as valid. Order can now be exported to 3rd party systems.
601 | CREATEDOrderMgr.failOrder(Order)FAILEDOrder was considered not valid. E.g. payment authorization was wrong or fraud check was not successful.
602 | OPEN/NEWOrderMgr.cancelOrder(Order)CANCELLEDOrder was cancelled.
603 | CANCELLEDOrderMgr.undoCancelOrder(Order)OPEN/NEWOrder was cancelled by mistake and this needs to be undone.
604 | FAILEDOrderMgr.undoFailOrder(Order)CREATEDOrder was failed by mistake and this needs to be undone.
605 |
606 | Every status change will trigger a change in the order journal which is the base for GMV calculations.
607 |
608 | ### taxRoundedAtGroup
609 |
610 | **Type:** boolean (Read Only)
611 |
612 | Use this method to check if the Order was created with grouped taxation calculation.
613 |
614 | If the tax is rounded on group level, the tax is applied to the summed-up tax basis for each tax rate.
615 |
616 | ## Constructor Summary
617 |
618 | ## Method Summary
619 |
620 | ### createAppeasement
621 |
622 | **Signature:** `createAppeasement(appeasementNumber : String) : Appeasement`
623 |
624 | Creates a new Appeasement associated with this order.
625 |
626 | ### createAppeasement
627 |
628 | **Signature:** `createAppeasement() : Appeasement`
629 |
630 | Creates a new Appeasement associated with this order.
631 |
632 | ### createReturnCase
633 |
634 | **Signature:** `createReturnCase(returnCaseNumber : String, isRMA : boolean) : ReturnCase`
635 |
636 | Creates a new ReturnCase associated with this order specifying whether the ReturnCase is an RMA (return merchandise authorization).
637 |
638 | ### createReturnCase
639 |
640 | **Signature:** `createReturnCase(isRMA : boolean) : ReturnCase`
641 |
642 | Creates a new ReturnCase associated with this order specifying whether the ReturnCase is an RMA (return merchandise authorization).
643 |
644 | ### createServiceItem
645 |
646 | **Signature:** `createServiceItem(ID : String, status : String) : OrderItem`
647 |
648 | Returns the order item with the given status which wraps a new service item which is created and added to the order.
649 |
650 | ### createShippingOrder
651 |
652 | **Signature:** `createShippingOrder() : ShippingOrder`
653 |
654 | Creates a new ShippingOrder for this order.
655 |
656 | ### createShippingOrder
657 |
658 | **Signature:** `createShippingOrder(shippingOrderNumber : String) : ShippingOrder`
659 |
660 | Creates a new ShippingOrder for this order.
661 |
662 | ### getAffiliatePartnerID
663 |
664 | **Signature:** `getAffiliatePartnerID() : String`
665 |
666 | Returns the affiliate partner ID value, or null.
667 |
668 | ### getAffiliatePartnerName
669 |
670 | **Signature:** `getAffiliatePartnerName() : String`
671 |
672 | Returns the affiliate partner name value, or null.
673 |
674 | ### getAppeasement
675 |
676 | **Signature:** `getAppeasement(appeasementNumber : String) : Appeasement`
677 |
678 | Returns the Appeasement associated with this order with the given appeasementNumber.
679 |
680 | ### getAppeasementItem
681 |
682 | **Signature:** `getAppeasementItem(appeasementItemID : String) : AppeasementItem`
683 |
684 | Returns the AppeasementItem associated with this Order with the given appeasementItemID.
685 |
686 | ### getAppeasementItems
687 |
688 | **Signature:** `getAppeasementItems() : FilteringCollection`
689 |
690 | Returns the collection of AppeasementItems associated with this order.
691 |
692 | ### getAppeasements
693 |
694 | **Signature:** `getAppeasements() : FilteringCollection`
695 |
696 | Returns the collection of Appeasements associated with this order.
697 |
698 | ### getCancelCode
699 |
700 | **Signature:** `getCancelCode() : EnumValue`
701 |
702 | If this order was cancelled, returns the value of the cancel code or null.
703 |
704 | ### getCancelDescription
705 |
706 | **Signature:** `getCancelDescription() : String`
707 |
708 | If this order was cancelled, returns the text describing why the order was cancelled or null.
709 |
710 | ### getCapturedAmount
711 |
712 | **Signature:** `getCapturedAmount() : Money`
713 |
714 | Returns the sum of the captured amounts.
715 |
716 | ### getConfirmationStatus
717 |
718 | **Signature:** `getConfirmationStatus() : EnumValue`
719 |
720 | Returns the confirmation status of the order. Possible values are CONFIRMATION_STATUS_NOTCONFIRMED and CONFIRMATION_STATUS_CONFIRMED.
721 |
722 | ### getCreatedBy
723 |
724 | **Signature:** `getCreatedBy() : String`
725 |
726 | Returns the name of the user who has created the order.
727 |
728 | ### getCurrentOrder
729 |
730 | **Signature:** `getCurrentOrder() : Order`
731 |
732 | Returns the current order.
733 |
734 | ### getCurrentOrderNo
735 |
736 | **Signature:** `getCurrentOrderNo() : String`
737 |
738 | Returns the order number of the current order.
739 |
740 | ### getCustomerLocaleID
741 |
742 | **Signature:** `getCustomerLocaleID() : String`
743 |
744 | Returns the ID of the locale that was in effect when the order was placed.
745 |
746 | ### getCustomerOrderReference
747 |
748 | **Signature:** `getCustomerOrderReference() : String`
749 |
750 | Returns the customer-specific reference information for the order, or null.
751 |
752 | ### getExportAfter
753 |
754 | **Signature:** `getExportAfter() : Date`
755 |
756 | Returns a date after which an order can be exported.
757 |
758 | ### getExportStatus
759 |
760 | **Signature:** `getExportStatus() : EnumValue`
761 |
762 | Returns the export status of the order. Possible values are: EXPORT_STATUS_NOTEXPORTED, EXPORT_STATUS_EXPORTED, EXPORT_STATUS_READY, and EXPORT_STATUS_FAILED.
763 |
764 | ### getExternalOrderNo
765 |
766 | **Signature:** `getExternalOrderNo() : String`
767 |
768 | Returns the value of an external order number associated with this order, or null.
769 |
770 | ### getExternalOrderStatus
771 |
772 | **Signature:** `getExternalOrderStatus() : String`
773 |
774 | Returns the status of an external order associated with this order, or null.
775 |
776 | ### getExternalOrderText
777 |
778 | **Signature:** `getExternalOrderText() : String`
779 |
780 | Returns the text describing the external order, or null.
781 |
782 | ### getGlobalPartyID
783 |
784 | **Signature:** `getGlobalPartyID() : String`
785 |
786 | The Global Party ID reconciles customer identity across multiple systems.
787 |
788 | ### getInvoice
789 |
790 | **Signature:** `getInvoice(invoiceNumber : String) : Invoice`
791 |
792 | Returns the Invoice associated with this order with the given invoiceNumber.
793 |
794 | ### getInvoiceItem
795 |
796 | **Signature:** `getInvoiceItem(invoiceItemID : String) : InvoiceItem`
797 |
798 | Returns the InvoiceItem associated with this order with the given ID.
799 |
800 | ### getInvoiceItems
801 |
802 | **Signature:** `getInvoiceItems() : FilteringCollection`
803 |
804 | Returns the collection of InvoiceItems associated with this order.
805 |
806 | ### getInvoiceNo
807 |
808 | **Signature:** `getInvoiceNo() : String`
809 |
810 | Returns the invoice number for this Order.
811 |
812 | ### getInvoices
813 |
814 | **Signature:** `getInvoices() : FilteringCollection`
815 |
816 | Returns the collection of Invoices associated with this order.
817 |
818 | ### getOrderExportXML
819 |
820 | **Signature:** `getOrderExportXML() : String`
821 |
822 | Returns the order export XML as String object.
823 |
824 | ### getOrderExportXML
825 |
826 | **Signature:** `getOrderExportXML(encryptionAlgorithm : String, encryptionKey : String) : String`
827 |
828 | Returns the order export XML as String object, with payment instrument data re-encrypted using the given encryption algorithm and key.
829 |
830 | ### getOrderExportXML
831 |
832 | **Signature:** `getOrderExportXML(encryptionAlgorithm : String, encryptionKey : String, encryptUsingEKID : boolean) : String`
833 |
834 | Returns the order export XML as String object, with payment instrument data re-encrypted using the given encryption algorithm and key.
835 |
836 | ### getOrderExportXML
837 |
838 | **Signature:** `getOrderExportXML(encryptionAlgorithm : String, encryptionKey : String) : String`
839 |
840 | Returns the order export XML as String object, with payment instrument data re-encrypted using the given encryption algorithm and key.
841 |
842 | ### getOrderItem
843 |
844 | **Signature:** `getOrderItem(itemID : String) : OrderItem`
845 |
846 | Returns the OrderItem for the itemID.
847 |
848 | ### getOrderNo
849 |
850 | **Signature:** `getOrderNo() : String`
851 |
852 | Returns the order number for this order.
853 |
854 | ### getOrderToken
855 |
856 | **Signature:** `getOrderToken() : String`
857 |
858 | Returns the token for this order.
859 |
860 | ### getOriginalOrder
861 |
862 | **Signature:** `getOriginalOrder() : Order`
863 |
864 | Returns the original order associated with this order.
865 |
866 | ### getOriginalOrderNo
867 |
868 | **Signature:** `getOriginalOrderNo() : String`
869 |
870 | Returns the order number of the original order associated with this order.
871 |
872 | ### getPaymentStatus
873 |
874 | **Signature:** `getPaymentStatus() : EnumValue`
875 |
876 | Returns the order payment status value. Possible values are PAYMENT_STATUS_NOTPAID, PAYMENT_STATUS_PARTPAID or PAYMENT_STATUS_PAID.
877 |
878 | ### getPaymentTransaction
879 |
880 | **Signature:** `getPaymentTransaction() : PaymentTransaction`
881 |
882 | Returns the payment transaction associated with this order.
883 |
884 | ### getRefundedAmount
885 |
886 | **Signature:** `getRefundedAmount() : Money`
887 |
888 | Returns the sum of the refunded amounts.
889 |
890 | ### getRemoteHost
891 |
892 | **Signature:** `getRemoteHost() : String`
893 |
894 | Returns the IP address of the remote host from which the order was created.
895 |
896 | ### getReplaceCode
897 |
898 | **Signature:** `getReplaceCode() : EnumValue`
899 |
900 | If this order was replaced by another order, returns the value of the replace code.
901 |
902 | ### getReplaceDescription
903 |
904 | **Signature:** `getReplaceDescription() : String`
905 |
906 | If this order was replaced by another order, returns the value of the replace description.
907 |
908 | ### getReplacedOrder
909 |
910 | **Signature:** `getReplacedOrder() : Order`
911 |
912 | Returns the order that this order replaced or null.
913 |
914 | ### getReplacedOrderNo
915 |
916 | **Signature:** `getReplacedOrderNo() : String`
917 |
918 | Returns the order number that this order replaced or null if this order did not replace an order.
919 |
920 | ### getReplacementOrder
921 |
922 | **Signature:** `getReplacementOrder() : Order`
923 |
924 | Returns the order that replaced this order, or null.
925 |
926 | ### getReplacementOrderNo
927 |
928 | **Signature:** `getReplacementOrderNo() : String`
929 |
930 | If this order was replaced by another order, returns the order number that replaced this order.
931 |
932 | ### getReturn
933 |
934 | **Signature:** `getReturn(returnNumber : String) : Return`
935 |
936 | Returns the Return associated with this order with the given returnNumber.
937 |
938 | ### getReturnCase
939 |
940 | **Signature:** `getReturnCase(returnCaseNumber : String) : ReturnCase`
941 |
942 | Returns the ReturnCase associated with this order with the given returnCaseNumber.
943 |
944 | ### getReturnCaseItem
945 |
946 | **Signature:** `getReturnCaseItem(returnCaseItemID : String) : ReturnCaseItem`
947 |
948 | Returns the ReturnCaseItem associated with this order with the given returnCaseItemID.
949 |
950 | ### getReturnCaseItems
951 |
952 | **Signature:** `getReturnCaseItems() : FilteringCollection`
953 |
954 | Returns the collection of ReturnCaseItems associated with this order.
955 |
956 | ### getReturnCases
957 |
958 | **Signature:** `getReturnCases() : FilteringCollection`
959 |
960 | Returns the collection of ReturnCases associated with this order.
961 |
962 | ### getReturnItem
963 |
964 | **Signature:** `getReturnItem(returnItemID : String) : ReturnItem`
965 |
966 | Returns the ReturnItem associated with this order with the given ID.
967 |
968 | ### getReturnItems
969 |
970 | **Signature:** `getReturnItems() : FilteringCollection`
971 |
972 | Returns the collection of ReturnItems associated with this order.
973 |
974 | ### getReturns
975 |
976 | **Signature:** `getReturns() : FilteringCollection`
977 |
978 | Returns the collection of Returns associated with this order.
979 |
980 | ### getShippingOrder
981 |
982 | **Signature:** `getShippingOrder(shippingOrderNumber : String) : ShippingOrder`
983 |
984 | Returns the ShippingOrder associated with this order with the given shippingOrderNumber.
985 |
986 | ### getShippingOrderItem
987 |
988 | **Signature:** `getShippingOrderItem(shippingOrderItemID : String) : ShippingOrderItem`
989 |
990 | Returns the ShippingOrderItem associated with this order with the given shippingOrderItemID.
991 |
992 | ### getShippingOrderItems
993 |
994 | **Signature:** `getShippingOrderItems() : FilteringCollection`
995 |
996 | Returns the collection of ShippingOrderItems associated with this order.
997 |
998 | ### getShippingOrders
999 |
1000 | **Signature:** `getShippingOrders() : FilteringCollection`
1001 |
1002 | Returns the collection of ShippingOrders associated with this order.
1003 |
1004 | ### getShippingStatus
1005 |
1006 | **Signature:** `getShippingStatus() : EnumValue`
1007 |
1008 | Returns the order shipping status. Possible values are SHIPPING_STATUS_NOTSHIPPED, SHIPPING_STATUS_PARTSHIPPED or SHIPPING_STATUS_SHIPPED.
1009 |
1010 | ### getSourceCode
1011 |
1012 | **Signature:** `getSourceCode() : String`
1013 |
1014 | Returns the source code stored with the order or null if no source code is attached to the order.
1015 |
1016 | ### getSourceCodeGroup
1017 |
1018 | **Signature:** `getSourceCodeGroup() : SourceCodeGroup`
1019 |
1020 | Returns the source code group attached to the order or null if no source code group is attached to the order.
1021 |
1022 | ### getSourceCodeGroupID
1023 |
1024 | **Signature:** `getSourceCodeGroupID() : String`
1025 |
1026 | Returns the source code group id stored with the order or null if no source code group is attached to the order.
1027 |
1028 | ### getStatus
1029 |
1030 | **Signature:** `getStatus() : EnumValue`
1031 |
1032 | Returns the status of the order. Possible values are: ORDER_STATUS_CREATED ORDER_STATUS_NEW ORDER_STATUS_OPEN ORDER_STATUS_COMPLETED ORDER_STATUS_CANCELLED ORDER_STATUS_FAILED ORDER_STATUS_REPLACED
1033 |
1034 | ### isImported
1035 |
1036 | **Signature:** `isImported() : boolean`
1037 |
1038 | Returns true, if the order is imported and false otherwise.
1039 |
1040 | ### isTaxRoundedAtGroup
1041 |
1042 | **Signature:** `isTaxRoundedAtGroup() : boolean`
1043 |
1044 | Use this method to check if the Order was created with grouped taxation calculation.
1045 |
1046 | ### reauthorize
1047 |
1048 | **Signature:** `reauthorize() : Status`
1049 |
1050 | Ensures that the order is authorized.
1051 |
1052 | ### removeRemoteHost
1053 |
1054 | **Signature:** `removeRemoteHost() : void`
1055 |
1056 | Removes the IP address of the remote host if stored.
1057 |
1058 | ### setAffiliatePartnerID
1059 |
1060 | **Signature:** `setAffiliatePartnerID(affiliatePartnerID : String) : void`
1061 |
1062 | Sets the affiliate partner ID value.
1063 |
1064 | ### setAffiliatePartnerName
1065 |
1066 | **Signature:** `setAffiliatePartnerName(affiliatePartnerName : String) : void`
1067 |
1068 | Sets the affiliate partner name value.
1069 |
1070 | ### setCancelCode
1071 |
1072 | **Signature:** `setCancelCode(cancelCode : String) : void`
1073 |
1074 | Sets the cancel code value.
1075 |
1076 | ### setCancelDescription
1077 |
1078 | **Signature:** `setCancelDescription(cancelDescription : String) : void`
1079 |
1080 | Sets the description as to why the order was cancelled.
1081 |
1082 | ### setConfirmationStatus
1083 |
1084 | **Signature:** `setConfirmationStatus(status : Number) : void`
1085 |
1086 | Sets the confirmation status value. Possible values are CONFIRMATION_STATUS_NOTCONFIRMED or CONFIRMATION_STATUS_CONFIRMED.
1087 |
1088 | ### setCustomer
1089 |
1090 | **Signature:** `setCustomer(customer : Customer) : void`
1091 |
1092 | This method is used to associate the order object with the specified customer object.
1093 |
1094 | ### setCustomerNo
1095 |
1096 | **Signature:** `setCustomerNo(customerNo : String) : void`
1097 |
1098 | Sets the customer number associated with this order.
1099 |
1100 | ### setCustomerOrderReference
1101 |
1102 | **Signature:** `setCustomerOrderReference(reference : String) : void`
1103 |
1104 | Sets the customer-specific reference information for the order.
1105 |
1106 | ### setExportAfter
1107 |
1108 | **Signature:** `setExportAfter(date : Date) : void`
1109 |
1110 | Sets the date after which an order can be exported.
1111 |
1112 | ### setExportStatus
1113 |
1114 | **Signature:** `setExportStatus(status : Number) : void`
1115 |
1116 | Sets the export status of the order. Possible values are: EXPORT_STATUS_NOTEXPORTED, EXPORT_STATUS_EXPORTED, EXPORT_STATUS_READY, and EXPORT_STATUS_FAILED.
1117 |
1118 | ### setExternalOrderNo
1119 |
1120 | **Signature:** `setExternalOrderNo(externalOrderNo : String) : void`
1121 |
1122 | Sets the value of an external order number associated with this order
1123 |
1124 | ### setExternalOrderStatus
1125 |
1126 | **Signature:** `setExternalOrderStatus(status : String) : void`
1127 |
1128 | Sets the status of an external order associated with this order
1129 |
1130 | ### setExternalOrderText
1131 |
1132 | **Signature:** `setExternalOrderText(text : String) : void`
1133 |
1134 | Sets the text describing the external order.
1135 |
1136 | ### setInvoiceNo
1137 |
1138 | **Signature:** `setInvoiceNo(invoiceNumber : String) : void`
1139 |
1140 | Sets the invoice number for this Order.
1141 |
1142 | ### setOrderStatus
1143 |
1144 | **Signature:** `setOrderStatus(status : Number) : void`
1145 |
1146 | Sets the order status.
1147 |
1148 | ### setPaymentStatus
1149 |
1150 | **Signature:** `setPaymentStatus(status : Number) : void`
1151 |
1152 | Sets the order payment status. Possible values are PAYMENT_STATUS_NOTPAID, PAYMENT_STATUS_PARTPAID or PAYMENT_STATUS_PAID.
1153 |
1154 | ### setReplaceCode
1155 |
1156 | **Signature:** `setReplaceCode(replaceCode : String) : void`
1157 |
1158 | Sets the value of the replace code.
1159 |
1160 | ### setReplaceDescription
1161 |
1162 | **Signature:** `setReplaceDescription(replaceDescription : String) : void`
1163 |
1164 | Sets the value of the replace description.
1165 |
1166 | ### setShippingStatus
1167 |
1168 | **Signature:** `setShippingStatus(status : Number) : void`
1169 |
1170 | Sets the order shipping status value. Possible values are SHIPPING_STATUS_NOTSHIPPED, SHIPPING_STATUS_PARTSHIPPED or SHIPPING_STATUS_SHIPPED.
1171 |
1172 | ### setStatus
1173 |
1174 | **Signature:** `setStatus(status : Number) : void`
1175 |
1176 | Sets the status of the order.
1177 |
1178 | ### trackOrderChange
1179 |
1180 | **Signature:** `trackOrderChange(text : String) : Note`
1181 |
1182 | Tracks an order change.
1183 |
1184 | ## Method Detail
1185 |
1186 | ## Method Details
1187 |
1188 | ### createAppeasement
1189 |
1190 | **Signature:** `createAppeasement(appeasementNumber : String) : Appeasement`
1191 |
1192 | **Description:** Creates a new Appeasement associated with this order. An appeasementNumber must be specified. If an Appeasement already exists for the appeasementNumber, the method fails with an exception. 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.
1193 |
1194 | **Parameters:**
1195 |
1196 | - `appeasementNumber`: the appeasementNumber to be assigned to the newly created appeasement
1197 |
1198 | **Returns:**
1199 |
1200 | the created appeasement
1201 |
1202 | **Throws:**
1203 |
1204 | IllegalArgumentException - if an Appeasement already exists with the number.
1205 |
1206 | ---
1207 |
1208 | ### createAppeasement
1209 |
1210 | **Signature:** `createAppeasement() : Appeasement`
1211 |
1212 | **Description:** Creates a new Appeasement associated with this order. The new Appeasement will have an appeasementNumber based on the getOrderNo(). 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.
1213 |
1214 | **Returns:**
1215 |
1216 | the created appeasement
1217 |
1218 | ---
1219 |
1220 | ### createReturnCase
1221 |
1222 | **Signature:** `createReturnCase(returnCaseNumber : String, isRMA : boolean) : ReturnCase`
1223 |
1224 | **Description:** Creates a new ReturnCase associated with this order specifying whether the ReturnCase is an RMA (return merchandise authorization). A returnCaseNumber must be specified. If a ReturnCase already exists for the returnCaseNumber, the method fails with an exception. 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.
1225 |
1226 | **Parameters:**
1227 |
1228 | - `returnCaseNumber`: returnCaseNumber to use
1229 | - `isRMA`: whether the new ReturnCase is an RMA (return merchandise authorization)
1230 |
1231 | **Returns:**
1232 |
1233 | null or the ReturnCase associated with the given returnCaseNumber
1234 |
1235 | **Throws:**
1236 |
1237 | IllegalArgumentException - if a ReturnCase already exists with the number.
1238 |
1239 | ---
1240 |
1241 | ### createReturnCase
1242 |
1243 | **Signature:** `createReturnCase(isRMA : boolean) : ReturnCase`
1244 |
1245 | **Description:** Creates a new ReturnCase associated with this order specifying whether the ReturnCase is an RMA (return merchandise authorization). The new ReturnCase will have a returnCaseNumber based on the getOrderNo(), e.g. for an order-no 1234 the return cases will have the numbers 1234#RC1, 1234#RC2, 1234#RC3... 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.
1246 |
1247 | **Parameters:**
1248 |
1249 | - `isRMA`: whether the new ReturnCase is an RMA (return merchandise authorization)
1250 |
1251 | **Returns:**
1252 |
1253 | the created ReturnCase
1254 |
1255 | ---
1256 |
1257 | ### createServiceItem
1258 |
1259 | **Signature:** `createServiceItem(ID : String, status : String) : OrderItem`
1260 |
1261 | **Description:** Returns the order item with the given status which wraps a new service item which is created and added to the order.
1262 |
1263 | **Parameters:**
1264 |
1265 | - `ID`: the ID of the new service item. This ID will be returned when ShippingLineItem.getID() is called.
1266 | - `status`: the status of the order item, use one of OrderItem.STATUS_NEW OrderItem.STATUS_OPEN OrderItem.STATUS_SHIPPED 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.
1267 |
1268 | **Returns:**
1269 |
1270 | the created order item
1271 |
1272 | ---
1273 |
1274 | ### createShippingOrder
1275 |
1276 | **Signature:** `createShippingOrder() : ShippingOrder`
1277 |
1278 | **Description:** Creates a new ShippingOrder for this order. Generates a default shipping order number. Use createShippingOrder(String) for a defined shipping order number. 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.
1279 |
1280 | **Returns:**
1281 |
1282 | the created shipping order
1283 |
1284 | **See Also:**
1285 |
1286 | ShippingOrder
1287 |
1288 | ---
1289 |
1290 | ### createShippingOrder
1291 |
1292 | **Signature:** `createShippingOrder(shippingOrderNumber : String) : ShippingOrder`
1293 |
1294 | **Description:** Creates a new ShippingOrder for this order. 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.
1295 |
1296 | **Parameters:**
1297 |
1298 | - `shippingOrderNumber`: the document number to be used
1299 |
1300 | **Returns:**
1301 |
1302 | the created shipping order
1303 |
1304 | **See Also:**
1305 |
1306 | ShippingOrder
1307 |
1308 | ---
1309 |
1310 | ### getAffiliatePartnerID
1311 |
1312 | **Signature:** `getAffiliatePartnerID() : String`
1313 |
1314 | **Description:** Returns the affiliate partner ID value, or null.
1315 |
1316 | **Returns:**
1317 |
1318 | the affiliate partner ID value, or null.
1319 |
1320 | ---
1321 |
1322 | ### getAffiliatePartnerName
1323 |
1324 | **Signature:** `getAffiliatePartnerName() : String`
1325 |
1326 | **Description:** Returns the affiliate partner name value, or null.
1327 |
1328 | **Returns:**
1329 |
1330 | the affiliate partner name value, or null.
1331 |
1332 | ---
1333 |
1334 | ### getAppeasement
1335 |
1336 | **Signature:** `getAppeasement(appeasementNumber : String) : Appeasement`
1337 |
1338 | **Description:** Returns the Appeasement associated with this order with the given appeasementNumber. The method returns null if no instance can be found.
1339 |
1340 | **Parameters:**
1341 |
1342 | - `appeasementNumber`: the appeasement number
1343 |
1344 | **Returns:**
1345 |
1346 | the Appeasement associated with the given appeasementNumber
1347 |
1348 | ---
1349 |
1350 | ### getAppeasementItem
1351 |
1352 | **Signature:** `getAppeasementItem(appeasementItemID : String) : AppeasementItem`
1353 |
1354 | **Description:** Returns the AppeasementItem associated with this Order with the given appeasementItemID. The method returns null if no instance can be found.
1355 |
1356 | **Parameters:**
1357 |
1358 | - `appeasementItemID`: the ID
1359 |
1360 | **Returns:**
1361 |
1362 | the AppeasementItem associated with the given appeasementItemID.
1363 |
1364 | ---
1365 |
1366 | ### getAppeasementItems
1367 |
1368 | **Signature:** `getAppeasementItems() : FilteringCollection`
1369 |
1370 | **Description:** Returns the collection of AppeasementItems associated with this order.
1371 |
1372 | **Returns:**
1373 |
1374 | the appeasement items belonging to this order
1375 |
1376 | ---
1377 |
1378 | ### getAppeasements
1379 |
1380 | **Signature:** `getAppeasements() : FilteringCollection`
1381 |
1382 | **Description:** Returns the collection of Appeasements associated with this order.
1383 |
1384 | **Returns:**
1385 |
1386 | the appeasements associated with this order
1387 |
1388 | ---
1389 |
1390 | ### getCancelCode
1391 |
1392 | **Signature:** `getCancelCode() : EnumValue`
1393 |
1394 | **Description:** If this order was cancelled, returns the value of the cancel code or null.
1395 |
1396 | **Returns:**
1397 |
1398 | the value of the cancel code.
1399 |
1400 | ---
1401 |
1402 | ### getCancelDescription
1403 |
1404 | **Signature:** `getCancelDescription() : String`
1405 |
1406 | **Description:** If this order was cancelled, returns the text describing why the order was cancelled or null.
1407 |
1408 | **Returns:**
1409 |
1410 | the description as to why the order was cancelled or null.
1411 |
1412 | ---
1413 |
1414 | ### getCapturedAmount
1415 |
1416 | **Signature:** `getCapturedAmount() : Money`
1417 |
1418 | **Description:** Returns the sum of the captured amounts. The captured amounts are calculated on the fly. Associate a payment capture for an PaymentInstrument with an Invoice using Invoice.addCaptureTransaction(OrderPaymentInstrument, Money).
1419 |
1420 | **Returns:**
1421 |
1422 | sum of captured amounts
1423 |
1424 | ---
1425 |
1426 | ### getConfirmationStatus
1427 |
1428 | **Signature:** `getConfirmationStatus() : EnumValue`
1429 |
1430 | **Description:** Returns the confirmation status of the order. Possible values are CONFIRMATION_STATUS_NOTCONFIRMED and CONFIRMATION_STATUS_CONFIRMED.
1431 |
1432 | **Returns:**
1433 |
1434 | Order confirmation status
1435 |
1436 | ---
1437 |
1438 | ### getCreatedBy
1439 |
1440 | **Signature:** `getCreatedBy() : String`
1441 |
1442 | **Description:** Returns the name of the user who has created the order. If an agent user has created the order, the agent user's name is returned. Otherwise "Customer" is returned.
1443 |
1444 | **Returns:**
1445 |
1446 | the name of the user who created the order.
1447 |
1448 | ---
1449 |
1450 | ### getCurrentOrder
1451 |
1452 | **Signature:** `getCurrentOrder() : Order`
1453 |
1454 | **Description:** Returns the current order. The current order represents the most recent order in a chain of orders. For example, if Order1 was replaced by Order2, Order2 is the current representation of the order and Order1 is the original representation of the order. If you replace Order2 with Order3, Order 3 is now the current order and Order1 is still the original representation of the order. If this order has not been replaced, this method returns this order because this order is the current order.
1455 |
1456 | **Returns:**
1457 |
1458 | the current order.
1459 |
1460 | **See Also:**
1461 |
1462 | getOriginalOrderNo()
1463 | getOriginalOrder()
1464 | getReplacedOrderNo()
1465 | getReplacedOrder()
1466 | getReplacementOrderNo()
1467 | getReplacementOrder()
1468 |
1469 | ---
1470 |
1471 | ### getCurrentOrderNo
1472 |
1473 | **Signature:** `getCurrentOrderNo() : String`
1474 |
1475 | **Description:** Returns the order number of the current order. The current order represents the most recent order in a chain of orders. For example, if Order1 was replaced by Order2, Order2 is the current representation of the order and Order1 is the original representation of the order. If you replace Order2 with Order3, Order 3 is now the current order and Order1 is still the original representation of the order. If this order has not been replaced, calling this method returns the same value as the getOrderNo() method because this order is the current order.
1476 |
1477 | **Returns:**
1478 |
1479 | the order number of the current order
1480 |
1481 | **See Also:**
1482 |
1483 | getOriginalOrderNo()
1484 | getOriginalOrder()
1485 | getReplacedOrderNo()
1486 | getReplacedOrder()
1487 | getReplacementOrderNo()
1488 | getReplacementOrder()
1489 |
1490 | ---
1491 |
1492 | ### getCustomerLocaleID
1493 |
1494 | **Signature:** `getCustomerLocaleID() : String`
1495 |
1496 | **Description:** Returns the ID of the locale that was in effect when the order was placed. This is the customer's locale.
1497 |
1498 | **Returns:**
1499 |
1500 | the ID of the locale associated with this order, or null.
1501 |
1502 | ---
1503 |
1504 | ### getCustomerOrderReference
1505 |
1506 | **Signature:** `getCustomerOrderReference() : String`
1507 |
1508 | **Description:** Returns the customer-specific reference information for the order, or null.
1509 |
1510 | **Returns:**
1511 |
1512 | the customer-specific reference information for the order, or null.
1513 |
1514 | ---
1515 |
1516 | ### getExportAfter
1517 |
1518 | **Signature:** `getExportAfter() : Date`
1519 |
1520 | **Description:** Returns a date after which an order can be exported.
1521 |
1522 | **Returns:**
1523 |
1524 | a date after which an order can be exported.
1525 |
1526 | ---
1527 |
1528 | ### getExportStatus
1529 |
1530 | **Signature:** `getExportStatus() : EnumValue`
1531 |
1532 | **Description:** Returns the export status of the order. Possible values are: EXPORT_STATUS_NOTEXPORTED, EXPORT_STATUS_EXPORTED, EXPORT_STATUS_READY, and EXPORT_STATUS_FAILED.
1533 |
1534 | **Returns:**
1535 |
1536 | Order export status
1537 |
1538 | ---
1539 |
1540 | ### getExternalOrderNo
1541 |
1542 | **Signature:** `getExternalOrderNo() : String`
1543 |
1544 | **Description:** Returns the value of an external order number associated with this order, or null.
1545 |
1546 | **Returns:**
1547 |
1548 | the value of an external order number associated with this order, or null.
1549 |
1550 | ---
1551 |
1552 | ### getExternalOrderStatus
1553 |
1554 | **Signature:** `getExternalOrderStatus() : String`
1555 |
1556 | **Description:** Returns the status of an external order associated with this order, or null.
1557 |
1558 | **Returns:**
1559 |
1560 | the status of an external order associated with this order, or null.
1561 |
1562 | ---
1563 |
1564 | ### getExternalOrderText
1565 |
1566 | **Signature:** `getExternalOrderText() : String`
1567 |
1568 | **Description:** Returns the text describing the external order, or null.
1569 |
1570 | **Returns:**
1571 |
1572 | the text describing the external order, or null.
1573 |
1574 | ---
1575 |
1576 | ### getGlobalPartyID
1577 |
1578 | **Signature:** `getGlobalPartyID() : String`
1579 |
1580 | **Description:** The Global Party ID reconciles customer identity across multiple systems. For example, as part of the Service for Commerce experience, service agents can find information for customers who have never called into the call center, but have created a profile on the website. Service agents can find guest order data from B2C Commerce and easily create accounts for customers. Customer 360 Data Manager matches records from multiple data sources to determine all the records associated with a specific customer.
1581 |
1582 | **Returns:**
1583 |
1584 | the Global Party ID associated with this order, or null.
1585 |
1586 | ---
1587 |
1588 | ### getInvoice
1589 |
1590 | **Signature:** `getInvoice(invoiceNumber : String) : Invoice`
1591 |
1592 | **Description:** Returns the Invoice associated with this order with the given invoiceNumber. The method returns null if no instance can be found. 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.
1593 |
1594 | **Parameters:**
1595 |
1596 | - `invoiceNumber`: the invoice number
1597 |
1598 | **Returns:**
1599 |
1600 | the invoice associated with the given invoiceNumber
1601 |
1602 | ---
1603 |
1604 | ### getInvoiceItem
1605 |
1606 | **Signature:** `getInvoiceItem(invoiceItemID : String) : InvoiceItem`
1607 |
1608 | **Description:** Returns the InvoiceItem associated with this order with the given ID. The method returns null if no instance can be found. 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.
1609 |
1610 | **Parameters:**
1611 |
1612 | - `invoiceItemID`: the item ID
1613 |
1614 | **Returns:**
1615 |
1616 | the invoice item associated with the given ID
1617 |
1618 | ---
1619 |
1620 | ### getInvoiceItems
1621 |
1622 | **Signature:** `getInvoiceItems() : FilteringCollection`
1623 |
1624 | **Description:** Returns the collection of InvoiceItems associated with this order. 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.
1625 |
1626 | **Returns:**
1627 |
1628 | invoice items belonging to this order
1629 |
1630 | ---
1631 |
1632 | ### getInvoiceNo
1633 |
1634 | **Signature:** `getInvoiceNo() : String`
1635 |
1636 | **Description:** Returns the invoice number for this Order. When an order is placed (e.g. with OrderMgr.placeOrder(Order)) invoice number will be filled using a sequence. Before order was placed null will be returned unless it was set with setInvoiceNo(String).
1637 |
1638 | **Returns:**
1639 |
1640 | the invoice number for this Order.
1641 |
1642 | ---
1643 |
1644 | ### getInvoices
1645 |
1646 | **Signature:** `getInvoices() : FilteringCollection`
1647 |
1648 | **Description:** Returns the collection of Invoices associated with this order. 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.
1649 |
1650 | **Returns:**
1651 |
1652 | invoices belonging to this order
1653 |
1654 | ---
1655 |
1656 | ### getOrderExportXML
1657 |
1658 | **Signature:** `getOrderExportXML() : String`
1659 |
1660 | **Description:** Returns the order export XML as String object. NOTE: This method will return payment instrument data masked. If payment instrument re-encryption is needed please use getOrderExportXML(String, String) instead. Example: var orderXMLAsString : String = order.getOrderExportXML(); var orderXML : XML = new XML(orderXMLAsString);
1661 |
1662 | **Returns:**
1663 |
1664 | the order export XML
1665 |
1666 | **Throws:**
1667 |
1668 | IllegalStateException - If the method is called in a transaction with changes.
1669 | IllegalStateException - If the order is not placed. This method can be called for placed orders only.
1670 | IllegalStateException - If the order export XML could not be generated.
1671 |
1672 | ---
1673 |
1674 | ### getOrderExportXML
1675 |
1676 | **Signature:** `getOrderExportXML(encryptionAlgorithm : String, encryptionKey : String) : String`
1677 |
1678 | **Description:** Returns the order export XML as String object, with payment instrument data re-encrypted using the given encryption algorithm and key. NOTE: If no encryption is needed or desired please always use getOrderExportXML() instead, which returns the payment instrument data masked. Do not pass in any null arguments! Example: var orderXMLAsString : String = order.getOrderExportXML( "RSA/ECB/PKCS1Padding", "[key]" ); var orderXML : XML = new XML( orderXMLAsString );
1679 |
1680 | **API Versioned:**
1681 |
1682 | No longer available as of version 22.7. undefined behaviour for invalid arguments (e.g. null)
1683 |
1684 | **Parameters:**
1685 |
1686 | - `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 is supported, but this will be fixed and support for ENCRYPTION_ALGORITHM_RSA_ECB_OAEPWITHSHA56ANDMGF1PADDING will be added soon.
1687 | - `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.
1688 |
1689 | **Returns:**
1690 |
1691 | the order export XML
1692 |
1693 | **Throws:**
1694 |
1695 | IllegalStateException - If the method is called in a transaction with changes.
1696 | IllegalStateException - If the order is not placed. This method can be called for placed orders only.
1697 | IllegalStateException - If the order export XML could not be generated.
1698 |
1699 | ---
1700 |
1701 | ### getOrderExportXML
1702 |
1703 | **Signature:** `getOrderExportXML(encryptionAlgorithm : String, encryptionKey : String, encryptUsingEKID : boolean) : String`
1704 |
1705 | **Description:** Returns the order export XML as String object, with payment instrument data re-encrypted using the given encryption algorithm and key. NOTE: If no encryption is needed or desired please always use getOrderExportXML() instead, which returns the payment instrument data masked. Do not pass in any null arguments! Example: var orderXMLAsString : String = order.getOrderExportXML( "RSA/ECB/PKCS1Padding", "[key]", false ); var orderXML : XML = new XML( orderXMLAsString );
1706 |
1707 | **API Versioned:**
1708 |
1709 | No longer available as of version 22.7. undefined behaviour for invalid arguments (e.g. null)
1710 |
1711 | **Deprecated:**
1712 |
1713 | This method will be removed soon. Please use the following methods instead: getOrderExportXML() – if payment instrument data should be masked getOrderExportXML(String, String) – if payment instrument data should be re-encrypted
1714 |
1715 | **Parameters:**
1716 |
1717 | - `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 is supported, but this will be fixed and support for ENCRYPTION_ALGORITHM_RSA_ECB_OAEPWITHSHA56ANDMGF1PADDING will be added soon.
1718 | - `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.
1719 | - `encryptUsingEKID`: ignored
1720 |
1721 | **Returns:**
1722 |
1723 | the order export XML
1724 |
1725 | **Throws:**
1726 |
1727 | IllegalStateException - If the method is called in a transaction with changes.
1728 | IllegalStateException - If the order is not placed. This method can be called for placed orders only.
1729 | IllegalStateException - If the order export XML could not be generated.
1730 |
1731 | ---
1732 |
1733 | ### getOrderExportXML
1734 |
1735 | **Signature:** `getOrderExportXML(encryptionAlgorithm : String, encryptionKey : String) : String`
1736 |
1737 | **Description:** Returns the order export XML as String object, with payment instrument data re-encrypted using the given encryption algorithm and key. NOTE: If no encryption is needed or desired please always use getOrderExportXML() instead, which returns the payment instrument data masked. Example: var orderXMLAsString : String = order.getOrderExportXML( "RSA/ECB/PKCS1Padding", "[key]" ); var orderXML : XML = new XML( orderXMLAsString );
1738 |
1739 | **API Versioned:**
1740 |
1741 | From version 22.7. strict encryption argument checks; no null or otherwise invalid values allowed
1742 |
1743 | **Parameters:**
1744 |
1745 | - `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: ENCRYPTION_ALGORITHM_RSA_ECB_OAEPWITHSHA56ANDMGF1PADDING – The current and preferred algorithm. ENCRYPTION_ALGORITHM_RSA_ECB_PKCS1PADDING – This algorithm is outdated/deprecated and will be removed in a future release. Please do not use anymore.
1746 | - `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.
1747 |
1748 | **Returns:**
1749 |
1750 | the order export XML
1751 |
1752 | **Throws:**
1753 |
1754 | IllegalArgumentException - If encryptionAlgorithm is not a valid known algorithm.
1755 | IllegalArgumentException - If encryptionKey is a blank string.
1756 | IllegalStateException - If the method is called in a transaction with changes.
1757 | IllegalStateException - If the order is not placed. This method can be called for placed orders only.
1758 | IllegalStateException - If the order export XML could not be generated.
1759 |
1760 | ---
1761 |
1762 | ### getOrderItem
1763 |
1764 | **Signature:** `getOrderItem(itemID : String) : OrderItem`
1765 |
1766 | **Description:** Returns the OrderItem for the itemID. An OrderItem will only exist for ProductLineItems or ShippingLineItems which belong to the order. The method fails with an exception if no instance can be found.
1767 |
1768 | **Parameters:**
1769 |
1770 | - `itemID`: the itemID
1771 |
1772 | **Returns:**
1773 |
1774 | the order item for itemID
1775 |
1776 | **See Also:**
1777 |
1778 | ProductLineItem.getOrderItem()
1779 | ShippingLineItem.getOrderItem()
1780 |
1781 | **Throws:**
1782 |
1783 | IllegalArgumentException - if no instance is found
1784 |
1785 | ---
1786 |
1787 | ### getOrderNo
1788 |
1789 | **Signature:** `getOrderNo() : String`
1790 |
1791 | **Description:** Returns the order number for this order.
1792 |
1793 | **Returns:**
1794 |
1795 | the order number for this order.
1796 |
1797 | ---
1798 |
1799 | ### getOrderToken
1800 |
1801 | **Signature:** `getOrderToken() : String`
1802 |
1803 | **Description:** Returns the token for this order. The order token is a string (length 32 bytes) associated with this one order. The order token is random. It reduces the capability of malicious users to access an order through guessing. Order token can be used to further validate order ownership, but should never be used to solely validate ownership. In addition, the storefront should ensure authentication and authorization. See the Security Best Practices for Developers for details.
1804 |
1805 | **Returns:**
1806 |
1807 | the token for this order.
1808 |
1809 | ---
1810 |
1811 | ### getOriginalOrder
1812 |
1813 | **Signature:** `getOriginalOrder() : Order`
1814 |
1815 | **Description:** Returns the original order associated with this order. The original order represents an order that was the first ancestor in a chain of orders. For example, if Order1 was replaced by Order2, Order2 is the current representation of the order and Order1 is the original representation of the order. If you replace Order2 with Order3, Order1 is still the original representation of the order. If this order is the first ancestor, this method returns this order.
1816 |
1817 | **Returns:**
1818 |
1819 | the order number of the original order associated with this order.
1820 |
1821 | **See Also:**
1822 |
1823 | getCurrentOrderNo()
1824 | getCurrentOrder()
1825 | getReplacedOrderNo()
1826 | getReplacedOrder()
1827 | getReplacementOrderNo()
1828 | getReplacementOrder()
1829 |
1830 | ---
1831 |
1832 | ### getOriginalOrderNo
1833 |
1834 | **Signature:** `getOriginalOrderNo() : String`
1835 |
1836 | **Description:** Returns the order number of the original order associated with this order. The original order represents an order that was the first ancestor in a chain of orders. For example, if Order1 was replaced by Order2, Order2 is the current representation of the order and Order1 is the original representation of the order. If you replace Order2 with Order3, Order1 is still the original representation of the order. If this order is the first ancestor, this method returns the value of getOrderNo().
1837 |
1838 | **Returns:**
1839 |
1840 | the order number of the original order associated with this order.
1841 |
1842 | **See Also:**
1843 |
1844 | getCurrentOrderNo()
1845 | getCurrentOrder()
1846 | getReplacedOrderNo()
1847 | getReplacedOrder()
1848 | getReplacementOrderNo()
1849 | getReplacementOrder()
1850 |
1851 | ---
1852 |
1853 | ### getPaymentStatus
1854 |
1855 | **Signature:** `getPaymentStatus() : EnumValue`
1856 |
1857 | **Description:** Returns the order payment status value. Possible values are PAYMENT_STATUS_NOTPAID, PAYMENT_STATUS_PARTPAID or PAYMENT_STATUS_PAID.
1858 |
1859 | **Returns:**
1860 |
1861 | Order payment status
1862 |
1863 | ---
1864 |
1865 | ### getPaymentTransaction
1866 |
1867 | **Signature:** `getPaymentTransaction() : PaymentTransaction`
1868 |
1869 | **Description:** Returns the payment transaction associated with this order. It is possible that there are multiple payment transactions associated with the order. In this case, this method returns the transaction associated with the first PaymentInstrument returned by getPaymentInstruments().
1870 |
1871 | **Deprecated:**
1872 |
1873 | Use LineItemCtnr.getPaymentInstruments() to get the list of PaymentInstrument instances and then use getPaymentTransaction() method on each PaymentInstrument to access the individual transactions.
1874 |
1875 | **Returns:**
1876 |
1877 | the payment transaction or null if there is no transaction.
1878 |
1879 | ---
1880 |
1881 | ### getRefundedAmount
1882 |
1883 | **Signature:** `getRefundedAmount() : Money`
1884 |
1885 | **Description:** Returns the sum of the refunded amounts. The refunded amounts are calculated on the fly. Associate a payment refund for an PaymentInstrument with an Invoice using Invoice.addRefundTransaction(OrderPaymentInstrument, Money).
1886 |
1887 | **Returns:**
1888 |
1889 | sum of refunded amounts
1890 |
1891 | ---
1892 |
1893 | ### getRemoteHost
1894 |
1895 | **Signature:** `getRemoteHost() : String`
1896 |
1897 | **Description:** Returns the IP address of the remote host from which the order was created. If the IP address was not captured for the order because order IP logging was disabled at the time the order was created, null will be returned.
1898 |
1899 | **Returns:**
1900 |
1901 | The IP address of the remote host captured for the order or null
1902 |
1903 | ---
1904 |
1905 | ### getReplaceCode
1906 |
1907 | **Signature:** `getReplaceCode() : EnumValue`
1908 |
1909 | **Description:** If this order was replaced by another order, returns the value of the replace code. Otherwise. returns null.
1910 |
1911 | **Returns:**
1912 |
1913 | the replace code
1914 |
1915 | ---
1916 |
1917 | ### getReplaceDescription
1918 |
1919 | **Signature:** `getReplaceDescription() : String`
1920 |
1921 | **Description:** If this order was replaced by another order, returns the value of the replace description. Otherwise returns null.
1922 |
1923 | **Returns:**
1924 |
1925 | the value of the replace code or null.
1926 |
1927 | ---
1928 |
1929 | ### getReplacedOrder
1930 |
1931 | **Signature:** `getReplacedOrder() : Order`
1932 |
1933 | **Description:** Returns the order that this order replaced or null. For example, if you have three orders where Order1 was replaced by Order2 and Order2 was replaced by Order3, calling this method on Order3 will return Order2. Similarly, calling this method on Order1 will return null as Order1 was the original order.
1934 |
1935 | **Returns:**
1936 |
1937 | the order that replaced this order, or null.
1938 |
1939 | **See Also:**
1940 |
1941 | getCurrentOrderNo()
1942 | getCurrentOrder()
1943 | getOriginalOrderNo()
1944 | getOriginalOrder()
1945 | getReplacementOrderNo()
1946 | getReplacementOrder()
1947 |
1948 | ---
1949 |
1950 | ### getReplacedOrderNo
1951 |
1952 | **Signature:** `getReplacedOrderNo() : String`
1953 |
1954 | **Description:** Returns the order number that this order replaced or null if this order did not replace an order. For example, if you have three orders where Order1 was replaced by Order2 and Order2 was replaced by Order3, calling this method on Order3 will return the order number for Order2. Similarly, calling this method on Order1 will return null as Order1 was the original order.
1955 |
1956 | **Returns:**
1957 |
1958 | the order number of the order that this order replaced or null.
1959 |
1960 | **See Also:**
1961 |
1962 | getCurrentOrderNo()
1963 | getCurrentOrder()
1964 | getOriginalOrderNo()
1965 | getOriginalOrder()
1966 | getReplacementOrderNo()
1967 | getReplacementOrder()
1968 |
1969 | ---
1970 |
1971 | ### getReplacementOrder
1972 |
1973 | **Signature:** `getReplacementOrder() : Order`
1974 |
1975 | **Description:** Returns the order that replaced this order, or null.
1976 |
1977 | **Returns:**
1978 |
1979 | the order that replaced this order, or null.
1980 |
1981 | **See Also:**
1982 |
1983 | getCurrentOrderNo()
1984 | getCurrentOrder()
1985 | getOriginalOrderNo()
1986 | getOriginalOrder()
1987 | getReplacedOrderNo()
1988 | getReplacedOrder()
1989 |
1990 | ---
1991 |
1992 | ### getReplacementOrderNo
1993 |
1994 | **Signature:** `getReplacementOrderNo() : String`
1995 |
1996 | **Description:** If this order was replaced by another order, returns the order number that replaced this order. Otherwise returns null.
1997 |
1998 | **Returns:**
1999 |
2000 | the order that replaced this order, or null.
2001 |
2002 | **See Also:**
2003 |
2004 | getCurrentOrderNo()
2005 | getCurrentOrder()
2006 | getOriginalOrderNo()
2007 | getOriginalOrder()
2008 | getReplacedOrderNo()
2009 | getReplacedOrder()
2010 |
2011 | ---
2012 |
2013 | ### getReturn
2014 |
2015 | **Signature:** `getReturn(returnNumber : String) : Return`
2016 |
2017 | **Description:** Returns the Return associated with this order with the given returnNumber. The method returns null if no instance can be found. 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.
2018 |
2019 | **Parameters:**
2020 |
2021 | - `returnNumber`: the return number
2022 |
2023 | **Returns:**
2024 |
2025 | the return associated with the given returnNumber
2026 |
2027 | ---
2028 |
2029 | ### getReturnCase
2030 |
2031 | **Signature:** `getReturnCase(returnCaseNumber : String) : ReturnCase`
2032 |
2033 | **Description:** Returns the ReturnCase associated with this order with the given returnCaseNumber. The method returns null if no instance can be found. 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.
2034 |
2035 | **Parameters:**
2036 |
2037 | - `returnCaseNumber`: the return case number
2038 |
2039 | **Returns:**
2040 |
2041 | the return case associated with the given returnCaseNumber
2042 |
2043 | ---
2044 |
2045 | ### getReturnCaseItem
2046 |
2047 | **Signature:** `getReturnCaseItem(returnCaseItemID : String) : ReturnCaseItem`
2048 |
2049 | **Description:** Returns the ReturnCaseItem associated with this order with the given returnCaseItemID. The method returns null if no instance can be found. 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.
2050 |
2051 | **Parameters:**
2052 |
2053 | - `returnCaseItemID`: the ID
2054 |
2055 | **Returns:**
2056 |
2057 | the return case item associated with the given returnCaseItemID
2058 |
2059 | ---
2060 |
2061 | ### getReturnCaseItems
2062 |
2063 | **Signature:** `getReturnCaseItems() : FilteringCollection`
2064 |
2065 | **Description:** Returns the collection of ReturnCaseItems associated with this order. 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.
2066 |
2067 | **Returns:**
2068 |
2069 | return case items belonging to this order
2070 |
2071 | ---
2072 |
2073 | ### getReturnCases
2074 |
2075 | **Signature:** `getReturnCases() : FilteringCollection`
2076 |
2077 | **Description:** Returns the collection of ReturnCases associated with this order. 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.
2078 |
2079 | **Returns:**
2080 |
2081 | return cases belonging to this order
2082 |
2083 | ---
2084 |
2085 | ### getReturnItem
2086 |
2087 | **Signature:** `getReturnItem(returnItemID : String) : ReturnItem`
2088 |
2089 | **Description:** Returns the ReturnItem associated with this order with the given ID. The method returns null if no instance can be found. 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.
2090 |
2091 | **Parameters:**
2092 |
2093 | - `returnItemID`: the ID
2094 |
2095 | **Returns:**
2096 |
2097 | the return item associated with the given returnItemID
2098 |
2099 | ---
2100 |
2101 | ### getReturnItems
2102 |
2103 | **Signature:** `getReturnItems() : FilteringCollection`
2104 |
2105 | **Description:** Returns the collection of ReturnItems associated with this order. 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.
2106 |
2107 | **Returns:**
2108 |
2109 | return items belonging to this order
2110 |
2111 | ---
2112 |
2113 | ### getReturns
2114 |
2115 | **Signature:** `getReturns() : FilteringCollection`
2116 |
2117 | **Description:** Returns the collection of Returns associated with this order. 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.
2118 |
2119 | **Returns:**
2120 |
2121 | returns belonging to this order
2122 |
2123 | ---
2124 |
2125 | ### getShippingOrder
2126 |
2127 | **Signature:** `getShippingOrder(shippingOrderNumber : String) : ShippingOrder`
2128 |
2129 | **Description:** Returns the ShippingOrder associated with this order with the given shippingOrderNumber. The method returns null if no instance can be found. 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.
2130 |
2131 | **Parameters:**
2132 |
2133 | - `shippingOrderNumber`: the shipping order number
2134 |
2135 | **Returns:**
2136 |
2137 | the shipping order associated with the given shippingOrderNumber
2138 |
2139 | ---
2140 |
2141 | ### getShippingOrderItem
2142 |
2143 | **Signature:** `getShippingOrderItem(shippingOrderItemID : String) : ShippingOrderItem`
2144 |
2145 | **Description:** Returns the ShippingOrderItem associated with this order with the given shippingOrderItemID. The method returns null if no instance can be found. 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.
2146 |
2147 | **Parameters:**
2148 |
2149 | - `shippingOrderItemID`: the ID
2150 |
2151 | **Returns:**
2152 |
2153 | the shipping order item associated with the given shippingOrderItemID
2154 |
2155 | ---
2156 |
2157 | ### getShippingOrderItems
2158 |
2159 | **Signature:** `getShippingOrderItems() : FilteringCollection`
2160 |
2161 | **Description:** Returns the collection of ShippingOrderItems associated with this order. 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.
2162 |
2163 | **Returns:**
2164 |
2165 | shipping order items belonging to this order
2166 |
2167 | ---
2168 |
2169 | ### getShippingOrders
2170 |
2171 | **Signature:** `getShippingOrders() : FilteringCollection`
2172 |
2173 | **Description:** Returns the collection of ShippingOrders associated with this order. 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.
2174 |
2175 | **Returns:**
2176 |
2177 | shipping orders belonging to this order
2178 |
2179 | ---
2180 |
2181 | ### getShippingStatus
2182 |
2183 | **Signature:** `getShippingStatus() : EnumValue`
2184 |
2185 | **Description:** Returns the order shipping status. Possible values are SHIPPING_STATUS_NOTSHIPPED, SHIPPING_STATUS_PARTSHIPPED or SHIPPING_STATUS_SHIPPED.
2186 |
2187 | **Returns:**
2188 |
2189 | Order shipping status
2190 |
2191 | ---
2192 |
2193 | ### getSourceCode
2194 |
2195 | **Signature:** `getSourceCode() : String`
2196 |
2197 | **Description:** Returns the source code stored with the order or null if no source code is attached to the order.
2198 |
2199 | **Returns:**
2200 |
2201 | the source code stored with the order or null if no source code is attached to the order.
2202 |
2203 | ---
2204 |
2205 | ### getSourceCodeGroup
2206 |
2207 | **Signature:** `getSourceCodeGroup() : SourceCodeGroup`
2208 |
2209 | **Description:** Returns the source code group attached to the order or null if no source code group is attached to the order.
2210 |
2211 | **Returns:**
2212 |
2213 | the source code group attached to the order or null if no source code group is attached to the order.
2214 |
2215 | ---
2216 |
2217 | ### getSourceCodeGroupID
2218 |
2219 | **Signature:** `getSourceCodeGroupID() : String`
2220 |
2221 | **Description:** Returns the source code group id stored with the order or null if no source code group is attached to the order.
2222 |
2223 | **Returns:**
2224 |
2225 | the source code group id stored with the order or null if no source code group is attached to the order.
2226 |
2227 | ---
2228 |
2229 | ### getStatus
2230 |
2231 | **Signature:** `getStatus() : EnumValue`
2232 |
2233 | **Description:** Returns the status of the order. Possible values are: ORDER_STATUS_CREATED ORDER_STATUS_NEW ORDER_STATUS_OPEN ORDER_STATUS_COMPLETED ORDER_STATUS_CANCELLED ORDER_STATUS_FAILED ORDER_STATUS_REPLACED The order status usually changes when a process action is initiated. Most status changes have an action which needs to executed in order to end having the order in a specific order status. When an order is created with e.g. OrderMgr.createOrder(Basket) the order status will be ORDER_STATUS_CREATED. The usual flow is that payment authorization will be added to the order. Once the order is considered as valid (payed, fraud checked, ...) the order gets placed. This can be done by calling OrderMgr.placeOrder(Order). The result of placing an order will be status ORDER_STATUS_OPEN (from a process standpoint ORDER_STATUS_NEW which has the same meaning). Status ORDER_STATUS_REPLACED is related to functionality BasketMgr.createBasketFromOrder(Order). ORDER_STATUS_COMPLETED has no meaning by default but can be used by custom implementations but is a synonym for NEW/OPEN. Below you will find the most important status changes: Status beforeActionStatus afterBusiness meaning -OrderMgr.createOrder(Basket)CREATEDOrder was created from a basket. CREATEDOrderMgr.placeOrder(Order)OPEN/NEWOrder was considered as valid. Order can now be exported to 3rd party systems. CREATEDOrderMgr.failOrder(Order)FAILEDOrder was considered not valid. E.g. payment authorization was wrong or fraud check was not successful. OPEN/NEWOrderMgr.cancelOrder(Order)CANCELLEDOrder was cancelled. CANCELLEDOrderMgr.undoCancelOrder(Order)OPEN/NEWOrder was cancelled by mistake and this needs to be undone. FAILEDOrderMgr.undoFailOrder(Order)CREATEDOrder was failed by mistake and this needs to be undone. Every status change will trigger a change in the order journal which is the base for GMV calculations.
2234 |
2235 | **Returns:**
2236 |
2237 | Status of the order.
2238 |
2239 | **See Also:**
2240 |
2241 | LineItemCtnr
2242 |
2243 | ---
2244 |
2245 | ### isImported
2246 |
2247 | **Signature:** `isImported() : boolean`
2248 |
2249 | **Description:** Returns true, if the order is imported and false otherwise.
2250 |
2251 | **Returns:**
2252 |
2253 | true, if the order was imported, false otherwise.
2254 |
2255 | ---
2256 |
2257 | ### isTaxRoundedAtGroup
2258 |
2259 | **Signature:** `isTaxRoundedAtGroup() : boolean`
2260 |
2261 | **Description:** Use this method to check if the Order was created with grouped taxation calculation. If the tax is rounded on group level, the tax is applied to the summed-up tax basis for each tax rate.
2262 |
2263 | **Returns:**
2264 |
2265 | true if the Order was created with grouped taxation
2266 |
2267 | ---
2268 |
2269 | ### reauthorize
2270 |
2271 | **Signature:** `reauthorize() : Status`
2272 |
2273 | **Description:** Ensures that the order is authorized. Checks if the order is authorized by calling the hook PaymentHooks.validateAuthorization(Order). If the authorization is not valid it reauthorizes the order by calling the PaymentHooks.reauthorize(Order).
2274 |
2275 | **Returns:**
2276 |
2277 | the status of the operation, will be Status.OK if the order is authorized after this call
2278 |
2279 | ---
2280 |
2281 | ### removeRemoteHost
2282 |
2283 | **Signature:** `removeRemoteHost() : void`
2284 |
2285 | **Description:** Removes the IP address of the remote host if stored. If IP logging was enabled during order creation the IP address of the customer will be stored and can be retrieved using getRemoteHost().
2286 |
2287 | **See Also:**
2288 |
2289 | getRemoteHost()
2290 |
2291 | ---
2292 |
2293 | ### setAffiliatePartnerID
2294 |
2295 | **Signature:** `setAffiliatePartnerID(affiliatePartnerID : String) : void`
2296 |
2297 | **Description:** Sets the affiliate partner ID value.
2298 |
2299 | **Parameters:**
2300 |
2301 | - `affiliatePartnerID`: the affiliate partner ID value.
2302 |
2303 | ---
2304 |
2305 | ### setAffiliatePartnerName
2306 |
2307 | **Signature:** `setAffiliatePartnerName(affiliatePartnerName : String) : void`
2308 |
2309 | **Description:** Sets the affiliate partner name value.
2310 |
2311 | **Parameters:**
2312 |
2313 | - `affiliatePartnerName`: the affiliate partner name value.
2314 |
2315 | ---
2316 |
2317 | ### setCancelCode
2318 |
2319 | **Signature:** `setCancelCode(cancelCode : String) : void`
2320 |
2321 | **Description:** Sets the cancel code value.
2322 |
2323 | **Parameters:**
2324 |
2325 | - `cancelCode`: the cancel code value.
2326 |
2327 | ---
2328 |
2329 | ### setCancelDescription
2330 |
2331 | **Signature:** `setCancelDescription(cancelDescription : String) : void`
2332 |
2333 | **Description:** Sets the description as to why the order was cancelled.
2334 |
2335 | **Parameters:**
2336 |
2337 | - `cancelDescription`: the description for why the order was cancelled.
2338 |
2339 | ---
2340 |
2341 | ### setConfirmationStatus
2342 |
2343 | **Signature:** `setConfirmationStatus(status : Number) : void`
2344 |
2345 | **Description:** Sets the confirmation status value. Possible values are CONFIRMATION_STATUS_NOTCONFIRMED or CONFIRMATION_STATUS_CONFIRMED.
2346 |
2347 | **Parameters:**
2348 |
2349 | - `status`: Order confirmation status
2350 |
2351 | ---
2352 |
2353 | ### setCustomer
2354 |
2355 | **Signature:** `setCustomer(customer : Customer) : void`
2356 |
2357 | **Description:** This method is used to associate the order object with the specified customer object. If the customer object represents a registered customer, the order will be assigned to this registered customer and the order's customer number (LineItemCtnr.getCustomerNo()) will be updated. If the customer object represents an unregistered (anonymous) customer, the order will become an anonymous order and the order's customer number will be set to null.
2358 |
2359 | **Parameters:**
2360 |
2361 | - `customer`: The customer to be associated with the order.
2362 |
2363 | **Throws:**
2364 |
2365 | NullArgumentException - If specified customer is null.
2366 |
2367 | ---
2368 |
2369 | ### setCustomerNo
2370 |
2371 | **Signature:** `setCustomerNo(customerNo : String) : void`
2372 |
2373 | **Description:** Sets the customer number associated with this order. Note it is recommended to use (setCustomer(Customer)) instead of this method. This method only sets the customer number and should be used with care as it does not re-link the order with a customer profile object which can lead to an inconsistency! Ensure that the customer number used is not already taken by a different customer profile.
2374 |
2375 | **Parameters:**
2376 |
2377 | - `customerNo`: the customer number associated with this order.
2378 |
2379 | ---
2380 |
2381 | ### setCustomerOrderReference
2382 |
2383 | **Signature:** `setCustomerOrderReference(reference : String) : void`
2384 |
2385 | **Description:** Sets the customer-specific reference information for the order.
2386 |
2387 | **Parameters:**
2388 |
2389 | - `reference`: the customer-specific reference information for the order.
2390 |
2391 | ---
2392 |
2393 | ### setExportAfter
2394 |
2395 | **Signature:** `setExportAfter(date : Date) : void`
2396 |
2397 | **Description:** Sets the date after which an order can be exported.
2398 |
2399 | **Parameters:**
2400 |
2401 | - `date`: the date after which an order can be exported.
2402 |
2403 | ---
2404 |
2405 | ### setExportStatus
2406 |
2407 | **Signature:** `setExportStatus(status : Number) : void`
2408 |
2409 | **Description:** Sets the export status of the order. Possible values are: EXPORT_STATUS_NOTEXPORTED, EXPORT_STATUS_EXPORTED, EXPORT_STATUS_READY, and EXPORT_STATUS_FAILED. Setting the status to EXPORT_STATUS_EXPORTED will also trigger the finalization of on order inventory transactions for this order meaning that all inventory transactions with type on order will be moved into final inventory transactions. This is only relevant when On Order Inventory is turned on for the inventory list ordered products are in. In case of an exception the current transaction is marked as rollback only.
2410 |
2411 | **Parameters:**
2412 |
2413 | - `status`: Order export status
2414 |
2415 | ---
2416 |
2417 | ### setExternalOrderNo
2418 |
2419 | **Signature:** `setExternalOrderNo(externalOrderNo : String) : void`
2420 |
2421 | **Description:** Sets the value of an external order number associated with this order
2422 |
2423 | **Parameters:**
2424 |
2425 | - `externalOrderNo`: the value of an external order number associated with this order.
2426 |
2427 | ---
2428 |
2429 | ### setExternalOrderStatus
2430 |
2431 | **Signature:** `setExternalOrderStatus(status : String) : void`
2432 |
2433 | **Description:** Sets the status of an external order associated with this order
2434 |
2435 | **Parameters:**
2436 |
2437 | - `status`: the status of the external order.
2438 |
2439 | ---
2440 |
2441 | ### setExternalOrderText
2442 |
2443 | **Signature:** `setExternalOrderText(text : String) : void`
2444 |
2445 | **Description:** Sets the text describing the external order.
2446 |
2447 | **Parameters:**
2448 |
2449 | - `text`: the text describing the external order.
2450 |
2451 | ---
2452 |
2453 | ### setInvoiceNo
2454 |
2455 | **Signature:** `setInvoiceNo(invoiceNumber : String) : void`
2456 |
2457 | **Description:** Sets the invoice number for this Order. Notice that this value might be overwritten during order placement (e.g. with OrderMgr.placeOrder(Order)).
2458 |
2459 | **Parameters:**
2460 |
2461 | - `invoiceNumber`: the invoice number for this Order.
2462 |
2463 | **See Also:**
2464 |
2465 | getInvoiceNo()
2466 |
2467 | ---
2468 |
2469 | ### setOrderStatus
2470 |
2471 | **Signature:** `setOrderStatus(status : Number) : void`
2472 |
2473 | **Description:** Sets the order status. Use this method when using Order Post Processing such as the creation of shipping orders. The only supported values are ORDER_STATUS_OPEN, ORDER_STATUS_CANCELLED. Setting the status will adjust the order item status when applicable (item status not SHIPPED or CANCELLED). Note that the order status and the status of the items are directly related and dependent on one another. See OrderItem.setStatus(String) for more information about possible status transitions. Warning: This method will not undo coupon redemptions upon cancellation of an order. Re-opening such an order later with OrderMgr.undoCancelOrder(Order) or OrderItem.setStatus(String) with ORDER_STATUS_OPEN will result in an additional application of the same coupon code which in turn might fail. 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.
2474 |
2475 | **Deprecated:**
2476 |
2477 | use setStatus(Number) instead
2478 |
2479 | **Parameters:**
2480 |
2481 | - `status`: the status to be set, use one of: ORDER_STATUS_OPEN ORDER_STATUS_CANCELLED
2482 |
2483 | **Throws:**
2484 |
2485 | IllegalArgumentException - on attempt to set an unsupported status value
2486 |
2487 | ---
2488 |
2489 | ### setPaymentStatus
2490 |
2491 | **Signature:** `setPaymentStatus(status : Number) : void`
2492 |
2493 | **Description:** Sets the order payment status. Possible values are PAYMENT_STATUS_NOTPAID, PAYMENT_STATUS_PARTPAID or PAYMENT_STATUS_PAID.
2494 |
2495 | **Parameters:**
2496 |
2497 | - `status`: Order payment status
2498 |
2499 | ---
2500 |
2501 | ### setReplaceCode
2502 |
2503 | **Signature:** `setReplaceCode(replaceCode : String) : void`
2504 |
2505 | **Description:** Sets the value of the replace code.
2506 |
2507 | **Parameters:**
2508 |
2509 | - `replaceCode`: the value of the replace code.
2510 |
2511 | ---
2512 |
2513 | ### setReplaceDescription
2514 |
2515 | **Signature:** `setReplaceDescription(replaceDescription : String) : void`
2516 |
2517 | **Description:** Sets the value of the replace description.
2518 |
2519 | **Parameters:**
2520 |
2521 | - `replaceDescription`: the value of the replace description.
2522 |
2523 | ---
2524 |
2525 | ### setShippingStatus
2526 |
2527 | **Signature:** `setShippingStatus(status : Number) : void`
2528 |
2529 | **Description:** Sets the order shipping status value. Possible values are SHIPPING_STATUS_NOTSHIPPED, SHIPPING_STATUS_PARTSHIPPED or SHIPPING_STATUS_SHIPPED.
2530 |
2531 | **Parameters:**
2532 |
2533 | - `status`: Order shipping status
2534 |
2535 | ---
2536 |
2537 | ### setStatus
2538 |
2539 | **Signature:** `setStatus(status : Number) : void`
2540 |
2541 | **Description:** Sets the status of the order. Possible values are: ORDER_STATUS_NEW ORDER_STATUS_OPEN ORDER_STATUS_COMPLETED ORDER_STATUS_CANCELLED ORDER_STATUS_REPLACED This method does not support order statuses ORDER_STATUS_CREATED or ORDER_STATUS_FAILED. Please use OrderMgr.placeOrder(Order) or OrderMgr.failOrder(Order). Setting the order status to ORDER_STATUS_CANCELLED will have the same effect as calling OrderMgr.cancelOrder(Order). Setting a canceled order to ORDER_STATUS_NEW, ORDER_STATUS_OPEN or ORDER_STATUS_COMPLETED will have the same effect as calling OrderMgr.undoCancelOrder(Order). It is recommended to use the methods in OrderMgr directly to be able to do error processing with the return code.
2542 |
2543 | **Parameters:**
2544 |
2545 | - `status`: Order status
2546 |
2547 | **Throws:**
2548 |
2549 | IllegalArgumentException - on attempt to set status CREATED or FAILED, or status transition while cancel order or undo cancel order returns with an error code.
2550 |
2551 | ---
2552 |
2553 | ### trackOrderChange
2554 |
2555 | **Signature:** `trackOrderChange(text : String) : Note`
2556 |
2557 | **Description:** Tracks an order change. This adds a history entry to the order. Focus of history entries are changes through business logic, both custom and internal logic. Tracked order changes are read-only and can be accessed in the Business Manager order history. The following attributes of the created history entry are initialized: Note.getCreatedBy() gets the current user assigned Note.getCreationDate() gets the current date assigned This feature is intended to track important changes in custom order flow which should become visible in Business Manager's history tab. It is NOT intended as auditing feature for every change to an order. A warning will be produced after 600 notes are added to an order. The warning can be reviewed in Business Manager's Quota Status screen. Attempting to add a note to an order which already has 1000 notes results in an exception. Please bear in mind that internal changes, such as order status changes, also track changes. Avoid using this feature in recurring jobs which may re-process orders multiple times as the limit needs to be considered each time a change is tracked. The same limit on the number of notes added also applies when using method LineItemCtnr.addNote(String, String) to add notes.
2558 |
2559 | **Parameters:**
2560 |
2561 | - `text`: the text of the history entry
2562 |
2563 | **Returns:**
2564 |
2565 | the created history entry
2566 |
2567 | ---
```