Class OrderImportDraftBuilder
- All Implemented Interfaces:
io.vrap.rmf.base.client.Builder<OrderImportDraft>
Example to create an instance using the builder pattern
OrderImportDraft orderImportDraft = OrderImportDraft.builder()
.totalPrice(totalPriceBuilder -> totalPriceBuilder)
.build()
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionIf not givenlineItems
must not be empty.Contains addresses for orders with multiple shipping addresses.If not givencustomLineItems
must not be empty.billingAddress
(BaseAddress billingAddress) set the value to the billingAddressset the value to the billingAddress using the builder functionbuild()
builds OrderImportDraft with checking for non-null required valuesbuilds OrderImportDraft without checking for non-null required valuesbusinessUnit
(BusinessUnitResourceIdentifier businessUnit) The Business Unit the Cart belongs to.businessUnit
(Function<BusinessUnitResourceIdentifierBuilder, BusinessUnitResourceIdentifierBuilder> builder) The Business Unit the Cart belongs to.completedAt
(ZonedDateTime completedAt) set the value to the completedAtA two-digit country code as per ISO 3166-1 alpha-2.custom
(CustomFieldsDraft custom) The custom fields.The custom fields.customerEmail
(String customerEmail) The customer email can be used when no check against existing Customers is desired during order import.customerGroup
(CustomerGroupResourceIdentifier customerGroup) Set when the customer is set and the customer is a member of a customer group.customerGroup
(Function<CustomerGroupResourceIdentifierBuilder, CustomerGroupResourceIdentifierBuilder> builder) Set when the customer is set and the customer is a member of a customer group.customerId
(String customerId) If given the customer with that ID must exist in the project.customLineItems
(CustomLineItemImportDraft... customLineItems) If not givenlineItems
must not be empty.customLineItems
(List<CustomLineItemImportDraft> customLineItems) If not givenlineItems
must not be empty.value of billingAddress}The Business Unit the Cart belongs to.value of completedAt}A two-digit country code as per ISO 3166-1 alpha-2.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.If not givenlineItems
must not be empty.If not given the modeNone
will be assigned by default.Contains addresses for orders with multiple shipping addresses.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
.value of paymentInfo}value of paymentState}value of shipmentState}value of shippingAddress}Set if the ShippingMethod is set.getState()
This reference can point to a state in a custom workflow.getStore()
value of store}Order Import does not support calculation of taxes.If not given the tax rounding modeHalfEven
will be assigned by default.value of totalPrice}inventoryMode
(InventoryMode inventoryMode) If not given the modeNone
will be assigned by default.itemShippingAddresses
(BaseAddress... itemShippingAddresses) Contains addresses for orders with multiple shipping addresses.itemShippingAddresses
(List<BaseAddress> itemShippingAddresses) Contains addresses for orders with multiple shipping addresses.lineItems
(LineItemImportDraft... lineItems) If not givencustomLineItems
must not be empty.lineItems
(List<LineItemImportDraft> lineItems) If not givencustomLineItems
must not be empty.static OrderImportDraftBuilder
of()
factory method for an instance of OrderImportDraftBuilderstatic OrderImportDraftBuilder
of
(OrderImportDraft template) create builder for OrderImportDraft instanceorderNumber
(String orderNumber) String that unique identifies an order.orderState
(OrderState orderState) If not given theOpen
state will be assigned by default.origin
(CartOrigin origin) The default origin isCustomer
.paymentInfo
(PaymentInfo paymentInfo) set the value to the paymentInfoset the value to the paymentInfo using the builder functionpaymentState
(PaymentState paymentState) set the value to the paymentStateplusCustomLineItems
(CustomLineItemImportDraft... customLineItems) If not givenlineItems
must not be empty.plusCustomLineItems
(Function<CustomLineItemImportDraftBuilder, CustomLineItemImportDraftBuilder> builder) If not givenlineItems
must not be empty.plusItemShippingAddresses
(BaseAddress... itemShippingAddresses) Contains addresses for orders with multiple shipping addresses.Contains addresses for orders with multiple shipping addresses.plusLineItems
(LineItemImportDraft... lineItems) If not givencustomLineItems
must not be empty.If not givencustomLineItems
must not be empty.If not givenlineItems
must not be empty.Contains addresses for orders with multiple shipping addresses.If not givencustomLineItems
must not be empty.shipmentState
(ShipmentState shipmentState) set the value to the shipmentStateshippingAddress
(BaseAddress shippingAddress) set the value to the shippingAddressset the value to the shippingAddress using the builder functionshippingInfo
(ShippingInfoImportDraft shippingInfo) Set if the ShippingMethod is set.Set if the ShippingMethod is set.state
(StateReference state) This reference can point to a state in a custom workflow.This reference can point to a state in a custom workflow.store
(StoreResourceIdentifier store) set the value to the storeset the value to the store using the builder functiontaxedPrice
(TaxedPriceDraft taxedPrice) Order Import does not support calculation of taxes.Order Import does not support calculation of taxes.taxRoundingMode
(RoundingMode taxRoundingMode) If not given the tax rounding modeHalfEven
will be assigned by default.totalPrice
(Money totalPrice) set the value to the totalPricetotalPrice
(Function<MoneyBuilder, MoneyBuilder> builder) set the value to the totalPrice using the builder functionset the value to the billingAddress using the builder functionwithBusinessUnit
(Function<BusinessUnitResourceIdentifierBuilder, BusinessUnitResourceIdentifier> builder) The Business Unit the Cart belongs to.The custom fields.withCustomerGroup
(Function<CustomerGroupResourceIdentifierBuilder, CustomerGroupResourceIdentifier> builder) Set when the customer is set and the customer is a member of a customer group.withCustomLineItems
(Function<CustomLineItemImportDraftBuilder, CustomLineItemImportDraftBuilder> builder) If not givenlineItems
must not be empty.Contains addresses for orders with multiple shipping addresses.If not givencustomLineItems
must not be empty.withPaymentInfo
(Function<PaymentInfoBuilder, PaymentInfo> builder) set the value to the paymentInfo using the builder functionset the value to the shippingAddress using the builder functionSet if the ShippingMethod is set.withState
(Function<StateReferenceBuilder, StateReference> builder) This reference can point to a state in a custom workflow.set the value to the store using the builder functionOrder Import does not support calculation of taxes.withTotalPrice
(Function<MoneyBuilder, Money> builder) set the value to the totalPrice using the builder function
-
Constructor Details
-
OrderImportDraftBuilder
public OrderImportDraftBuilder()
-
-
Method Details
-
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- Returns:
- Builder
-
customerId
If given the customer with that ID must exist in the project.
- Parameters:
customerId
- value to be set- Returns:
- Builder
-
customerEmail
The customer email can be used when no check against existing Customers is desired during order import.
- Parameters:
customerEmail
- value to be set- Returns:
- Builder
-
lineItems
If not given
customLineItems
must not be empty.- Parameters:
lineItems
- value to be set- Returns:
- Builder
-
lineItems
If not given
customLineItems
must not be empty.- Parameters:
lineItems
- value to be set- Returns:
- Builder
-
plusLineItems
If not given
customLineItems
must not be empty.- Parameters:
lineItems
- value to be set- Returns:
- Builder
-
plusLineItems
public OrderImportDraftBuilder plusLineItems(Function<LineItemImportDraftBuilder, LineItemImportDraftBuilder> builder) If not given
customLineItems
must not be empty.- Parameters:
builder
- function to build the lineItems value- Returns:
- Builder
-
withLineItems
public OrderImportDraftBuilder withLineItems(Function<LineItemImportDraftBuilder, LineItemImportDraftBuilder> builder) If not given
customLineItems
must not be empty.- Parameters:
builder
- function to build the lineItems value- Returns:
- Builder
-
addLineItems
public OrderImportDraftBuilder addLineItems(Function<LineItemImportDraftBuilder, LineItemImportDraft> builder) If not given
customLineItems
must not be empty.- Parameters:
builder
- function to build the lineItems value- Returns:
- Builder
-
setLineItems
public OrderImportDraftBuilder setLineItems(Function<LineItemImportDraftBuilder, LineItemImportDraft> builder) If not given
customLineItems
must not be empty.- Parameters:
builder
- function to build the lineItems value- Returns:
- Builder
-
customLineItems
public OrderImportDraftBuilder customLineItems(@Nullable CustomLineItemImportDraft... customLineItems) If not given
lineItems
must not be empty.- Parameters:
customLineItems
- value to be set- Returns:
- Builder
-
customLineItems
public OrderImportDraftBuilder customLineItems(@Nullable List<CustomLineItemImportDraft> customLineItems) If not given
lineItems
must not be empty.- Parameters:
customLineItems
- value to be set- Returns:
- Builder
-
plusCustomLineItems
public OrderImportDraftBuilder plusCustomLineItems(@Nullable CustomLineItemImportDraft... customLineItems) If not given
lineItems
must not be empty.- Parameters:
customLineItems
- value to be set- Returns:
- Builder
-
plusCustomLineItems
public OrderImportDraftBuilder plusCustomLineItems(Function<CustomLineItemImportDraftBuilder, CustomLineItemImportDraftBuilder> builder) If not given
lineItems
must not be empty.- Parameters:
builder
- function to build the customLineItems value- Returns:
- Builder
-
withCustomLineItems
public OrderImportDraftBuilder withCustomLineItems(Function<CustomLineItemImportDraftBuilder, CustomLineItemImportDraftBuilder> builder) If not given
lineItems
must not be empty.- Parameters:
builder
- function to build the customLineItems value- Returns:
- Builder
-
addCustomLineItems
public OrderImportDraftBuilder addCustomLineItems(Function<CustomLineItemImportDraftBuilder, CustomLineItemImportDraft> builder) If not given
lineItems
must not be empty.- Parameters:
builder
- function to build the customLineItems value- Returns:
- Builder
-
setCustomLineItems
public OrderImportDraftBuilder setCustomLineItems(Function<CustomLineItemImportDraftBuilder, CustomLineItemImportDraft> builder) If not given
lineItems
must not be empty.- Parameters:
builder
- function to build the customLineItems value- Returns:
- Builder
-
totalPrice
set the value to the totalPrice using the builder function- Parameters:
builder
- function to build the totalPrice value- Returns:
- Builder
-
withTotalPrice
set the value to the totalPrice using the builder function- Parameters:
builder
- function to build the totalPrice value- Returns:
- Builder
-
totalPrice
set the value to the totalPrice- Parameters:
totalPrice
- value to be set- Returns:
- Builder
-
taxedPrice
public OrderImportDraftBuilder taxedPrice(Function<TaxedPriceDraftBuilder, TaxedPriceDraftBuilder> builder) Order Import does not support calculation of taxes. When setting the draft the taxedPrice is to be provided.
- Parameters:
builder
- function to build the taxedPrice value- Returns:
- Builder
-
withTaxedPrice
public OrderImportDraftBuilder withTaxedPrice(Function<TaxedPriceDraftBuilder, TaxedPriceDraft> builder) Order Import does not support calculation of taxes. When setting the draft the taxedPrice is to be provided.
- Parameters:
builder
- function to build the taxedPrice value- Returns:
- Builder
-
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- Returns:
- Builder
-
shippingAddress
public OrderImportDraftBuilder shippingAddress(Function<BaseAddressBuilder, BaseAddressBuilder> builder) set the value to the shippingAddress using the builder function- Parameters:
builder
- function to build the shippingAddress value- Returns:
- Builder
-
withShippingAddress
public OrderImportDraftBuilder withShippingAddress(Function<BaseAddressBuilder, BaseAddress> builder) set the value to the shippingAddress using the builder function- Parameters:
builder
- function to build the shippingAddress value- Returns:
- Builder
-
shippingAddress
set the value to the shippingAddress- Parameters:
shippingAddress
- value to be set- Returns:
- Builder
-
billingAddress
public OrderImportDraftBuilder billingAddress(Function<BaseAddressBuilder, BaseAddressBuilder> builder) set the value to the billingAddress using the builder function- Parameters:
builder
- function to build the billingAddress value- Returns:
- Builder
-
withBillingAddress
set the value to the billingAddress using the builder function- Parameters:
builder
- function to build the billingAddress value- Returns:
- Builder
-
billingAddress
set the value to the billingAddress- Parameters:
billingAddress
- value to be set- Returns:
- Builder
-
customerGroup
public OrderImportDraftBuilder customerGroup(Function<CustomerGroupResourceIdentifierBuilder, CustomerGroupResourceIdentifierBuilder> builder) Set when the customer is set and the customer is a member of a customer group. Used for product variant price selection.
- Parameters:
builder
- function to build the customerGroup value- Returns:
- Builder
-
withCustomerGroup
public OrderImportDraftBuilder withCustomerGroup(Function<CustomerGroupResourceIdentifierBuilder, CustomerGroupResourceIdentifier> builder) Set when the customer is set and the customer is a member of a customer group. Used for product variant price selection.
- Parameters:
builder
- function to build the customerGroup value- Returns:
- Builder
-
customerGroup
public OrderImportDraftBuilder customerGroup(@Nullable 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- Returns:
- Builder
-
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- Returns:
- Builder
-
orderState
If not given the
Open
state will be assigned by default.- Parameters:
orderState
- value to be set- Returns:
- Builder
-
state
This reference can point to a state in a custom workflow.
- Parameters:
builder
- function to build the state value- Returns:
- Builder
-
withState
This reference can point to a state in a custom workflow.
- Parameters:
builder
- function to build the state value- Returns:
- Builder
-
state
This reference can point to a state in a custom workflow.
- Parameters:
state
- value to be set- Returns:
- Builder
-
shipmentState
set the value to the shipmentState- Parameters:
shipmentState
- value to be set- Returns:
- Builder
-
paymentState
set the value to the paymentState- Parameters:
paymentState
- value to be set- Returns:
- Builder
-
shippingInfo
public OrderImportDraftBuilder shippingInfo(Function<ShippingInfoImportDraftBuilder, ShippingInfoImportDraftBuilder> builder) Set if the ShippingMethod is set.
- Parameters:
builder
- function to build the shippingInfo value- Returns:
- Builder
-
withShippingInfo
public OrderImportDraftBuilder withShippingInfo(Function<ShippingInfoImportDraftBuilder, ShippingInfoImportDraft> builder) Set if the ShippingMethod is set.
- Parameters:
builder
- function to build the shippingInfo value- Returns:
- Builder
-
shippingInfo
Set if the ShippingMethod is set.
- Parameters:
shippingInfo
- value to be set- Returns:
- Builder
-
paymentInfo
set the value to the paymentInfo using the builder function- Parameters:
builder
- function to build the paymentInfo value- Returns:
- Builder
-
withPaymentInfo
set the value to the paymentInfo using the builder function- Parameters:
builder
- function to build the paymentInfo value- Returns:
- Builder
-
paymentInfo
set the value to the paymentInfo- Parameters:
paymentInfo
- value to be set- Returns:
- Builder
-
completedAt
set the value to the completedAt- Parameters:
completedAt
- value to be set- Returns:
- Builder
-
custom
public OrderImportDraftBuilder custom(Function<CustomFieldsDraftBuilder, CustomFieldsDraftBuilder> builder) The custom fields.
- Parameters:
builder
- function to build the custom value- Returns:
- Builder
-
withCustom
public OrderImportDraftBuilder withCustom(Function<CustomFieldsDraftBuilder, CustomFieldsDraft> builder) The custom fields.
- Parameters:
builder
- function to build the custom value- Returns:
- Builder
-
custom
The custom fields.
- Parameters:
custom
- value to be set- Returns:
- Builder
-
inventoryMode
If not given the mode
None
will be assigned by default.- Parameters:
inventoryMode
- value to be set- Returns:
- Builder
-
taxRoundingMode
If not given the tax rounding mode
HalfEven
will be assigned by default.- Parameters:
taxRoundingMode
- value to be set- Returns:
- Builder
-
itemShippingAddresses
public OrderImportDraftBuilder itemShippingAddresses(@Nullable BaseAddress... itemShippingAddresses) Contains addresses for orders with multiple shipping addresses.
- Parameters:
itemShippingAddresses
- value to be set- Returns:
- Builder
-
itemShippingAddresses
public OrderImportDraftBuilder itemShippingAddresses(@Nullable List<BaseAddress> itemShippingAddresses) Contains addresses for orders with multiple shipping addresses.
- Parameters:
itemShippingAddresses
- value to be set- Returns:
- Builder
-
plusItemShippingAddresses
public OrderImportDraftBuilder plusItemShippingAddresses(@Nullable BaseAddress... itemShippingAddresses) Contains addresses for orders with multiple shipping addresses.
- Parameters:
itemShippingAddresses
- value to be set- Returns:
- Builder
-
plusItemShippingAddresses
public OrderImportDraftBuilder plusItemShippingAddresses(Function<BaseAddressBuilder, BaseAddressBuilder> builder) Contains addresses for orders with multiple shipping addresses.
- Parameters:
builder
- function to build the itemShippingAddresses value- Returns:
- Builder
-
withItemShippingAddresses
public OrderImportDraftBuilder withItemShippingAddresses(Function<BaseAddressBuilder, BaseAddressBuilder> builder) Contains addresses for orders with multiple shipping addresses.
- Parameters:
builder
- function to build the itemShippingAddresses value- Returns:
- Builder
-
addItemShippingAddresses
public OrderImportDraftBuilder addItemShippingAddresses(Function<BaseAddressBuilder, BaseAddress> builder) Contains addresses for orders with multiple shipping addresses.
- Parameters:
builder
- function to build the itemShippingAddresses value- Returns:
- Builder
-
setItemShippingAddresses
public OrderImportDraftBuilder setItemShippingAddresses(Function<BaseAddressBuilder, BaseAddress> builder) Contains addresses for orders with multiple shipping addresses.
- Parameters:
builder
- function to build the itemShippingAddresses value- Returns:
- Builder
-
businessUnit
public OrderImportDraftBuilder businessUnit(Function<BusinessUnitResourceIdentifierBuilder, BusinessUnitResourceIdentifierBuilder> builder) The Business Unit the Cart belongs to.
- Parameters:
builder
- function to build the businessUnit value- Returns:
- Builder
-
withBusinessUnit
public OrderImportDraftBuilder withBusinessUnit(Function<BusinessUnitResourceIdentifierBuilder, BusinessUnitResourceIdentifier> builder) The Business Unit the Cart belongs to.
- Parameters:
builder
- function to build the businessUnit value- Returns:
- Builder
-
businessUnit
The Business Unit the Cart belongs to.
- Parameters:
businessUnit
- value to be set- Returns:
- Builder
-
store
public OrderImportDraftBuilder store(Function<StoreResourceIdentifierBuilder, StoreResourceIdentifierBuilder> builder) set the value to the store using the builder function- Parameters:
builder
- function to build the store value- Returns:
- Builder
-
withStore
public OrderImportDraftBuilder withStore(Function<StoreResourceIdentifierBuilder, StoreResourceIdentifier> builder) set the value to the store using the builder function- Parameters:
builder
- function to build the store value- Returns:
- Builder
-
store
set the value to the store- Parameters:
store
- value to be set- Returns:
- Builder
-
origin
The default origin is
Customer
.- Parameters:
origin
- value to be set- Returns:
- Builder
-
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
value of totalPrice}- Returns:
- totalPrice
-
getTaxedPrice
Order Import does not support calculation of taxes. When setting the draft the taxedPrice is to be provided.
- Returns:
- taxedPrice
-
getShippingAddress
value of shippingAddress}- Returns:
- shippingAddress
-
getBillingAddress
value of billingAddress}- 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
value of shipmentState}- Returns:
- shipmentState
-
getPaymentState
value of paymentState}- Returns:
- paymentState
-
getShippingInfo
Set if the ShippingMethod is set.
- Returns:
- shippingInfo
-
getPaymentInfo
value of paymentInfo}- Returns:
- paymentInfo
-
getCompletedAt
value of completedAt}- Returns:
- completedAt
-
getCustom
The custom fields.
- 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
value of store}- Returns:
- store
-
getOrigin
The default origin is
Customer
.- Returns:
- origin
-
build
builds OrderImportDraft with checking for non-null required values- Specified by:
build
in interfaceio.vrap.rmf.base.client.Builder<OrderImportDraft>
- Returns:
- OrderImportDraft
-
buildUnchecked
builds OrderImportDraft without checking for non-null required values- Returns:
- OrderImportDraft
-
of
factory method for an instance of OrderImportDraftBuilder- Returns:
- builder
-
of
create builder for OrderImportDraft instance- Parameters:
template
- instance with prefilled values for the builder- Returns:
- builder
-