Package com.commercetools.api.models.order

Class OrderBuilder

java.lang.Object

com.commercetools.api.models.order.OrderBuilder

All Implemented Interfaces:

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

public class OrderBuilder
extends Object
implements io.vrap.rmf.base.client.Builder<Order>

OrderBuilder Example to create an instance using the builder pattern

     Order order = Order.builder()
             .id("{id}")
             .version(0.3)
             .createdAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .lastModifiedAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .plusLineItems(lineItemsBuilder -> lineItemsBuilder)
             .plusCustomLineItems(customLineItemsBuilder -> customLineItemsBuilder)
             .totalPrice(totalPriceBuilder -> totalPriceBuilder)
             .shippingMode(ShippingMode.SINGLE)
             .plusShipping(shippingBuilder -> shippingBuilder)
             .orderState(OrderState.OPEN)
             .plusSyncInfo(syncInfoBuilder -> syncInfoBuilder)
             .origin(CartOrigin.CUSTOMER)
             .plusRefusedGifts(refusedGiftsBuilder -> refusedGiftsBuilder)
             .build()
 

Constructor Summary

Constructors

Constructor	Description
OrderBuilder()

Method Summary

Modifier and Type	Method	Description
OrderBuilder	addCustomLineItems(Function<CustomLineItemBuilder,CustomLineItem> builder)	add the value to the customLineItems using the builder function
OrderBuilder	addDiscountCodes(Function<DiscountCodeInfoBuilder,DiscountCodeInfo> builder)	add the value to the discountCodes using the builder function
OrderBuilder	addItemShippingAddresses(Function<AddressBuilder,Address> builder)	Contains addresses for orders with multiple shipping addresses.
OrderBuilder	addLineItems(Function<LineItemBuilder,LineItem> builder)	add the value to the lineItems using the builder function
OrderBuilder	addRefusedGifts(Function<CartDiscountReferenceBuilder,CartDiscountReference> builder)	Automatically filled when a line item with LineItemMode GiftLineItem is removed from this order.
OrderBuilder	addReturnInfo(Function<ReturnInfoBuilder,ReturnInfo> builder)	add the value to the returnInfo using the builder function
OrderBuilder	addShipping(Function<ShippingBuilder,Shipping> builder)	Holds all shipping-related information per Shipping Method for Multi ShippingMode.
OrderBuilder	addSyncInfo(Function<SyncInfoBuilder,SyncInfo> builder)	add the value to the syncInfo using the builder function
OrderBuilder	anonymousId(String anonymousId)	Identifies carts and orders belonging to an anonymous session (the customer has not signed up/in yet).
OrderBuilder	billingAddress(Address billingAddress)	set the value to the billingAddress
OrderBuilder	billingAddress(Function<AddressBuilder,AddressBuilder> builder)	set the value to the billingAddress using the builder function
Order	build()	builds Order with checking for non-null required values
Order	buildUnchecked()	builds Order without checking for non-null required values
OrderBuilder	businessUnit(BusinessUnitKeyReference businessUnit)	The Business Unit the Order belongs to.
OrderBuilder	businessUnit(Function<BusinessUnitKeyReferenceBuilder,BusinessUnitKeyReferenceBuilder> builder)	The Business Unit the Order belongs to.
OrderBuilder	cart(CartReference cart)	Set when this order was created from a cart.
OrderBuilder	cart(Function<CartReferenceBuilder,CartReferenceBuilder> builder)	Set when this order was created from a cart.
OrderBuilder	completedAt(ZonedDateTime completedAt)	This field will only be present if it was set for Order Import
OrderBuilder	country(String country)	A two-digit country code as per ISO 3166-1 alpha-2.
OrderBuilder	createdAt(ZonedDateTime createdAt)	set the value to the createdAt
OrderBuilder	createdBy(CreatedBy createdBy)	Present on resources created after 1 February 2019 except for events not tracked.
OrderBuilder	createdBy(Function<CreatedByBuilder,CreatedByBuilder> builder)	Present on resources created after 1 February 2019 except for events not tracked.
OrderBuilder	custom(CustomFields custom)	set the value to the custom
OrderBuilder	custom(Function<CustomFieldsBuilder,CustomFieldsBuilder> builder)	set the value to the custom using the builder function
OrderBuilder	customerEmail(String customerEmail)	set the value to the customerEmail
OrderBuilder	customerGroup(CustomerGroupReference customerGroup)	Set when the customer is set and the customer is a member of a customer group.
OrderBuilder	customerGroup(Function<CustomerGroupReferenceBuilder,CustomerGroupReferenceBuilder> builder)	Set when the customer is set and the customer is a member of a customer group.
OrderBuilder	customerId(String customerId)	set the value to the customerId
OrderBuilder	customLineItems(CustomLineItem... customLineItems)	set values to the customLineItems
OrderBuilder	customLineItems(List<CustomLineItem> customLineItems)	set value to the customLineItems
OrderBuilder	discountCodes(DiscountCodeInfo... discountCodes)	set values to the discountCodes
OrderBuilder	discountCodes(List<DiscountCodeInfo> discountCodes)	set value to the discountCodes
String	getAnonymousId()	Identifies carts and orders belonging to an anonymous session (the customer has not signed up/in yet).
Address	getBillingAddress()	value of billingAddress}
BusinessUnitKeyReference	getBusinessUnit()	The Business Unit the Order belongs to.
CartReference	getCart()	Set when this order was created from a cart.
ZonedDateTime	getCompletedAt()	This field will only be present if it was set for Order Import
String	getCountry()	A two-digit country code as per ISO 3166-1 alpha-2.
ZonedDateTime	getCreatedAt()	value of createdAt}
CreatedBy	getCreatedBy()	Present on resources created after 1 February 2019 except for events not tracked.
CustomFields	getCustom()	value of custom}
String	getCustomerEmail()	value of customerEmail}
CustomerGroupReference	getCustomerGroup()	Set when the customer is set and the customer is a member of a customer group.
String	getCustomerId()	value of customerId}
List<CustomLineItem>	getCustomLineItems()	value of customLineItems}
List<DiscountCodeInfo>	getDiscountCodes()	value of discountCodes}
String	getId()	Unique identifier of the Order.
InventoryMode	getInventoryMode()	value of inventoryMode}
List<Address>	getItemShippingAddresses()	Contains addresses for orders with multiple shipping addresses.
Long	getLastMessageSequenceNumber()	Deprecated.
ZonedDateTime	getLastModifiedAt()	value of lastModifiedAt}
LastModifiedBy	getLastModifiedBy()	Present on resources created after 1 February 2019 except for events not tracked.
List<LineItem>	getLineItems()	value of lineItems}
String	getLocale()	value of locale}
String	getOrderNumber()	String that uniquely identifies an order.
OrderState	getOrderState()	One of the four predefined OrderStates.
CartOrigin	getOrigin()	value of origin}
PaymentInfo	getPaymentInfo()	value of paymentInfo}
PaymentState	getPaymentState()	value of paymentState}
String	getPurchaseOrderNumber()	The Purchase Order Number is typically set by the Buyer on a QuoteRequest to track the purchase order during the quote and order flow.
QuoteReference	getQuote()	Set when this order was created from a quote.
List<CartDiscountReference>	getRefusedGifts()	Automatically filled when a line item with LineItemMode GiftLineItem is removed from this order.
List<ReturnInfo>	getReturnInfo()	value of returnInfo}
ShipmentState	getShipmentState()	value of shipmentState}
List<Shipping>	getShipping()	Holds all shipping-related information per Shipping Method for Multi ShippingMode.
Address	getShippingAddress()	Holds all shipping-related information per Shipping Method.
CustomFields	getShippingCustomFields()	Custom Fields of the Shipping Method for Single ShippingMode.
ShippingInfo	getShippingInfo()	Set if the ShippingMethod is set.
String	getShippingKey()	User-defined unique identifier of the Shipping Method with Single ShippingMode.
ShippingMode	getShippingMode()	Indicates whether one or multiple Shipping Methods are added to the Cart.
ShippingRateInput	getShippingRateInput()	Input used to select a ShippingRatePriceTier.
StateReference	getState()	This reference can point to a state in a custom workflow.
StoreKeyReference	getStore()	value of store}
List<SyncInfo>	getSyncInfo()	value of syncInfo}
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()	The taxes are calculated based on the shipping address.
TaxedPrice	getTaxedShippingPrice()	Sum of taxedPrice of ShippingInfo across all Shipping Methods.
TaxMode	getTaxMode()	value of taxMode}
RoundingMode	getTaxRoundingMode()	When calculating taxes for taxedPrice, the selected mode is used for rouding.
TypedMoney	getTotalPrice()	value of totalPrice}
Long	getVersion()	The current version of the order.
OrderBuilder	id(String id)	Unique identifier of the Order.
OrderBuilder	inventoryMode(InventoryMode inventoryMode)	set the value to the inventoryMode
OrderBuilder	itemShippingAddresses(Address... itemShippingAddresses)	Contains addresses for orders with multiple shipping addresses.
OrderBuilder	itemShippingAddresses(List<Address> itemShippingAddresses)	Contains addresses for orders with multiple shipping addresses.
OrderBuilder	lastMessageSequenceNumber(Long lastMessageSequenceNumber)	Deprecated.
OrderBuilder	lastModifiedAt(ZonedDateTime lastModifiedAt)	set the value to the lastModifiedAt
OrderBuilder	lastModifiedBy(LastModifiedBy lastModifiedBy)	Present on resources created after 1 February 2019 except for events not tracked.
OrderBuilder	lastModifiedBy(Function<LastModifiedByBuilder,LastModifiedByBuilder> builder)	Present on resources created after 1 February 2019 except for events not tracked.
OrderBuilder	lineItems(LineItem... lineItems)	set values to the lineItems
OrderBuilder	lineItems(List<LineItem> lineItems)	set value to the lineItems
OrderBuilder	locale(String locale)	set the value to the locale
static OrderBuilder	of()	factory method for an instance of OrderBuilder
static OrderBuilder	of(Order template)	create builder for Order instance
OrderBuilder	orderNumber(String orderNumber)	String that uniquely identifies an order.
OrderBuilder	orderState(OrderState orderState)	One of the four predefined OrderStates.
OrderBuilder	origin(CartOrigin origin)	set the value to the origin
OrderBuilder	paymentInfo(PaymentInfo paymentInfo)	set the value to the paymentInfo
OrderBuilder	paymentInfo(Function<PaymentInfoBuilder,PaymentInfoBuilder> builder)	set the value to the paymentInfo using the builder function
OrderBuilder	paymentState(PaymentState paymentState)	set the value to the paymentState
OrderBuilder	plusCustomLineItems(CustomLineItem... customLineItems)	add values to the customLineItems
OrderBuilder	plusCustomLineItems(Function<CustomLineItemBuilder,CustomLineItemBuilder> builder)	add the value to the customLineItems using the builder function
OrderBuilder	plusDiscountCodes(DiscountCodeInfo... discountCodes)	add values to the discountCodes
OrderBuilder	plusDiscountCodes(Function<DiscountCodeInfoBuilder,DiscountCodeInfoBuilder> builder)	add the value to the discountCodes using the builder function
OrderBuilder	plusItemShippingAddresses(Address... itemShippingAddresses)	Contains addresses for orders with multiple shipping addresses.
OrderBuilder	plusItemShippingAddresses(Function<AddressBuilder,AddressBuilder> builder)	Contains addresses for orders with multiple shipping addresses.
OrderBuilder	plusLineItems(LineItem... lineItems)	add values to the lineItems
OrderBuilder	plusLineItems(Function<LineItemBuilder,LineItemBuilder> builder)	add the value to the lineItems using the builder function
OrderBuilder	plusRefusedGifts(CartDiscountReference... refusedGifts)	Automatically filled when a line item with LineItemMode GiftLineItem is removed from this order.
OrderBuilder	plusRefusedGifts(Function<CartDiscountReferenceBuilder,CartDiscountReferenceBuilder> builder)	Automatically filled when a line item with LineItemMode GiftLineItem is removed from this order.
OrderBuilder	plusReturnInfo(ReturnInfo... returnInfo)	add values to the returnInfo
OrderBuilder	plusReturnInfo(Function<ReturnInfoBuilder,ReturnInfoBuilder> builder)	add the value to the returnInfo using the builder function
OrderBuilder	plusShipping(Shipping... shipping)	Holds all shipping-related information per Shipping Method for Multi ShippingMode.
OrderBuilder	plusShipping(Function<ShippingBuilder,ShippingBuilder> builder)	Holds all shipping-related information per Shipping Method for Multi ShippingMode.
OrderBuilder	plusSyncInfo(SyncInfo... syncInfo)	add values to the syncInfo
OrderBuilder	plusSyncInfo(Function<SyncInfoBuilder,SyncInfoBuilder> builder)	add the value to the syncInfo using the builder function
OrderBuilder	purchaseOrderNumber(String purchaseOrderNumber)	The Purchase Order Number is typically set by the Buyer on a QuoteRequest to track the purchase order during the quote and order flow.
OrderBuilder	quote(QuoteReference quote)	Set when this order was created from a quote.
OrderBuilder	quote(Function<QuoteReferenceBuilder,QuoteReferenceBuilder> builder)	Set when this order was created from a quote.
OrderBuilder	refusedGifts(CartDiscountReference... refusedGifts)	Automatically filled when a line item with LineItemMode GiftLineItem is removed from this order.
OrderBuilder	refusedGifts(List<CartDiscountReference> refusedGifts)	Automatically filled when a line item with LineItemMode GiftLineItem is removed from this order.
OrderBuilder	returnInfo(ReturnInfo... returnInfo)	set values to the returnInfo
OrderBuilder	returnInfo(List<ReturnInfo> returnInfo)	set value to the returnInfo
OrderBuilder	setCustomLineItems(Function<CustomLineItemBuilder,CustomLineItem> builder)	set the value to the customLineItems using the builder function
OrderBuilder	setDiscountCodes(Function<DiscountCodeInfoBuilder,DiscountCodeInfo> builder)	set the value to the discountCodes using the builder function
OrderBuilder	setItemShippingAddresses(Function<AddressBuilder,Address> builder)	Contains addresses for orders with multiple shipping addresses.
OrderBuilder	setLineItems(Function<LineItemBuilder,LineItem> builder)	set the value to the lineItems using the builder function
OrderBuilder	setRefusedGifts(Function<CartDiscountReferenceBuilder,CartDiscountReference> builder)	Automatically filled when a line item with LineItemMode GiftLineItem is removed from this order.
OrderBuilder	setReturnInfo(Function<ReturnInfoBuilder,ReturnInfo> builder)	set the value to the returnInfo using the builder function
OrderBuilder	setShipping(Function<ShippingBuilder,Shipping> builder)	Holds all shipping-related information per Shipping Method for Multi ShippingMode.
OrderBuilder	setSyncInfo(Function<SyncInfoBuilder,SyncInfo> builder)	set the value to the syncInfo using the builder function
OrderBuilder	shipmentState(ShipmentState shipmentState)	set the value to the shipmentState
OrderBuilder	shipping(Shipping... shipping)	Holds all shipping-related information per Shipping Method for Multi ShippingMode.
OrderBuilder	shipping(List<Shipping> shipping)	Holds all shipping-related information per Shipping Method for Multi ShippingMode.
OrderBuilder	shippingAddress(Address shippingAddress)	Holds all shipping-related information per Shipping Method.
OrderBuilder	shippingAddress(Function<AddressBuilder,AddressBuilder> builder)	Holds all shipping-related information per Shipping Method.
OrderBuilder	shippingCustomFields(CustomFields shippingCustomFields)	Custom Fields of the Shipping Method for Single ShippingMode.
OrderBuilder	shippingCustomFields(Function<CustomFieldsBuilder,CustomFieldsBuilder> builder)	Custom Fields of the Shipping Method for Single ShippingMode.
OrderBuilder	shippingInfo(ShippingInfo shippingInfo)	Set if the ShippingMethod is set.
OrderBuilder	shippingInfo(Function<ShippingInfoBuilder,ShippingInfoBuilder> builder)	Set if the ShippingMethod is set.
OrderBuilder	shippingKey(String shippingKey)	User-defined unique identifier of the Shipping Method with Single ShippingMode.
OrderBuilder	shippingMode(ShippingMode shippingMode)	Indicates whether one or multiple Shipping Methods are added to the Cart.
OrderBuilder	shippingRateInput(ShippingRateInput shippingRateInput)	Input used to select a ShippingRatePriceTier.
OrderBuilder	shippingRateInput(Function<ShippingRateInputBuilder,io.vrap.rmf.base.client.Builder<? extends ShippingRateInput>> builder)	Input used to select a ShippingRatePriceTier.
OrderBuilder	state(StateReference state)	This reference can point to a state in a custom workflow.
OrderBuilder	state(Function<StateReferenceBuilder,StateReferenceBuilder> builder)	This reference can point to a state in a custom workflow.
OrderBuilder	store(StoreKeyReference store)	set the value to the store
OrderBuilder	store(Function<StoreKeyReferenceBuilder,StoreKeyReferenceBuilder> builder)	set the value to the store using the builder function
OrderBuilder	syncInfo(SyncInfo... syncInfo)	set values to the syncInfo
OrderBuilder	syncInfo(List<SyncInfo> syncInfo)	set value to the syncInfo
OrderBuilder	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.
OrderBuilder	taxedPrice(TaxedPrice taxedPrice)	The taxes are calculated based on the shipping address.
OrderBuilder	taxedPrice(Function<TaxedPriceBuilder,TaxedPriceBuilder> builder)	The taxes are calculated based on the shipping address.
OrderBuilder	taxedShippingPrice(TaxedPrice taxedShippingPrice)	Sum of taxedPrice of ShippingInfo across all Shipping Methods.
OrderBuilder	taxedShippingPrice(Function<TaxedPriceBuilder,TaxedPriceBuilder> builder)	Sum of taxedPrice of ShippingInfo across all Shipping Methods.
OrderBuilder	taxMode(TaxMode taxMode)	set the value to the taxMode
OrderBuilder	taxRoundingMode(RoundingMode taxRoundingMode)	When calculating taxes for taxedPrice, the selected mode is used for rouding.
OrderBuilder	totalPrice(TypedMoney totalPrice)	set the value to the totalPrice
OrderBuilder	totalPrice(Function<TypedMoneyBuilder,io.vrap.rmf.base.client.Builder<? extends TypedMoney>> builder)	set the value to the totalPrice using the builder function
OrderBuilder	version(Long version)	The current version of the order.
OrderBuilder	withBillingAddress(Function<AddressBuilder,Address> builder)	set the value to the billingAddress using the builder function
OrderBuilder	withBusinessUnit(Function<BusinessUnitKeyReferenceBuilder,BusinessUnitKeyReference> builder)	The Business Unit the Order belongs to.
OrderBuilder	withCart(Function<CartReferenceBuilder,CartReference> builder)	Set when this order was created from a cart.
OrderBuilder	withCreatedBy(Function<CreatedByBuilder,CreatedBy> builder)	Present on resources created after 1 February 2019 except for events not tracked.
OrderBuilder	withCustom(Function<CustomFieldsBuilder,CustomFields> builder)	set the value to the custom using the builder function
OrderBuilder	withCustomerGroup(Function<CustomerGroupReferenceBuilder,CustomerGroupReference> builder)	Set when the customer is set and the customer is a member of a customer group.
OrderBuilder	withCustomLineItems(Function<CustomLineItemBuilder,CustomLineItemBuilder> builder)	set the value to the customLineItems using the builder function
OrderBuilder	withDiscountCodes(Function<DiscountCodeInfoBuilder,DiscountCodeInfoBuilder> builder)	set the value to the discountCodes using the builder function
OrderBuilder	withItemShippingAddresses(Function<AddressBuilder,AddressBuilder> builder)	Contains addresses for orders with multiple shipping addresses.
OrderBuilder	withLastModifiedBy(Function<LastModifiedByBuilder,LastModifiedBy> builder)	Present on resources created after 1 February 2019 except for events not tracked.
OrderBuilder	withLineItems(Function<LineItemBuilder,LineItemBuilder> builder)	set the value to the lineItems using the builder function
OrderBuilder	withPaymentInfo(Function<PaymentInfoBuilder,PaymentInfo> builder)	set the value to the paymentInfo using the builder function
OrderBuilder	withQuote(Function<QuoteReferenceBuilder,QuoteReference> builder)	Set when this order was created from a quote.
OrderBuilder	withRefusedGifts(Function<CartDiscountReferenceBuilder,CartDiscountReferenceBuilder> builder)	Automatically filled when a line item with LineItemMode GiftLineItem is removed from this order.
OrderBuilder	withReturnInfo(Function<ReturnInfoBuilder,ReturnInfoBuilder> builder)	set the value to the returnInfo using the builder function
OrderBuilder	withShipping(Function<ShippingBuilder,ShippingBuilder> builder)	Holds all shipping-related information per Shipping Method for Multi ShippingMode.
OrderBuilder	withShippingAddress(Function<AddressBuilder,Address> builder)	Holds all shipping-related information per Shipping Method.
OrderBuilder	withShippingCustomFields(Function<CustomFieldsBuilder,CustomFields> builder)	Custom Fields of the Shipping Method for Single ShippingMode.
OrderBuilder	withShippingInfo(Function<ShippingInfoBuilder,ShippingInfo> builder)	Set if the ShippingMethod is set.
OrderBuilder	withState(Function<StateReferenceBuilder,StateReference> builder)	This reference can point to a state in a custom workflow.
OrderBuilder	withStore(Function<StoreKeyReferenceBuilder,StoreKeyReference> builder)	set the value to the store using the builder function
OrderBuilder	withSyncInfo(Function<SyncInfoBuilder,SyncInfoBuilder> builder)	set the value to the syncInfo using the builder function
OrderBuilder	withTaxedPrice(Function<TaxedPriceBuilder,TaxedPrice> builder)	The taxes are calculated based on the shipping address.
OrderBuilder	withTaxedShippingPrice(Function<TaxedPriceBuilder,TaxedPrice> builder)	Sum of taxedPrice of ShippingInfo across all Shipping Methods.

Methods inherited from class java.lang.Object

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

Constructor Details

OrderBuilder

public OrderBuilder()

Method Details

id

public OrderBuilder id(String id)

Unique identifier of the Order.

Parameters:

id - value to be set

Returns:

Builder

version

public OrderBuilder version(Long version)

The current version of the order.

Parameters:

version - value to be set

Returns:

Builder

createdAt

public OrderBuilder createdAt(ZonedDateTime createdAt)

set the value to the createdAt

Parameters:

createdAt - value to be set

Returns:

Builder

lastModifiedAt

public OrderBuilder lastModifiedAt(ZonedDateTime lastModifiedAt)

set the value to the lastModifiedAt

Parameters:

lastModifiedAt - value to be set

Returns:

Builder

lastModifiedBy

public OrderBuilder 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 OrderBuilder 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 OrderBuilder 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 OrderBuilder 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 OrderBuilder 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 OrderBuilder 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

completedAt

public OrderBuilder completedAt(@Nullable
 ZonedDateTime completedAt)

This field will only be present if it was set for Order Import

Parameters:

completedAt - value to be set

Returns:

Builder

orderNumber

public OrderBuilder orderNumber(@Nullable
 String orderNumber)

String that uniquely identifies an order. It can be used to create more human-readable (in contrast to ID) identifier for the order. It should be unique across a project. Once it's set it cannot be changed.

Parameters:

orderNumber - value to be set

Returns:

Builder

customerId

public OrderBuilder customerId(@Nullable
 String customerId)

set the value to the customerId

Parameters:

customerId - value to be set

Returns:

Builder

customerEmail

public OrderBuilder customerEmail(@Nullable
 String customerEmail)

set the value to the customerEmail

Parameters:

customerEmail - value to be set

Returns:

Builder

anonymousId

public OrderBuilder anonymousId(@Nullable
 String anonymousId)

Identifies carts and orders belonging to an anonymous session (the customer has not signed up/in yet).

Parameters:

anonymousId - value to be set

Returns:

Builder

businessUnit

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

The Business Unit the Order belongs to.

Parameters:

builder - function to build the businessUnit value

Returns:

Builder

withBusinessUnit

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

The Business Unit the Order belongs to.

Parameters:

builder - function to build the businessUnit value

Returns:

Builder

businessUnit

public OrderBuilder businessUnit(@Nullable
 BusinessUnitKeyReference businessUnit)

The Business Unit the Order belongs to.

Parameters:

businessUnit - value to be set

Returns:

Builder

store

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

set the value to the store using the builder function

Parameters:

builder - function to build the store value

Returns:

Builder

withStore

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

set the value to the store using the builder function

Parameters:

