io.sphere.sdk.carts.commands.updateactions

Class SetShippingMethod

java.lang.Object

io.sphere.sdk.models.Base

io.sphere.sdk.commands.UpdateActionImpl<Cart>

io.sphere.sdk.carts.commands.updateactions.SetShippingMethod

All Implemented Interfaces:

UpdateAction<Cart>

public final class SetShippingMethod
extends UpdateActionImpl<Cart>

Sets the shipping method.

See also CartInStoreUpdateCommand.

withShippingMethodForGermany(client(), shippingMethod -> {
    withCart(client(), createCartWithShippingAddress(client()), cart -> {
        //add shipping method
        assertThat(cart.getShippingInfo()).isNull();
        final CartUpdateCommand updateCommand =
                CartUpdateCommand.of(cart, SetShippingMethod.of(shippingMethod.toResourceIdentifier()))
                        .plusExpansionPaths(m -> m.shippingInfo().shippingMethod().taxCategory())
                        .plusExpansionPaths(m -> m.shippingInfo().taxCategory());
        final Cart cartWithShippingMethod = client().executeBlocking(updateCommand);
        assertThat(cartWithShippingMethod.getShippingInfo().getShippingMethodState()).isEqualTo(ShippingMethodState.MATCHES_CART);
        assertThat(cartWithShippingMethod.getShippingInfo().getShippingMethod()).isEqualTo(shippingMethod.toReference());
        assertThat(cartWithShippingMethod.getShippingInfo().getShippingMethod().getObj())
                .as("reference expansion shippingMethod")
                .isEqualTo(shippingMethod);
        assertThat(cartWithShippingMethod.getShippingInfo().getShippingMethod().getObj().getTaxCategory().getObj())
                .as("reference expansion taxCategory")
                .isEqualTo(cartWithShippingMethod.getShippingInfo().getTaxCategory().getObj())
                .isNotNull();

        //remove shipping method
        final Cart cartWithoutShippingMethod = client().executeBlocking(CartUpdateCommand.of(cartWithShippingMethod, SetShippingMethod.ofRemove()));
        assertThat(cartWithoutShippingMethod.getShippingInfo()).isNull();

        return cartWithoutShippingMethod;
    });
});
See the test code.

withShippingMethodForGermany(client(), shippingMethod -> {
    withCart(client(), createCartWithShippingAddress(client()), cart -> {
        //add shipping method
        assertThat(cart.getShippingInfo()).isNull();
        final CartUpdateCommand updateCommand =
                CartUpdateCommand.of(cart, SetShippingMethod.ofId(shippingMethod.getId()))
                        .plusExpansionPaths(m -> m.shippingInfo().shippingMethod().taxCategory())
                        .plusExpansionPaths(m -> m.shippingInfo().taxCategory());
        final Cart cartWithShippingMethod = client().executeBlocking(updateCommand);
        assertThat(cartWithShippingMethod.getShippingInfo().getShippingMethod()).isEqualTo(shippingMethod.toReference());
        assertThat(cartWithShippingMethod.getShippingInfo().getShippingMethod().getObj())
                .as("reference expansion shippingMethod")
                .isEqualTo(shippingMethod);

        //remove shipping method
        final Cart cartWithoutShippingMethod = client().executeBlocking(CartUpdateCommand.of(cartWithShippingMethod, SetShippingMethod.ofRemove()));
        assertThat(cartWithoutShippingMethod.getShippingInfo()).isNull();

        return cartWithoutShippingMethod;
    });
});
See the test code.

Method Summary

Modifier and Type	Method and Description
ResourceIdentifier<ShippingMethod>	getShippingMethod()
static SetShippingMethod	of(ResourceIdentifier<ShippingMethod> shippingMethod)
static SetShippingMethod	ofId(String shippingMethodId)
static SetShippingMethod	ofReferencable(Referenceable<ShippingMethod> shippingMethod) Deprecated.
static SetShippingMethod	ofRemove()

Methods inherited from class io.sphere.sdk.commands.UpdateActionImpl

getAction

Methods inherited from class io.sphere.sdk.models.Base

equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getShippingMethod

@Nullable
public ResourceIdentifier<ShippingMethod> getShippingMethod()

ofReferencable

@Deprecated
public static SetShippingMethod ofReferencable(@Nullable
                                                           Referenceable<ShippingMethod> shippingMethod)

Deprecated.

This method is deprecated, please use of(ResourceIdentifier)

of

public static SetShippingMethod of(@Nullable
                                   ResourceIdentifier<ShippingMethod> shippingMethod)

ofId

public static SetShippingMethod ofId(@Nullable
                                     String shippingMethodId)

ofRemove

public static SetShippingMethod ofRemove()