commercetools Java SDK

commercetools Composable Commerce Java SDK.

Pages about the SDK

First steps

1. Installation
   • Modules
   • Gradle
   • Maven
   • Troubleshooting
   • Spring Framework
2. Getting Started
   • Instantiation
   • Performing requests
   • Example
   • Closing the client
3. Supported Endpoints
   • Project API
   • Import API
   • Audit log API
4. Configuration
   • ApiRoot and ProjectApiRoot
   • Custom URLs
   • Custom HTTP client
   • Error handling
   • Unwrap exceptions
   • Not found
5. Authentication
   • Client credentials flow
   • Static token
   • Anonymous and RefreshToken flow
   • Standalone anonymous session flow
   • Password flow
   • Introspection
   • Token revocation
6. Querying
   • Predicates
   • Query Predicate Builder
   • Basic Usage
   • Examples of Query Predicates
   • Get by id/key
   • Query all
   • Sorting
   • Pagination
7. Middlewares
   • ErrorMiddleware
   • OAuthMiddleware
   • PolicyMiddleware
   • ConcurrentModificationMiddleware
   • UserAgentMiddleware
   • AcceptGZipMiddleware
   • InternalLoggerMiddleware
8. GraphQL
   • GraphQL module

Products and ProductTypes

1. Product attributes
   • ProductType Creation
   • Product Creation
   • Reading Attributes
   • Update attribute values of a product
   • Create attributes for importing orders

Subscriptions

1. Subscriptions
   • Delivery Payloads
   • Message Payloads
   • Change Payloads

Preparing for the worst

1. Exception documentation
   • Errors
   • Custom HttpExceptionFactory
2. Logging
   • Logger configuration
   • Log Information
   • Error
   • Info
   • Debug
   • Trace
   • Logger hierarchy
   • Usage of Mapped Diagnostic Context

Customization

1. Serialization
   • Customization
   • Date and time attributes
   • Number attributes
   • Deserialize Attributes as JsonNode
2. Client Tuning
   • Blocking execution
   • PolicyMiddleware
   • Configure the underlying http client
   • Limit concurrent requests
   • Timeouts
   • HTTP protocol version
3. Optimizing package size
   • Using split packages

Other

1. General concepts
   • ApiHttpClient
   • ApiRoot & ProjectApiRoot
   • ApiMethod
   • Models
2. Data representation
   • Interfaces
   • Polymorphic types
   • Builder
   • Object property
   • Array property
   • Polymorphic types
   • Implementation
3. Features
   • Embracing Java 8
   • Request builders
   • Good defaults for equals() and hashCode()
   • Client interfaces
   • Model factory methods
   • Middlewares
4. Using
   • Models and Builders
   • Request DSL

Migration from SDK v1

1. Overview
2. Compatibility JVM SDK (v1)
   • Creating a SphereClient with the v2 SDK
   • Using Requests from the JVM SDK (v1)
3. Model class mapping SDK v1 to v2

Monitoring

1. NewRelic
2. Datadog
3. OpenTelemetryMiddleware

Package	Description
com.commercetools.api
com.commercetools.api.client
com.commercetools.api.client.error
com.commercetools.api.defaultconfig
com.commercetools.api.json
com.commercetools.api.models
com.commercetools.api.models.api_client
com.commercetools.api.models.approval_flow
com.commercetools.api.models.approval_rule
com.commercetools.api.models.associate_role
com.commercetools.api.models.attribute_group
com.commercetools.api.models.business_unit
com.commercetools.api.models.business_unit_search
com.commercetools.api.models.cart
com.commercetools.api.models.cart_discount
com.commercetools.api.models.category
com.commercetools.api.models.channel
com.commercetools.api.models.common
com.commercetools.api.models.custom_object
com.commercetools.api.models.customer
com.commercetools.api.models.customer_group
com.commercetools.api.models.customer_search
com.commercetools.api.models.discount_code
com.commercetools.api.models.discount_group
com.commercetools.api.models.error
com.commercetools.api.models.event
com.commercetools.api.models.extension
com.commercetools.api.models.graph_ql
com.commercetools.api.models.inventory
com.commercetools.api.models.me
com.commercetools.api.models.message
com.commercetools.api.models.order
com.commercetools.api.models.order_edit
com.commercetools.api.models.payment
com.commercetools.api.models.payment_method
com.commercetools.api.models.product
com.commercetools.api.models.product_discount
com.commercetools.api.models.product_search
com.commercetools.api.models.product_selection
com.commercetools.api.models.product_tailoring
com.commercetools.api.models.product_type
com.commercetools.api.models.project
com.commercetools.api.models.quote
com.commercetools.api.models.quote_request
com.commercetools.api.models.recurrence_policy
com.commercetools.api.models.recurring_order
com.commercetools.api.models.review
com.commercetools.api.models.search
com.commercetools.api.models.shipping_method
com.commercetools.api.models.shopping_list
com.commercetools.api.models.staged_quote
com.commercetools.api.models.standalone_price
com.commercetools.api.models.state
com.commercetools.api.models.store
com.commercetools.api.models.store_country
com.commercetools.api.models.subscription
com.commercetools.api.models.tax_category
com.commercetools.api.models.type
com.commercetools.api.models.warning
com.commercetools.api.models.zone
com.commercetools.api.predicates
com.commercetools.api.predicates.expansion
com.commercetools.api.predicates.expansion.approval_flow
com.commercetools.api.predicates.expansion.approval_rule
com.commercetools.api.predicates.expansion.associate_role
com.commercetools.api.predicates.expansion.attribute_group
com.commercetools.api.predicates.expansion.business_unit
com.commercetools.api.predicates.expansion.cart
com.commercetools.api.predicates.expansion.cart_discount
com.commercetools.api.predicates.expansion.category
com.commercetools.api.predicates.expansion.channel
com.commercetools.api.predicates.expansion.common
com.commercetools.api.predicates.expansion.custom_object
com.commercetools.api.predicates.expansion.customer
com.commercetools.api.predicates.expansion.customer_group
com.commercetools.api.predicates.expansion.discount_code
com.commercetools.api.predicates.expansion.discount_group
com.commercetools.api.predicates.expansion.extension
com.commercetools.api.predicates.expansion.inventory
com.commercetools.api.predicates.expansion.me
com.commercetools.api.predicates.expansion.message
com.commercetools.api.predicates.expansion.order
com.commercetools.api.predicates.expansion.order_edit
com.commercetools.api.predicates.expansion.payment
com.commercetools.api.predicates.expansion.payment_method
com.commercetools.api.predicates.expansion.product
com.commercetools.api.predicates.expansion.product_discount
com.commercetools.api.predicates.expansion.product_selection
com.commercetools.api.predicates.expansion.product_tailoring
com.commercetools.api.predicates.expansion.product_type
com.commercetools.api.predicates.expansion.quote
com.commercetools.api.predicates.expansion.quote_request
com.commercetools.api.predicates.expansion.recurrence_policy
com.commercetools.api.predicates.expansion.recurring_order
com.commercetools.api.predicates.expansion.review
com.commercetools.api.predicates.expansion.shipping_method
com.commercetools.api.predicates.expansion.shopping_list
com.commercetools.api.predicates.expansion.staged_quote
com.commercetools.api.predicates.expansion.standalone_price
com.commercetools.api.predicates.expansion.state
com.commercetools.api.predicates.expansion.store
com.commercetools.api.predicates.expansion.subscription
com.commercetools.api.predicates.expansion.tax_category
com.commercetools.api.predicates.expansion.type
com.commercetools.api.predicates.expansion.zone
com.commercetools.api.predicates.query
com.commercetools.api.predicates.query.product
com.commercetools.api.predicates.query.type
com.commercetools.api.product
com.commercetools.api.search.products
com.commercetools.compat
com.commercetools.docs.meta
com.commercetools.graphql.api
com.commercetools.history.client
com.commercetools.history.defaultconfig
com.commercetools.history.models.cart_discount
com.commercetools.history.models.change
com.commercetools.history.models.change_history
com.commercetools.history.models.change_value
com.commercetools.history.models.common
com.commercetools.history.models.error
com.commercetools.history.models.graph_ql
com.commercetools.history.models.label
com.commercetools.http.apachehttp
com.commercetools.http.asynchttp
com.commercetools.http.javanet
com.commercetools.http.netty
com.commercetools.http.okhttp3
com.commercetools.http.okhttp4
com.commercetools.importapi.client
com.commercetools.importapi.defaultconfig
com.commercetools.importapi.json
com.commercetools.importapi.models.business_units
com.commercetools.importapi.models.categories
com.commercetools.importapi.models.common
com.commercetools.importapi.models.customers
com.commercetools.importapi.models.customfields
com.commercetools.importapi.models.discount_codes
com.commercetools.importapi.models.errors
com.commercetools.importapi.models.importcontainers
com.commercetools.importapi.models.importoperations
com.commercetools.importapi.models.importrequests
com.commercetools.importapi.models.importsummaries
com.commercetools.importapi.models.inventories
com.commercetools.importapi.models.order_patches
com.commercetools.importapi.models.orders
com.commercetools.importapi.models.prices
com.commercetools.importapi.models.product_selections
com.commercetools.importapi.models.productdrafts
com.commercetools.importapi.models.products
com.commercetools.importapi.models.producttypes
com.commercetools.importapi.models.productvariants
com.commercetools.importapi.models.standalone_prices
com.commercetools.importapi.models.types
com.commercetools.money
com.commercetools.monitoring.datadog
com.commercetools.monitoring.datadog.statsd
com.commercetools.monitoring.newrelic
com.commercetools.monitoring.opentelemetry
io.sphere.sdk.client
io.vrap.rmf.base.client
io.vrap.rmf.base.client.error
io.vrap.rmf.base.client.http
io.vrap.rmf.base.client.oauth2
io.vrap.rmf.base.client.utils
io.vrap.rmf.base.client.utils.json
io.vrap.rmf.base.client.utils.json.modules
io.vrap.rmf.base.client.utils.json.modules.deserializers
io.vrap.rmf.base.client.utils.json.modules.serializers