builder - function to build the store value

Returns:

Builder

store

public OrderBuilder store(@Nullable
 StoreKeyReference store)

set the value to the store

Parameters:

store - value to be set

Returns:

Builder

lineItems

public OrderBuilder lineItems(LineItem... lineItems)

set values to the lineItems

Parameters:

lineItems - value to be set

Returns:

Builder

lineItems

public OrderBuilder lineItems(List<LineItem> lineItems)

set value to the lineItems

Parameters:

lineItems - value to be set

Returns:

Builder

plusLineItems

public OrderBuilder plusLineItems(LineItem... lineItems)

add values to the lineItems

Parameters:

lineItems - value to be set

Returns:

Builder

plusLineItems

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

add the value to the lineItems using the builder function

Parameters:

builder - function to build the lineItems value

Returns:

Builder

withLineItems

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

set the value to the lineItems using the builder function

Parameters:

builder - function to build the lineItems value

Returns:

Builder

addLineItems

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

add the value to the lineItems using the builder function

Parameters:

builder - function to build the lineItems value

Returns:

Builder

setLineItems

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

set the value to the lineItems using the builder function

Parameters:

builder - function to build the lineItems value

Returns:

Builder

customLineItems

public OrderBuilder customLineItems(CustomLineItem... customLineItems)

set values to the customLineItems

Parameters:

customLineItems - value to be set

Returns:

Builder

customLineItems

public OrderBuilder customLineItems(List<CustomLineItem> customLineItems)

set value to the customLineItems

Parameters:

customLineItems - value to be set

Returns:

Builder

plusCustomLineItems

public OrderBuilder plusCustomLineItems(CustomLineItem... customLineItems)

add values to the customLineItems

Parameters:

customLineItems - value to be set

Returns:

Builder

plusCustomLineItems

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

add the value to the customLineItems using the builder function

Parameters:

builder - function to build the customLineItems value

Returns:

Builder

withCustomLineItems

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

set the value to the customLineItems using the builder function

Parameters:

builder - function to build the customLineItems value

Returns:

Builder

addCustomLineItems

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

add the value to the customLineItems using the builder function

Parameters:

builder - function to build the customLineItems value

Returns:

Builder

setCustomLineItems

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

set the value to the customLineItems using the builder function

Parameters:

builder - function to build the customLineItems value

Returns:

Builder

totalPrice

public OrderBuilder totalPrice(TypedMoney totalPrice)

set the value to the totalPrice

Parameters:

totalPrice - value to be set

Returns:

Builder

totalPrice

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

set the value to the totalPrice using the builder function

Parameters:

builder - function to build the totalPrice value

Returns:

Builder

taxedPrice

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

The taxes are calculated based on the shipping address.

Parameters:

builder - function to build the taxedPrice value

Returns:

Builder

withTaxedPrice

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

The taxes are calculated based on the shipping address.

Parameters:

builder - function to build the taxedPrice value

Returns:

Builder

taxedPrice

public OrderBuilder taxedPrice(@Nullable
 TaxedPrice taxedPrice)

The taxes are calculated based on the shipping address.

Parameters:

taxedPrice - value to be set

Returns:

Builder

taxedShippingPrice

public OrderBuilder taxedShippingPrice(Function<TaxedPriceBuilder,TaxedPriceBuilder> builder)

Sum of taxedPrice of ShippingInfo across all Shipping Methods. For Platform TaxMode, it is set automatically only if shipping address is set or Shipping Method is added to the Cart.

Parameters:

builder - function to build the taxedShippingPrice value

Returns:

Builder

withTaxedShippingPrice

public OrderBuilder withTaxedShippingPrice(Function<TaxedPriceBuilder,TaxedPrice> builder)

Sum of taxedPrice of ShippingInfo across all Shipping Methods. For Platform TaxMode, it is set automatically only if shipping address is set or Shipping Method is added to the Cart.

Parameters:

builder - function to build the taxedShippingPrice value

Returns:

Builder

taxedShippingPrice

public OrderBuilder taxedShippingPrice(@Nullable
 TaxedPrice taxedShippingPrice)

Sum of taxedPrice of ShippingInfo across all Shipping Methods. For Platform TaxMode, it is set automatically only if shipping address is set or Shipping Method is added to the Cart.

Parameters:

taxedShippingPrice - value to be set

Returns:

Builder

shippingAddress

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

Holds all shipping-related information per Shipping Method.

For Multi ShippingMode, it is updated automatically after the Shipping Methods are added.

Parameters:

builder - function to build the shippingAddress value

Returns:

Builder

withShippingAddress

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

Holds all shipping-related information per Shipping Method.

For Multi ShippingMode, it is updated automatically after the Shipping Methods are added.

Parameters:

builder - function to build the shippingAddress value

Returns:

Builder

shippingAddress

public OrderBuilder shippingAddress(@Nullable
 Address shippingAddress)

Holds all shipping-related information per Shipping Method.

For Multi ShippingMode, it is updated automatically after the Shipping Methods are added.

Parameters:

shippingAddress - value to be set

Returns:

Builder

billingAddress

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

set the value to the billingAddress using the builder function

Parameters:

builder - function to build the billingAddress value

Returns:

Builder

withBillingAddress

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

set the value to the billingAddress using the builder function

Parameters:

builder - function to build the billingAddress value

Returns:

Builder

billingAddress

public OrderBuilder billingAddress(@Nullable
 Address billingAddress)

set the value to the billingAddress

Parameters:

billingAddress - value to be set

Returns:

Builder

shippingMode

public OrderBuilder shippingMode(ShippingMode shippingMode)

Indicates whether one or multiple Shipping Methods are added to the Cart.

Parameters:

shippingMode - value to be set

Returns:

Builder

shippingKey

public OrderBuilder shippingKey(@Nullable
 String shippingKey)

User-defined unique identifier of the Shipping Method with Single ShippingMode.

Parameters:

shippingKey - value to be set

Returns:

Builder

shippingCustomFields

public OrderBuilder shippingCustomFields(Function<CustomFieldsBuilder,CustomFieldsBuilder> builder)

Custom Fields of the Shipping Method for Single ShippingMode.

Parameters:

builder - function to build the shippingCustomFields value

Returns:

Builder

withShippingCustomFields

public OrderBuilder withShippingCustomFields(Function<CustomFieldsBuilder,CustomFields> builder)

Custom Fields of the Shipping Method for Single ShippingMode.

Parameters:

builder - function to build the shippingCustomFields value

Returns:

Builder

shippingCustomFields

public OrderBuilder shippingCustomFields(@Nullable
 CustomFields shippingCustomFields)

Custom Fields of the Shipping Method for Single ShippingMode.

Parameters:

shippingCustomFields - value to be set

Returns:

Builder

shipping

public OrderBuilder shipping(Shipping... shipping)

Holds all shipping-related information per Shipping Method for Multi ShippingMode.

It is updated automatically after the Shipping Method is added.

Parameters:

shipping - value to be set

Returns:

Builder

shipping

public OrderBuilder shipping(List<Shipping> shipping)

Holds all shipping-related information per Shipping Method for Multi ShippingMode.

It is updated automatically after the Shipping Method is added.

Parameters:

shipping - value to be set

Returns:

Builder

plusShipping

public OrderBuilder plusShipping(Shipping... shipping)

Holds all shipping-related information per Shipping Method for Multi ShippingMode.

It is updated automatically after the Shipping Method is added.

Parameters:

shipping - value to be set

Returns:

Builder

plusShipping

public OrderBuilder plusShipping(Function<ShippingBuilder,ShippingBuilder> builder)

Holds all shipping-related information per Shipping Method for Multi ShippingMode.

It is updated automatically after the Shipping Method is added.

Parameters:

builder - function to build the shipping value

Returns:

Builder

withShipping

public OrderBuilder withShipping(Function<ShippingBuilder,ShippingBuilder> builder)

Holds all shipping-related information per Shipping Method for Multi ShippingMode.

It is updated automatically after the Shipping Method is added.

Parameters:

builder - function to build the shipping value

Returns:

Builder

addShipping

public OrderBuilder addShipping(Function<ShippingBuilder,Shipping> builder)

Holds all shipping-related information per Shipping Method for Multi ShippingMode.

It is updated automatically after the Shipping Method is added.

Parameters:

builder - function to build the shipping value

Returns:

Builder

setShipping

public OrderBuilder setShipping(Function<ShippingBuilder,Shipping> builder)

Holds all shipping-related information per Shipping Method for Multi ShippingMode.

It is updated automatically after the Shipping Method is added.

Parameters:

builder - function to build the shipping value

Returns:

Builder

taxMode

public OrderBuilder taxMode(@Nullable
 TaxMode taxMode)

set the value to the taxMode

Parameters:

taxMode - value to be set

Returns:

Builder

taxRoundingMode

public OrderBuilder taxRoundingMode(@Nullable
 RoundingMode taxRoundingMode)

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

Parameters:

taxRoundingMode - value to be set

Returns:

Builder

customerGroup

public OrderBuilder customerGroup(Function<CustomerGroupReferenceBuilder,CustomerGroupReferenceBuilder> 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 OrderBuilder withCustomerGroup(Function<CustomerGroupReferenceBuilder,CustomerGroupReference> 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 OrderBuilder customerGroup(@Nullable
 CustomerGroupReference 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

public OrderBuilder country(@Nullable
 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

Returns:

Builder

orderState

public OrderBuilder orderState(OrderState orderState)

One of the four predefined OrderStates.

Parameters:

orderState - value to be set

Returns:

Builder

state

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

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

Parameters:

builder - function to build the state value

Returns:

Builder

withState

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

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

Parameters:

builder - function to build the state value

Returns:

Builder

state

public OrderBuilder state(@Nullable
 StateReference state)

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

Parameters:

state - value to be set

Returns:

Builder

shipmentState

public OrderBuilder shipmentState(@Nullable
 ShipmentState shipmentState)

set the value to the shipmentState

Parameters:

shipmentState - value to be set

Returns:

Builder

paymentState

public OrderBuilder paymentState(@Nullable
 PaymentState paymentState)

set the value to the paymentState

Parameters:

paymentState - value to be set

Returns:

Builder

shippingInfo

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

Set if the ShippingMethod is set.

Parameters:

builder - function to build the shippingInfo value

Returns:

Builder

withShippingInfo

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

Set if the ShippingMethod is set.

Parameters:

builder - function to build the shippingInfo value

Returns:

Builder

shippingInfo

public OrderBuilder shippingInfo(@Nullable
 ShippingInfo shippingInfo)

Set if the ShippingMethod is set.

Parameters:

shippingInfo - value to be set

Returns:

Builder

syncInfo

public OrderBuilder syncInfo(SyncInfo... syncInfo)

set values to the syncInfo

Parameters:

syncInfo - value to be set

Returns:

Builder

syncInfo

public OrderBuilder syncInfo(List<SyncInfo> syncInfo)

set value to the syncInfo

Parameters:

syncInfo - value to be set

Returns:

Builder

plusSyncInfo

public OrderBuilder plusSyncInfo(SyncInfo... syncInfo)

add values to the syncInfo

Parameters:

syncInfo - value to be set

Returns:

Builder

plusSyncInfo

public OrderBuilder plusSyncInfo(Function<SyncInfoBuilder,SyncInfoBuilder> builder)

add the value to the syncInfo using the builder function

Parameters:

builder - function to build the syncInfo value

Returns:

Builder

withSyncInfo

public OrderBuilder withSyncInfo(Function<SyncInfoBuilder,SyncInfoBuilder> builder)

set the value to the syncInfo using the builder function

Parameters:

builder - function to build the syncInfo value

Returns:

Builder

addSyncInfo

public OrderBuilder addSyncInfo(Function<SyncInfoBuilder,SyncInfo> builder)

add the value to the syncInfo using the builder function

Parameters:

builder - function to build the syncInfo value

Returns:

Builder

setSyncInfo

public OrderBuilder setSyncInfo(Function<SyncInfoBuilder,SyncInfo> builder)

set the value to the syncInfo using the builder function

Parameters:

builder - function to build the syncInfo value

Returns:

Builder

returnInfo

public OrderBuilder returnInfo(@Nullable
 ReturnInfo... returnInfo)

set values to the returnInfo

Parameters:

returnInfo - value to be set

Returns:

Builder

returnInfo

public OrderBuilder returnInfo(@Nullable
 List<ReturnInfo> returnInfo)

set value to the returnInfo

Parameters:

returnInfo - value to be set

Returns:

Builder

plusReturnInfo

public OrderBuilder plusReturnInfo(@Nullable
 ReturnInfo... returnInfo)

add values to the returnInfo

Parameters:

returnInfo - value to be set

Returns:

Builder

plusReturnInfo

public OrderBuilder plusReturnInfo(Function<ReturnInfoBuilder,ReturnInfoBuilder> builder)

add the value to the returnInfo using the builder function

Parameters:

builder - function to build the returnInfo value

Returns:

Builder

withReturnInfo

public OrderBuilder withReturnInfo(Function<ReturnInfoBuilder,ReturnInfoBuilder> builder)

set the value to the returnInfo using the builder function

Parameters:

builder - function to build the returnInfo value

Returns:

Builder

addReturnInfo

public OrderBuilder addReturnInfo(Function<ReturnInfoBuilder,ReturnInfo> builder)

add the value to the returnInfo using the builder function

Parameters:

builder - function to build the returnInfo value

Returns:

Builder

setReturnInfo

public OrderBuilder setReturnInfo(Function<ReturnInfoBuilder,ReturnInfo> builder)

set the value to the returnInfo using the builder function

Parameters:

builder - function to build the returnInfo value

Returns:

Builder

purchaseOrderNumber

public OrderBuilder purchaseOrderNumber(@Nullable
 String purchaseOrderNumber)

The Purchase Order Number is typically set by the Buyer on a QuoteRequest to track the purchase order during the quote and order flow.

Parameters:

purchaseOrderNumber - value to be set

Returns:

Builder

discountCodes

public OrderBuilder discountCodes(@Nullable
 DiscountCodeInfo... discountCodes)

set values to the discountCodes

Parameters:

discountCodes - value to be set

Returns:

Builder

discountCodes

public OrderBuilder discountCodes(@Nullable
 List<DiscountCodeInfo> discountCodes)

set value to the discountCodes

Parameters:

discountCodes - value to be set

Returns:

Builder

plusDiscountCodes

public OrderBuilder plusDiscountCodes(@Nullable
 DiscountCodeInfo... discountCodes)

add values to the discountCodes

Parameters:

discountCodes - value to be set

Returns:

Builder

plusDiscountCodes

public OrderBuilder plusDiscountCodes(Function<DiscountCodeInfoBuilder,DiscountCodeInfoBuilder> builder)

add the value to the discountCodes using the builder function

Parameters:

builder - function to build the discountCodes value

Returns:

Builder

withDiscountCodes

public OrderBuilder withDiscountCodes(Function<DiscountCodeInfoBuilder,DiscountCodeInfoBuilder> builder)

set the value to the discountCodes using the builder function

Parameters:

builder - function to build the discountCodes value

Returns:

Builder

addDiscountCodes

public OrderBuilder addDiscountCodes(Function<DiscountCodeInfoBuilder,DiscountCodeInfo> builder)

add the value to the discountCodes using the builder function

Parameters:

builder - function to build the discountCodes value

Returns:

Builder

setDiscountCodes

public OrderBuilder setDiscountCodes(Function<DiscountCodeInfoBuilder,DiscountCodeInfo> builder)

set the value to the discountCodes using the builder function

Parameters:

builder - function to build the discountCodes value

Returns:

Builder

lastMessageSequenceNumber

@Deprecated
public OrderBuilder lastMessageSequenceNumber(@Nullable
 Long lastMessageSequenceNumber)

Deprecated.

Internal-only field.

Parameters:

lastMessageSequenceNumber - value to be set

Returns:

Builder

cart

public OrderBuilder cart(Function<CartReferenceBuilder,CartReferenceBuilder> builder)

Set when this order was created from a cart. The cart will have the state Ordered.

Parameters:

builder - function to build the cart value

Returns:

Builder

withCart

public OrderBuilder withCart(Function<CartReferenceBuilder,CartReference> builder)

Set when this order was created from a cart. The cart will have the state Ordered.

Parameters:

builder - function to build the cart value

Returns:

Builder

cart

public OrderBuilder cart(@Nullable
 CartReference cart)

Set when this order was created from a cart. The cart will have the state Ordered.

Parameters:

cart - value to be set

Returns:

Builder

quote

public OrderBuilder quote(Function<QuoteReferenceBuilder,QuoteReferenceBuilder> builder)

Set when this order was created from a quote.

Parameters:

builder - function to build the quote value

Returns:

Builder

withQuote

public OrderBuilder withQuote(Function<QuoteReferenceBuilder,QuoteReference> builder)

Set when this order was created from a quote.

Parameters:

builder - function to build the quote value

Returns:

Builder

quote

public OrderBuilder quote(@Nullable
 QuoteReference quote)

Set when this order was created from a quote.

Parameters:

quote - value to be set

Returns:

Builder

custom

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

set the value to the custom using the builder function

Parameters:

builder - function to build the custom value

Returns:

Builder

withCustom

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

set the value to the custom using the builder function

Parameters:

builder - function to build the custom value

Returns:

Builder

custom

public OrderBuilder custom(@Nullable
 CustomFields custom)

set the value to the custom

Parameters:

custom - value to be set

Returns:

Builder

paymentInfo

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

set the value to the paymentInfo using the builder function

Parameters:

builder - function to build the paymentInfo value

Returns:

Builder

withPaymentInfo

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

set the value to the paymentInfo using the builder function

Parameters:

builder - function to build the paymentInfo value

Returns:

Builder

paymentInfo

public OrderBuilder paymentInfo(@Nullable
 PaymentInfo paymentInfo)

set the value to the paymentInfo

Parameters:

paymentInfo - value to be set

Returns:

Builder

locale

public OrderBuilder locale(@Nullable
 String locale)

set the value to the locale

Parameters:

locale - value to be set

Returns:

Builder

inventoryMode

public OrderBuilder inventoryMode(@Nullable
 InventoryMode inventoryMode)

set the value to the inventoryMode

Parameters:

inventoryMode - value to be set

Returns:

Builder

origin

public OrderBuilder origin(CartOrigin origin)

set the value to the origin

Parameters:

origin - value to be set

Returns:

Builder

taxCalculationMode

public OrderBuilder taxCalculationMode(@Nullable
 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

shippingRateInput

public OrderBuilder shippingRateInput(@Nullable
 ShippingRateInput shippingRateInput)

Input used to select a ShippingRatePriceTier. The data type of this field depends on the shippingRateInputType.type configured in the Project:

• If CartClassification, it is ClassificationShippingRateInput.
• If CartScore, it is ScoreShippingRateInput.
• If CartValue, it cannot be used.

Parameters:

shippingRateInput - value to be set

Returns:

Builder

shippingRateInput

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

Input used to select a ShippingRatePriceTier. The data type of this field depends on the shippingRateInputType.type configured in the Project:

• If CartClassification, it is ClassificationShippingRateInput.
• If CartScore, it is ScoreShippingRateInput.
• If CartValue, it cannot be used.

Parameters:

builder - function to build the shippingRateInput value

Returns:

Builder

itemShippingAddresses

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

Contains addresses for orders with multiple shipping addresses.

Parameters:

itemShippingAddresses - value to be set

Returns:

Builder

itemShippingAddresses

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

Contains addresses for orders with multiple shipping addresses.

Parameters:

itemShippingAddresses - value to be set

Returns:

Builder

plusItemShippingAddresses

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

Contains addresses for orders with multiple shipping addresses.

Parameters:

itemShippingAddresses - value to be set

Returns:

Builder

plusItemShippingAddresses

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

Contains addresses for orders with multiple shipping addresses.

Parameters:

builder - function to build the itemShippingAddresses value

Returns:

Builder

withItemShippingAddresses

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

Contains addresses for orders with multiple shipping addresses.

Parameters:

builder - function to build the itemShippingAddresses value

Returns:

Builder

addItemShippingAddresses

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

Contains addresses for orders with multiple shipping addresses.

Parameters:

builder - function to build the itemShippingAddresses value

Returns:

Builder

setItemShippingAddresses

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

Contains addresses for orders with multiple shipping addresses.

Parameters:

builder - function to build the itemShippingAddresses value

Returns:

Builder

refusedGifts

public OrderBuilder refusedGifts(CartDiscountReference... refusedGifts)

Automatically filled when a line item with LineItemMode GiftLineItem is removed from this order.

Parameters:

refusedGifts - value to be set

Returns:

Builder

refusedGifts

public OrderBuilder refusedGifts(List<CartDiscountReference> refusedGifts)

Automatically filled when a line item with LineItemMode GiftLineItem is removed from this order.

Parameters:

refusedGifts - value to be set

Returns:

Builder

plusRefusedGifts

public OrderBuilder plusRefusedGifts(CartDiscountReference... refusedGifts)

Automatically filled when a line item with LineItemMode GiftLineItem is removed from this order.

Parameters:

refusedGifts - value to be set

Returns:

Builder

plusRefusedGifts

public OrderBuilder plusRefusedGifts(Function<CartDiscountReferenceBuilder,CartDiscountReferenceBuilder> builder)

Automatically filled when a line item with LineItemMode GiftLineItem is removed from this order.

Parameters:

builder - function to build the refusedGifts value

Returns:

Builder

withRefusedGifts

public OrderBuilder withRefusedGifts(Function<CartDiscountReferenceBuilder,CartDiscountReferenceBuilder> builder)

Automatically filled when a line item with LineItemMode GiftLineItem is removed from this order.

Parameters:

builder - function to build the refusedGifts value

Returns:

Builder

addRefusedGifts

public OrderBuilder addRefusedGifts(Function<CartDiscountReferenceBuilder,CartDiscountReference> builder)

Automatically filled when a line item with LineItemMode GiftLineItem is removed from this order.

Parameters:

builder - function to build the refusedGifts value

Returns:

Builder

setRefusedGifts

public OrderBuilder setRefusedGifts(Function<CartDiscountReferenceBuilder,CartDiscountReference> builder)

Automatically filled when a line item with LineItemMode GiftLineItem is removed from this order.

Parameters:

builder - function to build the refusedGifts value

Returns:

Builder

getId

public String getId()

Unique identifier of the Order.

Returns:

id

getVersion

public Long getVersion()

The current version of the order.

Returns:

version

getCreatedAt

public ZonedDateTime getCreatedAt()

value of createdAt}

Returns:

createdAt

getLastModifiedAt

public ZonedDateTime getLastModifiedAt()

value of lastModifiedAt}

Returns:

lastModifiedAt

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

getCompletedAt

@Nullable
public ZonedDateTime getCompletedAt()

This field will only be present if it was set for Order Import

Returns:

completedAt

getOrderNumber

@Nullable
public String getOrderNumber()

String that uniquely identifies an order. It can be used to create more human-readable (in contrast to ID) identifier for the order. It should be unique across a project. Once it's set it cannot be changed.

Returns:

orderNumber

getCustomerId

@Nullable
public String getCustomerId()

value of customerId}

Returns:

customerId

getCustomerEmail

@Nullable
public String getCustomerEmail()

value of customerEmail}

Returns:

customerEmail

getAnonymousId

@Nullable
public String getAnonymousId()

Identifies carts and orders belonging to an anonymous session (the customer has not signed up/in yet).

Returns:

anonymousId

getBusinessUnit

@Nullable
public BusinessUnitKeyReference getBusinessUnit()

The Business Unit the Order belongs to.

Returns:

businessUnit

getStore

@Nullable
public StoreKeyReference getStore()

value of store}

Returns:

store

getLineItems

public List<LineItem> getLineItems()

value of lineItems}

Returns:

lineItems

getCustomLineItems

public List<CustomLineItem> getCustomLineItems()

value of customLineItems}

Returns:

customLineItems

getTotalPrice

public TypedMoney getTotalPrice()

value of totalPrice}

Returns:

totalPrice

getTaxedPrice

@Nullable
public TaxedPrice getTaxedPrice()

The taxes are calculated based on the shipping address.

Returns:

taxedPrice

getTaxedShippingPrice

@Nullable
public TaxedPrice getTaxedShippingPrice()

Sum of taxedPrice of ShippingInfo across all Shipping Methods. For Platform TaxMode, it is set automatically only if shipping address is set or Shipping Method is added to the Cart.

Returns:

taxedShippingPrice

getShippingAddress

@Nullable
public Address getShippingAddress()

Holds all shipping-related information per Shipping Method.

For Multi ShippingMode, it is updated automatically after the Shipping Methods are added.

Returns:

shippingAddress

getBillingAddress

@Nullable
public Address getBillingAddress()

value of billingAddress}

Returns:

billingAddress

getShippingMode

public ShippingMode getShippingMode()

Indicates whether one or multiple Shipping Methods are added to the Cart.

Returns:

