Serialized Form

Package com.broadleafcommerce.catalog.clone.category

Class com.broadleafcommerce.catalog.clone.category.CloneCategoryRequest

class CloneCategoryRequest extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

categoryId

String categoryId

The Category id to clone.

childUrlAppend

String childUrlAppend

The String to append to the url of any child categories of this clone request, since categories must have a unique url.

cloneRelationships

List<String> cloneRelationships

The List of the Category relationships that is used to specify which of the relationships should be cloned. If this list is empty, the relationships will not be cloned.

description

String description

See Also:

• Category.getDescription()

externalId

String externalId

See Also:

• Category.getExternalId()

metaTitle

String metaTitle

See Also:

• Category.getMetaTitle()

name

String name

See Also:

• Category.getName()

parentCategoryContextId

String parentCategoryContextId

See Also:

• Category.getParentCategory()

url

String url

See Also:

• Category.getUrl()

Package com.broadleafcommerce.catalog.clone.product

Class com.broadleafcommerce.catalog.clone.product.CloneProductRequest

class CloneProductRequest extends Object implements Serializable

Serialized Fields

cloneRelationships

List<String> cloneRelationships

The List of the Product relationships that is used to specify which of the relationships should be cloned. If this list is empty, the relationships will not be cloned.

name

String name

See Also:

• Product.getName()

productId

String productId

The Product id to clone.

sku

String sku

See Also:

• Product.getSku()

uri

String uri

See Also:

• Product.getUri()

Package com.broadleafcommerce.catalog.domain

Class com.broadleafcommerce.catalog.domain.Attribute

class Attribute extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

contextState

com.broadleafcommerce.data.tracking.core.EmbeddedContextState contextState

A subset of Tracking information to expose the context state for this object. This value is not persisted, and instead it is dynamically calculated and populated when the ChangeDetails for the parent object's entire attributes map are compared.

nameLabel

String nameLabel

A additional label that can be used to identify this attribute.

value

Object value

The value represented by this attribute. Attributes are generally placed on domain objects as a map of attribute names to attribute values: Map<String, Attribute>.

Class com.broadleafcommerce.catalog.domain.CartFieldMapping

class CartFieldMapping extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

attributeName

String attributeName

The attribute name where this field's value should be stored in.

contextState

com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState

A subset of Tracking information to expose the context state for this object.

id

String id

The context ID of the mapping.

valuePath

String valuePath

The JsonPath on the Product to retrieve the value(s) which should be stored in that attribute.

Class com.broadleafcommerce.catalog.domain.CategoryProduct

class CategoryProduct extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

category

CategoryRef category

The parent category in the relationship.

contextState

com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState

A subset of Tracking information to expose the context state for this object.

id

String id

The context ID of the relationship.

primary

boolean primary

Determines whether the associated category should be considered the primary parent category of the associated product.

product

Product product

The child product in the relationship.

sorted

Boolean sorted

Whether the persistent counterpart to this CategoryProduct has a non-default value for Sortable.getSorting(), which determines order in admin list grids.

See Also:

• Sorted.getSorted()
• Sortable

sorting

String sorting

Field indicating a sort order, if sorted. This is alphanumeric, allowing for lexicographical sorting.

Class com.broadleafcommerce.catalog.domain.PromotionalCategoryProduct

class PromotionalCategoryProduct extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

category

CategoryRef category

The category in which the related product is placed.

contextState

com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState

A subset of Tracking information to expose the context state for this object.

id

String id

The context ID of the relationship.

promotionalProduct

Product promotionalProduct

The product to promote.

promotionalProductType

String promotionalProductType

See Also:

• PromotionalProductType

promotionMessage

String promotionMessage

The promotion message for this relation.

sorted

Boolean sorted

Whether the persistent counterpart to this PromotionalCategoryProduct has a non-default value for Sortable.getSorting(), which determines order in admin list grids and ordering of PromotionalCategoryProducts that appear in customer-facing frontend views driven by PromotionalCategoryProduct.

See Also:

• Sorted.getSorted()
• Sortable

Class com.broadleafcommerce.catalog.domain.PromotionalProduct

class PromotionalProduct extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

contextState

com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState

A subset of Tracking information to expose the context state for this object.

id

String id

The context ID of the promotional product.

productId

String productId

The context ID of the owning product of this association.

promotionMessage

String promotionMessage

The promotion message for this relation.

relatedProduct

Product relatedProduct

The underlying Product that is being associated to as the actual promotional product.

sorted

Boolean sorted

Whether the persistent counterpart to this PromotionalProduct has a non-default value for Sortable.getSorting(), which determines order in admin list grids and ordering of PromotionalProducts that appear in customer-facing frontend views driven by PromotionalProduct.

See Also:

• Sorted.getSorted()
• Sortable

type

String type

See Also:

• PromotionalProductType

Package com.broadleafcommerce.catalog.domain.asset

Class com.broadleafcommerce.catalog.domain.asset.CategoryAsset

class CategoryAsset extends com.broadleafcommerce.asset.consumer.domain.EntityAsset implements Serializable

serialVersionUID:

1L

Serialized Fields

categoryId

String categoryId

The context ID of the Category associated with this asset.

contextState

com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState

A subset of Tracking information to expose the context state for this object.

id

String id

The context ID of the relationship.

primary

boolean primary

Determines whether this asset should be considered the primary asset for the category.

For any category, there can only be one CategoryAsset with this value set to true.

sorted

Boolean sorted

Whether the persistent counterpart to this CategoryAsset has a non-default value for Sortable.getSorting(), which determines order in admin list grids and ordering of images that appear in customer-facing frontend views that are driven by CategoryAsset.

See Also:

• Sorted.getSorted()
• Sortable

Class com.broadleafcommerce.catalog.domain.asset.IncludedProductAsset

class IncludedProductAsset extends com.broadleafcommerce.asset.consumer.domain.EntityAsset implements Serializable

serialVersionUID:

1L

Class com.broadleafcommerce.catalog.domain.asset.ProductAsset

class ProductAsset extends com.broadleafcommerce.asset.consumer.domain.EntityAsset implements Serializable

serialVersionUID:

1L

Serialized Fields

contextState

com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState

A subset of Tracking information to expose the context state for this object.

id

String id

The context ID of the relationship.

primary

boolean primary

Determines whether this asset should be considered the primary asset for the product.

For any product, there can only be one ProductAsset with this value set to true.

productId

String productId

The context ID of the Product associated with this asset.

sorted

Boolean sorted

Whether the persistent counterpart to this ProductAsset has a non-default value for Sortable.getSorting(), which determines order in admin list grids and ordering of images that appear in customer-facing frontend views that are driven by ProductAsset.

See Also:

• Sorted.getSorted()
• Sortable

Class com.broadleafcommerce.catalog.domain.asset.SpecificItemChoiceAsset

class SpecificItemChoiceAsset extends com.broadleafcommerce.asset.consumer.domain.EntityAsset implements Serializable

serialVersionUID:

1L

Package com.broadleafcommerce.catalog.domain.category

Class com.broadleafcommerce.catalog.domain.category.Category

class Category extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

activeEndDate

Instant activeEndDate

Defines the ending time for which this category is active. If the active start date is not null, but the active end date is, the category is considered to be active forever, starting on the start date.

See Also:

• Category.getActiveStartDate()

activeStartDate

Instant activeStartDate

Defines the beginning time for which this category is active. If both the active start date and the active end date are null, this category is considered to always be active.

See Also:

• Category.getActiveEndDate()

attributes

Map<String,Attribute> attributes

Dynamic attributes that are a part of the category

contextState

com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState

A subset of Tracking information to expose the context state for this object.

description

String description

HTML-formatted description of the category.

displayTemplate

String displayTemplate

Defines the display template. The display template can be used to help create a unique key that drives the presentation layer destination for this category. For example, if using Spring MVC with Thymeleaf, this could be a path to a Thymeleaf template. If using a frontend view technology like React, this could point to a specific React component.

externalId

String externalId

Intended to hold any unique identifier not tied to datastore where this category is stored. For example, many implementations may integrate or import/export data from other systems that manage their own unique identifiers.

id

String id

The context ID of the category.

metaDescription

String metaDescription

Used for SEO data in <meta description=""> in a category detail page. If this is unset, the name should be used.

metaTitle

String metaTitle

Used for SEO data in <title> tag in a category detail page. If this is unset, the name should be used.

name

String name

The name of the category.

parentCategory

CategoryRef parentCategory

This category's parent category.

productMembershipLocale

Locale productMembershipLocale

The locale used to check if a related product is a member of this category. Only applies when this category's product membership type is CategoryProductMembershipType.RULE_BASED. By default, this is set as the catalog locale.

See Also:

• CategoryProductMembershipType

productMembershipRule

String productMembershipRule

The rule string used to check if a related product is a member of this category. Only applies when this category's product membership type is CategoryProductMembershipType.RULE_BASED.

See Also:

• CategoryProductMembershipType

productMembershipType

String productMembershipType

Determines how this category defines membership of its products. Valid types are found at CategoryProductMembershipType.

See Also:

• CategoryProductMembershipType
• PromotionalCategoryProduct
• Category.getProductMembershipRule()

showInSiteMap

boolean showInSiteMap

This controls whether a category should be visible on the frontend display. An example use-case for setting this to false would be a category involving a "secret specials" page which should be hidden from general navigation and search engines, but still has a valid URL that could be sent to customers.

taxCode

String taxCode

The tax code for all products in this category.

url

String url

SEO-friendly URL to identify this category. This is usually generated with some URL-safe version of the name of the category.

A null URL indicates that this category should generally be hidden everywhere on the frontend and represents a backend-only categorization.

Class com.broadleafcommerce.catalog.domain.category.CategoryAncestorList

class CategoryAncestorList extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

ancestors

List<Category> ancestors

category

Category category

Class com.broadleafcommerce.catalog.domain.category.CategoryRef

class CategoryRef extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

id

String id

name

String name

url

String url

Package com.broadleafcommerce.catalog.domain.category.commerce

Class com.broadleafcommerce.catalog.domain.category.commerce.CategoryDetails

class CategoryDetails extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

assets

List<CategoryAsset> assets

All of the category's assets.

breadcrumbs

List<Breadcrumb> breadcrumbs

Navigational Breadcrumbs to show on the details view.

category

Category category

products

org.springframework.data.domain.Page<ProductSummary> products

A page of Products belonging to the category. To configure the page pass paging params to the CategoryDetailsEndpoint—they will be added to the CategoryDetailsRequest.

promotionalProducts

Map<String,List<PromotionalCategoryProductSummary>> promotionalProducts

A map containing a category's PromotionalProducts where the key is the type.

Class com.broadleafcommerce.catalog.domain.category.commerce.CategoryDetailsContext

class CategoryDetailsContext extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

relatedCategoryAssets

Map<String,List<CategoryAsset>> relatedCategoryAssets

An aggregation of all of the CategoryAssets related to the CategoryDetailsContext.resolvedCategory.

The key is the ID of the parent category.

This allows the DB to be queried fewer times during the build process.

relatedCategoryProducts

Map<String,org.springframework.data.domain.Page<ProductSummary>> relatedCategoryProducts

An aggregation of all of the Products related to the CategoryDetailsContext.resolvedCategory.

relatedProductAssets

Map<String,List<ProductAsset>> relatedProductAssets

An aggregation of all of the ProductAssets related to the CategoryDetailsContext.relatedProducts.

The key is the ID of the parent product.

This allows the DB to be queried fewer times during the build process.

relatedProducts

Map<String,ProductSummary> relatedProducts

An aggregation of all of the Products related to the CategoryDetailsContext.resolvedCategory.

This allows the DB to be queried fewer times during the build process.

relatedProductTags

Map<String,List<ProductTag>> relatedProductTags

Map of all ProductTags of the CategoryDetailsContext.relatedProducts. Mapped by the parent product's ID. The ProductTag.getTag() should be hydrated before adding to this map.

relatedPromotionalProducts

Map<String,List<PromotionalCategoryProductSummary>> relatedPromotionalProducts

An aggregation of all of the PromotionalProducts related to the CategoryDetailsContext.resolvedCategory mapped by their type.

relatedVariants

Map<String,VariantDetail> relatedVariants

An aggregation of all of the Variants related to the CategoryDetailsContext.relatedProducts.

This allows the DB to be queried fewer times during the build process.

request

CategoryDetailsRequest request

The CategoryDetailsRequest made that initiated the CategoryDetails build process.

resolvedCategory

Category resolvedCategory

The resolved category for the CategoryDetailsContext.request.

Class com.broadleafcommerce.catalog.domain.category.commerce.CategoryDetailsRequest

class CategoryDetailsRequest extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

attributes

org.springframework.util.MultiValueMap<String,String> attributes

Map holding any additional attributes passed in the request not matching any defined properties.

categoryId

String categoryId

The category ID to match against. If this field is non-null, then it is used instead of CategoryDetailsRequest.categoryUrl.

categoryUrl

String categoryUrl

The category URL to match against. If CategoryDetailsRequest.categoryId is non-null, then it is used instead of this field.

productPageInfo

org.springframework.data.domain.Pageable productPageInfo

Pagination info to apply to theproducts included in the response.

Package com.broadleafcommerce.catalog.domain.commerce

Class com.broadleafcommerce.catalog.domain.commerce.Breadcrumb

class Breadcrumb extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

label

String label

Label to display.

uri

String uri

URI to link to.

Class com.broadleafcommerce.catalog.domain.commerce.BrowseDetailsRequest

class BrowseDetailsRequest extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

attributes

org.springframework.util.MultiValueMap<String,String> attributes

Map holding any additional attributes passed in the request not matching any defined properties.

productPageInfo

org.springframework.data.domain.Pageable productPageInfo

Pagination info to apply to the products included in the response if this is a request matching a Category.

uris

Set<String> uris

One or more URIs identifying one or more Products or Categories to be fetched. The list of URIs should only apply to one entity type, i.e., they should all be product URIs or else they should all be category URIs, not a mix of both.

Note: In the case of a category matching, only one category may be returned.

Class com.broadleafcommerce.catalog.domain.commerce.BrowseEntityDetails

class BrowseEntityDetails extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

categoryDetails

CategoryDetails categoryDetails

The category that matched the requested URI.

productDetails

List<ProductDetails> productDetails

The products that matched the requested URI.

urisForMissingEntities

Set<String> urisForMissingEntities

All BrowseDetailsRequest.getUris() that failed to match known Products or Categories.

Class com.broadleafcommerce.catalog.domain.commerce.PriceInfo

class PriceInfo extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

price

javax.money.MonetaryAmount price

Determined best price for a target.

priceType

String priceType

The type of PriceInfo.price whether salePrice, standardPrice, contractPrice, etc.

priceTypeDetails

Map<String,PriceTypeDetail> priceTypeDetails

Map of each type of price to each corresponding PriceTypeDetail, which contains the best overall price for that type.

Class com.broadleafcommerce.catalog.domain.commerce.PriceTypeDetail

class PriceTypeDetail extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

bestPrice

javax.money.MonetaryAmount bestPrice

The determined best price value for this type of price from amongst all the candidates.

type

String type

The corresponding type of the price: salePrice, standardPrice, contractPrice, etc.

Package com.broadleafcommerce.catalog.domain.enumeration

Class com.broadleafcommerce.catalog.domain.enumeration.DataDrivenEnum

class DataDrivenEnum extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

contextState

com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState

A subset of Tracking information to expose the context state for this object.

displayValue

String displayValue

The display value for the associated DataDrivenEnum.type.

Different from DataDrivenEnum.value, the display value is meant to be more user-friendly and for client-facing usages, such as searching and faceting.

For example, the display value for type "MATERIAL" could be "Cotton", "Leather", "Polyester", etc.

id

String id

The context ID of this enum.

type

String type

Identifies the type of the associated value, this is needed to gather all the enum values based on their types.

For example, if this enum type was to be used for a field representing product's materials, then the type would be "MATERIAL".

value

String value

The value of the associated DataDrivenEnum.type.

For example, the value for type "MATERIAL" could be "COTTON", "LEATHER", "POLYESTER", etc.

Package com.broadleafcommerce.catalog.domain.enumeration.commerce

Class com.broadleafcommerce.catalog.domain.enumeration.commerce.DataDrivenEnumDetails

class DataDrivenEnumDetails extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

associatedCategoryExists

boolean associatedCategoryExists

Declares whether there is a Category associated with this dataDrivenEnum based on its value.

Since DataDrivenEnum is used to represent some product fields such as product's brand, there are categories expected to exist to further categorize products based on the data driven enum values.

For example, if a product's brand is a DataDrivenEnum with the value SOME_BRAND_NAME, a category with the url /some-brand-name is expected to be created for this brand.

dataDrivenEnum

DataDrivenEnum dataDrivenEnum

Class com.broadleafcommerce.catalog.domain.enumeration.commerce.DataDrivenEnumDetailsContext

class DataDrivenEnumDetailsContext extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

request

DataDrivenEnumDetailsRequest request

The DataDrivenEnumDetailsRequest made that initiated the DataDrivenEnumDetails build process.

resolvedDataDrivenEnum

DataDrivenEnum resolvedDataDrivenEnum

The resolved data driven enum for the DataDrivenEnumDetailsContext.request.

Class com.broadleafcommerce.catalog.domain.enumeration.commerce.DataDrivenEnumDetailsList

class DataDrivenEnumDetailsList extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

dataDrivenEnumDetails

List<DataDrivenEnumDetails> dataDrivenEnumDetails

All DataDrivenEnumDetails.

dataDrivenEnumIdsForMissingEntities

Set<String> dataDrivenEnumIdsForMissingEntities

All DataDrivenEnum Ids that cannot be found.

Class com.broadleafcommerce.catalog.domain.enumeration.commerce.DataDrivenEnumDetailsRequest

class DataDrivenEnumDetailsRequest extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

attributes

org.springframework.util.MultiValueMap<String,String> attributes

Map holding any additional attributes passed in the request not matching any defined properties.

checkIfAssociatedCategoryExist

boolean checkIfAssociatedCategoryExist

Whether this request should also check if an associated category exists based on the expected category url for the data driven enum value.

dataDrivenEnumIds

Set<String> dataDrivenEnumIds

The data driven enum IDs matching the data driven enums for which DataDrivenEnumDetails are requested.

Package com.broadleafcommerce.catalog.domain.option

Class com.broadleafcommerce.catalog.domain.option.OptionTemplate

class OptionTemplate extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

contextState

com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState

A subset of Tracking information to expose the context state for this object.

id

String id

name

String name

Admin management name for this template, used to help narrow down individual templates

option

ProductOption option

The option that this template actually manages

Class com.broadleafcommerce.catalog.domain.option.OptionTemplateGroup

class OptionTemplateGroup extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

contextState

com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState

A subset of Tracking information to expose the context state for this object.

id

String id

name

String name

templates

List<OptionTemplate> templates

Class com.broadleafcommerce.catalog.domain.option.OptionTemplateGroupRef

class OptionTemplateGroupRef extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

id

String id

The context ID of the OptionTemplateGroup.

Class com.broadleafcommerce.catalog.domain.option.OptionTemplateRef

class OptionTemplateRef extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

id

String id

The context ID of the OptionTemplate.

Package com.broadleafcommerce.catalog.domain.product

Class com.broadleafcommerce.catalog.domain.product.ConsolidatedProduct

class ConsolidatedProduct extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

advancedTags

List<AdvancedTagRef> advancedTags

References to the AdvancedTags related to this product via any ProductTags.

archived

boolean archived

Whether or not this product has been archived in this context state.

catalogOmissions

Set<String> catalogOmissions

The IDs of descendant catalogs in which this context version of the product has been omitted as a result of one or more filters.

e.g. if this product is in catalog A, and catalog B inherits this product from catalog A but contains a filter that removes it from the view of catalog B, then the catalog A version product will contain "B" in its catalogOmissions.

catalogOverrides

Set<String> catalogOverrides

The IDs of descendant catalogs in which this context version of the product has been overridden.

e.g. if this product is in catalog A, and catalog B inherits this product from catalog A but contains a local change for this product, then the catalog A version product will contain "B" in its catalogOverrides.

categories

List<CategoryRef> categories

dataDrivenEnums

List<DataDrivenEnum> dataDrivenEnums

explicitCategories

List<CategoryRef> explicitCategories

hasRequiredOptions

boolean hasRequiredOptions

Does this product have required options? In other words, does it have any item choices with a minimum quantity greater than 0.

marketplaceApplications

Set<String> marketplaceApplications

The IDs of marketplace applications where this product could appear in, based on the catalog hierarchy.

optionAssets

Map<String,ProductAsset> optionAssets

primaryCategory

CategoryRef primaryCategory

product

Product product

productSortingWithinCategories

Map<String,String> productSortingWithinCategories

This is a map of Category ID to sorting value from the CategoryProduct.

requiredOptionsAvailable

boolean requiredOptionsAvailable

If this product has required options, are there enough available item choices to purchase this product? Note: If ConsolidatedProduct.hasRequiredOptions is false, this property should be ignored.

sandboxOverrides

Set<String> sandboxOverrides

The IDs of descendant sandboxes in which this context version of the product has been overridden.

e.g. if this product is in sandbox A, and sandbox B inherits this product from sandbox A but contains a local change for this product, then the sandbox A version product will contain "B" in its sandboxOverrides.

sandboxOwner

String sandboxOwner

The owner of the sandboxed product if it's in a user sandbox.

This will only be populated if the Product ContextState level is TrackingLevel.USER.

translations

List<com.broadleafcommerce.translation.domain.Translation> translations

Translations for the product and all translatable consolidated objects.

variants

List<Variant> variants

vendorRef

String vendorRef

Soft reference to the vendor associated with the Product's catalog. This value can be null, in which case, no vendor is associated.

Class com.broadleafcommerce.catalog.domain.product.Dimensions

class Dimensions extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

depth

BigDecimal depth

height

BigDecimal height

units

String units

See Also:

• DimensionUnits

width

BigDecimal width

Class com.broadleafcommerce.catalog.domain.product.FulfillmentFlatRate

class FulfillmentFlatRate extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

contextState

com.broadleafcommerce.data.tracking.core.EmbeddedContextState contextState

A subset of Tracking information to expose the context state for this object. This value is not persisted, and instead it is dynamically calculated and populated when the ChangeDetails for the parent object's entire attributes map are compared.

value

javax.money.MonetaryAmount value

The value of this flat rate

Class com.broadleafcommerce.catalog.domain.product.IncludedProduct

class IncludedProduct extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

asset

IncludedProductAsset asset

The asset for this included product. Intended to override the asset normally shown for the IncludedProduct.product specifically in the context of this relationship.

See Also:

• IncludedProductAsset

contextState

com.broadleafcommerce.data.tracking.core.EmbeddedContextState contextState

A subset of Tracking information to expose the context state for this object. This value is not persisted, and instead it is dynamically calculated and populated when the ChangeDetails for the parent object's entire attributes map are compared.

discountAllowed

boolean discountAllowed

Deprecated.

Dictates whether or not discounts are allowed to be applied to this included product.

displayOrder

Long displayOrder

Defines the display position of this included product in relation to other included products.

id

String id

See Also:

• SubIdentifiable.getId()

label

String label

The user-facing label that describes this included product.

overridePrice

javax.money.MonetaryAmount overridePrice

Deprecated.

The price of the included product itself. If no pricing is specified here, the price of the target product, variant, or selected product from the category will be used.

pricingKey

String pricingKey

Deprecated.

Unique pricing key for this particular included product. Useful for scenarios such as pricing of included products, where a system wide unique identifier for the included product would be required to associate it with a price within an external system

product

Product product

This field contains the specified product if the included product type is IncludedProductType.PRODUCT.

quantity

int quantity

If the quantity type of this included product is IncludedProductQuantityType#FIXED, this field will hold the value of the fixed quantity.

type

String type

Describes which of the product, variant, or category/default selection fields should be used for this included product.

See Also:

• IncludedProductType

variant

Variant variant

This field contains the specified variant if the type is IncludedProductType.VARIANT.

See Also:

• IncludedProduct.variantParentProductId

variantParentProductId

String variantParentProductId

This field contains the id of the parent product of the specified IncludedProduct.variant if the type is IncludedProductType.VARIANT.

This field is necessary because variants are a sub-resource of product and thus API callers cannot fetch them purely by variant id alone.

See Also:

• IncludedProduct.variant

Class com.broadleafcommerce.catalog.domain.product.Product

class Product extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

activeEndDate

Instant activeEndDate

End when this product is not longer active. Unset indicates that it is always active.

See Also:

• Product.isActive()

activeStartDate

Instant activeStartDate

Start of when this product should be active.

attributes

Map<String,Attribute> attributes

Dynamic attributes that are a part of the product. This is an admin-centered concept

availableOnline

boolean availableOnline

Whether or not this product is available online - ie inventory is available somewhere to fulfill this product.

Defaults to true

brand

DataDrivenEnum brand

contextState

com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState

A subset of Tracking information to expose the context state for this object.

cost

javax.money.MonetaryAmount cost

Can be used in display or as a part of more complex pricing algorithms.

currency

javax.money.CurrencyUnit currency

Currency for all of the prices on this product

defaultPrice

javax.money.MonetaryAmount defaultPrice

The default price that should be used if there is not a Product.salePrice set. This price can also be used as the default price for all of the Variants as well.

For more advance pricing calculations, consider hiding this field in the API and removing support for it in lieu of managing prices outside of this service.

Always included in the API even if set to null to indicate whether or not this was explicitly set

description

String description

Description of the product that can include HTML in implementations where a WYSIWYG editor manages this field.

dimension

Dimensions dimension

discountable

boolean discountable

Whether or not this product be applied to any offers or promotions.

Defaults to true

displayTemplate

String displayTemplate

Defines the display template. The display template can be used to help create a unique key that drives the presentation layer destination for this category. For example, if using Spring MVC with Thymeleaf, this could be a path to a Thymeleaf template. If using a frontend view technology like React, this could point to a specific React component.

eligibleForPickup

boolean eligibleForPickup

Whether or not this Product can be picked up at a store rather than just be shipped

externalId

String externalId

This is an arbitrary ID, typically assigned by or used by 1st or 3rd party systems that are not Broadleaf.

fulfillmentFlatRates

Map<String,FulfillmentFlatRate> fulfillmentFlatRates

A map of flat rates for fulfilling (e.g., shipping) this product for a particular fulfillment option type (e.g., standard shipping). Depending on if the option is configured to use flat rates, this flat rate will be used in calculating the cost of fulfilling this product.

The key of the map is the type of the fulfillment option such as FIXED_STANDARD or BANDED_PRICE_EXPRESS.

See Also:

• FulfillmentFlatRate

id

String id

includedProducts

List<IncludedProduct> includedProducts

Additional products that are always included with the product, no matter what. Used to configure "bundles" or "kits".

If some of these items should be optional or the user should decide which additional items are added to their cart, use Product.options instead.

See Also:

• IncludedProduct

individuallySold

boolean individuallySold

If this product or any of its variants can be sold individually in the store, or if they must be apart of another product as an add-on. Usually if a product is not individually sold then it should also not show up in search.

This defaults to true.

See Also:

• Product.searchable

inventoryCheckStrategy

String inventoryCheckStrategy

Describes when the product's inventory should be checked for availability.

See Also:

• InventoryCheckStrategy

inventoryReservationStrategy

String inventoryReservationStrategy

Describes when the product's inventory should be reserved.

See Also:

• InventoryReservationStrategy

inventoryType

String inventoryType

Describes the product's type of fulfillment - ie is it a physical or virtual item?

Defaults to InventoryType.PHYSICAL

See Also:

• InventoryType

keywords

List<String> keywords

Generally additional search terms that should be used when customers search for this product.

maximumThreshold

Integer maximumThreshold

The maximum count of this product that must be added in a cart.

merchandisingProduct

boolean merchandisingProduct

Deprecated.

please use Product.productType instead.

This product is not sold itself, but is a sort of container for subordinate items. This allows for configurable products with different user choices through ProductOption

merchandisingType

DataDrivenEnum merchandisingType

mergingType

String mergingType

Determines how this Product should merge with other similar items when it gets added to a cart. This will override the global setting on item merging. Out of box supported values are those in DefaultMergingType.

metaDescription

String metaDescription

Used for SEO data in <meta description=""> in a product detail page. If this is unset, the Product.description should be used

metaTitle

String metaTitle

Used for SEO data in <title> tag in a product detail page. If this is unset, the Product.name should be used.

minimumThreshold

Integer minimumThreshold

The minimum count of this product that must be added in a cart.

msrp

javax.money.MonetaryAmount msrp

Suggested retail price for the product. This is generally only used for display and should not have any true pricing logic tied to it.

See Also:

• Product.currency

name

String name

Customer-facing name of this product. This can also be overridden at the Variant level

online

boolean online

Whether or not this product should be visible at all in the store. A product that is offline is not searchable, visible, or purchasable.

Defaults to true

options

List<ProductOption> options

Drives additional information that the customer should enter when purchasing this product. This can be in the form of additional variations, additional items that can be bundled with this product or simply more information that the customer needs to enter about what they are purchasing (like a personalized message).

pricingKey

String pricingKey

System-wide unique identifier to configure specific pricing for the product. Relevant if pricing data is managed in a separate system or data store, like the Broadleaf pricing services.

primaryAsset

ProductAsset primaryAsset

The ProductAsset associated with this product marked as ProductAsset.isPrimary(). By default, this is only hydrated for API callers.

primaryCategory

Category primaryCategory

The Category associated with this product where the CategoryProduct relationship is marked as CategoryProduct.isPrimary().

This field is not persisted on the product - instead, this is a dynamically set/hydrated value for API callers to conveniently manage the primary CategoryProduct relationship as part of Product API create/replace calls.

It is not necessarily respected or hydrated in all scenarios.

See Also:

• DefaultProductService.create(Product, ContextInfo)
• DefaultProductService.replace(String, Product, ContextInfo)

productType

String productType

Defines the type of the product. This affects how the product is displayed and managed in the admin UI, how it is handled by cart and order operations, and how it gets indexed by Search Services. The default types are defined by DefaultProductType.

See Also:

• DefaultProductType

reviewsSummary

ReviewsSummary reviewsSummary

The summary of reviews for this product.

salePrice

javax.money.MonetaryAmount salePrice

Indicates that this product is on sale. This should take priority over the default price if this salePrice is lower than the defaultPrice.

searchable

boolean searchable

Whether or not this product shows up in search. Usually this matches whether or not the product is Product.individuallySold

This defaults to true

sku

String sku

This uniquely identifies this product in the catalog when it is sold and is used for other contexts like inventory and pricing.

tags

List<String> tags

A list of simple labels used to categorize the product

targetDemographic

DataDrivenEnum targetDemographic

taxCode

String taxCode

The tax code for this product.

upc

String upc

Universal product code that identifies this product. This is usually only relevant when this product is sold individually without any variants

uri

String uri

SEO-friendly URI to identify this product. This is usually generated with some URL-safe version of the main category name along with a url-friendly version of Product.name

weight

Weight weight

Class com.broadleafcommerce.catalog.domain.product.ReviewsSummary

class ReviewsSummary extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

numberOfReviews

int numberOfReviews

The number of reviews made.

rating

BigDecimal rating

The overall rating for the reviewed product.

ratingUnits

String ratingUnits

The unit of measure for the rating, e.g., stars, thumbs, etc.

Class com.broadleafcommerce.catalog.domain.product.SKUContainer

class SKUContainer extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

displayName

String displayName

sku

String sku

Class com.broadleafcommerce.catalog.domain.product.Variant

class Variant extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

activeEndDate

Instant activeEndDate

When this Variant should no longer be active. Unset to mark this variant as never inactive

See Also:

• Variant.isActive()

activeStartDate

Instant activeStartDate

When this Variant should start to become active. Unset to mark this Variant as always active

See Also:

• Variant.isActive()

attributes

Map<String,Attribute> attributes

Dynamic attributes that are a part of the variant. This is an admin-entered concept.

contextState

com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState

A subset of Tracking information to expose the context state for this object.

cost

javax.money.MonetaryAmount cost

Can be used in display or as apart of more complex pricing algorithms

defaultPrice

javax.money.MonetaryAmount defaultPrice

The default price that should be used if there is not a Variant.salePrice set. This price can also be maintained at the Product level

description

String description

Description of the Variant that can include HTML in implementations where a WYSIWYG editor manages this field.

dimension

Dimensions dimension

discountable

boolean discountable

Whether or not this variant can participate in offers or promotions

externalId

String externalId

This is an arbitrary ID, typically assigned by or used by 1st or 3rd party systems that are not Broadleaf.

fulfillmentFlatRates

Map<String,FulfillmentFlatRate> fulfillmentFlatRates

A map of flat rates for fulfilling (e.g., shipping) this variant for a particular fulfillment option type (e.g., standard shipping). Depending on if the option is configured to use flat rates, this flat rate will be used in calculating the cost of fulfilling this variant.

The key of the map is the type of the fulfillment option such as FIXED_STANDARD or BANDED_PRICE_EXPRESS.

See Also:

• FulfillmentFlatRate

id

String id

The unique identifier for this variant.

inventoryCheckStrategy

String inventoryCheckStrategy

Describes when the variant's inventory should be checked for availability. If not set, defaults to Product.inventoryCheckStrategy.

See Also:

• InventoryCheckStrategy

inventoryReservationStrategy

String inventoryReservationStrategy

Describes when the variant's inventory should be reserved. If not set, defaults to Product.inventoryReservationStrategy.

See Also:

• InventoryReservationStrategy

maximumThreshold

Integer maximumThreshold

The maximum count of this variant can be added in a cart.

minimumThreshold

Integer minimumThreshold

The minimum count of this variant that must be added in a cart.

name

String name

The name of this particular variant of the product. Generally serves as an overridable field from a product. During option selection when narrowing the specific Sku to order

online

boolean online

Indicates whether or not this variant should appear in search or be able to be ordered Variant.isActive()

optionValues

Map<String,String> optionValues

Helper to make this particular variant uniquely identifiable across multiple variants for the same product. Keys correspond to AttributeChoice.attributeName while values correspond to one of the corresponding AttributeChoice.allowedValues.

productId

String productId

The link to the product that this variant is a part of

reviewsSummary

ReviewsSummary reviewsSummary

The summary of reviews for this variant.

salePrice

javax.money.MonetaryAmount salePrice

Indicates that this product is on sale. This should take priority over the default price if the default price is lower

sku

String sku

Sku code for this particular variant. Overrides the main Product Sku that is set, if any

taxCode

String taxCode

The tax code for this variant.

upc

String upc

Universal product code that defines this particular variant of the product

weight

Weight weight

Class com.broadleafcommerce.catalog.domain.product.Weight

class Weight extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

units

String units

See Also:

• WeightUnits

weight

BigDecimal weight

Package com.broadleafcommerce.catalog.domain.product.commerce

Class com.broadleafcommerce.catalog.domain.product.commerce.IncludedProductDetail

class IncludedProductDetail extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

includedProduct

IncludedProduct includedProduct

priceInfo

PriceInfo priceInfo

Summary of the pricing information related to the included product.

product

ProductDetails product

This field contains the specified product if the add-on type is DefaultItemChoiceTargetType.SPECIFIC_PRODUCTS.

variant

VariantDetail variant

This field contains the specified variant if the add-on type is DefaultItemChoiceTargetType.SPECIFIC_VARIANTS.

Class com.broadleafcommerce.catalog.domain.product.commerce.ItemChoiceCategory

class ItemChoiceCategory extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

id

String id

The ID of the category.

name

String name

The name of the category.

productMembershipRule

String productMembershipRule

The rule string used to check if a related product is a member of this category. Only applies when this category's product membership type is CategoryProductMembershipType.RULE_BASED.

See Also:

• CategoryProductMembershipType

products

org.springframework.data.domain.Page<ProductDetails> products

A Page of Products for the category to choose from.

Class com.broadleafcommerce.catalog.domain.product.commerce.ItemChoiceDetail

class ItemChoiceDetail extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

category

ItemChoiceCategory category

The ItemChoiceCategory which the choice will be chosen from by the customer if the ItemChoiceDetail.getTargetType() is DefaultItemChoiceTargetType.CATEGORY. This will include the products in the category.

defaultProduct

ProductDetails defaultProduct

The default product that can be used when driving customer selections if the ItemChoiceDetail.getTargetType() is DefaultItemChoiceTargetType.SPECIFIC_PRODUCTS. Can be null.

defaultProductInCategory

ProductDetails defaultProductInCategory

The default product that can be used when driving customer selections if the ItemChoiceDetail.getTargetType() is DefaultItemChoiceTargetType.CATEGORY.

defaultVariant

VariantDetail defaultVariant

The default variant that can be used when driving customer selections if the ItemChoiceDetail.getTargetType() is DefaultItemChoiceTargetType.SPECIFIC_VARIANTS. Can be null.

itemChoice

ItemChoice itemChoice

priceInfo

PriceInfo priceInfo

Summary of the pricing information related to the choice.

specificChoices

List<SpecificItemChoiceDetail> specificChoices

If the ItemChoiceDetail.getTargetType() is DefaultItemChoiceTargetType.SPECIFIC_PRODUCTS or DefaultItemChoiceTargetType.SPECIFIC_VARIANTS this holds the manually-curated options that the customer can choose from. This also allows for specific override pricing on an item-by-item basis

specificItemChoice

SpecificItemChoiceDetail specificItemChoice

If the ItemChoiceDetail.getTargetType() is DefaultItemChoiceTargetType.SPECIFIC_PRODUCT or DefaultItemChoiceTargetType.SPECIFIC_VARIANT this holds the manually selected option that the customer can choose to add on. This also allows for specific override pricing.

Class com.broadleafcommerce.catalog.domain.product.commerce.ProductDetails

class ProductDetails extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

advancedTags

List<ProductTagDetail> advancedTags

A list of ProductTags sorted based on the sort position of the ProductTag for the product with ties broken by AdvancedTag.getPriority().

assets

List<ProductAsset> assets

All ProductAssets for this product.

breadcrumbs

List<Breadcrumb> breadcrumbs

Navigational Breadcrumbs to show on the details view.

includedProducts

List<IncludedProductDetail> includedProducts

Additional products that are always included with the product, no matter what. Used to create fixed "bundles" or "kits".

If some of these items should be optional or the user should decide which additional items are added to their cart, use ProductDetails.options instead.

options

List<ProductOptionDetail> options

Drives additional information that the customer should enter when purchasing this product. this can be in the form of additional variations, additional items that can be bundled with this product or simply more information that the customer needs to enter about what they are purchasing (like a personalized message).

parentCategories

Set<CategoryRef> parentCategories

All Categories that include the product.

priceInfo

PriceInfo priceInfo

Summary of the pricing information related to the product.

product

Product product

promotionalProducts

Map<String,List<PromotionalProductSummary>> promotionalProducts

Map of all of the related PromotionalProducts grouped by type.

variants

List<VariantDetail> variants

All Variants for this product.

vendorRef

String vendorRef

Soft reference to the vendor associated with this catalog. This value can be null, in which case, no vendor is associated.

Class com.broadleafcommerce.catalog.domain.product.commerce.ProductDetailsContext

class ProductDetailsContext extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

parentCategories

Set<CategoryRef> parentCategories

Set of all Categories that include ProductDetailsContext.resolvedProduct.

relatedCategoryProducts

Map<String,Set<ProductDetails>> relatedCategoryProducts

An aggregation of all of the Products belonging to related Categories mapped by the category's ID.

relatedDataDrivenEnums

List<DataDrivenEnum> relatedDataDrivenEnums

An aggregation of all of the DataDrivenEnums related to the ProductDetailsContext.resolvedProduct.

This allows the DB to be queried fewer times during the build process.

relatedProductAssets

Map<String,List<ProductAsset>> relatedProductAssets

An aggregation of all of the ProductAssets related to the ProductDetailsContext.resolvedProduct. This includes only direct Product assets since SpecificItemChoice assets and IncludedProduct assets will already be populated.

The key is the ID of the parent product.

This allows the DB to be queried fewer times during the build process.

relatedProducts

Map<String,ProductDetails> relatedProducts

An aggregation of all of the Products related to the ProductDetailsContext.resolvedProduct. This includes the Products used by ItemChoices and IncludedProducts.

This allows the DB to be queried fewer times during the build process.

relatedProductTags

Map<String,List<ProductTag>> relatedProductTags

Map of all ProductTags of the ProductDetailsContext.relatedProducts. Mapped by the parent product's ID. The ProductTag.getTag() should be hydrated before adding to this map.

relatedPromotionalProducts

List<PromotionalProductSummary> relatedPromotionalProducts

An aggregation of all of the PromotionalProducts related to the ProductDetailsContext.resolvedProduct.

This allows the DB to be queried fewer times during the build process.

relatedVariants

Map<String,VariantDetail> relatedVariants

An aggregation of all of the Variants related to the ProductDetailsContext.resolvedProduct. This includes the Variants used by ItemChoices and IncludedProducts.

This allows the DB to be queried fewer times during the build process.

request

ProductDetailsRequest request

Deprecated.

Not used and is marked for removal in v2.0.0 as of v1.5.0.

The ProductDetailsRequest made that initiated the ProductDetails build process.

resolvedProduct

Product resolvedProduct

The resolved product for the ProductDetailsContext.request.

specificCategoryChoices

Map<String,ItemChoiceCategory> specificCategoryChoices

An aggregation of all of the Categories related to the ProductDetailsContext.resolvedProduct. This includes the Categories used by ItemChoices.

This allows the DB to be queried fewer times during the build process.

Class com.broadleafcommerce.catalog.domain.product.commerce.ProductDetailsList

class ProductDetailsList extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

productDetails

List<ProductDetails> productDetails

All ProductDetails for this product.

productIdsForMissingEntities

Set<String> productIdsForMissingEntities

All Product Ids that failed lookup for this product.

productUrisForMissingEntities

Set<String> productUrisForMissingEntities

All Product Uris that failed lookup for this product.

Class com.broadleafcommerce.catalog.domain.product.commerce.ProductDetailsRequest

class ProductDetailsRequest extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

attributes

Map<String,Object> attributes

Map holding any additional attributes passed in the request not matching any defined properties.

productIds

Set<String> productIds

The Product.getId() product IDs} matching the products for which ProductDetails are requested. If this field is non-null, then it is used instead of ProductDetailsRequest.productUris.

productUris

Set<String> productUris

The product uris matching the products for which ProductDetails are requested. If ProductDetailsRequest.productIds is non-null, then it is used instead of this field.

Class com.broadleafcommerce.catalog.domain.product.commerce.ProductOptionDetail

class ProductOptionDetail extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

itemChoice

ItemChoiceDetail itemChoice

Configuration for the DefaultProductOptionType.ITEM_CHOICE. Drives customer selection of an additional item to add to their cart

productOption

ProductOption productOption

Class com.broadleafcommerce.catalog.domain.product.commerce.ProductSummary

class ProductSummary extends Object implements Serializable

Serialized Fields

advancedTags

List<ProductTagDetail> advancedTags

A list of ProductTags sorted based on the sort position of the ProductTag for the produt with ties broken by AdvancedTag.getPriority().

assets

List<ProductAsset> assets

All ProductAssets for this product.

priceInfo

PriceInfo priceInfo

Summary of the pricing information related to the product.

product

Product product

variants

List<VariantDetail> variants

All Variants for this product.

Class com.broadleafcommerce.catalog.domain.product.commerce.ProductTagDetail

class ProductTagDetail extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

activeEndDate

Instant activeEndDate

See Also:

• ProductTag.getActiveEndDate()

activeStartDate

Instant activeStartDate

See Also:

• ProductTag.getActiveStartDate()

id

String id

See Also:

• ProductTag.getId()

productId

String productId

ID of the parent product.

tag

AdvancedTag tag

See Also:

• ProductTag.getTag()

Class com.broadleafcommerce.catalog.domain.product.commerce.PromotionalCategoryProductSummary

class PromotionalCategoryProductSummary extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

promotionalCategoryProduct

PromotionalCategoryProduct promotionalCategoryProduct

promotionalProduct

ProductSummary promotionalProduct

The product to promote.

Class com.broadleafcommerce.catalog.domain.product.commerce.PromotionalProductSummary

class PromotionalProductSummary extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

promotionalProduct

PromotionalProduct promotionalProduct

relatedProduct

ProductDetails relatedProduct

The product to promote.

Class com.broadleafcommerce.catalog.domain.product.commerce.SpecificItemChoiceDetail

class SpecificItemChoiceDetail extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

priceInfo

PriceInfo priceInfo

Summary of the pricing information related to the choice.

product

ProductDetails product

If the SpecificItemChoiceDetail.getType() is DefaultSpecificItemChoiceType.PRODUCT this holds the product for this choice

specificItemChoice

SpecificItemChoice specificItemChoice

variant

VariantDetail variant

If the SpecificItemChoiceDetail.getType() is DefaultSpecificItemChoiceType.VARIANT this holds the variant for this choice

variantPricing

Map<String,SpecificItemVariantPricingDetail> variantPricing

Map of a variant to a price which is used to determine an override price for a SpecificItemChoice that applies when specific variants are added to a cart.

Class com.broadleafcommerce.catalog.domain.product.commerce.SpecificItemVariantPricingDetail

class SpecificItemVariantPricingDetail extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

priceInfo

PriceInfo priceInfo

The price to use for this item when the related Variant is selected.

specificItemVariantPricing

SpecificItemVariantPricing specificItemVariantPricing

Class com.broadleafcommerce.catalog.domain.product.commerce.VariantDetail

class VariantDetail extends Object implements Serializable

Serialized Fields

advancedTags

List<ProductTag> advancedTags

The product tags associated with this variant. Must be hydrated.

priceInfo

PriceInfo priceInfo

Summary of the pricing information related to the variant.

variant

Variant variant

vendorRef

String vendorRef

Soft reference to the vendor associated with this catalog. This value can be null, in which case, no vendor is associated.

Package com.broadleafcommerce.catalog.domain.product.option

Class com.broadleafcommerce.catalog.domain.product.option.AttributeChoice

class AttributeChoice extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

allowedValues

List<AttributeChoiceValue> allowedValues

Gives the customer more structured input to fill out their option, which can drive a select field or a color picker with particular colors. This restricts the available values that the user can use to complete this option.

When used to distinguish variants, a value in this list should correspond to the value in a variant's Variant.optionValues map for the AttributeChoice.attributeName key.

attributeName

String attributeName

The order or item attribute that this choice is stored in when the user adds to their cart

When used to distinguish variants, this field corresponds to a key in Variant.optionValues.

errorCode

String errorCode

In case of a validation failure in conjunction with a AttributeChoice.getValidationStrategy() this is the error code that should be shown to customers. This could map into a special message key on the frontend or provide additional information to the user in addition to AttributeChoice.getErrorMessage().

See Also:

• AttributeChoice.getErrorMessage()

errorMessage

String errorMessage

In case of a validation failure in conjunction with a AttributeChoice.getValidationStrategy() this is the message that should be shown to customers. Intended to be displayed directly on the page when the AttributeChoice.getValidationStrategy() fails validation.

required

boolean required

Whether or not the user is required to fill out this option in order to add the product to their cart. This is always validated on cart add.

type

String type

A hint to the frontend of how to display the customer-facing input. For instance, you might display a set of DefaultAttributeChoiceType.COLOR as a color picker, a DefaultAttributeChoiceType.DATE as a date field, etc.

See Also:

• DefaultAttributeChoiceType

validationRule

String validationRule

If AttributeChoice.validationType is regex, this is the expression that should execute against the user's value.

validationStrategy

String validationStrategy

The strategy used to determine when this product option is validated. For example, validation can be done when a product is added to a cart, when an order is submitted, or never (null). Regardless of this strategy, AttributeChoice.required and AttributeChoice.allowedValues are always validated.

See Also:

• DefaultValidationStrategy
• AttributeChoice.validationType

validationType

String validationType

How the validation from AttributeChoice.getValidationStrategy() should be performed. Only relevant if AttributeChoice.getValidationStrategy() is non-null

See Also:

• DefaultValidationType

Class com.broadleafcommerce.catalog.domain.product.option.AttributeChoiceValue

class AttributeChoiceValue extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

displayOrder

Integer displayOrder

How this value displays in the context of all other values within a single AttributeChoice

id

String id

See Also:

• SubIdentifiable.getId()

label

String label

What the customer sees for display. For example, text in the case of sizes or a hex value in the case of colors. Can diverge from AttributeChoiceValue.value which is what is added to the cart

value

String value

The value stored as an item attribute or cart attribute based on what the user selects. This field is required, but can be different than the customer-facing display in AttributeChoiceValue.label

Class com.broadleafcommerce.catalog.domain.product.option.ItemChoice

class ItemChoice extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

category

Category category

The Category which the choice will be chosen from by the customer if the ItemChoice.targetType is DefaultItemChoiceTargetType.CATEGORY.

choiceKey

String choiceKey

The key used during the validation of cart item's configuration to relate this ItemChoice to one of the cart item's dependent items.

defaultProduct

Product defaultProduct

The default product that can be used when driving customer selections if the ItemChoice.targetType is DefaultItemChoiceTargetType.SPECIFIC_PRODUCTS. Can be null.

defaultProductInCategory

Product defaultProductInCategory

The default product that can be used when driving customer selections if the ItemChoice.targetType is DefaultItemChoiceTargetType.CATEGORY.

defaultVariant

Variant defaultVariant

The default variant that can be used when driving customer selections if the ItemChoice.targetType is DefaultItemChoiceTargetType.SPECIFIC_VARIANTS. Can be null.

discountAllowed

boolean discountAllowed

Dictates whether or not discounts are allowed to be applied to this choice.

maximumQuantity

Integer maximumQuantity

The maximum amount of this item that a customer can purchase at a time. If null, this would allow a customer to specify their own quantity for how many of these items they can add to the cart.

minimumQuantity

Integer minimumQuantity

The minimum amount of the item that a customer must purchase.

overridePrice

javax.money.MonetaryAmount overridePrice

The price of this choice. If no pricing is specified here, the price of the target product, ItemChoice.getDefaultVariant() () variant}, or selected product from the category will be used.

If this is a DefaultItemChoiceTargetType.SPECIFIC_PRODUCTS or DefaultItemChoiceTargetType.SPECIFIC_VARIANTS then any price set here will be overridden by the item pricing set on any of the ItemChoice.specificChoices for that choice.

pricingKey

String pricingKey

System-wide unique identifier to configure specific pricing for the choice. Relevant if pricing data is managed in a separate system or data store, like the Broadleaf pricing services.

selectionType

String selectionType

Describes restrictions placed on the customer's ability to select items from the targeted set. Generally, this is a restriction on how many choices can be selected for a single add-to-cart request and, potentially, how quantity is distributed among multiple selected choices.

See Also:

• DefaultItemChoiceSelectionType

specificChoices

List<SpecificItemChoice> specificChoices

If the ItemChoice.targetType is DefaultItemChoiceTargetType.SPECIFIC_PRODUCTS or DefaultItemChoiceTargetType.SPECIFIC_VARIANTS this holds the manually-curated options that the customer can choose from. This also allows for specific override pricing on an item-by-item basis

specificItemChoice

SpecificItemChoice specificItemChoice

If the ItemChoice.targetType is DefaultItemChoiceTargetType.SPECIFIC_PRODUCT or DefaultItemChoiceTargetType.SPECIFIC_VARIANT this holds the manually selected option that the customer can choose to add on. This also allows for specific override pricing.

targetType

String targetType

Identifies the type of items that a customer can choose from, whether specific products, specific variants, or products from a specific category.

See Also:

• DefaultItemChoiceTargetType

Class com.broadleafcommerce.catalog.domain.product.option.ProductOption

class ProductOption extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

attributeChoice

AttributeChoice attributeChoice

Configuration when the ProductOption.type of this option is one of:

1. DefaultProductOptionType.VARIANT_DISTINGUISHING - drives customer further specifying their choices into a specific Variant that contains a unique SKU code, pricing concerns, etc.
2. DefaultProductOptionType.CART_ITEM_ATTRIBUTE - Customer input will flow directly in the item attributes within their cart
3. DefaultProductOptionType.CART_ATTRIBUTE. Customer input will flow directly in the global cart attribute. Any previously-set attribute should be replaced with new values.

contextState

com.broadleafcommerce.data.tracking.core.EmbeddedContextState contextState

A subset of Tracking information to expose the context state for this object.

displayOrder

Integer displayOrder

The ordering of this option in relation to other options on the page. Can be null which indicates ordered last.

See Also:

• ProductOption.compareTo(ProductOption)

id

String id

See Also:

• SubIdentifiable.getId()

itemChoice

ItemChoice itemChoice

Configuration for the DefaultProductOptionType.ITEM_CHOICE. Drives customer selection of an additional item to add to their cart

label

String label

The label shown to customers when displaying this option. This helps communicate to customers how they should fill out the input

searchOnOption

Boolean searchOnOption

If the product option is of type DefaultProductOptionType.VARIANT_DISTINGUISHING, this allows searching based on this product option. For example, if the product were a T-Shirt with three colors, three documents for each color would be indexed.

templateContextId

String templateContextId

If this option came from an OptionTemplate this allows data synchronization if the template is updated.

type

String type

Controls both how the customer should be inputting values to fill out this option as well as storage of where the value will go once added to the cart.

See Also:

• DefaultProductOptionType

Class com.broadleafcommerce.catalog.domain.product.option.SpecificItemChoice

class SpecificItemChoice extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

asset

SpecificItemChoiceAsset asset

The asset for this selection. Intended to override the asset normally shown for the SpecificItemChoice.product or SpecificItemChoice.variant specifically in the context of this relationship.

See Also:

• SpecificItemChoiceAsset

discountAllowed

boolean discountAllowed

Dictates whether or not discounts are allowed to be applied to this add-on.

nameOverride

String nameOverride

When displaying this choice to a customer, an optional override for the display the customer should see. If {@link null}, the product or variant name is used for display

overridePrice

javax.money.MonetaryAmount overridePrice

The price of this explicit selection. If no pricing is specified here, the price of the target product, variant will be used.

If the ItemChoice.getOverridePrice() is set, that will override any price set here and this price should be ignored

pricingKey

String pricingKey

System-wide unique identifier to configure specific pricing for the choice. Relevant if pricing data is managed in a separate system or data store, like the Broadleaf pricing services. Only relevant when ItemChoice.getOverridePrice() is null.

product

Product product

If the SpecificItemChoice.type is DefaultSpecificItemChoiceType.PRODUCT this holds the product for this choice

type

String type

Whether or not this item holds a product or a variant that the customer can select from

See Also:

• DefaultSpecificItemChoiceType

variant

Variant variant

If the SpecificItemChoice.type is DefaultSpecificItemChoiceType.VARIANT this holds the variant for this choice

See Also:

• SpecificItemChoice.variantParentProductId

variantParentProductId

String variantParentProductId

This field contains the id of the parent product of the specified SpecificItemChoice.variant if the type is DefaultSpecificItemChoiceType.VARIANT.

This field is necessary because variants are a sub-resource of product and thus API callers cannot fetch them purely by variant id alone.

See Also:

• SpecificItemChoice.variant

variantPricingOverrides

List<SpecificItemVariantPricing> variantPricingOverrides

Pricing overrides if specific variants of the main product this item belongs to are added to the cart.

Class com.broadleafcommerce.catalog.domain.product.option.SpecificItemVariantPricing

class SpecificItemVariantPricing extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

overridePrice

javax.money.MonetaryAmount overridePrice

The price to use for this item when the related Variant is selected.

pricingKey

String pricingKey

Special key used to target this item from pricing services.

variant

Variant variant

ID of the Variant this pricing should be used with.

Package com.broadleafcommerce.catalog.domain.tag

Class com.broadleafcommerce.catalog.domain.tag.AdvancedTag

class AdvancedTag extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

activeEndDate

Instant activeEndDate

End when this tag is not longer active. Unset indicates that it is always active.

activeStartDate

Instant activeStartDate

Start of when this tag should be active.

attributes

Map<String,Object> attributes

Miscellaneous attributes for this tag.

badgeAsset

TagAsset badgeAsset

An asset that should be displayed for this tag.

badgeMessage

String badgeMessage

Message to display on a storefront such "New" or "Fairtrade" as a badge. This should support rich text (HTML) as well as plain text.

contextState

com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState

A subset of Tracking information to expose the context state for this object.

id

String id

A unique system identifier.

name

String name

A friendly identifier for the tag. Can be used as a search term on the storefront if AdvancedTag.searchableByName is true. This will also be displayed as the facet value.

position

String position

Defines the position over a display component this tag should be displayed such as the "top-left" of a Product's image on a list or details page. If multiple tags have the same position, then their relative order on a product or their AdvancedTag.priority will determine which is displayed.

See Also:

• DefaultTagDisplayPosition

priority

Long priority

Priority of this tag relative to other tags that may share the same AdvancedTag.position or AdvancedTag.type. This provides a way to pick on tag over another when there is a conflict. This could be overridden in the context of a specific product depending on the ProductTag.getSorting().

searchableByName

boolean searchableByName

Whether storefront users can find products (or other entities) with this tag by its AdvancedTag.name.

type

String type

Defines the type of this tag such as "key feature" or "discount". This allows categorizing tags to enhance user's ability to prioritize related tags such as only showing one "discount" tag even if a product has several.

See Also:

• DefaultTagType

Class com.broadleafcommerce.catalog.domain.tag.AdvancedTagRef

class AdvancedTagRef extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

id

String id

See Also:

• AdvancedTag.getId()

name

String name

See Also:

• AdvancedTag.getName()

searchableByName

boolean searchableByName

See Also:

• AdvancedTag.isSearchableByName()

type

String type

See Also:

• AdvancedTag.getType()

Class com.broadleafcommerce.catalog.domain.tag.ProductTag

class ProductTag extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

activeEndDate

Instant activeEndDate

End when this tag is not longer active. Unset indicates that it is always active. This implicitly inherits from the AdvancedTag: If the tag isn't active, neither will this ProductTag, but the reverse is not true.

activeStartDate

Instant activeStartDate

Start of when this tag should be active for the product. This implicitly inherits from the AdvancedTag: If the tag isn't active, neither will this ProductTag, but the reverse is not true.

contextState

com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState

A subset of Tracking information to expose the context state for this object.

id

String id

A unique system identifier.

product

Product product

The Variant to associate to the ProductTag.tag to. May be null, but one of either the Variant or Product must be set. See #targetType.

IMPORTANT: This value is not automatically hydrated when the persistent domain is converted into this projection. That can be done programmatically if needed. The persistent domain stores a leaner representation by default so that updates to the product don't have to be synced and there is no unnecessary duplication of data.

sorted

Boolean sorted

Whether the persistent counterpart to this object has a non-default value for Sortable.getSorting(), which determines order in admin list-grids and the relative precedence of the ProductTag.tag compared to others related to the ProductTag.product on the storefront.

See Also:

• Sorted.getSorted()
• Sortable
• for specific sort order value

sorting

String sorting

Field indicating a sort order, if sorted. This is alphanumeric, allowing for lexicographical sorting.

See Also:

• which is a flag signifying whether this is sorted

tag

AdvancedTag tag

The AdvancedTag to associate with the ProductTag.product.

IMPORTANT: This value is not automatically hydrated when the persistent domain is converted into this projection. That can be done programmatically if needed. The persistent domain stores a leaner representation by default so that updates to the tag don't have to be synced and there is no unnecessary duplication of data.

variant

Variant variant

The Variant to associate to the ProductTag.tag to. May be null, but one of either the Variant or Product must be set. See #targetType.

IMPORTANT: This value is not automatically hydrated when the persistent domain is converted into this projection. That can be done programmatically if needed. The persistent domain stores a leaner representation by default so that updates to the product don't have to be synced and there is no unnecessary duplication of data.

Class com.broadleafcommerce.catalog.domain.tag.TagAsset

class TagAsset extends com.broadleafcommerce.asset.consumer.domain.EntityAsset implements Serializable

serialVersionUID:

1L

Package com.broadleafcommerce.catalog.provider.jpa.domain

Class com.broadleafcommerce.catalog.provider.jpa.domain.JpaAttribute

class JpaAttribute extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

nameLabel

String nameLabel

See Also:

• Attribute.getNameLabel()

value

Object value

See Also:

• Attribute.getValue()

Class com.broadleafcommerce.catalog.provider.jpa.domain.JpaCartFieldMapping

class JpaCartFieldMapping extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

_id

String _id

attributeName

String attributeName

The attribute name where this field's value should be stored in.

contextId

String contextId

tracking

com.broadleafcommerce.data.tracking.jpa.filtering.domain.ApplicationJpaTracking tracking

See Also:

• ApplicationJpaTracking

valuePath

String valuePath

The JsonPath on the Product to retrieve the value(s) which should be stored in that attribute.

Class com.broadleafcommerce.catalog.provider.jpa.domain.JpaCategoryProduct

class JpaCategoryProduct extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

_id

String _id

categoryContextId

String categoryContextId

contextId

String contextId

primary

boolean primary

productContextId

String productContextId

sorting

String sorting

tracking

com.broadleafcommerce.data.tracking.jpa.filtering.domain.CatalogJpaTracking tracking

Class com.broadleafcommerce.catalog.provider.jpa.domain.JpaFulfillmentFlatRate

class JpaFulfillmentFlatRate extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

currency

javax.money.CurrencyUnit currency

value

BigDecimal value

See Also:

• FulfillmentFlatRate.getValue()

Class com.broadleafcommerce.catalog.provider.jpa.domain.JpaIncludedProduct

class JpaIncludedProduct extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

asset

JpaIncludedProductAsset asset

See Also:

• IncludedProduct.getAsset()

currency

javax.money.CurrencyUnit currency

discountAllowed

boolean discountAllowed

Deprecated.

displayOrder

Long displayOrder

id

String id

See Also:

• SubIdentifiable.getId()

label

String label

overridePrice

BigDecimal overridePrice

Deprecated.

pricingKey

String pricingKey

Deprecated.

See Also:

• IncludedProduct.getPricingKey()

productContextId

String productContextId

quantity

int quantity

type

String type

variantContextId

String variantContextId

variantParentProductContextId

String variantParentProductContextId

Class com.broadleafcommerce.catalog.provider.jpa.domain.JpaPromotionalCategoryProduct

class JpaPromotionalCategoryProduct extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

_id

String _id

categoryContextId

String categoryContextId

contextId

String contextId

promotionalProductContextId

String promotionalProductContextId

promotionalProductType

String promotionalProductType

promotionMessage

String promotionMessage

sorting

String sorting

See Also:

• Sortable.getSorting()

tracking

com.broadleafcommerce.data.tracking.jpa.filtering.domain.CatalogJpaTracking tracking

Package com.broadleafcommerce.catalog.provider.jpa.domain.asset

Class com.broadleafcommerce.catalog.provider.jpa.domain.asset.JpaCategoryAsset

class JpaCategoryAsset extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

_id

String _id

altText

String altText

See Also:

• EntityAsset.altText

applicationId

String applicationId

See Also:

• EntityAsset.getApplicationId()

categoryContextId

String categoryContextId

contextId

String contextId

embedCode

String embedCode

See Also:

• EntityAsset.embedCode

primary

boolean primary

provider

String provider

See Also:

• EntityAsset.provider

sorting

String sorting

tags

List<JpaCategoryAssetTag> tags

See Also:

• EntityAsset.tags

tenantId

String tenantId

See Also:

• EntityAsset.getTenantId()

title

String title

See Also:

• EntityAsset.title

tracking

com.broadleafcommerce.data.tracking.jpa.filtering.domain.CatalogJpaTracking tracking

type

String type

See Also:

• EntityAsset.type

url

String url

See Also:

• EntityAsset.url

Class com.broadleafcommerce.catalog.provider.jpa.domain.asset.JpaCategoryAssetTag

class JpaCategoryAssetTag extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

asset

JpaCategoryAsset asset

The JpaCategoryAsset that this tag belongs to.

tag

String tag

The actual tag value.

See Also:

• EntityAsset.tags
• JpaCategoryAsset.tags

Class com.broadleafcommerce.catalog.provider.jpa.domain.asset.JpaCategoryAssetTagId

class JpaCategoryAssetTagId extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

asset

String asset

See Also:

• JpaCategoryAssetTag.asset

tag

String tag

See Also:

• JpaCategoryAssetTag.tag

Class com.broadleafcommerce.catalog.provider.jpa.domain.asset.JpaIncludedProductAsset

class JpaIncludedProductAsset extends com.broadleafcommerce.asset.consumer.domain.EntityAsset implements Serializable

serialVersionUID:

1L

Class com.broadleafcommerce.catalog.provider.jpa.domain.asset.JpaProductAsset

class JpaProductAsset extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

_id

String _id

altText

String altText

See Also:

• EntityAsset.altText

applicationId

String applicationId

See Also:

• EntityAsset.getApplicationId()

contextId

String contextId

embedCode

String embedCode

See Also:

• EntityAsset.embedCode

primary

boolean primary

productContextId

String productContextId

provider

String provider

See Also:

• EntityAsset.provider

sorting

String sorting

tags

List<JpaProductAssetTag> tags

See Also:

• EntityAsset.tags

tenantId

String tenantId

See Also:

• EntityAsset.getTenantId()

title

String title

See Also:

• EntityAsset.title

tracking

com.broadleafcommerce.data.tracking.jpa.filtering.domain.CatalogJpaTracking tracking

type

String type

See Also:

• EntityAsset.type

url

String url

See Also:

• EntityAsset.url

Class com.broadleafcommerce.catalog.provider.jpa.domain.asset.JpaProductAssetTag

class JpaProductAssetTag extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

asset

JpaProductAsset asset

The JpaProductAsset that this tag belongs to.

tag

String tag

The actual tag value.

See Also:

• EntityAsset.tags
• JpaProductAsset.tags

Class com.broadleafcommerce.catalog.provider.jpa.domain.asset.JpaProductAssetTagId

class JpaProductAssetTagId extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

asset

String asset

See Also:

• JpaProductAssetTag.asset

tag

String tag

See Also:

• JpaProductAssetTag.tag

Class com.broadleafcommerce.catalog.provider.jpa.domain.asset.JpaSpecificItemChoiceAsset

class JpaSpecificItemChoiceAsset extends com.broadleafcommerce.asset.consumer.domain.EntityAsset implements Serializable

serialVersionUID:

1L

Package com.broadleafcommerce.catalog.provider.jpa.domain.category

Class com.broadleafcommerce.catalog.provider.jpa.domain.category.JpaCategory

class JpaCategory extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

_id

String _id

activeEndDate

Instant activeEndDate

activeStartDate

Instant activeStartDate

attributes

Map<String,JpaAttribute> attributes

contextId

String contextId

description

String description

displayTemplate

String displayTemplate

externalId

String externalId

metaDescription

String metaDescription

metaTitle

String metaTitle

name

String name

parentCategoryContextId

String parentCategoryContextId

productMembershipLocale

Locale productMembershipLocale

productMembershipRule

String productMembershipRule

productMembershipType

String productMembershipType

showInSiteMap

boolean showInSiteMap

taxCode

String taxCode

tracking

com.broadleafcommerce.data.tracking.jpa.filtering.domain.CatalogJpaTracking tracking

url

String url

Package com.broadleafcommerce.catalog.provider.jpa.domain.enumeration

Class com.broadleafcommerce.catalog.provider.jpa.domain.enumeration.JpaDataDrivenEnum

class JpaDataDrivenEnum extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

_id

String _id

contextId

String contextId

displayValue

String displayValue

See Also:

• DataDrivenEnum.getDisplayValue()

tracking

com.broadleafcommerce.data.tracking.jpa.filtering.domain.ApplicationJpaTracking tracking

type

String type

See Also:

• DataDrivenEnum.getType()

value

String value

See Also:

• DataDrivenEnum.getValue()

Package com.broadleafcommerce.catalog.provider.jpa.domain.option

Class com.broadleafcommerce.catalog.provider.jpa.domain.option.JpaOptionTemplate

class JpaOptionTemplate extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

_id

String _id

allowedValues

List<JpaAttributeChoiceValue> allowedValues

attributeName

String attributeName

categoryContextId

String categoryContextId

choiceKey

String choiceKey

choiceType

String choiceType

contextId

String contextId

currency

javax.money.CurrencyUnit currency

defaultProductContextId

String defaultProductContextId

defaultProductInCategoryContextId

String defaultProductInCategoryContextId

defaultVariantContextId

String defaultVariantContextId

discountAllowed

Boolean discountAllowed

displayOrder

Integer displayOrder

errorCode

String errorCode

errorMessage

String errorMessage

label

String label

maximumQuantity

Integer maximumQuantity

minimumQuantity

Integer minimumQuantity

name

String name

optionSubItemIdentifier

String optionSubItemIdentifier

optionType

String optionType

overridePrice

BigDecimal overridePrice

pricingKey

String pricingKey

productContextId

String productContextId

requiredChoice

Boolean requiredChoice

selectionType

String selectionType

specificChoices

List<JpaSpecificItemChoice> specificChoices

targetType

String targetType

templateContextId

String templateContextId

tracking

com.broadleafcommerce.data.tracking.jpa.filtering.domain.CatalogJpaTracking tracking

validationRule

String validationRule

validationStrategy

String validationStrategy

validationType

String validationType

Class com.broadleafcommerce.catalog.provider.jpa.domain.option.JpaOptionTemplateGroup

class JpaOptionTemplateGroup extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

_id

String _id

contextId

String contextId

name

String name

templateContextIds

List<String> templateContextIds

tracking

com.broadleafcommerce.data.tracking.jpa.filtering.domain.CatalogJpaTracking tracking

Package com.broadleafcommerce.catalog.provider.jpa.domain.product

Class com.broadleafcommerce.catalog.provider.jpa.domain.product.JpaProduct

class JpaProduct extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

_id

String _id

activeEndDate

Instant activeEndDate

activeStartDate

Instant activeStartDate

attributes

Map<String,JpaAttribute> attributes

availableOnline

boolean availableOnline

brandContextId

String brandContextId

contextId

String contextId

cost

BigDecimal cost

currency

javax.money.CurrencyUnit currency

defaultPrice

BigDecimal defaultPrice

depth

BigDecimal depth

description

String description

dimensionUnits

String dimensionUnits

discountable

boolean discountable

displayTemplate

String displayTemplate

eligibleForPickup

boolean eligibleForPickup

externalId

String externalId

fulfillmentFlatRates

Map<String,JpaFulfillmentFlatRate> fulfillmentFlatRates

height

BigDecimal height

includedProducts

List<JpaIncludedProduct> includedProducts

individuallySold

boolean individuallySold

inventoryCheckStrategy

String inventoryCheckStrategy

inventoryReservationStrategy

String inventoryReservationStrategy

inventoryType

String inventoryType

keywords

List<String> keywords

maximumThreshold

Integer maximumThreshold

merchandisingProduct

boolean merchandisingProduct

merchandisingTypeContextId

String merchandisingTypeContextId

mergingType

String mergingType

metaDescription

String metaDescription

metaTitle

String metaTitle

minimumThreshold

Integer minimumThreshold

msrp

BigDecimal msrp

name

String name

numberOfReviews

Integer numberOfReviews

See Also:

• ReviewsSummary.getNumberOfReviews()

online

boolean online

options

List<JpaProductOption> options

pricingKey

String pricingKey

productType

String productType

rating

BigDecimal rating

See Also:

• ReviewsSummary.getRating()

ratingUnits

String ratingUnits

See Also:

• ReviewsSummary.getRatingUnits()

salePrice

BigDecimal salePrice

searchable

boolean searchable

sku

String sku

tags

String tags

targetDemographicContextId

String targetDemographicContextId

taxCode

String taxCode

tracking

com.broadleafcommerce.data.tracking.jpa.filtering.domain.CatalogJpaTracking tracking

upc

String upc

uri

String uri

weight

BigDecimal weight

weightUnits

String weightUnits

width

BigDecimal width

Class com.broadleafcommerce.catalog.provider.jpa.domain.product.JpaVariant

class JpaVariant extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

_id

String _id

activeEndDate

Instant activeEndDate

activeStartDate

Instant activeStartDate

attributes

Map<String,JpaAttribute> attributes

contextId

String contextId

cost

BigDecimal cost

currency

javax.money.CurrencyUnit currency

defaultPrice

BigDecimal defaultPrice

depth

BigDecimal depth

description

String description

dimensionUnits

String dimensionUnits

discountable

boolean discountable

externalId

String externalId

fulfillmentFlatRates

Map<String,JpaFulfillmentFlatRate> fulfillmentFlatRates

height

BigDecimal height

inventoryCheckStrategy

String inventoryCheckStrategy

inventoryReservationStrategy

String inventoryReservationStrategy

maximumThreshold

Integer maximumThreshold

minimumThreshold

Integer minimumThreshold

name

String name

numberOfReviews

Integer numberOfReviews

See Also:

• ReviewsSummary.getNumberOfReviews()

online

boolean online

optionValues

Map<String,String> optionValues

productContextId

String productContextId

rating

BigDecimal rating

See Also:

• ReviewsSummary.getRating()

ratingUnits

String ratingUnits

See Also:

• ReviewsSummary.getRatingUnits()

salePrice

BigDecimal salePrice

sku

String sku

taxCode

String taxCode

tracking

com.broadleafcommerce.data.tracking.jpa.filtering.domain.CatalogJpaTracking tracking

upc

String upc

weight

BigDecimal weight

weightUnits

String weightUnits

width

BigDecimal width

Package com.broadleafcommerce.catalog.provider.jpa.domain.product.option

Class com.broadleafcommerce.catalog.provider.jpa.domain.product.option.JpaAttributeChoice

class JpaAttributeChoice extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

allowedValues

List<JpaAttributeChoiceValue> allowedValues

attributeName

String attributeName

errorCode

String errorCode

errorMessage

String errorMessage

required

Boolean required

type

String type

validationRule

String validationRule

validationStrategy

String validationStrategy

validationType

String validationType

Class com.broadleafcommerce.catalog.provider.jpa.domain.product.option.JpaAttributeChoiceValue

class JpaAttributeChoiceValue extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

displayOrder

Integer displayOrder

id

String id

See Also:

• SubIdentifiable.getId()

label

String label

value

String value

Class com.broadleafcommerce.catalog.provider.jpa.domain.product.option.JpaItemChoice

class JpaItemChoice extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

categoryContextId

String categoryContextId

choiceKey

String choiceKey

currency

javax.money.CurrencyUnit currency

defaultProductContextId

String defaultProductContextId

defaultProductInCategoryContextId

String defaultProductInCategoryContextId

defaultVariantContextId

String defaultVariantContextId

discountAllowed

Boolean discountAllowed

maximumQuantity

Integer maximumQuantity

minimumQuantity

Integer minimumQuantity

overridePrice

BigDecimal overridePrice

pricingKey

String pricingKey

selectionType

String selectionType

specificChoices

List<JpaSpecificItemChoice> specificChoices

specificItemChoice

JpaSpecificItemChoice specificItemChoice

targetType

String targetType

Class com.broadleafcommerce.catalog.provider.jpa.domain.product.option.JpaProductOption

class JpaProductOption extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

attributeChoice

JpaAttributeChoice attributeChoice

displayOrder

Integer displayOrder

itemChoice

JpaItemChoice itemChoice

label

String label

productContextId

String productContextId

searchOnOption

Boolean searchOnOption

subItemIdentifier

String subItemIdentifier

templateContextId

String templateContextId

type

String type

Class com.broadleafcommerce.catalog.provider.jpa.domain.product.option.JpaSpecificItemChoice

class JpaSpecificItemChoice extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

asset

JpaSpecificItemChoiceAsset asset

currency

javax.money.CurrencyUnit currency

discountAllowed

boolean discountAllowed

nameOverride

String nameOverride

overridePrice

BigDecimal overridePrice

pricingKey

String pricingKey

productContextId

String productContextId

type

String type

variantContextId

String variantContextId

variantParentProductContextId

String variantParentProductContextId

variantPricingOverrides

List<JpaSpecificItemVariantPricing> variantPricingOverrides

Class com.broadleafcommerce.catalog.provider.jpa.domain.product.option.JpaSpecificItemVariantPricing

class JpaSpecificItemVariantPricing extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

currency

javax.money.CurrencyUnit currency

overridePrice

BigDecimal overridePrice

pricingKey

String pricingKey

variantId

String variantId

variantSku

String variantSku

Package com.broadleafcommerce.catalog.provider.jpa.domain.product.relation

Class com.broadleafcommerce.catalog.provider.jpa.domain.product.relation.JpaPromotionalProduct

class JpaPromotionalProduct extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

_id

String _id

contextId

String contextId

productContextId

String productContextId

promotionMessage

String promotionMessage

relatedProductContextId

String relatedProductContextId

sorting

String sorting

See Also:

• Sortable.getSorting()

tracking

com.broadleafcommerce.data.tracking.jpa.filtering.domain.CatalogJpaTracking tracking

type

String type

Package com.broadleafcommerce.catalog.provider.jpa.domain.tag

Class com.broadleafcommerce.catalog.provider.jpa.domain.tag.JpaAdvancedTag

class JpaAdvancedTag extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

_id

String _id

activeEndDate

Instant activeEndDate

activeStartDate

Instant activeStartDate

attributes

Map<String,Object> attributes

badgeAsset

JpaTagAsset badgeAsset

badgeMessage

String badgeMessage

contextId

String contextId

name

String name

position

String position

priority

Long priority

searchableByName

boolean searchableByName

tracking

com.broadleafcommerce.data.tracking.jpa.filtering.domain.ApplicationJpaTracking tracking

type

String type

Class com.broadleafcommerce.catalog.provider.jpa.domain.tag.JpaProductTag

class JpaProductTag extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

_id

String _id

activeEndDate

Instant activeEndDate

activeStartDate

Instant activeStartDate

contextId

String contextId

productContextId

String productContextId

sorting

String sorting

tagContextId

String tagContextId

tracking

com.broadleafcommerce.data.tracking.jpa.filtering.domain.CatalogJpaTracking tracking

variantId

String variantId

Class com.broadleafcommerce.catalog.provider.jpa.domain.tag.JpaTagAsset

class JpaTagAsset extends com.broadleafcommerce.asset.consumer.domain.EntityAsset implements Serializable

serialVersionUID:

1L

Package com.broadleafcommerce.catalog.provider.shared.messaging.search

Class com.broadleafcommerce.catalog.provider.shared.messaging.search.AncillaryProductSingleIndexRequestPayload

class AncillaryProductSingleIndexRequestPayload extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

productContextId

String productContextId

The context ID of the product for which a reindex will be requested.

Class com.broadleafcommerce.catalog.provider.shared.messaging.search.ProductSingleIndexRequestPayload

class ProductSingleIndexRequestPayload extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

contextId

String contextId

The context ID of the product for which a reindex will be requested.

Package com.broadleafcommerce.catalog.service.category.commerce.exception

Exception com.broadleafcommerce.catalog.service.category.commerce.exception.CategoryDetailsRequestException

class CategoryDetailsRequestException extends RuntimeException implements Serializable

Package com.broadleafcommerce.catalog.service.enumeration.commerce.exception

Exception com.broadleafcommerce.catalog.service.enumeration.commerce.exception.DataDrivenEnumDetailsRequestException

class DataDrivenEnumDetailsRequestException extends RuntimeException implements Serializable

serialVersionUID:

1L

Package com.broadleafcommerce.catalog.service.product.commerce.exception

Exception com.broadleafcommerce.catalog.service.product.commerce.exception.ProductDetailsRequestException

class ProductDetailsRequestException extends RuntimeException implements Serializable

Package com.broadleafcommerce.catalog.web.endpoint.dto

Class com.broadleafcommerce.catalog.web.endpoint.dto.OptionGenerationRequest

class OptionGenerationRequest extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

generationType

String generationType

The type of the generation: Either OptionGenerationType.TEMPLATE or OptionGenerationType.TEMPLATE_GROUP.

productId

String productId

ID of the Product for which options should be generated.

template

OptionTemplateRef template

The OptionTemplateRef of the OptionTemplate to be used for generating options for a product if the OptionGenerationRequest.generationType is OptionGenerationType.TEMPLATE, then this field is used.

templateGroup

OptionTemplateGroupRef templateGroup

The OptionTemplateGroupRef of the OptionTemplateGroup to be used for generating options for a product if the OptionGenerationRequest.generationType is OptionGenerationType.TEMPLATE_GROUP, then this field is used.

Class com.broadleafcommerce.catalog.web.endpoint.dto.SkuGenerationParameters

class SkuGenerationParameters extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

prefix

String prefix

Default is SKU-

Package com.broadleafcommerce.catalog.web.endpoint.exception

Exception com.broadleafcommerce.catalog.web.endpoint.exception.CategoryAncestryHydrationException

class CategoryAncestryHydrationException extends RuntimeException implements Serializable

Exception com.broadleafcommerce.catalog.web.endpoint.exception.InvalidCategoryDeleteException

class InvalidCategoryDeleteException extends Exception implements Serializable

Exception com.broadleafcommerce.catalog.web.endpoint.exception.InvalidCategoryTypeException

class InvalidCategoryTypeException extends Exception implements Serializable

Exception com.broadleafcommerce.catalog.web.endpoint.exception.InvalidParentCategoryException

class InvalidParentCategoryException extends Exception implements Serializable

Exception com.broadleafcommerce.catalog.web.endpoint.exception.InvalidRelatedProductException

class InvalidRelatedProductException extends Exception implements Serializable