Package com.commercetools.api.models.message

Interface DeliveryAddedMessage

All Superinterfaces:

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

public interface DeliveryAddedMessage
extends OrderMessage

Generated after a successful Add Delivery update action.

Example to create an instance using the builder pattern

     DeliveryAddedMessage deliveryAddedMessage = DeliveryAddedMessage.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)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DELIVERY_ADDED	discriminator value for DeliveryAddedMessage

Method Summary

Modifier and Type	Method	Description
static DeliveryAddedMessageBuilder	builder()	builder factory method for DeliveryAddedMessage
static DeliveryAddedMessageBuilder	builder(DeliveryAddedMessage template)	create builder for DeliveryAddedMessage instance
DeliveryAddedMessage	copyDeep()
static DeliveryAddedMessage	deepCopy(DeliveryAddedMessage template)	factory method to create a deep copy of DeliveryAddedMessage
@NotNull @Valid Delivery	getDelivery()	Delivery that was added to the Order.
String	getShippingKey()	User-defined unique identifier of the Shipping Method in a Cart with Multiple ShippingMode.
static DeliveryAddedMessage	of()	factory method
static DeliveryAddedMessage	of(DeliveryAddedMessage template)	factory method to create a shallow copy DeliveryAddedMessage
void	setDelivery(Delivery delivery)	Delivery that was added to the Order.
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<DeliveryAddedMessage>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withDeliveryAddedMessage(Function<DeliveryAddedMessage,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

DELIVERY_ADDED

static final String DELIVERY_ADDED

discriminator value for DeliveryAddedMessage

See Also:

• Constant Field Values

Method Details

getDelivery

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

Delivery that was added to the Order. The Delivery in the Message body does not contain Parcels if those were part of the initial Add Delivery update action. In that case, the update action produces an additional Parcel Added To Delivery Message containing information about the Parcels.

Returns:

delivery

getShippingKey

String getShippingKey()

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

Returns:

shippingKey

setDelivery

void setDelivery(Delivery delivery)

Delivery that was added to the Order. The Delivery in the Message body does not contain Parcels if those were part of the initial Add Delivery update action. In that case, the update action produces an additional Parcel Added To Delivery Message containing information about the Parcels.

Parameters:

delivery - 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 DeliveryAddedMessage of()

factory method

Returns:

instance of DeliveryAddedMessage

of

static DeliveryAddedMessage of(DeliveryAddedMessage template)

factory method to create a shallow copy DeliveryAddedMessage

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

DeliveryAddedMessage copyDeep()

Specified by:

copyDeep in interface BaseResource

Specified by:

copyDeep in interface Message

Specified by:

copyDeep in interface OrderMessage

deepCopy

@Nullable
static DeliveryAddedMessage deepCopy(@Nullable
 DeliveryAddedMessage template)

factory method to create a deep copy of DeliveryAddedMessage

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static DeliveryAddedMessageBuilder builder()

builder factory method for DeliveryAddedMessage

Returns:

builder

builder

static DeliveryAddedMessageBuilder builder(DeliveryAddedMessage template)

create builder for DeliveryAddedMessage instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withDeliveryAddedMessage

default <T> T withDeliveryAddedMessage(Function<DeliveryAddedMessage,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<DeliveryAddedMessage> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference