Class OrderImpl
- All Implemented Interfaces:
BaseResource
,Customizable<Order>
,DomainResource<Order>
,Identifiable<Order>
,Order
,OrderLike<Order>
,OrderMixin
,Referencable<Order>
,ResourceIdentifiable<Order>
,Versioned<Order>
,io.vrap.rmf.base.client.ModelBase
-
Nested Class Summary
Nested classes/interfaces inherited from interface io.vrap.rmf.base.client.ModelBase
io.vrap.rmf.base.client.ModelBase.FilteredRecursiveToStringStyle
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionboolean
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 LineItem Price selection.Date and time (UTC) the Order was initially created.Present on resources created after 1 February 2019 except for events not tracked.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.Present on resources created after 1 February 2019 except for events not tracked.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.int
hashCode()
void
setAnonymousId
(String anonymousId) Anonymous session associated with the Order.void
setBillingAddress
(Address billingAddress) Billing address associated with the Order.void
setBusinessUnit
(BusinessUnitKeyReference businessUnit) Reference to a Business Unit the Order belongs to.void
setCart
(CartReference cart) Reference to the Cart for an Order created from Cart.void
setCompletedAt
(ZonedDateTime completedAt) User-defined date and time (UTC) of the Order.void
setCountry
(String country) Used for LineItem Price selection.void
setCreatedAt
(ZonedDateTime createdAt) Date and time (UTC) the Order was initially created.void
setCreatedBy
(CreatedBy createdBy) Present on resources created after 1 February 2019 except for events not tracked.void
setCustom
(CustomFields custom) Custom Fields of the Order.void
setCustomerEmail
(String customerEmail) Email address of the Customer that the Order belongs to.void
setCustomerGroup
(CustomerGroupReference customerGroup) Reference to the Customer Group of the Customer that the Order belongs to.void
setCustomerId
(String customerId) id
of the Customer that the Order belongs to.void
setCustomLineItems
(CustomLineItem... customLineItems) Custom Line Items that are part of the Order.void
setCustomLineItems
(List<CustomLineItem> customLineItems) Custom Line Items that are part of the Order.void
setDirectDiscounts
(DirectDiscount... directDiscounts) Direct Discounts added to the Order.void
setDirectDiscounts
(List<DirectDiscount> directDiscounts) Direct Discounts added to the Order.void
setDiscountCodes
(DiscountCodeInfo... discountCodes) Discount Codes added to the Order.void
setDiscountCodes
(List<DiscountCodeInfo> discountCodes) Discount Codes added to the Order.void
setDiscountOnTotalPrice
(DiscountOnTotalPrice discountOnTotalPrice) Discounts that apply on the total price of the Order.void
Unique identifier of the Order.void
setInventoryMode
(InventoryMode inventoryMode) Indicates how stock quantities are tracked for Line Items in the Order.void
setItemShippingAddresses
(Address... itemShippingAddresses) Additional shipping addresses of the Order as specified by LineItems using theshippingDetails
field.void
setItemShippingAddresses
(List<Address> itemShippingAddresses) Additional shipping addresses of the Order as specified by LineItems using theshippingDetails
field.void
setLastMessageSequenceNumber
(Long lastMessageSequenceNumber) Deprecated.void
setLastModifiedAt
(ZonedDateTime lastModifiedAt) Date and time (UTC) the Order was last updated.void
setLastModifiedBy
(LastModifiedBy lastModifiedBy) Present on resources created after 1 February 2019 except for events not tracked.void
setLineItems
(LineItem... lineItems) Line Items that are part of the Order.void
setLineItems
(List<LineItem> lineItems) Line Items that are part of the Order.void
Languages of the Order.void
setOrderNumber
(String orderNumber) User-defined identifier of the Order that is unique across a Project.void
setOrderState
(OrderState orderState) Current status of the Order.void
setOrigin
(CartOrigin origin) Indicates the origin of the Cart from which the Order was created.void
setPaymentInfo
(PaymentInfo paymentInfo) Payment information related to the Order.void
setPaymentState
(PaymentState paymentState) Payment status of the Order.void
setPurchaseOrderNumber
(String purchaseOrderNumber) User-defined identifier of a purchase Order.void
setQuote
(QuoteReference quote) Reference to the Quote for an Order created from Quote.void
setRefusedGifts
(CartDiscountReference... refusedGifts) Automatically set when a Line Item withGiftLineItem
LineItemMode is removed from the Order.void
setRefusedGifts
(List<CartDiscountReference> refusedGifts) Automatically set when a Line Item withGiftLineItem
LineItemMode is removed from the Order.void
setReturnInfo
(ReturnInfo... returnInfo) Contains information regarding the returns associated with the Order.void
setReturnInfo
(List<ReturnInfo> returnInfo) Contains information regarding the returns associated with the Order.void
setShipmentState
(ShipmentState shipmentState) Shipment status of the Order.void
setShipping
(Shipping... shipping) Shipping-related information forMultiple
ShippingMode.void
setShipping
(List<Shipping> shipping) Shipping-related information forMultiple
ShippingMode.void
setShippingAddress
(Address shippingAddress) Shipping address associated with the Order.void
setShippingCustomFields
(CustomFields shippingCustomFields) Custom Fields of the Shipping Method forSingle
ShippingMode.void
setShippingInfo
(ShippingInfo shippingInfo) Shipping-related information forSingle
ShippingMode.void
setShippingKey
(String shippingKey) key
of the ShippingMethod forSingle
ShippingMode.void
setShippingMode
(ShippingMode shippingMode) Indicates whether there can be one or multiple Shipping Methods.void
setShippingRateInput
(ShippingRateInput shippingRateInput) Input used to select a ShippingRatePriceTier.void
setState
(StateReference state) State of the Order.void
setStore
(StoreKeyReference store) Reference to a Store the Order belongs to.void
setSyncInfo
(SyncInfo... syncInfo) Contains synchronization activity information of the Order (like export or import).void
setSyncInfo
(List<SyncInfo> syncInfo) Contains synchronization activity information of the Order (like export or import).void
setTaxCalculationMode
(TaxCalculationMode taxCalculationMode) Indicates how taxes are calculated when calculating taxes fortaxedPrice
.void
setTaxedPrice
(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.void
setTaxedShippingPrice
(TaxedPrice taxedShippingPrice) Sum of thetaxedPrice
field of ShippingInfo across all Shipping Methods.void
setTaxMode
(TaxMode taxMode) Indicates how Tax Rates are set.void
setTaxRoundingMode
(RoundingMode taxRoundingMode) Indicates how monetary values are rounded when calculating taxes fortaxedPrice
.void
setTotalPrice
(TypedMoney totalPrice) Sum of thetotalPrice
field of all LineItems and CustomLineItems, and if available, theprice
field of ShippingInfo.void
setVersion
(Long version) Current version of the Order.Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.commercetools.api.models.common.BaseResource
withBaseResource
Methods inherited from interface com.commercetools.api.models.Customizable
unwrapCustomizable
Methods inherited from interface com.commercetools.api.models.DomainResource
get
Methods inherited from interface io.vrap.rmf.base.client.ModelBase
reflectionString, reflectionString
Methods inherited from interface com.commercetools.api.models.order.OrderLike
calculateSubTotalPrice
Methods inherited from interface com.commercetools.api.models.order.OrderMixin
toReference, toResourceIdentifier
-
Constructor Details
-
OrderImpl
public OrderImpl()create empty instance
-
-
Method Details
-
getId
Unique identifier of the Order.
- Specified by:
getId
in interfaceBaseResource
- Specified by:
getId
in interfaceDomainResource<Order>
- Specified by:
getId
in interfaceIdentifiable<Order>
- Specified by:
getId
in interfaceOrder
- Specified by:
getId
in interfaceOrderLike<Order>
- Specified by:
getId
in interfaceVersioned<Order>
- Returns:
- id
-
getVersion
Current version of the Order.
- Specified by:
getVersion
in interfaceBaseResource
- Specified by:
getVersion
in interfaceDomainResource<Order>
- Specified by:
getVersion
in interfaceOrder
- Specified by:
getVersion
in interfaceOrderLike<Order>
- Specified by:
getVersion
in interfaceVersioned<Order>
- Returns:
- version
-
getCreatedAt
Date and time (UTC) the Order was initially created.
- Specified by:
getCreatedAt
in interfaceBaseResource
- Specified by:
getCreatedAt
in interfaceOrder
- Specified by:
getCreatedAt
in interfaceOrderLike<Order>
- Returns:
- createdAt
-
getLastModifiedAt
Date and time (UTC) the Order was last updated.
- Specified by:
getLastModifiedAt
in interfaceBaseResource
- Specified by:
getLastModifiedAt
in interfaceOrder
- Specified by:
getLastModifiedAt
in interfaceOrderLike<Order>
- Returns:
- lastModifiedAt
-
getOrderNumber
User-defined identifier of the Order that is unique across a Project.
- Specified by:
getOrderNumber
in interfaceOrder
- 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.
- Specified by:
getPurchaseOrderNumber
in interfaceOrder
- Returns:
- purchaseOrderNumber
-
getCustomerId
id
of the Customer that the Order belongs to.- Specified by:
getCustomerId
in interfaceOrder
- Specified by:
getCustomerId
in interfaceOrderLike<Order>
- Returns:
- customerId
-
getCustomerEmail
Email address of the Customer that the Order belongs to.
- Specified by:
getCustomerEmail
in interfaceOrder
- Specified by:
getCustomerEmail
in interfaceOrderLike<Order>
- Returns:
- customerEmail
-
getCustomerGroup
Reference to the Customer Group of the Customer that the Order belongs to. Used for LineItem Price selection.
- Specified by:
getCustomerGroup
in interfaceOrder
- Specified by:
getCustomerGroup
in interfaceOrderLike<Order>
- Returns:
- customerGroup
-
getAnonymousId
Anonymous session associated with the Order.
- Specified by:
getAnonymousId
in interfaceOrder
- Specified by:
getAnonymousId
in interfaceOrderLike<Order>
- Returns:
- anonymousId
-
getBusinessUnit
Reference to a Business Unit the Order belongs to.
- Specified by:
getBusinessUnit
in interfaceOrder
- Returns:
- businessUnit
-
getStore
Reference to a Store the Order belongs to.
-
getLineItems
Line Items that are part of the Order.
- Specified by:
getLineItems
in interfaceOrder
- Specified by:
getLineItems
in interfaceOrderLike<Order>
- Returns:
- lineItems
-
getCustomLineItems
Custom Line Items that are part of the Order.
- Specified by:
getCustomLineItems
in interfaceOrder
- Specified by:
getCustomLineItems
in interfaceOrderLike<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.- Specified by:
getTotalPrice
in interfaceOrder
- Specified by:
getTotalPrice
in interfaceOrderLike<Order>
- 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.- Specified by:
getTaxedPrice
in interfaceOrder
- Specified by:
getTaxedPrice
in interfaceOrderLike<Order>
- Returns:
- taxedPrice
- For
-
getTaxedShippingPrice
Sum of the
taxedPrice
field of ShippingInfo across all Shipping Methods.- Specified by:
getTaxedShippingPrice
in interfaceOrder
- Returns:
- taxedShippingPrice
-
getDiscountOnTotalPrice
Discounts that apply on the total price of the Order.
- Specified by:
getDiscountOnTotalPrice
in interfaceOrder
- Returns:
- discountOnTotalPrice
-
getTaxMode
Indicates how Tax Rates are set.
- Specified by:
getTaxMode
in interfaceOrder
- Specified by:
getTaxMode
in interfaceOrderLike<Order>
- Returns:
- taxMode
-
getTaxRoundingMode
Indicates how monetary values are rounded when calculating taxes for
taxedPrice
.- Specified by:
getTaxRoundingMode
in interfaceOrder
- Specified by:
getTaxRoundingMode
in interfaceOrderLike<Order>
- Returns:
- taxRoundingMode
-
getTaxCalculationMode
Indicates how taxes are calculated when calculating taxes for
taxedPrice
.- Specified by:
getTaxCalculationMode
in interfaceOrder
- Specified by:
getTaxCalculationMode
in interfaceOrderLike<Order>
- Returns:
- taxCalculationMode
-
getInventoryMode
Indicates how stock quantities are tracked for Line Items in the Order.
- Specified by:
getInventoryMode
in interfaceOrder
- Specified by:
getInventoryMode
in interfaceOrderLike<Order>
- Returns:
- inventoryMode
-
getBillingAddress
Billing address associated with the Order.
- Specified by:
getBillingAddress
in interfaceOrder
- Specified by:
getBillingAddress
in interfaceOrderLike<Order>
- Returns:
- billingAddress
-
getShippingAddress
Shipping address associated with the Order. Determines eligible ShippingMethod rates and Tax Rates of Line Items.
- Specified by:
getShippingAddress
in interfaceOrder
- Specified by:
getShippingAddress
in interfaceOrderLike<Order>
- Returns:
- shippingAddress
-
getShippingMode
Indicates whether there can be one or multiple Shipping Methods.
- Specified by:
getShippingMode
in interfaceOrder
- Returns:
- shippingMode
-
getShippingKey
key
of the ShippingMethod forSingle
ShippingMode.- Specified by:
getShippingKey
in interfaceOrder
- Returns:
- shippingKey
-
getShippingInfo
Shipping-related information for
Single
ShippingMode. Automatically set when a Shipping Method is set.- Specified by:
getShippingInfo
in interfaceOrder
- Specified by:
getShippingInfo
in interfaceOrderLike<Order>
- 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.
- Specified by:
getShippingRateInput
in interfaceOrder
- Specified by:
getShippingRateInput
in interfaceOrderLike<Order>
- Returns:
- shippingRateInput
- If
-
getShippingCustomFields
Custom Fields of the Shipping Method for
Single
ShippingMode.- Specified by:
getShippingCustomFields
in interfaceOrder
- Specified by:
getShippingCustomFields
in interfaceOrderLike<Order>
- Returns:
- shippingCustomFields
-
getShipping
Shipping-related information for
Multiple
ShippingMode. Updated automatically each time a new Shipping Method is added.- Specified by:
getShipping
in interfaceOrder
- 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
.- Specified by:
getItemShippingAddresses
in interfaceOrder
- Specified by:
getItemShippingAddresses
in interfaceOrderLike<Order>
- Returns:
- itemShippingAddresses
-
getDiscountCodes
Discount Codes added to the Order. An Order that has
directDiscounts
cannot havediscountCodes
.- Specified by:
getDiscountCodes
in interfaceOrder
- Specified by:
getDiscountCodes
in interfaceOrderLike<Order>
- Returns:
- discountCodes
-
getDirectDiscounts
Direct Discounts added to the Order. An Order that has
discountCodes
cannot havedirectDiscounts
.- Specified by:
getDirectDiscounts
in interfaceOrder
- Returns:
- directDiscounts
-
getRefusedGifts
Automatically set when a Line Item with
GiftLineItem
LineItemMode is removed from the Order.- Specified by:
getRefusedGifts
in interfaceOrder
- Specified by:
getRefusedGifts
in interfaceOrderLike<Order>
- Returns:
- refusedGifts
-
getPaymentInfo
Payment information related to the Order.
- Specified by:
getPaymentInfo
in interfaceOrder
- Specified by:
getPaymentInfo
in interfaceOrderLike<Order>
- Returns:
- paymentInfo
-
getCountry
Used for LineItem Price selection.
- Specified by:
getCountry
in interfaceOrder
- Specified by:
getCountry
in interfaceOrderLike<Order>
- Returns:
- country
-
getLocale
Languages of the Order. Can only contain languages supported by the Project.
-
getOrigin
Indicates the origin of the Cart from which the Order was created.
-
getCart
Reference to the Cart for an Order created from Cart. The referenced Cart will have the
Ordered
CartState. -
getQuote
Reference to the Quote for an Order created from Quote.
-
getOrderState
Current status of the Order.
- Specified by:
getOrderState
in interfaceOrder
- Returns:
- orderState
-
getShipmentState
Shipment status of the Order.
- Specified by:
getShipmentState
in interfaceOrder
- Returns:
- shipmentState
-
getPaymentState
Payment status of the Order.
- Specified by:
getPaymentState
in interfaceOrder
- Returns:
- paymentState
-
getState
State of the Order. This reference can point to a State in a custom workflow.
-
getSyncInfo
Contains synchronization activity information of the Order (like export or import). Can only be set with Update SyncInfo update action.
- Specified by:
getSyncInfo
in interfaceOrder
- Returns:
- syncInfo
-
getReturnInfo
Contains information regarding the returns associated with the Order.
- Specified by:
getReturnInfo
in interfaceOrder
- Returns:
- returnInfo
-
getLastMessageSequenceNumber
Deprecated.Internal-only field.
- Specified by:
getLastMessageSequenceNumber
in interfaceOrder
- Returns:
- lastMessageSequenceNumber
-
getCustom
Custom Fields of the Order.
-
getCompletedAt
User-defined date and time (UTC) of the Order. Present only on an Order created using Order Import.
- Specified by:
getCompletedAt
in interfaceOrder
- Returns:
- completedAt
-
getLastModifiedBy
Present on resources created after 1 February 2019 except for events not tracked.
- Specified by:
getLastModifiedBy
in interfaceOrder
- Specified by:
getLastModifiedBy
in interfaceOrderLike<Order>
- Returns:
- lastModifiedBy
-
getCreatedBy
Present on resources created after 1 February 2019 except for events not tracked.
- Specified by:
getCreatedBy
in interfaceOrder
- Specified by:
getCreatedBy
in interfaceOrderLike<Order>
- Returns:
- createdBy
-
setId
Description copied from interface:Order
Unique identifier of the Order.
- Specified by:
setId
in interfaceBaseResource
- Specified by:
setId
in interfaceOrder
- Parameters:
id
- value to be set
-
setVersion
Description copied from interface:Order
Current version of the Order.
- Specified by:
setVersion
in interfaceBaseResource
- Specified by:
setVersion
in interfaceOrder
- Parameters:
version
- value to be set
-
setCreatedAt
Description copied from interface:Order
Date and time (UTC) the Order was initially created.
- Specified by:
setCreatedAt
in interfaceBaseResource
- Specified by:
setCreatedAt
in interfaceOrder
- Parameters:
createdAt
- value to be set
-
setLastModifiedAt
Description copied from interface:Order
Date and time (UTC) the Order was last updated.
- Specified by:
setLastModifiedAt
in interfaceBaseResource
- Specified by:
setLastModifiedAt
in interfaceOrder
- Parameters:
lastModifiedAt
- value to be set
-
setOrderNumber
Description copied from interface:Order
User-defined identifier of the Order that is unique across a Project.
- Specified by:
setOrderNumber
in interfaceOrder
- Parameters:
orderNumber
- value to be set
-
setPurchaseOrderNumber
Description copied from interface:Order
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.
- Specified by:
setPurchaseOrderNumber
in interfaceOrder
- Parameters:
purchaseOrderNumber
- value to be set
-
setCustomerId
Description copied from interface:Order
id
of the Customer that the Order belongs to.- Specified by:
setCustomerId
in interfaceOrder
- Parameters:
customerId
- value to be set
-
setCustomerEmail
Description copied from interface:Order
Email address of the Customer that the Order belongs to.
- Specified by:
setCustomerEmail
in interfaceOrder
- Parameters:
customerEmail
- value to be set
-
setCustomerGroup
Description copied from interface:Order
Reference to the Customer Group of the Customer that the Order belongs to. Used for LineItem Price selection.
- Specified by:
setCustomerGroup
in interfaceOrder
- Parameters:
customerGroup
- value to be set
-
setAnonymousId
Description copied from interface:Order
Anonymous session associated with the Order.
- Specified by:
setAnonymousId
in interfaceOrder
- Parameters:
anonymousId
- value to be set
-
setBusinessUnit
Description copied from interface:Order
Reference to a Business Unit the Order belongs to.
- Specified by:
setBusinessUnit
in interfaceOrder
- Parameters:
businessUnit
- value to be set
-
setStore
Description copied from interface:Order
Reference to a Store the Order belongs to.
-
setLineItems
Description copied from interface:Order
Line Items that are part of the Order.
- Specified by:
setLineItems
in interfaceOrder
- Parameters:
lineItems
- values to be set
-
setLineItems
Description copied from interface:Order
Line Items that are part of the Order.
- Specified by:
setLineItems
in interfaceOrder
- Parameters:
lineItems
- values to be set
-
setCustomLineItems
Description copied from interface:Order
Custom Line Items that are part of the Order.
- Specified by:
setCustomLineItems
in interfaceOrder
- Parameters:
customLineItems
- values to be set
-
setCustomLineItems
Description copied from interface:Order
Custom Line Items that are part of the Order.
- Specified by:
setCustomLineItems
in interfaceOrder
- Parameters:
customLineItems
- values to be set
-
setTotalPrice
Description copied from interface:Order
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.- Specified by:
setTotalPrice
in interfaceOrder
- Parameters:
totalPrice
- value to be set
-
setTaxedPrice
Description copied from interface:Order
- 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.- Specified by:
setTaxedPrice
in interfaceOrder
- Parameters:
taxedPrice
- value to be set
- For
-
setTaxedShippingPrice
Description copied from interface:Order
Sum of the
taxedPrice
field of ShippingInfo across all Shipping Methods.- Specified by:
setTaxedShippingPrice
in interfaceOrder
- Parameters:
taxedShippingPrice
- value to be set
-
setDiscountOnTotalPrice
Description copied from interface:Order
Discounts that apply on the total price of the Order.
- Specified by:
setDiscountOnTotalPrice
in interfaceOrder
- Parameters:
discountOnTotalPrice
- value to be set
-
setTaxMode
Description copied from interface:Order
Indicates how Tax Rates are set.
- Specified by:
setTaxMode
in interfaceOrder
- Parameters:
taxMode
- value to be set
-
setTaxRoundingMode
Description copied from interface:Order
Indicates how monetary values are rounded when calculating taxes for
taxedPrice
.- Specified by:
setTaxRoundingMode
in interfaceOrder
- Parameters:
taxRoundingMode
- value to be set
-
setTaxCalculationMode
Description copied from interface:Order
Indicates how taxes are calculated when calculating taxes for
taxedPrice
.- Specified by:
setTaxCalculationMode
in interfaceOrder
- Parameters:
taxCalculationMode
- value to be set
-
setInventoryMode
Description copied from interface:Order
Indicates how stock quantities are tracked for Line Items in the Order.
- Specified by:
setInventoryMode
in interfaceOrder
- Parameters:
inventoryMode
- value to be set
-
setBillingAddress
Description copied from interface:Order
Billing address associated with the Order.
- Specified by:
setBillingAddress
in interfaceOrder
- Parameters:
billingAddress
- value to be set
-
setShippingAddress
Description copied from interface:Order
Shipping address associated with the Order. Determines eligible ShippingMethod rates and Tax Rates of Line Items.
- Specified by:
setShippingAddress
in interfaceOrder
- Parameters:
shippingAddress
- value to be set
-
setShippingMode
Description copied from interface:Order
Indicates whether there can be one or multiple Shipping Methods.
- Specified by:
setShippingMode
in interfaceOrder
- Parameters:
shippingMode
- value to be set
-
setShippingKey
Description copied from interface:Order
key
of the ShippingMethod forSingle
ShippingMode.- Specified by:
setShippingKey
in interfaceOrder
- Parameters:
shippingKey
- value to be set
-
setShippingInfo
Description copied from interface:Order
Shipping-related information for
Single
ShippingMode. Automatically set when a Shipping Method is set.- Specified by:
setShippingInfo
in interfaceOrder
- Parameters:
shippingInfo
- value to be set
-
setShippingRateInput
Description copied from interface:Order
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.
- Specified by:
setShippingRateInput
in interfaceOrder
- Parameters:
shippingRateInput
- value to be set
- If
-
setShippingCustomFields
Description copied from interface:Order
Custom Fields of the Shipping Method for
Single
ShippingMode.- Specified by:
setShippingCustomFields
in interfaceOrder
- Parameters:
shippingCustomFields
- value to be set
-
setShipping
Description copied from interface:Order
Shipping-related information for
Multiple
ShippingMode. Updated automatically each time a new Shipping Method is added.- Specified by:
setShipping
in interfaceOrder
- Parameters:
shipping
- values to be set
-
setShipping
Description copied from interface:Order
Shipping-related information for
Multiple
ShippingMode. Updated automatically each time a new Shipping Method is added.- Specified by:
setShipping
in interfaceOrder
- Parameters:
shipping
- values to be set
-
setItemShippingAddresses
Description copied from interface:Order
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
.- Specified by:
setItemShippingAddresses
in interfaceOrder
- Parameters:
itemShippingAddresses
- values to be set
-
setItemShippingAddresses
Description copied from interface:Order
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
.- Specified by:
setItemShippingAddresses
in interfaceOrder
- Parameters:
itemShippingAddresses
- values to be set
-
setDiscountCodes
Description copied from interface:Order
Discount Codes added to the Order. An Order that has
directDiscounts
cannot havediscountCodes
.- Specified by:
setDiscountCodes
in interfaceOrder
- Parameters:
discountCodes
- values to be set
-
setDiscountCodes
Description copied from interface:Order
Discount Codes added to the Order. An Order that has
directDiscounts
cannot havediscountCodes
.- Specified by:
setDiscountCodes
in interfaceOrder
- Parameters:
discountCodes
- values to be set
-
setDirectDiscounts
Description copied from interface:Order
Direct Discounts added to the Order. An Order that has
discountCodes
cannot havedirectDiscounts
.- Specified by:
setDirectDiscounts
in interfaceOrder
- Parameters:
directDiscounts
- values to be set
-
setDirectDiscounts
Description copied from interface:Order
Direct Discounts added to the Order. An Order that has
discountCodes
cannot havedirectDiscounts
.- Specified by:
setDirectDiscounts
in interfaceOrder
- Parameters:
directDiscounts
- values to be set
-
setRefusedGifts
Description copied from interface:Order
Automatically set when a Line Item with
GiftLineItem
LineItemMode is removed from the Order.- Specified by:
setRefusedGifts
in interfaceOrder
- Parameters:
refusedGifts
- values to be set
-
setRefusedGifts
Description copied from interface:Order
Automatically set when a Line Item with
GiftLineItem
LineItemMode is removed from the Order.- Specified by:
setRefusedGifts
in interfaceOrder
- Parameters:
refusedGifts
- values to be set
-
setPaymentInfo
Description copied from interface:Order
Payment information related to the Order.
- Specified by:
setPaymentInfo
in interfaceOrder
- Parameters:
paymentInfo
- value to be set
-
setCountry
Description copied from interface:Order
Used for LineItem Price selection.
- Specified by:
setCountry
in interfaceOrder
- Parameters:
country
- value to be set
-
setLocale
Description copied from interface:Order
Languages of the Order. Can only contain languages supported by the Project.
-
setOrigin
Description copied from interface:Order
Indicates the origin of the Cart from which the Order was created.
-
setCart
Description copied from interface:Order
Reference to the Cart for an Order created from Cart. The referenced Cart will have the
Ordered
CartState. -
setQuote
Description copied from interface:Order
Reference to the Quote for an Order created from Quote.
-
setOrderState
Description copied from interface:Order
Current status of the Order.
- Specified by:
setOrderState
in interfaceOrder
- Parameters:
orderState
- value to be set
-
setShipmentState
Description copied from interface:Order
Shipment status of the Order.
- Specified by:
setShipmentState
in interfaceOrder
- Parameters:
shipmentState
- value to be set
-
setPaymentState
Description copied from interface:Order
Payment status of the Order.
- Specified by:
setPaymentState
in interfaceOrder
- Parameters:
paymentState
- value to be set
-
setState
Description copied from interface:Order
State of the Order. This reference can point to a State in a custom workflow.
-
setSyncInfo
Description copied from interface:Order
Contains synchronization activity information of the Order (like export or import). Can only be set with Update SyncInfo update action.
- Specified by:
setSyncInfo
in interfaceOrder
- Parameters:
syncInfo
- values to be set
-
setSyncInfo
Description copied from interface:Order
Contains synchronization activity information of the Order (like export or import). Can only be set with Update SyncInfo update action.
- Specified by:
setSyncInfo
in interfaceOrder
- Parameters:
syncInfo
- values to be set
-
setReturnInfo
Description copied from interface:Order
Contains information regarding the returns associated with the Order.
- Specified by:
setReturnInfo
in interfaceOrder
- Parameters:
returnInfo
- values to be set
-
setReturnInfo
Description copied from interface:Order
Contains information regarding the returns associated with the Order.
- Specified by:
setReturnInfo
in interfaceOrder
- Parameters:
returnInfo
- values to be set
-
setLastMessageSequenceNumber
Deprecated.Description copied from interface:Order
Internal-only field.
- Specified by:
setLastMessageSequenceNumber
in interfaceOrder
- Parameters:
lastMessageSequenceNumber
- value to be set
-
setCustom
Description copied from interface:Order
Custom Fields of the Order.
- Specified by:
setCustom
in interfaceCustomizable<Order>
- Specified by:
setCustom
in interfaceOrder
- Parameters:
custom
- value to be set
-
setCompletedAt
Description copied from interface:Order
User-defined date and time (UTC) of the Order. Present only on an Order created using Order Import.
- Specified by:
setCompletedAt
in interfaceOrder
- Parameters:
completedAt
- value to be set
-
setLastModifiedBy
Description copied from interface:Order
Present on resources created after 1 February 2019 except for events not tracked.
- Specified by:
setLastModifiedBy
in interfaceOrder
- Parameters:
lastModifiedBy
- value to be set
-
setCreatedBy
Description copied from interface:Order
Present on resources created after 1 February 2019 except for events not tracked.
- Specified by:
setCreatedBy
in interfaceOrder
- Parameters:
createdBy
- value to be set
-
equals
-
hashCode
public int hashCode()
-