Serialized Form

Package com.broadleafcommerce.dataexchange.domain

Class com.broadleafcommerce.dataexchange.domain.AbstractExchangeObject

class AbstractExchangeObject extends AbstractPassthroughProperties implements Serializable

serialVersionUID:

1L

Serialized Fields

correlationId

String correlationId

jsonPath

String jsonPath

newlyCreated

boolean newlyCreated

parentCorrelationId

String parentCorrelationId

Class com.broadleafcommerce.dataexchange.domain.EntityExchangeObject

class EntityExchangeObject extends AbstractExchangeObject implements Serializable

Serialized Fields

customProperties

Map<String,Object> customProperties

Any custom properties from extensions that should just be passed through.

id

String id

The ID of the entity.

Package com.broadleafcommerce.dataexchange.domain.asset

Class com.broadleafcommerce.dataexchange.domain.asset.ExchangeEntityAsset

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

serialVersionUID:

1L

Serialized Fields

correlationId

String correlationId

newlyCreated

boolean newlyCreated

parentCorrelationId

String parentCorrelationId

Package com.broadleafcommerce.dataexchange.domain.catalog.product

Class com.broadleafcommerce.dataexchange.domain.catalog.product.Attribute

class Attribute extends AbstractExchangeObject implements Serializable

serialVersionUID:

1L

Serialized Fields

nameLabel

String nameLabel

translations

List<Translation> translations

value

Object value

Class com.broadleafcommerce.dataexchange.domain.catalog.product.CategoryRef

class CategoryRef extends EntityExchangeObject implements Serializable

serialVersionUID:

1L

Serialized Fields

externalId

String externalId

url

String url

Class com.broadleafcommerce.dataexchange.domain.catalog.product.ComprehensiveProduct

class ComprehensiveProduct extends EntityExchangeObject implements Serializable

serialVersionUID:

1L

Serialized Fields

assets

List<ProductAsset> assets

availableOnline

Boolean availableOnline

brand

DataDrivenEnum brand

businessType

String businessType

description

String description

externalId

String externalId

generateOptions

List<GenerateProductOption> generateOptions

The options to generate for this product.

inventoryType

String inventoryType

merchandisingType

DataDrivenEnum merchandisingType

name

String name

online

Boolean online

prices

List<Prices> prices

Any prices associated with this 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. This is usually a UUID but could be any unique value.

productTags

List<ProductTag> productTags

productType

String productType

searchable

Boolean searchable

sku

String sku

skuInventories

List<SkuInventory> skuInventories

Any inventory records associated with this product.

targetDemographic

DataDrivenEnum targetDemographic

translations

List<Translation> translations

upc

String upc

variants

List<Variant> variants

Class com.broadleafcommerce.dataexchange.domain.catalog.product.DataDrivenEnum

class DataDrivenEnum extends EntityExchangeObject implements Serializable

Serialized Fields

displayValue

String displayValue

id

String id

type

String type

value

String value

Class com.broadleafcommerce.dataexchange.domain.catalog.product.GenerateProductOption

class GenerateProductOption extends AbstractPassthroughProperties implements Serializable

serialVersionUID:

1L

Serialized Fields

generationType

String generationType

preferAddTemplateByReference

boolean preferAddTemplateByReference

productId

String productId

template

GenerateProductOption.TemplateRef template

templateGroup

GenerateProductOption.TemplateRef templateGroup

templateName

String templateName

Class com.broadleafcommerce.dataexchange.domain.catalog.product.GenerateProductOption.TemplateRef

class TemplateRef extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

id

String id

Class com.broadleafcommerce.dataexchange.domain.catalog.product.Prices

class Prices extends AbstractExchangeObject implements Serializable

serialVersionUID:

1L

Serialized Fields

identifier

String identifier

The identifier of the price list that these prices are associated with. May be interpreted differently (or not at all) based on the value of Prices.identifierType.

identifierType

String identifierType

The type of identifier that the price list is associated with. See PriceListIdentifier. If value is not supplied, we

priceData

List<PriceData> priceData

The list of prices associated with this price list.

priceListType

String priceListType

The type of price list that these prices are associated with. See PriceListType. If value not supplied, it is assumed the type is PriceListType.STANDARD

Class com.broadleafcommerce.dataexchange.domain.catalog.product.ProductAsset

class ProductAsset extends ExchangeEntityAsset implements Serializable

serialVersionUID:

1L

Serialized Fields

id

String id

jsonPath

String jsonPath

primary

Boolean primary

productId

String productId

sorted

Boolean sorted

translations

List<Translation> translations

Class com.broadleafcommerce.dataexchange.domain.catalog.product.ProductList

class ProductList extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

errors

List<DataExchangeError> errors

This will be a list of errors. Each error has a path, and the path will be a JSON Path referencing the ProductList.getProducts() list. For example,

• $[0].variants[1]
• $[1].prices[3]
• $[2].assets[2].translations[5]

This allows clients to find the objects in the JSON object graph that is returned by referencing the JSON Path of each error. This list will be set at the end of a batch process, immediately prior to returning this to the client.

products

List<T extends ComprehensiveProduct> products

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

class ProductOption extends EntityExchangeObject implements Serializable

Serialized Fields

addedByReference

boolean addedByReference

displayOrder

Integer displayOrder

label

String label

templateContextId

String templateContextId

Class com.broadleafcommerce.dataexchange.domain.catalog.product.SkuInventory

class SkuInventory extends EntityExchangeObject implements Serializable

serialVersionUID:

1L

Serialized Fields

inventoryLocationContextId

String inventoryLocationContextId

skuRef

SkuRef skuRef

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

class Variant extends EntityExchangeObject implements Serializable

serialVersionUID:

1L

Serialized Fields

externalId

String externalId

name

String name

productId

String productId

productTags

List<ProductTag> productTags

sku

String sku

translations

List<Translation> translations

upc

String upc

Package com.broadleafcommerce.dataexchange.domain.catalog.tag

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

class ProductTag extends EntityExchangeObject implements Serializable

Serialized Fields

product

ProductTag.IdHolder product

tag

AdvancedTag tag

variant

ProductTag.IdHolder variant

Package com.broadleafcommerce.dataexchange.domain.exception

Class com.broadleafcommerce.dataexchange.domain.exception.DataExchangeError

class DataExchangeError extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

error

Object error

Message indicating details about the exception or error. This is typically a string or map, but may be any JSON serializable object.

headers

Map<String,Map<String,Object>> headers

The request/response headers if this error was generated from a service-to-service call. This is not enabled by default and must be enabled via property. See: DataExchangeErrorProperties.setReturnRequestHeaders(boolean) DataExchangeErrorProperties.setReturnResponseHeaders(boolean) WebClientHttpRequestAwareErrorResolver

httpMethod

String httpMethod

The HTTP method type (PUT/PATCH/POST/DELETE) if available.

httpStatus

int httpStatus

HTTP status code associated with this error (typically received from another service-to-service call).

originalError

Throwable originalError

The original error.

path

String path

JSON path to the entity associated with this error.

stackTrace

String stackTrace

The stack trace associated with the error. This is not typically returned to the client, but may be enabled for debugging purposes. See DataExchangeErrorProperties.

type

String type

Indicates the type of the error. May be used to categorize the error for easier handling by the client.

urlPath

String urlPath

The URL path associated with the error if available. (e.g. "/products", "/variants", etc.)

Package com.broadleafcommerce.dataexchange.domain.pricing

Class com.broadleafcommerce.dataexchange.domain.pricing.PriceData

class PriceData extends AbstractPassthroughProperties implements Serializable

serialVersionUID:

1L

Serialized Fields

activeStartDate

Instant activeStartDate

id

String id

price

javax.money.MonetaryAmount price

priceListId

String priceListId

priceListName

String priceListName

target

com.broadleafcommerce.pricing.client.domain.PriceableTargetRef target

Package com.broadleafcommerce.dataexchange.domain.translation

Class com.broadleafcommerce.dataexchange.domain.translation.Translation

class Translation extends AbstractExchangeObject implements Serializable

serialVersionUID:

1L

Serialized Fields

entityField

String entityField

The name of the field that is being translated.

entityId

String entityId

The ID of the owning entity.

entityType

String entityType

The type of the owning entity.

id

String id

locale

Locale locale

The locale for this translation.

value

Object value

This will usually be a String. But since we can translate anything, really, this allows us to accept numbers, collections, etc.

Class com.broadleafcommerce.dataexchange.domain.translation.TranslationsPayload

class TranslationsPayload extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

translations

List<Translation> translations

Package com.broadleafcommerce.dataexchange.exception

Exception com.broadleafcommerce.dataexchange.exception.CorrelationIdException

class CorrelationIdException extends DataExchangeException implements Serializable

Exception com.broadleafcommerce.dataexchange.exception.DataExchangeBadRequestException

class DataExchangeBadRequestException extends RuntimeException implements Serializable

Exception com.broadleafcommerce.dataexchange.exception.DataExchangeException

class DataExchangeException extends RuntimeException implements Serializable

Package com.broadleafcommerce.dataexchange.service.error

Exception com.broadleafcommerce.dataexchange.service.error.DataExchangeGlobalException

class DataExchangeGlobalException extends RuntimeException implements Serializable

Serialized Fields

error

DataExchangeError error

Class com.broadleafcommerce.dataexchange.service.error.DefaultBatchItemErrorHandler.ErrorExchangeObject

class ErrorExchangeObject extends AbstractExchangeObject implements Serializable