CartModule

CartService

A Cart contains the product and custom cart items that a user may wish to purchase.

CatalogModule

CategoryService

Categories allow you to organize your Products into hierarchical groups. That means these groups can also contain other Categories, which can then be viewed in a tree structure. All categories returned from this service are translated based on the user's locale.

ConstraintRuleConditionService

Constraint rules are powerful when configuring products. They allow you to include, excludes, recommend, validate, and replace products based on business logic.

ConstraintRuleService

Constraint rules are powerful when configuring products. They allow you to include, excludes, recommend, validate, and replace products based on business logic.

ProductAttributeRuleService

Product attribute rules are a powerful feature that add a level of dynamic configuration to products a given set of product attributes.

ProductAttributeService

Product attributes represent a characteristic of a product that can have different values. I.e. colors of a given product.

ProductOptionGroupService

Product option groups are a way of grouping the individual options for a product.

ProductOptionService

Product options are individual products that users can select from when configuring a bundle.

ProductService

Products are the core resource to any Apttus project. They can be associated by category, collection, brands, and more.

SearchService

The search service is a way to find products and aggregate information within the catalog.

OrderModule

OrderService

The order object represents an order in Apttus. Only orders where the current user is the owner will be returned by this service.

QuoteService

The quote represents a price breakdown for a given product configuration. Quotes are generally associated with an approval process and can be converted to a cart or an order.

TemplateService

A template service provides methods for the proposal and agreement templates within Apttus. Use this to retrieve template records.

PricingModule

ConversionService

The conversion service is responsible for pulling conversion rates from your Salesforce instance.
Remember to set the enableMultiCurrency in your salesforce.config.ts file to true.

PriceListItemService

The price list items map a product to a specific price list. They provide the base price for any product in your catalog.

PriceListService

Price lists are the core object for defining the catalog seen by the end-user. Categories, products, and pricing are all derived from the selected price list.

PriceMatrixService

Price matrixes are used to map various product facets to a price adjustment. For example, there may be matrixes for attributes or quantities that adjust the base price. Use this service to retrieve the data for those matrixes.

PriceRuleService

Stubbed service for Apttus price rules. Currently has no supporting methods.

PriceService

Client-side pricing engine for retrieving price for various points in the ecommerce application. NOTE: It is not guaranteed that this service will always return accurate pricing for a given cart. You should always call cartService.priceCart(...) to trigger the server-side pricing engine to get the final price of a given cart. There are also pipes provided that wrap this service to provide pricing within a template i.e. ProductPricePipe, OrderPricePipe, CartPricePipe, and more.

StoreModule

AccountLocationService

The Address-Location service allows you to organize account addresses. Addresses are a sub-resource of an Account. An account may have multiple addresses.

AccountService

The account service provides methods for interacting with the accounts the user has access to.

ContactService

The contact service provides methods for interacting with the contacts the current user has access to.

EmailService

The email service provides methods for sending email communications.

StorefrontService

The storefront record is the backbone to the customer experience. It drives catalog, pricing, and interface.

UserService

The user service is the primary service for user interactions. This includes updating the user record, login/logoff, and more.