close

Filter

Connector for commercetools Manual / Version 2310

Table Of Contents

7. Commerce Adapter Properties

commercetools.api.api-url
Type java.lang.String
Default  
Description

The base URL, with protocol and port (if needed), to access the commercetools API.

commercetools.api.auth-url
Type java.lang.String
Default  
Description

The absolute URL, with protocol and port (if needed), used for authorization at the commercetools system.

commercetools.api.client-id
Type java.lang.String
Default  
Description

The unique identifier of the API client.

commercetools.api.client-secret
Type java.lang.String
Default  
Description

The confidential client secret.

commercetools.api.fail-on-api-deprecation
Type java.lang.Boolean
Default false
Description

Decorate the SphereClient (responsible for all call to the commercetools system) with a DeprecationExceptionSphereClientDecorator in order to throw an exception on usage of deprecated API calls.

commercetools.api.project-key
Type java.lang.String
Default  
Description

The unique key of the commercetools project.

commercetools.api.scopes
Type java.lang.String
Default  
Description

A comma separated list of scopes, the API client should have access to.

commercetools.default-locale
Type java.util.Locale
Default  
Description

The default locale for accessing the commerce system if no locale parameter was passed into request.

commercetools.product-data-version
Type com.coremedia.commerce.adapter.commercetools.config.ProductDataVersion
Default  
Description

The version of the product data. Can be current for published data or staged for preview.

commercetools.search-enable-language-fallback
Type java.lang.Boolean
Default true
Description

True if language of locale shall be used in search requests.

commercetools.search-max-result-size
Type java.lang.Integer
Default 500
Description

Maximum search result size.

commercetools.single-value-search-facets
Type java.util.List<java.lang.String>
Default  
Description

List of facet keys. These facets only support single values to be selected.

cache.capacities
Type java.util.Map<java.lang.String,java.lang.Long>
Default  
Description

Number of cache entries per cache class until cache eviction takes place. The keys must match the cache classes as defined by the cache keys. Please refer to javadoc of com.coremedia.cache.CacheKey.

cache.timeout-seconds
Type java.util.Map<java.lang.String,java.lang.Long>
Default  
Description

TTL in seconds until certain cache entries are invalidated.

entities.circuit-breaker-names
Type java.util.Map<java.lang.String,java.lang.String>
Default  
Description

Mapping of data lookup keys (cache classes) to circuit breaker names. Mapping to 'none' disables circuit breakers for the mapped data lookup keys.

Example: Mapping 'product' to 'products' will use a separate circuit breaker named 'products' for product calls. The new circuit breaker can have its own configuration via 'resilience4j.circuitbreaker.configs.products'. Mapping 'product' to 'none' will disable the circuit breaker for product requests.

entities.default-circuit-breaker-name
Type java.lang.String
Default base
Description

The default breaker name.

entities.disable-circuit-breakers
Type java.lang.Boolean
Default false
Description

Disable circuit breakers and cache failed calls in cache class failed.

entities.exponential-backoff.factor
Type java.lang.Double
Default 1.5
Description

The factor to be applied to the delay to compute the next delay.

entities.exponential-backoff.initial-delay
Type java.time.Duration
Default 2s
Description

The initial delay of the backoff.

entities.message-store.files
Type java.util.Map<java.lang.String,java.lang.Long>
Default  
Description

The number of request/response pairs to cache persistently. The keys must be valid cache classes as configured for the data lookup service, e.g., catalog, catalogs, category, categories, etc.

entities.message-store.root
Type org.springframework.core.io.Resource
Default  
Description

Root resource to persistently store messages. If this property is not set, no messages will be persisted. Configure a value to enable persistent caching of messages.

entities.products.register-parent-dependency
Type java.lang.Boolean
Default true
Description

Controls if a parent dependency is registered for a non-base product so that it is invalidated together with its base product.

entities.recompute-on-invalidation
Type java.lang.Boolean
Default false
Description

Whether to recompute entities proactively on invalidation.

entities.send-invalidations
Type java.lang.Boolean
Default true
Description

Whether or not to propagate invalidations of entities to the clients.

metadata.additional-metadata
Type java.util.Map<java.lang.String,java.lang.String>
Default  
Description

Map of additional metadata.

Can be used as customization hook. All properties starting with "metadata.additional-metadata.*" are transmitted to the generic client on the CMS side.

metadata.custom-attributes-format
Type com.coremedia.commerce.adapter.base.entities.CustomAttributesFormat
Default  
Description

Format of the custom attribute values.

The keys are always plain strings.

Used to identify the deserialization format on the CMS side.

metadata.custom-entity-param-names
Type java.util.Collection<java.lang.String>
Default  
Description

List of parameter names, which values need to be transmitted with every entity request from the CMS side.

metadata.replacement-tokens
Type java.util.Map<java.lang.String,java.lang.String>
Default  
Description

Map of key value pairs.

Used as replacement map for example for link building in the generic client on the CMS side.

metadata.vendor
Type java.lang.String
Default  
Description

Name of the vendor.

Used to identify the connected vendor on the CMS side.

Table 7.1. Commercetools Commerce Adapter related Properties


Search Results

Table Of Contents
warning

Your Internet Explorer is no longer supported.

Please use Mozilla Firefox, Google Chrome, or Microsoft Edge.