Package com.commercetools.api.models.order

Interface OrderImportDraft

All Superinterfaces:

CustomizableDraft<OrderImportDraft>, io.vrap.rmf.base.client.Draft<OrderImportDraft>

All Known Implementing Classes:

OrderImportDraftImpl

public interface OrderImportDraft
extends CustomizableDraft<OrderImportDraft>, io.vrap.rmf.base.client.Draft<OrderImportDraft>

OrderImportDraft Example to create an instance using the builder pattern

     OrderImportDraft orderImportDraft = OrderImportDraft.builder()
             .totalPrice(totalPriceBuilder -> totalPriceBuilder)
             .build()
 

Method Summary

Modifier and Type	Method	Description
static OrderImportDraftBuilder	builder()	builder factory method for OrderImportDraft
static OrderImportDraftBuilder	builder(OrderImportDraft template)	create builder for OrderImportDraft instance
static OrderImportDraft	deepCopy(OrderImportDraft template)	factory method to create a deep copy of OrderImportDraft
@Valid BaseAddress	getBillingAddress()
@Valid BusinessUnitResourceIdentifier	getBusinessUnit()	The Business Unit the Cart belongs to.
ZonedDateTime	getCompletedAt()
String	getCountry()	A two-digit country code as per ISO 3166-1 alpha-2.
@Valid CustomFieldsDraft	getCustom()	The custom fields.
String	getCustomerEmail()	The customer email can be used when no check against existing Customers is desired during order import.
@Valid CustomerGroupResourceIdentifier	getCustomerGroup()	Set when the customer is set and the customer is a member of a customer group.
String	getCustomerId()	If given the customer with that ID must exist in the project.
@Valid List<CustomLineItemImportDraft>	getCustomLineItems()	If not given lineItems must not be empty.
InventoryMode	getInventoryMode()	If not given the mode None will be assigned by default.
@Valid List<BaseAddress>	getItemShippingAddresses()	Contains addresses for orders with multiple shipping addresses.
@Valid List<LineItemImportDraft>	getLineItems()	If not given customLineItems must not be empty.
String	getOrderNumber()	String that unique identifies an order.
OrderState	getOrderState()	If not given the Open state will be assigned by default.
CartOrigin	getOrigin()	The default origin is Customer.
@Valid PaymentInfo	getPaymentInfo()
PaymentState	getPaymentState()
ShipmentState	getShipmentState()
@Valid BaseAddress	getShippingAddress()
@Valid ShippingInfoImportDraft	getShippingInfo()	Set if the ShippingMethod is set.
@Valid StateReference	getState()	This reference can point to a state in a custom workflow.
@Valid StoreResourceIdentifier	getStore()
@Valid TaxedPriceDraft	getTaxedPrice()	Order Import does not support calculation of taxes.
RoundingMode	getTaxRoundingMode()	If not given the tax rounding mode HalfEven will be assigned by default.
@NotNull @Valid Money	getTotalPrice()
static OrderImportDraft	of()	factory method
static OrderImportDraft	of(OrderImportDraft template)	factory method to create a shallow copy OrderImportDraft
void	setBillingAddress(BaseAddress billingAddress)	set billingAddress
void	setBusinessUnit(BusinessUnitResourceIdentifier businessUnit)	The Business Unit the Cart belongs to.
void	setCompletedAt(ZonedDateTime completedAt)	set completedAt
void	setCountry(String country)	A two-digit country code as per ISO 3166-1 alpha-2.
void	setCustom(CustomFieldsDraft custom)	The custom fields.
void	setCustomerEmail(String customerEmail)	The customer email can be used when no check against existing Customers is desired during order import.
void	setCustomerGroup(CustomerGroupResourceIdentifier customerGroup)	Set when the customer is set and the customer is a member of a customer group.
void	setCustomerId(String customerId)	If given the customer with that ID must exist in the project.
void	setCustomLineItems(CustomLineItemImportDraft... customLineItems)	If not given lineItems must not be empty.
void	setCustomLineItems(List<CustomLineItemImportDraft> customLineItems)	If not given lineItems must not be empty.
void	setInventoryMode(InventoryMode inventoryMode)	If not given the mode None will be assigned by default.
void	setItemShippingAddresses(BaseAddress... itemShippingAddresses)	Contains addresses for orders with multiple shipping addresses.
void	setItemShippingAddresses(List<BaseAddress> itemShippingAddresses)	Contains addresses for orders with multiple shipping addresses.
void	setLineItems(LineItemImportDraft... lineItems)	If not given customLineItems must not be empty.
void	setLineItems(List<LineItemImportDraft> lineItems)	If not given customLineItems must not be empty.
void	setOrderNumber(String orderNumber)	String that unique identifies an order.
void	setOrderState(OrderState orderState)	If not given the Open state will be assigned by default.
void	setOrigin(CartOrigin origin)	The default origin is Customer.
void	setPaymentInfo(PaymentInfo paymentInfo)	set paymentInfo
void	setPaymentState(PaymentState paymentState)	set paymentState
void	setShipmentState(ShipmentState shipmentState)	set shipmentState
void	setShippingAddress(BaseAddress shippingAddress)	set shippingAddress
void	setShippingInfo(ShippingInfoImportDraft shippingInfo)	Set if the ShippingMethod is set.
void	setState(StateReference state)	This reference can point to a state in a custom workflow.
void	setStore(StoreResourceIdentifier store)	set store
void	setTaxedPrice(TaxedPriceDraft taxedPrice)	Order Import does not support calculation of taxes.
void	setTaxRoundingMode(RoundingMode taxRoundingMode)	If not given the tax rounding mode HalfEven will be assigned by default.
void	setTotalPrice(Money totalPrice)	set totalPrice
static com.fasterxml.jackson.core.type.TypeReference<OrderImportDraft>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withOrderImportDraft(Function<OrderImportDraft,T> helper)	accessor map function

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

unwrapCustomizableDraft

Method Details

getOrderNumber

String getOrderNumber()

String that unique identifies an order. It can be used to create more human-readable (in contrast to ID) identifier for the order. It should be unique within a project.

Returns:

orderNumber

getCustomerId

String getCustomerId()

If given the customer with that ID must exist in the project.

Returns:

customerId

getCustomerEmail

String getCustomerEmail()

The customer email can be used when no check against existing Customers is desired during order import.

Returns:

customerEmail

getLineItems

@Valid
@Valid List<LineItemImportDraft> getLineItems()

If not given customLineItems must not be empty.

Returns:

lineItems

getCustomLineItems

@Valid
@Valid List<CustomLineItemImportDraft> getCustomLineItems()

If not given lineItems must not be empty.

Returns:

customLineItems

getTotalPrice

@NotNull
@Valid
@NotNull @Valid Money getTotalPrice()

Returns:

totalPrice

getTaxedPrice

@Valid
@Valid TaxedPriceDraft getTaxedPrice()

Order Import does not support calculation of taxes. When setting the draft the taxedPrice is to be provided.

Returns:

taxedPrice

getShippingAddress

@Valid
@Valid BaseAddress getShippingAddress()

Returns:

shippingAddress

getBillingAddress

@Valid
@Valid BaseAddress getBillingAddress()

Returns:

billingAddress

getCustomerGroup

@Valid
@Valid CustomerGroupResourceIdentifier getCustomerGroup()

Set when the customer is set and the customer is a member of a customer group. Used for product variant price selection.

Returns:

customerGroup

getCountry

String getCountry()

A two-digit country code as per ISO 3166-1 alpha-2. Used for product variant price selection.

Returns:

country

getOrderState

OrderState getOrderState()

If not given the Open state will be assigned by default.

Returns:

orderState

getState

@Valid
@Valid StateReference getState()

This reference can point to a state in a custom workflow.

Returns:

state

getShipmentState

ShipmentState getShipmentState()

Returns:

shipmentState

getPaymentState

PaymentState getPaymentState()

Returns:

paymentState

getShippingInfo

@Valid
@Valid ShippingInfoImportDraft getShippingInfo()

Set if the ShippingMethod is set.

Returns:

shippingInfo

getPaymentInfo

@Valid
@Valid PaymentInfo getPaymentInfo()

Returns:

paymentInfo

getCompletedAt

ZonedDateTime getCompletedAt()

Returns:

completedAt

getCustom

@Valid
@Valid CustomFieldsDraft getCustom()

The custom fields.

Specified by:

getCustom in interface CustomizableDraft<OrderImportDraft>

Returns:

custom

getInventoryMode

InventoryMode getInventoryMode()

If not given the mode None will be assigned by default.

Returns:

inventoryMode

getTaxRoundingMode

RoundingMode getTaxRoundingMode()

If not given the tax rounding mode HalfEven will be assigned by default.

Returns:

taxRoundingMode

getItemShippingAddresses

@Valid
@Valid List<BaseAddress> getItemShippingAddresses()

Contains addresses for orders with multiple shipping addresses.

Returns:

itemShippingAddresses

getBusinessUnit

@Valid
@Valid BusinessUnitResourceIdentifier getBusinessUnit()

The Business Unit the Cart belongs to.

Returns:

businessUnit

getStore

@Valid
@Valid StoreResourceIdentifier getStore()

Returns:

store

getOrigin

CartOrigin getOrigin()

The default origin is Customer.

Returns:

origin

setOrderNumber

void setOrderNumber(String orderNumber)

String that unique identifies an order. It can be used to create more human-readable (in contrast to ID) identifier for the order. It should be unique within a project.

Parameters:

orderNumber - value to be set

setCustomerId

void setCustomerId(String customerId)

If given the customer with that ID must exist in the project.

Parameters:

customerId - value to be set

setCustomerEmail

void setCustomerEmail(String customerEmail)

The customer email can be used when no check against existing Customers is desired during order import.

Parameters:

customerEmail - value to be set

setLineItems

void setLineItems(LineItemImportDraft... lineItems)

If not given customLineItems must not be empty.

Parameters:

lineItems - values to be set

setLineItems

void setLineItems(List<LineItemImportDraft> lineItems)

If not given customLineItems must not be empty.

Parameters:

lineItems - values to be set

setCustomLineItems

void setCustomLineItems(CustomLineItemImportDraft... customLineItems)

If not given lineItems must not be empty.

Parameters:

customLineItems - values to be set

setCustomLineItems

void setCustomLineItems(List<CustomLineItemImportDraft> customLineItems)

If not given lineItems must not be empty.

Parameters:

customLineItems - values to be set

setTotalPrice

void setTotalPrice(Money totalPrice)

set totalPrice

Parameters:

totalPrice - value to be set

setTaxedPrice

void setTaxedPrice(TaxedPriceDraft taxedPrice)

Order Import does not support calculation of taxes. When setting the draft the taxedPrice is to be provided.

Parameters:

taxedPrice - value to be set

setShippingAddress

void setShippingAddress(BaseAddress shippingAddress)

set shippingAddress

Parameters:

shippingAddress - value to be set

setBillingAddress

void setBillingAddress(BaseAddress billingAddress)

set billingAddress

Parameters:

billingAddress - value to be set

setCustomerGroup

void setCustomerGroup(CustomerGroupResourceIdentifier customerGroup)

Set when the customer is set and the customer is a member of a customer group. Used for product variant price selection.

Parameters:

customerGroup - value to be set

setCountry

void setCountry(String country)

A two-digit country code as per ISO 3166-1 alpha-2. Used for product variant price selection.

Parameters:

country - value to be set

setOrderState

void setOrderState(OrderState orderState)

If not given the Open state will be assigned by default.

Parameters:

orderState - value to be set

setState

void setState(StateReference state)

This reference can point to a state in a custom workflow.

Parameters:

state - value to be set

setShipmentState

void setShipmentState(ShipmentState shipmentState)

set shipmentState

Parameters:

shipmentState - value to be set

setPaymentState

void setPaymentState(PaymentState paymentState)

set paymentState

Parameters:

paymentState - value to be set

setShippingInfo

void setShippingInfo(ShippingInfoImportDraft shippingInfo)

Set if the ShippingMethod is set.

Parameters:

shippingInfo - value to be set

setPaymentInfo

void setPaymentInfo(PaymentInfo paymentInfo)

set paymentInfo

Parameters:

paymentInfo - value to be set

setCompletedAt

void setCompletedAt(ZonedDateTime completedAt)

set completedAt

Parameters:

completedAt - value to be set

setCustom

void setCustom(CustomFieldsDraft custom)

The custom fields.

Specified by:

setCustom in interface CustomizableDraft<OrderImportDraft>

Parameters:

custom - value to be set

setInventoryMode

void setInventoryMode(InventoryMode inventoryMode)

If not given the mode None will be assigned by default.

Parameters:

inventoryMode - value to be set

setTaxRoundingMode

void setTaxRoundingMode(RoundingMode taxRoundingMode)

If not given the tax rounding mode HalfEven will be assigned by default.

Parameters:

taxRoundingMode - value to be set

setItemShippingAddresses

void setItemShippingAddresses(BaseAddress... itemShippingAddresses)

Contains addresses for orders with multiple shipping addresses.

Parameters:

itemShippingAddresses - values to be set

setItemShippingAddresses

void setItemShippingAddresses(List<BaseAddress> itemShippingAddresses)

Contains addresses for orders with multiple shipping addresses.

Parameters:

itemShippingAddresses - values to be set

setBusinessUnit

void setBusinessUnit(BusinessUnitResourceIdentifier businessUnit)

The Business Unit the Cart belongs to.

Parameters:

businessUnit - value to be set

setStore

void setStore(StoreResourceIdentifier store)

set store

Parameters:

store - value to be set

setOrigin

void setOrigin(CartOrigin origin)

The default origin is Customer.

Parameters:

origin - value to be set

of

static OrderImportDraft of()

factory method

Returns:

instance of OrderImportDraft

of

static OrderImportDraft of(OrderImportDraft template)

factory method to create a shallow copy OrderImportDraft

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static OrderImportDraft deepCopy(@Nullable
 OrderImportDraft template)

factory method to create a deep copy of OrderImportDraft

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static OrderImportDraftBuilder builder()

builder factory method for OrderImportDraft

Returns:

builder

builder

static OrderImportDraftBuilder builder(OrderImportDraft template)

create builder for OrderImportDraft instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withOrderImportDraft

default <T> T withOrderImportDraft(Function<OrderImportDraft,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<OrderImportDraft> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference