Interface OrderImportDraft
- All Superinterfaces:
CustomizableDraft<OrderImportDraft>
,io.vrap.rmf.base.client.Draft<OrderImportDraft>
- All Known Implementing Classes:
OrderImportDraftImpl
Example to create an instance using the builder pattern
OrderImportDraft orderImportDraft = OrderImportDraft.builder()
.totalPrice(totalPriceBuilder -> totalPriceBuilder)
.build()
-
Method Summary
Modifier and TypeMethodDescriptionstatic OrderImportDraftBuilder
builder()
builder factory method for OrderImportDraftstatic OrderImportDraftBuilder
builder
(OrderImportDraft template) create builder for OrderImportDraft instancestatic OrderImportDraft
deepCopy
(OrderImportDraft template) factory method to create a deep copy of OrderImportDraft@Valid BaseAddress
The Business Unit the Cart belongs to.A two-digit country code as per ISO 3166-1 alpha-2.@Valid CustomFieldsDraft
The custom fields.The customer email can be used when no check against existing Customers is desired during order import.Set when the customer is set and the customer is a member of a customer group.If given the customer with that ID must exist in the project.@Valid List<CustomLineItemImportDraft>
If not givenlineItems
must not be empty.If not given the modeNone
will be assigned by default.@Valid List<BaseAddress>
Contains addresses for orders with multiple shipping addresses.@Valid List<LineItemImportDraft>
If not givencustomLineItems
must not be empty.String that unique identifies an order.If not given theOpen
state will be assigned by default.The default origin isCustomer
.@Valid PaymentInfo
@Valid BaseAddress
@Valid ShippingInfoImportDraft
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
Order Import does not support calculation of taxes.If not given the tax rounding modeHalfEven
will be assigned by default.@NotNull @Valid Money
static OrderImportDraft
of()
factory methodstatic OrderImportDraft
of
(OrderImportDraft template) factory method to create a shallow copy OrderImportDraftvoid
setBillingAddress
(BaseAddress billingAddress) set billingAddressvoid
setBusinessUnit
(BusinessUnitResourceIdentifier businessUnit) The Business Unit the Cart belongs to.void
setCompletedAt
(ZonedDateTime completedAt) set completedAtvoid
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 givenlineItems
must not be empty.void
setCustomLineItems
(List<CustomLineItemImportDraft> customLineItems) If not givenlineItems
must not be empty.void
setInventoryMode
(InventoryMode inventoryMode) If not given the modeNone
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 givencustomLineItems
must not be empty.void
setLineItems
(List<LineItemImportDraft> lineItems) If not givencustomLineItems
must not be empty.void
setOrderNumber
(String orderNumber) String that unique identifies an order.void
setOrderState
(OrderState orderState) If not given theOpen
state will be assigned by default.void
setOrigin
(CartOrigin origin) The default origin isCustomer
.void
setPaymentInfo
(PaymentInfo paymentInfo) set paymentInfovoid
setPaymentState
(PaymentState paymentState) set paymentStatevoid
setShipmentState
(ShipmentState shipmentState) set shipmentStatevoid
setShippingAddress
(BaseAddress shippingAddress) set shippingAddressvoid
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 storevoid
setTaxedPrice
(TaxedPriceDraft taxedPrice) Order Import does not support calculation of taxes.void
setTaxRoundingMode
(RoundingMode taxRoundingMode) If not given the tax rounding modeHalfEven
will be assigned by default.void
setTotalPrice
(Money totalPrice) set totalPricestatic com.fasterxml.jackson.core.type.TypeReference<OrderImportDraft>
gives a TypeReference for usage with Jackson DataBinddefault <T> T
withOrderImportDraft
(Function<OrderImportDraft, T> helper) accessor map functionMethods inherited from interface com.commercetools.api.models.CustomizableDraft
unwrapCustomizableDraft
-
Method Details
-
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
If given the customer with that ID must exist in the project.
- Returns:
- customerId
-
getCustomerEmail
The customer email can be used when no check against existing Customers is desired during order import.
- Returns:
- customerEmail
-
getLineItems
If not given
customLineItems
must not be empty.- Returns:
- lineItems
-
getCustomLineItems
If not given
lineItems
must not be empty.- Returns:
- customLineItems
-
getTotalPrice
- Returns:
- totalPrice
-
getTaxedPrice
Order Import does not support calculation of taxes. When setting the draft the taxedPrice is to be provided.
- Returns:
- taxedPrice
-
getShippingAddress
- Returns:
- shippingAddress
-
getBillingAddress
- Returns:
- billingAddress
-
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
A two-digit country code as per ISO 3166-1 alpha-2. Used for product variant price selection.
- Returns:
- country
-
getOrderState
If not given the
Open
state will be assigned by default.- Returns:
- orderState
-
getState
This reference can point to a state in a custom workflow.
- Returns:
- state
-
getShipmentState
- Returns:
- shipmentState
-
getPaymentState
- Returns:
- paymentState
-
getShippingInfo
Set if the ShippingMethod is set.
- Returns:
- shippingInfo
-
getPaymentInfo
- Returns:
- paymentInfo
-
getCompletedAt
- Returns:
- completedAt
-
getCustom
The custom fields.
- Specified by:
getCustom
in interfaceCustomizableDraft<OrderImportDraft>
- Returns:
- custom
-
getInventoryMode
If not given the mode
None
will be assigned by default.- Returns:
- inventoryMode
-
getTaxRoundingMode
If not given the tax rounding mode
HalfEven
will be assigned by default.- Returns:
- taxRoundingMode
-
getItemShippingAddresses
Contains addresses for orders with multiple shipping addresses.
- Returns:
- itemShippingAddresses
-
getBusinessUnit
The Business Unit the Cart belongs to.
- Returns:
- businessUnit
-
getStore
- Returns:
- store
-
getOrigin
The default origin is
Customer
.- Returns:
- origin
-
setOrderNumber
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
If given the customer with that ID must exist in the project.
- Parameters:
customerId
- value to be set
-
setCustomerEmail
The customer email can be used when no check against existing Customers is desired during order import.
- Parameters:
customerEmail
- value to be set
-
setLineItems
If not given
customLineItems
must not be empty.- Parameters:
lineItems
- values to be set
-
setLineItems
If not given
customLineItems
must not be empty.- Parameters:
lineItems
- values to be set
-
setCustomLineItems
If not given
lineItems
must not be empty.- Parameters:
customLineItems
- values to be set
-
setCustomLineItems
If not given
lineItems
must not be empty.- Parameters:
customLineItems
- values to be set
-
setTotalPrice
set totalPrice- Parameters:
totalPrice
- value to be set
-
setTaxedPrice
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
set shippingAddress- Parameters:
shippingAddress
- value to be set
-
setBillingAddress
set billingAddress- Parameters:
billingAddress
- value to be set
-
setCustomerGroup
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
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
If not given the
Open
state will be assigned by default.- Parameters:
orderState
- value to be set
-
setState
This reference can point to a state in a custom workflow.
- Parameters:
state
- value to be set
-
setShipmentState
set shipmentState- Parameters:
shipmentState
- value to be set
-
setPaymentState
set paymentState- Parameters:
paymentState
- value to be set
-
setShippingInfo
Set if the ShippingMethod is set.
- Parameters:
shippingInfo
- value to be set
-
setPaymentInfo
set paymentInfo- Parameters:
paymentInfo
- value to be set
-
setCompletedAt
set completedAt- Parameters:
completedAt
- value to be set
-
setCustom
The custom fields.
- Specified by:
setCustom
in interfaceCustomizableDraft<OrderImportDraft>
- Parameters:
custom
- value to be set
-
setInventoryMode
If not given the mode
None
will be assigned by default.- Parameters:
inventoryMode
- value to be set
-
setTaxRoundingMode
If not given the tax rounding mode
HalfEven
will be assigned by default.- Parameters:
taxRoundingMode
- value to be set
-
setItemShippingAddresses
Contains addresses for orders with multiple shipping addresses.
- Parameters:
itemShippingAddresses
- values to be set
-
setItemShippingAddresses
Contains addresses for orders with multiple shipping addresses.
- Parameters:
itemShippingAddresses
- values to be set
-
setBusinessUnit
The Business Unit the Cart belongs to.
- Parameters:
businessUnit
- value to be set
-
setStore
set store- Parameters:
store
- value to be set
-
setOrigin
The default origin is
Customer
.- Parameters:
origin
- value to be set
-
of
factory method- Returns:
- instance of OrderImportDraft
-
of
factory method to create a shallow copy OrderImportDraft- Parameters:
template
- instance to be copied- Returns:
- copy instance
-
deepCopy
factory method to create a deep copy of OrderImportDraft- Parameters:
template
- instance to be copied- Returns:
- copy instance
-
builder
builder factory method for OrderImportDraft- Returns:
- builder
-
builder
create builder for OrderImportDraft instance- Parameters:
template
- instance with prefilled values for the builder- Returns:
- builder
-
withOrderImportDraft
accessor map function- Type Parameters:
T
- mapped type- Parameters:
helper
- function to map the object- Returns:
- mapped value
-
typeReference
gives a TypeReference for usage with Jackson DataBind- Returns:
- TypeReference
-