This is page 60 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/LineItemCtnr.md:
--------------------------------------------------------------------------------
```markdown
1 | ## Package: dw.order
2 |
3 | # Class LineItemCtnr
4 |
5 | ## Inheritance Hierarchy
6 |
7 | - Object
8 | - dw.object.PersistentObject
9 | - dw.object.ExtensibleObject
10 | - dw.order.LineItemCtnr
11 |
12 | ## Description
13 |
14 | A container for line items, such as ProductLineItems, CouponLineItems, GiftCertificateLineItems. This container also provides access to shipments, shipping adjustments (promotions), and payment instruments (credit cards). LineItemCtnr also contains a set of methods for creating line items and adjustments, and for accessing various price values. There are three types of price-related methods: Net-based methods represent the amount of a category before tax has been calculated. For example, the getMerchandizeTotalNetPrice() returns the price of all merchandise in the container whereas getShippingTotalNetPrice() returns the price of all shipments in the container. Tax-based methods return the amount of tax on a category. For example, the getMerchandizeTotalTax() returns the total tax for all merchandise and the getShippingTotalTax() returns the tax applied to all shipments. Gross-based methods represent the amount of a category after tax has been calculated. For example, the getMerchandizeTotalGrossPrice() returns the price of all merchandise in the container, including tax on the merchandise, whereas getShippingTotalGrossPrice() returns the price of all shipments in the container, including tax on the shipments in the container. There are also a set of methods that provide access to 'adjusted' values. The adjusted-based methods return values where promotions have been applied. For example, the getAdjustedMerchandizeTotalNetPrice() method returns the net price of all merchandise after product-level and order-level promotions have been applied. Whereas the getAdjustedMerchandizeTotalGrossPrice() method returns the price of all merchandise after product-level and order-level promotions have been applied and includes the amount of merchandise-related tax. Finally, there are a set of methods that return the aggregate values representing the line items in the container. These are the total-based methods getTotalNetPrice(), getTotalTax() and getTotalGrossPrice(). These methods return the totals of all items in the container and include any order-level promotions. Note that all merchandise-related methods do not include 'gift certificates' values in the values they return. Gift certificates are not considered merchandise as they do not represent a product.
15 |
16 | ## Constants
17 |
18 | ### BUSINESS_TYPE_B2B
19 |
20 | **Type:** Number = 2
21 |
22 | constant for Business Type B2B
23 |
24 | ### BUSINESS_TYPE_B2C
25 |
26 | **Type:** Number = 1
27 |
28 | constant for Business Type B2C
29 |
30 | ### CHANNEL_TYPE_CALLCENTER
31 |
32 | **Type:** Number = 2
33 |
34 | constant for Channel Type CallCenter
35 |
36 | ### CHANNEL_TYPE_CUSTOMERSERVICECENTER
37 |
38 | **Type:** Number = 11
39 |
40 | constant for Channel Type Customer Service Center
41 |
42 | ### CHANNEL_TYPE_DSS
43 |
44 | **Type:** Number = 4
45 |
46 | constant for Channel Type DSS
47 |
48 | ### CHANNEL_TYPE_FACEBOOKADS
49 |
50 | **Type:** Number = 8
51 |
52 | constant for Channel Type Facebook Ads
53 |
54 | ### CHANNEL_TYPE_GOOGLE
55 |
56 | **Type:** Number = 13
57 |
58 | constant for Channel Type Google
59 |
60 | ### CHANNEL_TYPE_INSTAGRAMCOMMERCE
61 |
62 | **Type:** Number = 12
63 |
64 | constant for Channel Type Instagram Commerce
65 |
66 | ### CHANNEL_TYPE_MARKETPLACE
67 |
68 | **Type:** Number = 3
69 |
70 | constant for Channel Type Marketplace
71 |
72 | ### CHANNEL_TYPE_ONLINERESERVATION
73 |
74 | **Type:** Number = 10
75 |
76 | constant for Channel Type Online Reservation
77 |
78 | ### CHANNEL_TYPE_PINTEREST
79 |
80 | **Type:** Number = 6
81 |
82 | constant for Channel Type Pinterest
83 |
84 | ### CHANNEL_TYPE_SNAPCHAT
85 |
86 | **Type:** Number = 15
87 |
88 | constant for Channel Type Snapchat
89 |
90 | ### CHANNEL_TYPE_STORE
91 |
92 | **Type:** Number = 5
93 |
94 | constant for Channel Type Store
95 |
96 | ### CHANNEL_TYPE_STOREFRONT
97 |
98 | **Type:** Number = 1
99 |
100 | constant for Channel Type Storefront
101 |
102 | ### CHANNEL_TYPE_SUBSCRIPTIONS
103 |
104 | **Type:** Number = 9
105 |
106 | constant for Channel Type Subscriptions
107 |
108 | ### CHANNEL_TYPE_TIKTOK
109 |
110 | **Type:** Number = 14
111 |
112 | constant for Channel Type TikTok
113 |
114 | ### CHANNEL_TYPE_TWITTER
115 |
116 | **Type:** Number = 7
117 |
118 | constant for Channel Type Twitter
119 |
120 | ### CHANNEL_TYPE_WHATSAPP
121 |
122 | **Type:** Number = 16
123 |
124 | constant for Channel Type WhatsApp
125 |
126 | ### CHANNEL_TYPE_YOUTUBE
127 |
128 | **Type:** Number = 17
129 |
130 | constant for Channel Type YouTube
131 |
132 | ## Properties
133 |
134 | ### adjustedMerchandizeTotalGrossPrice
135 |
136 | **Type:** Money (Read Only)
137 |
138 | The adjusted total gross price (including tax) in purchase currency. Adjusted merchandize prices
139 | represent the sum of product prices before services such as shipping, but after product-level and order-level
140 | adjustments.
141 |
142 | ### adjustedMerchandizeTotalNetPrice
143 |
144 | **Type:** Money (Read Only)
145 |
146 | The total net price (excluding tax) in purchase currency. Adjusted merchandize prices represent the sum
147 | of product prices before services such as shipping, but after product-level and order-level adjustments.
148 |
149 | ### adjustedMerchandizeTotalPrice
150 |
151 | **Type:** Money (Read Only)
152 |
153 | The adjusted merchandize total price including product-level and order-level adjustments. If the line
154 | item container is based on net pricing the adjusted merchandize total net price is returned. If the line item
155 | container is based on gross pricing the adjusted merchandize total gross price is returned.
156 |
157 | ### adjustedMerchandizeTotalTax
158 |
159 | **Type:** Money (Read Only)
160 |
161 | The subtotal tax in purchase currency. Adjusted merchandize prices represent the sum of product prices
162 | before services such as shipping have been added, but after adjustment from promotions have been added.
163 |
164 | ### adjustedShippingTotalGrossPrice
165 |
166 | **Type:** Money (Read Only)
167 |
168 | The adjusted sum of all shipping line items of the line item container, including tax after shipping
169 | adjustments have been applied.
170 |
171 | ### adjustedShippingTotalNetPrice
172 |
173 | **Type:** Money (Read Only)
174 |
175 | The sum of all shipping line items of the line item container, excluding tax after shipping adjustments
176 | have been applied.
177 |
178 | ### adjustedShippingTotalPrice
179 |
180 | **Type:** Money (Read Only)
181 |
182 | The adjusted shipping total price. If the line item container is based on net pricing the adjusted
183 | shipping total net price is returned. If the line item container is based on gross pricing the adjusted shipping
184 | total gross price is returned.
185 |
186 | ### adjustedShippingTotalTax
187 |
188 | **Type:** Money (Read Only)
189 |
190 | The tax of all shipping line items of the line item container after shipping adjustments have been
191 | applied.
192 |
193 | ### allGiftCertificateLineItems
194 |
195 | **Type:** Collection (Read Only)
196 |
197 | All gift certificate line items of the container.
198 |
199 | ### allLineItems
200 |
201 | **Type:** Collection (Read Only)
202 |
203 | All product, shipping, price adjustment, and gift certificate line items of the line item container.
204 |
205 | ### allProductLineItems
206 |
207 | **Type:** Collection (Read Only)
208 |
209 | All product line items of the container, no matter if they are dependent or independent. This includes
210 | option, bundled and bonus line items.
211 |
212 | ### allProductQuantities
213 |
214 | **Type:** HashMap (Read Only)
215 |
216 | A hash mapping all products in the line item container to their total quantities. The total product
217 | quantity is used chiefly to validate the availability of the items in the cart. This method is not appropriate to
218 | look up prices because it returns products such as bundled line items which are included in the price of their
219 | parent and therefore have no corresponding price.
220 |
221 | The method counts all direct product line items, plus dependent product line items that are not option line
222 | items. It also excludes product line items that are not associated to any catalog product.
223 |
224 | ### allShippingPriceAdjustments
225 |
226 | **Type:** Collection (Read Only)
227 |
228 | The collection of all shipping price adjustments applied somewhere in the container. This can be
229 | adjustments applied to individual shipments or to the container itself. Note that the promotions engine only
230 | applies shipping price adjustments to the the default shipping line item of shipments, and never to the
231 | container.
232 |
233 | ### billingAddress
234 |
235 | **Type:** OrderAddress (Read Only)
236 |
237 | The billing address defined for the container. Returns null if no billing address has been created yet.
238 |
239 | ### bonusDiscountLineItems
240 |
241 | **Type:** Collection (Read Only)
242 |
243 | An unsorted collection of the the bonus discount line items associated with this container.
244 |
245 | ### bonusLineItems
246 |
247 | **Type:** Collection (Read Only)
248 |
249 | The collection of product line items that are bonus items (where
250 | ProductLineItem.isBonusProductLineItem() is true).
251 |
252 | ### businessType
253 |
254 | **Type:** EnumValue (Read Only)
255 |
256 | The type of the business this order has been placed in.
257 | Possible values are BUSINESS_TYPE_B2C or BUSINESS_TYPE_B2B.
258 |
259 | ### channelType
260 |
261 | **Type:** EnumValue (Read Only)
262 |
263 | The channel type defines in which sales channel this order has been created. This can be used to distinguish
264 | order placed through Storefront, Call Center or Marketplace.
265 | Possible values are CHANNEL_TYPE_STOREFRONT, CHANNEL_TYPE_CALLCENTER,
266 | CHANNEL_TYPE_MARKETPLACE, CHANNEL_TYPE_DSS, CHANNEL_TYPE_STORE,
267 | CHANNEL_TYPE_PINTEREST, CHANNEL_TYPE_TWITTER, CHANNEL_TYPE_FACEBOOKADS,
268 | CHANNEL_TYPE_SUBSCRIPTIONS, CHANNEL_TYPE_ONLINERESERVATION,
269 | CHANNEL_TYPE_CUSTOMERSERVICECENTER, CHANNEL_TYPE_INSTAGRAMCOMMERCE,
270 | CHANNEL_TYPE_GOOGLE, CHANNEL_TYPE_YOUTUBE, CHANNEL_TYPE_TIKTOK,
271 | CHANNEL_TYPE_SNAPCHAT, CHANNEL_TYPE_WHATSAPP
272 |
273 | ### couponLineItems
274 |
275 | **Type:** Collection (Read Only)
276 |
277 | A sorted collection of the coupon line items in the container. The coupon line items are returned in the
278 | order they were added to container.
279 |
280 | ### currencyCode
281 |
282 | **Type:** String (Read Only)
283 |
284 | The currency code for this line item container. The currency code is a 3-character currency mnemonic such
285 | as 'USD' or 'EUR'. The currency code represents the currency in which the calculation is made, and in which the
286 | buyer sees all prices in the store front.
287 |
288 | ### customer
289 |
290 | **Type:** Customer (Read Only)
291 |
292 | The customer associated with this container.
293 |
294 | ### customerEmail
295 |
296 | **Type:** String
297 |
298 | The email of the customer associated with this container.
299 |
300 | ### customerName
301 |
302 | **Type:** String
303 |
304 | The name of the customer associated with this container.
305 |
306 | ### customerNo
307 |
308 | **Type:** String (Read Only)
309 |
310 | The customer number of the customer associated with this container.
311 |
312 | ### defaultShipment
313 |
314 | **Type:** Shipment (Read Only)
315 |
316 | The default shipment of the line item container. Every basket and order has a default shipment with the
317 | id "me". If you call a process that accesses a shipment, and you don't specify the shipment, then the process
318 | uses the default shipment. You can't remove a default shipment. Calling removeShipment(Shipment) on it
319 | throws an exception.
320 |
321 | ### etag
322 |
323 | **Type:** String (Read Only)
324 |
325 | The Etag of the line item container. The Etag is a hash that represents the overall container state
326 | including any associated objects like line items.
327 |
328 | ### externallyTaxed
329 |
330 | **Type:** boolean (Read Only)
331 |
332 | Use this method to check whether the LineItemCtnr is calculated based on external tax tables.
333 |
334 | Note: a basket can only be created in EXTERNAL tax mode using SCAPI.
335 |
336 | ### giftCertificateLineItems
337 |
338 | **Type:** Collection (Read Only)
339 |
340 | All gift certificate line items of the container.
341 |
342 | ### giftCertificatePaymentInstruments
343 |
344 | **Type:** Collection (Read Only)
345 |
346 | An unsorted collection of the PaymentInstrument instances that represent GiftCertificates in this
347 | container.
348 |
349 | ### giftCertificateTotalGrossPrice
350 |
351 | **Type:** Money (Read Only)
352 |
353 | The total gross price of all gift certificates in the cart. Should usually be equal to total net price.
354 |
355 | ### giftCertificateTotalNetPrice
356 |
357 | **Type:** Money (Read Only)
358 |
359 | The total net price (excluding tax) of all gift certificates in the cart. Should usually be equal to
360 | total gross price.
361 |
362 | ### giftCertificateTotalPrice
363 |
364 | **Type:** Money (Read Only)
365 |
366 | The gift certificate total price. If the line item container is based on net pricing the gift certificate
367 | total net price is returned. If the line item container is based on gross pricing the gift certificate total
368 | gross price is returned.
369 |
370 | ### giftCertificateTotalTax
371 |
372 | **Type:** Money (Read Only)
373 |
374 | The total tax of all gift certificates in the cart. Should usually be 0.0.
375 |
376 | ### merchandizeTotalGrossPrice
377 |
378 | **Type:** Money (Read Only)
379 |
380 | The total gross price (including tax) in purchase currency. Merchandize total prices represent the sum of
381 | product prices before services such as shipping or adjustment from promotions have been added.
382 |
383 | ### merchandizeTotalNetPrice
384 |
385 | **Type:** Money (Read Only)
386 |
387 | The total net price (excluding tax) in purchase currency. Merchandize total prices represent the sum of
388 | product prices before services such as shipping or adjustment from promotion have been added.
389 |
390 | ### merchandizeTotalPrice
391 |
392 | **Type:** Money (Read Only)
393 |
394 | The merchandize total price. If the line item container is based on net pricing the merchandize total net
395 | price is returned. If the line item container is based on gross pricing the merchandize total gross price is
396 | returned.
397 |
398 | ### merchandizeTotalTax
399 |
400 | **Type:** Money (Read Only)
401 |
402 | The total tax in purchase currency. Merchandize total prices represent the sum of product prices before
403 | services such as shipping or adjustment from promotions have been added.
404 |
405 | ### notes
406 |
407 | **Type:** List (Read Only)
408 |
409 | The list of notes for this object, ordered by creation time from oldest to newest.
410 |
411 | ### paymentInstrument
412 |
413 | **Type:** OrderPaymentInstrument (Read Only)
414 |
415 | The payment instrument of the line item container or null. This method is deprecated. You should use
416 | getPaymentInstruments() or getGiftCertificatePaymentInstruments() instead.
417 |
418 | ### paymentInstruments
419 |
420 | **Type:** Collection (Read Only)
421 |
422 | An unsorted collection of the payment instruments in this container.
423 |
424 | ### priceAdjustments
425 |
426 | **Type:** Collection (Read Only)
427 |
428 | The collection of price adjustments that have been applied to the totals such as promotion on the
429 | purchase value (i.e. $10 Off or 10% Off). The price adjustments are sorted by the order in which they were
430 | applied to the order by the promotions engine.
431 |
432 | ### productLineItems
433 |
434 | **Type:** Collection (Read Only)
435 |
436 | The product line items of the container that are not dependent on other product line items. This includes
437 | line items representing bonus products in the container but excludes option, bundled, and bonus line items. The
438 | returned collection is sorted by the position attribute of the product line items.
439 |
440 | ### productQuantities
441 |
442 | **Type:** HashMap (Read Only)
443 |
444 | A hash map of all products in the line item container and their total quantities. The total product
445 | quantity is for example used to lookup the product price.
446 |
447 | The method counts all direct product line items, plus dependent product line items that are not bundled line
448 | items and no option line items. It also excludes product line items that are not associated to any catalog
449 | product, and bonus product line items.
450 |
451 | ### productQuantityTotal
452 |
453 | **Type:** Number (Read Only)
454 |
455 | The total quantity of all product line items. Not included are bundled line items and option line items.
456 |
457 | ### shipments
458 |
459 | **Type:** Collection (Read Only)
460 |
461 | All shipments of the line item container.
462 | The first shipment in the returned collection is the default shipment (shipment ID always set to "me"). All other
463 | shipments are sorted ascending by shipment ID.
464 |
465 | ### shippingPriceAdjustments
466 |
467 | **Type:** Collection (Read Only)
468 |
469 | The of shipping price adjustments applied to the shipping total of the container. Note that the
470 | promotions engine only applies shipping price adjustments to the the default shipping line item of shipments, and
471 | never to the container.
472 |
473 | ### shippingTotalGrossPrice
474 |
475 | **Type:** Money (Read Only)
476 |
477 | The sum of all shipping line items of the line item container, including tax before shipping adjustments
478 | have been applied.
479 |
480 | ### shippingTotalNetPrice
481 |
482 | **Type:** Money (Read Only)
483 |
484 | The sum of all shipping line items of the line item container, excluding tax before shipping adjustments
485 | have been applied.
486 |
487 | ### shippingTotalPrice
488 |
489 | **Type:** Money (Read Only)
490 |
491 | The shipping total price. If the line item container is based on net pricing the shipping total net price
492 | is returned. If the line item container is based on gross pricing the shipping total gross price is returned.
493 |
494 | ### shippingTotalTax
495 |
496 | **Type:** Money (Read Only)
497 |
498 | The tax of all shipping line items of the line item container before shipping adjustments have been
499 | applied.
500 |
501 | ### taxRoundedAtGroup
502 |
503 | **Type:** boolean (Read Only)
504 |
505 | Use this method to check if the LineItemCtnr was calculated with grouped taxation calculation.
506 |
507 | If the tax is rounded on group level, the tax is applied to the summed-up tax basis for each tax rate.
508 |
509 | ### taxTotalsPerTaxRate
510 |
511 | **Type:** SortedMap (Read Only)
512 |
513 | This method returns a SortedMap in which the keys are Decimal tax rates and the values
514 | are Money total tax for the tax rate. The map is unmodifiable.
515 |
516 | ### totalGrossPrice
517 |
518 | **Type:** Money (Read Only)
519 |
520 | The grand total price gross of tax for LineItemCtnr, in purchase currency. Total prices represent the sum
521 | of product prices, services prices and adjustments.
522 |
523 | ### totalNetPrice
524 |
525 | **Type:** Money (Read Only)
526 |
527 | The grand total price for LineItemCtnr net of tax, in purchase currency. Total prices represent the sum
528 | of product prices, services prices and adjustments.
529 |
530 | ### totalTax
531 |
532 | **Type:** Money (Read Only)
533 |
534 | The grand total tax for LineItemCtnr, in purchase currency. Total prices represent the sum of product
535 | prices, services prices and adjustments.
536 |
537 | ## Constructor Summary
538 |
539 | ## Method Summary
540 |
541 | ### addNote
542 |
543 | **Signature:** `addNote(subject : String, text : String) : Note`
544 |
545 | Adds a note to the object.
546 |
547 | ### createBillingAddress
548 |
549 | **Signature:** `createBillingAddress() : OrderAddress`
550 |
551 | Create a billing address for the LineItemCtnr.
552 |
553 | ### createBonusProductLineItem
554 |
555 | **Signature:** `createBonusProductLineItem(bonusDiscountLineItem : BonusDiscountLineItem, product : Product, optionModel : ProductOptionModel, shipment : Shipment) : ProductLineItem`
556 |
557 | Creates a product line item in the container based on the passed Product and BonusDiscountLineItem.
558 |
559 | ### createCouponLineItem
560 |
561 | **Signature:** `createCouponLineItem(couponCode : String, campaignBased : boolean) : CouponLineItem`
562 |
563 | Creates a new CouponLineItem for this container based on the supplied coupon code.
564 |
565 | ### createCouponLineItem
566 |
567 | **Signature:** `createCouponLineItem(couponCode : String) : CouponLineItem`
568 |
569 | Creates a coupon line item that is not based on the B2C Commerce campaign system and associates it with the specified coupon code.
570 |
571 | ### createGiftCertificateLineItem
572 |
573 | **Signature:** `createGiftCertificateLineItem(amount : Number, recipientEmail : String) : GiftCertificateLineItem`
574 |
575 | Creates a gift certificate line item.
576 |
577 | ### createGiftCertificatePaymentInstrument
578 |
579 | **Signature:** `createGiftCertificatePaymentInstrument(giftCertificateCode : String, amount : Money) : OrderPaymentInstrument`
580 |
581 | Creates an OrderPaymentInstrument representing a Gift Certificate.
582 |
583 | ### createPaymentInstrument
584 |
585 | **Signature:** `createPaymentInstrument(paymentMethodId : String, amount : Money) : OrderPaymentInstrument`
586 |
587 | Creates a payment instrument using the specified payment method id and amount.
588 |
589 | ### createPaymentInstrumentFromWallet
590 |
591 | **Signature:** `createPaymentInstrumentFromWallet(walletPaymentInstrument : CustomerPaymentInstrument, amount : Money) : OrderPaymentInstrument`
592 |
593 | Creates a payment instrument using the specified wallet payment instrument and amount.
594 |
595 | ### createPriceAdjustment
596 |
597 | **Signature:** `createPriceAdjustment(promotionID : String) : PriceAdjustment`
598 |
599 | Creates an order price adjustment. The promotion id is mandatory and must not be the ID of any actual promotion defined in B2C Commerce; otherwise an exception is thrown.
600 |
601 | ### createPriceAdjustment
602 |
603 | **Signature:** `createPriceAdjustment(promotionID : String, discount : Discount) : PriceAdjustment`
604 |
605 | Creates an order level price adjustment for a specific discount. The promotion id is mandatory and must not be the ID of any actual promotion defined in B2C Commerce; otherwise an exception is thrown.
606 |
607 | ### createProductLineItem
608 |
609 | **Signature:** `createProductLineItem(productID : String, quantity : Quantity, shipment : Shipment) : ProductLineItem`
610 |
611 | Creates a new product line item in the container and assigns it to the specified shipment.
612 |
613 | ### createProductLineItem
614 |
615 | **Signature:** `createProductLineItem(productID : String, shipment : Shipment) : ProductLineItem`
616 |
617 | Creates a new product line item in the container and assigns it to the specified shipment.
618 |
619 | ### createProductLineItem
620 |
621 | **Signature:** `createProductLineItem(productListItem : ProductListItem, shipment : Shipment) : ProductLineItem`
622 |
623 | Creates a new product line item in the basket and assigns it to the specified shipment.
624 |
625 | ### createProductLineItem
626 |
627 | **Signature:** `createProductLineItem(product : Product, optionModel : ProductOptionModel, shipment : Shipment) : ProductLineItem`
628 |
629 | Creates a new product line item in the container and assigns it to the specified shipment.
630 |
631 | ### createShipment
632 |
633 | **Signature:** `createShipment(id : String) : Shipment`
634 |
635 | Creates a standard shipment for the line item container.
636 |
637 | ### createShippingPriceAdjustment
638 |
639 | **Signature:** `createShippingPriceAdjustment(promotionID : String) : PriceAdjustment`
640 |
641 | Creates a shipping price adjustment to be applied to the container.
642 |
643 | ### getAdjustedMerchandizeTotalGrossPrice
644 |
645 | **Signature:** `getAdjustedMerchandizeTotalGrossPrice() : Money`
646 |
647 | Returns the adjusted total gross price (including tax) in purchase currency.
648 |
649 | ### getAdjustedMerchandizeTotalNetPrice
650 |
651 | **Signature:** `getAdjustedMerchandizeTotalNetPrice() : Money`
652 |
653 | Returns the total net price (excluding tax) in purchase currency.
654 |
655 | ### getAdjustedMerchandizeTotalPrice
656 |
657 | **Signature:** `getAdjustedMerchandizeTotalPrice() : Money`
658 |
659 | Returns the adjusted merchandize total price including product-level and order-level adjustments.
660 |
661 | ### getAdjustedMerchandizeTotalPrice
662 |
663 | **Signature:** `getAdjustedMerchandizeTotalPrice(applyOrderLevelAdjustments : boolean) : Money`
664 |
665 | Returns the adjusted merchandize total price including order-level adjustments if requested.
666 |
667 | ### getAdjustedMerchandizeTotalTax
668 |
669 | **Signature:** `getAdjustedMerchandizeTotalTax() : Money`
670 |
671 | Returns the subtotal tax in purchase currency.
672 |
673 | ### getAdjustedShippingTotalGrossPrice
674 |
675 | **Signature:** `getAdjustedShippingTotalGrossPrice() : Money`
676 |
677 | Returns the adjusted sum of all shipping line items of the line item container, including tax after shipping adjustments have been applied.
678 |
679 | ### getAdjustedShippingTotalNetPrice
680 |
681 | **Signature:** `getAdjustedShippingTotalNetPrice() : Money`
682 |
683 | Returns the sum of all shipping line items of the line item container, excluding tax after shipping adjustments have been applied.
684 |
685 | ### getAdjustedShippingTotalPrice
686 |
687 | **Signature:** `getAdjustedShippingTotalPrice() : Money`
688 |
689 | Returns the adjusted shipping total price.
690 |
691 | ### getAdjustedShippingTotalTax
692 |
693 | **Signature:** `getAdjustedShippingTotalTax() : Money`
694 |
695 | Returns the tax of all shipping line items of the line item container after shipping adjustments have been applied.
696 |
697 | ### getAllGiftCertificateLineItems
698 |
699 | **Signature:** `getAllGiftCertificateLineItems() : Collection`
700 |
701 | Returns all gift certificate line items of the container.
702 |
703 | ### getAllLineItems
704 |
705 | **Signature:** `getAllLineItems() : Collection`
706 |
707 | Returns all product, shipping, price adjustment, and gift certificate line items of the line item container.
708 |
709 | ### getAllProductLineItems
710 |
711 | **Signature:** `getAllProductLineItems() : Collection`
712 |
713 | Returns all product line items of the container, no matter if they are dependent or independent.
714 |
715 | ### getAllProductLineItems
716 |
717 | **Signature:** `getAllProductLineItems(productID : String) : Collection`
718 |
719 | Returns all product line items of the container that have a product ID equal to the specified product ID, no matter if they are dependent or independent.
720 |
721 | ### getAllProductQuantities
722 |
723 | **Signature:** `getAllProductQuantities() : HashMap`
724 |
725 | Returns a hash mapping all products in the line item container to their total quantities.
726 |
727 | ### getAllShippingPriceAdjustments
728 |
729 | **Signature:** `getAllShippingPriceAdjustments() : Collection`
730 |
731 | Returns the collection of all shipping price adjustments applied somewhere in the container.
732 |
733 | ### getBillingAddress
734 |
735 | **Signature:** `getBillingAddress() : OrderAddress`
736 |
737 | Returns the billing address defined for the container.
738 |
739 | ### getBonusDiscountLineItems
740 |
741 | **Signature:** `getBonusDiscountLineItems() : Collection`
742 |
743 | Returns an unsorted collection of the the bonus discount line items associated with this container.
744 |
745 | ### getBonusLineItems
746 |
747 | **Signature:** `getBonusLineItems() : Collection`
748 |
749 | Returns the collection of product line items that are bonus items (where ProductLineItem.isBonusProductLineItem() is true).
750 |
751 | ### getBusinessType
752 |
753 | **Signature:** `getBusinessType() : EnumValue`
754 |
755 | Returns the type of the business this order has been placed in. Possible values are BUSINESS_TYPE_B2C or BUSINESS_TYPE_B2B.
756 |
757 | ### getChannelType
758 |
759 | **Signature:** `getChannelType() : EnumValue`
760 |
761 | The channel type defines in which sales channel this order has been created.
762 |
763 | ### getCouponLineItem
764 |
765 | **Signature:** `getCouponLineItem(couponCode : String) : CouponLineItem`
766 |
767 | Returns the coupon line item representing the specified coupon code.
768 |
769 | ### getCouponLineItems
770 |
771 | **Signature:** `getCouponLineItems() : Collection`
772 |
773 | Returns a sorted collection of the coupon line items in the container.
774 |
775 | ### getCurrencyCode
776 |
777 | **Signature:** `getCurrencyCode() : String`
778 |
779 | Returns the currency code for this line item container.
780 |
781 | ### getCustomer
782 |
783 | **Signature:** `getCustomer() : Customer`
784 |
785 | Returns the customer associated with this container.
786 |
787 | ### getCustomerEmail
788 |
789 | **Signature:** `getCustomerEmail() : String`
790 |
791 | Returns the email of the customer associated with this container.
792 |
793 | ### getCustomerName
794 |
795 | **Signature:** `getCustomerName() : String`
796 |
797 | Returns the name of the customer associated with this container.
798 |
799 | ### getCustomerNo
800 |
801 | **Signature:** `getCustomerNo() : String`
802 |
803 | Returns the customer number of the customer associated with this container.
804 |
805 | ### getDefaultShipment
806 |
807 | **Signature:** `getDefaultShipment() : Shipment`
808 |
809 | Returns the default shipment of the line item container.
810 |
811 | ### getEtag
812 |
813 | **Signature:** `getEtag() : String`
814 |
815 | Returns the Etag of the line item container.
816 |
817 | ### getGiftCertificateLineItems
818 |
819 | **Signature:** `getGiftCertificateLineItems() : Collection`
820 |
821 | Returns all gift certificate line items of the container.
822 |
823 | ### getGiftCertificateLineItems
824 |
825 | **Signature:** `getGiftCertificateLineItems(giftCertificateId : String) : Collection`
826 |
827 | Returns all gift certificate line items of the container, no matter if they are dependent or independent.
828 |
829 | ### getGiftCertificatePaymentInstruments
830 |
831 | **Signature:** `getGiftCertificatePaymentInstruments() : Collection`
832 |
833 | Returns an unsorted collection of the PaymentInstrument instances that represent GiftCertificates in this container.
834 |
835 | ### getGiftCertificatePaymentInstruments
836 |
837 | **Signature:** `getGiftCertificatePaymentInstruments(giftCertificateCode : String) : Collection`
838 |
839 | Returns an unsorted collection containing all PaymentInstruments of type PaymentInstrument.METHOD_GIFT_CERTIFICATE where the specified code is the same code on the payment instrument.
840 |
841 | ### getGiftCertificateTotalGrossPrice
842 |
843 | **Signature:** `getGiftCertificateTotalGrossPrice() : Money`
844 |
845 | Returns the total gross price of all gift certificates in the cart.
846 |
847 | ### getGiftCertificateTotalNetPrice
848 |
849 | **Signature:** `getGiftCertificateTotalNetPrice() : Money`
850 |
851 | Returns the total net price (excluding tax) of all gift certificates in the cart.
852 |
853 | ### getGiftCertificateTotalPrice
854 |
855 | **Signature:** `getGiftCertificateTotalPrice() : Money`
856 |
857 | Returns the gift certificate total price.
858 |
859 | ### getGiftCertificateTotalTax
860 |
861 | **Signature:** `getGiftCertificateTotalTax() : Money`
862 |
863 | Returns the total tax of all gift certificates in the cart.
864 |
865 | ### getMerchandizeTotalGrossPrice
866 |
867 | **Signature:** `getMerchandizeTotalGrossPrice() : Money`
868 |
869 | Returns the total gross price (including tax) in purchase currency.
870 |
871 | ### getMerchandizeTotalNetPrice
872 |
873 | **Signature:** `getMerchandizeTotalNetPrice() : Money`
874 |
875 | Returns the total net price (excluding tax) in purchase currency.
876 |
877 | ### getMerchandizeTotalPrice
878 |
879 | **Signature:** `getMerchandizeTotalPrice() : Money`
880 |
881 | Returns the merchandize total price.
882 |
883 | ### getMerchandizeTotalTax
884 |
885 | **Signature:** `getMerchandizeTotalTax() : Money`
886 |
887 | Returns the total tax in purchase currency.
888 |
889 | ### getNotes
890 |
891 | **Signature:** `getNotes() : List`
892 |
893 | Returns the list of notes for this object, ordered by creation time from oldest to newest.
894 |
895 | ### getPaymentInstrument
896 |
897 | **Signature:** `getPaymentInstrument() : OrderPaymentInstrument`
898 |
899 | Returns the payment instrument of the line item container or null.
900 |
901 | ### getPaymentInstruments
902 |
903 | **Signature:** `getPaymentInstruments() : Collection`
904 |
905 | Returns an unsorted collection of the payment instruments in this container.
906 |
907 | ### getPaymentInstruments
908 |
909 | **Signature:** `getPaymentInstruments(paymentMethodID : String) : Collection`
910 |
911 | Returns an unsorted collection of PaymentInstrument instances based on the specified payment method ID.
912 |
913 | ### getPriceAdjustmentByPromotionID
914 |
915 | **Signature:** `getPriceAdjustmentByPromotionID(promotionID : String) : PriceAdjustment`
916 |
917 | Returns the price adjustment associated to the specified promotion ID.
918 |
919 | ### getPriceAdjustments
920 |
921 | **Signature:** `getPriceAdjustments() : Collection`
922 |
923 | Returns the collection of price adjustments that have been applied to the totals such as promotion on the purchase value (i.e.
924 |
925 | ### getProductLineItems
926 |
927 | **Signature:** `getProductLineItems() : Collection`
928 |
929 | Returns the product line items of the container that are not dependent on other product line items.
930 |
931 | ### getProductLineItems
932 |
933 | **Signature:** `getProductLineItems(productID : String) : Collection`
934 |
935 | Returns the product line items of the container that have a product ID equal to the specified product ID and that are not dependent on other product line items.
936 |
937 | ### getProductQuantities
938 |
939 | **Signature:** `getProductQuantities() : HashMap`
940 |
941 | Returns a hash map of all products in the line item container and their total quantities.
942 |
943 | ### getProductQuantities
944 |
945 | **Signature:** `getProductQuantities(includeBonusProducts : boolean) : HashMap`
946 |
947 | Returns a hash map of all products in the line item container and their total quantities.
948 |
949 | ### getProductQuantityTotal
950 |
951 | **Signature:** `getProductQuantityTotal() : Number`
952 |
953 | Returns the total quantity of all product line items.
954 |
955 | ### getShipment
956 |
957 | **Signature:** `getShipment(id : String) : Shipment`
958 |
959 | Returns the shipment for the specified ID or null if no shipment with this ID exists in the line item container.
960 |
961 | ### getShipments
962 |
963 | **Signature:** `getShipments() : Collection`
964 |
965 | Returns all shipments of the line item container. The first shipment in the returned collection is the default shipment (shipment ID always set to "me").
966 |
967 | ### getShippingPriceAdjustmentByPromotionID
968 |
969 | **Signature:** `getShippingPriceAdjustmentByPromotionID(promotionID : String) : PriceAdjustment`
970 |
971 | Returns the shipping price adjustment associated with the specified promotion ID.
972 |
973 | ### getShippingPriceAdjustments
974 |
975 | **Signature:** `getShippingPriceAdjustments() : Collection`
976 |
977 | Returns the of shipping price adjustments applied to the shipping total of the container.
978 |
979 | ### getShippingTotalGrossPrice
980 |
981 | **Signature:** `getShippingTotalGrossPrice() : Money`
982 |
983 | Returns the sum of all shipping line items of the line item container, including tax before shipping adjustments have been applied.
984 |
985 | ### getShippingTotalNetPrice
986 |
987 | **Signature:** `getShippingTotalNetPrice() : Money`
988 |
989 | Returns the sum of all shipping line items of the line item container, excluding tax before shipping adjustments have been applied.
990 |
991 | ### getShippingTotalPrice
992 |
993 | **Signature:** `getShippingTotalPrice() : Money`
994 |
995 | Returns the shipping total price.
996 |
997 | ### getShippingTotalTax
998 |
999 | **Signature:** `getShippingTotalTax() : Money`
1000 |
1001 | Returns the tax of all shipping line items of the line item container before shipping adjustments have been applied.
1002 |
1003 | ### getTaxTotalsPerTaxRate
1004 |
1005 | **Signature:** `getTaxTotalsPerTaxRate() : SortedMap`
1006 |
1007 | This method returns a SortedMap in which the keys are Decimal tax rates and the values are Money total tax for the tax rate.
1008 |
1009 | ### getTotalGrossPrice
1010 |
1011 | **Signature:** `getTotalGrossPrice() : Money`
1012 |
1013 | Returns the grand total price gross of tax for LineItemCtnr, in purchase currency.
1014 |
1015 | ### getTotalNetPrice
1016 |
1017 | **Signature:** `getTotalNetPrice() : Money`
1018 |
1019 | Returns the grand total price for LineItemCtnr net of tax, in purchase currency.
1020 |
1021 | ### getTotalTax
1022 |
1023 | **Signature:** `getTotalTax() : Money`
1024 |
1025 | Returns the grand total tax for LineItemCtnr, in purchase currency.
1026 |
1027 | ### isExternallyTaxed
1028 |
1029 | **Signature:** `isExternallyTaxed() : boolean`
1030 |
1031 | Use this method to check whether the LineItemCtnr is calculated based on external tax tables.
1032 |
1033 | ### isTaxRoundedAtGroup
1034 |
1035 | **Signature:** `isTaxRoundedAtGroup() : boolean`
1036 |
1037 | Use this method to check if the LineItemCtnr was calculated with grouped taxation calculation.
1038 |
1039 | ### removeAllPaymentInstruments
1040 |
1041 | **Signature:** `removeAllPaymentInstruments() : void`
1042 |
1043 | Removes the all Payment Instruments from this container and deletes the Payment Instruments.
1044 |
1045 | ### removeBonusDiscountLineItem
1046 |
1047 | **Signature:** `removeBonusDiscountLineItem(bonusDiscountLineItem : BonusDiscountLineItem) : void`
1048 |
1049 | Removes the specified bonus discount line item from the line item container.
1050 |
1051 | ### removeCouponLineItem
1052 |
1053 | **Signature:** `removeCouponLineItem(couponLineItem : CouponLineItem) : void`
1054 |
1055 | Removes the specified coupon line item from the line item container.
1056 |
1057 | ### removeGiftCertificateLineItem
1058 |
1059 | **Signature:** `removeGiftCertificateLineItem(giftCertificateLineItem : GiftCertificateLineItem) : void`
1060 |
1061 | Removes the specified gift certificate line item from the line item container.
1062 |
1063 | ### removeNote
1064 |
1065 | **Signature:** `removeNote(note : Note) : void`
1066 |
1067 | Removes a note from this line item container and deletes it.
1068 |
1069 | ### removePaymentInstrument
1070 |
1071 | **Signature:** `removePaymentInstrument(pi : PaymentInstrument) : void`
1072 |
1073 | Removes the specified Payment Instrument from this container and deletes the Payment Instrument.
1074 |
1075 | ### removePriceAdjustment
1076 |
1077 | **Signature:** `removePriceAdjustment(priceAdjustment : PriceAdjustment) : void`
1078 |
1079 | Removes the specified price adjustment line item from the line item container.
1080 |
1081 | ### removeProductLineItem
1082 |
1083 | **Signature:** `removeProductLineItem(productLineItem : ProductLineItem) : void`
1084 |
1085 | Removes the specified product line item from the line item container.
1086 |
1087 | ### removeShipment
1088 |
1089 | **Signature:** `removeShipment(shipment : Shipment) : void`
1090 |
1091 | Removes the specified shipment and all associated product, gift certificate, shipping and price adjustment line items from the line item container.
1092 |
1093 | ### removeShippingPriceAdjustment
1094 |
1095 | **Signature:** `removeShippingPriceAdjustment(priceAdjustment : PriceAdjustment) : void`
1096 |
1097 | Removes the specified shipping price adjustment line item from the line item container.
1098 |
1099 | ### setCustomerEmail
1100 |
1101 | **Signature:** `setCustomerEmail(aValue : String) : void`
1102 |
1103 | Sets the email address of the customer associated with this container.
1104 |
1105 | ### setCustomerName
1106 |
1107 | **Signature:** `setCustomerName(aValue : String) : void`
1108 |
1109 | Sets the name of the customer associated with this container.
1110 |
1111 | ### updateOrderLevelPriceAdjustmentTax
1112 |
1113 | **Signature:** `updateOrderLevelPriceAdjustmentTax() : void`
1114 |
1115 | Calculates the tax for all shipping and order-level merchandise price adjustments in this LineItemCtnr.
1116 |
1117 | ### updateTotals
1118 |
1119 | **Signature:** `updateTotals() : void`
1120 |
1121 | Recalculates the totals of the line item container.
1122 |
1123 | ### verifyPriceAdjustmentLimits
1124 |
1125 | **Signature:** `verifyPriceAdjustmentLimits() : Status`
1126 |
1127 | Verifies whether the manual price adjustments made for the line item container exceed the corresponding limits for the current user and the current site.
1128 |
1129 | ## Method Detail
1130 |
1131 | ## Method Details
1132 |
1133 | ### addNote
1134 |
1135 | **Signature:** `addNote(subject : String, text : String) : Note`
1136 |
1137 | **Description:** Adds a note to the object.
1138 |
1139 | **Parameters:**
1140 |
1141 | - `subject`: The subject of the note.
1142 | - `text`: The text of the note. Must be no more than 4000 characters or an exception is thrown.
1143 |
1144 | **Returns:**
1145 |
1146 | the added note.
1147 |
1148 | ---
1149 |
1150 | ### createBillingAddress
1151 |
1152 | **Signature:** `createBillingAddress() : OrderAddress`
1153 |
1154 | **Description:** Create a billing address for the LineItemCtnr. A LineItemCtnr (e.g. basket) initially has no billing address. This method creates a billing address for the LineItemCtnr and replaces an existing billing address.
1155 |
1156 | **Returns:**
1157 |
1158 | The new billing address of the LineItemCtnr.
1159 |
1160 | ---
1161 |
1162 | ### createBonusProductLineItem
1163 |
1164 | **Signature:** `createBonusProductLineItem(bonusDiscountLineItem : BonusDiscountLineItem, product : Product, optionModel : ProductOptionModel, shipment : Shipment) : ProductLineItem`
1165 |
1166 | **Description:** Creates a product line item in the container based on the passed Product and BonusDiscountLineItem. The product must be assigned to the current site catalog and must also be a bonus product of the specified BonusDiscountLineItem or an exception is thrown. The line item is always created in the default shipment. If successful, the operation always creates a new ProductLineItem and never simply increments the quantity of an existing ProductLineItem. An option model can optionally be specified.
1167 |
1168 | **Parameters:**
1169 |
1170 | - `bonusDiscountLineItem`: Line item representing an applied BonusChoiceDiscount in the LineItemCtnr, must not be null.
1171 | - `product`: Product The product to add to the LineItemCtnr. Must not be null and must be a bonus product of bonusDiscountLineItem.
1172 | - `optionModel`: ProductOptionModel or null.
1173 | - `shipment`: The shipment to add the bonus product to. If null, the product is added to the default shipment.
1174 |
1175 | ---
1176 |
1177 | ### createCouponLineItem
1178 |
1179 | **Signature:** `createCouponLineItem(couponCode : String, campaignBased : boolean) : CouponLineItem`
1180 |
1181 | **Description:** Creates a new CouponLineItem for this container based on the supplied coupon code. The created coupon line item is based on the B2C Commerce campaign system if campaignBased parameter is true. In that case, if the supplied coupon code is not valid, APIException with type 'CreateCouponLineItemException' is thrown. If you want to create a custom coupon line item, you must call this method with campaignBased = false or to use createCouponLineItem(String). Example: try { var cli : CouponLineItem = basket.createCouponLineItem(couponCode, true); } catch (e if e instanceof APIException && e.type === 'CreateCouponLineItemException') if (e.errorCode == CouponStatusCodes.COUPON_CODE_ALREADY_IN_BASKET) { ... } } An dw.order.CreateCouponLineItemException is thrown in case of campaignBased = true only. Indicates that the provided coupon code is not a valid coupon code to create a coupon line item based on the B2C Commerce campaign system. The error code property (CreateCouponLineItemException.errorCode) will be set to one of the following values: CouponStatusCodes.COUPON_CODE_ALREADY_IN_BASKET = Indicates that coupon code has already been added to basket. CouponStatusCodes.COUPON_ALREADY_IN_BASKET = Indicates that another code of the same MultiCode/System coupon has already been added to basket. CouponStatusCodes.COUPON_CODE_ALREADY_REDEEMED = Indicates that code of MultiCode/System coupon has already been redeemed. CouponStatusCodes.COUPON_CODE_UNKNOWN = Indicates that coupon not found for given coupon code or that the code itself was not found. CouponStatusCodes.COUPON_DISABLED = Indicates that coupon is not enabled. CouponStatusCodes.REDEMPTION_LIMIT_EXCEEDED = Indicates that number of redemptions per code exceeded. CouponStatusCodes.CUSTOMER_REDEMPTION_LIMIT_EXCEEDED = Indicates that number of redemptions per code and customer exceeded. CouponStatusCodes.TIMEFRAME_REDEMPTION_LIMIT_EXCEEDED = Indicates that number of redemptions per code, customer and time exceeded. CouponStatusCodes.NO_ACTIVE_PROMOTION = Indicates that coupon is not assigned to an active promotion.
1182 |
1183 | **Parameters:**
1184 |
1185 | - `couponCode`: the coupon code to be represented by the coupon line item
1186 | - `campaignBased`: the flag if the created coupon line item should be based on the B2C Commerce campaign system
1187 |
1188 | **Returns:**
1189 |
1190 | the created coupon line item
1191 |
1192 | ---
1193 |
1194 | ### createCouponLineItem
1195 |
1196 | **Signature:** `createCouponLineItem(couponCode : String) : CouponLineItem`
1197 |
1198 | **Description:** Creates a coupon line item that is not based on the B2C Commerce campaign system and associates it with the specified coupon code. There may not be any other coupon line item in the container with the specific coupon code, otherwise an exception is thrown. If you want to create a coupon line item based on the B2C Commerce campaign system, you must use createCouponLineItem(String, Boolean) with campaignBased = true.
1199 |
1200 | **Parameters:**
1201 |
1202 | - `couponCode`: couponCode represented by the coupon line item.
1203 |
1204 | **Returns:**
1205 |
1206 | New coupon line item.
1207 |
1208 | ---
1209 |
1210 | ### createGiftCertificateLineItem
1211 |
1212 | **Signature:** `createGiftCertificateLineItem(amount : Number, recipientEmail : String) : GiftCertificateLineItem`
1213 |
1214 | **Description:** Creates a gift certificate line item.
1215 |
1216 | **Parameters:**
1217 |
1218 | - `amount`: the amount of the gift certificate - mandatory
1219 | - `recipientEmail`: the recipient's email address - mandatory
1220 |
1221 | **Returns:**
1222 |
1223 | The new gift certificate line item
1224 |
1225 | ---
1226 |
1227 | ### createGiftCertificatePaymentInstrument
1228 |
1229 | **Signature:** `createGiftCertificatePaymentInstrument(giftCertificateCode : String, amount : Money) : OrderPaymentInstrument`
1230 |
1231 | **Description:** Creates an OrderPaymentInstrument representing a Gift Certificate. The amount is set on a PaymentTransaction that is accessible via the OrderPaymentInstrument. By default, the status of the PaymentTransaction is set to CREATE. The PaymentTransaction must be processed at a later time.
1232 |
1233 | **Parameters:**
1234 |
1235 | - `giftCertificateCode`: the redemption code of the Gift Certificate.
1236 | - `amount`: the amount to set on the PaymentTransaction. If the OrderPaymentInstrument is actually redeemed, this is the amount that will be deducted from the Gift Certificate.
1237 |
1238 | **Returns:**
1239 |
1240 | the OrderPaymentInstrument.
1241 |
1242 | ---
1243 |
1244 | ### createPaymentInstrument
1245 |
1246 | **Signature:** `createPaymentInstrument(paymentMethodId : String, amount : Money) : OrderPaymentInstrument`
1247 |
1248 | **Description:** Creates a payment instrument using the specified payment method id and amount. The amount is set on the PaymentTransaction that is attached to the payment instrument.
1249 |
1250 | **Parameters:**
1251 |
1252 | - `paymentMethodId`: The payment method id. See the PaymentInstrument class for payment method types
1253 | - `amount`: The payment amount or null
1254 |
1255 | **Returns:**
1256 |
1257 | The new payment instrument
1258 |
1259 | ---
1260 |
1261 | ### createPaymentInstrumentFromWallet
1262 |
1263 | **Signature:** `createPaymentInstrumentFromWallet(walletPaymentInstrument : CustomerPaymentInstrument, amount : Money) : OrderPaymentInstrument`
1264 |
1265 | **Description:** Creates a payment instrument using the specified wallet payment instrument and amount. The amount is set on the PaymentTransaction that is attached to the payment instrument. All data from the wallet payment instrument will be copied over to the created payment instrument.
1266 |
1267 | **Parameters:**
1268 |
1269 | - `walletPaymentInstrument`: The payment instrument from the customer's walled.
1270 | - `amount`: The payment amount or null
1271 |
1272 | **Returns:**
1273 |
1274 | The new payment instrument
1275 |
1276 | ---
1277 |
1278 | ### createPriceAdjustment
1279 |
1280 | **Signature:** `createPriceAdjustment(promotionID : String) : PriceAdjustment`
1281 |
1282 | **Description:** Creates an order price adjustment. The promotion id is mandatory and must not be the ID of any actual promotion defined in B2C Commerce; otherwise an exception is thrown.
1283 |
1284 | **Parameters:**
1285 |
1286 | - `promotionID`: Promotion ID
1287 |
1288 | **Returns:**
1289 |
1290 | The new price adjustment
1291 |
1292 | ---
1293 |
1294 | ### createPriceAdjustment
1295 |
1296 | **Signature:** `createPriceAdjustment(promotionID : String, discount : Discount) : PriceAdjustment`
1297 |
1298 | **Description:** Creates an order level price adjustment for a specific discount. The promotion id is mandatory and must not be the ID of any actual promotion defined in B2C Commerce; otherwise an exception is thrown. The possible discount types are supported: PercentageDiscount and AmountDiscount. Examples: var myOrder : dw.order.Order; // assume known var paTenPercent : dw.order.PriceAdjustment = myOrder.createPriceAdjustment("myPromotionID1", new dw.campaign.PercentageDiscount(10)); var paReduceBy20 : dw.order.PriceAdjustment = myOrder.createPriceAdjustment("myPromotionID2", new dw.campaign.AmountDiscount(20);
1299 |
1300 | **Parameters:**
1301 |
1302 | - `promotionID`: Promotion ID
1303 | - `discount`: The discount
1304 |
1305 | **Returns:**
1306 |
1307 | The new price adjustment
1308 |
1309 | ---
1310 |
1311 | ### createProductLineItem
1312 |
1313 | **Signature:** `createProductLineItem(productID : String, quantity : Quantity, shipment : Shipment) : ProductLineItem`
1314 |
1315 | **Description:** Creates a new product line item in the container and assigns it to the specified shipment. If the specified productID represents a product in the site catalog, the method will associate the product line item with that catalog product and will copy all order-relevant information, like the quantity unit, from the catalog product. If the specified productID does not represent a product of the site catalog, the method creates a new product line item and initializes it with the specified product ID and quantity. If the passed in quantity value is not a positive integer, it will be rounded to the nearest positive integer. The minimum order quantity and step quantity will be set to 1.0. For catalog products, the method follows the configured 'Add2Basket' strategy to either increment the quantity of an existing product line item or create a new product line item for the same product. For non-catalog products, the method creates a new product line item no matter if the same product is already in the line item container. If a negative quantity is specified, it is automatically changed to 1.0.
1316 |
1317 | **Deprecated:**
1318 |
1319 | Use createProductLineItem(String, Shipment) or ProductLineItem.updateQuantity(Number) instead.
1320 |
1321 | **Parameters:**
1322 |
1323 | - `productID`: The product ID.
1324 | - `quantity`: The quantity of the product.
1325 | - `shipment`: Shipment
1326 |
1327 | **Returns:**
1328 |
1329 | the product line item
1330 |
1331 | ---
1332 |
1333 | ### createProductLineItem
1334 |
1335 | **Signature:** `createProductLineItem(productID : String, shipment : Shipment) : ProductLineItem`
1336 |
1337 | **Description:** Creates a new product line item in the container and assigns it to the specified shipment. If the specified productID represents a product in the site catalog, the method will associate the product line item with that catalog product and will copy all order-relevant information, like the quantity unit, from the catalog product. The quantity of the product line item is initialized with 1.0 or - if defined - the minimum order quantity of the product. If the product represents a product in the site catalog and is an option product, the product is added with it's default option values. If the specified productID does not represent a product of the site catalog, the method creates a new product line item and initializes it with the specified product ID and with a quantity, minimum order quantity, and step quantity value of 1.0. If the provided SKU references a product that is not available as described in method ProductLineItem.isCatalogProduct(), the new product line item is considered a non-catalog product line item without a connection to a product. Such product line items are not included in reservation requests in either OCI-based inventory or eCom-based inventory when calling Basket.reserveInventory() or OrderMgr.createOrder(Basket).
1338 |
1339 | **Parameters:**
1340 |
1341 | - `productID`: The product ID.
1342 | - `shipment`: Shipment
1343 |
1344 | **Returns:**
1345 |
1346 | The new product line item
1347 |
1348 | ---
1349 |
1350 | ### createProductLineItem
1351 |
1352 | **Signature:** `createProductLineItem(productListItem : ProductListItem, shipment : Shipment) : ProductLineItem`
1353 |
1354 | **Description:** Creates a new product line item in the basket and assigns it to the specified shipment. If the product list item references a product in the site catalog, the method will associate the product line item with that catalog product and will copy all order-relevant information, like the quantity unit, from the catalog product. The quantity of the product line item is initialized with 1.0 or - if defined - the minimum order quantity of the product. If the product list item references an option product, the option values are copied from the product list item. If the product list item is associated with an existing product line item, and the BasketAddProductBehaviour setting is MergeQuantities, then the product line item quantity is increased by 1.0 or, if defined, the minimum order quantity of the product. An exception is thrown if the line item container is no basket. the type of the product list item is not PRODUCT. the product list item references a product which is not assigned to the site catalog.
1355 |
1356 | **Parameters:**
1357 |
1358 | - `productListItem`: the product list item
1359 | - `shipment`: the shipment the created product line item will be assigned to
1360 |
1361 | **Returns:**
1362 |
1363 | The new product line item
1364 |
1365 | ---
1366 |
1367 | ### createProductLineItem
1368 |
1369 | **Signature:** `createProductLineItem(product : Product, optionModel : ProductOptionModel, shipment : Shipment) : ProductLineItem`
1370 |
1371 | **Description:** Creates a new product line item in the container and assigns it to the specified shipment. An option model can be specified. Please note that the product must be assigned to the current site catalog.
1372 |
1373 | **Parameters:**
1374 |
1375 | - `product`: Product
1376 | - `optionModel`: ProductOptionModel or null
1377 | - `shipment`: Shipment
1378 |
1379 | ---
1380 |
1381 | ### createShipment
1382 |
1383 | **Signature:** `createShipment(id : String) : Shipment`
1384 |
1385 | **Description:** Creates a standard shipment for the line item container. The specified ID must not yet be in use for another shipment of this line item container.
1386 |
1387 | **Parameters:**
1388 |
1389 | - `id`: ID of the shipment.
1390 |
1391 | ---
1392 |
1393 | ### createShippingPriceAdjustment
1394 |
1395 | **Signature:** `createShippingPriceAdjustment(promotionID : String) : PriceAdjustment`
1396 |
1397 | **Description:** Creates a shipping price adjustment to be applied to the container. The promotion ID is mandatory and must not be the ID of any actual promotion defined in B2C Commerce; otherwise the method will throw an exception. If there already exists a shipping price adjustment referring to the specified promotion ID, an exception is thrown.
1398 |
1399 | **Parameters:**
1400 |
1401 | - `promotionID`: Promotion ID
1402 |
1403 | **Returns:**
1404 |
1405 | The new price adjustment
1406 |
1407 | ---
1408 |
1409 | ### getAdjustedMerchandizeTotalGrossPrice
1410 |
1411 | **Signature:** `getAdjustedMerchandizeTotalGrossPrice() : Money`
1412 |
1413 | **Description:** Returns the adjusted total gross price (including tax) in purchase currency. Adjusted merchandize prices represent the sum of product prices before services such as shipping, but after product-level and order-level adjustments.
1414 |
1415 | **Returns:**
1416 |
1417 | the adjusted total gross price (including tax) in purchase currency.
1418 |
1419 | ---
1420 |
1421 | ### getAdjustedMerchandizeTotalNetPrice
1422 |
1423 | **Signature:** `getAdjustedMerchandizeTotalNetPrice() : Money`
1424 |
1425 | **Description:** Returns the total net price (excluding tax) in purchase currency. Adjusted merchandize prices represent the sum of product prices before services such as shipping, but after product-level and order-level adjustments.
1426 |
1427 | **Returns:**
1428 |
1429 | the total net price (excluding tax) in purchase currency.
1430 |
1431 | ---
1432 |
1433 | ### getAdjustedMerchandizeTotalPrice
1434 |
1435 | **Signature:** `getAdjustedMerchandizeTotalPrice() : Money`
1436 |
1437 | **Description:** Returns the adjusted merchandize total price including product-level and order-level adjustments. If the line item container is based on net pricing the adjusted merchandize total net price is returned. If the line item container is based on gross pricing the adjusted merchandize total gross price is returned.
1438 |
1439 | **Returns:**
1440 |
1441 | either the adjusted merchandize total net or gross price
1442 |
1443 | ---
1444 |
1445 | ### getAdjustedMerchandizeTotalPrice
1446 |
1447 | **Signature:** `getAdjustedMerchandizeTotalPrice(applyOrderLevelAdjustments : boolean) : Money`
1448 |
1449 | **Description:** Returns the adjusted merchandize total price including order-level adjustments if requested. If the line item container is based on net pricing the adjusted merchandize total net price is returned. If the line item container is based on gross pricing the adjusted merchandize total gross price is returned.
1450 |
1451 | **Parameters:**
1452 |
1453 | - `applyOrderLevelAdjustments`: controls if order-level price adjustements are applied. If true, the price that is returned includes order-level price adjustments. If false, only product-level price adjustments are applied.
1454 |
1455 | **Returns:**
1456 |
1457 | a price representing the adjusted merchandize total controlled by the applyOrderLevelAdjustments parameter.
1458 |
1459 | ---
1460 |
1461 | ### getAdjustedMerchandizeTotalTax
1462 |
1463 | **Signature:** `getAdjustedMerchandizeTotalTax() : Money`
1464 |
1465 | **Description:** Returns the subtotal tax in purchase currency. Adjusted merchandize prices represent the sum of product prices before services such as shipping have been added, but after adjustment from promotions have been added.
1466 |
1467 | **Returns:**
1468 |
1469 | the subtotal tax in purchase currency.
1470 |
1471 | ---
1472 |
1473 | ### getAdjustedShippingTotalGrossPrice
1474 |
1475 | **Signature:** `getAdjustedShippingTotalGrossPrice() : Money`
1476 |
1477 | **Description:** Returns the adjusted sum of all shipping line items of the line item container, including tax after shipping adjustments have been applied.
1478 |
1479 | **Returns:**
1480 |
1481 | the adjusted sum of all shipping line items of the line item container, including tax after shipping adjustments have been applied.
1482 |
1483 | ---
1484 |
1485 | ### getAdjustedShippingTotalNetPrice
1486 |
1487 | **Signature:** `getAdjustedShippingTotalNetPrice() : Money`
1488 |
1489 | **Description:** Returns the sum of all shipping line items of the line item container, excluding tax after shipping adjustments have been applied.
1490 |
1491 | **Returns:**
1492 |
1493 | the sum of all shipping line items of the line item container, excluding tax after shipping adjustments have been applied.
1494 |
1495 | ---
1496 |
1497 | ### getAdjustedShippingTotalPrice
1498 |
1499 | **Signature:** `getAdjustedShippingTotalPrice() : Money`
1500 |
1501 | **Description:** Returns the adjusted shipping total price. If the line item container is based on net pricing the adjusted shipping total net price is returned. If the line item container is based on gross pricing the adjusted shipping total gross price is returned.
1502 |
1503 | **Returns:**
1504 |
1505 | either the adjusted shipping total net or gross price
1506 |
1507 | ---
1508 |
1509 | ### getAdjustedShippingTotalTax
1510 |
1511 | **Signature:** `getAdjustedShippingTotalTax() : Money`
1512 |
1513 | **Description:** Returns the tax of all shipping line items of the line item container after shipping adjustments have been applied.
1514 |
1515 | **Returns:**
1516 |
1517 | the tax of all shipping line items of the line item container after shipping adjustments have been applied.
1518 |
1519 | ---
1520 |
1521 | ### getAllGiftCertificateLineItems
1522 |
1523 | **Signature:** `getAllGiftCertificateLineItems() : Collection`
1524 |
1525 | **Description:** Returns all gift certificate line items of the container.
1526 |
1527 | **Deprecated:**
1528 |
1529 | Use getGiftCertificateLineItems() to get the collection instead.
1530 |
1531 | **Returns:**
1532 |
1533 | A collection of all GiftCertificateLineItems of the container.
1534 |
1535 | ---
1536 |
1537 | ### getAllLineItems
1538 |
1539 | **Signature:** `getAllLineItems() : Collection`
1540 |
1541 | **Description:** Returns all product, shipping, price adjustment, and gift certificate line items of the line item container.
1542 |
1543 | **Returns:**
1544 |
1545 | A collection of all product, shipping, price adjustment, and gift certificate line items of the container, in that order.
1546 |
1547 | ---
1548 |
1549 | ### getAllProductLineItems
1550 |
1551 | **Signature:** `getAllProductLineItems() : Collection`
1552 |
1553 | **Description:** Returns all product line items of the container, no matter if they are dependent or independent. This includes option, bundled and bonus line items.
1554 |
1555 | **Returns:**
1556 |
1557 | An unsorted collection of all ProductLineItem instances of the container.
1558 |
1559 | ---
1560 |
1561 | ### getAllProductLineItems
1562 |
1563 | **Signature:** `getAllProductLineItems(productID : String) : Collection`
1564 |
1565 | **Description:** Returns all product line items of the container that have a product ID equal to the specified product ID, no matter if they are dependent or independent. This includes option, bundled and bonus line items.
1566 |
1567 | **Parameters:**
1568 |
1569 | - `productID`: The product ID used to filter the product line items.
1570 |
1571 | **Returns:**
1572 |
1573 | An unsorted collection of all ProductLineItem instances which have the specified product ID.
1574 |
1575 | ---
1576 |
1577 | ### getAllProductQuantities
1578 |
1579 | **Signature:** `getAllProductQuantities() : HashMap`
1580 |
1581 | **Description:** Returns a hash mapping all products in the line item container to their total quantities. The total product quantity is used chiefly to validate the availability of the items in the cart. This method is not appropriate to look up prices because it returns products such as bundled line items which are included in the price of their parent and therefore have no corresponding price. The method counts all direct product line items, plus dependent product line items that are not option line items. It also excludes product line items that are not associated to any catalog product.
1582 |
1583 | **Returns:**
1584 |
1585 | A map of products and their total quantities.
1586 |
1587 | ---
1588 |
1589 | ### getAllShippingPriceAdjustments
1590 |
1591 | **Signature:** `getAllShippingPriceAdjustments() : Collection`
1592 |
1593 | **Description:** Returns the collection of all shipping price adjustments applied somewhere in the container. This can be adjustments applied to individual shipments or to the container itself. Note that the promotions engine only applies shipping price adjustments to the the default shipping line item of shipments, and never to the container.
1594 |
1595 | **Returns:**
1596 |
1597 | an unsorted collection of the shipping PriceAdjustment instances associated with this container.
1598 |
1599 | **See Also:**
1600 |
1601 | getShippingPriceAdjustments()
1602 |
1603 | ---
1604 |
1605 | ### getBillingAddress
1606 |
1607 | **Signature:** `getBillingAddress() : OrderAddress`
1608 |
1609 | **Description:** Returns the billing address defined for the container. Returns null if no billing address has been created yet.
1610 |
1611 | **Returns:**
1612 |
1613 | the billing address or null.
1614 |
1615 | ---
1616 |
1617 | ### getBonusDiscountLineItems
1618 |
1619 | **Signature:** `getBonusDiscountLineItems() : Collection`
1620 |
1621 | **Description:** Returns an unsorted collection of the the bonus discount line items associated with this container.
1622 |
1623 | **Returns:**
1624 |
1625 | An unsorted collection of BonusDiscountLine instances in the container.
1626 |
1627 | ---
1628 |
1629 | ### getBonusLineItems
1630 |
1631 | **Signature:** `getBonusLineItems() : Collection`
1632 |
1633 | **Description:** Returns the collection of product line items that are bonus items (where ProductLineItem.isBonusProductLineItem() is true).
1634 |
1635 | **Returns:**
1636 |
1637 | the collection of product line items that are bonus items.
1638 |
1639 | ---
1640 |
1641 | ### getBusinessType
1642 |
1643 | **Signature:** `getBusinessType() : EnumValue`
1644 |
1645 | **Description:** Returns the type of the business this order has been placed in. Possible values are BUSINESS_TYPE_B2C or BUSINESS_TYPE_B2B.
1646 |
1647 | **Returns:**
1648 |
1649 | the type of the business this order has been placed in. or null, if the business type is not set
1650 |
1651 | ---
1652 |
1653 | ### getChannelType
1654 |
1655 | **Signature:** `getChannelType() : EnumValue`
1656 |
1657 | **Description:** The channel type defines in which sales channel this order has been created. This can be used to distinguish order placed through Storefront, Call Center or Marketplace. Possible values are CHANNEL_TYPE_STOREFRONT, CHANNEL_TYPE_CALLCENTER, CHANNEL_TYPE_MARKETPLACE, CHANNEL_TYPE_DSS, CHANNEL_TYPE_STORE, CHANNEL_TYPE_PINTEREST, CHANNEL_TYPE_TWITTER, CHANNEL_TYPE_FACEBOOKADS, CHANNEL_TYPE_SUBSCRIPTIONS, CHANNEL_TYPE_ONLINERESERVATION, CHANNEL_TYPE_CUSTOMERSERVICECENTER, CHANNEL_TYPE_INSTAGRAMCOMMERCE, CHANNEL_TYPE_GOOGLE, CHANNEL_TYPE_YOUTUBE, CHANNEL_TYPE_TIKTOK, CHANNEL_TYPE_SNAPCHAT, CHANNEL_TYPE_WHATSAPP
1658 |
1659 | **Returns:**
1660 |
1661 | the sales channel this order has been placed in or null, if the order channel is not set
1662 |
1663 | ---
1664 |
1665 | ### getCouponLineItem
1666 |
1667 | **Signature:** `getCouponLineItem(couponCode : String) : CouponLineItem`
1668 |
1669 | **Description:** Returns the coupon line item representing the specified coupon code.
1670 |
1671 | **Parameters:**
1672 |
1673 | - `couponCode`: the coupon code.
1674 |
1675 | **Returns:**
1676 |
1677 | coupon line item or null.
1678 |
1679 | ---
1680 |
1681 | ### getCouponLineItems
1682 |
1683 | **Signature:** `getCouponLineItems() : Collection`
1684 |
1685 | **Description:** Returns a sorted collection of the coupon line items in the container. The coupon line items are returned in the order they were added to container.
1686 |
1687 | **Returns:**
1688 |
1689 | A sorted list of the CouponLineItem instances in the container.
1690 |
1691 | ---
1692 |
1693 | ### getCurrencyCode
1694 |
1695 | **Signature:** `getCurrencyCode() : String`
1696 |
1697 | **Description:** Returns the currency code for this line item container. The currency code is a 3-character currency mnemonic such as 'USD' or 'EUR'. The currency code represents the currency in which the calculation is made, and in which the buyer sees all prices in the store front.
1698 |
1699 | **Returns:**
1700 |
1701 | the currency code for this line item container.
1702 |
1703 | ---
1704 |
1705 | ### getCustomer
1706 |
1707 | **Signature:** `getCustomer() : Customer`
1708 |
1709 | **Description:** Returns the customer associated with this container.
1710 |
1711 | **Returns:**
1712 |
1713 | the customer associated with this container.
1714 |
1715 | ---
1716 |
1717 | ### getCustomerEmail
1718 |
1719 | **Signature:** `getCustomerEmail() : String`
1720 |
1721 | **Description:** Returns the email of the customer associated with this container.
1722 |
1723 | **Returns:**
1724 |
1725 | the email of the customer associated with this container.
1726 |
1727 | ---
1728 |
1729 | ### getCustomerName
1730 |
1731 | **Signature:** `getCustomerName() : String`
1732 |
1733 | **Description:** Returns the name of the customer associated with this container.
1734 |
1735 | **Returns:**
1736 |
1737 | the name of the customer associated with this container.
1738 |
1739 | ---
1740 |
1741 | ### getCustomerNo
1742 |
1743 | **Signature:** `getCustomerNo() : String`
1744 |
1745 | **Description:** Returns the customer number of the customer associated with this container.
1746 |
1747 | **Returns:**
1748 |
1749 | the customer number of the customer associated with this container.
1750 |
1751 | ---
1752 |
1753 | ### getDefaultShipment
1754 |
1755 | **Signature:** `getDefaultShipment() : Shipment`
1756 |
1757 | **Description:** Returns the default shipment of the line item container. Every basket and order has a default shipment with the id "me". If you call a process that accesses a shipment, and you don't specify the shipment, then the process uses the default shipment. You can't remove a default shipment. Calling removeShipment(Shipment) on it throws an exception.
1758 |
1759 | **Returns:**
1760 |
1761 | the default shipment of the container
1762 |
1763 | ---
1764 |
1765 | ### getEtag
1766 |
1767 | **Signature:** `getEtag() : String`
1768 |
1769 | **Description:** Returns the Etag of the line item container. The Etag is a hash that represents the overall container state including any associated objects like line items.
1770 |
1771 | **Returns:**
1772 |
1773 | the Etag value
1774 |
1775 | ---
1776 |
1777 | ### getGiftCertificateLineItems
1778 |
1779 | **Signature:** `getGiftCertificateLineItems() : Collection`
1780 |
1781 | **Description:** Returns all gift certificate line items of the container.
1782 |
1783 | **Returns:**
1784 |
1785 | A collection of all GiftCertificateLineItems of the container.
1786 |
1787 | ---
1788 |
1789 | ### getGiftCertificateLineItems
1790 |
1791 | **Signature:** `getGiftCertificateLineItems(giftCertificateId : String) : Collection`
1792 |
1793 | **Description:** Returns all gift certificate line items of the container, no matter if they are dependent or independent.
1794 |
1795 | **Parameters:**
1796 |
1797 | - `giftCertificateId`: the gift certificate identifier.
1798 |
1799 | **Returns:**
1800 |
1801 | A collection of all GiftCertificateLineItems of the container.
1802 |
1803 | ---
1804 |
1805 | ### getGiftCertificatePaymentInstruments
1806 |
1807 | **Signature:** `getGiftCertificatePaymentInstruments() : Collection`
1808 |
1809 | **Description:** Returns an unsorted collection of the PaymentInstrument instances that represent GiftCertificates in this container.
1810 |
1811 | **Returns:**
1812 |
1813 | an unsorted collection containing the set of PaymentInstrument instances that represent GiftCertificates.
1814 |
1815 | ---
1816 |
1817 | ### getGiftCertificatePaymentInstruments
1818 |
1819 | **Signature:** `getGiftCertificatePaymentInstruments(giftCertificateCode : String) : Collection`
1820 |
1821 | **Description:** Returns an unsorted collection containing all PaymentInstruments of type PaymentInstrument.METHOD_GIFT_CERTIFICATE where the specified code is the same code on the payment instrument.
1822 |
1823 | **Parameters:**
1824 |
1825 | - `giftCertificateCode`: the gift certificate code.
1826 |
1827 | **Returns:**
1828 |
1829 | an unsorted collection containing all PaymentInstruments of type PaymentInstrument.METHOD_GIFT_CERTIFICATE where the specified code is the same code on the payment instrument.
1830 |
1831 | ---
1832 |
1833 | ### getGiftCertificateTotalGrossPrice
1834 |
1835 | **Signature:** `getGiftCertificateTotalGrossPrice() : Money`
1836 |
1837 | **Description:** Returns the total gross price of all gift certificates in the cart. Should usually be equal to total net price.
1838 |
1839 | **Returns:**
1840 |
1841 | the total gross price of all gift certificate line items
1842 |
1843 | ---
1844 |
1845 | ### getGiftCertificateTotalNetPrice
1846 |
1847 | **Signature:** `getGiftCertificateTotalNetPrice() : Money`
1848 |
1849 | **Description:** Returns the total net price (excluding tax) of all gift certificates in the cart. Should usually be equal to total gross price.
1850 |
1851 | **Returns:**
1852 |
1853 | the total net price of all gift certificate line items
1854 |
1855 | ---
1856 |
1857 | ### getGiftCertificateTotalPrice
1858 |
1859 | **Signature:** `getGiftCertificateTotalPrice() : Money`
1860 |
1861 | **Description:** Returns the gift certificate total price. If the line item container is based on net pricing the gift certificate total net price is returned. If the line item container is based on gross pricing the gift certificate total gross price is returned.
1862 |
1863 | **Returns:**
1864 |
1865 | either the gift certificate total net or gross price
1866 |
1867 | ---
1868 |
1869 | ### getGiftCertificateTotalTax
1870 |
1871 | **Signature:** `getGiftCertificateTotalTax() : Money`
1872 |
1873 | **Description:** Returns the total tax of all gift certificates in the cart. Should usually be 0.0.
1874 |
1875 | **Returns:**
1876 |
1877 | the total tax of all gift certificate line items
1878 |
1879 | ---
1880 |
1881 | ### getMerchandizeTotalGrossPrice
1882 |
1883 | **Signature:** `getMerchandizeTotalGrossPrice() : Money`
1884 |
1885 | **Description:** Returns the total gross price (including tax) in purchase currency. Merchandize total prices represent the sum of product prices before services such as shipping or adjustment from promotions have been added.
1886 |
1887 | **Returns:**
1888 |
1889 | the total gross price (including tax) in purchase currency.
1890 |
1891 | ---
1892 |
1893 | ### getMerchandizeTotalNetPrice
1894 |
1895 | **Signature:** `getMerchandizeTotalNetPrice() : Money`
1896 |
1897 | **Description:** Returns the total net price (excluding tax) in purchase currency. Merchandize total prices represent the sum of product prices before services such as shipping or adjustment from promotion have been added.
1898 |
1899 | **Returns:**
1900 |
1901 | the total net price (excluding tax) in purchase currency.
1902 |
1903 | ---
1904 |
1905 | ### getMerchandizeTotalPrice
1906 |
1907 | **Signature:** `getMerchandizeTotalPrice() : Money`
1908 |
1909 | **Description:** Returns the merchandize total price. If the line item container is based on net pricing the merchandize total net price is returned. If the line item container is based on gross pricing the merchandize total gross price is returned.
1910 |
1911 | **Returns:**
1912 |
1913 | either the merchandize total net or gross price
1914 |
1915 | ---
1916 |
1917 | ### getMerchandizeTotalTax
1918 |
1919 | **Signature:** `getMerchandizeTotalTax() : Money`
1920 |
1921 | **Description:** Returns the total tax in purchase currency. Merchandize total prices represent the sum of product prices before services such as shipping or adjustment from promotions have been added.
1922 |
1923 | **Returns:**
1924 |
1925 | the total tax in purchase currency.
1926 |
1927 | ---
1928 |
1929 | ### getNotes
1930 |
1931 | **Signature:** `getNotes() : List`
1932 |
1933 | **Description:** Returns the list of notes for this object, ordered by creation time from oldest to newest.
1934 |
1935 | **Returns:**
1936 |
1937 | the list of notes for this object, ordered by creation time from oldest to newest.
1938 |
1939 | ---
1940 |
1941 | ### getPaymentInstrument
1942 |
1943 | **Signature:** `getPaymentInstrument() : OrderPaymentInstrument`
1944 |
1945 | **Description:** Returns the payment instrument of the line item container or null. This method is deprecated. You should use getPaymentInstruments() or getGiftCertificatePaymentInstruments() instead.
1946 |
1947 | **Deprecated:**
1948 |
1949 | Use getPaymentInstruments() or getGiftCertificatePaymentInstruments() to get the set of payment instruments.
1950 |
1951 | **Returns:**
1952 |
1953 | the order payment instrument of the line item container or null.
1954 |
1955 | ---
1956 |
1957 | ### getPaymentInstruments
1958 |
1959 | **Signature:** `getPaymentInstruments() : Collection`
1960 |
1961 | **Description:** Returns an unsorted collection of the payment instruments in this container.
1962 |
1963 | **Returns:**
1964 |
1965 | an unsorted collection containing the set of PaymentInstrument instances associated with this container.
1966 |
1967 | ---
1968 |
1969 | ### getPaymentInstruments
1970 |
1971 | **Signature:** `getPaymentInstruments(paymentMethodID : String) : Collection`
1972 |
1973 | **Description:** Returns an unsorted collection of PaymentInstrument instances based on the specified payment method ID.
1974 |
1975 | **Parameters:**
1976 |
1977 | - `paymentMethodID`: the ID of the payment method used.
1978 |
1979 | **Returns:**
1980 |
1981 | an unsorted collection of OrderPaymentInstrument instances based on the payment method.
1982 |
1983 | ---
1984 |
1985 | ### getPriceAdjustmentByPromotionID
1986 |
1987 | **Signature:** `getPriceAdjustmentByPromotionID(promotionID : String) : PriceAdjustment`
1988 |
1989 | **Description:** Returns the price adjustment associated to the specified promotion ID.
1990 |
1991 | **Parameters:**
1992 |
1993 | - `promotionID`: Promotion id
1994 |
1995 | **Returns:**
1996 |
1997 | The price adjustment associated with the specified promotion ID or null if none was found.
1998 |
1999 | ---
2000 |
2001 | ### getPriceAdjustments
2002 |
2003 | **Signature:** `getPriceAdjustments() : Collection`
2004 |
2005 | **Description:** Returns the collection of price adjustments that have been applied to the totals such as promotion on the purchase value (i.e. $10 Off or 10% Off). The price adjustments are sorted by the order in which they were applied to the order by the promotions engine.
2006 |
2007 | **Returns:**
2008 |
2009 | the sorted collection of PriceAdjustment instances.
2010 |
2011 | ---
2012 |
2013 | ### getProductLineItems
2014 |
2015 | **Signature:** `getProductLineItems() : Collection`
2016 |
2017 | **Description:** Returns the product line items of the container that are not dependent on other product line items. This includes line items representing bonus products in the container but excludes option, bundled, and bonus line items. The returned collection is sorted by the position attribute of the product line items.
2018 |
2019 | **Returns:**
2020 |
2021 | A sorted collection of ProductLineItem instances which are not dependent on other product line items.
2022 |
2023 | ---
2024 |
2025 | ### getProductLineItems
2026 |
2027 | **Signature:** `getProductLineItems(productID : String) : Collection`
2028 |
2029 | **Description:** Returns the product line items of the container that have a product ID equal to the specified product ID and that are not dependent on other product line items. This includes line items representing bonus products in the container, but excludes option, bundled and bonus line items. The returned collection is sorted by the position attribute of the product line items.
2030 |
2031 | **Parameters:**
2032 |
2033 | - `productID`: The Product ID used to filter the product line items.
2034 |
2035 | **Returns:**
2036 |
2037 | A sorted collection of ProductLineItem instances which have the specified product ID and are not dependent on other product line items.
2038 |
2039 | ---
2040 |
2041 | ### getProductQuantities
2042 |
2043 | **Signature:** `getProductQuantities() : HashMap`
2044 |
2045 | **Description:** Returns a hash map of all products in the line item container and their total quantities. The total product quantity is for example used to lookup the product price. The method counts all direct product line items, plus dependent product line items that are not bundled line items and no option line items. It also excludes product line items that are not associated to any catalog product, and bonus product line items.
2046 |
2047 | **Returns:**
2048 |
2049 | a map of products and their total quantities.
2050 |
2051 | **See Also:**
2052 |
2053 | getProductQuantities(Boolean)
2054 |
2055 | ---
2056 |
2057 | ### getProductQuantities
2058 |
2059 | **Signature:** `getProductQuantities(includeBonusProducts : boolean) : HashMap`
2060 |
2061 | **Description:** Returns a hash map of all products in the line item container and their total quantities. The total product quantity is for example used to lookup the product price in the cart. The method counts all direct product line items, plus dependent product line items that are not bundled line items and no option line items. It also excludes product line items that are not associated to any catalog product. If the parameter 'includeBonusProducts' is set to true, the method also counts bonus product line items.
2062 |
2063 | **Parameters:**
2064 |
2065 | - `includeBonusProducts`: if true also bonus product line item are counted
2066 |
2067 | **Returns:**
2068 |
2069 | A map of products and their total quantities.
2070 |
2071 | ---
2072 |
2073 | ### getProductQuantityTotal
2074 |
2075 | **Signature:** `getProductQuantityTotal() : Number`
2076 |
2077 | **Description:** Returns the total quantity of all product line items. Not included are bundled line items and option line items.
2078 |
2079 | **Returns:**
2080 |
2081 | The total quantity of all line items of the container.
2082 |
2083 | ---
2084 |
2085 | ### getShipment
2086 |
2087 | **Signature:** `getShipment(id : String) : Shipment`
2088 |
2089 | **Description:** Returns the shipment for the specified ID or null if no shipment with this ID exists in the line item container. Using "me" always returns the default shipment.
2090 |
2091 | **Parameters:**
2092 |
2093 | - `id`: the shipment identifier
2094 |
2095 | **Returns:**
2096 |
2097 | the shipment or null
2098 |
2099 | ---
2100 |
2101 | ### getShipments
2102 |
2103 | **Signature:** `getShipments() : Collection`
2104 |
2105 | **Description:** Returns all shipments of the line item container. The first shipment in the returned collection is the default shipment (shipment ID always set to "me"). All other shipments are sorted ascending by shipment ID.
2106 |
2107 | **Returns:**
2108 |
2109 | all shipments of the line item container
2110 |
2111 | ---
2112 |
2113 | ### getShippingPriceAdjustmentByPromotionID
2114 |
2115 | **Signature:** `getShippingPriceAdjustmentByPromotionID(promotionID : String) : PriceAdjustment`
2116 |
2117 | **Description:** Returns the shipping price adjustment associated with the specified promotion ID.
2118 |
2119 | **Parameters:**
2120 |
2121 | - `promotionID`: Promotion id
2122 |
2123 | **Returns:**
2124 |
2125 | The price adjustment associated with the specified promotion ID or null if none was found.
2126 |
2127 | ---
2128 |
2129 | ### getShippingPriceAdjustments
2130 |
2131 | **Signature:** `getShippingPriceAdjustments() : Collection`
2132 |
2133 | **Description:** Returns the of shipping price adjustments applied to the shipping total of the container. Note that the promotions engine only applies shipping price adjustments to the the default shipping line item of shipments, and never to the container.
2134 |
2135 | **Returns:**
2136 |
2137 | a collection of shipping price adjustments.
2138 |
2139 | **See Also:**
2140 |
2141 | getAllShippingPriceAdjustments()
2142 |
2143 | ---
2144 |
2145 | ### getShippingTotalGrossPrice
2146 |
2147 | **Signature:** `getShippingTotalGrossPrice() : Money`
2148 |
2149 | **Description:** Returns the sum of all shipping line items of the line item container, including tax before shipping adjustments have been applied.
2150 |
2151 | **Returns:**
2152 |
2153 | the sum of all shipping line items of the line item container, including tax before shipping adjustments have been applied.
2154 |
2155 | ---
2156 |
2157 | ### getShippingTotalNetPrice
2158 |
2159 | **Signature:** `getShippingTotalNetPrice() : Money`
2160 |
2161 | **Description:** Returns the sum of all shipping line items of the line item container, excluding tax before shipping adjustments have been applied.
2162 |
2163 | **Returns:**
2164 |
2165 | the sum of all shipping line items of the line item container, excluding tax before shipping adjustments have been applied.
2166 |
2167 | ---
2168 |
2169 | ### getShippingTotalPrice
2170 |
2171 | **Signature:** `getShippingTotalPrice() : Money`
2172 |
2173 | **Description:** Returns the shipping total price. If the line item container is based on net pricing the shipping total net price is returned. If the line item container is based on gross pricing the shipping total gross price is returned.
2174 |
2175 | **Returns:**
2176 |
2177 | either the shipping total net or gross price
2178 |
2179 | ---
2180 |
2181 | ### getShippingTotalTax
2182 |
2183 | **Signature:** `getShippingTotalTax() : Money`
2184 |
2185 | **Description:** Returns the tax of all shipping line items of the line item container before shipping adjustments have been applied.
2186 |
2187 | **Returns:**
2188 |
2189 | the tax of all shipping line items of the line item container before shipping adjustments have been applied.
2190 |
2191 | ---
2192 |
2193 | ### getTaxTotalsPerTaxRate
2194 |
2195 | **Signature:** `getTaxTotalsPerTaxRate() : SortedMap`
2196 |
2197 | **Description:** This method returns a SortedMap in which the keys are Decimal tax rates and the values are Money total tax for the tax rate. The map is unmodifiable.
2198 |
2199 | **Returns:**
2200 |
2201 | sorted map of tax rate against total tax
2202 |
2203 | ---
2204 |
2205 | ### getTotalGrossPrice
2206 |
2207 | **Signature:** `getTotalGrossPrice() : Money`
2208 |
2209 | **Description:** Returns the grand total price gross of tax for LineItemCtnr, in purchase currency. Total prices represent the sum of product prices, services prices and adjustments.
2210 |
2211 | **Returns:**
2212 |
2213 | the grand total price.
2214 |
2215 | ---
2216 |
2217 | ### getTotalNetPrice
2218 |
2219 | **Signature:** `getTotalNetPrice() : Money`
2220 |
2221 | **Description:** Returns the grand total price for LineItemCtnr net of tax, in purchase currency. Total prices represent the sum of product prices, services prices and adjustments.
2222 |
2223 | **Returns:**
2224 |
2225 | the grand total price.
2226 |
2227 | ---
2228 |
2229 | ### getTotalTax
2230 |
2231 | **Signature:** `getTotalTax() : Money`
2232 |
2233 | **Description:** Returns the grand total tax for LineItemCtnr, in purchase currency. Total prices represent the sum of product prices, services prices and adjustments.
2234 |
2235 | **Returns:**
2236 |
2237 | the grand total tax.
2238 |
2239 | ---
2240 |
2241 | ### isExternallyTaxed
2242 |
2243 | **Signature:** `isExternallyTaxed() : boolean`
2244 |
2245 | **Description:** Use this method to check whether the LineItemCtnr is calculated based on external tax tables. Note: a basket can only be created in EXTERNAL tax mode using SCAPI.
2246 |
2247 | **Returns:**
2248 |
2249 | true if the LineItemCtnr was calculated based on external tax tables.
2250 |
2251 | ---
2252 |
2253 | ### isTaxRoundedAtGroup
2254 |
2255 | **Signature:** `isTaxRoundedAtGroup() : boolean`
2256 |
2257 | **Description:** Use this method to check if the LineItemCtnr was calculated 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.
2258 |
2259 | **Returns:**
2260 |
2261 | true if the LineItemCtnr was calculated with grouped taxation
2262 |
2263 | ---
2264 |
2265 | ### removeAllPaymentInstruments
2266 |
2267 | **Signature:** `removeAllPaymentInstruments() : void`
2268 |
2269 | **Description:** Removes the all Payment Instruments from this container and deletes the Payment Instruments.
2270 |
2271 | ---
2272 |
2273 | ### removeBonusDiscountLineItem
2274 |
2275 | **Signature:** `removeBonusDiscountLineItem(bonusDiscountLineItem : BonusDiscountLineItem) : void`
2276 |
2277 | **Description:** Removes the specified bonus discount line item from the line item container.
2278 |
2279 | **Parameters:**
2280 |
2281 | - `bonusDiscountLineItem`: The bonus discount line item to remove, must not be null.
2282 |
2283 | ---
2284 |
2285 | ### removeCouponLineItem
2286 |
2287 | **Signature:** `removeCouponLineItem(couponLineItem : CouponLineItem) : void`
2288 |
2289 | **Description:** Removes the specified coupon line item from the line item container.
2290 |
2291 | **Parameters:**
2292 |
2293 | - `couponLineItem`: The coupon line item to remove
2294 |
2295 | ---
2296 |
2297 | ### removeGiftCertificateLineItem
2298 |
2299 | **Signature:** `removeGiftCertificateLineItem(giftCertificateLineItem : GiftCertificateLineItem) : void`
2300 |
2301 | **Description:** Removes the specified gift certificate line item from the line item container.
2302 |
2303 | **Parameters:**
2304 |
2305 | - `giftCertificateLineItem`: The gift certificate line item to remove
2306 |
2307 | ---
2308 |
2309 | ### removeNote
2310 |
2311 | **Signature:** `removeNote(note : Note) : void`
2312 |
2313 | **Description:** Removes a note from this line item container and deletes it.
2314 |
2315 | **Parameters:**
2316 |
2317 | - `note`: The note to remove. Must not be null. Must belong to this line item container.
2318 |
2319 | ---
2320 |
2321 | ### removePaymentInstrument
2322 |
2323 | **Signature:** `removePaymentInstrument(pi : PaymentInstrument) : void`
2324 |
2325 | **Description:** Removes the specified Payment Instrument from this container and deletes the Payment Instrument.
2326 |
2327 | **Parameters:**
2328 |
2329 | - `pi`: the Payment Instrument to remove.
2330 |
2331 | ---
2332 |
2333 | ### removePriceAdjustment
2334 |
2335 | **Signature:** `removePriceAdjustment(priceAdjustment : PriceAdjustment) : void`
2336 |
2337 | **Description:** Removes the specified price adjustment line item from the line item container.
2338 |
2339 | **Parameters:**
2340 |
2341 | - `priceAdjustment`: The price adjustment line item to remove, must not be null.
2342 |
2343 | ---
2344 |
2345 | ### removeProductLineItem
2346 |
2347 | **Signature:** `removeProductLineItem(productLineItem : ProductLineItem) : void`
2348 |
2349 | **Description:** Removes the specified product line item from the line item container.
2350 |
2351 | **Parameters:**
2352 |
2353 | - `productLineItem`: The product line item to remove, must not be null.
2354 |
2355 | ---
2356 |
2357 | ### removeShipment
2358 |
2359 | **Signature:** `removeShipment(shipment : Shipment) : void`
2360 |
2361 | **Description:** Removes the specified shipment and all associated product, gift certificate, shipping and price adjustment line items from the line item container. It is not permissible to remove the default shipment.
2362 |
2363 | **Parameters:**
2364 |
2365 | - `shipment`: Shipment to be removed, must not be null.
2366 |
2367 | ---
2368 |
2369 | ### removeShippingPriceAdjustment
2370 |
2371 | **Signature:** `removeShippingPriceAdjustment(priceAdjustment : PriceAdjustment) : void`
2372 |
2373 | **Description:** Removes the specified shipping price adjustment line item from the line item container.
2374 |
2375 | **Parameters:**
2376 |
2377 | - `priceAdjustment`: The price adjustment line item to remove, must not be null.
2378 |
2379 | ---
2380 |
2381 | ### setCustomerEmail
2382 |
2383 | **Signature:** `setCustomerEmail(aValue : String) : void`
2384 |
2385 | **Description:** Sets the email address of the customer associated with this container.
2386 |
2387 | **Parameters:**
2388 |
2389 | - `aValue`: the email address of the customer associated with this container.
2390 |
2391 | ---
2392 |
2393 | ### setCustomerName
2394 |
2395 | **Signature:** `setCustomerName(aValue : String) : void`
2396 |
2397 | **Description:** Sets the name of the customer associated with this container.
2398 |
2399 | **Parameters:**
2400 |
2401 | - `aValue`: the name of the customer associated with this container.
2402 |
2403 | ---
2404 |
2405 | ### updateOrderLevelPriceAdjustmentTax
2406 |
2407 | **Signature:** `updateOrderLevelPriceAdjustmentTax() : void`
2408 |
2409 | **Description:** Calculates the tax for all shipping and order-level merchandise price adjustments in this LineItemCtnr. The tax on each adjustment is calculated from the taxes of the line items the adjustment applies across. This method must be invoked at the end of tax calculation of a basket or an order.
2410 |
2411 | ---
2412 |
2413 | ### updateTotals
2414 |
2415 | **Signature:** `updateTotals() : void`
2416 |
2417 | **Description:** Recalculates the totals of the line item container. It is necessary to call this method after any type of modification to the basket.
2418 |
2419 | ---
2420 |
2421 | ### verifyPriceAdjustmentLimits
2422 |
2423 | **Signature:** `verifyPriceAdjustmentLimits() : Status`
2424 |
2425 | **Description:** Verifies whether the manual price adjustments made for the line item container exceed the corresponding limits for the current user and the current site. The results of this method are based on the current values held in the LineItemCtnr, such as the base price of manual price adjustments. It is important the method is only called after the calculation process has completed. Status.OK is returned if NONE of the manual price adjustments exceed the correspondent limits. Status.ERROR is returned if ANY of the manual price adjustments exceed the correspondent limits. If this case Status.getItems() returns all price adjustment limit violations. The code of each StatusItem represents the violated price adjustment type (see PriceAdjustmentLimitTypes). StatusItem.getDetails() returns a Map with the max amount and (where relevant) the item to which the violation applies. Usage: var order : Order; // known var status : Status = order.verifyPriceAdjustmentLimits(); if (status.status == Status.ERROR) { for each (var statusItem : StatusItem in status.items) { var statusDetail : MapEntry = statusItem.details.entrySet().iterator().next(); var maxAllowedLimit : Number = (Number) (statusDetail.key); if (statusItem.code == PriceAdjustmentLimitTypes.TYPE_ORDER) { // fix order price adjustment considering maxAllowedLimit } else if (statusItem.code == PriceAdjustmentLimitTypes.TYPE_ITEM) { var pli : ProductLineItem = (ProductLineItem) (statusDetail.value); // fix pli price adjustment considering maxAllowedLimit } else if (statusItem.code == PriceAdjustmentLimitTypes.TYPE_SHIPPING) { if (statusDetail.value == null) { // fix order level shipping price adjustment considering maxAllowedLimit } else { var sli : ShippingLineItem = (ShippingLineItem) (statusDetail.value); // fix sli price adjustment considering maxAllowedLimit } } } }
2426 |
2427 | **Returns:**
2428 |
2429 | a Status instance with - Status.OK if all manual price adjustments do not exceed the correspondent limits, otherwise Status.ERROR
2430 |
2431 | ---
```