Package com.commercetools.api.models.order_edit

Interface StagedOrderAddParcelToDeliveryAction

All Superinterfaces:

ResourceUpdateAction<StagedOrderUpdateAction>, StagedOrderUpdateAction

All Known Implementing Classes:

StagedOrderAddParcelToDeliveryActionImpl

public interface StagedOrderAddParcelToDeliveryAction
extends StagedOrderUpdateAction

To add a Parcel, at least one Delivery must exist.

Produces the Parcel Added To Delivery Message.

Example to create an instance using the builder pattern

     StagedOrderAddParcelToDeliveryAction stagedOrderAddParcelToDeliveryAction = StagedOrderAddParcelToDeliveryAction.builder()
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ADD_PARCEL_TO_DELIVERY	discriminator value for StagedOrderAddParcelToDeliveryAction

Method Summary

Modifier and Type	Method	Description
static StagedOrderAddParcelToDeliveryActionBuilder	builder()	builder factory method for StagedOrderAddParcelToDeliveryAction
static StagedOrderAddParcelToDeliveryActionBuilder	builder(StagedOrderAddParcelToDeliveryAction template)	create builder for StagedOrderAddParcelToDeliveryAction instance
static StagedOrderAddParcelToDeliveryAction	deepCopy(StagedOrderAddParcelToDeliveryAction template)	factory method to create a deep copy of StagedOrderAddParcelToDeliveryAction
String	getDeliveryId()	id of an existing Delivery.
String	getDeliveryKey()	key of an existing Delivery.
@Valid List<DeliveryItem>	getItems()	Value to set.
@Valid ParcelMeasurements	getMeasurements()	Value to set.
String	getParcelKey()	key of an existing Parcel.
@Valid TrackingData	getTrackingData()	Value to set.
static StagedOrderAddParcelToDeliveryAction	of()	factory method
static StagedOrderAddParcelToDeliveryAction	of(StagedOrderAddParcelToDeliveryAction template)	factory method to create a shallow copy StagedOrderAddParcelToDeliveryAction
void	setDeliveryId(String deliveryId)	id of an existing Delivery.
void	setDeliveryKey(String deliveryKey)	key of an existing Delivery.
void	setItems(DeliveryItem... items)	Value to set.
void	setItems(List<DeliveryItem> items)	Value to set.
void	setMeasurements(ParcelMeasurements measurements)	Value to set.
void	setParcelKey(String parcelKey)	key of an existing Parcel.
void	setTrackingData(TrackingData trackingData)	Value to set.
static com.fasterxml.jackson.core.type.TypeReference<StagedOrderAddParcelToDeliveryAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withStagedOrderAddParcelToDeliveryAction(Function<StagedOrderAddParcelToDeliveryAction,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_PARCEL_TO_DELIVERY

static final String ADD_PARCEL_TO_DELIVERY

discriminator value for StagedOrderAddParcelToDeliveryAction

See Also:

• Constant Field Values

Method Details

getDeliveryId

String getDeliveryId()

id of an existing Delivery.

Either deliveryId or deliveryKey must be provided.

Returns:

deliveryId

getDeliveryKey

String getDeliveryKey()

key of an existing Delivery.

Either deliveryId or deliveryKey must be provided.

Returns:

deliveryKey

getParcelKey

String getParcelKey()

key of an existing Parcel.

Returns:

parcelKey

getMeasurements

@Valid
@Valid ParcelMeasurements getMeasurements()

Value to set.

Returns:

measurements

getTrackingData

@Valid
@Valid TrackingData getTrackingData()

Value to set.

Returns:

trackingData

getItems

@Valid
@Valid List<DeliveryItem> getItems()

Value to set.

Returns:

items

setDeliveryId

void setDeliveryId(String deliveryId)

id of an existing Delivery.

Either deliveryId or deliveryKey must be provided.

Parameters:

deliveryId - value to be set

setDeliveryKey

void setDeliveryKey(String deliveryKey)

key of an existing Delivery.

Either deliveryId or deliveryKey must be provided.

Parameters:

deliveryKey - value to be set

setParcelKey

void setParcelKey(String parcelKey)

key of an existing Parcel.

Parameters:

parcelKey - value to be set

setMeasurements

void setMeasurements(ParcelMeasurements measurements)

Value to set.

Parameters:

measurements - value to be set

setTrackingData

void setTrackingData(TrackingData trackingData)

Value to set.

Parameters:

trackingData - value to be set

setItems

void setItems(DeliveryItem... items)

Value to set.

Parameters:

items - values to be set

setItems

void setItems(List<DeliveryItem> items)

Value to set.

Parameters:

items - values to be set

of

static StagedOrderAddParcelToDeliveryAction of()

factory method

Returns:

instance of StagedOrderAddParcelToDeliveryAction

of

static StagedOrderAddParcelToDeliveryAction of(StagedOrderAddParcelToDeliveryAction template)

factory method to create a shallow copy StagedOrderAddParcelToDeliveryAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static StagedOrderAddParcelToDeliveryAction deepCopy(@Nullable
 StagedOrderAddParcelToDeliveryAction template)

factory method to create a deep copy of StagedOrderAddParcelToDeliveryAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static StagedOrderAddParcelToDeliveryActionBuilder builder()

builder factory method for StagedOrderAddParcelToDeliveryAction

Returns:

builder

builder

static StagedOrderAddParcelToDeliveryActionBuilder builder(StagedOrderAddParcelToDeliveryAction template)

create builder for StagedOrderAddParcelToDeliveryAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withStagedOrderAddParcelToDeliveryAction

default <T> T withStagedOrderAddParcelToDeliveryAction(Function<StagedOrderAddParcelToDeliveryAction,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<StagedOrderAddParcelToDeliveryAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference