Package com.commercetools.api.models.quote_request

Class QuoteRequestBuilder

java.lang.Object

com.commercetools.api.models.quote_request.QuoteRequestBuilder

All Implemented Interfaces:

io.vrap.rmf.base.client.Builder<QuoteRequest>

public class QuoteRequestBuilder
extends Object
implements io.vrap.rmf.base.client.Builder<QuoteRequest>

QuoteRequestBuilder Example to create an instance using the builder pattern

     QuoteRequest quoteRequest = QuoteRequest.builder()
             .id("{id}")
             .version(0.3)
             .createdAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .lastModifiedAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .quoteRequestState(QuoteRequestState.SUBMITTED)
             .customer(customerBuilder -> customerBuilder)
             .plusLineItems(lineItemsBuilder -> lineItemsBuilder)
             .plusCustomLineItems(customLineItemsBuilder -> customLineItemsBuilder)
             .totalPrice(totalPriceBuilder -> totalPriceBuilder)
             .taxMode(TaxMode.PLATFORM)
             .taxRoundingMode(RoundingMode.HALF_EVEN)
             .taxCalculationMode(TaxCalculationMode.LINE_ITEM_LEVEL)
             .build()
 

Constructor Summary

Constructors

Constructor	Description
QuoteRequestBuilder()

Method Summary

Modifier and Type	Method	Description
QuoteRequestBuilder	addCustomLineItems(Function<CustomLineItemBuilder,CustomLineItem> builder)	The Custom Line Items for which a Quote is requested.
QuoteRequestBuilder	addDirectDiscounts(Function<DirectDiscountBuilder,DirectDiscount> builder)	Discounts that are only valid for the Quote and cannot be associated to any other Cart or Order.
QuoteRequestBuilder	addItemShippingAddresses(Function<AddressBuilder,Address> builder)	Contains addresses for carts with multiple shipping addresses.
QuoteRequestBuilder	addLineItems(Function<LineItemBuilder,LineItem> builder)	The Line Items for which a Quote is requested.
QuoteRequestBuilder	billingAddress(Address billingAddress)	Address used for invoicing.
QuoteRequestBuilder	billingAddress(Function<AddressBuilder,AddressBuilder> builder)	Address used for invoicing.
QuoteRequest	build()	builds QuoteRequest with checking for non-null required values
QuoteRequest	buildUnchecked()	builds QuoteRequest without checking for non-null required values
QuoteRequestBuilder	businessUnit(BusinessUnitKeyReference businessUnit)	The BusinessUnit for the Quote Request.
QuoteRequestBuilder	businessUnit(Function<BusinessUnitKeyReferenceBuilder,BusinessUnitKeyReferenceBuilder> builder)	The BusinessUnit for the Quote Request.
QuoteRequestBuilder	comment(String comment)	Message from the Buyer included in the Quote Request.
QuoteRequestBuilder	country(String country)	Used for Product Variant price selection.
QuoteRequestBuilder	createdAt(ZonedDateTime createdAt)	Date and time (UTC) the QuoteRequest was initially created.
QuoteRequestBuilder	createdBy(CreatedBy createdBy)	Present on resources created after 1 February 2019 except for events not tracked.
QuoteRequestBuilder	createdBy(Function<CreatedByBuilder,CreatedByBuilder> builder)	Present on resources created after 1 February 2019 except for events not tracked.
QuoteRequestBuilder	custom(CustomFields custom)	Custom Fields of the Quote Request.
QuoteRequestBuilder	custom(Function<CustomFieldsBuilder,CustomFieldsBuilder> builder)	Custom Fields of the Quote Request.
QuoteRequestBuilder	customer(CustomerReference customer)	The Buyer who owns the request.
QuoteRequestBuilder	customer(Function<CustomerReferenceBuilder,CustomerReferenceBuilder> builder)	The Buyer who owns the request.
QuoteRequestBuilder	customerGroup(CustomerGroupReference customerGroup)	Set automatically when customer is set and the Customer is a member of a Customer Group.
QuoteRequestBuilder	customerGroup(Function<CustomerGroupReferenceBuilder,CustomerGroupReferenceBuilder> builder)	Set automatically when customer is set and the Customer is a member of a Customer Group.
QuoteRequestBuilder	customLineItems(CustomLineItem... customLineItems)	The Custom Line Items for which a Quote is requested.
QuoteRequestBuilder	customLineItems(List<CustomLineItem> customLineItems)	The Custom Line Items for which a Quote is requested.
QuoteRequestBuilder	directDiscounts(DirectDiscount... directDiscounts)	Discounts that are only valid for the Quote and cannot be associated to any other Cart or Order.
QuoteRequestBuilder	directDiscounts(List<DirectDiscount> directDiscounts)	Discounts that are only valid for the Quote and cannot be associated to any other Cart or Order.
Address	getBillingAddress()	Address used for invoicing.
BusinessUnitKeyReference	getBusinessUnit()	The BusinessUnit for the Quote Request.
String	getComment()	Message from the Buyer included in the Quote Request.
String	getCountry()	Used for Product Variant price selection.
ZonedDateTime	getCreatedAt()	Date and time (UTC) the QuoteRequest was initially created.
CreatedBy	getCreatedBy()	Present on resources created after 1 February 2019 except for events not tracked.
CustomFields	getCustom()	Custom Fields of the Quote Request.
CustomerReference	getCustomer()	The Buyer who owns the request.
CustomerGroupReference	getCustomerGroup()	Set automatically when customer is set and the Customer is a member of a Customer Group.
List<CustomLineItem>	getCustomLineItems()	The Custom Line Items for which a Quote is requested.
List<DirectDiscount>	getDirectDiscounts()	Discounts that are only valid for the Quote and cannot be associated to any other Cart or Order.
String	getId()	Unique identifier of the QuoteRequest.
InventoryMode	getInventoryMode()	Inventory mode of the Cart referenced in the QuoteRequestDraft.
List<Address>	getItemShippingAddresses()	Contains addresses for carts with multiple shipping addresses.
String	getKey()	User-defined unique identifier of the QuoteRequest.
ZonedDateTime	getLastModifiedAt()	Date and time (UTC) the QuoteRequest was last updated.
LastModifiedBy	getLastModifiedBy()	Present on resources created after 1 February 2019 except for events not tracked.
List<LineItem>	getLineItems()	The Line Items for which a Quote is requested.
PaymentInfo	getPaymentInfo()	Log of payment transactions related to the Quote.
String	getPurchaseOrderNumber()	Identifier for a purchase order, usually in a B2B context.
QuoteRequestState	getQuoteRequestState()	Indicates the current state of the Quote Request in the negotiation process.
Address	getShippingAddress()	Used to determine the eligible ShippingMethods and rates as well as the tax rate of the Line Items.
ShippingInfo	getShippingInfo()	Set automatically once the ShippingMethod is set.
ShippingRateInput	getShippingRateInput()	Used to select a ShippingRatePriceTier.
StateReference	getState()	State of the Quote Request.
StoreKeyReference	getStore()	The Store to which the Buyer belongs.
TaxCalculationMode	getTaxCalculationMode()	When calculating taxes for taxedPrice, the selected mode is used for calculating the price with LineItemLevel (horizontally) or UnitPriceLevel (vertically) calculation mode.
TaxedPrice	getTaxedPrice()	Not set until the shipping address is set.
TaxMode	getTaxMode()	Tax mode of the Cart referenced in the QuoteRequestDraft.
RoundingMode	getTaxRoundingMode()	When calculating taxes for taxedPrice, the selected mode is used for rounding.
TypedMoney	getTotalPrice()	Sum of all totalPrice fields of the lineItems and customLineItems, as well as the price field of shippingInfo (if it exists).
Long	getVersion()	Current version of the QuoteRequest.
QuoteRequestBuilder	id(String id)	Unique identifier of the QuoteRequest.
QuoteRequestBuilder	inventoryMode(InventoryMode inventoryMode)	Inventory mode of the Cart referenced in the QuoteRequestDraft.
QuoteRequestBuilder	itemShippingAddresses(Address... itemShippingAddresses)	Contains addresses for carts with multiple shipping addresses.
QuoteRequestBuilder	itemShippingAddresses(List<Address> itemShippingAddresses)	Contains addresses for carts with multiple shipping addresses.
QuoteRequestBuilder	key(String key)	User-defined unique identifier of the QuoteRequest.
QuoteRequestBuilder	lastModifiedAt(ZonedDateTime lastModifiedAt)	Date and time (UTC) the QuoteRequest was last updated.
QuoteRequestBuilder	lastModifiedBy(LastModifiedBy lastModifiedBy)	Present on resources created after 1 February 2019 except for events not tracked.
QuoteRequestBuilder	lastModifiedBy(Function<LastModifiedByBuilder,LastModifiedByBuilder> builder)	Present on resources created after 1 February 2019 except for events not tracked.
QuoteRequestBuilder	lineItems(LineItem... lineItems)	The Line Items for which a Quote is requested.
QuoteRequestBuilder	lineItems(List<LineItem> lineItems)	The Line Items for which a Quote is requested.
static QuoteRequestBuilder	of()	factory method for an instance of QuoteRequestBuilder
static QuoteRequestBuilder	of(QuoteRequest template)	create builder for QuoteRequest instance
QuoteRequestBuilder	paymentInfo(PaymentInfo paymentInfo)	Log of payment transactions related to the Quote.
QuoteRequestBuilder	paymentInfo(Function<PaymentInfoBuilder,PaymentInfoBuilder> builder)	Log of payment transactions related to the Quote.
QuoteRequestBuilder	plusCustomLineItems(CustomLineItem... customLineItems)	The Custom Line Items for which a Quote is requested.
QuoteRequestBuilder	plusCustomLineItems(Function<CustomLineItemBuilder,CustomLineItemBuilder> builder)	The Custom Line Items for which a Quote is requested.
QuoteRequestBuilder	plusDirectDiscounts(DirectDiscount... directDiscounts)	Discounts that are only valid for the Quote and cannot be associated to any other Cart or Order.
QuoteRequestBuilder	plusDirectDiscounts(Function<DirectDiscountBuilder,DirectDiscountBuilder> builder)	Discounts that are only valid for the Quote and cannot be associated to any other Cart or Order.
QuoteRequestBuilder	plusItemShippingAddresses(Address... itemShippingAddresses)	Contains addresses for carts with multiple shipping addresses.
QuoteRequestBuilder	plusItemShippingAddresses(Function<AddressBuilder,AddressBuilder> builder)	Contains addresses for carts with multiple shipping addresses.
QuoteRequestBuilder	plusLineItems(LineItem... lineItems)	The Line Items for which a Quote is requested.
QuoteRequestBuilder	plusLineItems(Function<LineItemBuilder,LineItemBuilder> builder)	The Line Items for which a Quote is requested.
QuoteRequestBuilder	purchaseOrderNumber(String purchaseOrderNumber)	Identifier for a purchase order, usually in a B2B context.
QuoteRequestBuilder	quoteRequestState(QuoteRequestState quoteRequestState)	Indicates the current state of the Quote Request in the negotiation process.
QuoteRequestBuilder	setCustomLineItems(Function<CustomLineItemBuilder,CustomLineItem> builder)	The Custom Line Items for which a Quote is requested.
QuoteRequestBuilder	setDirectDiscounts(Function<DirectDiscountBuilder,DirectDiscount> builder)	Discounts that are only valid for the Quote and cannot be associated to any other Cart or Order.
QuoteRequestBuilder	setItemShippingAddresses(Function<AddressBuilder,Address> builder)	Contains addresses for carts with multiple shipping addresses.
QuoteRequestBuilder	setLineItems(Function<LineItemBuilder,LineItem> builder)	The Line Items for which a Quote is requested.
QuoteRequestBuilder	shippingAddress(Address shippingAddress)	Used to determine the eligible ShippingMethods and rates as well as the tax rate of the Line Items.
QuoteRequestBuilder	shippingAddress(Function<AddressBuilder,AddressBuilder> builder)	Used to determine the eligible ShippingMethods and rates as well as the tax rate of the Line Items.
QuoteRequestBuilder	shippingInfo(ShippingInfo shippingInfo)	Set automatically once the ShippingMethod is set.
QuoteRequestBuilder	shippingInfo(Function<ShippingInfoBuilder,ShippingInfoBuilder> builder)	Set automatically once the ShippingMethod is set.
QuoteRequestBuilder	shippingRateInput(ShippingRateInput shippingRateInput)	Used to select a ShippingRatePriceTier.
QuoteRequestBuilder	shippingRateInput(Function<ShippingRateInputBuilder,io.vrap.rmf.base.client.Builder<? extends ShippingRateInput>> builder)	Used to select a ShippingRatePriceTier.
QuoteRequestBuilder	state(StateReference state)	State of the Quote Request.
QuoteRequestBuilder	state(Function<StateReferenceBuilder,StateReferenceBuilder> builder)	State of the Quote Request.
QuoteRequestBuilder	store(StoreKeyReference store)	The Store to which the Buyer belongs.
QuoteRequestBuilder	store(Function<StoreKeyReferenceBuilder,StoreKeyReferenceBuilder> builder)	The Store to which the Buyer belongs.
QuoteRequestBuilder	taxCalculationMode(TaxCalculationMode taxCalculationMode)	When calculating taxes for taxedPrice, the selected mode is used for calculating the price with LineItemLevel (horizontally) or UnitPriceLevel (vertically) calculation mode.
QuoteRequestBuilder	taxedPrice(TaxedPrice taxedPrice)	Not set until the shipping address is set.
QuoteRequestBuilder	taxedPrice(Function<TaxedPriceBuilder,TaxedPriceBuilder> builder)	Not set until the shipping address is set.
QuoteRequestBuilder	taxMode(TaxMode taxMode)	Tax mode of the Cart referenced in the QuoteRequestDraft.
QuoteRequestBuilder	taxRoundingMode(RoundingMode taxRoundingMode)	When calculating taxes for taxedPrice, the selected mode is used for rounding.
QuoteRequestBuilder	totalPrice(TypedMoney totalPrice)	Sum of all totalPrice fields of the lineItems and customLineItems, as well as the price field of shippingInfo (if it exists).
QuoteRequestBuilder	totalPrice(Function<TypedMoneyBuilder,io.vrap.rmf.base.client.Builder<? extends TypedMoney>> builder)	Sum of all totalPrice fields of the lineItems and customLineItems, as well as the price field of shippingInfo (if it exists).
QuoteRequestBuilder	version(Long version)	Current version of the QuoteRequest.
QuoteRequestBuilder	withBillingAddress(Function<AddressBuilder,Address> builder)	Address used for invoicing.
QuoteRequestBuilder	withBusinessUnit(Function<BusinessUnitKeyReferenceBuilder,BusinessUnitKeyReference> builder)	The BusinessUnit for the Quote Request.
QuoteRequestBuilder	withCreatedBy(Function<CreatedByBuilder,CreatedBy> builder)	Present on resources created after 1 February 2019 except for events not tracked.
QuoteRequestBuilder	withCustom(Function<CustomFieldsBuilder,CustomFields> builder)	Custom Fields of the Quote Request.
QuoteRequestBuilder	withCustomer(Function<CustomerReferenceBuilder,CustomerReference> builder)	The Buyer who owns the request.
QuoteRequestBuilder	withCustomerGroup(Function<CustomerGroupReferenceBuilder,CustomerGroupReference> builder)	Set automatically when customer is set and the Customer is a member of a Customer Group.
QuoteRequestBuilder	withCustomLineItems(Function<CustomLineItemBuilder,CustomLineItemBuilder> builder)	The Custom Line Items for which a Quote is requested.
QuoteRequestBuilder	withDirectDiscounts(Function<DirectDiscountBuilder,DirectDiscountBuilder> builder)	Discounts that are only valid for the Quote and cannot be associated to any other Cart or Order.
QuoteRequestBuilder	withItemShippingAddresses(Function<AddressBuilder,AddressBuilder> builder)	Contains addresses for carts with multiple shipping addresses.
QuoteRequestBuilder	withLastModifiedBy(Function<LastModifiedByBuilder,LastModifiedBy> builder)	Present on resources created after 1 February 2019 except for events not tracked.
QuoteRequestBuilder	withLineItems(Function<LineItemBuilder,LineItemBuilder> builder)	The Line Items for which a Quote is requested.
QuoteRequestBuilder	withPaymentInfo(Function<PaymentInfoBuilder,PaymentInfo> builder)	Log of payment transactions related to the Quote.
QuoteRequestBuilder	withShippingAddress(Function<AddressBuilder,Address> builder)	Used to determine the eligible ShippingMethods and rates as well as the tax rate of the Line Items.
QuoteRequestBuilder	withShippingInfo(Function<ShippingInfoBuilder,ShippingInfo> builder)	Set automatically once the ShippingMethod is set.
QuoteRequestBuilder	withState(Function<StateReferenceBuilder,StateReference> builder)	State of the Quote Request.
QuoteRequestBuilder	withStore(Function<StoreKeyReferenceBuilder,StoreKeyReference> builder)	The Store to which the Buyer belongs.
QuoteRequestBuilder	withTaxedPrice(Function<TaxedPriceBuilder,TaxedPrice> builder)	Not set until the shipping address is set.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

QuoteRequestBuilder

public QuoteRequestBuilder()

Method Details

id

public QuoteRequestBuilder id(String id)

Unique identifier of the QuoteRequest.

Parameters:

id - value to be set

Returns:

Builder

version

public QuoteRequestBuilder version(Long version)

Current version of the QuoteRequest.

Parameters:

version - value to be set

Returns:

Builder

createdAt

public QuoteRequestBuilder createdAt(ZonedDateTime createdAt)

Date and time (UTC) the QuoteRequest was initially created.

Parameters:

createdAt - value to be set

Returns:

Builder

lastModifiedAt

public QuoteRequestBuilder lastModifiedAt(ZonedDateTime lastModifiedAt)

Date and time (UTC) the QuoteRequest was last updated.

Parameters:

lastModifiedAt - value to be set

Returns:

Builder

key

public QuoteRequestBuilder key(@Nullable
 String key)

User-defined unique identifier of the QuoteRequest.

Parameters:

key - value to be set

Returns:

Builder

lastModifiedBy

public QuoteRequestBuilder lastModifiedBy(Function<LastModifiedByBuilder,LastModifiedByBuilder> builder)

Present on resources created after 1 February 2019 except for events not tracked.

Parameters:

builder - function to build the lastModifiedBy value

Returns:

Builder

withLastModifiedBy

public QuoteRequestBuilder withLastModifiedBy(Function<LastModifiedByBuilder,LastModifiedBy> builder)

Present on resources created after 1 February 2019 except for events not tracked.

Parameters:

builder - function to build the lastModifiedBy value

Returns:

Builder

lastModifiedBy

public QuoteRequestBuilder lastModifiedBy(@Nullable
 LastModifiedBy lastModifiedBy)

Present on resources created after 1 February 2019 except for events not tracked.

Parameters:

lastModifiedBy - value to be set

Returns:

Builder

createdBy

public QuoteRequestBuilder createdBy(Function<CreatedByBuilder,CreatedByBuilder> builder)

Present on resources created after 1 February 2019 except for events not tracked.

Parameters:

builder - function to build the createdBy value

Returns:

Builder

withCreatedBy

public QuoteRequestBuilder withCreatedBy(Function<CreatedByBuilder,CreatedBy> builder)

Present on resources created after 1 February 2019 except for events not tracked.

Parameters:

builder - function to build the createdBy value

Returns:

Builder

createdBy

public QuoteRequestBuilder createdBy(@Nullable
 CreatedBy createdBy)

Present on resources created after 1 February 2019 except for events not tracked.

Parameters:

createdBy - value to be set

Returns:

Builder

quoteRequestState

public QuoteRequestBuilder quoteRequestState(QuoteRequestState quoteRequestState)

Indicates the current state of the Quote Request in the negotiation process.

Parameters:

quoteRequestState - value to be set

Returns:

Builder

comment

public QuoteRequestBuilder comment(@Nullable
 String comment)

Message from the Buyer included in the Quote Request.

Parameters:

comment - value to be set

Returns:

Builder

customer

public QuoteRequestBuilder customer(Function<CustomerReferenceBuilder,CustomerReferenceBuilder> builder)

The Buyer who owns the request.

Parameters:

builder - function to build the customer value

Returns:

Builder

withCustomer

public QuoteRequestBuilder withCustomer(Function<CustomerReferenceBuilder,CustomerReference> builder)

The Buyer who owns the request.

Parameters:

builder - function to build the customer value

Returns:

Builder

customer

public QuoteRequestBuilder customer(CustomerReference customer)

The Buyer who owns the request.

Parameters:

customer - value to be set

Returns:

Builder

customerGroup

public QuoteRequestBuilder customerGroup(Function<CustomerGroupReferenceBuilder,CustomerGroupReferenceBuilder> builder)

Set automatically when customer is set and the Customer is a member of a Customer Group. Not updated if Customer is changed after Quote Request creation. Used for Product Variant price selection.

Parameters:

builder - function to build the customerGroup value

Returns:

Builder

withCustomerGroup

public QuoteRequestBuilder withCustomerGroup(Function<CustomerGroupReferenceBuilder,CustomerGroupReference> builder)

Set automatically when customer is set and the Customer is a member of a Customer Group. Not updated if Customer is changed after Quote Request creation. Used for Product Variant price selection.

Parameters:

builder - function to build the customerGroup value

Returns:

Builder

customerGroup

public QuoteRequestBuilder customerGroup(@Nullable
 CustomerGroupReference customerGroup)

Set automatically when customer is set and the Customer is a member of a Customer Group. Not updated if Customer is changed after Quote Request creation. Used for Product Variant price selection.

Parameters:

customerGroup - value to be set

Returns:

Builder

store

public QuoteRequestBuilder store(Function<StoreKeyReferenceBuilder,StoreKeyReferenceBuilder> builder)

The Store to which the Buyer belongs.

Parameters:

builder - function to build the store value

Returns:

Builder

withStore

public QuoteRequestBuilder withStore(Function<StoreKeyReferenceBuilder,StoreKeyReference> builder)

The Store to which the Buyer belongs.

Parameters:

builder - function to build the store value

Returns:

Builder

store

public QuoteRequestBuilder store(@Nullable
 StoreKeyReference store)

The Store to which the Buyer belongs.

Parameters:

store - value to be set

Returns:

Builder

lineItems

public QuoteRequestBuilder lineItems(LineItem... lineItems)

The Line Items for which a Quote is requested.

Parameters:

lineItems - value to be set

Returns:

Builder

lineItems

public QuoteRequestBuilder lineItems(List<LineItem> lineItems)

The Line Items for which a Quote is requested.

Parameters:

lineItems - value to be set

Returns:

Builder

plusLineItems

public QuoteRequestBuilder plusLineItems(LineItem... lineItems)

The Line Items for which a Quote is requested.

Parameters:

lineItems - value to be set

Returns:

Builder

plusLineItems

public QuoteRequestBuilder plusLineItems(Function<LineItemBuilder,LineItemBuilder> builder)

The Line Items for which a Quote is requested.

Parameters:

builder - function to build the lineItems value

Returns:

Builder

withLineItems

public QuoteRequestBuilder withLineItems(Function<LineItemBuilder,LineItemBuilder> builder)

The Line Items for which a Quote is requested.

Parameters:

builder - function to build the lineItems value

Returns:

Builder

addLineItems

public QuoteRequestBuilder addLineItems(Function<LineItemBuilder,LineItem> builder)

The Line Items for which a Quote is requested.

Parameters:

builder - function to build the lineItems value

Returns:

Builder

setLineItems

public QuoteRequestBuilder setLineItems(Function<LineItemBuilder,LineItem> builder)

The Line Items for which a Quote is requested.

Parameters:

builder - function to build the lineItems value

Returns:

Builder

customLineItems

public QuoteRequestBuilder customLineItems(CustomLineItem... customLineItems)

The Custom Line Items for which a Quote is requested.

Parameters:

customLineItems - value to be set

Returns:

Builder

customLineItems

public QuoteRequestBuilder customLineItems(List<CustomLineItem> customLineItems)

The Custom Line Items for which a Quote is requested.

Parameters:

customLineItems - value to be set

Returns:

Builder

plusCustomLineItems

public QuoteRequestBuilder plusCustomLineItems(CustomLineItem... customLineItems)

The Custom Line Items for which a Quote is requested.

Parameters:

customLineItems - value to be set

Returns:

Builder

plusCustomLineItems

public QuoteRequestBuilder plusCustomLineItems(Function<CustomLineItemBuilder,CustomLineItemBuilder> builder)

The Custom Line Items for which a Quote is requested.

Parameters:

builder - function to build the customLineItems value

Returns:

Builder

withCustomLineItems

public QuoteRequestBuilder withCustomLineItems(Function<CustomLineItemBuilder,CustomLineItemBuilder> builder)

The Custom Line Items for which a Quote is requested.

Parameters:

builder - function to build the customLineItems value

Returns:

Builder

addCustomLineItems

public QuoteRequestBuilder addCustomLineItems(Function<CustomLineItemBuilder,CustomLineItem> builder)

The Custom Line Items for which a Quote is requested.

Parameters:

builder - function to build the customLineItems value

Returns:

Builder

setCustomLineItems

public QuoteRequestBuilder setCustomLineItems(Function<CustomLineItemBuilder,CustomLineItem> builder)

The Custom Line Items for which a Quote is requested.

Parameters:

builder - function to build the customLineItems value

Returns:

Builder

totalPrice

public QuoteRequestBuilder totalPrice(TypedMoney totalPrice)

Sum of all totalPrice fields of the lineItems and customLineItems, as well as the price field of shippingInfo (if it exists). totalPrice may or may not include the taxes: it depends on the taxRate.includedInPrice property of each price.

Parameters:

totalPrice - value to be set

Returns:

Builder

totalPrice

public QuoteRequestBuilder totalPrice(Function<TypedMoneyBuilder,io.vrap.rmf.base.client.Builder<? extends TypedMoney>> builder)

Sum of all totalPrice fields of the lineItems and customLineItems, as well as the price field of shippingInfo (if it exists). totalPrice may or may not include the taxes: it depends on the taxRate.includedInPrice property of each price.

Parameters:

builder - function to build the totalPrice value

Returns:

Builder

taxedPrice

public QuoteRequestBuilder taxedPrice(Function<TaxedPriceBuilder,TaxedPriceBuilder> builder)

Not set until the shipping address is set. Will be set automatically in the Platform TaxMode. For the External tax mode it will be set as soon as the external tax rates for all line items, custom line items, and shipping in the cart are set.

Parameters:

builder - function to build the taxedPrice value

Returns:

Builder

withTaxedPrice

public QuoteRequestBuilder withTaxedPrice(Function<TaxedPriceBuilder,TaxedPrice> builder)

Not set until the shipping address is set. Will be set automatically in the Platform TaxMode. For the External tax mode it will be set as soon as the external tax rates for all line items, custom line items, and shipping in the cart are set.

Parameters:

builder - function to build the taxedPrice value

Returns:

Builder

taxedPrice

public QuoteRequestBuilder taxedPrice(@Nullable
 TaxedPrice taxedPrice)

Not set until the shipping address is set. Will be set automatically in the Platform TaxMode. For the External tax mode it will be set as soon as the external tax rates for all line items, custom line items, and shipping in the cart are set.

Parameters:

taxedPrice - value to be set

Returns:

Builder

shippingAddress

public QuoteRequestBuilder shippingAddress(Function<AddressBuilder,AddressBuilder> builder)

Used to determine the eligible ShippingMethods and rates as well as the tax rate of the Line Items.

Parameters:

builder - function to build the shippingAddress value

Returns:

Builder

withShippingAddress

public QuoteRequestBuilder withShippingAddress(Function<AddressBuilder,Address> builder)

Used to determine the eligible ShippingMethods and rates as well as the tax rate of the Line Items.

Parameters:

builder - function to build the shippingAddress value

Returns:

Builder

shippingAddress

public QuoteRequestBuilder shippingAddress(@Nullable
 Address shippingAddress)

Used to determine the eligible ShippingMethods and rates as well as the tax rate of the Line Items.

Parameters:

shippingAddress - value to be set

Returns:

Builder

billingAddress

public QuoteRequestBuilder billingAddress(Function<AddressBuilder,AddressBuilder> builder)

Address used for invoicing.

Parameters:

builder - function to build the billingAddress value

Returns:

Builder

withBillingAddress

public QuoteRequestBuilder withBillingAddress(Function<AddressBuilder,Address> builder)

Address used for invoicing.

Parameters:

builder - function to build the billingAddress value

Returns:

Builder

billingAddress

public QuoteRequestBuilder billingAddress(@Nullable
 Address billingAddress)

Address used for invoicing.

Parameters:

billingAddress - value to be set

Returns:

Builder

inventoryMode

public QuoteRequestBuilder inventoryMode(@Nullable
 InventoryMode inventoryMode)

Inventory mode of the Cart referenced in the QuoteRequestDraft.

Parameters:

inventoryMode - value to be set

Returns:

Builder

taxMode

public QuoteRequestBuilder taxMode(TaxMode taxMode)

Tax mode of the Cart referenced in the QuoteRequestDraft.

Parameters:

taxMode - value to be set

Returns:

Builder

taxRoundingMode

public QuoteRequestBuilder taxRoundingMode(RoundingMode taxRoundingMode)

When calculating taxes for taxedPrice, the selected mode is used for rounding.

Parameters:

taxRoundingMode - value to be set

Returns:

Builder

taxCalculationMode

public QuoteRequestBuilder taxCalculationMode(TaxCalculationMode taxCalculationMode)

When calculating taxes for taxedPrice, the selected mode is used for calculating the price with LineItemLevel (horizontally) or UnitPriceLevel (vertically) calculation mode.

Parameters:

taxCalculationMode - value to be set

Returns:

Builder

country

public QuoteRequestBuilder country(@Nullable
 String country)

Used for Product Variant price selection.

Parameters:

country - value to be set

Returns:

Builder

shippingInfo

public QuoteRequestBuilder shippingInfo(Function<ShippingInfoBuilder,ShippingInfoBuilder> builder)

Set automatically once the ShippingMethod is set.

Parameters:

builder - function to build the shippingInfo value

Returns:

Builder

withShippingInfo

public QuoteRequestBuilder withShippingInfo(Function<ShippingInfoBuilder,ShippingInfo> builder)

Set automatically once the ShippingMethod is set.

Parameters:

builder - function to build the shippingInfo value

Returns:

Builder

shippingInfo

public QuoteRequestBuilder shippingInfo(@Nullable
 ShippingInfo shippingInfo)

Set automatically once the ShippingMethod is set.

Parameters:

shippingInfo - value to be set

Returns:

Builder

paymentInfo

public QuoteRequestBuilder paymentInfo(Function<PaymentInfoBuilder,PaymentInfoBuilder> builder)

Log of payment transactions related to the Quote.

Parameters:

builder - function to build the paymentInfo value

Returns:

Builder

withPaymentInfo

public QuoteRequestBuilder withPaymentInfo(Function<PaymentInfoBuilder,PaymentInfo> builder)

Log of payment transactions related to the Quote.

Parameters:

builder - function to build the paymentInfo value

Returns:

Builder

paymentInfo

public QuoteRequestBuilder paymentInfo(@Nullable
 PaymentInfo paymentInfo)

Log of payment transactions related to the Quote.

Parameters:

paymentInfo - value to be set

Returns:

Builder

shippingRateInput

public QuoteRequestBuilder shippingRateInput(@Nullable
 ShippingRateInput shippingRateInput)

Used to select a ShippingRatePriceTier.

Parameters:

shippingRateInput - value to be set

Returns:

Builder

shippingRateInput

public QuoteRequestBuilder shippingRateInput(Function<ShippingRateInputBuilder,io.vrap.rmf.base.client.Builder<? extends ShippingRateInput>> builder)

Used to select a ShippingRatePriceTier.

Parameters:

builder - function to build the shippingRateInput value

Returns:

Builder

itemShippingAddresses

public QuoteRequestBuilder itemShippingAddresses(@Nullable
 Address... itemShippingAddresses)

Contains addresses for carts with multiple shipping addresses. Line items reference these addresses under their shippingDetails. The addresses captured here are not used to determine eligible shipping methods or the applicable tax rate. Only the cart's shippingAddress is used for this.

Parameters:

itemShippingAddresses - value to be set

Returns:

Builder

itemShippingAddresses

public QuoteRequestBuilder itemShippingAddresses(@Nullable
 List<Address> itemShippingAddresses)

Contains addresses for carts with multiple shipping addresses. Line items reference these addresses under their shippingDetails. The addresses captured here are not used to determine eligible shipping methods or the applicable tax rate. Only the cart's shippingAddress is used for this.

Parameters:

itemShippingAddresses - value to be set

Returns:

Builder

plusItemShippingAddresses

public QuoteRequestBuilder plusItemShippingAddresses(@Nullable
 Address... itemShippingAddresses)

Contains addresses for carts with multiple shipping addresses. Line items reference these addresses under their shippingDetails. The addresses captured here are not used to determine eligible shipping methods or the applicable tax rate. Only the cart's shippingAddress is used for this.

Parameters:

itemShippingAddresses - value to be set

Returns:

Builder

plusItemShippingAddresses

public QuoteRequestBuilder plusItemShippingAddresses(Function<AddressBuilder,AddressBuilder> builder)

Contains addresses for carts with multiple shipping addresses. Line items reference these addresses under their shippingDetails. The addresses captured here are not used to determine eligible shipping methods or the applicable tax rate. Only the cart's shippingAddress is used for this.

Parameters:

builder - function to build the itemShippingAddresses value

Returns:

Builder

withItemShippingAddresses

public QuoteRequestBuilder withItemShippingAddresses(Function<AddressBuilder,AddressBuilder> builder)

Contains addresses for carts with multiple shipping addresses. Line items reference these addresses under their shippingDetails. The addresses captured here are not used to determine eligible shipping methods or the applicable tax rate. Only the cart's shippingAddress is used for this.

Parameters:

builder - function to build the itemShippingAddresses value

Returns:

Builder

addItemShippingAddresses

public QuoteRequestBuilder addItemShippingAddresses(Function<AddressBuilder,Address> builder)

Contains addresses for carts with multiple shipping addresses. Line items reference these addresses under their shippingDetails. The addresses captured here are not used to determine eligible shipping methods or the applicable tax rate. Only the cart's shippingAddress is used for this.

Parameters:

builder - function to build the itemShippingAddresses value

Returns:

Builder

setItemShippingAddresses

public QuoteRequestBuilder setItemShippingAddresses(Function<AddressBuilder,Address> builder)

Contains addresses for carts with multiple shipping addresses. Line items reference these addresses under their shippingDetails. The addresses captured here are not used to determine eligible shipping methods or the applicable tax rate. Only the cart's shippingAddress is used for this.

Parameters:

builder - function to build the itemShippingAddresses value

Returns:

Builder

directDiscounts

public QuoteRequestBuilder directDiscounts(@Nullable
 DirectDiscount... directDiscounts)

Discounts that are only valid for the Quote and cannot be associated to any other Cart or Order.

Parameters:

directDiscounts - value to be set

Returns:

Builder

directDiscounts

public QuoteRequestBuilder directDiscounts(@Nullable
 List<DirectDiscount> directDiscounts)

Discounts that are only valid for the Quote and cannot be associated to any other Cart or Order.

Parameters:

directDiscounts - value to be set

Returns:

Builder

plusDirectDiscounts

public QuoteRequestBuilder plusDirectDiscounts(@Nullable
 DirectDiscount... directDiscounts)

Discounts that are only valid for the Quote and cannot be associated to any other Cart or Order.

Parameters:

directDiscounts - value to be set

Returns:

Builder

plusDirectDiscounts

public QuoteRequestBuilder plusDirectDiscounts(Function<DirectDiscountBuilder,DirectDiscountBuilder> builder)

Discounts that are only valid for the Quote and cannot be associated to any other Cart or Order.

Parameters:

builder - function to build the directDiscounts value

Returns:

Builder

withDirectDiscounts

public QuoteRequestBuilder withDirectDiscounts(Function<DirectDiscountBuilder,DirectDiscountBuilder> builder)

Discounts that are only valid for the Quote and cannot be associated to any other Cart or Order.

Parameters:

builder - function to build the directDiscounts value

Returns:

Builder

addDirectDiscounts

public QuoteRequestBuilder addDirectDiscounts(Function<DirectDiscountBuilder,DirectDiscount> builder)

Discounts that are only valid for the Quote and cannot be associated to any other Cart or Order.

Parameters:

builder - function to build the directDiscounts value

Returns:

Builder

setDirectDiscounts

public QuoteRequestBuilder setDirectDiscounts(Function<DirectDiscountBuilder,DirectDiscount> builder)

Discounts that are only valid for the Quote and cannot be associated to any other Cart or Order.

Parameters:

builder - function to build the directDiscounts value

Returns:

Builder

custom

public QuoteRequestBuilder custom(Function<CustomFieldsBuilder,CustomFieldsBuilder> builder)

Custom Fields of the Quote Request.

Parameters:

builder - function to build the custom value

Returns:

Builder

withCustom

public QuoteRequestBuilder withCustom(Function<CustomFieldsBuilder,CustomFields> builder)

Custom Fields of the Quote Request.

Parameters:

builder - function to build the custom value

Returns:

Builder

custom

public QuoteRequestBuilder custom(@Nullable
 CustomFields custom)

Custom Fields of the Quote Request.

Parameters:

custom - value to be set

Returns:

Builder

state

public QuoteRequestBuilder state(Function<StateReferenceBuilder,StateReferenceBuilder> builder)

State of the Quote Request. This reference can point to a State in a custom workflow.

Parameters:

builder - function to build the state value

Returns:

Builder

withState

public QuoteRequestBuilder withState(Function<StateReferenceBuilder,StateReference> builder)

State of the Quote Request. This reference can point to a State in a custom workflow.

Parameters:

builder - function to build the state value

Returns:

Builder

state

public QuoteRequestBuilder state(@Nullable
 StateReference state)

State of the Quote Request. This reference can point to a State in a custom workflow.

Parameters:

state - value to be set

Returns:

Builder

purchaseOrderNumber

public QuoteRequestBuilder purchaseOrderNumber(@Nullable
 String purchaseOrderNumber)

Identifier for a purchase order, usually in a B2B context. The Purchase Order Number is typically entered by the Buyer.

Parameters:

purchaseOrderNumber - value to be set

Returns:

Builder

businessUnit

public QuoteRequestBuilder businessUnit(Function<BusinessUnitKeyReferenceBuilder,BusinessUnitKeyReferenceBuilder> builder)

The BusinessUnit for the Quote Request.

Parameters:

builder - function to build the businessUnit value

Returns:

Builder

withBusinessUnit

public QuoteRequestBuilder withBusinessUnit(Function<BusinessUnitKeyReferenceBuilder,BusinessUnitKeyReference> builder)

The BusinessUnit for the Quote Request.

Parameters:

builder - function to build the businessUnit value

Returns:

Builder

businessUnit

public QuoteRequestBuilder businessUnit(@Nullable
 BusinessUnitKeyReference businessUnit)

The BusinessUnit for the Quote Request.

Parameters:

businessUnit - value to be set

Returns:

Builder

getId

public String getId()

Unique identifier of the QuoteRequest.

Returns:

id

getVersion

public Long getVersion()

Current version of the QuoteRequest.

Returns:

version

getCreatedAt

public ZonedDateTime getCreatedAt()

Date and time (UTC) the QuoteRequest was initially created.

Returns:

createdAt

getLastModifiedAt

public ZonedDateTime getLastModifiedAt()

Date and time (UTC) the QuoteRequest was last updated.

Returns:

lastModifiedAt

getKey

@Nullable
public String getKey()

User-defined unique identifier of the QuoteRequest.

Returns:

key

getLastModifiedBy

@Nullable
public LastModifiedBy getLastModifiedBy()

Present on resources created after 1 February 2019 except for events not tracked.

Returns:

lastModifiedBy

getCreatedBy

@Nullable
public CreatedBy getCreatedBy()

Present on resources created after 1 February 2019 except for events not tracked.

Returns:

createdBy

getQuoteRequestState

public QuoteRequestState getQuoteRequestState()

Indicates the current state of the Quote Request in the negotiation process.

Returns:

quoteRequestState

getComment

@Nullable
public String getComment()

Message from the Buyer included in the Quote Request.

Returns:

comment

getCustomer

public CustomerReference getCustomer()

The Buyer who owns the request.

Returns:

customer

getCustomerGroup

@Nullable
public CustomerGroupReference getCustomerGroup()

Set automatically when customer is set and the Customer is a member of a Customer Group. Not updated if Customer is changed after Quote Request creation. Used for Product Variant price selection.

Returns:

customerGroup

getStore

@Nullable
public StoreKeyReference getStore()

The Store to which the Buyer belongs.

Returns:

store

getLineItems

public List<LineItem> getLineItems()

The Line Items for which a Quote is requested.

Returns:

lineItems

getCustomLineItems

public List<CustomLineItem> getCustomLineItems()

The Custom Line Items for which a Quote is requested.

Returns:

customLineItems

getTotalPrice

public TypedMoney getTotalPrice()

Sum of all totalPrice fields of the lineItems and customLineItems, as well as the price field of shippingInfo (if it exists). totalPrice may or may not include the taxes: it depends on the taxRate.includedInPrice property of each price.

Returns:

totalPrice

getTaxedPrice

@Nullable
public TaxedPrice getTaxedPrice()

Not set until the shipping address is set. Will be set automatically in the Platform TaxMode. For the External tax mode it will be set as soon as the external tax rates for all line items, custom line items, and shipping in the cart are set.

Returns:

taxedPrice

getShippingAddress

@Nullable
public Address getShippingAddress()

Used to determine the eligible ShippingMethods and rates as well as the tax rate of the Line Items.

Returns:

shippingAddress

getBillingAddress

@Nullable
public Address getBillingAddress()

Address used for invoicing.

Returns:

billingAddress

getInventoryMode

@Nullable
public InventoryMode getInventoryMode()

Inventory mode of the Cart referenced in the QuoteRequestDraft.

Returns:

inventoryMode

getTaxMode

public TaxMode getTaxMode()

Tax mode of the Cart referenced in the QuoteRequestDraft.

Returns:

taxMode

getTaxRoundingMode

public RoundingMode getTaxRoundingMode()

When calculating taxes for taxedPrice, the selected mode is used for rounding.

Returns:

taxRoundingMode

getTaxCalculationMode

public TaxCalculationMode getTaxCalculationMode()

When calculating taxes for taxedPrice, the selected mode is used for calculating the price with LineItemLevel (horizontally) or UnitPriceLevel (vertically) calculation mode.

Returns:

taxCalculationMode

getCountry

@Nullable
public String getCountry()

Used for Product Variant price selection.

Returns:

country

getShippingInfo

@Nullable
public ShippingInfo getShippingInfo()

Set automatically once the ShippingMethod is set.

Returns:

shippingInfo

getPaymentInfo

@Nullable
public PaymentInfo getPaymentInfo()

Log of payment transactions related to the Quote.

Returns:

paymentInfo

getShippingRateInput

@Nullable
public ShippingRateInput getShippingRateInput()

Used to select a ShippingRatePriceTier.

Returns:

shippingRateInput

getItemShippingAddresses

@Nullable
public List<Address> getItemShippingAddresses()

Contains addresses for carts with multiple shipping addresses. Line items reference these addresses under their shippingDetails. The addresses captured here are not used to determine eligible shipping methods or the applicable tax rate. Only the cart's shippingAddress is used for this.

Returns:

itemShippingAddresses

getDirectDiscounts

@Nullable
public List<DirectDiscount> getDirectDiscounts()

Discounts that are only valid for the Quote and cannot be associated to any other Cart or Order.

Returns:

directDiscounts

getCustom

@Nullable
public CustomFields getCustom()

Custom Fields of the Quote Request.

Returns:

custom

getState

@Nullable
public StateReference getState()

State of the Quote Request. This reference can point to a State in a custom workflow.

Returns:

state

getPurchaseOrderNumber

@Nullable
public String getPurchaseOrderNumber()

Identifier for a purchase order, usually in a B2B context. The Purchase Order Number is typically entered by the Buyer.

Returns:

purchaseOrderNumber

getBusinessUnit

@Nullable
public BusinessUnitKeyReference getBusinessUnit()

The BusinessUnit for the Quote Request.

Returns:

businessUnit

build

public QuoteRequest build()

builds QuoteRequest with checking for non-null required values

Specified by:

build in interface io.vrap.rmf.base.client.Builder<QuoteRequest>

Returns:

QuoteRequest

buildUnchecked

public QuoteRequest buildUnchecked()

builds QuoteRequest without checking for non-null required values

Returns:

QuoteRequest

of

public static QuoteRequestBuilder of()

factory method for an instance of QuoteRequestBuilder

Returns:

builder

of

public static QuoteRequestBuilder of(QuoteRequest template)

create builder for QuoteRequest instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder