Uses of Interface
io.sphere.sdk.client.SphereRequest

Packages that use SphereRequest

Package	Description
io.sphere.sdk.apiclient.commands
io.sphere.sdk.apiclient.queries
io.sphere.sdk.cartdiscounts.commands	Provides types to change the state of cart discounts.
io.sphere.sdk.cartdiscounts.queries	Provides types to retrieve the state of cart discounts.
io.sphere.sdk.carts.commands	Provides types to change the state of carts.
io.sphere.sdk.carts.queries	Provides types to retrieve the state of carts.
io.sphere.sdk.categories.commands	Provides types to change the state of categories.
io.sphere.sdk.categories.queries	Provides types to retrieve the state of categories.
io.sphere.sdk.channels.commands	Provides types to change the state of channels.
io.sphere.sdk.channels.queries	Provides types to retrieve the state of channels.
io.sphere.sdk.client	Provides types to connect to the API via HTTPS.
io.sphere.sdk.client.correlationid
io.sphere.sdk.client.metrics	Provides classes to collect metrics about a SphereClient.
io.sphere.sdk.commands	This package provide tools to change objects in Composable Commerce.
io.sphere.sdk.customergroups.commands	Provides types to change the state of customer groups.
io.sphere.sdk.customergroups.queries	Provides types to retrieve the state of customer groups.
io.sphere.sdk.customers.commands	Provides types to change the state of customers.
io.sphere.sdk.customers.queries	Provides types to retrieve the state of customers.
io.sphere.sdk.customobjects.commands	Provides types to change the state of custom objects.
io.sphere.sdk.customobjects.queries	Provides types to retrieve the state of custom objects.
io.sphere.sdk.discountcodes.commands	Provides types to change the state of discount codes.
io.sphere.sdk.discountcodes.queries	Provides types to retrieve the state of discount codes.
io.sphere.sdk.extensions.commands
io.sphere.sdk.extensions.queries
io.sphere.sdk.inventory.commands	Provides types to change the state of inventory entries.
io.sphere.sdk.inventory.queries	Provides types to retrieve the state of inventory entries.
io.sphere.sdk.jsonnodes.queries	Provides types to retrieve the state of json nodes.
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.commands
io.sphere.sdk.orderedits.queries
io.sphere.sdk.orders.commands	Provides types to change the state of orders.
io.sphere.sdk.orders.queries	Provides types to retrieve the state of orders.
io.sphere.sdk.payments.commands	Provides types to change the state of payments.
io.sphere.sdk.payments.queries	Provides types to retrieve the state of payments.
io.sphere.sdk.productdiscounts.commands	Provides types to change the state of product discounts.
io.sphere.sdk.productdiscounts.queries	Provides types to retrieve the state of product discounts.
io.sphere.sdk.products.commands	Provides types to change the state of 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.productselections.commands	Provides types to change the state of product selection.
io.sphere.sdk.productselections.queries	Provides types to retrieve the state of product selections.
io.sphere.sdk.producttypes.commands	Provides types to change the state of product types.
io.sphere.sdk.producttypes.queries	Provides types to retrieve the state of product types.
io.sphere.sdk.projects.commands
io.sphere.sdk.projects.queries	Provides the project endpoint.
io.sphere.sdk.queries	Provides types to prepare and receive queries.
io.sphere.sdk.reviews.commands	Provides types to change the state of reviews.
io.sphere.sdk.reviews.queries	Provides types to retrieve the state of reviews.
io.sphere.sdk.search	Provides types to perform searches.
io.sphere.sdk.shippingmethods.commands	Provides types to change the state of shipping methods.
io.sphere.sdk.shippingmethods.queries	Provides types to retrieve the state of shipping methods.
io.sphere.sdk.shoppinglists.commands	Provides types to change the state of shopping list methods.
io.sphere.sdk.shoppinglists.queries	Provides types to retrieve the state of shopping lists.
io.sphere.sdk.states.commands	Provides types to change the state of states.
io.sphere.sdk.states.queries	Provides types to retrieve the state of states.
io.sphere.sdk.stores.commands
io.sphere.sdk.stores.queries
io.sphere.sdk.subscriptions.commands	Provides types to change the state of subscription methods.
io.sphere.sdk.subscriptions.queries
io.sphere.sdk.taxcategories.commands	Provides types to change the state of tax categories.
io.sphere.sdk.taxcategories.queries	Provides types to retrieve the state of tax categories.
io.sphere.sdk.types.commands	Provides types to change the state of types.
io.sphere.sdk.types.queries	Provides types to retrieve the state of types.
io.sphere.sdk.zones.commands	Provides types to change the state of zones.
io.sphere.sdk.zones.queries	Provides types to retrieve the state of zones.

Uses of SphereRequest in io.sphere.sdk.apiclient.commands

Subinterfaces of SphereRequest in io.sphere.sdk.apiclient.commands

Modifier and Type	Interface and Description
interface	ApiClientCreateCommand Creates an ApiClient
interface	ApiClientDeleteCommand

Uses of SphereRequest in io.sphere.sdk.apiclient.queries

Subinterfaces of SphereRequest in io.sphere.sdk.apiclient.queries

Modifier and Type	Interface and Description
interface	ApiClientByIdGet Retrieves a extension by a known ID.
interface	ApiClientQuery {@doc.gen summary api-clients

Uses of SphereRequest in io.sphere.sdk.cartdiscounts.commands

Subinterfaces of SphereRequest in io.sphere.sdk.cartdiscounts.commands

Modifier and Type	Interface and Description
interface	CartDiscountCreateCommand Command object to create a CartDiscount.
interface	CartDiscountDeleteCommand Deletes a CartDiscount.
interface	CartDiscountUpdateCommand Command object to update a CartDiscount.

Uses of SphereRequest in io.sphere.sdk.cartdiscounts.queries

Subinterfaces of SphereRequest in io.sphere.sdk.cartdiscounts.queries

Modifier and Type	Interface and Description
interface	CartDiscountByIdGet Gets a CartDiscount by a known ID.
interface	CartDiscountByKeyGet Gets a CartDiscount by a known key.
interface	CartDiscountQuery {@doc.gen summary cart discounts

Uses of SphereRequest in io.sphere.sdk.carts.commands

Subinterfaces of SphereRequest in io.sphere.sdk.carts.commands

Modifier and Type	Interface and Description
interface	CartCreateCommand Creates a cart.
interface	CartDeleteCommand Deletes a cart final CartDraft cartDraft = CartDraftBuilder.of(EUR).country(DE).build(); final Cart cart = client().executeBlocking(CartCreateCommand.of(cartDraft)); final String key = randomKey(); final Cart updatedCart = client().executeBlocking(CartUpdateCommand.of(cart, SetKey.of(key))); assertThat(updatedCart.getKey()).isEqualTo(key); client().executeBlocking(CartDeleteCommand.ofKey(key, updatedCart.getVersion())); final PagedQueryResult<Cart> queryResult = client().executeBlocking(CartQuery.of().withPredicates(cartQueryModel -> cartQueryModel.key().is(updatedCart.getKey()))); assertThat(queryResult.getResults()).isEmpty(); See the test code.
interface	CartInStoreCreateCommand
interface	CartInStoreDeleteCommand
interface	CartInStoreUpdateCommand
interface	CartUpdateCommand Updates a cart.

Classes in io.sphere.sdk.carts.commands that implement SphereRequest

Modifier and Type	Class and Description
class	CartInStoreReplicationCommand Creates a new cart based on an existing cart or order.
class	CartReplicationCommand Creates a new cart based on an existing cart or order.

Uses of SphereRequest in io.sphere.sdk.carts.queries

Subinterfaces of SphereRequest in io.sphere.sdk.carts.queries

Modifier and Type	Interface and Description
interface	CartByCustomerIdGet Gets a cart by the customer id.
interface	CartByIdGet Gets a cart by ID.
interface	CartByKeyGet Gets a cart by Key.
interface	CartInStoreByCustomerIdGet
interface	CartInStoreByIdGet
interface	CartInStoreByKeyGet
interface	CartInStoreQuery
interface	CartQuery {@doc.gen summary carts

Uses of SphereRequest in io.sphere.sdk.categories.commands

Subinterfaces of SphereRequest in io.sphere.sdk.categories.commands

Modifier and Type	Interface and Description
interface	CategoryCreateCommand Command object to create a Category.
interface	CategoryDeleteCommand Deletes a category.
interface	CategoryUpdateCommand Updates a category.

Uses of SphereRequest in io.sphere.sdk.categories.queries

Subinterfaces of SphereRequest in io.sphere.sdk.categories.queries

Modifier and Type	Interface and Description
interface	CategoryByIdGet Retrieves a category by a known ID.
interface	CategoryByKeyGet Retrieves a category by a known Key.
interface	CategoryQuery {@doc.gen summary categories

Uses of SphereRequest in io.sphere.sdk.channels.commands

Subinterfaces of SphereRequest in io.sphere.sdk.channels.commands

Modifier and Type	Interface and Description
interface	ChannelCreateCommand Creates a channel.
interface	ChannelDeleteCommand Deletes a channel.
interface	ChannelUpdateCommand Updates a channel.

Uses of SphereRequest in io.sphere.sdk.channels.queries

Subinterfaces of SphereRequest in io.sphere.sdk.channels.queries

Modifier and Type	Interface and Description
interface	ChannelByIdGet Fetches a channel by a known ID.
interface	ChannelQuery {@doc.gen summary channels

Uses of SphereRequest in io.sphere.sdk.client

Classes in io.sphere.sdk.client that implement SphereRequest

Modifier and Type	Class and Description
class	JavaAndHttpResponseSphereRequest<T> A wrapper for a SphereRequest to receive the Java object as well as the HttpResponse representation.
class	JavaAndJsonSphereRequest<T> A wrapper for a SphereRequest to receive the Java object as well as the JsonNode representation.
class	JsonNodeSphereRequest A SphereRequest which returns JsonNode instances instead of deserialized Java domain model classes.
class	SphereRequestDecorator<T> Public available base class to decorate the behaviour of SphereRequests.

Fields in io.sphere.sdk.client declared as SphereRequest

Modifier and Type	Field and Description
protected SphereRequest<T>	SphereRequestDecorator.delegate

Methods in io.sphere.sdk.client with parameters of type SphereRequest

Modifier and Type	Method and Description
static <T> T	SphereClientUtils.blockingWait(CompletionStage<T> completionStage, SphereRequest<T> sphereRequest, Duration duration) Waits with a timeout for RESPONSES of a Composable Commerce client wrapped in a CompletionStage.
static <T> T	SphereClientUtils.blockingWait(CompletionStage<T> completionStage, SphereRequest<T> sphereRequest, long timeout, TimeUnit unit) Waits with a timeout for RESPONSES of a Composable Commerce client wrapped in a CompletionStage.
<T> CompletionStage<T>	BlockingSphereClient.execute(SphereRequest<T> sphereRequest)
<T> CompletionStage<T>	DeprecationExceptionSphereClientDecorator.execute(SphereRequest<T> sphereRequest)
<T> CompletionStage<T>	TimeoutSphereClientDecorator.execute(SphereRequest<T> sphereRequest)
<T> CompletionStage<T>	SphereClientDecorator.execute(SphereRequest<T> sphereRequest)
<T> CompletionStage<T>	SphereClient.execute(SphereRequest<T> sphereRequest) Executes asynchronously a request to Composable Commerce.
<T> CompletionStage<T>	QueueSphereClientDecorator.execute(SphereRequest<T> sphereRequest)
<T> T	BlockingSphereClient.executeBlocking(SphereRequest<T> sphereRequest) Executes a request and blocks the caller thread until the response is available or a client specific timeout occurs.
<T> T	BlockingSphereClient.executeBlocking(SphereRequest<T> sphereRequest, Duration duration) Executes a request and blocks the caller thread until the response is available or a request specific timeout occurs.
<T> T	BlockingSphereClient.executeBlocking(SphereRequest<T> sphereRequest, long timeout, TimeUnit unit) Executes a request and blocks the caller thread until the response is available or a request specific timeout occurs.
static <T> JavaAndJsonSphereRequest<T>	JavaAndJsonSphereRequest.of(SphereRequest<T> delegate)
static <T> JavaAndHttpResponseSphereRequest<T>	JavaAndHttpResponseSphereRequest.of(SphereRequest<T> delegate)
static <T> JsonNodeSphereRequest	JsonNodeSphereRequest.of(SphereRequest<T> other)

Constructors in io.sphere.sdk.client with parameters of type SphereRequest

Constructor and Description
SphereRequestDecorator(SphereRequest<T> delegate)

Uses of SphereRequest in io.sphere.sdk.client.correlationid

Classes in io.sphere.sdk.client.correlationid that implement SphereRequest

Modifier and Type	Class and Description
class	CorrelationIdRequestDecorator<T>

Methods in io.sphere.sdk.client.correlationid with parameters of type SphereRequest

Modifier and Type	Method and Description
static <T> CorrelationIdRequestDecorator<T>	CorrelationIdRequestDecorator.of(SphereRequest<T> delegate, String correlationId) Decorates a SphereRequest as delegate.

Uses of SphereRequest in io.sphere.sdk.client.metrics

Methods in io.sphere.sdk.client.metrics that return SphereRequest

Modifier and Type	Method and Description
SphereRequest<?>	ObservedDuration.getRequest() The sphere request related to the observed duration.

Methods in io.sphere.sdk.client.metrics with parameters of type SphereRequest

Modifier and Type	Method and Description
<T> CompletionStage<T>	SimpleMetricsSphereClient.execute(SphereRequest<T> sphereRequest)
static ObservedSerializationDuration	ObservedSerializationDuration.of(long durationInMilliseconds, String requestId, SphereRequest<?> request)
static ObservedDeserializationDuration	ObservedDeserializationDuration.of(long durationInMilliseconds, String sphereRequestId, SphereRequest<?> request, String correlationId)
static ObservedTotalDuration	ObservedTotalDuration.of(long durationInMilliseconds, String sphereRequestId, SphereRequest<?> request, String correlationId)
static ObservedDeserializationDuration	ObservedDeserializationDuration.of(long durationInMilliseconds, String sphereRequestId, SphereRequest<?> request, String correlationId, HttpResponse httpResponse, Object result)
static ObservedTotalDuration	ObservedTotalDuration.of(long durationInMilliseconds, String sphereRequestId, SphereRequest<?> request, String correlationId, Object successResult, Throwable errorResult)

Uses of SphereRequest in io.sphere.sdk.commands

Subinterfaces of SphereRequest in io.sphere.sdk.commands

Modifier and Type	Interface and Description
interface	Command<T> A command represents a request to update the state of Composable Commerce entities.
interface	CreateCommand<T> Command to create a resource in Composable Commerce.
interface	DeleteCommand<T> Command which deletes one or more resources in Composable Commerce.
interface	DraftBasedCreateCommand<T,D> Command to create a resource in Composable Commerce based on a draft object.
interface	DraftBasedCreateCommandDsl<T,D,C> Command to create a resource in Composable Commerce based on a draft object and having a wither to replace the current draft.
interface	UpdateCommand<T> Command which updates a Composable Commerce resource based on a list of update actions.
interface	UpdateCommandDsl<T extends ResourceView<T,T>,C extends UpdateCommandDsl<T,C>> Subinterface for update commands which supports updating the version for retries on ConcurrentModificationExceptions

Classes in io.sphere.sdk.commands that implement SphereRequest

Modifier and Type	Class and Description
class	CommandImpl<T> Base class to implement commands using the Jackson JSON mapper.
class	CreateCommandImpl<T,D> Base class to implement commands which create a resource in Composable Commerce.
class	MetaModelByIdDeleteCommandImpl<T extends ResourceView<T,T>,C,E> Internal base class to implement commands which delete a resource by ID in Composable Commerce.
class	MetaModelCreateCommandImpl<T,C,D,E> Internal base class to implement commands which create a resource in Composable Commerce.
class	MetaModelUpdateCommandDslImpl<T extends ResourceView<T,T>,C extends UpdateCommandDsl<T,C>,E> Internal base class to implement commands that change one resource in Composable Commerce.

Uses of SphereRequest in io.sphere.sdk.customergroups.commands

Subinterfaces of SphereRequest in io.sphere.sdk.customergroups.commands

Modifier and Type	Interface and Description
interface	CustomerGroupCreateCommand Creates a new customer group final String name = "creation demo customer group name"; final CustomerGroup customerGroup = client().executeBlocking(CustomerGroupCreateCommand.of(name)); assertThat(customerGroup.getName()).isEqualTo(name); See the test code.
interface	CustomerGroupDeleteCommand Deletes a customer group.
interface	CustomerGroupUpdateCommand Updates a customer group.

Uses of SphereRequest in io.sphere.sdk.customergroups.queries

Subinterfaces of SphereRequest in io.sphere.sdk.customergroups.queries

Modifier and Type	Interface and Description
interface	CustomerGroupByIdGet Fetches a customer group based on a known ID.
interface	CustomerGroupByKeyGet Fetches a customer group based on a known key.
interface	CustomerGroupQuery {@doc.gen summary customer groups

Uses of SphereRequest in io.sphere.sdk.customers.commands

Subinterfaces of SphereRequest in io.sphere.sdk.customers.commands

Modifier and Type	Interface and Description
interface	CustomerCreateCommand Creates/signs up a customer.
interface	CustomerDeleteCommand Deletes a customer.
interface	CustomerInStoreCreateCommand
interface	CustomerInStoreDeleteCommand
interface	CustomerInStoreUpdateCommand
interface	CustomerUpdateCommand Updates a customer.

Classes in io.sphere.sdk.customers.commands that implement SphereRequest

Modifier and Type	Class and Description
class	CustomerChangePasswordCommand Updates the password of a customer.
class	CustomerCreateEmailTokenCommand Creates a token for verifying the customer's email.
class	CustomerCreatePasswordTokenCommand Creates a token to reset the customer password with CustomerPasswordResetCommand.
class	CustomerInStoreChangePasswordCommand Updates the password of a customer with a store.
class	CustomerInStoreCreateEmailTokenCommand
class	CustomerInStoreCreatePasswordTokenCommand
class	CustomerInStorePasswordResetCommand
class	CustomerInStoreSignInCommand
class	CustomerInStoreVerifyEmailCommand
class	CustomerPasswordResetCommand Sets a new password for the customer.
class	CustomerSignInCommand Retrieves the authenticated customer (a customer that matches the given email/password pair).
class	CustomerVerifyEmailCommand Verifies customer's email using a token.

Uses of SphereRequest in io.sphere.sdk.customers.queries

Subinterfaces of SphereRequest in io.sphere.sdk.customers.queries

Modifier and Type	Interface and Description
interface	CustomerByEmailTokenGet Fetches a customer by a known email token.
interface	CustomerByIdGet Fetches a customer by a known ID.
interface	CustomerByKeyGet Fetches a customer by a known key.
interface	CustomerByPasswordTokenGet Fetches a cusomter by a known password reset token.
interface	CustomerInStoreByEmailTokenGet
interface	CustomerInStoreByIdGet
interface	CustomerInStoreByKeyGet
interface	CustomerInStoreByPasswordTokenGet
interface	CustomerInStoreQuery
interface	CustomerQuery {@doc.gen summary customers

Uses of SphereRequest in io.sphere.sdk.customobjects.commands

Subinterfaces of SphereRequest in io.sphere.sdk.customobjects.commands

Modifier and Type	Interface and Description
interface	CustomObjectDeleteCommand<T> Deletes a custom object in Composable Commerce.
interface	CustomObjectUpsertCommand<T> Command for creating or updating a custom object.

Classes in io.sphere.sdk.customobjects.commands that implement SphereRequest

Modifier and Type	Class and Description
class	CustomObjectCustomJsonMappingUpsertCommand<T> Command for creating or updating a custom object using a custom JSON mapper.

Uses of SphereRequest in io.sphere.sdk.customobjects.queries

Subinterfaces of SphereRequest in io.sphere.sdk.customobjects.queries

Modifier and Type	Interface and Description
interface	CustomObjectByIdGet<T> SphereRequest to fetch one CustomObject by id.
interface	CustomObjectByKeyGet<T> SphereRequest to fetch one CustomObject by container and key.
interface	CustomObjectQuery<T> Queries custom objects.

Classes in io.sphere.sdk.customobjects.queries that implement SphereRequest

Modifier and Type	Class and Description
class	CustomObjectCustomJsonMappingByKeyGet<T> SphereRequest to fetch one CustomObject by container and key but using a custom JSON mapper instead of the SDK default one.

Uses of SphereRequest in io.sphere.sdk.discountcodes.commands

Subinterfaces of SphereRequest in io.sphere.sdk.discountcodes.commands

Modifier and Type	Interface and Description
interface	DiscountCodeCreateCommand Command object to create a DiscountCode.
interface	DiscountCodeDeleteCommand Command object to delete a DiscountCode.
interface	DiscountCodeUpdateCommand Command object to update a DiscountCode.

Uses of SphereRequest in io.sphere.sdk.discountcodes.queries

Subinterfaces of SphereRequest in io.sphere.sdk.discountcodes.queries

Modifier and Type	Interface and Description
interface	DiscountCodeByIdGet
interface	DiscountCodeQuery {@doc.gen summary discount codes

Uses of SphereRequest in io.sphere.sdk.extensions.commands

Subinterfaces of SphereRequest in io.sphere.sdk.extensions.commands

Modifier and Type	Interface and Description
interface	ExtensionCreateCommand Creates an extension
interface	ExtensionDeleteCommand Deletes an extension.
interface	ExtensionUpdateCommand Updates an extension.

Uses of SphereRequest in io.sphere.sdk.extensions.queries

Subinterfaces of SphereRequest in io.sphere.sdk.extensions.queries

Modifier and Type	Interface and Description
interface	ExtensionByIdGet Retrieves a extension by a known ID.
interface	ExtensionByKeyGet Retrieves a extension by a known Key.
interface	ExtensionQuery {@doc.gen summary extensions

Uses of SphereRequest in io.sphere.sdk.inventory.commands

Subinterfaces of SphereRequest in io.sphere.sdk.inventory.commands

Modifier and Type	Interface and Description
interface	InventoryEntryCreateCommand Command object to create a InventoryEntry.
interface	InventoryEntryDeleteCommand Command object to delete a InventoryEntry.
interface	InventoryEntryUpdateCommand Command object to update a InventoryEntry.

Uses of SphereRequest in io.sphere.sdk.inventory.queries

Subinterfaces of SphereRequest in io.sphere.sdk.inventory.queries

Modifier and Type	Interface and Description
interface	InventoryEntryByIdGet
interface	InventoryEntryQuery {@doc.gen summary inventory entries

Uses of SphereRequest in io.sphere.sdk.jsonnodes.queries

Subinterfaces of SphereRequest in io.sphere.sdk.jsonnodes.queries

Modifier and Type	Interface and Description
interface	JsonNodeQuery

Uses of SphereRequest in io.sphere.sdk.messages.queries

Subinterfaces of SphereRequest in io.sphere.sdk.messages.queries

Modifier and Type	Interface and Description
interface	MessageByIdGet withOrderAndReturnInfo(client(), ((order, returnInfo) -> { //query one message since message creation is not directly possible final MessageQuery query = MessageQuery.of() .withPredicates(m -> m.type().is("ReturnInfoAdded")) .withSort(m -> m.createdAt().sort().desc()) .withLimit(1L); assertEventually(Duration.ofSeconds(45), Duration.ofMillis(100), () -> { final Optional<Message> messageOptional = client().executeBlocking(query).head(); assertThat(messageOptional).isPresent(); final Message messageFromQueryEndpoint = messageOptional.get(); final Message message = client().executeBlocking(MessageByIdGet.of(messageFromQueryEndpoint)); assertThat(message).isEqualTo(messageFromQueryEndpoint); }); return order; })); See the test code. If you need to receive one specific message class, like DeliveryAddedMessage, use MessageQuery with a predicate by id.
interface	MessageQuery Provides a QueryDsl for messages to formulate predicates, search expressions and reference expansion path expressions. For further information how to use the query API to consult the Query API documentation. Query for any message

Uses of SphereRequest in io.sphere.sdk.models

Methods in io.sphere.sdk.models that return SphereRequest

Modifier and Type	Method and Description
SphereRequest<?>	SphereException.getSphereRequest()

Methods in io.sphere.sdk.models with parameters of type SphereRequest

Modifier and Type	Method and Description
void	SphereException.setSphereRequest(SphereRequest<?> sphereRequest)

Uses of SphereRequest in io.sphere.sdk.orderedits.commands

Subinterfaces of SphereRequest in io.sphere.sdk.orderedits.commands

Modifier and Type	Interface and Description
interface	OrderEditCreateCommand Command object to create a OrderEdit.
interface	OrderEditDeleteCommand Command object to delete a OrderEdit.
interface	OrderEditUpdateCommand Command object to update a OrderEdit.

Classes in io.sphere.sdk.orderedits.commands that implement SphereRequest

Modifier and Type	Class and Description
class	OrderEditApplyCommand

Uses of SphereRequest in io.sphere.sdk.orderedits.queries

Subinterfaces of SphereRequest in io.sphere.sdk.orderedits.queries

Modifier and Type	Interface and Description
interface	OrderEditByIdGet Gets an order edit by ID.
interface	OrderEditByKeyGet Gets an order edit by key.
interface	OrderEditQuery {@doc.gen summary orderedits

Uses of SphereRequest in io.sphere.sdk.orders.commands

Subinterfaces of SphereRequest in io.sphere.sdk.orders.commands

Modifier and Type	Interface and Description
interface	OrderDeleteCommand Command object to delete a Order.
interface	OrderFromCartCreateCommand Orders a cart.
interface	OrderFromCartInStoreCreateCommand
interface	OrderInStoreDeleteByIdCommand
interface	OrderInStoreDeleteByOrderNumberCommand
interface	OrderInStoreUpdateByIdCommand
interface	OrderInStoreUpdateByOrderNumberCommand
interface	OrderUpdateCommand Command object to update a Order.

Classes in io.sphere.sdk.orders.commands that implement SphereRequest

Modifier and Type	Class and Description
class	OrderImportCommand Orders can also be imported via the Import API endpoint so you don't have to create a cart before.

Uses of SphereRequest in io.sphere.sdk.orders.queries

Subinterfaces of SphereRequest in io.sphere.sdk.orders.queries

Modifier and Type	Interface and Description
interface	OrderByIdGet Gets an order by ID.
interface	OrderByOrderNumberGet Fetches an order by a known order number.
interface	OrderInStoreByIdGet
interface	OrderInStoreByOrderNumberGet
interface	OrderInStoreQuery
interface	OrderQuery {@doc.gen summary orders

Uses of SphereRequest in io.sphere.sdk.payments.commands

Subinterfaces of SphereRequest in io.sphere.sdk.payments.commands

Modifier and Type	Interface and Description
interface	PaymentCreateCommand Command object to create a Payment.
interface	PaymentDeleteCommand Command object to delete a Payment.
interface	PaymentUpdateCommand Updates a payment.

Uses of SphereRequest in io.sphere.sdk.payments.queries

Subinterfaces of SphereRequest in io.sphere.sdk.payments.queries

Modifier and Type	Interface and Description
interface	PaymentByIdGet Retrieves a payment by a known ID.
interface	PaymentByKeyGet Retrieves a payment by a known key.
interface	PaymentQuery {@doc.gen summary payments

Uses of SphereRequest in io.sphere.sdk.productdiscounts.commands

Subinterfaces of SphereRequest in io.sphere.sdk.productdiscounts.commands

Modifier and Type	Interface and Description
interface	ProductDiscountCreateCommand Command object to create a ProductDiscount.
interface	ProductDiscountDeleteCommand Command object to delete a ProductDiscount.
interface	ProductDiscountUpdateCommand Command object to update a ProductDiscount.

Uses of SphereRequest in io.sphere.sdk.productdiscounts.queries

Subinterfaces of SphereRequest in io.sphere.sdk.productdiscounts.queries

Modifier and Type	Interface and Description
interface	ProductDiscountByIdGet
interface	ProductDiscountByKeyGet
interface	ProductDiscountQuery {@doc.gen summary product discounts

Classes in io.sphere.sdk.productdiscounts.queries that implement SphereRequest

Modifier and Type	Class and Description
class	MatchingProductDiscountGet

Uses of SphereRequest in io.sphere.sdk.products.commands

Subinterfaces of SphereRequest in io.sphere.sdk.products.commands

Modifier and Type	Interface and Description
interface	ProductCreateCommand Creates a product.
interface	ProductDeleteCommand Command object to delete a Product.
interface	ProductUpdateCommand Known UpdateActions AddAsset AddAsset AddExternalImage AddExternalImage AddPrice AddPrice AddToCategory AddToCategory AddVariant AddVariant ChangeAssetName ChangeAssetName ChangeAssetOrder ChangeAssetOrder ChangeMasterVariant ChangeMasterVariant ChangeName ChangeName ChangePrice ChangePrice ChangeSlug ChangeSlug LegacySetSku LegacySetSku MetaAttributesUpdateActions MetaAttributesUpdateActions MoveImageToPosition MoveImageToPosition Publish Publish RemoveAsset RemoveAsset RemoveFromCategory RemoveFromCategory RemoveImage RemoveImage RemovePrice RemovePrice RemoveVariant RemoveVariant RevertStagedChanges RevertStagedChanges RevertStagedVariantChanges RevertStagedVariantChanges SetAssetCustomField SetAssetCustomField SetAssetCustomType SetAssetCustomType SetAssetDescription SetAssetDescription SetAssetKey SetAssetKey SetAssetSources SetAssetSources SetAssetTags SetAssetTags SetAttribute SetAttribute SetAttributeInAllVariants SetAttributeInAllVariants SetCategoryOrderHint SetCategoryOrderHint SetDescription SetDescription SetDiscountedPrice SetDiscountedPrice SetImageLabel SetImageLabel SetKey SetKey SetMetaDescription SetMetaDescription SetMetaKeywords SetMetaKeywords SetMetaTitle SetMetaTitle SetPrices SetPrices SetProductPriceCustomField SetProductPriceCustomField SetProductPriceCustomType SetProductPriceCustomType SetProductVariantKey SetProductVariantKey SetSearchKeywords SetSearchKeywords SetSku SetSku SetTaxCategory SetTaxCategory TransitionState TransitionState Unpublish Unpublish

Classes in io.sphere.sdk.products.commands that implement SphereRequest

Modifier and Type	Class and Description
class	ProductImageUploadCommand Uploads an Image for a product.

Uses of SphereRequest in io.sphere.sdk.products.queries

Subinterfaces of SphereRequest in io.sphere.sdk.products.queries

Modifier and Type	Interface and Description
interface	ProductByIdGet
interface	ProductByIdHead
interface	ProductByIdProductSelectionGet
interface	ProductByKeyGet Retrieves a product projection by a known key.
interface	ProductByKeyHead
interface	ProductByKeyProductSelectionGet
interface	ProductProjectionByIdGet
interface	ProductProjectionByKeyGet Retrieves a product projection by a known key.
interface	ProductProjectionInStoreByIdGet
interface	ProductProjectionInStoreByKeyGet
interface	ProductProjectionInStoreQuery
interface	ProductProjectionQuery Provides a QueryDsl for product projections to formulate predicates, search expressions and reference expansion path expressions. For further information how to use the query API to consult the Query API documentation.
interface	ProductQuery Provides a QueryDsl for products to formulate predicates, search expressions and reference expansion path expressions. For further information how to use the query API to consult the Query API documentation.
interface	ProductsHead
interface	SuggestQuery Query search keywords to implement a basic auto-complete functionality.

Uses of SphereRequest in io.sphere.sdk.products.search

Subinterfaces of SphereRequest in io.sphere.sdk.products.search

Modifier and Type	Interface and Description
interface	ProductProjectionSearch Searches for products.

Uses of SphereRequest in io.sphere.sdk.productselections.commands

Subinterfaces of SphereRequest in io.sphere.sdk.productselections.commands

Modifier and Type	Interface and Description
interface	ProductSelectionCreateCommand Command object to create a ProductSelection.
interface	ProductSelectionDeleteCommand Deletes a cart
interface	ProductSelectionUpdateCommand Updates a cart.

Uses of SphereRequest in io.sphere.sdk.productselections.queries

Subinterfaces of SphereRequest in io.sphere.sdk.productselections.queries

Modifier and Type	Interface and Description
interface	ProductSelectionByIdGet Gets a product selection by ID.
interface	ProductSelectionByIdProductGet
interface	ProductSelectionByIdProductsGet
interface	ProductSelectionByKeyGet Gets a product selection by Key.
interface	ProductSelectionByKeyProductGet
interface	ProductSelectionByKeyProductsGet
interface	ProductSelectionQuery {@doc.gen summary product selections

Uses of SphereRequest in io.sphere.sdk.producttypes.commands

Subinterfaces of SphereRequest in io.sphere.sdk.producttypes.commands

Modifier and Type	Interface and Description
interface	ProductTypeCreateCommand Command to create a ProductType in Composable Commerce.
interface	ProductTypeDeleteCommand Deletes a product type.
interface	ProductTypeUpdateCommand Command object to update a ProductType.

Uses of SphereRequest in io.sphere.sdk.producttypes.queries

Subinterfaces of SphereRequest in io.sphere.sdk.producttypes.queries

Modifier and Type	Interface and Description
interface	ProductTypeByIdGet Retrieves a product type by a known ID.
interface	ProductTypeByKeyGet Retrieves a product type by a known key.
interface	ProductTypeQuery {@doc.gen summary product types

Uses of SphereRequest in io.sphere.sdk.projects.commands

Subinterfaces of SphereRequest in io.sphere.sdk.projects.commands

Modifier and Type

Interface and Description

interface

ProjectUpdateCommand Update commands for the Project entity final Project project = client().executeBlocking(ProjectGet.of()); final String new_project_name = "NewName"; final List<String> new_project_currencies = Arrays.asList(USD.getCurrencyCode()); final List<CountryCode> new_project_countries = Arrays.asList(CountryCode.CA); final List<Locale> new_project_locales = Arrays.asList(Locale.FRANCE); final List<String> new_project_languages = new_project_locales.stream().map(Locale::toLanguageTag).collect(Collectors.toList()); final Boolean new_project_messages_enabled = false; final Long delete_days_after_activation = 20L; final URL url = new URL("https://invalid.cmo"); final ExternalOAuth externalOAuth = ExternalOAuth.of("customheader: customValue", url); final ProjectUpdateCommand updateCommand = ProjectUpdateCommand.of(project, Arrays.asList( ChangeName.of(new_project_name), ChangeCurrencies.of(new_project_currencies), ChangeCountries.of(new_project_countries), ChangeLanguages.of(new_project_languages), ChangeMessagesConfiguration.of(MessagesConfigurationDraft.of(new_project_messages_enabled, delete_days_after_activation)), SetShippingRateInputType.ofUnset(), SetExternalOAuth.of(externalOAuth) )); final Project updatedProject = client().executeBlocking(updateCommand); softAssert(soft -> { soft.assertThat(updatedProject.getKey()).isEqualTo(getSphereClientConfig().getProjectKey()); soft.assertThat(updatedProject.getName()).as("name").isEqualTo(new_project_name); soft.assertThat(updatedProject.getCountries()).as("countries").isEqualTo(new_project_countries); soft.assertThat(updatedProject.getLanguages()).as("languages").isEqualTo(new_project_languages); soft.assertThat(updatedProject.getLanguageLocales()).as("languages as locale").isEqualTo(new_project_locales); soft.assertThat(updatedProject.getCreatedAt()).as("createdAt").isNotNull(); soft.assertThat(updatedProject.getCurrencies()).as("currencies").isEqualTo(new_project_currencies); soft.assertThat(updatedProject.getCurrencyUnits()).as("currencies as unit").contains(USD); soft.assertThat(updatedProject.getMessages().isEnabled()).isEqualTo(new_project_messages_enabled); soft.assertThat(updatedProject.getMessages().getDeleteDaysAfterCreation()).isEqualTo(delete_days_after_activation); soft.assertThat(updatedProject.getShippingRateInputType()).isNull(); soft.assertThat(updatedProject.getExternalOAuth()).isEqualToIgnoringGivenFields(externalOAuth,"authorizationHeader"); }); See the test code.

Uses of SphereRequest in io.sphere.sdk.projects.queries

Classes in io.sphere.sdk.projects.queries that implement SphereRequest

Modifier and Type	Class and Description
class	ProjectGet

Methods in io.sphere.sdk.projects.queries that return SphereRequest

Modifier and Type	Method and Description
static SphereRequest<Project>	ProjectGet.of()

Uses of SphereRequest in io.sphere.sdk.queries

Subinterfaces of SphereRequest in io.sphere.sdk.queries

Modifier and Type	Interface and Description
interface	Get<T>
interface	GetDsl<R,T,C>
interface	Head<T>
interface	HeadDsl<R,T,C>
interface	MetaModelGetDsl<R,T,C extends MetaModelGetDsl<R,T,C,E>,E>
interface	MetaModelHeadDsl<R,T,C extends MetaModelHeadDsl<R,T,C>>
interface	MetaModelQueryDsl<T,C extends MetaModelQueryDsl<T,C,Q,E>,Q,E> Internal query request interface for immutable value classes which can copy themselves with modified fields providing a meta model for convenient creation of expressions.
interface	Query<T>
interface	QueryDsl<T,C extends QueryDsl<T,C>> Query request interface for immutable value classes which can copy themselves with modified fields.
interface	ResourceQuery<T> Queries for resources.

Classes in io.sphere.sdk.queries that implement SphereRequest

Modifier and Type	Class and Description
class	MetaModelGetDslImpl<R,T,C extends MetaModelGetDsl<R,T,C,E>,E>
class	MetaModelHeadDslImpl<R,T,C extends MetaModelHeadDsl<R,T,C>>
class	MetaModelQueryDslImpl<T,C extends MetaModelQueryDsl<T,C,Q,E>,Q,E>

Uses of SphereRequest in io.sphere.sdk.reviews.commands

Subinterfaces of SphereRequest in io.sphere.sdk.reviews.commands

Modifier and Type	Interface and Description
interface	ReviewCreateCommand Command object to create a Review.
interface	ReviewDeleteCommand Command object to delete a Review.
interface	ReviewUpdateCommand Updates a review.

Uses of SphereRequest in io.sphere.sdk.reviews.queries

Subinterfaces of SphereRequest in io.sphere.sdk.reviews.queries

Modifier and Type	Interface and Description
interface	ReviewByIdGet Retrieves a review by a known ID.
interface	ReviewByKeyGet
interface	ReviewQuery {@doc.gen summary reviews

Uses of SphereRequest in io.sphere.sdk.search

Subinterfaces of SphereRequest in io.sphere.sdk.search

Modifier and Type	Interface and Description
interface	MetaModelSearchDsl<T,C extends MetaModelSearchDsl<T,C,S,L,F,E>,S,L,F,E>
interface	ResourceSearch<T>
interface	Search<T>
interface	SearchDsl<T,C extends SearchDsl<T,C>>

Classes in io.sphere.sdk.search that implement SphereRequest

Modifier and Type	Class and Description
class	MetaModelSearchDslImpl<T,C extends MetaModelSearchDsl<T,C,S,L,F,E>,S,L,F,E>

Uses of SphereRequest in io.sphere.sdk.shippingmethods.commands

Subinterfaces of SphereRequest in io.sphere.sdk.shippingmethods.commands

Modifier and Type	Interface and Description
interface	ShippingMethodCreateCommand Creates a ShippingMethod.
interface	ShippingMethodDeleteCommand Command object to delete a ShippingMethod.
interface	ShippingMethodUpdateCommand Command object to update a ShippingMethod.

Uses of SphereRequest in io.sphere.sdk.shippingmethods.queries

Subinterfaces of SphereRequest in io.sphere.sdk.shippingmethods.queries

Modifier and Type	Interface and Description
interface	ShippingMethodByIdGet Fetches a shipping method by ID.
interface	ShippingMethodByKeyGet Fetches a shipping method by key.
interface	ShippingMethodQuery {@doc.gen summary shipping methods
interface	ShippingMethodsByCartGet Retrieves all the shipping methods that can ship to the shipping address of the given cart.
interface	ShippingMethodsByLocationGet Retrieves all the shipping methods that can ship to the given location.
interface	ShippingMethodsByOrderEditGet Retrieves all the shipping methods that can ship to the given orderEdit.

Uses of SphereRequest in io.sphere.sdk.shoppinglists.commands

Subinterfaces of SphereRequest in io.sphere.sdk.shoppinglists.commands

Modifier and Type	Interface and Description
interface	ShoppingListCreateCommand Creates a ShoppingList.
interface	ShoppingListDeleteCommand Deletes a shopping list.
interface	ShoppingListInStoreCreateCommand
interface	ShoppingListInStoreDeleteCommand
interface	ShoppingListInStoreUpdateCommand
interface	ShoppingListUpdateCommand Updates a shopping list.

Uses of SphereRequest in io.sphere.sdk.shoppinglists.queries

Subinterfaces of SphereRequest in io.sphere.sdk.shoppinglists.queries

Modifier and Type	Interface and Description
interface	ShoppingListByIdGet Fetches a shopping list by ID.
interface	ShoppingListByKeyGet
interface	ShoppingListInStoreByIdGet
interface	ShoppingListInStoreByKeyGet
interface	ShoppingListInStoreQuery
interface	ShoppingListQuery {@doc.gen summary shopping lists

Uses of SphereRequest in io.sphere.sdk.states.commands

Subinterfaces of SphereRequest in io.sphere.sdk.states.commands

Modifier and Type	Interface and Description
interface	StateCreateCommand Command object to create a State.
interface	StateDeleteCommand Deletes a state.
interface	StateUpdateCommand Updates a state.

Uses of SphereRequest in io.sphere.sdk.states.queries

Subinterfaces of SphereRequest in io.sphere.sdk.states.queries

Modifier and Type	Interface and Description
interface	StateByIdGet
interface	StateByKeyGet Fetches a state by a known key.
interface	StateQuery {@doc.gen summary states

Uses of SphereRequest in io.sphere.sdk.stores.commands

Subinterfaces of SphereRequest in io.sphere.sdk.stores.commands

Modifier and Type	Interface and Description
interface	StoreCreateCommand Command object to create a Store.
interface	StoreDeleteCommand Command object to delete a Store.
interface	StoreUpdateCommand Command object to update a Store.

Uses of SphereRequest in io.sphere.sdk.stores.queries

Subinterfaces of SphereRequest in io.sphere.sdk.stores.queries

Modifier and Type	Interface and Description
interface	StoreByIdGet Gets a store by ID.
interface	StoreByKeyGet Get store by Key StoreFixtures.withStore(client(), store -> { final Store queriedStore = client().executeBlocking(StoreByKeyGet.of(store.getKey())); Assertions.assertThat(queriedStore).isNotNull(); }); See the test code.
interface	StoreQuery {@doc.gen summary stores

Uses of SphereRequest in io.sphere.sdk.subscriptions.commands

Subinterfaces of SphereRequest in io.sphere.sdk.subscriptions.commands

Modifier and Type	Interface and Description
interface	SubscriptionCreateCommand Creates a Subscription.
interface	SubscriptionDeleteCommand Deletes a subscription.
interface	SubscriptionUpdateCommand Updates a subscription.

Uses of SphereRequest in io.sphere.sdk.subscriptions.queries

Subinterfaces of SphereRequest in io.sphere.sdk.subscriptions.queries

Modifier and Type	Interface and Description
interface	SubscriptionByIdGet Fetches a subscription by id.
interface	SubscriptionByKeyGet Fetches a subscription by key.
interface	SubscriptionQuery {@doc.gen summary subscriptions

Uses of SphereRequest in io.sphere.sdk.taxcategories.commands

Subinterfaces of SphereRequest in io.sphere.sdk.taxcategories.commands

Modifier and Type	Interface and Description
interface	TaxCategoryCreateCommand Command object to create a TaxCategory.
interface	TaxCategoryDeleteCommand Deletes a tax category.
interface	TaxCategoryUpdateCommand Command object to update a TaxCategory.

Uses of SphereRequest in io.sphere.sdk.taxcategories.queries

Subinterfaces of SphereRequest in io.sphere.sdk.taxcategories.queries

Modifier and Type	Interface and Description
interface	TaxCategoryByIdGet Fetches a tax category by a known ID.
interface	TaxCategoryByKeyGet Fetches a tax category by a known Key.
interface	TaxCategoryQuery {@doc.gen summary tax categories

Uses of SphereRequest in io.sphere.sdk.types.commands

Subinterfaces of SphereRequest in io.sphere.sdk.types.commands

Modifier and Type	Interface and Description
interface	TypeCreateCommand Command object to create a Type.
interface	TypeDeleteCommand Command object to delete a Type.
interface	TypeUpdateCommand Command object to update a Type.

Uses of SphereRequest in io.sphere.sdk.types.queries

Subinterfaces of SphereRequest in io.sphere.sdk.types.queries

Modifier and Type	Interface and Description
interface	TypeByIdGet
interface	TypeQuery {@doc.gen summary types

Uses of SphereRequest in io.sphere.sdk.zones.commands

Subinterfaces of SphereRequest in io.sphere.sdk.zones.commands

Modifier and Type	Interface and Description
interface	ZoneCreateCommand Command object to create a Zone.
interface	ZoneDeleteCommand Command object to delete a Zone.
interface	ZoneUpdateCommand Updates a zone.

Uses of SphereRequest in io.sphere.sdk.zones.queries

Subinterfaces of SphereRequest in io.sphere.sdk.zones.queries

Modifier and Type	Interface and Description
interface	ZoneByIdGet Gets a zone by ID.
interface	ZoneByKeyGet Get Zone by Key
interface	ZoneQuery {@doc.gen summary zones