Package | Description |
---|---|
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.carts |
Provides model classes and builders for carts.
|
io.sphere.sdk.carts.commands |
Provides types to change 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.messages | |
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.commands |
This package provide tools to change objects in Composable Commerce.
|
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.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.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.commands |
Provides types to change the state of discount codes.
|
io.sphere.sdk.extensions | |
io.sphere.sdk.extensions.commands | |
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.messages | |
io.sphere.sdk.messages |
Provides model classes and builders for messages.
|
io.sphere.sdk.models |
Provides the common API types of Composable Commerce.
|
io.sphere.sdk.orderedits | |
io.sphere.sdk.orderedits.commands | |
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.messages |
Provides model classes and builders for 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.messages |
Provides model classes and builders for 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.products |
Provides model classes and builders for products.
|
io.sphere.sdk.products.commands |
Provides types to change the state of products.
|
io.sphere.sdk.products.messages |
Provides model classes and builders for products.
|
io.sphere.sdk.productselections |
Provides model classes and builders for product selections.
|
io.sphere.sdk.productselections.commands |
Provides types to change the state of product selection.
|
io.sphere.sdk.productselections.messages | |
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.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.messages |
Provides model classes and builders for reviews.
|
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.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.states |
Provides model classes and builders for states.
|
io.sphere.sdk.states.commands |
Provides types to change the state of states.
|
io.sphere.sdk.stores | |
io.sphere.sdk.stores.commands | |
io.sphere.sdk.stores.messages | |
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.commands |
Provides types to change the state of subscription methods.
|
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.types |
Provides model classes and builders for types.
|
io.sphere.sdk.types.commands |
Provides types to change the state of types.
|
io.sphere.sdk.zones |
Provides model classes and builders for zones.
|
io.sphere.sdk.zones.commands |
Provides types to change the state of zones.
|
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 CartDiscountDeleteCommand |
CartDiscountDeleteCommand.of(Versioned<CartDiscount> versioned)
Creates a command object to delete a
CartDiscount by ID. |
static CartDiscountUpdateCommand |
CartDiscountUpdateCommand.of(Versioned<CartDiscount> versioned,
List<? extends UpdateAction<CartDiscount>> updateActions)
Creates a command to update a CartDiscount selected by its ID using several update actions.
|
static CartDiscountUpdateCommand |
CartDiscountUpdateCommand.of(Versioned<CartDiscount> versioned,
UpdateAction<CartDiscount> updateAction,
UpdateAction<CartDiscount>... updateActions)
Creates a command to update a CartDiscount selected by its ID using one update action.
|
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 CartInStoreDeleteCommand |
CartInStoreDeleteCommand.of(String storeKey,
Versioned<Cart> versioned) |
static CartInStoreDeleteCommand |
CartInStoreDeleteCommand.of(String storeKey,
Versioned<Cart> versioned,
boolean eraseData) |
static CartInStoreUpdateCommand |
CartInStoreUpdateCommand.of(String storeKey,
Versioned<Cart> versioned,
List<? extends UpdateAction<Cart>> updateActions) |
static CartInStoreUpdateCommand |
CartInStoreUpdateCommand.of(String storeKey,
Versioned<Cart> versioned,
UpdateAction<Cart> updateAction,
UpdateAction<Cart>... updateActions) |
static CartDeleteCommand |
CartDeleteCommand.of(Versioned<Cart> versioned)
Creates a command object to delete a
Cart by ID. |
static CartDeleteCommand |
CartDeleteCommand.of(Versioned<Cart> versioned,
boolean eraseData)
Creates a command object to delete a
Cart by ID. |
static CartUpdateCommand |
CartUpdateCommand.of(Versioned<Cart> versioned,
List<? extends UpdateAction<Cart>> updateActions)
Creates a command to update a Cart selected by its ID using several update actions.
|
static CartUpdateCommand |
CartUpdateCommand.of(Versioned<Cart> versioned,
UpdateAction<Cart> updateAction,
UpdateAction<Cart>... updateActions)
Creates a command to update a Cart selected by its ID using one update action.
|
Modifier and Type | Interface and Description |
---|---|
interface |
Category
Categories are used to organize products in a hierarchical structure.
|
Modifier and Type | Method and Description |
---|---|
static CategoryDeleteCommand |
CategoryDeleteCommand.of(Versioned<Category> versioned)
Creates a command object to delete a
Category by ID. |
static CategoryUpdateCommand |
CategoryUpdateCommand.of(Versioned<Category> versioned,
List<? extends UpdateAction<Category>> updateActions)
Creates a command to update a Category selected by its ID using several update actions.
|
static CategoryUpdateCommand |
CategoryUpdateCommand.of(Versioned<Category> versioned,
UpdateAction<Category> updateAction,
UpdateAction<Category>... updateActions)
Creates a command to update a Category selected by its ID using one update action.
|
Modifier and Type | Class and Description |
---|---|
class |
CategoryCreatedMessage |
class |
CategorySlugChangedMessage |
Modifier and Type | Interface and Description |
---|---|
interface |
Channel
Channels represent a source or destination of different entities.
|
Modifier and Type | Method and Description |
---|---|
static ChannelDeleteCommand |
ChannelDeleteCommand.of(Versioned<Channel> versioned)
Creates a command object to delete a
Channel by ID. |
static ChannelUpdateCommand |
ChannelUpdateCommand.of(Versioned<Channel> versioned,
List<? extends UpdateAction<Channel>> updateActions)
Creates a command to update a Channel selected by its ID using several update actions.
|
static ChannelUpdateCommand |
ChannelUpdateCommand.of(Versioned<Channel> versioned,
UpdateAction<Channel> updateAction,
UpdateAction<Channel>... updateActions)
Creates a command to update a Channel selected by its ID using one update action.
|
Modifier and Type | Method and Description |
---|---|
Versioned<T> |
MetaModelUpdateCommandDslImpl.getVersioned() |
Modifier and Type | Method and Description |
---|---|
MetaModelUpdateCommandDslBuilder<T,C,E> |
MetaModelUpdateCommandDslBuilder.versioned(Versioned<T> versioned) |
C |
MetaModelUpdateCommandDslImpl.withVersion(Versioned<T> newVersioned) |
C |
UpdateCommandDsl.withVersion(Versioned<T> versioned)
Creates a copy of this update command with a different value for version.
|
Constructor and Description |
---|
MetaModelByIdDeleteCommandImpl(Versioned<T> versioned,
boolean eraseData,
com.fasterxml.jackson.databind.JavaType javaType,
String endpoint,
E expansionModel,
List<ExpansionPath<T>> expansionPaths,
Function<MetaModelByIdDeleteCommandBuilder<T,C,E>,C> creationFunction) |
MetaModelByIdDeleteCommandImpl(Versioned<T> versioned,
boolean eraseData,
JsonEndpoint<T> endpoint,
E expansionModel,
Function<MetaModelByIdDeleteCommandBuilder<T,C,E>,C> creationFunction) |
MetaModelByIdDeleteCommandImpl(Versioned<T> versioned,
JsonEndpoint<T> endpoint,
E expansionModel,
Function<MetaModelByIdDeleteCommandBuilder<T,C,E>,C> creationFunction) |
MetaModelUpdateCommandDslImpl(Versioned<T> versioned,
List<? extends UpdateAction<T>> updateActions,
JsonEndpoint<T> endpoint,
Function<MetaModelUpdateCommandDslBuilder<T,C,E>,C> creationFunction,
E expansionModel) |
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 CustomerGroupDeleteCommand |
CustomerGroupDeleteCommand.of(Versioned<CustomerGroup> versioned)
Creates a command object to delete a
CustomerGroup by ID. |
static CustomerGroupUpdateCommand |
CustomerGroupUpdateCommand.of(Versioned<CustomerGroup> versioned,
List<? extends UpdateAction<CustomerGroup>> updateActions)
Creates a command to update a CustomerGroup selected by its ID using several update actions.
|
static CustomerGroupUpdateCommand |
CustomerGroupUpdateCommand.of(Versioned<CustomerGroup> versioned,
UpdateAction<CustomerGroup> updateAction,
UpdateAction<CustomerGroup>... updateActions)
Creates a command to update a CustomerGroup selected by its ID using one update action.
|
Modifier and Type | Interface and Description |
---|---|
interface |
Customer
A customer is a person purchasing products.
|
Modifier and Type | Method and Description |
---|---|
static CustomerInStoreDeleteCommand |
CustomerInStoreDeleteCommand.of(String storeKey,
Versioned<Customer> versioned) |
static CustomerInStoreDeleteCommand |
CustomerInStoreDeleteCommand.of(String storeKey,
Versioned<Customer> versioned,
boolean eraseData) |
static CustomerDeleteCommand |
CustomerDeleteCommand.of(Versioned<Customer> versioned)
Creates a command object to delete a
Customer by ID. |
static CustomerDeleteCommand |
CustomerDeleteCommand.of(Versioned<Customer> versioned,
boolean eraseData)
Creates a command object to delete a
Customer by ID. |
static CustomerVerifyEmailCommand |
CustomerVerifyEmailCommand.of(Versioned<Customer> customer,
CustomerToken customerToken)
|
static CustomerPasswordResetCommand |
CustomerPasswordResetCommand.of(Versioned<Customer> customer,
CustomerToken token,
String newPassword)
Deprecated.
|
static CustomerUpdateCommand |
CustomerUpdateCommand.of(Versioned<Customer> versioned,
List<? extends UpdateAction<Customer>> updateActions)
Creates a command to update a Customer selected by its ID using several update actions.
|
static CustomerVerifyEmailCommand |
CustomerVerifyEmailCommand.of(Versioned<Customer> customer,
String tokenValue)
|
static CustomerInStoreUpdateCommand |
CustomerInStoreUpdateCommand.of(Versioned<Customer> versioned,
String storeKey,
List<? extends UpdateAction<Customer>> updateActions) |
static CustomerPasswordResetCommand |
CustomerPasswordResetCommand.of(Versioned<Customer> customer,
String tokenValue,
String newPassword)
Deprecated.
|
static CustomerChangePasswordCommand |
CustomerChangePasswordCommand.of(Versioned<Customer> customer,
String currentPassword,
String newPassword) |
static CustomerInStoreChangePasswordCommand |
CustomerInStoreChangePasswordCommand.of(Versioned<Customer> customer,
String storeKey,
String currentPassword,
String newPassword) |
static CustomerInStoreUpdateCommand |
CustomerInStoreUpdateCommand.of(Versioned<Customer> versioned,
String storeKey,
UpdateAction<Customer> updateAction,
UpdateAction<Customer>... updateActions) |
static CustomerUpdateCommand |
CustomerUpdateCommand.of(Versioned<Customer> versioned,
UpdateAction<Customer> updateAction,
UpdateAction<Customer>... updateActions)
Creates a command to update a Customer selected by its ID using one update action.
|
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 | 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 DiscountCodeDeleteCommand |
DiscountCodeDeleteCommand.of(Versioned<DiscountCode> versioned)
Creates a command object to delete a
DiscountCode by ID. |
static DiscountCodeDeleteCommand |
DiscountCodeDeleteCommand.of(Versioned<DiscountCode> versioned,
boolean eraseData)
Creates a command object to delete a
DiscountCode by ID. |
static DiscountCodeUpdateCommand |
DiscountCodeUpdateCommand.of(Versioned<DiscountCode> versioned,
List<? extends UpdateAction<DiscountCode>> updateActions)
Creates a command to update a DiscountCode selected by its ID using several update actions.
|
static DiscountCodeUpdateCommand |
DiscountCodeUpdateCommand.of(Versioned<DiscountCode> versioned,
UpdateAction<DiscountCode> updateAction,
UpdateAction<DiscountCode>... updateActions)
Creates a command to update a DiscountCode selected by its ID using one update action.
|
Modifier and Type | Interface and Description |
---|---|
interface |
Extension |
Modifier and Type | Method and Description |
---|---|
static ExtensionDeleteCommand |
ExtensionDeleteCommand.of(Versioned<Extension> versioned)
Creates a command object to delete a
Extension by ID. |
static ExtensionUpdateCommand |
ExtensionUpdateCommand.of(Versioned<Extension> versioned,
List<? extends UpdateAction<Extension>> updateActions)
Creates a command to update a Extension selected by its ID using several update actions.
|
static ExtensionUpdateCommand |
ExtensionUpdateCommand.of(Versioned<Extension> versioned,
UpdateAction<Extension> updateAction,
UpdateAction<Extension>... updateActions)
Creates a command to update a Extension selected by its ID using one update action.
|
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 | Method and Description |
---|---|
static InventoryEntryDeleteCommand |
InventoryEntryDeleteCommand.of(Versioned<InventoryEntry> versioned)
Creates a command object to delete a
InventoryEntry by ID. |
static InventoryEntryUpdateCommand |
InventoryEntryUpdateCommand.of(Versioned<InventoryEntry> versioned,
List<? extends UpdateAction<InventoryEntry>> updateActions)
Creates a command to update a InventoryEntry selected by its ID using several update actions.
|
static InventoryEntryUpdateCommand |
InventoryEntryUpdateCommand.of(Versioned<InventoryEntry> versioned,
UpdateAction<InventoryEntry> updateAction,
UpdateAction<InventoryEntry>... updateActions)
Creates a command to update a InventoryEntry selected by its ID using one update action.
|
Modifier and Type | Class and Description |
---|---|
class |
InventoryEntryCreatedMessage |
class |
InventoryEntryDeletedMessage |
class |
InventoryEntryQuantitySetMessage |
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 | Interface and Description |
---|---|
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.
|
Modifier and Type | Class and Description |
---|---|
class |
ResourceImpl<T extends Identifiable<T>> |
class |
ResourceViewImpl<T,O> |
Modifier and Type | Method and Description |
---|---|
static <T> Versioned<T> |
Versioned.of(String id,
long version) |
static <T> Versioned<T> |
Versioned.of(Versioned<T> versioned)
Creates a versioned that only contains the id and the version.
|
Modifier and Type | Method and Description |
---|---|
static <T> Versioned<T> |
Versioned.of(Versioned<T> versioned)
Creates a versioned that only contains the id and the version.
|
Modifier and Type | Interface and Description |
---|---|
interface |
OrderEdit |
Modifier and Type | Method and Description |
---|---|
static OrderEditDeleteCommand |
OrderEditDeleteCommand.of(Versioned<OrderEdit> versioned)
Creates a command object to delete a
OrderEdit by ID. |
static OrderEditUpdateCommand |
OrderEditUpdateCommand.of(Versioned<OrderEdit> versioned,
List<? extends UpdateAction<OrderEdit>> updateActions)
Creates a command to update a OrderEdit selected by its ID using several update actions.
|
static OrderEditApplyCommand |
OrderEditApplyCommand.of(Versioned<OrderEdit> orderEditVersioned,
Long resourceVersion)
Creates a new instance of
OrderEditApplyCommand |
static OrderEditUpdateCommand |
OrderEditUpdateCommand.of(Versioned<OrderEdit> versioned,
UpdateAction<OrderEdit> updateAction,
UpdateAction<OrderEdit>... updateActions)
Creates a command to update a OrderEdit selected by its ID using one update action.
|
Modifier and Type | Interface and Description |
---|---|
interface |
Order
An order can be created from a cart, usually after a checkout process has been completed.
|
Modifier and Type | Method and Description |
---|---|
static OrderFromCartDraft |
OrderFromCartDraft.of(Versioned<Cart> cart) |
static OrderFromCartDraft |
OrderFromCartDraft.of(Versioned<Cart> cart,
String orderNumber,
PaymentState paymentState) |
Modifier and Type | Method and Description |
---|---|
static OrderFromCartInStoreCreateCommand |
OrderFromCartInStoreCreateCommand.of(String storeKey,
Versioned<Cart> cart) |
static OrderInStoreDeleteByIdCommand |
OrderInStoreDeleteByIdCommand.of(String storeKey,
Versioned<Order> versioned) |
static OrderInStoreDeleteByIdCommand |
OrderInStoreDeleteByIdCommand.of(String storeKey,
Versioned<Order> versioned,
boolean eraseData) |
static OrderInStoreUpdateByOrderNumberCommand |
OrderInStoreUpdateByIdCommand.of(String storeKey,
Versioned<Order> versioned,
List<? extends UpdateAction<Order>> updateActions) |
static OrderInStoreUpdateByOrderNumberCommand |
OrderInStoreUpdateByIdCommand.of(String storeKey,
Versioned<Order> versioned,
UpdateAction<Order> updateAction,
UpdateAction<Order>... updateActions) |
static OrderFromCartCreateCommand |
OrderFromCartCreateCommand.of(Versioned<Cart> cart) |
static OrderDeleteCommand |
OrderDeleteCommand.of(Versioned<Order> versioned)
Creates a command object to delete a
Order by ID. |
static OrderDeleteCommand |
OrderDeleteCommand.of(Versioned<Order> versioned,
boolean eraseData)
Creates a command object to delete a
Order by ID. |
static OrderUpdateCommand |
OrderUpdateCommand.of(Versioned<Order> versioned,
List<? extends UpdateAction<Order>> updateActions)
Creates a command to update a Order selected by its ID using several update actions.
|
static OrderUpdateCommand |
OrderUpdateCommand.of(Versioned<Order> versioned,
UpdateAction<Order> updateAction,
UpdateAction<Order>... updateActions)
Creates a command to update a Order selected by its ID using one update action.
|
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 | 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 | Method and Description |
---|---|
static PaymentDeleteCommand |
PaymentDeleteCommand.of(Versioned<Payment> versioned)
Creates a command object to delete a
Payment by ID. |
static PaymentDeleteCommand |
PaymentDeleteCommand.of(Versioned<Payment> versioned,
boolean eraseData)
Creates a command object to delete a
Payment by ID. |
static PaymentUpdateCommand |
PaymentUpdateCommand.of(Versioned<Payment> versioned,
List<? extends UpdateAction<Payment>> updateActions)
Creates a command to update a Payment selected by its ID using several update actions.
|
static PaymentUpdateCommand |
PaymentUpdateCommand.of(Versioned<Payment> versioned,
UpdateAction<Payment> updateAction,
UpdateAction<Payment>... updateActions)
Creates a command to update a Payment selected by its ID using one update action.
|
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 | Interface and Description |
---|---|
interface |
ProductDiscount
Product discounts are used to change certain product prices.
|
Modifier and Type | Method and Description |
---|---|
static ProductDiscountDeleteCommand |
ProductDiscountDeleteCommand.of(Versioned<ProductDiscount> versioned)
Creates a command object to delete a
ProductDiscount by ID. |
static ProductDiscountUpdateCommand |
ProductDiscountUpdateCommand.of(Versioned<ProductDiscount> versioned,
List<? extends UpdateAction<ProductDiscount>> updateActions)
Creates a command to update a ProductDiscount selected by its ID using several update actions.
|
static ProductDiscountUpdateCommand |
ProductDiscountUpdateCommand.of(Versioned<ProductDiscount> versioned,
UpdateAction<ProductDiscount> updateAction,
UpdateAction<ProductDiscount>... updateActions)
Creates a command to update a ProductDiscount selected by its ID using one update action.
|
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 | Method and Description |
---|---|
static ProductDeleteCommand |
ProductDeleteCommand.of(Versioned<Product> versioned)
Creates a command object to delete a
Product by ID. |
static ProductUpdateCommand |
ProductUpdateCommand.of(Versioned<Product> versioned,
List<? extends UpdateAction<Product>> updateActions) |
static ProductUpdateCommand |
ProductUpdateCommand.of(Versioned<Product> versioned,
UpdateAction<Product> updateAction,
UpdateAction<Product>... updateActions) |
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 | Interface and Description |
---|---|
interface |
ProductSelection |
Modifier and Type | Method and Description |
---|---|
static ProductSelectionDeleteCommand |
ProductSelectionDeleteCommand.of(Versioned<ProductSelection> versioned)
Creates a command object to delete a
ProductSelection by ID. |
static ProductSelectionUpdateCommand |
ProductSelectionUpdateCommand.of(Versioned<ProductSelection> versioned,
List<? extends UpdateAction<ProductSelection>> updateActions)
Creates a command to update a ProductSelection selected by its ID using several update actions.
|
static ProductSelectionUpdateCommand |
ProductSelectionUpdateCommand.of(Versioned<ProductSelection> versioned,
UpdateAction<ProductSelection> updateAction,
UpdateAction<ProductSelection>... updateActions)
Creates a command to update a ProductSelection selected by its ID using one update action.
|
Modifier and Type | Class and Description |
---|---|
class |
ProductSelectionCreatedMessage |
class |
ProductSelectionDeletedMessage |
class |
ProductSelectionProductAddedMessage |
class |
ProductSelectionProductRemovedMessage |
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 ProductTypeDeleteCommand |
ProductTypeDeleteCommand.of(Versioned<ProductType> versioned)
Creates a command object to delete a
ProductType by ID. |
static ProductTypeUpdateCommand |
ProductTypeUpdateCommand.of(Versioned<ProductType> versioned,
List<? extends UpdateAction<ProductType>> updateActions)
Creates a command to update a ProductType selected by its ID using several update actions.
|
static ProductTypeUpdateCommand |
ProductTypeUpdateCommand.of(Versioned<ProductType> versioned,
UpdateAction<ProductType> updateAction,
UpdateAction<ProductType>... updateActions)
Creates a command to update a ProductType selected by its ID using one update action.
|
Modifier and Type | Interface and Description |
---|---|
interface |
Review
Reviews are used to evaluate products and channels.
|
Modifier and Type | Method and Description |
---|---|
static ReviewDeleteCommand |
ReviewDeleteCommand.of(Versioned<Review> versioned)
Creates a command object to delete a
Review by ID. |
static ReviewDeleteCommand |
ReviewDeleteCommand.of(Versioned<Review> versioned,
boolean eraseData)
Creates a command object to delete a
Review by ID. |
static ReviewUpdateCommand |
ReviewUpdateCommand.of(Versioned<Review> versioned,
List<? extends UpdateAction<Review>> updateActions)
Creates a command to update a Review selected by its ID using several update actions.
|
static ReviewUpdateCommand |
ReviewUpdateCommand.of(Versioned<Review> versioned,
UpdateAction<Review> updateAction,
UpdateAction<Review>... updateActions)
Creates a command to update a Review selected by its ID using one update action.
|
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 | 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 ShippingMethodDeleteCommand |
ShippingMethodDeleteCommand.of(Versioned<ShippingMethod> versioned)
Creates a command object to delete a
ShippingMethod by ID. |
static ShippingMethodUpdateCommand |
ShippingMethodUpdateCommand.of(Versioned<ShippingMethod> versioned,
List<? extends UpdateAction<ShippingMethod>> updateActions)
Creates a command to update a ShippingMethod selected by its ID using several update actions.
|
static ShippingMethodUpdateCommand |
ShippingMethodUpdateCommand.of(Versioned<ShippingMethod> versioned,
UpdateAction<ShippingMethod> updateAction,
UpdateAction<ShippingMethod>... updateActions)
Creates a command to update a ShippingMethod selected by its ID using one update action.
|
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 ShoppingListInStoreDeleteCommand |
ShoppingListInStoreDeleteCommand.of(String storeKey,
Versioned<ShoppingList> versioned) |
static ShoppingListInStoreDeleteCommand |
ShoppingListInStoreDeleteCommand.of(String storeKey,
Versioned<ShoppingList> versioned,
boolean eraseData) |
static ShoppingListDeleteCommand |
ShoppingListDeleteCommand.of(Versioned<ShoppingList> versioned)
Creates a command object to delete a
ShoppingList by ID. |
static ShoppingListDeleteCommand |
ShoppingListDeleteCommand.of(Versioned<ShoppingList> versioned,
boolean eraseData)
Creates a command object to delete a
ShoppingList by ID. |
static ShoppingListUpdateCommand |
ShoppingListUpdateCommand.of(Versioned<ShoppingList> versioned,
List<? extends UpdateAction<ShoppingList>> updateActions)
Creates a command to update a ShoppingList selected by its ID using several update actions.
|
static ShoppingListInStoreUpdateCommand |
ShoppingListInStoreUpdateCommand.of(Versioned<ShoppingList> versioned,
String storeKey,
List<? extends UpdateAction<ShoppingList>> updateActions) |
static ShoppingListInStoreUpdateCommand |
ShoppingListInStoreUpdateCommand.of(Versioned<ShoppingList> versioned,
String storeKey,
UpdateAction<ShoppingList> updateAction,
UpdateAction<ShoppingList>... updateActions) |
static ShoppingListUpdateCommand |
ShoppingListUpdateCommand.of(Versioned<ShoppingList> versioned,
UpdateAction<ShoppingList> updateAction,
UpdateAction<ShoppingList>... updateActions)
Creates a command to update a ShoppingList selected by its ID using one update action.
|
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 StateDeleteCommand |
StateDeleteCommand.of(Versioned<State> versioned)
Creates a command object to delete a
State by ID. |
static StateUpdateCommand |
StateUpdateCommand.of(Versioned<State> versioned,
List<? extends UpdateAction<State>> updateActions)
Creates a command to update a State selected by its ID using several update actions.
|
static StateUpdateCommand |
StateUpdateCommand.of(Versioned<State> versioned,
UpdateAction<State> updateAction,
UpdateAction<State>... updateActions)
Creates a command to update a State selected by its ID using one update action.
|
Modifier and Type | Interface and Description |
---|---|
interface |
Store
Stores let you model the context your customers shop in, e.g.
|
Modifier and Type | Method and Description |
---|---|
static StoreDeleteCommand |
StoreDeleteCommand.of(Versioned<Store> versioned)
Creates a command object to delete a
Store by ID. |
static StoreUpdateCommand |
StoreUpdateCommand.of(Versioned<Store> versioned,
List<? extends UpdateAction<Store>> updateActions)
Creates a command to update a Store selected by its ID using several update actions.
|
static StoreUpdateCommand |
StoreUpdateCommand.of(Versioned<Store> versioned,
UpdateAction<Store> updateAction,
UpdateAction<Store>... updateActions)
Creates a command to update a Store selected by its ID using one update action.
|
Modifier and Type | Class and Description |
---|---|
class |
StoreCreatedMessage |
class |
StoreDeletedMessage |
class |
StoreProductSelectionsChangedMessage |
Modifier and Type | Interface and Description |
---|---|
interface |
Subscription |
Modifier and Type | Method and Description |
---|---|
static SubscriptionDeleteCommand |
SubscriptionDeleteCommand.of(Versioned<Subscription> versioned)
Creates a command object to delete a
Subscription by ID. |
static SubscriptionUpdateCommand |
SubscriptionUpdateCommand.of(Versioned<Subscription> versioned,
List<? extends UpdateAction<Subscription>> updateActions)
Creates a command to update a Subscription selected by its ID using several update actions.
|
static SubscriptionUpdateCommand |
SubscriptionUpdateCommand.of(Versioned<Subscription> versioned,
UpdateAction<Subscription> updateAction,
UpdateAction<Subscription>... updateActions)
Creates a command to update a Subscription selected by its ID using one update action.
|
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 TaxCategoryDeleteCommand |
TaxCategoryDeleteCommand.of(Versioned<TaxCategory> versioned)
Creates a command object to delete a
TaxCategory by ID. |
static TaxCategoryUpdateCommand |
TaxCategoryUpdateCommand.of(Versioned<TaxCategory> versioned,
List<? extends UpdateAction<TaxCategory>> updateActions)
Creates a command to update a TaxCategory selected by its ID using several update actions.
|
static TaxCategoryUpdateCommand |
TaxCategoryUpdateCommand.of(Versioned<TaxCategory> versioned,
UpdateAction<TaxCategory> updateAction,
UpdateAction<TaxCategory>... updateActions)
Creates a command to update a TaxCategory selected by its ID using one update action.
|
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 TypeDeleteCommand |
TypeDeleteCommand.of(Versioned<Type> versioned)
Creates a command object to delete a
Type by ID. |
static TypeUpdateCommand |
TypeUpdateCommand.of(Versioned<Type> versioned,
List<? extends UpdateAction<Type>> updateActions)
Creates a command to update a Type selected by its ID using several update actions.
|
static TypeUpdateCommand |
TypeUpdateCommand.of(Versioned<Type> versioned,
UpdateAction<Type> updateAction,
UpdateAction<Type>... updateActions)
Creates a command to update a Type selected by its ID using one update action.
|
Modifier and Type | Interface and Description |
---|---|
interface |
Zone
Zones define Shipping Rates for a set of Locations.
|
Modifier and Type | Method and Description |
---|---|
static ZoneDeleteCommand |
ZoneDeleteCommand.of(Versioned<Zone> versioned)
Creates a command object to delete a
Zone by ID. |
static ZoneUpdateCommand |
ZoneUpdateCommand.of(Versioned<Zone> versioned,
List<? extends UpdateAction<Zone>> updateActions)
Creates a command to update a Zone selected by its ID using several update actions.
|
static ZoneUpdateCommand |
ZoneUpdateCommand.of(Versioned<Zone> versioned,
UpdateAction<Zone> updateAction,
UpdateAction<Zone>... updateActions)
Creates a command to update a Zone selected by its ID using one update action.
|