shippingMode

getShippingKey

@Nullable
public String getShippingKey()

User-defined unique identifier of the Shipping Method with Single ShippingMode.

Returns:

shippingKey

getShippingCustomFields

@Nullable
public CustomFields getShippingCustomFields()

Custom Fields of the Shipping Method for Single ShippingMode.

Returns:

shippingCustomFields

getShipping

public List<Shipping> getShipping()

Holds all shipping-related information per Shipping Method for Multi ShippingMode.

It is updated automatically after the Shipping Method is added.

Returns:

shipping

getTaxMode

@Nullable
public TaxMode getTaxMode()

value of taxMode}

Returns:

taxMode

getTaxRoundingMode

@Nullable
public RoundingMode getTaxRoundingMode()

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

Returns:

taxRoundingMode

getCustomerGroup

@Nullable
public CustomerGroupReference 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

@Nullable
public String getCountry()

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

Returns:

country

getOrderState

public OrderState getOrderState()

One of the four predefined OrderStates.

Returns:

orderState

getState

@Nullable
public StateReference getState()

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

Returns:

state

getShipmentState

@Nullable
public ShipmentState getShipmentState()

value of shipmentState}

Returns:

shipmentState

getPaymentState

@Nullable
public PaymentState getPaymentState()

value of paymentState}

Returns:

paymentState

getShippingInfo

@Nullable
public ShippingInfo getShippingInfo()

Set if the ShippingMethod is set.

Returns:

shippingInfo

getSyncInfo

public List<SyncInfo> getSyncInfo()

value of syncInfo}

Returns:

syncInfo

getReturnInfo

@Nullable
public List<ReturnInfo> getReturnInfo()

value of returnInfo}

Returns:

returnInfo

getPurchaseOrderNumber

@Nullable
public String getPurchaseOrderNumber()

The Purchase Order Number is typically set by the Buyer on a QuoteRequest to track the purchase order during the quote and order flow.

Returns:

purchaseOrderNumber

getDiscountCodes

@Nullable
public List<DiscountCodeInfo> getDiscountCodes()

value of discountCodes}

Returns:

discountCodes

getLastMessageSequenceNumber

@Deprecated
@Nullable
public Long getLastMessageSequenceNumber()

Deprecated.

Internal-only field.

Returns:

lastMessageSequenceNumber

getCart

@Nullable
public CartReference getCart()

Set when this order was created from a cart. The cart will have the state Ordered.

Returns:

cart

getQuote

@Nullable
public QuoteReference getQuote()

Set when this order was created from a quote.

Returns:

quote

getCustom

@Nullable
public CustomFields getCustom()

value of custom}

Returns:

custom

getPaymentInfo

@Nullable
public PaymentInfo getPaymentInfo()

value of paymentInfo}

Returns:

paymentInfo

getLocale

@Nullable
public String getLocale()

value of locale}

Returns:

locale

getInventoryMode

@Nullable
public InventoryMode getInventoryMode()

value of inventoryMode}

Returns:

inventoryMode

getOrigin

public CartOrigin getOrigin()

value of origin}

Returns:

origin

getTaxCalculationMode

@Nullable
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

getShippingRateInput

@Nullable
public ShippingRateInput getShippingRateInput()

Input used to select a ShippingRatePriceTier. The data type of this field depends on the shippingRateInputType.type configured in the Project:

• If CartClassification, it is ClassificationShippingRateInput.
• If CartScore, it is ScoreShippingRateInput.
• If CartValue, it cannot be used.

Returns:

shippingRateInput

getItemShippingAddresses

@Nullable
public List<Address> getItemShippingAddresses()

Contains addresses for orders with multiple shipping addresses.

Returns:

itemShippingAddresses

getRefusedGifts

public List<CartDiscountReference> getRefusedGifts()

Automatically filled when a line item with LineItemMode GiftLineItem is removed from this order.

Returns:

refusedGifts

build

public Order build()

builds Order with checking for non-null required values

Specified by:

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

Returns:

Order

buildUnchecked

public Order buildUnchecked()

builds Order without checking for non-null required values

Returns:

Order

of

public static OrderBuilder of()

factory method for an instance of OrderBuilder

Returns:

builder

of

public static OrderBuilder of(Order template)

create builder for Order instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder