Skip navigation links

commercetools JVM SDK 2.0.0 API

commercetools platform JVM SDK.

See: Description

Packages 
Package Description
io.sphere.sdk.annotations  
io.sphere.sdk.annotations.processors  
io.sphere.sdk.annotations.processors.generators  
io.sphere.sdk.annotations.processors.models  
io.sphere.sdk.annotations.processors.validators  
io.sphere.sdk.apiclient  
io.sphere.sdk.apiclient.commands  
io.sphere.sdk.apiclient.expansion  
io.sphere.sdk.apiclient.queries  
io.sphere.sdk.cartdiscounts
Provides model classes and builders for cart discounts.
io.sphere.sdk.cartdiscounts.commands
Provides types to change the state of cart discounts.
io.sphere.sdk.cartdiscounts.commands.updateactions
Provides the possible operations which can be performed on update commands for cart discounts.
io.sphere.sdk.cartdiscounts.expansion
Provides reference expansion models for cart discounts.
io.sphere.sdk.cartdiscounts.queries
Provides types to retrieve the state of cart discounts.
io.sphere.sdk.carts
Provides model classes and builders for carts.
io.sphere.sdk.carts.commands
Provides types to change the state of carts.
io.sphere.sdk.carts.commands.updateactions
Provides the possible operations which can be performed on update commands for carts.
io.sphere.sdk.carts.expansion
Provides reference expansion models for carts.
io.sphere.sdk.carts.queries
Provides types to retrieve the state of carts.
io.sphere.sdk.categories
Provides model types to organize products in a hierarchical structure.
io.sphere.sdk.categories.commands
Provides types to change the state of categories.
io.sphere.sdk.categories.commands.updateactions
Provides the possible operations which can be performed on update commands for categories.
io.sphere.sdk.categories.expansion
Provides reference expansion models for categories.
io.sphere.sdk.categories.messages  
io.sphere.sdk.categories.queries
Provides types to retrieve the state of categories.
io.sphere.sdk.channels
Provides model classes and builders for channels.
io.sphere.sdk.channels.commands
Provides types to change the state of channels.
io.sphere.sdk.channels.commands.updateactions
Provides the possible operations which can be performed on update commands for channels.
io.sphere.sdk.channels.expansion
Provides reference expansion models for channels.
io.sphere.sdk.channels.queries
Provides types to retrieve the state of channels.
io.sphere.sdk.client
Provides types to connect to the platform via HTTPS.
io.sphere.sdk.client.correlationid  
io.sphere.sdk.client.metrics
Provides classes to collect metrics about a SphereClient.
io.sphere.sdk.client.retry  
io.sphere.sdk.commands
This package provide tools to change objects in the platform.
io.sphere.sdk.customergroups
Provides model classes and builders for customer groups.
io.sphere.sdk.customergroups.commands
Provides types to change the state of customer groups.
io.sphere.sdk.customergroups.commands.updateactions
Provides the possible operations which can be performed on update commands for customer groups.
io.sphere.sdk.customergroups.expansion
Provides reference expansion models for customer groups.
io.sphere.sdk.customergroups.queries
Provides types to retrieve the state of customer groups.
io.sphere.sdk.customers
Provides model classes and builders for customers.
io.sphere.sdk.customers.commands
Provides types to change the state of customers.
io.sphere.sdk.customers.commands.updateactions
Provides the possible operations which can be performed on update commands for customers.
io.sphere.sdk.customers.errors
Errors related to Customer operations.
io.sphere.sdk.customers.expansion
Provides reference expansion models for customers.
io.sphere.sdk.customers.messages  
io.sphere.sdk.customers.queries
Provides types to retrieve the state of customers.
io.sphere.sdk.customobjects
Provides model classes and builders for custom objects.
io.sphere.sdk.customobjects.commands
Provides types to change the state of custom objects.
io.sphere.sdk.customobjects.expansion
Provides reference expansion models for custom objects.
io.sphere.sdk.customobjects.queries
Provides types to retrieve the state of custom objects.
io.sphere.sdk.discountcodes
Provides model classes and builders for discount codes.
io.sphere.sdk.discountcodes.commands
Provides types to change the state of discount codes.
io.sphere.sdk.discountcodes.commands.updateactions
Provides the possible operations which can be performed on update commands for discount codes.
io.sphere.sdk.discountcodes.expansion
Provides reference expansion models for discount codes.
io.sphere.sdk.discountcodes.queries
Provides types to retrieve the state of discount codes.
io.sphere.sdk.expansion
Provides classes to describe reference expansion paths and their models.
io.sphere.sdk.extensions  
io.sphere.sdk.extensions.commands  
io.sphere.sdk.extensions.commands.updateactions
Provides the possible operations which can be performed on update commands for extensions.
io.sphere.sdk.extensions.errors  
io.sphere.sdk.extensions.expansion  
io.sphere.sdk.extensions.queries  
io.sphere.sdk.http
Provides types to deal with HTTP.
io.sphere.sdk.inventory
Provides model classes and builders for inventory entries.
io.sphere.sdk.inventory.commands
Provides types to change the state of inventory entries.
io.sphere.sdk.inventory.commands.updateactions
Provides the possible operations which can be performed on update commands for inventory entries.
io.sphere.sdk.inventory.expansion
Provides reference expansion models for inventory entries.
io.sphere.sdk.inventory.messages  
io.sphere.sdk.inventory.queries
Provides types to retrieve the state of inventory entries.
io.sphere.sdk.json
Provides utils the JSON mapping from and to the platform.
io.sphere.sdk.jsonnodes.expansion
Provides reference expansion models for json nodes.
io.sphere.sdk.jsonnodes.queries
Provides types to retrieve the state of json nodes.
io.sphere.sdk.messages
Provides model classes and builders for messages.
io.sphere.sdk.messages.expansion
Provides reference expansion models for messages.
io.sphere.sdk.messages.queries
Provides types to retrieve the state of messages.
io.sphere.sdk.meta
Serves as documentation pages about the SDK itself, classes should not be in the classpath.
io.sphere.sdk.models
Provides the common API types of the platform.
io.sphere.sdk.models.errors
Provides base classes for errors related to the commercetools platform.
io.sphere.sdk.orderedits  
io.sphere.sdk.orderedits.commands  
io.sphere.sdk.orderedits.commands.stagedactions  
io.sphere.sdk.orderedits.commands.updateactions  
io.sphere.sdk.orderedits.expansion
Provides reference expansion models for orderedits.
io.sphere.sdk.orderedits.queries  
io.sphere.sdk.orders
Provides model classes and builders for orders.
io.sphere.sdk.orders.commands
Provides types to change the state of orders.
io.sphere.sdk.orders.commands.updateactions
Provides the possible operations which can be performed on update commands for orders.
io.sphere.sdk.orders.errors
Errors related to Order operations.
io.sphere.sdk.orders.expansion
Provides reference expansion models for orders.
io.sphere.sdk.orders.messages
Provides model classes and builders for orders.
io.sphere.sdk.orders.queries
Provides types to retrieve the state of orders.
io.sphere.sdk.payments
Provides model classes and builders for payments.
io.sphere.sdk.payments.commands
Provides types to change the state of payments.
io.sphere.sdk.payments.commands.updateactions
Provides the possible operations which can be performed on update commands for payments.
io.sphere.sdk.payments.expansion
Provides reference expansion models for payments.
io.sphere.sdk.payments.messages
Provides model classes and builders for payments.
io.sphere.sdk.payments.queries
Provides types to retrieve the state of payments.
io.sphere.sdk.productdiscounts
Provides model classes and builders for product discounts.
io.sphere.sdk.productdiscounts.commands
Provides types to change the state of product discounts.
io.sphere.sdk.productdiscounts.commands.updateactions
Provides the possible operations which can be performed on update commands for product discounts.
io.sphere.sdk.productdiscounts.errors  
io.sphere.sdk.productdiscounts.expansion
Provides reference expansion models for product discounts.
io.sphere.sdk.productdiscounts.queries
Provides types to retrieve the state of product discounts.
io.sphere.sdk.products
Provides model classes and builders for products.
io.sphere.sdk.products.attributes
Provides model classes for product type attributes.
io.sphere.sdk.products.commands
Provides types to change the state of products.
io.sphere.sdk.products.commands.updateactions
Provides the possible operations which can be performed on update commands for products.
io.sphere.sdk.products.errors  
io.sphere.sdk.products.expansion
Provides reference expansion models for products.
io.sphere.sdk.products.messages
Provides model classes and builders for products.
io.sphere.sdk.products.queries
Provides types to retrieve the state of products.
io.sphere.sdk.products.search
Endpoint related classes to search products.
io.sphere.sdk.producttypes
Provides model classes and builders for product types.
io.sphere.sdk.producttypes.commands
Provides types to change the state of product types.
io.sphere.sdk.producttypes.commands.updateactions
Provides the possible operations which can be performed on update commands for product types.
io.sphere.sdk.producttypes.errors  
io.sphere.sdk.producttypes.expansion
Provides reference expansion models for product types.
io.sphere.sdk.producttypes.queries
Provides types to retrieve the state of product types.
io.sphere.sdk.projects
Provides models for the project endpoint.
io.sphere.sdk.projects.commands  
io.sphere.sdk.projects.commands.updateactions  
io.sphere.sdk.projects.error  
io.sphere.sdk.projects.queries
Provides the project endpoint.
io.sphere.sdk.queries
Provides types to prepare and receive queries.
io.sphere.sdk.retry  
io.sphere.sdk.reviews
Provides model classes and builders for reviews.
io.sphere.sdk.reviews.commands
Provides types to change the state of reviews.
io.sphere.sdk.reviews.commands.updateactions
Provides the possible operations which can be performed on update commands for reviews.
io.sphere.sdk.reviews.expansion
Provides reference expansion models for reviews.
io.sphere.sdk.reviews.messages
Provides model classes and builders for reviews.
io.sphere.sdk.reviews.queries
Provides types to retrieve the state of reviews.
io.sphere.sdk.reviews.search
Provides model classes and builders for reviews.
io.sphere.sdk.search
Provides types to perform searches.
io.sphere.sdk.search.model
Models to support using search endpoints.
io.sphere.sdk.search.tokenizer
Provides Tokenizers for the search endpoint.
io.sphere.sdk.selection  
io.sphere.sdk.sequencegenerators  
io.sphere.sdk.shippingmethods
Provides model classes and builders for shipping methods.
io.sphere.sdk.shippingmethods.commands
Provides types to change the state of shipping methods.
io.sphere.sdk.shippingmethods.commands.updateactions
Provides the possible operations which can be performed on update commands for shipping methods.
io.sphere.sdk.shippingmethods.errors  
io.sphere.sdk.shippingmethods.expansion
Provides reference expansion models for shipping methods.
io.sphere.sdk.shippingmethods.queries
Provides types to retrieve the state of shipping methods.
io.sphere.sdk.shoppinglists
Provides model classes and builders for shopping lists.
io.sphere.sdk.shoppinglists.commands
Provides types to change the state of shopping list methods.
io.sphere.sdk.shoppinglists.commands.updateactions
Provides the possible operations which can be performed on update commands for shopping list methods.
io.sphere.sdk.shoppinglists.expansion
Provides reference expansion models for shopping lists.
io.sphere.sdk.shoppinglists.queries
Provides types to retrieve the state of shopping lists.
io.sphere.sdk.states
Provides model classes and builders for states.
io.sphere.sdk.states.commands
Provides types to change the state of states.
io.sphere.sdk.states.commands.updateactions
Provides the possible operations which can be performed on update commands for states.
io.sphere.sdk.states.expansion
Provides reference expansion models for states.
io.sphere.sdk.states.queries
Provides types to retrieve the state of states.
io.sphere.sdk.states.relatedupdateactions
Provides model classes and builders for states.
io.sphere.sdk.stores  
io.sphere.sdk.stores.commands  
io.sphere.sdk.stores.commands.updateactions  
io.sphere.sdk.stores.error  
io.sphere.sdk.stores.expansion
Provides reference expansion models for stores.
io.sphere.sdk.stores.queries  
io.sphere.sdk.subscriptions
Subscriptions are used to trigger an asynchronous background process in response to an event on the commercetools platform.
io.sphere.sdk.subscriptions.commands
Provides types to change the state of subscription methods.
io.sphere.sdk.subscriptions.commands.updateactions
Provides the possible operations which can be performed on update commands for subscription methods.
io.sphere.sdk.subscriptions.expansion
Provides reference expansion models for subscriptions.
io.sphere.sdk.subscriptions.queries  
io.sphere.sdk.taxcategories
Provides model classes and builders for tax categories.
io.sphere.sdk.taxcategories.commands
Provides types to change the state of tax categories.
io.sphere.sdk.taxcategories.commands.updateactions
Provides the possible operations which can be performed on update commands for tax categories.
io.sphere.sdk.taxcategories.expansion
Provides reference expansion models for tax categories.
io.sphere.sdk.taxcategories.queries
Provides types to retrieve the state of tax categories.
io.sphere.sdk.types
Provides model classes and builders for types.
io.sphere.sdk.types.commands
Provides types to change the state of types.
io.sphere.sdk.types.commands.updateactions
Provides the possible operations which can be performed on update commands for types.
io.sphere.sdk.types.customupdateactions
Provides update actions to update fields of resources implementing Custom.
io.sphere.sdk.types.expansion
Provides reference expansion models for types.
io.sphere.sdk.types.queries
Provides types to retrieve the state of types.
io.sphere.sdk.utils
Provides utilities for miscellaneous things.
io.sphere.sdk.zones
Provides model classes and builders for zones.
io.sphere.sdk.zones.commands
Provides types to change the state of zones.
io.sphere.sdk.zones.commands.updateactions
Provides the possible operations which can be performed on update commands for zones.
io.sphere.sdk.zones.expansion
Provides reference expansion models for zones.
io.sphere.sdk.zones.queries
Provides types to retrieve the state of zones.
javax.money.spi  
commercetools platform JVM SDK.

Pages about the SDK

First steps

  1. Getting Started
  2. supported endpoints
  3. Query API
    1. Creating queries
    2. Predicates
    3. Sorting
    4. Pagination
    5. Pagination for large offsets
  4. Reference Expansion
    1. Introduction
    2. Guarantees
    3. Use Expansion Models
    4. Expansion Path by String
  5. Release Notes

Products, Categories and ProductTypes

  1. Search API
    1. Full Text Search
    2. Pagination
    3. Sorting
    4. Faceting
    5. Filtering
    6. Product Projection Search Model
  2. product attributes
    1. Introduction
    2. ProductType Creation
    3. Product Creation
    4. Reading Attributes
    5. Creating a table of attributes
    6. Update attribute values of a product
    7. Create attribute stubs for unit tests
    8. Create attributes for importing orders
    9. Semantics of the Attribute classes
    10. Nested attributes (experimental)
  3. categories
    1. Introduction
    2. ProductType Creation
    3. Product Creation
    4. Reading Attributes
    5. Creating a table of attributes
    6. Update attribute values of a product
    7. Create attribute stubs for unit tests
    8. Create attributes for importing orders
    9. Semantics of the Attribute classes
    10. Nested attributes (experimental)
  4. tips to render money and date
    1. Temporal Data
      1. Formatting
    2. Monetary Data
      1. Creating MonetaryAmount values
      2. Formatting MonetaryAmount values
      3. Obtain the cent amounts
      4. Obtain the smooth amount
      5. Sorting MonetaryAmount values
      6. Rounding MonetaryAmount values

Preparing for the worst

  1. Exception Documentation
    1. Exception Hierarchy (UML)
    2. Exceptions
    3. Errors
  2. Logging
    1. Logger hierarchy
    2. Remove the chatty output of the Ning HTTP client
  3. Troubleshooting
    1. Mixed dependencies
    2. JSON Jackson Initialization Problems
    3. Incompatible Ning Async Http Client Versions
    4. Ning Async Http Client is flooding the logs
    5. How to provide a reproduceable support question
    6. Product not found

More about the client

  1. Async Execution
    1. Why asynchronous
    2. Mixing synchronous and asynchronous computations
    3. Functional Composition
    4. Callbacks
    5. Creation and filling
    6. Blocking Access and Immediate Access
    7. Java Functions
    8. Threads and the Trinity
    9. Error Handling
    10. Working with multiple futures
    11. Traps
    12. Advanced Examples
    13. Summary
    14. Further Topics
    15. Further read and sources
  2. Tuning the client
    1. Blocking Client
    2. Timeout Client
    3. Limit the amount of parallel requests
    4. Using design patterns to add functionality to the clients
    5. Configure the underlying http client.
  3. Writing unit tests with the client
    1. Client test doubles for unit tests
    2. Detailed example for creating test doubles

Other

  1. Custom Objects
  2. Custom Types (custom fields)
  3. Construction of Objects
    1. Static 'of' method
    2. Builders
    3. Copy methods
    4. Persistent objects vs. local test doubles
  4. Features of the SDK
  5. Documentation Guidelines
  6. Contributor Documentation
  7. GraphQL Example
  8. OSGi Support
Skip navigation links