io.sphere.sdk.carts.commands.updateactions

Class SetCustomShippingMethod

java.lang.Object

io.sphere.sdk.models.Base

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

io.sphere.sdk.carts.commands.updateactions.SetCustomShippingMethod

All Implemented Interfaces:

UpdateAction<Cart>

public final class SetCustomShippingMethod
extends UpdateActionImpl<Cart>

Sets a custom shipping method (independent of the shipping methods defined in the project). The custom shipping method can be unset with the setShippingMethod action without the shippingMethod.

See also CartInStoreUpdateCommand.

withTaxCategory(client(), taxCategory -> {
    final Cart cart = createCartWithShippingAddress(client());
    assertThat(cart.getShippingInfo()).isNull();
    final MonetaryAmount price = MoneyImpl.of(new BigDecimal("23.50"), EUR);
    final ShippingRate shippingRate = ShippingRate.of(price, null, Collections.emptyList());
    final String shippingMethodName = "custom-shipping";
    final SetCustomShippingMethod action = SetCustomShippingMethod.of(shippingMethodName, shippingRate, taxCategory);
    final Cart cartWithShippingMethod = client().executeBlocking(CartUpdateCommand.of(cart, action));
    final CartShippingInfo shippingInfo = cartWithShippingMethod.getShippingInfo();
    assertThat(shippingInfo.getPrice()).isEqualTo(price);
    assertThat(shippingInfo.getShippingMethod()).isNull();
    assertThat(shippingInfo.getShippingMethodName()).isEqualTo(shippingMethodName);
    assertThat(shippingInfo.getShippingRate()).isEqualTo(shippingRate);
    assertThat(shippingInfo.getTaxCategory()).isEqualTo(taxCategory.toReference());
    assertThat(shippingInfo.getTaxRate()).isNotNull();
});
See the test code.

Method Summary

Modifier and Type	Method and Description
ExternalTaxRateDraft	getExternalTaxRate()
String	getShippingMethodName()
ShippingRate	getShippingRate()
ResourceIdentifier<TaxCategory>	getTaxCategory()
static SetCustomShippingMethod	of(String shippingMethodName, ShippingRate shippingRate, Referenceable<TaxCategory> taxCategory)
static SetCustomShippingMethod	of(String shippingMethodName, ShippingRate shippingRate, ResourceIdentifier<TaxCategory> taxCategory)
static SetCustomShippingMethod	ofExternalTaxCalculation(String shippingMethodName, ShippingRate shippingRate)
static SetCustomShippingMethod	ofExternalTaxCalculation(String shippingMethodName, ShippingRate shippingRate, ExternalTaxRateDraft externalTaxRate)

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

of

public static SetCustomShippingMethod of(String shippingMethodName,
                                         ShippingRate shippingRate,
                                         ResourceIdentifier<TaxCategory> taxCategory)

of

public static SetCustomShippingMethod of(String shippingMethodName,
                                         ShippingRate shippingRate,
                                         Referenceable<TaxCategory> taxCategory)

ofExternalTaxCalculation

public static SetCustomShippingMethod ofExternalTaxCalculation(String shippingMethodName,
                                                               ShippingRate shippingRate,
                                                               ExternalTaxRateDraft externalTaxRate)

ofExternalTaxCalculation

public static SetCustomShippingMethod ofExternalTaxCalculation(String shippingMethodName,
                                                               ShippingRate shippingRate)

getShippingMethodName

public String getShippingMethodName()

getShippingRate

public ShippingRate getShippingRate()

getTaxCategory

@Nullable
public ResourceIdentifier<TaxCategory> getTaxCategory()

getExternalTaxRate

@Nullable
public ExternalTaxRateDraft getExternalTaxRate()