io.sphere.sdk.orders.commands.updateactions

Class AddReturnInfo

java.lang.Object

io.sphere.sdk.models.Base

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

io.sphere.sdk.orders.commands.updateactions.AddReturnInfo

All Implemented Interfaces:

UpdateAction<Order>

public final class AddReturnInfo
extends UpdateActionImpl<Order>

Adds return data to an order.

See also OrderUpdateCommand.

withOrder(client(), order -> {
    assertThat(order.getReturnInfo()).isEmpty();
    final String lineItemId = order.getLineItems().get(0).getId();
    final List<LineItemReturnItemDraft> items = asList(LineItemReturnItemDraft.of(1L, lineItemId, ReturnShipmentState.RETURNED, "foo bar"));
    final AddReturnInfo action = AddReturnInfo.of(items).withReturnDate(ZonedDateTime_IN_PAST).withReturnTrackingId("trackingId");
    final Order updatedOrder = client().executeBlocking(OrderUpdateCommand.of(order, action));

    final ReturnInfo returnInfo = updatedOrder.getReturnInfo().get(0);
    final ReturnItem returnItem = returnInfo.getItems().get(0);
    assertThat(returnItem).isInstanceOf(LineItemReturnItem.class);
    final LineItemReturnItem lineItemReturnItem = (LineItemReturnItem) returnItem;
    assertThat(returnItem.getQuantity()).isEqualTo(1);
    assertThat(lineItemReturnItem.getLineItemId()).isEqualTo(lineItemId);
    assertThat(lineItemReturnItem.getShipmentState()).isEqualTo(ReturnShipmentState.RETURNED);
    assertThat(lineItemReturnItem.getComment()).contains("foo bar");
    assertThat(returnInfo.getReturnDate()).isEqualTo(ZonedDateTime_IN_PAST);
    assertThat(returnInfo.getReturnTrackingId()).contains("trackingId");

    return updatedOrder;
});
See the test code.

See Also:

Order.getReturnInfo()

Method Summary

Modifier and Type	Method and Description
List<? extends ReturnItemDraft>	getItems()
ZonedDateTime	getReturnDate()
String	getReturnTrackingId()
static AddReturnInfo	of(List<? extends ReturnItemDraft> items)
static AddReturnInfo	of(List<? extends ReturnItemDraft> items, ZonedDateTime returnDate, String returnTrackingId)
AddReturnInfo	withReturnDate(ZonedDateTime returnDate)
AddReturnInfo	withReturnTrackingId(String returnTrackingId)

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 AddReturnInfo of(List<? extends ReturnItemDraft> items,
                               @Nullable
                               ZonedDateTime returnDate,
                               @Nullable
                               String returnTrackingId)

of

public static AddReturnInfo of(List<? extends ReturnItemDraft> items)

withReturnDate

public AddReturnInfo withReturnDate(ZonedDateTime returnDate)

withReturnTrackingId

public AddReturnInfo withReturnTrackingId(String returnTrackingId)

getReturnDate

@Nullable
public ZonedDateTime getReturnDate()

getReturnTrackingId

@Nullable
public String getReturnTrackingId()

getItems

public List<? extends ReturnItemDraft> getItems()