Package com.commercetools.api.models.order_edit

Interface StagedOrderAddDeliveryAction

All Superinterfaces:

CustomizableDraft<StagedOrderAddDeliveryAction>, ResourceUpdateAction<StagedOrderUpdateAction>, StagedOrderUpdateAction

public interface StagedOrderAddDeliveryAction
extends StagedOrderUpdateAction, CustomizableDraft<StagedOrderAddDeliveryAction>

A Delivery can only be added to an Order if its shippingInfo (for shippingMode = Single), or its shipping (for shippingMode = Multiple) exists.

Multiple Deliveries can be added to the same Order to represent split or partial shipments. However, the API doesn't validate that the cumulative quantities of Line Items or Custom Line Items across all Deliveries match or stay within the originally ordered quantities. For more information, see Multiple Deliveries on the Shipping and Delivery overview page.

Produces the Delivery Added Message.

Example to create an instance using the builder pattern

     StagedOrderAddDeliveryAction stagedOrderAddDeliveryAction = StagedOrderAddDeliveryAction.builder()
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ADD_DELIVERY	discriminator value for StagedOrderAddDeliveryAction

Method Summary

Modifier and Type	Method	Description
static StagedOrderAddDeliveryActionBuilder	builder()	builder factory method for StagedOrderAddDeliveryAction
static StagedOrderAddDeliveryActionBuilder	builder(StagedOrderAddDeliveryAction template)	create builder for StagedOrderAddDeliveryAction instance
StagedOrderAddDeliveryAction	copyDeep()
static StagedOrderAddDeliveryAction	deepCopy(StagedOrderAddDeliveryAction template)	factory method to create a deep copy of StagedOrderAddDeliveryAction
@Valid BaseAddress	getAddress()	Address the parcels should be delivered to.
@Valid CustomFieldsDraft	getCustom()	Custom Fields for the Delivery.
String	getDeliveryKey()	key of an existing Delivery.
@Valid List<DeliveryItem>	getItems()	Items to be included in the Delivery.
@Valid List<ParcelDraft>	getParcels()	Parcels of the Delivery.
String	getShippingKey()	key of the ShippingMethod, required for Multiple ShippingMode.
static StagedOrderAddDeliveryAction	of()	factory method
static StagedOrderAddDeliveryAction	of(StagedOrderAddDeliveryAction template)	factory method to create a shallow copy StagedOrderAddDeliveryAction
void	setAddress(BaseAddress address)	Address the parcels should be delivered to.
void	setCustom(CustomFieldsDraft custom)	Custom Fields for the Delivery.
void	setDeliveryKey(String deliveryKey)	key of an existing Delivery.
void	setItems(DeliveryItem... items)	Items to be included in the Delivery.
void	setItems(List<DeliveryItem> items)	Items to be included in the Delivery.
void	setParcels(ParcelDraft... parcels)	Parcels of the Delivery.
void	setParcels(List<ParcelDraft> parcels)	Parcels of the Delivery.
void	setShippingKey(String shippingKey)	key of the ShippingMethod, required for Multiple ShippingMode.
static com.fasterxml.jackson.core.type.TypeReference<StagedOrderAddDeliveryAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withStagedOrderAddDeliveryAction(Function<StagedOrderAddDeliveryAction,T> helper)	accessor map function

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

unwrapCustomizableDraft

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_DELIVERY

static final String ADD_DELIVERY

discriminator value for StagedOrderAddDeliveryAction

See Also:

• Constant Field Values

Method Details

getDeliveryKey

String getDeliveryKey()

key of an existing Delivery.

Returns:

deliveryKey

getShippingKey

String getShippingKey()

key of the ShippingMethod, required for Multiple ShippingMode.

Returns:

shippingKey

getItems

@Valid
@Valid List<DeliveryItem> getItems()

Items to be included in the Delivery.

Returns:

items

getAddress

@Valid
@Valid BaseAddress getAddress()

Address the parcels should be delivered to.

Returns:

address

getParcels

@Valid
@Valid List<ParcelDraft> getParcels()

Parcels of the Delivery.

If provided, this update action also produces the Parcel Added To Delivery Message.

Returns:

parcels

getCustom

@Valid
@Valid CustomFieldsDraft getCustom()

Custom Fields for the Delivery.

Specified by:

getCustom in interface CustomizableDraft<StagedOrderAddDeliveryAction>

Returns:

custom

setDeliveryKey

void setDeliveryKey(String deliveryKey)

key of an existing Delivery.

Parameters:

deliveryKey - value to be set

setShippingKey

void setShippingKey(String shippingKey)

key of the ShippingMethod, required for Multiple ShippingMode.

Parameters:

shippingKey - value to be set

setItems

void setItems(DeliveryItem... items)

Items to be included in the Delivery.

Parameters:

items - values to be set

setItems

void setItems(List<DeliveryItem> items)

Items to be included in the Delivery.

Parameters:

items - values to be set

setAddress

void setAddress(BaseAddress address)

Address the parcels should be delivered to.

Parameters:

address - value to be set

setParcels

void setParcels(ParcelDraft... parcels)

Parcels of the Delivery.

If provided, this update action also produces the Parcel Added To Delivery Message.

Parameters:

parcels - values to be set

setParcels

void setParcels(List<ParcelDraft> parcels)

Parcels of the Delivery.

If provided, this update action also produces the Parcel Added To Delivery Message.

Parameters:

parcels - values to be set

setCustom

void setCustom(CustomFieldsDraft custom)

Custom Fields for the Delivery.

Specified by:

setCustom in interface CustomizableDraft<StagedOrderAddDeliveryAction>

Parameters:

custom - value to be set

of

static StagedOrderAddDeliveryAction of()

factory method

Returns:

instance of StagedOrderAddDeliveryAction

of

static StagedOrderAddDeliveryAction of(StagedOrderAddDeliveryAction template)

factory method to create a shallow copy StagedOrderAddDeliveryAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

StagedOrderAddDeliveryAction copyDeep()

Specified by:

copyDeep in interface StagedOrderUpdateAction

deepCopy

@Nullable
static StagedOrderAddDeliveryAction deepCopy(@Nullable
 StagedOrderAddDeliveryAction template)

factory method to create a deep copy of StagedOrderAddDeliveryAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static StagedOrderAddDeliveryActionBuilder builder()

builder factory method for StagedOrderAddDeliveryAction

Returns:

builder

builder

static StagedOrderAddDeliveryActionBuilder builder(StagedOrderAddDeliveryAction template)

create builder for StagedOrderAddDeliveryAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withStagedOrderAddDeliveryAction

default <T> T withStagedOrderAddDeliveryAction(Function<StagedOrderAddDeliveryAction,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<StagedOrderAddDeliveryAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference