Interface StagedOrderAddParcelToDeliveryAction
- All Superinterfaces:
ResourceUpdateAction<StagedOrderUpdateAction>
,StagedOrderUpdateAction
To add a Parcel, at least one Delivery must exist.
Produces the Parcel Added To Delivery Message.
Example to create an instance using the builder pattern
StagedOrderAddParcelToDeliveryAction stagedOrderAddParcelToDeliveryAction = StagedOrderAddParcelToDeliveryAction.builder()
.build()
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
discriminator value for StagedOrderAddParcelToDeliveryAction -
Method Summary
Modifier and TypeMethodDescriptionbuilder()
builder factory method for StagedOrderAddParcelToDeliveryActionbuilder
(StagedOrderAddParcelToDeliveryAction template) create builder for StagedOrderAddParcelToDeliveryAction instancedeepCopy
(StagedOrderAddParcelToDeliveryAction template) factory method to create a deep copy of StagedOrderAddParcelToDeliveryAction@Valid CustomFieldsDraft
Custom Fields for the Parcel.id
of an existing Delivery.key
of an existing Delivery.@Valid List<DeliveryItem>
getItems()
Value to set.@Valid ParcelMeasurements
Value to set.key
of an existing Parcel.@Valid TrackingData
Value to set.of()
factory methodof
(StagedOrderAddParcelToDeliveryAction template) factory method to create a shallow copy StagedOrderAddParcelToDeliveryActionvoid
setCustom
(CustomFieldsDraft custom) Custom Fields for the Parcel.void
setDeliveryId
(String deliveryId) id
of an existing Delivery.void
setDeliveryKey
(String deliveryKey) key
of an existing Delivery.void
setItems
(DeliveryItem... items) Value to set.void
setItems
(List<DeliveryItem> items) Value to set.void
setMeasurements
(ParcelMeasurements measurements) Value to set.void
setParcelKey
(String parcelKey) key
of an existing Parcel.void
setTrackingData
(TrackingData trackingData) Value to set.static com.fasterxml.jackson.core.type.TypeReference<StagedOrderAddParcelToDeliveryAction>
gives a TypeReference for usage with Jackson DataBinddefault <T> T
accessor map functionMethods inherited from interface com.commercetools.api.models.ResourceUpdateAction
get
Methods inherited from interface com.commercetools.api.models.order.StagedOrderUpdateAction
getAction, withStagedOrderUpdateAction
-
Field Details
-
ADD_PARCEL_TO_DELIVERY
discriminator value for StagedOrderAddParcelToDeliveryAction- See Also:
-
-
Method Details
-
getDeliveryId
String getDeliveryId()id
of an existing Delivery.Either
deliveryId
ordeliveryKey
must be provided.- Returns:
- deliveryId
-
getDeliveryKey
String getDeliveryKey()key
of an existing Delivery.Either
deliveryId
ordeliveryKey
must be provided.- Returns:
- deliveryKey
-
getParcelKey
String getParcelKey()key
of an existing Parcel.- Returns:
- parcelKey
-
getMeasurements
Value to set.
- Returns:
- measurements
-
getTrackingData
Value to set.
- Returns:
- trackingData
-
getItems
Value to set.
- Returns:
- items
-
getCustom
Custom Fields for the Parcel.
- Returns:
- custom
-
setDeliveryId
id
of an existing Delivery.Either
deliveryId
ordeliveryKey
must be provided.- Parameters:
deliveryId
- value to be set
-
setDeliveryKey
key
of an existing Delivery.Either
deliveryId
ordeliveryKey
must be provided.- Parameters:
deliveryKey
- value to be set
-
setParcelKey
key
of an existing Parcel.- Parameters:
parcelKey
- value to be set
-
setMeasurements
Value to set.
- Parameters:
measurements
- value to be set
-
setTrackingData
Value to set.
- Parameters:
trackingData
- value to be set
-
setItems
Value to set.
- Parameters:
items
- values to be set
-
setItems
Value to set.
- Parameters:
items
- values to be set
-
setCustom
Custom Fields for the Parcel.
- Parameters:
custom
- value to be set
-
of
factory method- Returns:
- instance of StagedOrderAddParcelToDeliveryAction
-
of
factory method to create a shallow copy StagedOrderAddParcelToDeliveryAction- Parameters:
template
- instance to be copied- Returns:
- copy instance
-
deepCopy
@Nullable static StagedOrderAddParcelToDeliveryAction deepCopy(@Nullable StagedOrderAddParcelToDeliveryAction template) factory method to create a deep copy of StagedOrderAddParcelToDeliveryAction- Parameters:
template
- instance to be copied- Returns:
- copy instance
-
builder
builder factory method for StagedOrderAddParcelToDeliveryAction- Returns:
- builder
-
builder
static StagedOrderAddParcelToDeliveryActionBuilder builder(StagedOrderAddParcelToDeliveryAction template) create builder for StagedOrderAddParcelToDeliveryAction instance- Parameters:
template
- instance with prefilled values for the builder- Returns:
- builder
-
withStagedOrderAddParcelToDeliveryAction
default <T> T withStagedOrderAddParcelToDeliveryAction(Function<StagedOrderAddParcelToDeliveryAction, 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<StagedOrderAddParcelToDeliveryAction> typeReference()gives a TypeReference for usage with Jackson DataBind- Returns:
- TypeReference
-