Serialized Form (Broadleaf Catalog Browse Services 1.7.1-GA API)

Package com.broadleafcommerce.catalogbrowse.domain
- Class com.broadleafcommerce.catalogbrowse.domain.AdvancedTag 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.
    - id
      
      String id
      
      A unique system identifier.
    - name
      
      String name
      
      A friendly identifier for the tag.
    - 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.
    - 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().
    - 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.
- Class com.broadleafcommerce.catalogbrowse.domain.Asset 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.
    - primary
      
      boolean primary
      
      Determines whether this asset should be considered the primary (or default) asset for the parent entity.
      For any entity, there can only be one Asset with this value set to true.
    - tags
      
      LinkedHashSet<String> tags
      
      Descriptive or identifying labels.
- Class com.broadleafcommerce.catalogbrowse.domain.BrowseDetailsRequest extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - contextInfo
      
      com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo
      
      The ContextInfo derived from the original request containing tenant and sandbox info.
    - parameters
      
      org.springframework.util.MultiValueMap<String,String> parameters
      
      The parameters included in the original request that don't need to be enumerated in this service but passed along to the provider.
    - priceContext
      
      com.broadleafcommerce.pricing.client.domain.context.PriceContext priceContext
      
      The PriceContext from the original request containing general pricing info.
    - priceInfoContext
      
      com.broadleafcommerce.pricing.client.domain.context.PriceInfoContext priceInfoContext
      
      The PriceInfoContext from the original request containing info specific for getting PriceInfos such as prefetched PriceLists.
- Class com.broadleafcommerce.catalogbrowse.domain.BrowseEntityDetails extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - category
      
      Category category
      
      The category that matched the BrowseDetailsRequest.
    - products
      
      List<Product> products
      
      All Products and their details if products match the BrowseDetailsRequest.
    - urisForMissingEntities
      
      Set<String> urisForMissingEntities
      
      All URIs that failed to match known Products or Categories.
- Class com.broadleafcommerce.catalogbrowse.domain.CatalogSearchRequest extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - contextInfo
      
      com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo
      
      The ContextInfo derived from the original request containing tenant and sandbox info.
    - parameters
      
      org.springframework.util.MultiValueMap<String,String> parameters
      
      The parameters included in the original request that don't need to be enumerated in this service but passed along to the provider.
    - priceContext
      
      com.broadleafcommerce.pricing.client.domain.context.PriceContext priceContext
      
      The PriceContext from the original request containing general pricing info.
    - priceInfoContext
      
      com.broadleafcommerce.pricing.client.domain.context.PriceInfoContext priceInfoContext
      
      The PriceInfoContext from the original request containing info specific for getting PriceInfos such as prefetched PriceLists.
- Class com.broadleafcommerce.catalogbrowse.domain.CatalogTypeAheadRequest extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - contextInfo
      
      com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo
      
      The ContextInfo derived from the original request containing tenant and sandbox info.
    - parameters
      
      org.springframework.util.MultiValueMap<String,String> parameters
      
      The parameters included in the original request that don't need to be enumerated in this service but passed along to the provider.
    - priceContext
      
      com.broadleafcommerce.pricing.client.domain.context.PriceContext priceContext
      
      The PriceContext from the original request containing general pricing info.
    - priceInfoContext
      
      com.broadleafcommerce.pricing.client.domain.context.PriceInfoContext priceInfoContext
      
      The PriceInfoContext from the original request containing info specific for getting PriceInfos such as prefetched PriceLists.
- Class com.broadleafcommerce.catalogbrowse.domain.Category 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.
    - id
      
      String id
      
      The context ID of the category.
    - products
      
      SimplePage<Product> products
      
      A page of Products belonging to the category. To configure the page pass paging params to the endpoint.
- Class com.broadleafcommerce.catalogbrowse.domain.CategoryDetailsRequest extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - contextInfo
      
      com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo
      
      The ContextInfo derived from the original request containing tenant and sandbox info.
    - parameters
      
      org.springframework.util.MultiValueMap<String,String> parameters
      
      The parameters included in the original request that don't need to be enumerated in this service but passed along to the provider.
    - priceContext
      
      com.broadleafcommerce.pricing.client.domain.context.PriceContext priceContext
      
      The PriceContext from the original request containing general pricing info.
    - priceInfoContext
      
      com.broadleafcommerce.pricing.client.domain.context.PriceInfoContext priceInfoContext
      
      The PriceInfoContext from the original request containing info specific for getting PriceInfos such as prefetched PriceLists.
- Class com.broadleafcommerce.catalogbrowse.domain.DataDrivenEnum extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - associatedCategoryExists
      
      boolean associatedCategoryExists
      
      Declares whether there is a Category associated with this DataDrivenEnum based on DataDrivenEnum.getValue().
      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.
    - 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.
- Class com.broadleafcommerce.catalogbrowse.domain.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.
    - contextInfo
      
      com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo
      
      The ContextInfo derived from the original request containing tenant and sandbox info.
    - dataDrivenEnumIds
      
      Set<String> dataDrivenEnumIds
      
      The data driven enum IDs of requested DataDrivenEnums.
- Class com.broadleafcommerce.catalogbrowse.domain.DataDrivenEnumList extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - dataDrivenEnumIdsForMissingEntities
      
      Set<String> dataDrivenEnumIdsForMissingEntities
      
      The list of provided ids for which a DataDrivenEnum could not be found
    - dataDrivenEnums
      
      List<DataDrivenEnum> dataDrivenEnums
      
      All DataDrivenEnums and their details.
- Class com.broadleafcommerce.catalogbrowse.domain.IncludedProduct 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.
    - overridePrice
      
      javax.money.MonetaryAmount overridePrice
      
      The specific price set for this included item that overrides the price of underlying IncludedProduct.product or IncludedProduct.variant. This is primarily used for reference in determining whether IncludedProduct.priceInfo should be disregarded in pricing calculations in this service: If there is an overridePrice, then the IncludedProduct.priceInfo received from the CatalogProvider should be used as the base for additional pricing calculations informed by the PricingProvider. Otherwise, the received IncludedProduct.priceInfo should be discarded since it is really a copy of the underlying IncludedProduct.product or IncludedProduct.variant and cannot be used as a basis for additional pricing calculations for the IncludedProduct itself.
    - priceInfo
      
      com.broadleafcommerce.pricing.client.domain.PriceInfo priceInfo
      
      Summary of the pricing information related to the included item. The consumer of this service is expecting this to be the source of truth for the pricing of this item, so this field should be calculated from its own override price if present or be a copy of the underlying product's or variant's pricing to simplify the consumer's logic.
      
      See Also:
      
      for special pricing considerations
    - pricingKey
      
      String pricingKey
      
      Unique pricing key for this particular included item. Useful for scenarios such as pricing of included items, where a system wide unique identifier for the included item would be required to associate it with a price within an external system
    - product
      
      Product product
      
      This field contains the specified product if the type is DefaultIncludedProductType.PRODUCT.
    - quantity
      
      int quantity
      
      Fixed quantity of the item that is included with the parent product.
    - type
      
      String type
      
      Defines the type of the item: usually a Product or Variant.
      
      See Also:
      
      DefaultIncludedProductType
    - variant
      
      Variant variant
      
      This field contains the specified variant if the type is DefaultIncludedProductType.VARIANT.
- Class com.broadleafcommerce.catalogbrowse.domain.ItemChoice 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.
    - category
      
      ItemChoiceCategory category
      
      The ItemChoiceCategory which the choice will be chosen from by the customer if the ItemChoice.getTargetType() is DefaultItemChoiceTargetType.CATEGORY. This will include the products in the 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.
    - priceInfo
      
      com.broadleafcommerce.pricing.client.domain.PriceInfo priceInfo
      
      Summary of the pricing information related to the 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.
    - 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.catalogbrowse.domain.ItemChoiceCategory 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.
    - id
      
      String id
      
      The ID of the category.
    - products
      
      SimplePage<Product> products
      
      A SimplePage of Products for the category to choose from.
- Class com.broadleafcommerce.catalogbrowse.domain.Product extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - advancedTags
      
      List<ProductTag> 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<Asset> assets
      
      All Asset assets for this product.
    - attributes
      
      Map<String,Object> attributes
      
      Map holding any additional attributes passed in the request not matching any defined properties.
    - currency
      
      javax.money.CurrencyUnit currency
      
      Currency for this product.
    - id
      
      String id
      
      The unique identifier for this product.
    - includedProducts
      
      List<IncludedProduct> includedProducts
      
      Additional products or variants 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 Product.options instead.
    - maximumThreshold
      
      Integer maximumThreshold
      
      The maximum count of this product that must be added in a cart.
    - 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.
    - minimumThreshold
      
      Integer minimumThreshold
      
      The minimum count of this product that must be added in a cart.
    - 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).
    - price
      
      javax.money.MonetaryAmount price
      
      The price of the product. Sometimes services won't return a property PriceInfo but just a price instead. This should be converted to a price info and not returned as a separate field.
    - priceInfo
      
      com.broadleafcommerce.pricing.client.domain.PriceInfo priceInfo
      
      Summary of the pricing information related to the product.
    - 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
      
      Asset primaryAsset
      
      The primary or default Asset to display.
    - productType
      
      String productType
      
      Defines the type of the product.
      
      See Also:
      
      DefaultProductType
    - promotionalProducts
      
      Map<String,List<PromotionalProduct>> promotionalProducts
      
      Map of all of the related PromotionalProducts grouped by type.
    - 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.
    - variants
      
      List<Variant> 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.catalogbrowse.domain.ProductDetailsRequest extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - contextInfo
      
      com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo
      
      The ContextInfo derived from the original request containing tenant and sandbox info.
    - parameters
      
      org.springframework.util.MultiValueMap<String,String> parameters
      
      The parameters included in the original request that don't need to be enumerated in this service but passed along to the provider.
    - priceContext
      
      com.broadleafcommerce.pricing.client.domain.context.PriceContext priceContext
      
      The PriceContext from the original request containing general pricing info.
    - priceInfoContext
      
      com.broadleafcommerce.pricing.client.domain.context.PriceInfoContext priceInfoContext
      
      The PriceInfoContext from the original request containing info specific for getting PriceInfos such as prefetched PriceLists.
- Class com.broadleafcommerce.catalogbrowse.domain.ProductList extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - productIdsForMissingEntities
      
      Set<String> productIdsForMissingEntities
      
      The list of provided ids for which a Product could not be found
    - products
      
      List<Product> products
      
      All Products and their details.
    - productUrisForMissingEntities
      
      Set<String> productUrisForMissingEntities
      
      The list of provided uris for which a Product could not be found
- Class com.broadleafcommerce.catalogbrowse.domain.ProductOption 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.
    - itemChoice
      
      ItemChoice itemChoice
      
      Configuration for the DefaultProductOptionType.ITEM_CHOICE. Drives customer selection of an additional item to add to their cart
    - 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.catalogbrowse.domain.ProductTag 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.
    - id
      
      String id
      
      A unique system identifier.
    - productId
      
      String productId
      
      ID of the parent product.
    - sorting
      
      String sorting
      
      Field indicating a sort order, if sorted. This is alphanumeric, allowing for lexicographical sorting.
    - tag
      
      AdvancedTag tag
      
      The AdvancedTag to associate with a product.
- Class com.broadleafcommerce.catalogbrowse.domain.PromotionalProduct 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.
    - relatedProduct
      
      Product relatedProduct
      
      The product being promoted.
    - type
      
      String type
      
      The type of the promotional product such as UP_SALE and CROSS_SALE.
- Class com.broadleafcommerce.catalogbrowse.domain.SearchResponse 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.
    - content
      
      List<T> content
      
      The actual results for the search request.
- Class com.broadleafcommerce.catalogbrowse.domain.SimplePage 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.
    - content
      
      List<T> content
- Class com.broadleafcommerce.catalogbrowse.domain.SpecificItemChoice 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.
    - overridePrice
      
      javax.money.MonetaryAmount overridePrice
      
      The specific price set for this choice that overrides the price of underlying SpecificItemChoice.product or SpecificItemChoice.variant. This is primarily used for reference in determining whether SpecificItemChoice.priceInfo should be disregarded in pricing calculations in this service: If there is an overridePrice, then the SpecificItemChoice.priceInfo received from the CatalogProvider should be used as the base for additional pricing calculations informed by the PricingProvider. Otherwise, it should be discarded since it is really a copy of the underlying SpecificItemChoice.product or SpecificItemChoice.variant and cannot be used as a basis for additional pricing calculations for the SpecificItemChoice itself.
    - priceInfo
      
      com.broadleafcommerce.pricing.client.domain.PriceInfo priceInfo
      
      Summary of the pricing information related to the choice. The consumer of this service is expecting this to be the source of truth for the pricing of this specific choice, so this field should be calculated from its own override price if present or be a copy of the underlying product's or variant's pricing to simplify the consumer's logic.
      
      See Also:
      
      for special pricing considerations
    - 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.
    - 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
    - usingParentPricing
      
      boolean usingParentPricing
      
      Whether the SpecificItemChoice.priceInfo is inherited from the parent ItemChoice. This is usually determined after pricing is hydrated by the PricingProvider.
    - variant
      
      Variant variant
      
      If the SpecificItemChoice.type is DefaultSpecificItemChoiceType.VARIANT this holds the variant for this choice
    - variantPricing
      
      Map<String,SpecificItemChoiceVariantPricingOverride> variantPricing
      
      Pricing overrides if specific variants of the main product this item belongs to are added to the cart. This can be used in a case like a Warranty where the price of the Warranty depends on the price of the item (Variant) selected.
- Class com.broadleafcommerce.catalogbrowse.domain.SpecificItemChoiceVariantPricingOverride 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.
    - priceInfo
      
      com.broadleafcommerce.pricing.client.domain.PriceInfo priceInfo
      
      Summary of the pricing information for this pricing override. This is more detailed than SpecificItemChoiceVariantPricingOverride.overridePrice since it includes the price type and potentially other prices or cost.
    - 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.
    - variantId
      
      String variantId
      
      ID of the variant this pricing should be used with.
- Class com.broadleafcommerce.catalogbrowse.domain.TypeAheadResponse 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.
    - suggestions
      
      Map<String,List<Map<String,Object>>> suggestions
      
      A map of suggestions, with the key being the name of the origin of the suggestion. For example, it may be manufacturer, name, title, etc.
- Class com.broadleafcommerce.catalogbrowse.domain.Variant 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.
    - defaultPrice
      
      javax.money.MonetaryAmount defaultPrice
      
      The default price that should be used if there is not a Variant.salePrice set. If this price is not set, product's price would be used.
    - id
      
      String id
      
      The unique identifier for this variant.
    - 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.
    - priceInfo
      
      com.broadleafcommerce.pricing.client.domain.PriceInfo priceInfo
      
      Summary of the pricing information related to the 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 higher
    - sku
      
      String sku
      
      Sku code for this particular variant. Overrides the main Product Sku that is set, if any
    - 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.catalogbrowse.domain.context
- Class com.broadleafcommerce.catalogbrowse.domain.context.CustomerContext extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - accountId
      
      String accountId
      
      The id for the account that is in the current context.
    - customerId
      
      String customerId
      
      The id for the customer that is in the current context.
    - customerSegmentIds
      
      Set<String> customerSegmentIds
      
      The list of ids that correspond to customer segments that this customer is a part of.
Package com.broadleafcommerce.catalogbrowse.domain.marketing
- Class com.broadleafcommerce.catalogbrowse.domain.marketing.LineItemDTO extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - attributes
      
      Map<String,Object> attributes
      
      All additional attributes associated with the line item
    - quantity
      
      int quantity
      
      The quantity that this line item represents
    - salePrice
      
      javax.money.MonetaryAmount salePrice
      
      Any sale price associated with the line item
    - standardPrice
      
      javax.money.MonetaryAmount standardPrice
      
      The base price of the line item
- Class com.broadleafcommerce.catalogbrowse.domain.marketing.MarketingMessage extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - displayHint
      
      String displayHint
      
      Any display hint needed by the front-end
    - id
      
      String id
    - priority
      
      Integer priority
      
      The message's priority
    - text
      
      String text
      
      The message's text to display to the customer
- Class com.broadleafcommerce.catalogbrowse.domain.marketing.MarketingMessageRequest extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - appliedOfferIds
      
      List<String> appliedOfferIds
      
      A list of currently applied offer ids
    - cartProductIds
      
      List<String> cartProductIds
      
      The ids of any products currently in the customer's cart
    - cartSubtotal
      
      javax.money.MonetaryAmount cartSubtotal
      
      The subtotal of the customer's cart
    - categoryId
      
      String categoryId
      
      The current category's id
    - contextInfo
      
      com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo
      
      The ContextInfo derived from the original request containing tenant and sandbox info.
    - customerContext
      
      CustomerContext customerContext
      
      The customer context information that should be used in determining which offers apply
    - lineItems
      
      List<LineItemDTO> lineItems
      
      A list of hydrated LineItemDTOs used by the ExternalOfferProvider to retrieve MarketingMessages
    - maxMessageCount
      
      Integer maxMessageCount
      
      The maximum number of messages for each location and location / product combination
    - productIds
      
      List<String> productIds
      
      The ids for all products to retrieve marketing messages for
- Class com.broadleafcommerce.catalogbrowse.domain.marketing.MarketingMessageResponse extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - browseItemMessages
      
      Map<String,List<MarketingMessage>> browseItemMessages
      
      Messages that should be displayed on individual product items shown during browse
    - browseMessages
      
      List<MarketingMessage> browseMessages
      
      Messages that should be displayed on the product list page headers
    - cartItemMessages
      
      Map<String,List<MarketingMessage>> cartItemMessages
      
      Messages that should be displayed on individual cart items
    - cartMessages
      
      List<MarketingMessage> cartMessages
      
      Messages that should be displayed on the cart page's header
    - productDetailMessages
      
      Map<String,List<MarketingMessage>> productDetailMessages
      
      Messages that should be displayed on product detail pages
Package com.broadleafcommerce.catalogbrowse.exception
- Class com.broadleafcommerce.catalogbrowse.exception.DataDrivenEnumDetailsRequestException extends RuntimeException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.broadleafcommerce.catalogbrowse.exception.ProviderApiException extends RuntimeException implements Serializable
  - Serialized Fields
    - receivedException
      
      org.springframework.web.reactive.function.client.WebClientResponseException receivedException
      
      The received error.

Serialized Form

Package com.broadleafcommerce.catalogbrowse.domain

Class com.broadleafcommerce.catalogbrowse.domain.AdvancedTag extends Object implements Serializable

Serialized Fields

attributes

id

name

position

priority

type

Class com.broadleafcommerce.catalogbrowse.domain.Asset extends Object implements Serializable

Serialized Fields

attributes

primary

tags

Class com.broadleafcommerce.catalogbrowse.domain.BrowseDetailsRequest extends Object implements Serializable

Serialized Fields

contextInfo

parameters

priceContext

priceInfoContext

Class com.broadleafcommerce.catalogbrowse.domain.BrowseEntityDetails extends Object implements Serializable

Serialized Fields

category

products

urisForMissingEntities

Class com.broadleafcommerce.catalogbrowse.domain.CatalogSearchRequest extends Object implements Serializable

Serialized Fields

contextInfo

parameters

priceContext

priceInfoContext

Class com.broadleafcommerce.catalogbrowse.domain.CatalogTypeAheadRequest extends Object implements Serializable

Serialized Fields

contextInfo

parameters

priceContext

priceInfoContext

Class com.broadleafcommerce.catalogbrowse.domain.Category extends Object implements Serializable

Serialized Fields

attributes

id

products

Class com.broadleafcommerce.catalogbrowse.domain.CategoryDetailsRequest extends Object implements Serializable

Serialized Fields

contextInfo

parameters

priceContext

priceInfoContext

Class com.broadleafcommerce.catalogbrowse.domain.DataDrivenEnum extends Object implements Serializable

Serialized Fields

associatedCategoryExists

displayValue

id

type

value

Class com.broadleafcommerce.catalogbrowse.domain.DataDrivenEnumDetailsRequest extends Object implements Serializable

Serialized Fields

attributes

checkIfAssociatedCategoryExist

contextInfo

dataDrivenEnumIds

Class com.broadleafcommerce.catalogbrowse.domain.DataDrivenEnumList extends Object implements Serializable

Serialized Fields

dataDrivenEnumIdsForMissingEntities

dataDrivenEnums

Class com.broadleafcommerce.catalogbrowse.domain.IncludedProduct extends Object implements Serializable

Serialized Fields

attributes

overridePrice

priceInfo

pricingKey

product

quantity

type

variant

Class com.broadleafcommerce.catalogbrowse.domain.ItemChoice extends Object implements Serializable

Serialized Fields

attributes

category