Package com.commercetools.api.models.order_edit

Interface StagedOrderAddReturnInfoAction

All Superinterfaces:

ResourceUpdateAction<StagedOrderUpdateAction>, StagedOrderUpdateAction

All Known Implementing Classes:

StagedOrderAddReturnInfoActionImpl

public interface StagedOrderAddReturnInfoAction
extends StagedOrderUpdateAction

Produces the Return Info Added Message.

Example to create an instance using the builder pattern

     StagedOrderAddReturnInfoAction stagedOrderAddReturnInfoAction = StagedOrderAddReturnInfoAction.builder()
             .plusItems(itemsBuilder -> itemsBuilder)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ADD_RETURN_INFO	discriminator value for StagedOrderAddReturnInfoAction

Method Summary

Modifier and Type	Method	Description
static StagedOrderAddReturnInfoActionBuilder	builder()	builder factory method for StagedOrderAddReturnInfoAction
static StagedOrderAddReturnInfoActionBuilder	builder(StagedOrderAddReturnInfoAction template)	create builder for StagedOrderAddReturnInfoAction instance
static StagedOrderAddReturnInfoAction	deepCopy(StagedOrderAddReturnInfoAction template)	factory method to create a deep copy of StagedOrderAddReturnInfoAction
@NotNull @Valid List<ReturnItemDraft>	getItems()	Items to be returned.
ZonedDateTime	getReturnDate()	Value to set.
String	getReturnTrackingId()	Value to set.
static StagedOrderAddReturnInfoAction	of()	factory method
static StagedOrderAddReturnInfoAction	of(StagedOrderAddReturnInfoAction template)	factory method to create a shallow copy StagedOrderAddReturnInfoAction
void	setItems(ReturnItemDraft... items)	Items to be returned.
void	setItems(List<ReturnItemDraft> items)	Items to be returned.
void	setReturnDate(ZonedDateTime returnDate)	Value to set.
void	setReturnTrackingId(String returnTrackingId)	Value to set.
static com.fasterxml.jackson.core.type.TypeReference<StagedOrderAddReturnInfoAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withStagedOrderAddReturnInfoAction(Function<StagedOrderAddReturnInfoAction,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.ResourceUpdateAction

get

Methods inherited from interface com.commercetools.api.models.order.StagedOrderUpdateAction

getAction, withStagedOrderUpdateAction

Field Details

ADD_RETURN_INFO

static final String ADD_RETURN_INFO

discriminator value for StagedOrderAddReturnInfoAction

See Also:

• Constant Field Values

Method Details

getReturnTrackingId

String getReturnTrackingId()

Value to set.

Returns:

returnTrackingId

getItems

@NotNull
@Valid
@NotNull @Valid List<ReturnItemDraft> getItems()

Items to be returned. Must not be empty.

Returns:

items

getReturnDate

ZonedDateTime getReturnDate()

Value to set. If not set, it defaults to the current date and time.

Returns:

returnDate

setReturnTrackingId

void setReturnTrackingId(String returnTrackingId)

Value to set.

Parameters:

returnTrackingId - value to be set

setItems

void setItems(ReturnItemDraft... items)

Items to be returned. Must not be empty.

Parameters:

items - values to be set

setItems

void setItems(List<ReturnItemDraft> items)

Items to be returned. Must not be empty.

Parameters:

items - values to be set

setReturnDate

void setReturnDate(ZonedDateTime returnDate)

Value to set. If not set, it defaults to the current date and time.

Parameters:

returnDate - value to be set

of

static StagedOrderAddReturnInfoAction of()

factory method

Returns:

instance of StagedOrderAddReturnInfoAction

of

static StagedOrderAddReturnInfoAction of(StagedOrderAddReturnInfoAction template)

factory method to create a shallow copy StagedOrderAddReturnInfoAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static StagedOrderAddReturnInfoAction deepCopy(@Nullable
 StagedOrderAddReturnInfoAction template)

factory method to create a deep copy of StagedOrderAddReturnInfoAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static StagedOrderAddReturnInfoActionBuilder builder()

builder factory method for StagedOrderAddReturnInfoAction

Returns:

builder

builder

static StagedOrderAddReturnInfoActionBuilder builder(StagedOrderAddReturnInfoAction template)

create builder for StagedOrderAddReturnInfoAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withStagedOrderAddReturnInfoAction

default <T> T withStagedOrderAddReturnInfoAction(Function<StagedOrderAddReturnInfoAction,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

typeReference

static com.fasterxml.jackson.core.type.TypeReference<StagedOrderAddReturnInfoAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference