Package com.commercetools.api.models.message

Interface ParcelAddedToDeliveryMessage

All Superinterfaces:

BaseResource, DomainResource<Message>, Identifiable<Message>, Message, OrderMessage, Versioned<Message>

public interface ParcelAddedToDeliveryMessage
extends OrderMessage

Generated after a successful Add Parcel to Delivery update action.

Example to create an instance using the builder pattern

     ParcelAddedToDeliveryMessage parcelAddedToDeliveryMessage = ParcelAddedToDeliveryMessage.builder()
             .id("{id}")
             .version(0.3)
             .createdAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .lastModifiedAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .sequenceNumber(0.3)
             .resource(resourceBuilder -> resourceBuilder)
             .resourceVersion(0.3)
             .delivery(deliveryBuilder -> deliveryBuilder)
             .parcel(parcelBuilder -> parcelBuilder)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PARCEL_ADDED_TO_DELIVERY	discriminator value for ParcelAddedToDeliveryMessage

Method Summary

Modifier and Type	Method	Description
static ParcelAddedToDeliveryMessageBuilder	builder()	builder factory method for ParcelAddedToDeliveryMessage
static ParcelAddedToDeliveryMessageBuilder	builder(ParcelAddedToDeliveryMessage template)	create builder for ParcelAddedToDeliveryMessage instance
ParcelAddedToDeliveryMessage	copyDeep()
static ParcelAddedToDeliveryMessage	deepCopy(ParcelAddedToDeliveryMessage template)	factory method to create a deep copy of ParcelAddedToDeliveryMessage
@NotNull @Valid Delivery	getDelivery()	Unique identifier of the Delivery.
@NotNull @Valid Parcel	getParcel()	Parcel that was added to the Delivery.
String	getShippingKey()	User-defined unique identifier of the Shipping Method in a Cart with Multiple ShippingMode.
static ParcelAddedToDeliveryMessage	of()	factory method
static ParcelAddedToDeliveryMessage	of(ParcelAddedToDeliveryMessage template)	factory method to create a shallow copy ParcelAddedToDeliveryMessage
void	setDelivery(Delivery delivery)	Unique identifier of the Delivery.
void	setParcel(Parcel parcel)	Parcel that was added to the Delivery.
void	setShippingKey(String shippingKey)	User-defined unique identifier of the Shipping Method in a Cart with Multiple ShippingMode.
static com.fasterxml.jackson.core.type.TypeReference<ParcelAddedToDeliveryMessage>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withParcelAddedToDeliveryMessage(Function<ParcelAddedToDeliveryMessage,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.common.BaseResource

withBaseResource

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

get

Methods inherited from interface com.commercetools.api.models.message.Message

getCreatedAt, getCreatedBy, getId, getLastModifiedAt, getLastModifiedBy, getResource, getResourceUserProvidedIdentifiers, getResourceVersion, getSequenceNumber, getType, getVersion, setCreatedAt, setCreatedBy, setId, setLastModifiedAt, setLastModifiedBy, setResource, setResourceUserProvidedIdentifiers, setResourceVersion, setSequenceNumber, setVersion, withMessage

Methods inherited from interface com.commercetools.api.models.message.OrderMessage

withOrderMessage

Field Details

PARCEL_ADDED_TO_DELIVERY

static final String PARCEL_ADDED_TO_DELIVERY

discriminator value for ParcelAddedToDeliveryMessage

See Also:

• Constant Field Values

Method Details

getDelivery

@NotNull
@Valid
@NotNull @Valid Delivery getDelivery()

Unique identifier of the Delivery.

Returns:

delivery

getParcel

@NotNull
@Valid
@NotNull @Valid Parcel getParcel()

Parcel that was added to the Delivery.

Returns:

parcel

getShippingKey

String getShippingKey()

User-defined unique identifier of the Shipping Method in a Cart with Multiple ShippingMode.

Returns:

shippingKey

setDelivery

void setDelivery(Delivery delivery)

Unique identifier of the Delivery.

Parameters:

delivery - value to be set

setParcel

void setParcel(Parcel parcel)

Parcel that was added to the Delivery.

Parameters:

parcel - value to be set

setShippingKey

void setShippingKey(String shippingKey)

User-defined unique identifier of the Shipping Method in a Cart with Multiple ShippingMode.

Parameters:

shippingKey - value to be set

of

static ParcelAddedToDeliveryMessage of()

factory method

Returns:

instance of ParcelAddedToDeliveryMessage

of

static ParcelAddedToDeliveryMessage of(ParcelAddedToDeliveryMessage template)

factory method to create a shallow copy ParcelAddedToDeliveryMessage

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

ParcelAddedToDeliveryMessage copyDeep()

Specified by:

copyDeep in interface BaseResource

Specified by:

copyDeep in interface Message

Specified by:

copyDeep in interface OrderMessage

deepCopy

@Nullable
static ParcelAddedToDeliveryMessage deepCopy(@Nullable
 ParcelAddedToDeliveryMessage template)

factory method to create a deep copy of ParcelAddedToDeliveryMessage

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ParcelAddedToDeliveryMessageBuilder builder()

builder factory method for ParcelAddedToDeliveryMessage

Returns:

builder

builder

static ParcelAddedToDeliveryMessageBuilder builder(ParcelAddedToDeliveryMessage template)

create builder for ParcelAddedToDeliveryMessage instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withParcelAddedToDeliveryMessage

default <T> T withParcelAddedToDeliveryMessage(Function<ParcelAddedToDeliveryMessage,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<ParcelAddedToDeliveryMessage> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference