Package com.commercetools.importapi.models.orders

Interface ShippingInfoImportDraft

All Superinterfaces:

io.vrap.rmf.base.client.Draft<ShippingInfoImportDraft>

All Known Implementing Classes:

ShippingInfoImportDraftImpl

public interface ShippingInfoImportDraft
extends io.vrap.rmf.base.client.Draft<ShippingInfoImportDraft>

Maps to an order's shippingInfo property. This field is usually populated by the cart assosciated with the order, but when importing orders you must provide a draft representation as a part of the OrderImport.

Example to create an instance using the builder pattern

     ShippingInfoImportDraft shippingInfoImportDraft = ShippingInfoImportDraft.builder()
             .shippingMethodName("{shippingMethodName}")
             .price(priceBuilder -> priceBuilder)
             .shippingRate(shippingRateBuilder -> shippingRateBuilder)
             .build()
 

Method Summary

Modifier and Type	Method	Description
static ShippingInfoImportDraftBuilder	builder()	builder factory method for ShippingInfoImportDraft
static ShippingInfoImportDraftBuilder	builder(ShippingInfoImportDraft template)	create builder for ShippingInfoImportDraft instance
static ShippingInfoImportDraft	deepCopy(ShippingInfoImportDraft template)	factory method to create a deep copy of ShippingInfoImportDraft
@Valid List<Delivery>	getDeliveries()	Note that you can not add a DeliveryItem on import, as LineItems and CustomLineItems are not yet referencable by an id.
@Valid DiscountedLineItemPriceDraft	getDiscountedPrice()
@NotNull @Valid TypedMoney	getPrice()
@Valid ShippingMethodKeyReference	getShippingMethod()	References a shipping method by key.
@NotNull String	getShippingMethodName()
ShippingMethodState	getShippingMethodState()
@NotNull @Valid ShippingRateDraft	getShippingRate()
@Valid TaxCategoryKeyReference	getTaxCategory()	References a tax category by key.
@Valid TaxRate	getTaxRate()
static ShippingInfoImportDraft	of()	factory method
static ShippingInfoImportDraft	of(ShippingInfoImportDraft template)	factory method to create a shallow copy ShippingInfoImportDraft
void	setDeliveries(Delivery... deliveries)	Note that you can not add a DeliveryItem on import, as LineItems and CustomLineItems are not yet referencable by an id.
void	setDeliveries(List<Delivery> deliveries)	Note that you can not add a DeliveryItem on import, as LineItems and CustomLineItems are not yet referencable by an id.
void	setDiscountedPrice(DiscountedLineItemPriceDraft discountedPrice)	set discountedPrice
void	setPrice(TypedMoney price)	set price
void	setShippingMethod(ShippingMethodKeyReference shippingMethod)	References a shipping method by key.
void	setShippingMethodName(String shippingMethodName)	set shippingMethodName
void	setShippingMethodState(ShippingMethodState shippingMethodState)	set shippingMethodState
void	setShippingRate(ShippingRateDraft shippingRate)	set shippingRate
void	setTaxCategory(TaxCategoryKeyReference taxCategory)	References a tax category by key.
void	setTaxRate(TaxRate taxRate)	set taxRate
static com.fasterxml.jackson.core.type.TypeReference<ShippingInfoImportDraft>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withShippingInfoImportDraft(Function<ShippingInfoImportDraft,T> helper)	accessor map function

Method Details

getShippingMethodName

@NotNull
@NotNull String getShippingMethodName()

Returns:

shippingMethodName

getPrice

@NotNull
@Valid
@NotNull @Valid TypedMoney getPrice()

Returns:

price

getShippingRate

@NotNull
@Valid
@NotNull @Valid ShippingRateDraft getShippingRate()

Returns:

shippingRate

getTaxRate

@Valid
@Valid TaxRate getTaxRate()

Returns:

taxRate

getTaxCategory

@Valid
@Valid TaxCategoryKeyReference getTaxCategory()

References a tax category by key.

Returns:

taxCategory

getShippingMethod

@Valid
@Valid ShippingMethodKeyReference getShippingMethod()

References a shipping method by key.

Returns:

shippingMethod

getDeliveries

@Valid
@Valid List<Delivery> getDeliveries()

Note that you can not add a DeliveryItem on import, as LineItems and CustomLineItems are not yet referencable by an id.

Returns:

deliveries

getDiscountedPrice

@Valid
@Valid DiscountedLineItemPriceDraft getDiscountedPrice()

Returns:

discountedPrice

getShippingMethodState

ShippingMethodState getShippingMethodState()

Returns:

shippingMethodState

setShippingMethodName

void setShippingMethodName(String shippingMethodName)

set shippingMethodName

Parameters:

shippingMethodName - value to be set

setPrice

void setPrice(TypedMoney price)

set price

Parameters:

price - value to be set

setShippingRate

void setShippingRate(ShippingRateDraft shippingRate)

set shippingRate

Parameters:

shippingRate - value to be set

setTaxRate

void setTaxRate(TaxRate taxRate)

set taxRate

Parameters:

taxRate - value to be set

setTaxCategory

void setTaxCategory(TaxCategoryKeyReference taxCategory)

References a tax category by key.

Parameters:

taxCategory - value to be set

setShippingMethod

void setShippingMethod(ShippingMethodKeyReference shippingMethod)

References a shipping method by key.

Parameters:

shippingMethod - value to be set

setDeliveries

void setDeliveries(Delivery... deliveries)

Note that you can not add a DeliveryItem on import, as LineItems and CustomLineItems are not yet referencable by an id.

Parameters:

deliveries - values to be set

setDeliveries

void setDeliveries(List<Delivery> deliveries)

Note that you can not add a DeliveryItem on import, as LineItems and CustomLineItems are not yet referencable by an id.

Parameters:

deliveries - values to be set

setDiscountedPrice

void setDiscountedPrice(DiscountedLineItemPriceDraft discountedPrice)

set discountedPrice

Parameters:

discountedPrice - value to be set

setShippingMethodState

void setShippingMethodState(ShippingMethodState shippingMethodState)

set shippingMethodState

Parameters:

shippingMethodState - value to be set

of

static ShippingInfoImportDraft of()

factory method

Returns:

instance of ShippingInfoImportDraft

of

static ShippingInfoImportDraft of(ShippingInfoImportDraft template)

factory method to create a shallow copy ShippingInfoImportDraft

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static ShippingInfoImportDraft deepCopy(@Nullable
 ShippingInfoImportDraft template)

factory method to create a deep copy of ShippingInfoImportDraft

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ShippingInfoImportDraftBuilder builder()

builder factory method for ShippingInfoImportDraft

Returns:

builder

builder

static ShippingInfoImportDraftBuilder builder(ShippingInfoImportDraft template)

create builder for ShippingInfoImportDraft instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withShippingInfoImportDraft

default <T> T withShippingInfoImportDraft(Function<ShippingInfoImportDraft,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<ShippingInfoImportDraft> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference