Package com.commercetools.api.models.order_edit

Interface StagedOrderAddLineItemAction

All Superinterfaces:

CustomizableDraft<StagedOrderAddLineItemAction>, ResourceUpdateAction<StagedOrderUpdateAction>, StagedOrderUpdateAction

All Known Implementing Classes:

StagedOrderAddLineItemActionImpl

public interface StagedOrderAddLineItemAction
extends StagedOrderUpdateAction, CustomizableDraft<StagedOrderAddLineItemAction>

StagedOrderAddLineItemAction Example to create an instance using the builder pattern

     StagedOrderAddLineItemAction stagedOrderAddLineItemAction = StagedOrderAddLineItemAction.builder()
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ADD_LINE_ITEM	discriminator value for StagedOrderAddLineItemAction

Method Summary

Modifier and Type	Method	Description
static StagedOrderAddLineItemActionBuilder	builder()	builder factory method for StagedOrderAddLineItemAction
static StagedOrderAddLineItemActionBuilder	builder(StagedOrderAddLineItemAction template)	create builder for StagedOrderAddLineItemAction instance
static StagedOrderAddLineItemAction	deepCopy(StagedOrderAddLineItemAction template)	factory method to create a deep copy of StagedOrderAddLineItemAction
ZonedDateTime	getAddedAt()
@Valid CustomFieldsDraft	getCustom()	The representation used when creating or updating a customizable data type with Custom Fields.
@Valid ChannelResourceIdentifier	getDistributionChannel()	ResourceIdentifier to a Channel.
@Valid Money	getExternalPrice()	Draft type that stores amounts only in cent precision for the specified currency.
@Valid ExternalTaxRateDraft	getExternalTaxRate()	Controls calculation of taxed prices for Line Items, Custom Line Items, and Shipping Methods as explained in Cart tax calculation.
@Valid ExternalLineItemTotalPrice	getExternalTotalPrice()
String	getKey()	User-defined unique identifier of the LineItem.
String	getProductId()
Long	getQuantity()
@Valid ItemShippingDetailsDraft	getShippingDetails()	For order creation and updates, the sum of the targets must match the quantity of the Line Items or Custom Line Items.
String	getSku()
@Valid ChannelResourceIdentifier	getSupplyChannel()	ResourceIdentifier to a Channel.
Long	getVariantId()
static StagedOrderAddLineItemAction	of()	factory method
static StagedOrderAddLineItemAction	of(StagedOrderAddLineItemAction template)	factory method to create a shallow copy StagedOrderAddLineItemAction
void	setAddedAt(ZonedDateTime addedAt)	set addedAt
void	setCustom(CustomFieldsDraft custom)	The representation used when creating or updating a customizable data type with Custom Fields.
void	setDistributionChannel(ChannelResourceIdentifier distributionChannel)	ResourceIdentifier to a Channel.
void	setExternalPrice(Money externalPrice)	Draft type that stores amounts only in cent precision for the specified currency.
void	setExternalTaxRate(ExternalTaxRateDraft externalTaxRate)	Controls calculation of taxed prices for Line Items, Custom Line Items, and Shipping Methods as explained in Cart tax calculation.
void	setExternalTotalPrice(ExternalLineItemTotalPrice externalTotalPrice)	set externalTotalPrice
void	setKey(String key)	User-defined unique identifier of the LineItem.
void	setProductId(String productId)	set productId
void	setQuantity(Long quantity)	set quantity
void	setShippingDetails(ItemShippingDetailsDraft shippingDetails)	For order creation and updates, the sum of the targets must match the quantity of the Line Items or Custom Line Items.
void	setSku(String sku)	set sku
void	setSupplyChannel(ChannelResourceIdentifier supplyChannel)	ResourceIdentifier to a Channel.
void	setVariantId(Long variantId)	set variantId
static com.fasterxml.jackson.core.type.TypeReference<StagedOrderAddLineItemAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withStagedOrderAddLineItemAction(Function<StagedOrderAddLineItemAction,T> helper)	accessor map function

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

unwrapCustomizableDraft

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

get

Methods inherited from interface com.commercetools.api.models.order.StagedOrderUpdateAction

getAction, withStagedOrderUpdateAction

Field Details

ADD_LINE_ITEM

static final String ADD_LINE_ITEM

discriminator value for StagedOrderAddLineItemAction

See Also:

• Constant Field Values

Method Details

getKey

String getKey()

User-defined unique identifier of the LineItem.

Returns:

key

getCustom

@Valid
@Valid CustomFieldsDraft getCustom()

The representation used when creating or updating a customizable data type with Custom Fields.

Specified by:

getCustom in interface CustomizableDraft<StagedOrderAddLineItemAction>

Returns:

custom

getDistributionChannel

@Valid
@Valid ChannelResourceIdentifier getDistributionChannel()

ResourceIdentifier to a Channel.

Returns:

distributionChannel

getExternalTaxRate

@Valid
@Valid ExternalTaxRateDraft getExternalTaxRate()

Controls calculation of taxed prices for Line Items, Custom Line Items, and Shipping Methods as explained in Cart tax calculation.

Returns:

externalTaxRate

getProductId

String getProductId()

Returns:

productId

getVariantId

Long getVariantId()

Returns:

variantId

getSku

String getSku()

Returns:

sku

getQuantity

Long getQuantity()

Returns:

quantity

getAddedAt

ZonedDateTime getAddedAt()

Returns:

addedAt

getSupplyChannel

@Valid
@Valid ChannelResourceIdentifier getSupplyChannel()

ResourceIdentifier to a Channel.

Returns:

supplyChannel

getExternalPrice

@Valid
@Valid Money getExternalPrice()

Draft type that stores amounts only in cent precision for the specified currency.

Returns:

externalPrice

getExternalTotalPrice

@Valid
@Valid ExternalLineItemTotalPrice getExternalTotalPrice()

Returns:

externalTotalPrice

getShippingDetails

@Valid
@Valid ItemShippingDetailsDraft getShippingDetails()

For order creation and updates, the sum of the targets must match the quantity of the Line Items or Custom Line Items.

Returns:

shippingDetails

setKey

void setKey(String key)

User-defined unique identifier of the LineItem.

Parameters:

key - value to be set

setCustom

void setCustom(CustomFieldsDraft custom)

The representation used when creating or updating a customizable data type with Custom Fields.

Specified by:

setCustom in interface CustomizableDraft<StagedOrderAddLineItemAction>

Parameters:

custom - value to be set

setDistributionChannel

void setDistributionChannel(ChannelResourceIdentifier distributionChannel)

ResourceIdentifier to a Channel.

Parameters:

distributionChannel - value to be set

setExternalTaxRate

void setExternalTaxRate(ExternalTaxRateDraft externalTaxRate)

Controls calculation of taxed prices for Line Items, Custom Line Items, and Shipping Methods as explained in Cart tax calculation.

Parameters:

externalTaxRate - value to be set

setProductId

void setProductId(String productId)

set productId

Parameters:

productId - value to be set

setVariantId

void setVariantId(Long variantId)

set variantId

Parameters:

variantId - value to be set

setSku

void setSku(String sku)

set sku

Parameters:

sku - value to be set

setQuantity

void setQuantity(Long quantity)

set quantity

Parameters:

quantity - value to be set

setAddedAt

void setAddedAt(ZonedDateTime addedAt)

set addedAt

Parameters:

addedAt - value to be set

setSupplyChannel

void setSupplyChannel(ChannelResourceIdentifier supplyChannel)

ResourceIdentifier to a Channel.

Parameters:

supplyChannel - value to be set

setExternalPrice

void setExternalPrice(Money externalPrice)

Draft type that stores amounts only in cent precision for the specified currency.

Parameters:

externalPrice - value to be set

setExternalTotalPrice

void setExternalTotalPrice(ExternalLineItemTotalPrice externalTotalPrice)

set externalTotalPrice

Parameters:

externalTotalPrice - value to be set

setShippingDetails

void setShippingDetails(ItemShippingDetailsDraft shippingDetails)

For order creation and updates, the sum of the targets must match the quantity of the Line Items or Custom Line Items.

Parameters:

shippingDetails - value to be set

of

static StagedOrderAddLineItemAction of()

factory method

Returns:

instance of StagedOrderAddLineItemAction

of

static StagedOrderAddLineItemAction of(StagedOrderAddLineItemAction template)

factory method to create a shallow copy StagedOrderAddLineItemAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static StagedOrderAddLineItemAction deepCopy(@Nullable
 StagedOrderAddLineItemAction template)

factory method to create a deep copy of StagedOrderAddLineItemAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static StagedOrderAddLineItemActionBuilder builder()

builder factory method for StagedOrderAddLineItemAction

Returns:

builder

builder

static StagedOrderAddLineItemActionBuilder builder(StagedOrderAddLineItemAction template)

create builder for StagedOrderAddLineItemAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withStagedOrderAddLineItemAction

default <T> T withStagedOrderAddLineItemAction(Function<StagedOrderAddLineItemAction,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<StagedOrderAddLineItemAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference