Class StagedOrderBuilder
- All Implemented Interfaces:
io.vrap.rmf.base.client.Builder<StagedOrder>
Example to create an instance using the builder pattern
StagedOrder stagedOrder = StagedOrder.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
-
Method Summary
Modifier and TypeMethodDescriptionadd the value to the customLineItems using the builder functionadd the value to the discountCodes using the builder functionContains addresses for orders with multiple shipping addresses.addLineItems
(Function<LineItemBuilder, LineItem> builder) add the value to the lineItems using the builder functionAutomatically filled when a line item with LineItemModeGiftLineItem
is removed from this order.addReturnInfo
(Function<ReturnInfoBuilder, ReturnInfo> builder) add the value to the returnInfo using the builder functionaddShipping
(Function<ShippingBuilder, Shipping> builder) Holds all shipping-related information per Shipping Method forMulti
ShippingMode.addSyncInfo
(Function<SyncInfoBuilder, SyncInfo> builder) add the value to the syncInfo using the builder functionanonymousId
(String anonymousId) Identifies carts and orders belonging to an anonymous session (the customer has not signed up/in yet).billingAddress
(Address billingAddress) set the value to the billingAddressbillingAddress
(Function<AddressBuilder, AddressBuilder> builder) set the value to the billingAddress using the builder functionbuild()
builds StagedOrder with checking for non-null required valuesbuilds StagedOrder without checking for non-null required valuesbusinessUnit
(BusinessUnitKeyReference businessUnit) The Business Unit the Order belongs to.The Business Unit the Order belongs to.cart
(CartReference cart) Set when this order was created from a cart.cart
(Function<CartReferenceBuilder, CartReferenceBuilder> builder) Set when this order was created from a cart.completedAt
(ZonedDateTime completedAt) This field will only be present if it was set for Order ImportA two-digit country code as per ISO 3166-1 alpha-2.createdAt
(ZonedDateTime createdAt) set the value to the createdAtPresent on resources created after 1 February 2019 except for events not tracked.createdBy
(Function<CreatedByBuilder, CreatedByBuilder> builder) Present on resources created after 1 February 2019 except for events not tracked.custom
(CustomFields custom) set the value to the customcustom
(Function<CustomFieldsBuilder, CustomFieldsBuilder> builder) set the value to the custom using the builder functioncustomerEmail
(String customerEmail) set the value to the customerEmailcustomerGroup
(CustomerGroupReference customerGroup) Set when the customer is set and the customer is a member of a customer group.Set when the customer is set and the customer is a member of a customer group.customerId
(String customerId) set the value to the customerIdcustomLineItems
(CustomLineItem... customLineItems) set values to the customLineItemscustomLineItems
(List<CustomLineItem> customLineItems) set value to the customLineItemsdiscountCodes
(DiscountCodeInfo... discountCodes) set values to the discountCodesdiscountCodes
(List<DiscountCodeInfo> discountCodes) set value to the discountCodesIdentifies carts and orders belonging to an anonymous session (the customer has not signed up/in yet).value of billingAddress}The Business Unit the Order belongs to.getCart()
Set when this order was created from a cart.This field will only be present if it was set for Order ImportA two-digit country code as per ISO 3166-1 alpha-2.value of createdAt}Present on resources created after 1 February 2019 except for events not tracked.value of custom}value of customerEmail}Set when the customer is set and the customer is a member of a customer group.value of customerId}value of customLineItems}value of discountCodes}getId()
Unique identifier of the Order.value of inventoryMode}Contains addresses for orders with multiple shipping addresses.Deprecated.value of lastModifiedAt}Present on resources created after 1 February 2019 except for events not tracked.value of lineItems}value of locale}String that uniquely identifies an order.One of the four predefined OrderStates.value of origin}value of paymentInfo}value of paymentState}The Purchase Order Number is typically set by the Buyer on a QuoteRequest to track the purchase order during the quote and order flow.getQuote()
Set when this order was created from a quote.Automatically filled when a line item with LineItemModeGiftLineItem
is removed from this order.value of returnInfo}value of shipmentState}Holds all shipping-related information per Shipping Method forMulti
ShippingMode.Holds all shipping-related information per Shipping Method.Custom Fields of the Shipping Method forSingle
ShippingMode.Set if the ShippingMethod is set.User-defined unique identifier of the Shipping Method withSingle
ShippingMode.Indicates whether one or multiple Shipping Methods are added to the Cart.Input used to select a ShippingRatePriceTier.getState()
This reference can point to a state in a custom workflow.getStore()
value of store}value of syncInfo}When calculating taxes fortaxedPrice
, the selected mode is used for calculating the price with LineItemLevel (horizontally) or UnitPriceLevel (vertically) calculation mode.The taxes are calculated based on the shipping address.Sum oftaxedPrice
of ShippingInfo across all Shipping Methods.value of taxMode}When calculating taxes fortaxedPrice
, the selected mode is used for rouding.value of totalPrice}The current version of the order.Unique identifier of the Order.inventoryMode
(InventoryMode inventoryMode) set the value to the inventoryModeitemShippingAddresses
(Address... itemShippingAddresses) Contains addresses for orders with multiple shipping addresses.itemShippingAddresses
(List<Address> itemShippingAddresses) Contains addresses for orders with multiple shipping addresses.lastMessageSequenceNumber
(Long lastMessageSequenceNumber) Deprecated.lastModifiedAt
(ZonedDateTime lastModifiedAt) set the value to the lastModifiedAtlastModifiedBy
(LastModifiedBy lastModifiedBy) Present on resources created after 1 February 2019 except for events not tracked.Present on resources created after 1 February 2019 except for events not tracked.set values to the lineItemsset value to the lineItemsset the value to the localestatic StagedOrderBuilder
of()
factory method for an instance of StagedOrderBuilderstatic StagedOrderBuilder
of
(StagedOrder template) create builder for StagedOrder instanceorderNumber
(String orderNumber) String that uniquely identifies an order.orderState
(OrderState orderState) One of the four predefined OrderStates.origin
(CartOrigin origin) set the value to the originpaymentInfo
(PaymentInfo paymentInfo) set the value to the paymentInfoset the value to the paymentInfo using the builder functionpaymentState
(PaymentState paymentState) set the value to the paymentStateplusCustomLineItems
(CustomLineItem... customLineItems) add values to the customLineItemsadd the value to the customLineItems using the builder functionplusDiscountCodes
(DiscountCodeInfo... discountCodes) add values to the discountCodesadd the value to the discountCodes using the builder functionplusItemShippingAddresses
(Address... itemShippingAddresses) Contains addresses for orders with multiple shipping addresses.Contains addresses for orders with multiple shipping addresses.plusLineItems
(LineItem... lineItems) add values to the lineItemsplusLineItems
(Function<LineItemBuilder, LineItemBuilder> builder) add the value to the lineItems using the builder functionplusRefusedGifts
(CartDiscountReference... refusedGifts) Automatically filled when a line item with LineItemModeGiftLineItem
is removed from this order.Automatically filled when a line item with LineItemModeGiftLineItem
is removed from this order.plusReturnInfo
(ReturnInfo... returnInfo) add values to the returnInfoadd the value to the returnInfo using the builder functionplusShipping
(Shipping... shipping) Holds all shipping-related information per Shipping Method forMulti
ShippingMode.plusShipping
(Function<ShippingBuilder, ShippingBuilder> builder) Holds all shipping-related information per Shipping Method forMulti
ShippingMode.plusSyncInfo
(SyncInfo... syncInfo) add values to the syncInfoplusSyncInfo
(Function<SyncInfoBuilder, SyncInfoBuilder> builder) add the value to the syncInfo using the builder functionpurchaseOrderNumber
(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.quote
(QuoteReference quote) Set when this order was created from a quote.Set when this order was created from a quote.refusedGifts
(CartDiscountReference... refusedGifts) Automatically filled when a line item with LineItemModeGiftLineItem
is removed from this order.refusedGifts
(List<CartDiscountReference> refusedGifts) Automatically filled when a line item with LineItemModeGiftLineItem
is removed from this order.returnInfo
(ReturnInfo... returnInfo) set values to the returnInforeturnInfo
(List<ReturnInfo> returnInfo) set value to the returnInfoset the value to the customLineItems using the builder functionset the value to the discountCodes using the builder functionContains addresses for orders with multiple shipping addresses.setLineItems
(Function<LineItemBuilder, LineItem> builder) set the value to the lineItems using the builder functionAutomatically filled when a line item with LineItemModeGiftLineItem
is removed from this order.setReturnInfo
(Function<ReturnInfoBuilder, ReturnInfo> builder) set the value to the returnInfo using the builder functionsetShipping
(Function<ShippingBuilder, Shipping> builder) Holds all shipping-related information per Shipping Method forMulti
ShippingMode.setSyncInfo
(Function<SyncInfoBuilder, SyncInfo> builder) set the value to the syncInfo using the builder functionshipmentState
(ShipmentState shipmentState) set the value to the shipmentStateHolds all shipping-related information per Shipping Method forMulti
ShippingMode.Holds all shipping-related information per Shipping Method forMulti
ShippingMode.shippingAddress
(Address shippingAddress) Holds all shipping-related information per Shipping Method.shippingAddress
(Function<AddressBuilder, AddressBuilder> builder) Holds all shipping-related information per Shipping Method.shippingCustomFields
(CustomFields shippingCustomFields) Custom Fields of the Shipping Method forSingle
ShippingMode.Custom Fields of the Shipping Method forSingle
ShippingMode.shippingInfo
(ShippingInfo shippingInfo) Set if the ShippingMethod is set.Set if the ShippingMethod is set.shippingKey
(String shippingKey) User-defined unique identifier of the Shipping Method withSingle
ShippingMode.shippingMode
(ShippingMode shippingMode) Indicates whether one or multiple Shipping Methods are added to the Cart.shippingRateInput
(ShippingRateInput shippingRateInput) Input used to select a ShippingRatePriceTier.shippingRateInput
(Function<ShippingRateInputBuilder, io.vrap.rmf.base.client.Builder<? extends ShippingRateInput>> builder) Input used to select a ShippingRatePriceTier.state
(StateReference state) This reference can point to a state in a custom workflow.This reference can point to a state in a custom workflow.store
(StoreKeyReference store) set the value to the storeset the value to the store using the builder functionset values to the syncInfoset value to the syncInfotaxCalculationMode
(TaxCalculationMode taxCalculationMode) When calculating taxes fortaxedPrice
, the selected mode is used for calculating the price with LineItemLevel (horizontally) or UnitPriceLevel (vertically) calculation mode.taxedPrice
(TaxedPrice taxedPrice) The taxes are calculated based on the shipping address.taxedPrice
(Function<TaxedPriceBuilder, TaxedPriceBuilder> builder) The taxes are calculated based on the shipping address.taxedShippingPrice
(TaxedPrice taxedShippingPrice) Sum oftaxedPrice
of ShippingInfo across all Shipping Methods.Sum oftaxedPrice
of ShippingInfo across all Shipping Methods.set the value to the taxModetaxRoundingMode
(RoundingMode taxRoundingMode) When calculating taxes fortaxedPrice
, the selected mode is used for rouding.totalPrice
(TypedMoney totalPrice) set the value to the totalPricetotalPrice
(Function<TypedMoneyBuilder, io.vrap.rmf.base.client.Builder<? extends TypedMoney>> builder) set the value to the totalPrice using the builder functionThe current version of the order.withBillingAddress
(Function<AddressBuilder, Address> builder) set the value to the billingAddress using the builder functionThe Business Unit the Order belongs to.withCart
(Function<CartReferenceBuilder, CartReference> builder) Set when this order was created from a cart.withCreatedBy
(Function<CreatedByBuilder, CreatedBy> builder) Present on resources created after 1 February 2019 except for events not tracked.withCustom
(Function<CustomFieldsBuilder, CustomFields> builder) set the value to the custom using the builder functionSet when the customer is set and the customer is a member of a customer group.set the value to the customLineItems using the builder functionset the value to the discountCodes using the builder functionContains addresses for orders with multiple shipping addresses.Present on resources created after 1 February 2019 except for events not tracked.withLineItems
(Function<LineItemBuilder, LineItemBuilder> builder) set the value to the lineItems using the builder functionwithPaymentInfo
(Function<PaymentInfoBuilder, PaymentInfo> builder) set the value to the paymentInfo using the builder functionwithQuote
(Function<QuoteReferenceBuilder, QuoteReference> builder) Set when this order was created from a quote.Automatically filled when a line item with LineItemModeGiftLineItem
is removed from this order.set the value to the returnInfo using the builder functionwithShipping
(Function<ShippingBuilder, ShippingBuilder> builder) Holds all shipping-related information per Shipping Method forMulti
ShippingMode.withShippingAddress
(Function<AddressBuilder, Address> builder) Holds all shipping-related information per Shipping Method.Custom Fields of the Shipping Method forSingle
ShippingMode.Set if the ShippingMethod is set.withState
(Function<StateReferenceBuilder, StateReference> builder) This reference can point to a state in a custom workflow.set the value to the store using the builder functionwithSyncInfo
(Function<SyncInfoBuilder, SyncInfoBuilder> builder) set the value to the syncInfo using the builder functionwithTaxedPrice
(Function<TaxedPriceBuilder, TaxedPrice> builder) The taxes are calculated based on the shipping address.Sum oftaxedPrice
of ShippingInfo across all Shipping Methods.
-
Constructor Details
-
StagedOrderBuilder
public StagedOrderBuilder()
-
-
Method Details
-
id
Unique identifier of the Order.
- Parameters:
id
- value to be set- Returns:
- Builder
-
version
The current version of the order.
- Parameters:
version
- value to be set- Returns:
- Builder
-
createdAt
set the value to the createdAt- Parameters:
createdAt
- value to be set- Returns:
- Builder
-
lastModifiedAt
set the value to the lastModifiedAt- Parameters:
lastModifiedAt
- value to be set- Returns:
- Builder
-
lastModifiedBy
public StagedOrderBuilder 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 StagedOrderBuilder 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
Present on resources created after 1 February 2019 except for events not tracked.
- Parameters:
lastModifiedBy
- value to be set- Returns:
- Builder
-
createdBy
Present on resources created after 1 February 2019 except for events not tracked.
- Parameters:
builder
- function to build the createdBy value- Returns:
- Builder
-
withCreatedBy
Present on resources created after 1 February 2019 except for events not tracked.
- Parameters:
builder
- function to build the createdBy value- Returns:
- Builder
-
createdBy
Present on resources created after 1 February 2019 except for events not tracked.
- Parameters:
createdBy
- value to be set- Returns:
- Builder
-
completedAt
This field will only be present if it was set for Order Import
- Parameters:
completedAt
- value to be set- Returns:
- Builder
-
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
set the value to the customerId- Parameters:
customerId
- value to be set- Returns:
- Builder
-
customerEmail
set the value to the customerEmail- Parameters:
customerEmail
- value to be set- Returns:
- Builder
-
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 StagedOrderBuilder businessUnit(Function<BusinessUnitKeyReferenceBuilder, BusinessUnitKeyReferenceBuilder> builder) The Business Unit the Order belongs to.
- Parameters:
builder
- function to build the businessUnit value- Returns:
- Builder
-
withBusinessUnit
public StagedOrderBuilder withBusinessUnit(Function<BusinessUnitKeyReferenceBuilder, BusinessUnitKeyReference> builder) The Business Unit the Order belongs to.
- Parameters:
builder
- function to build the businessUnit value- Returns:
- Builder
-
businessUnit
The Business Unit the Order belongs to.
- Parameters:
businessUnit
- value to be set- Returns:
- Builder
-
store
public StagedOrderBuilder 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
set the value to the store using the builder function- Parameters:
builder
- function to build the store value- Returns:
- Builder
-
store
set the value to the store- Parameters:
store
- value to be set- Returns:
- Builder
-
lineItems
set values to the lineItems- Parameters:
lineItems
- value to be set- Returns:
- Builder
-
lineItems
set value to the lineItems- Parameters:
lineItems
- value to be set- Returns:
- Builder
-
plusLineItems
add values to the lineItems- Parameters:
lineItems
- value to be set- Returns:
- Builder
-
plusLineItems
add the value to the lineItems using the builder function- Parameters:
builder
- function to build the lineItems value- Returns:
- Builder
-
withLineItems
set the value to the lineItems using the builder function- Parameters:
builder
- function to build the lineItems value- Returns:
- Builder
-
addLineItems
add the value to the lineItems using the builder function- Parameters:
builder
- function to build the lineItems value- Returns:
- Builder
-
setLineItems
set the value to the lineItems using the builder function- Parameters:
builder
- function to build the lineItems value- Returns:
- Builder
-
customLineItems
set values to the customLineItems- Parameters:
customLineItems
- value to be set- Returns:
- Builder
-
customLineItems
set value to the customLineItems- Parameters:
customLineItems
- value to be set- Returns:
- Builder
-
plusCustomLineItems
add values to the customLineItems- Parameters:
customLineItems
- value to be set- Returns:
- Builder
-
plusCustomLineItems
public StagedOrderBuilder 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 StagedOrderBuilder 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 StagedOrderBuilder 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 StagedOrderBuilder 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
set the value to the totalPrice- Parameters:
totalPrice
- value to be set- Returns:
- Builder
-
totalPrice
public StagedOrderBuilder 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
The taxes are calculated based on the shipping address.
- Parameters:
builder
- function to build the taxedPrice value- Returns:
- Builder
-
withTaxedPrice
The taxes are calculated based on the shipping address.
- Parameters:
builder
- function to build the taxedPrice value- Returns:
- Builder
-
taxedPrice
The taxes are calculated based on the shipping address.
- Parameters:
taxedPrice
- value to be set- Returns:
- Builder
-
taxedShippingPrice
Sum of
taxedPrice
of ShippingInfo across all Shipping Methods. ForPlatform
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
Sum of
taxedPrice
of ShippingInfo across all Shipping Methods. ForPlatform
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
Sum of
taxedPrice
of ShippingInfo across all Shipping Methods. ForPlatform
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
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
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
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
set the value to the billingAddress using the builder function- Parameters:
builder
- function to build the billingAddress value- Returns:
- Builder
-
withBillingAddress
set the value to the billingAddress using the builder function- Parameters:
builder
- function to build the billingAddress value- Returns:
- Builder
-
billingAddress
set the value to the billingAddress- Parameters:
billingAddress
- value to be set- Returns:
- Builder
-
shippingMode
Indicates whether one or multiple Shipping Methods are added to the Cart.
- Parameters:
shippingMode
- value to be set- Returns:
- Builder
-
shippingKey
User-defined unique identifier of the Shipping Method with
Single
ShippingMode.- Parameters:
shippingKey
- value to be set- Returns:
- Builder
-
shippingCustomFields
public StagedOrderBuilder 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 StagedOrderBuilder 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
Custom Fields of the Shipping Method for
Single
ShippingMode.- Parameters:
shippingCustomFields
- value to be set- Returns:
- Builder
-
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
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
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
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
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
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
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
set the value to the taxMode- Parameters:
taxMode
- value to be set- Returns:
- Builder
-
taxRoundingMode
When calculating taxes for
taxedPrice
, the selected mode is used for rouding.- Parameters:
taxRoundingMode
- value to be set- Returns:
- Builder
-
customerGroup
public StagedOrderBuilder 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 StagedOrderBuilder 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
Set when the customer is set and the customer is a member of a customer group. Used for product variant price selection.
- Parameters:
customerGroup
- value to be set- Returns:
- Builder
-
country
A two-digit country code as per ISO 3166-1 alpha-2. Used for product variant price selection.
- Parameters:
country
- value to be set- Returns:
- Builder
-
orderState
One of the four predefined OrderStates.
- Parameters:
orderState
- value to be set- Returns:
- Builder
-
state
This reference can point to a state in a custom workflow.
- Parameters:
builder
- function to build the state value- Returns:
- Builder
-
withState
This reference can point to a state in a custom workflow.
- Parameters:
builder
- function to build the state value- Returns:
- Builder
-
state
This reference can point to a state in a custom workflow.
- Parameters:
state
- value to be set- Returns:
- Builder
-
shipmentState
set the value to the shipmentState- Parameters:
shipmentState
- value to be set- Returns:
- Builder
-
paymentState
set the value to the paymentState- Parameters:
paymentState
- value to be set- Returns:
- Builder
-
shippingInfo
Set if the ShippingMethod is set.
- Parameters:
builder
- function to build the shippingInfo value- Returns:
- Builder
-
withShippingInfo
Set if the ShippingMethod is set.
- Parameters:
builder
- function to build the shippingInfo value- Returns:
- Builder
-
shippingInfo
Set if the ShippingMethod is set.
- Parameters:
shippingInfo
- value to be set- Returns:
- Builder
-
syncInfo
set values to the syncInfo- Parameters:
syncInfo
- value to be set- Returns:
- Builder
-
syncInfo
set value to the syncInfo- Parameters:
syncInfo
- value to be set- Returns:
- Builder
-
plusSyncInfo
add values to the syncInfo- Parameters:
syncInfo
- value to be set- Returns:
- Builder
-
plusSyncInfo
add the value to the syncInfo using the builder function- Parameters:
builder
- function to build the syncInfo value- Returns:
- Builder
-
withSyncInfo
set the value to the syncInfo using the builder function- Parameters:
builder
- function to build the syncInfo value- Returns:
- Builder
-
addSyncInfo
add the value to the syncInfo using the builder function- Parameters:
builder
- function to build the syncInfo value- Returns:
- Builder
-
setSyncInfo
set the value to the syncInfo using the builder function- Parameters:
builder
- function to build the syncInfo value- Returns:
- Builder
-
returnInfo
set values to the returnInfo- Parameters:
returnInfo
- value to be set- Returns:
- Builder
-
returnInfo
set value to the returnInfo- Parameters:
returnInfo
- value to be set- Returns:
- Builder
-
plusReturnInfo
add values to the returnInfo- Parameters:
returnInfo
- value to be set- Returns:
- Builder
-
plusReturnInfo
add the value to the returnInfo using the builder function- Parameters:
builder
- function to build the returnInfo value- Returns:
- Builder
-
withReturnInfo
set the value to the returnInfo using the builder function- Parameters:
builder
- function to build the returnInfo value- Returns:
- Builder
-
addReturnInfo
add the value to the returnInfo using the builder function- Parameters:
builder
- function to build the returnInfo value- Returns:
- Builder
-
setReturnInfo
set the value to the returnInfo using the builder function- Parameters:
builder
- function to build the returnInfo value- Returns:
- Builder
-
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
set values to the discountCodes- Parameters:
discountCodes
- value to be set- Returns:
- Builder
-
discountCodes
set value to the discountCodes- Parameters:
discountCodes
- value to be set- Returns:
- Builder
-
plusDiscountCodes
add values to the discountCodes- Parameters:
discountCodes
- value to be set- Returns:
- Builder
-
plusDiscountCodes
public StagedOrderBuilder 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 StagedOrderBuilder 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 StagedOrderBuilder 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 StagedOrderBuilder 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 StagedOrderBuilder lastMessageSequenceNumber(@Nullable Long lastMessageSequenceNumber) Deprecated.Internal-only field.
- Parameters:
lastMessageSequenceNumber
- value to be set- Returns:
- Builder
-
cart
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
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
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
Set when this order was created from a quote.
- Parameters:
builder
- function to build the quote value- Returns:
- Builder
-
withQuote
Set when this order was created from a quote.
- Parameters:
builder
- function to build the quote value- Returns:
- Builder
-
quote
Set when this order was created from a quote.
- Parameters:
quote
- value to be set- Returns:
- Builder
-
custom
set the value to the custom using the builder function- Parameters:
builder
- function to build the custom value- Returns:
- Builder
-
withCustom
set the value to the custom using the builder function- Parameters:
builder
- function to build the custom value- Returns:
- Builder
-
custom
set the value to the custom- Parameters:
custom
- value to be set- Returns:
- Builder
-
paymentInfo
set the value to the paymentInfo using the builder function- Parameters:
builder
- function to build the paymentInfo value- Returns:
- Builder
-
withPaymentInfo
set the value to the paymentInfo using the builder function- Parameters:
builder
- function to build the paymentInfo value- Returns:
- Builder
-
paymentInfo
set the value to the paymentInfo- Parameters:
paymentInfo
- value to be set- Returns:
- Builder
-
locale
set the value to the locale- Parameters:
locale
- value to be set- Returns:
- Builder
-
inventoryMode
set the value to the inventoryMode- Parameters:
inventoryMode
- value to be set- Returns:
- Builder
-
origin
set the value to the origin- Parameters:
origin
- value to be set- Returns:
- Builder
-
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
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
- If
-
shippingRateInput
public StagedOrderBuilder 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
- If
-
itemShippingAddresses
Contains addresses for orders with multiple shipping addresses.
- Parameters:
itemShippingAddresses
- value to be set- Returns:
- Builder
-
itemShippingAddresses
Contains addresses for orders with multiple shipping addresses.
- Parameters:
itemShippingAddresses
- value to be set- Returns:
- Builder
-
plusItemShippingAddresses
Contains addresses for orders with multiple shipping addresses.
- Parameters:
itemShippingAddresses
- value to be set- Returns:
- Builder
-
plusItemShippingAddresses
public StagedOrderBuilder 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 StagedOrderBuilder withItemShippingAddresses(Function<AddressBuilder, AddressBuilder> builder) Contains addresses for orders with multiple shipping addresses.
- Parameters:
builder
- function to build the itemShippingAddresses value- Returns:
- Builder
-
addItemShippingAddresses
Contains addresses for orders with multiple shipping addresses.
- Parameters:
builder
- function to build the itemShippingAddresses value- Returns:
- Builder
-
setItemShippingAddresses
Contains addresses for orders with multiple shipping addresses.
- Parameters:
builder
- function to build the itemShippingAddresses value- Returns:
- Builder
-
refusedGifts
Automatically filled when a line item with LineItemMode
GiftLineItem
is removed from this order.- Parameters:
refusedGifts
- value to be set- Returns:
- Builder
-
refusedGifts
Automatically filled when a line item with LineItemMode
GiftLineItem
is removed from this order.- Parameters:
refusedGifts
- value to be set- Returns:
- Builder
-
plusRefusedGifts
Automatically filled when a line item with LineItemMode
GiftLineItem
is removed from this order.- Parameters:
refusedGifts
- value to be set- Returns:
- Builder
-
plusRefusedGifts
public StagedOrderBuilder 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 StagedOrderBuilder 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 StagedOrderBuilder 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 StagedOrderBuilder 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
Unique identifier of the Order.
- Returns:
- id
-
getVersion
The current version of the order.
- Returns:
- version
-
getCreatedAt
value of createdAt}- Returns:
- createdAt
-
getLastModifiedAt
value of lastModifiedAt}- Returns:
- lastModifiedAt
-
getLastModifiedBy
Present on resources created after 1 February 2019 except for events not tracked.
- Returns:
- lastModifiedBy
-
getCreatedBy
Present on resources created after 1 February 2019 except for events not tracked.
- Returns:
- createdBy
-
getCompletedAt
This field will only be present if it was set for Order Import
- Returns:
- completedAt
-
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
value of customerId}- Returns:
- customerId
-
getCustomerEmail
value of customerEmail}- Returns:
- customerEmail
-
getAnonymousId
Identifies carts and orders belonging to an anonymous session (the customer has not signed up/in yet).
- Returns:
- anonymousId
-
getBusinessUnit
The Business Unit the Order belongs to.
- Returns:
- businessUnit
-
getStore
value of store}- Returns:
- store
-
getLineItems
value of lineItems}- Returns:
- lineItems
-
getCustomLineItems
value of customLineItems}- Returns:
- customLineItems
-
getTotalPrice
value of totalPrice}- Returns:
- totalPrice
-
getTaxedPrice
The taxes are calculated based on the shipping address.
- Returns:
- taxedPrice
-
getTaxedShippingPrice
Sum of
taxedPrice
of ShippingInfo across all Shipping Methods. ForPlatform
TaxMode, it is set automatically only if shipping address is set or Shipping Method is added to the Cart.- Returns:
- taxedShippingPrice
-
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
value of billingAddress}- Returns:
- billingAddress
-
getShippingMode
Indicates whether one or multiple Shipping Methods are added to the Cart.
- Returns:
- shippingMode
-
getShippingKey
User-defined unique identifier of the Shipping Method with
Single
ShippingMode.- Returns:
- shippingKey
-
getShippingCustomFields
Custom Fields of the Shipping Method for
Single
ShippingMode.- Returns:
- shippingCustomFields
-
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
value of taxMode}- Returns:
- taxMode
-
getTaxRoundingMode
When calculating taxes for
taxedPrice
, the selected mode is used for rouding.- Returns:
- taxRoundingMode
-
getCustomerGroup
Set when the customer is set and the customer is a member of a customer group. Used for product variant price selection.
- Returns:
- customerGroup
-
getCountry
A two-digit country code as per ISO 3166-1 alpha-2. Used for product variant price selection.
- Returns:
- country
-
getOrderState
One of the four predefined OrderStates.
- Returns:
- orderState
-
getState
This reference can point to a state in a custom workflow.
- Returns:
- state
-
getShipmentState
value of shipmentState}- Returns:
- shipmentState
-
getPaymentState
value of paymentState}- Returns:
- paymentState
-
getShippingInfo
Set if the ShippingMethod is set.
- Returns:
- shippingInfo
-
getSyncInfo
value of syncInfo}- Returns:
- syncInfo
-
getReturnInfo
value of returnInfo}- Returns:
- returnInfo
-
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
value of discountCodes}- Returns:
- discountCodes
-
getLastMessageSequenceNumber
Deprecated.Internal-only field.
- Returns:
- lastMessageSequenceNumber
-
getCart
Set when this order was created from a cart. The cart will have the state
Ordered
.- Returns:
- cart
-
getQuote
Set when this order was created from a quote.
- Returns:
- quote
-
getCustom
value of custom}- Returns:
- custom
-
getPaymentInfo
value of paymentInfo}- Returns:
- paymentInfo
-
getLocale
value of locale}- Returns:
- locale
-
getInventoryMode
value of inventoryMode}- Returns:
- inventoryMode
-
getOrigin
value of origin}- Returns:
- origin
-
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
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
- If
-
getItemShippingAddresses
Contains addresses for orders with multiple shipping addresses.
- Returns:
- itemShippingAddresses
-
getRefusedGifts
Automatically filled when a line item with LineItemMode
GiftLineItem
is removed from this order.- Returns:
- refusedGifts
-
build
builds StagedOrder with checking for non-null required values- Specified by:
build
in interfaceio.vrap.rmf.base.client.Builder<StagedOrder>
- Returns:
- StagedOrder
-
buildUnchecked
builds StagedOrder without checking for non-null required values- Returns:
- StagedOrder
-
of
factory method for an instance of StagedOrderBuilder- Returns:
- builder
-
of
create builder for StagedOrder instance- Parameters:
template
- instance with prefilled values for the builder- Returns:
- builder
-