Class StagedOrderBuilder
- All Implemented Interfaces:
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)
.plusRefusedGifts(refusedGiftsBuilder -> refusedGiftsBuilder)
.origin(CartOrigin.CUSTOMER)
.orderState(OrderState.OPEN)
.plusSyncInfo(syncInfoBuilder -> syncInfoBuilder)
.build()
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionCustom Line Items that are part of the Order.Direct Discounts added to the Order.Discount Codes added to the Order.Additional shipping addresses of the Order as specified by LineItems using theshippingDetails
field.addLineItems
(Function<LineItemBuilder, LineItem> builder) Line Items that are part of the Order.Automatically set when a Line Item withGiftLineItem
LineItemMode is removed from the Order.addReturnInfo
(Function<ReturnInfoBuilder, ReturnInfo> builder) Contains information regarding the returns associated with the Order.addShipping
(Function<ShippingBuilder, Shipping> builder) Shipping-related information forMultiple
ShippingMode.addSyncInfo
(Function<SyncInfoBuilder, SyncInfo> builder) Contains synchronization activity information of the Order (like export or import).anonymousId
(String anonymousId) Anonymous session associated with the Order.billingAddress
(Address billingAddress) Billing address associated with the Order.billingAddress
(Function<AddressBuilder, AddressBuilder> builder) Billing address associated with the Order.build()
builds StagedOrder with checking for non-null required valuesbuilds StagedOrder without checking for non-null required valuesbusinessUnit
(BusinessUnitKeyReference businessUnit) Reference to a Business Unit the Order belongs to.Reference to a Business Unit the Order belongs to.cart
(CartReference cart) Reference to the Cart for an Order created from Cart.cart
(Function<CartReferenceBuilder, CartReferenceBuilder> builder) Reference to the Cart for an Order created from Cart.completedAt
(ZonedDateTime completedAt) User-defined date and time (UTC) of the Order.Used for Line Item price selection.createdAt
(ZonedDateTime createdAt) Date and time (UTC) the Order was initially created.IDs and references that created the Order.createdBy
(Function<CreatedByBuilder, CreatedByBuilder> builder) IDs and references that created the Order.custom
(CustomFields custom) Custom Fields of the Order.custom
(Function<CustomFieldsBuilder, CustomFieldsBuilder> builder) Custom Fields of the Order.customerEmail
(String customerEmail) Email address of the Customer that the Order belongs to.customerGroup
(CustomerGroupReference customerGroup) Reference to the Customer Group of the Customer that the Order belongs to.Reference to the Customer Group of the Customer that the Order belongs to.customerId
(String customerId) id
of the Customer that the Order belongs to.customLineItems
(CustomLineItem... customLineItems) Custom Line Items that are part of the Order.customLineItems
(List<CustomLineItem> customLineItems) Custom Line Items that are part of the Order.directDiscounts
(DirectDiscount... directDiscounts) Direct Discounts added to the Order.directDiscounts
(List<DirectDiscount> directDiscounts) Direct Discounts added to the Order.discountCodes
(DiscountCodeInfo... discountCodes) Discount Codes added to the Order.discountCodes
(List<DiscountCodeInfo> discountCodes) Discount Codes added to the Order.discountOnTotalPrice
(DiscountOnTotalPrice discountOnTotalPrice) Discounts that apply on the total price of the Order.Discounts that apply on the total price of the Order.Anonymous session associated with the Order.Billing address associated with the Order.Reference to a Business Unit the Order belongs to.getCart()
Reference to the Cart for an Order created from Cart.User-defined date and time (UTC) of the Order.Used for Line Item price selection.Date and time (UTC) the Order was initially created.IDs and references that created the Order.Custom Fields of the Order.Email address of the Customer that the Order belongs to.Reference to the Customer Group of the Customer that the Order belongs to.id
of the Customer that the Order belongs to.Custom Line Items that are part of the Order.Direct Discounts added to the Order.Discount Codes added to the Order.Discounts that apply on the total price of the Order.getId()
Unique identifier of the Order.Indicates how stock quantities are tracked for Line Items in the Order.Additional shipping addresses of the Order as specified by LineItems using theshippingDetails
field.Deprecated.Date and time (UTC) the Order was last updated.IDs and references that last modified the Order.Line Items that are part of the Order.Languages of the Order.User-defined identifier of the Order that is unique across a Project.Current status of the Order.Indicates the origin of the Cart from which the Order was created.Payment information related to the Order.Payment status of the Order.User-defined identifier of a purchase Order.getQuote()
Reference to the Quote for an Order created from Quote.Automatically set when a Line Item withGiftLineItem
LineItemMode is removed from the Order.Contains information regarding the returns associated with the Order.Shipment status of the Order.Shipping-related information forMultiple
ShippingMode.Shipping address associated with the Order.Custom Fields of the Shipping Method forSingle
ShippingMode.Shipping-related information forSingle
ShippingMode.key
of the ShippingMethod forSingle
ShippingMode.Indicates whether there can be one or multiple Shipping Methods.Input used to select a ShippingRatePriceTier.getState()
State of the Order.getStore()
Reference to a Store the Order belongs to.Contains synchronization activity information of the Order (like export or import).Indicates how taxes are calculated when calculating taxes fortaxedPrice
.ForPlatform
TaxMode, it is automatically set when a shipping address is set. ForExternal
TaxMode, it is automatically set whenshippingAddress
and external Tax Rates for all Line Items, Custom Line Items, and Shipping Methods in the Cart are set.Sum of thetaxedPrice
field of ShippingInfo across all Shipping Methods.Indicates how Tax Rates are set.Indicates how monetary values are rounded when calculating taxes fortaxedPrice
.Sum of thetotalPrice
field of all LineItems and CustomLineItems, and if available, theprice
field of ShippingInfo.Current version of the Order.Unique identifier of the Order.inventoryMode
(InventoryMode inventoryMode) Indicates how stock quantities are tracked for Line Items in the Order.itemShippingAddresses
(Address... itemShippingAddresses) Additional shipping addresses of the Order as specified by LineItems using theshippingDetails
field.itemShippingAddresses
(List<Address> itemShippingAddresses) Additional shipping addresses of the Order as specified by LineItems using theshippingDetails
field.lastMessageSequenceNumber
(Long lastMessageSequenceNumber) Deprecated.lastModifiedAt
(ZonedDateTime lastModifiedAt) Date and time (UTC) the Order was last updated.lastModifiedBy
(LastModifiedBy lastModifiedBy) IDs and references that last modified the Order.IDs and references that last modified the Order.Line Items that are part of the Order.Line Items that are part of the Order.Languages of the Order.static StagedOrderBuilder
of()
factory method for an instance of StagedOrderBuilderstatic StagedOrderBuilder
of
(StagedOrder template) create builder for StagedOrder instanceorderNumber
(String orderNumber) User-defined identifier of the Order that is unique across a Project.orderState
(OrderState orderState) Current status of the Order.origin
(CartOrigin origin) Indicates the origin of the Cart from which the Order was created.paymentInfo
(PaymentInfo paymentInfo) Payment information related to the Order.Payment information related to the Order.paymentState
(PaymentState paymentState) Payment status of the Order.plusCustomLineItems
(CustomLineItem... customLineItems) Custom Line Items that are part of the Order.Custom Line Items that are part of the Order.plusDirectDiscounts
(DirectDiscount... directDiscounts) Direct Discounts added to the Order.Direct Discounts added to the Order.plusDiscountCodes
(DiscountCodeInfo... discountCodes) Discount Codes added to the Order.Discount Codes added to the Order.plusItemShippingAddresses
(Address... itemShippingAddresses) Additional shipping addresses of the Order as specified by LineItems using theshippingDetails
field.Additional shipping addresses of the Order as specified by LineItems using theshippingDetails
field.plusLineItems
(LineItem... lineItems) Line Items that are part of the Order.plusLineItems
(Function<LineItemBuilder, LineItemBuilder> builder) Line Items that are part of the Order.plusRefusedGifts
(CartDiscountReference... refusedGifts) Automatically set when a Line Item withGiftLineItem
LineItemMode is removed from the Order.Automatically set when a Line Item withGiftLineItem
LineItemMode is removed from the Order.plusReturnInfo
(ReturnInfo... returnInfo) Contains information regarding the returns associated with the Order.Contains information regarding the returns associated with the Order.plusShipping
(Shipping... shipping) Shipping-related information forMultiple
ShippingMode.plusShipping
(Function<ShippingBuilder, ShippingBuilder> builder) Shipping-related information forMultiple
ShippingMode.plusSyncInfo
(SyncInfo... syncInfo) Contains synchronization activity information of the Order (like export or import).plusSyncInfo
(Function<SyncInfoBuilder, SyncInfoBuilder> builder) Contains synchronization activity information of the Order (like export or import).purchaseOrderNumber
(String purchaseOrderNumber) User-defined identifier of a purchase Order.quote
(QuoteReference quote) Reference to the Quote for an Order created from Quote.Reference to the Quote for an Order created from Quote.refusedGifts
(CartDiscountReference... refusedGifts) Automatically set when a Line Item withGiftLineItem
LineItemMode is removed from the Order.refusedGifts
(List<CartDiscountReference> refusedGifts) Automatically set when a Line Item withGiftLineItem
LineItemMode is removed from the Order.returnInfo
(ReturnInfo... returnInfo) Contains information regarding the returns associated with the Order.returnInfo
(List<ReturnInfo> returnInfo) Contains information regarding the returns associated with the Order.Custom Line Items that are part of the Order.Direct Discounts added to the Order.Discount Codes added to the Order.Additional shipping addresses of the Order as specified by LineItems using theshippingDetails
field.setLineItems
(Function<LineItemBuilder, LineItem> builder) Line Items that are part of the Order.Automatically set when a Line Item withGiftLineItem
LineItemMode is removed from the Order.setReturnInfo
(Function<ReturnInfoBuilder, ReturnInfo> builder) Contains information regarding the returns associated with the Order.setShipping
(Function<ShippingBuilder, Shipping> builder) Shipping-related information forMultiple
ShippingMode.setSyncInfo
(Function<SyncInfoBuilder, SyncInfo> builder) Contains synchronization activity information of the Order (like export or import).shipmentState
(ShipmentState shipmentState) Shipment status of the Order.Shipping-related information forMultiple
ShippingMode.Shipping-related information forMultiple
ShippingMode.shippingAddress
(Address shippingAddress) Shipping address associated with the Order.shippingAddress
(Function<AddressBuilder, AddressBuilder> builder) Shipping address associated with the Order.shippingCustomFields
(CustomFields shippingCustomFields) Custom Fields of the Shipping Method forSingle
ShippingMode.Custom Fields of the Shipping Method forSingle
ShippingMode.shippingInfo
(ShippingInfo shippingInfo) Shipping-related information forSingle
ShippingMode.Shipping-related information forSingle
ShippingMode.shippingKey
(String shippingKey) key
of the ShippingMethod forSingle
ShippingMode.shippingMode
(ShippingMode shippingMode) Indicates whether there can be one or multiple Shipping Methods.shippingRateInput
(ShippingRateInput shippingRateInput) Input used to select a ShippingRatePriceTier.shippingRateInput
(Function<ShippingRateInputBuilder, Builder<? extends ShippingRateInput>> builder) Input used to select a ShippingRatePriceTier.state
(StateReference state) State of the Order.State of the Order.store
(StoreKeyReference store) Reference to a Store the Order belongs to.Reference to a Store the Order belongs to.Contains synchronization activity information of the Order (like export or import).Contains synchronization activity information of the Order (like export or import).taxCalculationMode
(TaxCalculationMode taxCalculationMode) Indicates how taxes are calculated when calculating taxes fortaxedPrice
.taxedPrice
(TaxedPrice taxedPrice) ForPlatform
TaxMode, it is automatically set when a shipping address is set. ForExternal
TaxMode, it is automatically set whenshippingAddress
and external Tax Rates for all Line Items, Custom Line Items, and Shipping Methods in the Cart are set.taxedPrice
(Function<TaxedPriceBuilder, TaxedPriceBuilder> builder) ForPlatform
TaxMode, it is automatically set when a shipping address is set. ForExternal
TaxMode, it is automatically set whenshippingAddress
and external Tax Rates for all Line Items, Custom Line Items, and Shipping Methods in the Cart are set.taxedShippingPrice
(TaxedPrice taxedShippingPrice) Sum of thetaxedPrice
field of ShippingInfo across all Shipping Methods.Sum of thetaxedPrice
field of ShippingInfo across all Shipping Methods.Indicates how Tax Rates are set.taxRoundingMode
(RoundingMode taxRoundingMode) Indicates how monetary values are rounded when calculating taxes fortaxedPrice
.totalPrice
(CentPrecisionMoney totalPrice) Sum of thetotalPrice
field of all LineItems and CustomLineItems, and if available, theprice
field of ShippingInfo.Sum of thetotalPrice
field of all LineItems and CustomLineItems, and if available, theprice
field of ShippingInfo.Current version of the Order.withBillingAddress
(Function<AddressBuilder, Address> builder) Billing address associated with the Order.Reference to a Business Unit the Order belongs to.withCart
(Function<CartReferenceBuilder, CartReference> builder) Reference to the Cart for an Order created from Cart.withCreatedBy
(Function<CreatedByBuilder, CreatedBy> builder) IDs and references that created the Order.withCustom
(Function<CustomFieldsBuilder, CustomFields> builder) Custom Fields of the Order.Reference to the Customer Group of the Customer that the Order belongs to.Custom Line Items that are part of the Order.Direct Discounts added to the Order.Discount Codes added to the Order.Discounts that apply on the total price of the Order.Additional shipping addresses of the Order as specified by LineItems using theshippingDetails
field.IDs and references that last modified the Order.withLineItems
(Function<LineItemBuilder, LineItemBuilder> builder) Line Items that are part of the Order.withPaymentInfo
(Function<PaymentInfoBuilder, PaymentInfo> builder) Payment information related to the Order.withQuote
(Function<QuoteReferenceBuilder, QuoteReference> builder) Reference to the Quote for an Order created from Quote.Automatically set when a Line Item withGiftLineItem
LineItemMode is removed from the Order.Contains information regarding the returns associated with the Order.withShipping
(Function<ShippingBuilder, ShippingBuilder> builder) Shipping-related information forMultiple
ShippingMode.withShippingAddress
(Function<AddressBuilder, Address> builder) Shipping address associated with the Order.Custom Fields of the Shipping Method forSingle
ShippingMode.Shipping-related information forSingle
ShippingMode.withState
(Function<StateReferenceBuilder, StateReference> builder) State of the Order.Reference to a Store the Order belongs to.withSyncInfo
(Function<SyncInfoBuilder, SyncInfoBuilder> builder) Contains synchronization activity information of the Order (like export or import).withTaxedPrice
(Function<TaxedPriceBuilder, TaxedPrice> builder) ForPlatform
TaxMode, it is automatically set when a shipping address is set. ForExternal
TaxMode, it is automatically set whenshippingAddress
and external Tax Rates for all Line Items, Custom Line Items, and Shipping Methods in the Cart are set.Sum of thetaxedPrice
field of ShippingInfo across all Shipping Methods.Sum of thetotalPrice
field of all LineItems and CustomLineItems, and if available, theprice
field of ShippingInfo.
-
Constructor Details
-
StagedOrderBuilder
public StagedOrderBuilder()
-
-
Method Details
-
id
Unique identifier of the Order.
- Parameters:
id
- value to be set- Returns:
- Builder
-
version
Current version of the Order.
- Parameters:
version
- value to be set- Returns:
- Builder
-
createdAt
Date and time (UTC) the Order was initially created.
- Parameters:
createdAt
- value to be set- Returns:
- Builder
-
lastModifiedAt
Date and time (UTC) the Order was last updated.
- Parameters:
lastModifiedAt
- value to be set- Returns:
- Builder
-
orderNumber
User-defined identifier of the Order that is unique across a Project.
- Parameters:
orderNumber
- value to be set- Returns:
- Builder
-
purchaseOrderNumber
User-defined identifier of a purchase Order.
It is typically set by the Buyer and can be used with Quotes to track the purchase Order during the quote and order flow.
- Parameters:
purchaseOrderNumber
- value to be set- Returns:
- Builder
-
customerId
id
of the Customer that the Order belongs to.- Parameters:
customerId
- value to be set- Returns:
- Builder
-
customerEmail
Email address of the Customer that the Order belongs to.
- Parameters:
customerEmail
- value to be set- Returns:
- Builder
-
customerGroup
public StagedOrderBuilder customerGroup(Function<CustomerGroupReferenceBuilder, CustomerGroupReferenceBuilder> builder) Reference to the Customer Group of the Customer that the Order belongs to. Used for Line Item price selection.
- Parameters:
builder
- function to build the customerGroup value- Returns:
- Builder
-
withCustomerGroup
public StagedOrderBuilder withCustomerGroup(Function<CustomerGroupReferenceBuilder, CustomerGroupReference> builder) Reference to the Customer Group of the Customer that the Order belongs to. Used for Line Item price selection.
- Parameters:
builder
- function to build the customerGroup value- Returns:
- Builder
-
customerGroup
Reference to the Customer Group of the Customer that the Order belongs to. Used for Line Item price selection.
- Parameters:
customerGroup
- value to be set- Returns:
- Builder
-
anonymousId
Anonymous session associated with the Order.
- Parameters:
anonymousId
- value to be set- Returns:
- Builder
-
businessUnit
public StagedOrderBuilder businessUnit(Function<BusinessUnitKeyReferenceBuilder, BusinessUnitKeyReferenceBuilder> builder) Reference to a Business Unit the Order belongs to.
- Parameters:
builder
- function to build the businessUnit value- Returns:
- Builder
-
withBusinessUnit
public StagedOrderBuilder withBusinessUnit(Function<BusinessUnitKeyReferenceBuilder, BusinessUnitKeyReference> builder) Reference to a Business Unit the Order belongs to.
- Parameters:
builder
- function to build the businessUnit value- Returns:
- Builder
-
businessUnit
Reference to a Business Unit the Order belongs to.
- Parameters:
businessUnit
- value to be set- Returns:
- Builder
-
store
public StagedOrderBuilder store(Function<StoreKeyReferenceBuilder, StoreKeyReferenceBuilder> builder) Reference to a Store the Order belongs to.
- Parameters:
builder
- function to build the store value- Returns:
- Builder
-
withStore
Reference to a Store the Order belongs to.
- Parameters:
builder
- function to build the store value- Returns:
- Builder
-
store
Reference to a Store the Order belongs to.
- Parameters:
store
- value to be set- Returns:
- Builder
-
lineItems
Line Items that are part of the Order.
- Parameters:
lineItems
- value to be set- Returns:
- Builder
-
lineItems
Line Items that are part of the Order.
- Parameters:
lineItems
- value to be set- Returns:
- Builder
-
plusLineItems
Line Items that are part of the Order.
- Parameters:
lineItems
- value to be set- Returns:
- Builder
-
plusLineItems
Line Items that are part of the Order.
- Parameters:
builder
- function to build the lineItems value- Returns:
- Builder
-
withLineItems
Line Items that are part of the Order.
- Parameters:
builder
- function to build the lineItems value- Returns:
- Builder
-
addLineItems
Line Items that are part of the Order.
- Parameters:
builder
- function to build the lineItems value- Returns:
- Builder
-
setLineItems
Line Items that are part of the Order.
- Parameters:
builder
- function to build the lineItems value- Returns:
- Builder
-
customLineItems
Custom Line Items that are part of the Order.
- Parameters:
customLineItems
- value to be set- Returns:
- Builder
-
customLineItems
Custom Line Items that are part of the Order.
- Parameters:
customLineItems
- value to be set- Returns:
- Builder
-
plusCustomLineItems
Custom Line Items that are part of the Order.
- Parameters:
customLineItems
- value to be set- Returns:
- Builder
-
plusCustomLineItems
public StagedOrderBuilder plusCustomLineItems(Function<CustomLineItemBuilder, CustomLineItemBuilder> builder) Custom Line Items that are part of the Order.
- Parameters:
builder
- function to build the customLineItems value- Returns:
- Builder
-
withCustomLineItems
public StagedOrderBuilder withCustomLineItems(Function<CustomLineItemBuilder, CustomLineItemBuilder> builder) Custom Line Items that are part of the Order.
- Parameters:
builder
- function to build the customLineItems value- Returns:
- Builder
-
addCustomLineItems
public StagedOrderBuilder addCustomLineItems(Function<CustomLineItemBuilder, CustomLineItem> builder) Custom Line Items that are part of the Order.
- Parameters:
builder
- function to build the customLineItems value- Returns:
- Builder
-
setCustomLineItems
public StagedOrderBuilder setCustomLineItems(Function<CustomLineItemBuilder, CustomLineItem> builder) Custom Line Items that are part of the Order.
- Parameters:
builder
- function to build the customLineItems value- Returns:
- Builder
-
totalPrice
public StagedOrderBuilder totalPrice(Function<CentPrecisionMoneyBuilder, CentPrecisionMoneyBuilder> builder) Sum of the
totalPrice
field of all LineItems and CustomLineItems, and if available, theprice
field of ShippingInfo. If a discount applies ontotalPrice
, this field holds the discounted value.Taxes are included if TaxRate
includedInPrice
istrue
for each price.- Parameters:
builder
- function to build the totalPrice value- Returns:
- Builder
-
withTotalPrice
public StagedOrderBuilder withTotalPrice(Function<CentPrecisionMoneyBuilder, CentPrecisionMoney> builder) Sum of the
totalPrice
field of all LineItems and CustomLineItems, and if available, theprice
field of ShippingInfo. If a discount applies ontotalPrice
, this field holds the discounted value.Taxes are included if TaxRate
includedInPrice
istrue
for each price.- Parameters:
builder
- function to build the totalPrice value- Returns:
- Builder
-
totalPrice
Sum of the
totalPrice
field of all LineItems and CustomLineItems, and if available, theprice
field of ShippingInfo. If a discount applies ontotalPrice
, this field holds the discounted value.Taxes are included if TaxRate
includedInPrice
istrue
for each price.- Parameters:
totalPrice
- value to be set- Returns:
- Builder
-
taxedPrice
- For
Platform
TaxMode, it is automatically set when a shipping address is set. - For
External
TaxMode, it is automatically set whenshippingAddress
and external Tax Rates for all Line Items, Custom Line Items, and Shipping Methods in the Cart are set.
If a discount applies on
totalPrice
, this field holds the discounted values.- Parameters:
builder
- function to build the taxedPrice value- Returns:
- Builder
- For
-
withTaxedPrice
- For
Platform
TaxMode, it is automatically set when a shipping address is set. - For
External
TaxMode, it is automatically set whenshippingAddress
and external Tax Rates for all Line Items, Custom Line Items, and Shipping Methods in the Cart are set.
If a discount applies on
totalPrice
, this field holds the discounted values.- Parameters:
builder
- function to build the taxedPrice value- Returns:
- Builder
- For
-
taxedPrice
- For
Platform
TaxMode, it is automatically set when a shipping address is set. - For
External
TaxMode, it is automatically set whenshippingAddress
and external Tax Rates for all Line Items, Custom Line Items, and Shipping Methods in the Cart are set.
If a discount applies on
totalPrice
, this field holds the discounted values.- Parameters:
taxedPrice
- value to be set- Returns:
- Builder
- For
-
taxedShippingPrice
Sum of the
taxedPrice
field of ShippingInfo across all Shipping Methods.- Parameters:
builder
- function to build the taxedShippingPrice value- Returns:
- Builder
-
withTaxedShippingPrice
Sum of the
taxedPrice
field of ShippingInfo across all Shipping Methods.- Parameters:
builder
- function to build the taxedShippingPrice value- Returns:
- Builder
-
taxedShippingPrice
Sum of the
taxedPrice
field of ShippingInfo across all Shipping Methods.- Parameters:
taxedShippingPrice
- value to be set- Returns:
- Builder
-
discountOnTotalPrice
public StagedOrderBuilder discountOnTotalPrice(Function<DiscountOnTotalPriceBuilder, DiscountOnTotalPriceBuilder> builder) Discounts that apply on the total price of the Order.
- Parameters:
builder
- function to build the discountOnTotalPrice value- Returns:
- Builder
-
withDiscountOnTotalPrice
public StagedOrderBuilder withDiscountOnTotalPrice(Function<DiscountOnTotalPriceBuilder, DiscountOnTotalPrice> builder) Discounts that apply on the total price of the Order.
- Parameters:
builder
- function to build the discountOnTotalPrice value- Returns:
- Builder
-
discountOnTotalPrice
Discounts that apply on the total price of the Order.
- Parameters:
discountOnTotalPrice
- value to be set- Returns:
- Builder
-
taxMode
Indicates how Tax Rates are set.
- Parameters:
taxMode
- value to be set- Returns:
- Builder
-
taxRoundingMode
Indicates how monetary values are rounded when calculating taxes for
taxedPrice
.- Parameters:
taxRoundingMode
- value to be set- Returns:
- Builder
-
taxCalculationMode
Indicates how taxes are calculated when calculating taxes for
taxedPrice
.- Parameters:
taxCalculationMode
- value to be set- Returns:
- Builder
-
inventoryMode
Indicates how stock quantities are tracked for Line Items in the Order.
- Parameters:
inventoryMode
- value to be set- Returns:
- Builder
-
billingAddress
Billing address associated with the Order.
- Parameters:
builder
- function to build the billingAddress value- Returns:
- Builder
-
withBillingAddress
Billing address associated with the Order.
- Parameters:
builder
- function to build the billingAddress value- Returns:
- Builder
-
billingAddress
Billing address associated with the Order.
- Parameters:
billingAddress
- value to be set- Returns:
- Builder
-
shippingAddress
Shipping address associated with the Order. Determines eligible ShippingMethod rates and Tax Rates of Line Items.
- Parameters:
builder
- function to build the shippingAddress value- Returns:
- Builder
-
withShippingAddress
Shipping address associated with the Order. Determines eligible ShippingMethod rates and Tax Rates of Line Items.
- Parameters:
builder
- function to build the shippingAddress value- Returns:
- Builder
-
shippingAddress
Shipping address associated with the Order. Determines eligible ShippingMethod rates and Tax Rates of Line Items.
- Parameters:
shippingAddress
- value to be set- Returns:
- Builder
-
shippingMode
Indicates whether there can be one or multiple Shipping Methods.
- Parameters:
shippingMode
- value to be set- Returns:
- Builder
-
shippingKey
key
of the ShippingMethod forSingle
ShippingMode.- Parameters:
shippingKey
- value to be set- Returns:
- Builder
-
shippingInfo
Shipping-related information for
Single
ShippingMode. Automatically set when a Shipping Method is set.- Parameters:
builder
- function to build the shippingInfo value- Returns:
- Builder
-
withShippingInfo
Shipping-related information for
Single
ShippingMode. Automatically set when a Shipping Method is set.- Parameters:
builder
- function to build the shippingInfo value- Returns:
- Builder
-
shippingInfo
Shipping-related information for
Single
ShippingMode. Automatically set when a Shipping Method is set.- Parameters:
shippingInfo
- 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, 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
-
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
Shipping-related information for
Multiple
ShippingMode. Updated automatically each time a new Shipping Method is added.- Parameters:
shipping
- value to be set- Returns:
- Builder
-
shipping
Shipping-related information for
Multiple
ShippingMode. Updated automatically each time a new Shipping Method is added.- Parameters:
shipping
- value to be set- Returns:
- Builder
-
plusShipping
Shipping-related information for
Multiple
ShippingMode. Updated automatically each time a new Shipping Method is added.- Parameters:
shipping
- value to be set- Returns:
- Builder
-
plusShipping
Shipping-related information for
Multiple
ShippingMode. Updated automatically each time a new Shipping Method is added.- Parameters:
builder
- function to build the shipping value- Returns:
- Builder
-
withShipping
Shipping-related information for
Multiple
ShippingMode. Updated automatically each time a new Shipping Method is added.- Parameters:
builder
- function to build the shipping value- Returns:
- Builder
-
addShipping
Shipping-related information for
Multiple
ShippingMode. Updated automatically each time a new Shipping Method is added.- Parameters:
builder
- function to build the shipping value- Returns:
- Builder
-
setShipping
Shipping-related information for
Multiple
ShippingMode. Updated automatically each time a new Shipping Method is added.- Parameters:
builder
- function to build the shipping value- Returns:
- Builder
-
itemShippingAddresses
Additional shipping addresses of the Order as specified by LineItems using the
shippingDetails
field. Eligible Shipping Methods or applicable Tax Rates are determined by the address inshippingAddress
, and notitemShippingAddresses
.- Parameters:
itemShippingAddresses
- value to be set- Returns:
- Builder
-
itemShippingAddresses
Additional shipping addresses of the Order as specified by LineItems using the
shippingDetails
field. Eligible Shipping Methods or applicable Tax Rates are determined by the address inshippingAddress
, and notitemShippingAddresses
.- Parameters:
itemShippingAddresses
- value to be set- Returns:
- Builder
-
plusItemShippingAddresses
Additional shipping addresses of the Order as specified by LineItems using the
shippingDetails
field. Eligible Shipping Methods or applicable Tax Rates are determined by the address inshippingAddress
, and notitemShippingAddresses
.- Parameters:
itemShippingAddresses
- value to be set- Returns:
- Builder
-
plusItemShippingAddresses
public StagedOrderBuilder plusItemShippingAddresses(Function<AddressBuilder, AddressBuilder> builder) Additional shipping addresses of the Order as specified by LineItems using the
shippingDetails
field. Eligible Shipping Methods or applicable Tax Rates are determined by the address inshippingAddress
, and notitemShippingAddresses
.- Parameters:
builder
- function to build the itemShippingAddresses value- Returns:
- Builder
-
withItemShippingAddresses
public StagedOrderBuilder withItemShippingAddresses(Function<AddressBuilder, AddressBuilder> builder) Additional shipping addresses of the Order as specified by LineItems using the
shippingDetails
field. Eligible Shipping Methods or applicable Tax Rates are determined by the address inshippingAddress
, and notitemShippingAddresses
.- Parameters:
builder
- function to build the itemShippingAddresses value- Returns:
- Builder
-
addItemShippingAddresses
Additional shipping addresses of the Order as specified by LineItems using the
shippingDetails
field. Eligible Shipping Methods or applicable Tax Rates are determined by the address inshippingAddress
, and notitemShippingAddresses
.- Parameters:
builder
- function to build the itemShippingAddresses value- Returns:
- Builder
-
setItemShippingAddresses
Additional shipping addresses of the Order as specified by LineItems using the
shippingDetails
field. Eligible Shipping Methods or applicable Tax Rates are determined by the address inshippingAddress
, and notitemShippingAddresses
.- Parameters:
builder
- function to build the itemShippingAddresses value- Returns:
- Builder
-
discountCodes
Discount Codes added to the Order. An Order that has
directDiscounts
cannot havediscountCodes
.- Parameters:
discountCodes
- value to be set- Returns:
- Builder
-
discountCodes
Discount Codes added to the Order. An Order that has
directDiscounts
cannot havediscountCodes
.- Parameters:
discountCodes
- value to be set- Returns:
- Builder
-
plusDiscountCodes
Discount Codes added to the Order. An Order that has
directDiscounts
cannot havediscountCodes
.- Parameters:
discountCodes
- value to be set- Returns:
- Builder
-
plusDiscountCodes
public StagedOrderBuilder plusDiscountCodes(Function<DiscountCodeInfoBuilder, DiscountCodeInfoBuilder> builder) Discount Codes added to the Order. An Order that has
directDiscounts
cannot havediscountCodes
.- Parameters:
builder
- function to build the discountCodes value- Returns:
- Builder
-
withDiscountCodes
public StagedOrderBuilder withDiscountCodes(Function<DiscountCodeInfoBuilder, DiscountCodeInfoBuilder> builder) Discount Codes added to the Order. An Order that has
directDiscounts
cannot havediscountCodes
.- Parameters:
builder
- function to build the discountCodes value- Returns:
- Builder
-
addDiscountCodes
public StagedOrderBuilder addDiscountCodes(Function<DiscountCodeInfoBuilder, DiscountCodeInfo> builder) Discount Codes added to the Order. An Order that has
directDiscounts
cannot havediscountCodes
.- Parameters:
builder
- function to build the discountCodes value- Returns:
- Builder
-
setDiscountCodes
public StagedOrderBuilder setDiscountCodes(Function<DiscountCodeInfoBuilder, DiscountCodeInfo> builder) Discount Codes added to the Order. An Order that has
directDiscounts
cannot havediscountCodes
.- Parameters:
builder
- function to build the discountCodes value- Returns:
- Builder
-
directDiscounts
Direct Discounts added to the Order. An Order that has
discountCodes
cannot havedirectDiscounts
.- Parameters:
directDiscounts
- value to be set- Returns:
- Builder
-
directDiscounts
Direct Discounts added to the Order. An Order that has
discountCodes
cannot havedirectDiscounts
.- Parameters:
directDiscounts
- value to be set- Returns:
- Builder
-
plusDirectDiscounts
Direct Discounts added to the Order. An Order that has
discountCodes
cannot havedirectDiscounts
.- Parameters:
directDiscounts
- value to be set- Returns:
- Builder
-
plusDirectDiscounts
public StagedOrderBuilder plusDirectDiscounts(Function<DirectDiscountBuilder, DirectDiscountBuilder> builder) Direct Discounts added to the Order. An Order that has
discountCodes
cannot havedirectDiscounts
.- Parameters:
builder
- function to build the directDiscounts value- Returns:
- Builder
-
withDirectDiscounts
public StagedOrderBuilder withDirectDiscounts(Function<DirectDiscountBuilder, DirectDiscountBuilder> builder) Direct Discounts added to the Order. An Order that has
discountCodes
cannot havedirectDiscounts
.- Parameters:
builder
- function to build the directDiscounts value- Returns:
- Builder
-
addDirectDiscounts
public StagedOrderBuilder addDirectDiscounts(Function<DirectDiscountBuilder, DirectDiscount> builder) Direct Discounts added to the Order. An Order that has
discountCodes
cannot havedirectDiscounts
.- Parameters:
builder
- function to build the directDiscounts value- Returns:
- Builder
-
setDirectDiscounts
public StagedOrderBuilder setDirectDiscounts(Function<DirectDiscountBuilder, DirectDiscount> builder) Direct Discounts added to the Order. An Order that has
discountCodes
cannot havedirectDiscounts
.- Parameters:
builder
- function to build the directDiscounts value- Returns:
- Builder
-
refusedGifts
Automatically set when a Line Item with
GiftLineItem
LineItemMode is removed from the Order.- Parameters:
refusedGifts
- value to be set- Returns:
- Builder
-
refusedGifts
Automatically set when a Line Item with
GiftLineItem
LineItemMode is removed from the Order.- Parameters:
refusedGifts
- value to be set- Returns:
- Builder
-
plusRefusedGifts
Automatically set when a Line Item with
GiftLineItem
LineItemMode is removed from the Order.- Parameters:
refusedGifts
- value to be set- Returns:
- Builder
-
plusRefusedGifts
public StagedOrderBuilder plusRefusedGifts(Function<CartDiscountReferenceBuilder, CartDiscountReferenceBuilder> builder) Automatically set when a Line Item with
GiftLineItem
LineItemMode is removed from the Order.- Parameters:
builder
- function to build the refusedGifts value- Returns:
- Builder
-
withRefusedGifts
public StagedOrderBuilder withRefusedGifts(Function<CartDiscountReferenceBuilder, CartDiscountReferenceBuilder> builder) Automatically set when a Line Item with
GiftLineItem
LineItemMode is removed from the Order.- Parameters:
builder
- function to build the refusedGifts value- Returns:
- Builder
-
addRefusedGifts
public StagedOrderBuilder addRefusedGifts(Function<CartDiscountReferenceBuilder, CartDiscountReference> builder) Automatically set when a Line Item with
GiftLineItem
LineItemMode is removed from the Order.- Parameters:
builder
- function to build the refusedGifts value- Returns:
- Builder
-
setRefusedGifts
public StagedOrderBuilder setRefusedGifts(Function<CartDiscountReferenceBuilder, CartDiscountReference> builder) Automatically set when a Line Item with
GiftLineItem
LineItemMode is removed from the Order.- Parameters:
builder
- function to build the refusedGifts value- Returns:
- Builder
-
paymentInfo
Payment information related to the Order.
- Parameters:
builder
- function to build the paymentInfo value- Returns:
- Builder
-
withPaymentInfo
Payment information related to the Order.
- Parameters:
builder
- function to build the paymentInfo value- Returns:
- Builder
-
paymentInfo
Payment information related to the Order.
- Parameters:
paymentInfo
- value to be set- Returns:
- Builder
-
country
Used for Line Item price selection.
- Parameters:
country
- value to be set- Returns:
- Builder
-
locale
Languages of the Order. Can only contain languages supported by the Project.
- Parameters:
locale
- value to be set- Returns:
- Builder
-
origin
Indicates the origin of the Cart from which the Order was created.
- Parameters:
origin
- value to be set- Returns:
- Builder
-
cart
Reference to the Cart for an Order created from Cart. The referenced Cart will have the
Ordered
CartState.- Parameters:
builder
- function to build the cart value- Returns:
- Builder
-
withCart
Reference to the Cart for an Order created from Cart. The referenced Cart will have the
Ordered
CartState.- Parameters:
builder
- function to build the cart value- Returns:
- Builder
-
cart
Reference to the Cart for an Order created from Cart. The referenced Cart will have the
Ordered
CartState.- Parameters:
cart
- value to be set- Returns:
- Builder
-
quote
Reference to the Quote for an Order created from Quote.
- Parameters:
builder
- function to build the quote value- Returns:
- Builder
-
withQuote
Reference to the Quote for an Order created from Quote.
- Parameters:
builder
- function to build the quote value- Returns:
- Builder
-
quote
Reference to the Quote for an Order created from Quote.
- Parameters:
quote
- value to be set- Returns:
- Builder
-
orderState
Current status of the Order.
- Parameters:
orderState
- value to be set- Returns:
- Builder
-
shipmentState
Shipment status of the Order.
- Parameters:
shipmentState
- value to be set- Returns:
- Builder
-
paymentState
Payment status of the Order.
- Parameters:
paymentState
- value to be set- Returns:
- Builder
-
state
State of the Order. This reference can point to a State in a custom workflow.
- Parameters:
builder
- function to build the state value- Returns:
- Builder
-
withState
State of the Order. This reference can point to a State in a custom workflow.
- Parameters:
builder
- function to build the state value- Returns:
- Builder
-
state
State of the Order. This reference can point to a State in a custom workflow.
- Parameters:
state
- value to be set- Returns:
- Builder
-
syncInfo
Contains synchronization activity information of the Order (like export or import). Can only be set with Update SyncInfo update action.
- Parameters:
syncInfo
- value to be set- Returns:
- Builder
-
syncInfo
Contains synchronization activity information of the Order (like export or import). Can only be set with Update SyncInfo update action.
- Parameters:
syncInfo
- value to be set- Returns:
- Builder
-
plusSyncInfo
Contains synchronization activity information of the Order (like export or import). Can only be set with Update SyncInfo update action.
- Parameters:
syncInfo
- value to be set- Returns:
- Builder
-
plusSyncInfo
Contains synchronization activity information of the Order (like export or import). Can only be set with Update SyncInfo update action.
- Parameters:
builder
- function to build the syncInfo value- Returns:
- Builder
-
withSyncInfo
Contains synchronization activity information of the Order (like export or import). Can only be set with Update SyncInfo update action.
- Parameters:
builder
- function to build the syncInfo value- Returns:
- Builder
-
addSyncInfo
Contains synchronization activity information of the Order (like export or import). Can only be set with Update SyncInfo update action.
- Parameters:
builder
- function to build the syncInfo value- Returns:
- Builder
-
setSyncInfo
Contains synchronization activity information of the Order (like export or import). Can only be set with Update SyncInfo update action.
- Parameters:
builder
- function to build the syncInfo value- Returns:
- Builder
-
returnInfo
Contains information regarding the returns associated with the Order.
- Parameters:
returnInfo
- value to be set- Returns:
- Builder
-
returnInfo
Contains information regarding the returns associated with the Order.
- Parameters:
returnInfo
- value to be set- Returns:
- Builder
-
plusReturnInfo
Contains information regarding the returns associated with the Order.
- Parameters:
returnInfo
- value to be set- Returns:
- Builder
-
plusReturnInfo
Contains information regarding the returns associated with the Order.
- Parameters:
builder
- function to build the returnInfo value- Returns:
- Builder
-
withReturnInfo
Contains information regarding the returns associated with the Order.
- Parameters:
builder
- function to build the returnInfo value- Returns:
- Builder
-
addReturnInfo
Contains information regarding the returns associated with the Order.
- Parameters:
builder
- function to build the returnInfo value- Returns:
- Builder
-
setReturnInfo
Contains information regarding the returns associated with the Order.
- Parameters:
builder
- function to build the returnInfo value- Returns:
- Builder
-
lastMessageSequenceNumber
@Deprecated public StagedOrderBuilder lastMessageSequenceNumber(@Nullable Long lastMessageSequenceNumber) Deprecated.Internal-only field.
- Parameters:
lastMessageSequenceNumber
- value to be set- Returns:
- Builder
-
custom
Custom Fields of the Order.
- Parameters:
builder
- function to build the custom value- Returns:
- Builder
-
withCustom
Custom Fields of the Order.
- Parameters:
builder
- function to build the custom value- Returns:
- Builder
-
custom
Custom Fields of the Order.
- Parameters:
custom
- value to be set- Returns:
- Builder
-
completedAt
User-defined date and time (UTC) of the Order. Present only on an Order created using Order Import.
- Parameters:
completedAt
- value to be set- Returns:
- Builder
-
lastModifiedBy
public StagedOrderBuilder lastModifiedBy(Function<LastModifiedByBuilder, LastModifiedByBuilder> builder) IDs and references that last modified the Order.
- Parameters:
builder
- function to build the lastModifiedBy value- Returns:
- Builder
-
withLastModifiedBy
public StagedOrderBuilder withLastModifiedBy(Function<LastModifiedByBuilder, LastModifiedBy> builder) IDs and references that last modified the Order.
- Parameters:
builder
- function to build the lastModifiedBy value- Returns:
- Builder
-
lastModifiedBy
IDs and references that last modified the Order.
- Parameters:
lastModifiedBy
- value to be set- Returns:
- Builder
-
createdBy
IDs and references that created the Order.
- Parameters:
builder
- function to build the createdBy value- Returns:
- Builder
-
withCreatedBy
IDs and references that created the Order.
- Parameters:
builder
- function to build the createdBy value- Returns:
- Builder
-
createdBy
IDs and references that created the Order.
- Parameters:
createdBy
- value to be set- Returns:
- Builder
-
getId
Unique identifier of the Order.
- Returns:
- id
-
getVersion
Current version of the Order.
- Returns:
- version
-
getCreatedAt
Date and time (UTC) the Order was initially created.
- Returns:
- createdAt
-
getLastModifiedAt
Date and time (UTC) the Order was last updated.
- Returns:
- lastModifiedAt
-
getOrderNumber
User-defined identifier of the Order that is unique across a Project.
- Returns:
- orderNumber
-
getPurchaseOrderNumber
User-defined identifier of a purchase Order.
It is typically set by the Buyer and can be used with Quotes to track the purchase Order during the quote and order flow.
- Returns:
- purchaseOrderNumber
-
getCustomerId
id
of the Customer that the Order belongs to.- Returns:
- customerId
-
getCustomerEmail
Email address of the Customer that the Order belongs to.
- Returns:
- customerEmail
-
getCustomerGroup
Reference to the Customer Group of the Customer that the Order belongs to. Used for Line Item price selection.
- Returns:
- customerGroup
-
getAnonymousId
Anonymous session associated with the Order.
- Returns:
- anonymousId
-
getBusinessUnit
Reference to a Business Unit the Order belongs to.
- Returns:
- businessUnit
-
getStore
Reference to a Store the Order belongs to.
- Returns:
- store
-
getLineItems
Line Items that are part of the Order.
- Returns:
- lineItems
-
getCustomLineItems
Custom Line Items that are part of the Order.
- Returns:
- customLineItems
-
getTotalPrice
Sum of the
totalPrice
field of all LineItems and CustomLineItems, and if available, theprice
field of ShippingInfo. If a discount applies ontotalPrice
, this field holds the discounted value.Taxes are included if TaxRate
includedInPrice
istrue
for each price.- Returns:
- totalPrice
-
getTaxedPrice
- For
Platform
TaxMode, it is automatically set when a shipping address is set. - For
External
TaxMode, it is automatically set whenshippingAddress
and external Tax Rates for all Line Items, Custom Line Items, and Shipping Methods in the Cart are set.
If a discount applies on
totalPrice
, this field holds the discounted values.- Returns:
- taxedPrice
- For
-
getTaxedShippingPrice
Sum of the
taxedPrice
field of ShippingInfo across all Shipping Methods.- Returns:
- taxedShippingPrice
-
getDiscountOnTotalPrice
Discounts that apply on the total price of the Order.
- Returns:
- discountOnTotalPrice
-
getTaxMode
Indicates how Tax Rates are set.
- Returns:
- taxMode
-
getTaxRoundingMode
Indicates how monetary values are rounded when calculating taxes for
taxedPrice
.- Returns:
- taxRoundingMode
-
getTaxCalculationMode
Indicates how taxes are calculated when calculating taxes for
taxedPrice
.- Returns:
- taxCalculationMode
-
getInventoryMode
Indicates how stock quantities are tracked for Line Items in the Order.
- Returns:
- inventoryMode
-
getBillingAddress
Billing address associated with the Order.
- Returns:
- billingAddress
-
getShippingAddress
Shipping address associated with the Order. Determines eligible ShippingMethod rates and Tax Rates of Line Items.
- Returns:
- shippingAddress
-
getShippingMode
Indicates whether there can be one or multiple Shipping Methods.
- Returns:
- shippingMode
-
getShippingKey
key
of the ShippingMethod forSingle
ShippingMode.- Returns:
- shippingKey
-
getShippingInfo
Shipping-related information for
Single
ShippingMode. Automatically set when a Shipping Method is set.- Returns:
- shippingInfo
-
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
-
getShippingCustomFields
Custom Fields of the Shipping Method for
Single
ShippingMode.- Returns:
- shippingCustomFields
-
getShipping
Shipping-related information for
Multiple
ShippingMode. Updated automatically each time a new Shipping Method is added.- Returns:
- shipping
-
getItemShippingAddresses
Additional shipping addresses of the Order as specified by LineItems using the
shippingDetails
field. Eligible Shipping Methods or applicable Tax Rates are determined by the address inshippingAddress
, and notitemShippingAddresses
.- Returns:
- itemShippingAddresses
-
getDiscountCodes
Discount Codes added to the Order. An Order that has
directDiscounts
cannot havediscountCodes
.- Returns:
- discountCodes
-
getDirectDiscounts
Direct Discounts added to the Order. An Order that has
discountCodes
cannot havedirectDiscounts
.- Returns:
- directDiscounts
-
getRefusedGifts
Automatically set when a Line Item with
GiftLineItem
LineItemMode is removed from the Order.- Returns:
- refusedGifts
-
getPaymentInfo
Payment information related to the Order.
- Returns:
- paymentInfo
-
getCountry
Used for Line Item price selection.
- Returns:
- country
-
getLocale
Languages of the Order. Can only contain languages supported by the Project.
- Returns:
- locale
-
getOrigin
Indicates the origin of the Cart from which the Order was created.
- Returns:
- origin
-
getCart
Reference to the Cart for an Order created from Cart. The referenced Cart will have the
Ordered
CartState.- Returns:
- cart
-
getQuote
Reference to the Quote for an Order created from Quote.
- Returns:
- quote
-
getOrderState
Current status of the Order.
- Returns:
- orderState
-
getShipmentState
Shipment status of the Order.
- Returns:
- shipmentState
-
getPaymentState
Payment status of the Order.
- Returns:
- paymentState
-
getState
State of the Order. This reference can point to a State in a custom workflow.
- Returns:
- state
-
getSyncInfo
Contains synchronization activity information of the Order (like export or import). Can only be set with Update SyncInfo update action.
- Returns:
- syncInfo
-
getReturnInfo
Contains information regarding the returns associated with the Order.
- Returns:
- returnInfo
-
getLastMessageSequenceNumber
Deprecated.Internal-only field.
- Returns:
- lastMessageSequenceNumber
-
getCustom
Custom Fields of the Order.
- Returns:
- custom
-
getCompletedAt
User-defined date and time (UTC) of the Order. Present only on an Order created using Order Import.
- Returns:
- completedAt
-
getLastModifiedBy
IDs and references that last modified the Order.
- Returns:
- lastModifiedBy
-
getCreatedBy
IDs and references that created the Order.
- Returns:
- createdBy
-
build
builds StagedOrder with checking for non-null required values- Specified by:
build
in interfaceBuilder<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
-