Package com.commercetools.api.models.message

Interface ParcelRemovedFromDeliveryMessage

All Superinterfaces:

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

All Known Implementing Classes:

ParcelRemovedFromDeliveryMessageImpl

public interface ParcelRemovedFromDeliveryMessage
extends OrderMessage

Generated after a successful Remove Parcel From Delivery update action.

Example to create an instance using the builder pattern

     ParcelRemovedFromDeliveryMessage parcelRemovedFromDeliveryMessage = ParcelRemovedFromDeliveryMessage.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)
             .deliveryId("{deliveryId}")
             .parcel(parcelBuilder -> parcelBuilder)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PARCEL_REMOVED_FROM_DELIVERY	discriminator value for ParcelRemovedFromDeliveryMessage

Method Summary

Modifier and Type	Method	Description
static ParcelRemovedFromDeliveryMessageBuilder	builder()	builder factory method for ParcelRemovedFromDeliveryMessage
static ParcelRemovedFromDeliveryMessageBuilder	builder(ParcelRemovedFromDeliveryMessage template)	create builder for ParcelRemovedFromDeliveryMessage instance
static ParcelRemovedFromDeliveryMessage	deepCopy(ParcelRemovedFromDeliveryMessage template)	factory method to create a deep copy of ParcelRemovedFromDeliveryMessage
@NotNull String	getDeliveryId()	Unique identifier of the Delivery.
@NotNull @Valid Parcel	getParcel()	Parcel that was removed from the Delivery.
String	getShippingKey()	User-defined unique identifier of the Shipping Method in a Cart with Multi ShippingMode.
static ParcelRemovedFromDeliveryMessage	of()	factory method
static ParcelRemovedFromDeliveryMessage	of(ParcelRemovedFromDeliveryMessage template)	factory method to create a shallow copy ParcelRemovedFromDeliveryMessage
void	setDeliveryId(String deliveryId)	Unique identifier of the Delivery.
void	setParcel(Parcel parcel)	Parcel that was removed from the Delivery.
void	setShippingKey(String shippingKey)	User-defined unique identifier of the Shipping Method in a Cart with Multi ShippingMode.
static com.fasterxml.jackson.core.type.TypeReference<ParcelRemovedFromDeliveryMessage>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withParcelRemovedFromDeliveryMessage(Function<ParcelRemovedFromDeliveryMessage,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_REMOVED_FROM_DELIVERY

static final String PARCEL_REMOVED_FROM_DELIVERY

discriminator value for ParcelRemovedFromDeliveryMessage

See Also:

• Constant Field Values

Method Details

getDeliveryId

@NotNull
@NotNull String getDeliveryId()

Unique identifier of the Delivery.

Returns:

deliveryId

getParcel

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

Parcel that was removed from the Delivery.

Returns:

parcel

getShippingKey

String getShippingKey()

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

Returns:

shippingKey

setDeliveryId

void setDeliveryId(String deliveryId)

Unique identifier of the Delivery.

Parameters:

deliveryId - value to be set

setParcel

void setParcel(Parcel parcel)

Parcel that was removed from 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 Multi ShippingMode.

Parameters:

shippingKey - value to be set

of

static ParcelRemovedFromDeliveryMessage of()

factory method

Returns:

instance of ParcelRemovedFromDeliveryMessage

of

static ParcelRemovedFromDeliveryMessage of(ParcelRemovedFromDeliveryMessage template)

factory method to create a shallow copy ParcelRemovedFromDeliveryMessage

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static ParcelRemovedFromDeliveryMessage deepCopy(@Nullable
 ParcelRemovedFromDeliveryMessage template)

factory method to create a deep copy of ParcelRemovedFromDeliveryMessage

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ParcelRemovedFromDeliveryMessageBuilder builder()

builder factory method for ParcelRemovedFromDeliveryMessage

Returns:

builder

builder

static ParcelRemovedFromDeliveryMessageBuilder builder(ParcelRemovedFromDeliveryMessage template)

create builder for ParcelRemovedFromDeliveryMessage instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withParcelRemovedFromDeliveryMessage

default <T> T withParcelRemovedFromDeliveryMessage(Function<ParcelRemovedFromDeliveryMessage,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<ParcelRemovedFromDeliveryMessage> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference