Package | Description |
---|---|
io.sphere.sdk.apiclient | |
io.sphere.sdk.apiclient.queries | |
io.sphere.sdk.cartdiscounts |
Provides model classes and builders 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.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.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.queries |
Provides types to retrieve the state of channels.
|
io.sphere.sdk.customergroups |
Provides model classes and builders 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.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.discountcodes |
Provides model classes and builders for discount codes.
|
io.sphere.sdk.discountcodes.queries |
Provides types to retrieve the state of discount codes.
|
io.sphere.sdk.extensions | |
io.sphere.sdk.extensions.queries | |
io.sphere.sdk.inventory |
Provides model classes and builders 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.messages |
Provides model classes and builders for messages.
|
io.sphere.sdk.messages.queries |
Provides types to retrieve the state of messages.
|
io.sphere.sdk.models |
Provides the common API types of Composable Commerce.
|
io.sphere.sdk.orderedits | |
io.sphere.sdk.orderedits.queries | |
io.sphere.sdk.orders |
Provides model classes and builders 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.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.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.messages |
Provides model classes and builders for products.
|
io.sphere.sdk.products.queries |
Provides types to retrieve the state of products.
|
io.sphere.sdk.productselections |
Provides model classes and builders for product selections.
|
io.sphere.sdk.productselections.messages | |
io.sphere.sdk.productselections.queries |
Provides types to retrieve the state of product selections.
|
io.sphere.sdk.producttypes |
Provides model classes and builders for product types.
|
io.sphere.sdk.producttypes.queries |
Provides types to retrieve the state of product types.
|
io.sphere.sdk.queries |
Provides types to prepare and receive queries.
|
io.sphere.sdk.reviews |
Provides model classes and builders 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.shippingmethods |
Provides model classes and builders 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.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.queries |
Provides types to retrieve the state of states.
|
io.sphere.sdk.stores | |
io.sphere.sdk.stores.messages | |
io.sphere.sdk.stores.queries | |
io.sphere.sdk.subscriptions |
Subscriptions are used to trigger an asynchronous background process in response to an event on commercetools Composable Commerce.
|
io.sphere.sdk.subscriptions.queries | |
io.sphere.sdk.taxcategories |
Provides model classes and builders 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.queries |
Provides types to retrieve the state of types.
|
io.sphere.sdk.zones |
Provides model classes and builders for zones.
|
io.sphere.sdk.zones.queries |
Provides types to retrieve the state of zones.
|
Modifier and Type | Interface and Description |
---|---|
interface |
ApiClient |
Modifier and Type | Method and Description |
---|---|
static ApiClientByIdGet |
ApiClientByIdGet.of(Identifiable<ApiClient> resource) |
Modifier and Type | Interface and Description |
---|---|
interface |
CartDiscount
Cart discounts are used to change the prices of different elements within a cart like Line Items.
|
Modifier and Type | Method and Description |
---|---|
static CartDiscountByIdGet |
CartDiscountByIdGet.of(Identifiable<CartDiscount> resource) |
Modifier and Type | Interface and Description |
---|---|
interface |
Cart
A shopping cart holds product variants and can be ordered.
|
interface |
CartLike<T>
Interface to collect the common stuff between carts and orders.
|
Modifier and Type | Method and Description |
---|---|
static CartByIdGet |
CartByIdGet.of(Identifiable<Cart> resource) |
static CartByCustomerIdGet |
CartByCustomerIdGet.of(Identifiable<Customer> customer) |
Modifier and Type | Interface and Description |
---|---|
interface |
Category
Categories are used to organize products in a hierarchical structure.
|
Modifier and Type | Method and Description |
---|---|
List<Category> |
CategoryTree.findChildren(Identifiable<Category> category)
return the children for category.
|
Category |
CategoryTree.getRootAncestor(Identifiable<Category> category)
For a given category searches the ancestor that is in root level.
|
Modifier and Type | Method and Description |
---|---|
List<Category> |
CategoryTree.findSiblings(Collection<? extends Identifiable<Category>> categoryIds)
Gets a list containing all categories that share a parent
with at least one of the given categories.
|
CategoryTree |
CategoryTree.getSubtree(Collection<? extends Identifiable<Category>> parentCategories)
Gets the subtree of the given parent categories.
|
Modifier and Type | Class and Description |
---|---|
class |
CategoryCreatedMessage |
class |
CategorySlugChangedMessage |
Modifier and Type | Method and Description |
---|---|
static CategoryByIdGet |
CategoryByIdGet.of(Identifiable<Category> resource) |
Modifier and Type | Interface and Description |
---|---|
interface |
Channel
Channels represent a source or destination of different entities.
|
Modifier and Type | Method and Description |
---|---|
static ChannelByIdGet |
ChannelByIdGet.of(Identifiable<Channel> resource) |
Modifier and Type | Interface and Description |
---|---|
interface |
CustomerGroup
A Customer can be a member of a customer group (e.g.
|
Modifier and Type | Method and Description |
---|---|
static CustomerGroupByIdGet |
CustomerGroupByIdGet.of(Identifiable<CustomerGroup> resource) |
Modifier and Type | Interface and Description |
---|---|
interface |
Customer
A customer is a person purchasing products.
|
Modifier and Type | Method and Description |
---|---|
static CustomerCreateEmailTokenCommand |
CustomerCreateEmailTokenCommand.of(Identifiable<Customer> customer,
Integer timeToLiveInMinutes)
Creates a command object to create a token to verify a customer's email.
|
static CustomerInStoreCreateEmailTokenCommand |
CustomerInStoreCreateEmailTokenCommand.of(String storeKey,
Identifiable<Customer> customer,
Integer timeToLiveInMinutes)
Creates a command object to create a token to verify a customer's email.
|
Modifier and Type | Class and Description |
---|---|
class |
CustomerAddressAddedMessage
This message is the result of the
AddAddress update action. |
class |
CustomerAddressChangedMessage
This message is the result of the
ChangeAddress update action. |
class |
CustomerAddressRemovedMessage
This message is the result of the
RemoveAddress update action. |
class |
CustomerCompanyNameSetMessage
This message is the result of the
SetCompanyName update action. |
class |
CustomerCreatedMessage |
class |
CustomerDateOfBirthSetMessage
This message is the result of the
SetDateOfBirth update action. |
class |
CustomerDeletedMessage |
class |
CustomerEmailChangedMessage
This message is the result of the
ChangeEmail update action. |
class |
CustomerEmailVerifiedMessage
This message is the result of the
CustomerVerifyEmailCommand command. |
class |
CustomerGroupSetMessage
This message is the result of the
SetCustomerGroup update action. |
class |
CustomerPasswordUpdatedMessage
This message is the result of the
CustomerChangePasswordCommand . |
Modifier and Type | Method and Description |
---|---|
static CustomerByIdGet |
CustomerByIdGet.of(Identifiable<Customer> resource) |
Modifier and Type | Interface and Description |
---|---|
interface |
CustomObject<T>
Custom objects are a way to store arbitrary JSON-formatted data in Composable Commerce.
|
Modifier and Type | Interface and Description |
---|---|
interface |
DiscountCode
Discount codes can be added to a cart to enable certain cart discounts.
|
Modifier and Type | Method and Description |
---|---|
static DiscountCodeByIdGet |
DiscountCodeByIdGet.of(Identifiable<DiscountCode> resource) |
Modifier and Type | Interface and Description |
---|---|
interface |
Extension |
Modifier and Type | Method and Description |
---|---|
static ExtensionByIdGet |
ExtensionByIdGet.of(Identifiable<Extension> resource) |
Modifier and Type | Interface and Description |
---|---|
interface |
InventoryEntry
Inventory allows you to track stock quantity per SKU and optionally per supply
Channel . |
Modifier and Type | Class and Description |
---|---|
class |
InventoryEntryCreatedMessage |
class |
InventoryEntryDeletedMessage |
class |
InventoryEntryQuantitySetMessage |
Modifier and Type | Method and Description |
---|---|
static InventoryEntryByIdGet |
InventoryEntryByIdGet.of(Identifiable<InventoryEntry> resource) |
Modifier and Type | Interface and Description |
---|---|
interface |
GenericMessage<T>
Message for a certain Java type.
|
interface |
Message
A message represents a change or an action performed on a resource (like an Order or a Product).
|
Modifier and Type | Class and Description |
---|---|
class |
GenericMessageImpl<R> |
class |
MessageImpl |
Modifier and Type | Method and Description |
---|---|
static MessageByIdGet |
MessageByIdGet.of(Identifiable<Message> resource) |
Modifier and Type | Class and Description |
---|---|
class |
ResourceImpl<T extends Identifiable<T>> |
Modifier and Type | Interface and Description |
---|---|
interface |
Reference<T>
A
Reference is a loose reference to another resource in Composable Commerce. |
interface |
Resource<T>
A default model is a real resource in Composable Commerce which can be referenced and always consists of the fields
id, version, createdAt, lastModifiedAt.
|
interface |
ResourceView<T,O>
A view for a resource always containing the fields
id, version, createdAt, lastModifiedAt.
|
interface |
Versioned<T>
Something that has an ID and a version.
|
Modifier and Type | Class and Description |
---|---|
class |
ResourceImpl<T extends Identifiable<T>> |
class |
ResourceViewImpl<T,O> |
Modifier and Type | Method and Description |
---|---|
static <T extends Identifiable<T>> |
Reference.of(String typeId,
T obj) |
static <T extends Identifiable<T>> |
Reference.ofResourceTypeIdAndObj(String typeId,
T obj) |
Modifier and Type | Interface and Description |
---|---|
interface |
OrderEdit |
Modifier and Type | Method and Description |
---|---|
static OrderEditByIdGet |
OrderEditByIdGet.of(Identifiable<OrderEdit> resource) |
Modifier and Type | Interface and Description |
---|---|
interface |
Delivery
Deliveries are compilations of information on how the articles are being shipped to the customers.
|
interface |
Order
An order can be created from a cart, usually after a checkout process has been completed.
|
Modifier and Type | Interface and Description |
---|---|
interface |
SimpleOrderMessage
Messages for an
Order . |
Modifier and Type | Class and Description |
---|---|
class |
CustomLineItemStateTransitionMessage
This message is the result of the
TransitionCustomLineItemState update action. |
class |
DeliveryAddedMessage
This message is the result of the
AddDelivery update action. |
class |
DeliveryAddressSetMessage
This message is the result of the
SetDeliveryAddress update action. |
class |
DeliveryItemsUpdatedMessage
This message is the result of the
SetDeliveryItems update action. |
class |
DeliveryRemovedMessage
This message is the result of the
RemoveDelivery update action. |
class |
LineItemStateTransitionMessage
This message is the result of the
TransitionLineItemState update action. |
class |
OrderBillingAddressSetMessage
This message may appear if the billing address of an order is changed.
|
class |
OrderCreatedMessage |
class |
OrderCustomerEmailSetMessage
This message may appear if the customer email of an order is changed.
|
class |
OrderCustomerGroupSetMessage |
class |
OrderCustomerSetMessage |
class |
OrderDeletedMessage |
class |
OrderDiscountCodeAddedMessage |
class |
OrderDiscountCodeStateSetMessage |
class |
OrderEditAppliedMessage |
class |
OrderImportedMessage
This message is created when an order is imported.
|
class |
OrderLineItemDistributionChannelSetMessage |
class |
OrderPaymentAddedMessage |
class |
OrderPaymentStateChangedMessage |
class |
OrderReturnShipmentStateChangedMessage |
class |
OrderShipmentStateChangedMessage |
class |
OrderShippingAddressSetMessage
This message may appear if the shipping address of an order is changed.
|
class |
OrderShippingInfoSetMessage |
class |
OrderStateChangedMessage |
class |
OrderStateTransitionMessage
This message is the result of the
TransitionState update action. |
class |
OrderStoreSetMessage |
class |
ParcelAddedToDeliveryMessage
This message is the result of the
AddParcelToDelivery update action. |
class |
ParcelItemsUpdatedMessage
This message is the result of the
SetParcelItems update action. |
class |
ParcelMeasurementsUpdatedMessage
This message is the result of the
SetParcelMeasurements update action. |
class |
ParcelRemovedFromDeliveryMessage
This message is the result of the
RemoveParcelFromDelivery update action. |
class |
ParcelTrackingDataUpdatedMessage
This message is the result of the
SetParcelTrackingData update action. |
class |
ReturnInfoAddedMessage |
class |
ReturnInfoSetMessage |
Modifier and Type | Method and Description |
---|---|
static OrderByIdGet |
OrderByIdGet.of(Identifiable<Order> resource) |
static OrderInStoreByIdGet |
OrderInStoreByIdGet.of(String storeKey,
Identifiable<Order> resource) |
Modifier and Type | Interface and Description |
---|---|
interface |
Payment
Payments hold information about the current state of receiving and/or refunding money, but the process itself is handled by a PSP.
|
Modifier and Type | Class and Description |
---|---|
class |
PaymentCreatedMessage
This message is the result of a
PaymentCreateCommand . |
class |
PaymentInteractionAddedMessage
This message is the result of the
AddInterfaceInteraction update action. |
class |
PaymentStatusInterfaceCodeSetMessage |
class |
PaymentStatusStateTransitionMessage
This message is the result of the
TransitionState update action. |
class |
PaymentTransactionAddedMessage
This message is the result of the
AddTransaction update action. |
class |
PaymentTransactionStateChangedMessage
This message is the result of the
ChangeTransactionState update action. |
Modifier and Type | Method and Description |
---|---|
static PaymentByIdGet |
PaymentByIdGet.of(Identifiable<Payment> resource) |
Modifier and Type | Interface and Description |
---|---|
interface |
ProductDiscount
Product discounts are used to change certain product prices.
|
Modifier and Type | Method and Description |
---|---|
static ProductDiscountByIdGet |
ProductDiscountByIdGet.of(Identifiable<ProductDiscount> resource) |
Modifier and Type | Interface and Description |
---|---|
interface |
Product
A sellable good.
|
interface |
ProductLike<T,O> |
interface |
ProductProjection
A projected representation of a product shows the product with its current or staged data.
|
Modifier and Type | Interface and Description |
---|---|
interface |
SimpleProductMessage
Messages for a
Product . |
Modifier and Type | Class and Description |
---|---|
class |
ProductAddedToCategoryMessage |
class |
ProductCreatedMessage |
class |
ProductDeletedMessage |
class |
ProductImageAddedMessage
This message is the result of the
AddExternalImage update action. |
class |
ProductPriceDiscountsSetMessage |
class |
ProductPriceExternalDiscountSetMessage |
class |
ProductPublishedMessage |
class |
ProductRemovedFromCategoryMessage |
class |
ProductRevertedStagedChangesMessage |
class |
ProductSlugChangedMessage
Message emitted by the
ChangeSlug update action. |
class |
ProductStateTransitionMessage
This message is the result of the
TransitionState update action. |
class |
ProductUnpublishedMessage |
class |
ProductVariantAddedMessage |
class |
ProductVariantDeletedMessage |
Modifier and Type | Method and Description |
---|---|
static ProductByIdGet |
ProductByIdGet.of(Identifiable<Product> product) |
static ProductByIdProductSelectionGet |
ProductByIdProductSelectionGet.of(Identifiable<Product> product) |
static ProductByIdHead |
ProductByIdHead.of(Identifiable<Product> product) |
Modifier and Type | Interface and Description |
---|---|
interface |
ProductSelection |
Modifier and Type | Class and Description |
---|---|
class |
ProductSelectionCreatedMessage |
class |
ProductSelectionDeletedMessage |
class |
ProductSelectionProductAddedMessage |
class |
ProductSelectionProductRemovedMessage |
Modifier and Type | Method and Description |
---|---|
static ProductSelectionByIdProductGet |
ProductSelectionByIdProductGet.of(Identifiable<ProductSelection> productSelection) |
static ProductSelectionByIdGet |
ProductSelectionByIdGet.of(Identifiable<ProductSelection> resource) |
Modifier and Type | Interface and Description |
---|---|
interface |
ProductType
Describes common characteristics, most importantly common custom attributes, of many concrete products.
|
Modifier and Type | Method and Description |
---|---|
static ProductTypeByIdGet |
ProductTypeByIdGet.of(Identifiable<ProductType> resource) |
Modifier and Type | Method and Description |
---|---|
QueryPredicate<T> |
ResourceQueryModelImpl.is(Identifiable<T> identifiable) |
QueryPredicate<T> |
ResourceQueryModel.is(Identifiable<T> identifiable) |
Modifier and Type | Interface and Description |
---|---|
interface |
Review
Reviews are used to evaluate products and channels.
|
Modifier and Type | Class and Description |
---|---|
class |
ReviewCreatedMessage
This message is the result of the create review request.
|
class |
ReviewRatingSetMessage
This message is the result of the
SetRating update action. |
class |
ReviewStateTransitionMessage
This message is the result of the
TransitionState update action. |
Modifier and Type | Method and Description |
---|---|
static ReviewByIdGet |
ReviewByIdGet.of(Identifiable<Review> resource) |
Modifier and Type | Interface and Description |
---|---|
interface |
ShippingMethod
Shipping Methods define where orders can be shipped and what the costs are.
|
Modifier and Type | Method and Description |
---|---|
static ShippingMethodsByOrderEditGet |
ShippingMethodsByOrderEditGet.of(Identifiable<OrderEdit> orderEdit,
com.neovisionaries.i18n.CountryCode countryCode) |
static ShippingMethodsByOrderEditGet |
ShippingMethodsByOrderEditGet.of(Identifiable<OrderEdit> orderEdit,
com.neovisionaries.i18n.CountryCode countryCode,
String state) |
static ShippingMethodByIdGet |
ShippingMethodByIdGet.of(Identifiable<ShippingMethod> resource) |
Modifier and Type | Interface and Description |
---|---|
interface |
ShoppingList
A shopping list holds items which can be added to a cart.
|
Modifier and Type | Method and Description |
---|---|
static ShoppingListByIdGet |
ShoppingListByIdGet.of(Identifiable<ShoppingList> resource) |
Modifier and Type | Interface and Description |
---|---|
interface |
State
A State represents a state of a particular resource (defines a finite state machine).
|
Modifier and Type | Method and Description |
---|---|
static StateByIdGet |
StateByIdGet.of(Identifiable<State> resource) |
Modifier and Type | Interface and Description |
---|---|
interface |
Store
Stores let you model the context your customers shop in, e.g.
|
Modifier and Type | Class and Description |
---|---|
class |
StoreCreatedMessage |
class |
StoreDeletedMessage |
class |
StoreProductSelectionsChangedMessage |
Modifier and Type | Method and Description |
---|---|
static StoreByIdGet |
StoreByIdGet.of(Identifiable<Store> resource) |
Modifier and Type | Interface and Description |
---|---|
interface |
Subscription |
Modifier and Type | Method and Description |
---|---|
static SubscriptionByIdGet |
SubscriptionByIdGet.of(Identifiable<Subscription> resource) |
Modifier and Type | Interface and Description |
---|---|
interface |
TaxCategory
Tax Categories define how products are to be taxed in different countries.
|
Modifier and Type | Method and Description |
---|---|
static TaxCategoryByIdGet |
TaxCategoryByIdGet.of(Identifiable<TaxCategory> resource) |
Modifier and Type | Interface and Description |
---|---|
interface |
Type
Types define custom fields that are used to enhance resources as you need.
|
Modifier and Type | Method and Description |
---|---|
static TypeByIdGet |
TypeByIdGet.of(Identifiable<Type> resource) |
Modifier and Type | Interface and Description |
---|---|
interface |
Zone
Zones define Shipping Rates for a set of Locations.
|
Modifier and Type | Method and Description |
---|---|
static ZoneByIdGet |
ZoneByIdGet.of(Identifiable<Zone> resource) |