Package com.commercetools.api.models.message

Interface ParcelTrackingDataUpdatedMessagePayload

All Superinterfaces:

MessagePayload, OrderMessagePayload

All Known Implementing Classes:

ParcelTrackingDataUpdatedMessagePayloadImpl

public interface ParcelTrackingDataUpdatedMessagePayload
extends OrderMessagePayload

Generated after a successful Set Parcel Tracking Data update action.

Example to create an instance using the builder pattern

     ParcelTrackingDataUpdatedMessagePayload parcelTrackingDataUpdatedMessagePayload = ParcelTrackingDataUpdatedMessagePayload.builder()
             .deliveryId("{deliveryId}")
             .parcelId("{parcelId}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PARCEL_TRACKING_DATA_UPDATED	discriminator value for ParcelTrackingDataUpdatedMessagePayload

Method Summary

Modifier and Type	Method	Description
static ParcelTrackingDataUpdatedMessagePayloadBuilder	builder()	builder factory method for ParcelTrackingDataUpdatedMessagePayload
static ParcelTrackingDataUpdatedMessagePayloadBuilder	builder(ParcelTrackingDataUpdatedMessagePayload template)	create builder for ParcelTrackingDataUpdatedMessagePayload instance
static ParcelTrackingDataUpdatedMessagePayload	deepCopy(ParcelTrackingDataUpdatedMessagePayload template)	factory method to create a deep copy of ParcelTrackingDataUpdatedMessagePayload
@NotNull String	getDeliveryId()	Unique identifier of the Delivery.
@NotNull String	getParcelId()	Unique identifier of the Parcel.
String	getShippingKey()	User-defined unique identifier of the Shipping Method in a Cart with Multiple ShippingMode.
@Valid TrackingData	getTrackingData()	The Tracking Data that was added to the Parcel.
static ParcelTrackingDataUpdatedMessagePayload	of()	factory method
static ParcelTrackingDataUpdatedMessagePayload	of(ParcelTrackingDataUpdatedMessagePayload template)	factory method to create a shallow copy ParcelTrackingDataUpdatedMessagePayload
void	setDeliveryId(String deliveryId)	Unique identifier of the Delivery.
void	setParcelId(String parcelId)	Unique identifier of the Parcel.
void	setShippingKey(String shippingKey)	User-defined unique identifier of the Shipping Method in a Cart with Multiple ShippingMode.
void	setTrackingData(TrackingData trackingData)	The Tracking Data that was added to the Parcel.
static com.fasterxml.jackson.core.type.TypeReference<ParcelTrackingDataUpdatedMessagePayload>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withParcelTrackingDataUpdatedMessagePayload(Function<ParcelTrackingDataUpdatedMessagePayload,T> helper)	accessor map function

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

getType, withMessagePayload

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

withOrderMessagePayload

Field Details

PARCEL_TRACKING_DATA_UPDATED

static final String PARCEL_TRACKING_DATA_UPDATED

discriminator value for ParcelTrackingDataUpdatedMessagePayload

See Also:

• Constant Field Values

Method Details

getDeliveryId

@NotNull
@NotNull String getDeliveryId()

Unique identifier of the Delivery.

Returns:

deliveryId

getParcelId

@NotNull
@NotNull String getParcelId()

Unique identifier of the Parcel.

Returns:

parcelId

getTrackingData

@Valid
@Valid TrackingData getTrackingData()

The Tracking Data that was added to the Parcel.

Returns:

trackingData

getShippingKey

String getShippingKey()

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

Returns:

shippingKey

setDeliveryId

void setDeliveryId(String deliveryId)

Unique identifier of the Delivery.

Parameters:

deliveryId - value to be set

setParcelId

void setParcelId(String parcelId)

Unique identifier of the Parcel.

Parameters:

parcelId - value to be set

setTrackingData

void setTrackingData(TrackingData trackingData)

The Tracking Data that was added to the Parcel.

Parameters:

trackingData - 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 ParcelTrackingDataUpdatedMessagePayload of()

factory method

Returns:

instance of ParcelTrackingDataUpdatedMessagePayload

of

static ParcelTrackingDataUpdatedMessagePayload of(ParcelTrackingDataUpdatedMessagePayload template)

factory method to create a shallow copy ParcelTrackingDataUpdatedMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static ParcelTrackingDataUpdatedMessagePayload deepCopy(@Nullable
 ParcelTrackingDataUpdatedMessagePayload template)

factory method to create a deep copy of ParcelTrackingDataUpdatedMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ParcelTrackingDataUpdatedMessagePayloadBuilder builder()

builder factory method for ParcelTrackingDataUpdatedMessagePayload

Returns:

builder

builder

static ParcelTrackingDataUpdatedMessagePayloadBuilder builder(ParcelTrackingDataUpdatedMessagePayload template)

create builder for ParcelTrackingDataUpdatedMessagePayload instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withParcelTrackingDataUpdatedMessagePayload

default <T> T withParcelTrackingDataUpdatedMessagePayload(Function<ParcelTrackingDataUpdatedMessagePayload,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<ParcelTrackingDataUpdatedMessagePayload> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference