Package com.commercetools.api.models.order_edit
package com.commercetools.api.models.order_edit
-
ClassDescriptionOrderEdit Example to create an instance using the builder patternThe
stagedActions
field cannot be updated if the Order Editresult
is OrderEdit Applied.OrderEditAddStagedActionActionBuilder Example to create an instance using the builder patternResult of a succesful application ofstagedActions
to the Order.OrderEditAppliedBuilder Example to create an instance using the builder patternIf theeditVersion
and/orresourceVersion
do not match the actual version, a ConcurrentModification error will be returned.OrderEditApplyBuilder Example to create an instance using the builder patternOrderEditBuilder Example to create an instance using the builder patternOrderEditDraft Example to create an instance using the builder patternOrderEditDraftBuilder Example to create an instance using the builder patternIndicates that the edit has not been applied or processed in any way.OrderEditNotProcessedBuilder Example to create an instance using the builder patternPagedQueryResult withresults
containing an array of OrderEdit.OrderEditPagedQueryResponseBuilder Example to create an instance using the builder patternResult of a failed application ofstagedActions
to the Order.OrderEditPreviewFailureBuilder Example to create an instance using the builder patternThe data is not persisted but is dynamically pulled by dry-running the update actions fromstagedActions
on the current version of the related Order, not from the Order version at the time the OrderEdit was created.OrderEditPreviewSuccessBuilder Example to create an instance using the builder patternReference to an OrderEdit.OrderEditReferenceBuilder Example to create an instance using the builder patternResourceIdentifier to an OrderEdit.OrderEditResourceIdentifierBuilder Example to create an instance using the builder patternOrderEditResult Example to create a subtype instance using the builder patternOrderEditResultBuilderOrderEditSetCommentAction Example to create an instance using the builder patternOrderEditSetCommentActionBuilder Example to create an instance using the builder patternOrderEditSetCustomFieldAction Example to create an instance using the builder patternOrderEditSetCustomFieldActionBuilder Example to create an instance using the builder patternOrderEditSetCustomTypeAction Example to create an instance using the builder patternOrderEditSetCustomTypeActionBuilder Example to create an instance using the builder patternOrderEditSetKeyAction Example to create an instance using the builder patternOrderEditSetKeyActionBuilder Example to create an instance using the builder patternThestagedActions
field cannot be updated if the Order Editresult
is OrderEdit Applied.OrderEditSetStagedActionsActionBuilder Example to create an instance using the builder patternOrderEditUpdate Example to create an instance using the builder patternOrderEditUpdateAction Example to create a subtype instance using the builder patternOrderEditUpdateActionBuilderOrderEditUpdateBuilder Example to create an instance using the builder patternExcerpt of the Order extracting the total and the taxed price.OrderExcerptBuilder Example to create an instance using the builder patternStagedOrder Example to create an instance using the builder patternIf the Cart already contains a CustomLineItem with the sameslug
,name
,money
,taxCategory
,state
, and Custom Fields, then only the quantity of the existing Custom Line Item is increased.StagedOrderAddCustomLineItemActionBuilder Example to create an instance using the builder patternA Delivery can only be added to an Order if itsshippingInfo
(forshippingMode
=Single
), or itsshipping
(forshippingMode
=Multiple
) exists.StagedOrderAddDeliveryActionBuilder Example to create an instance using the builder patternAdds a DiscountCode to the Cart to activate the related Cart Discounts.StagedOrderAddDiscountCodeActionBuilder Example to create an instance using the builder patternAdds an address to an Order when shipping to multiple addresses is desired.StagedOrderAddItemShippingAddressActionBuilder Example to create an instance using the builder patternIf the Cart contains a LineItem for a Product Variant with the same LineItemMode, Custom Fields, supply and distribution channel, then only the quantity of the existing Line Item is increased.StagedOrderAddLineItemActionBuilder Example to create an instance using the builder patternTo add a Parcel, at least one Delivery must exist.StagedOrderAddParcelToDeliveryActionBuilder Example to create an instance using the builder patternStagedOrderAddPaymentAction Example to create an instance using the builder patternStagedOrderAddPaymentActionBuilder Example to create an instance using the builder patternProduces the Return Info Added Message.StagedOrderAddReturnInfoActionBuilder Example to create an instance using the builder patternAdds all LineItems of a ShoppingList to the Cart.StagedOrderAddShoppingListActionBuilder Example to create an instance using the builder patternStagedOrderBuilder Example to create an instance using the builder patternStagedOrderChangeCustomLineItemMoneyAction Example to create an instance using the builder patternStagedOrderChangeCustomLineItemMoneyActionBuilder Example to create an instance using the builder patternWhen multiple shipping addresses are set for a Custom Line Item, use the Add CustomLineItem update action to change the shipping details.StagedOrderChangeCustomLineItemQuantityActionBuilder Example to create an instance using the builder patternWhen multiple shipping addresses are set for a Line Item, use the Remove LineItem and Add LineItem update action to change the shipping details.StagedOrderChangeLineItemQuantityActionBuilder Example to create an instance using the builder patternProduces the Order State Changed Message.StagedOrderChangeOrderStateActionBuilder Example to create an instance using the builder patternProduces the Order Payment State Changed Message.StagedOrderChangePaymentStateActionBuilder Example to create an instance using the builder patternProduces the Order Shipment State Changed Message.StagedOrderChangeShipmentStateActionBuilder Example to create an instance using the builder patternChanging the tax calculation mode leads to recalculation of taxes.StagedOrderChangeTaxCalculationModeActionBuilder Example to create an instance using the builder patternWhenExternal
TaxMode is changed toPlatform
orDisabled
, all previously set external Tax Rates are removed. When set toPlatform
, Line Items, Custom Line Items, and Shipping Method require a Tax Category with a Tax Rate for the Cart'sshippingAddress
. Example to create an instance using the builder patternStagedOrderChangeTaxModeActionBuilder Example to create an instance using the builder patternChanging the tax rounding mode leads to recalculation of taxes.StagedOrderChangeTaxRoundingModeActionBuilder Example to create an instance using the builder patternThe import of States does not follow any predefined rules and should be only used if no transitions are defined.StagedOrderImportCustomLineItemStateActionBuilder Example to create an instance using the builder patternThe import of States does not follow any predefined rules and should be only used if no transitions are defined.StagedOrderImportLineItemStateActionBuilder Example to create an instance using the builder patternThis update action does not support specifying a quantity, unlike the Remove LineItem update action.StagedOrderRemoveCustomLineItemActionBuilder Example to create an instance using the builder patternProduces the DeliveryRemoved Message.StagedOrderRemoveDeliveryActionBuilder Example to create an instance using the builder patternStagedOrderRemoveDiscountCodeAction Example to create an instance using the builder patternStagedOrderRemoveDiscountCodeActionBuilder Example to create an instance using the builder patternAn address can only be removed if it is not referenced in any ItemShippingTarget of the Cart.StagedOrderRemoveItemShippingAddressActionBuilder Example to create an instance using the builder patternThe LineItem price is updated as described in Line Item price selection.StagedOrderRemoveLineItemActionBuilder Example to create an instance using the builder patternProduces the ParcelRemovedFromDelivery Message.StagedOrderRemoveParcelFromDeliveryActionBuilder Example to create an instance using the builder patternStagedOrderRemovePaymentAction Example to create an instance using the builder patternStagedOrderRemovePaymentActionBuilder Example to create an instance using the builder patternThis action updates thebillingAddress
on the Order, but it does not change the billing address on the referenced Cart from which the Order is created.StagedOrderSetBillingAddressActionBuilder Example to create an instance using the builder patternStagedOrderSetBillingAddressCustomFieldAction Example to create an instance using the builder patternStagedOrderSetBillingAddressCustomFieldActionBuilder Example to create an instance using the builder patternStagedOrderSetBillingAddressCustomTypeAction Example to create an instance using the builder patternStagedOrderSetBillingAddressCustomTypeActionBuilder Example to create an instance using the builder patternSetting the country can lead to changes in the LineItem prices.StagedOrderSetCountryActionBuilder Example to create an instance using the builder patternThis action updates thecustomerEmail
on the Order, but it does not change the Customer email on the Cart the Order has been created from.StagedOrderSetCustomerEmailActionBuilder Example to create an instance using the builder patternThis update action can only be used if a Customer is not assigned to a Cart.StagedOrderSetCustomerGroupActionBuilder Example to create an instance using the builder patternSetting the Order'scustomerId
does not recalculate prices or discounts on the Order.StagedOrderSetCustomerIdActionBuilder Example to create an instance using the builder patternStagedOrderSetCustomFieldAction Example to create an instance using the builder patternStagedOrderSetCustomFieldActionBuilder Example to create an instance using the builder patternStagedOrderSetCustomLineItemCustomFieldAction Example to create an instance using the builder patternStagedOrderSetCustomLineItemCustomFieldActionBuilder Example to create an instance using the builder patternStagedOrderSetCustomLineItemCustomTypeAction Example to create an instance using the builder patternStagedOrderSetCustomLineItemCustomTypeActionBuilder Example to create an instance using the builder patternStagedOrderSetCustomLineItemShippingDetailsAction Example to create an instance using the builder patternStagedOrderSetCustomLineItemShippingDetailsActionBuilder Example to create an instance using the builder patternCan be used if the Cart has theExternalAmount
TaxMode.StagedOrderSetCustomLineItemTaxAmountActionBuilder Example to create an instance using the builder patternCan be used if the Cart has theExternal
TaxMode.StagedOrderSetCustomLineItemTaxRateActionBuilder Example to create an instance using the builder patternTo set the Cart's custom Shipping Method (independent of the ShippingMethods managed through the Shipping Methods API) the Cart must have theSingle
ShippingMode and ashippingAddress
.StagedOrderSetCustomShippingMethodActionBuilder Example to create an instance using the builder patternStagedOrderSetCustomTypeAction Example to create an instance using the builder patternStagedOrderSetCustomTypeActionBuilder Example to create an instance using the builder patternProduces the DeliveryAddressSet Message.StagedOrderSetDeliveryAddressActionBuilder Example to create an instance using the builder patternStagedOrderSetDeliveryAddressCustomFieldAction Example to create an instance using the builder patternStagedOrderSetDeliveryAddressCustomFieldActionBuilder Example to create an instance using the builder patternStagedOrderSetDeliveryAddressCustomTypeAction Example to create an instance using the builder patternStagedOrderSetDeliveryAddressCustomTypeActionBuilder Example to create an instance using the builder patternStagedOrderSetDeliveryCustomFieldAction Example to create an instance using the builder patternStagedOrderSetDeliveryCustomFieldActionBuilder Example to create an instance using the builder patternStagedOrderSetDeliveryCustomTypeAction Example to create an instance using the builder patternStagedOrderSetDeliveryCustomTypeActionBuilder Example to create an instance using the builder patternProduces the Delivery Items Updated Message.StagedOrderSetDeliveryItemsActionBuilder Example to create an instance using the builder patternAdds a DirectDiscount, but only if no DiscountCode has been added to the Order.StagedOrderSetDirectDiscountsActionBuilder Example to create an instance using the builder patternStagedOrderSetItemShippingAddressCustomFieldAction Example to create an instance using the builder patternStagedOrderSetItemShippingAddressCustomFieldActionBuilder Example to create an instance using the builder patternStagedOrderSetItemShippingAddressCustomTypeAction Example to create an instance using the builder patternStagedOrderSetItemShippingAddressCustomTypeActionBuilder Example to create an instance using the builder patternStagedOrderSetLineItemCustomFieldAction Example to create an instance using the builder patternStagedOrderSetLineItemCustomFieldActionBuilder Example to create an instance using the builder patternStagedOrderSetLineItemCustomTypeAction Example to create an instance using the builder patternStagedOrderSetLineItemCustomTypeActionBuilder Example to create an instance using the builder patternSetting a distribution channel for a LineItem can lead to an updatedprice
as described in Line Item price selection.StagedOrderSetLineItemDistributionChannelActionBuilder Example to create an instance using the builder patternSets the LineItemprice
and changes thepriceMode
toExternalPrice
LineItemPriceMode.StagedOrderSetLineItemPriceActionBuilder Example to create an instance using the builder patternStagedOrderSetLineItemShippingDetailsAction Example to create an instance using the builder patternStagedOrderSetLineItemShippingDetailsActionBuilder Example to create an instance using the builder patternCan be used if the Cart has theExternalAmount
TaxMode.StagedOrderSetLineItemTaxAmountActionBuilder Example to create an instance using the builder patternCan be used if the Cart has theExternal
TaxMode.StagedOrderSetLineItemTaxRateActionBuilder Example to create an instance using the builder patternSets the LineItemtotalPrice
andprice
, and changes thepriceMode
toExternalTotal
LineItemPriceMode.StagedOrderSetLineItemTotalPriceActionBuilder Example to create an instance using the builder patternStagedOrderSetLocaleAction Example to create an instance using the builder patternStagedOrderSetLocaleActionBuilder Example to create an instance using the builder patternStagedOrderSetOrderNumberAction Example to create an instance using the builder patternStagedOrderSetOrderNumberActionBuilder Example to create an instance using the builder patternUpdates the total tax amount of the Order if it has theExternalAmount
TaxMode.StagedOrderSetOrderTotalTaxActionBuilder Example to create an instance using the builder patternStagedOrderSetParcelCustomFieldAction Example to create an instance using the builder patternStagedOrderSetParcelCustomFieldActionBuilder Example to create an instance using the builder patternStagedOrderSetParcelCustomTypeAction Example to create an instance using the builder patternStagedOrderSetParcelCustomTypeActionBuilder Example to create an instance using the builder patternProduces the ParcelItemsUpdated Message.StagedOrderSetParcelItemsActionBuilder Example to create an instance using the builder patternProduces the ParcelMeasurementsUpdated Message.StagedOrderSetParcelMeasurementsActionBuilder Example to create an instance using the builder patternProduces the ParcelTrackingDataUpdated Message.StagedOrderSetParcelTrackingDataActionBuilder Example to create an instance using the builder patternProduces the PurchaseOrderNumberSet Message.StagedOrderSetPurchaseOrderNumberActionBuilder Example to create an instance using the builder patternProduces the Return Info Set Message.StagedOrderSetReturnInfoActionBuilder Example to create an instance using the builder patternStagedOrderSetReturnItemCustomFieldAction Example to create an instance using the builder patternStagedOrderSetReturnItemCustomFieldActionBuilder Example to create an instance using the builder patternStagedOrderSetReturnItemCustomTypeAction Example to create an instance using the builder patternStagedOrderSetReturnItemCustomTypeActionBuilder Example to create an instance using the builder patternTo set a ReturnPaymentState, the OrderreturnInfo
must have at least one ReturnItem.StagedOrderSetReturnPaymentStateActionBuilder Example to create an instance using the builder patternTo set aReturnShipmentState
, the OrderreturnInfo
must have at least one ReturnItem.StagedOrderSetReturnShipmentStateActionBuilder Example to create an instance using the builder patternThis action updates theshippingAddress
on the Order, but it does not change the shipping address on the referenced Cart from which the Order is created.StagedOrderSetShippingAddressActionBuilder Example to create an instance using the builder patternSets the shipping address and a custom Shipping Method together to prevent an inconsistent state.StagedOrderSetShippingAddressAndCustomShippingMethodActionBuilder Example to create an instance using the builder patternSets the shipping address and Shipping Method together to prevent an inconsistent state.StagedOrderSetShippingAddressAndShippingMethodActionBuilder Example to create an instance using the builder patternStagedOrderSetShippingAddressCustomFieldAction Example to create an instance using the builder patternStagedOrderSetShippingAddressCustomFieldActionBuilder Example to create an instance using the builder patternStagedOrderSetShippingAddressCustomTypeAction Example to create an instance using the builder patternStagedOrderSetShippingAddressCustomTypeActionBuilder Example to create an instance using the builder patternStagedOrderSetShippingCustomFieldAction Example to create an instance using the builder patternStagedOrderSetShippingCustomFieldActionBuilder Example to create an instance using the builder patternThis action sets, overwrites, or removes any existing Custom Type and Custom Fields for the Order'sshippingMethod
orshipping
.StagedOrderSetShippingCustomTypeActionBuilder Example to create an instance using the builder patternTo set the Cart's Shipping Method, the Cart must have theSingle
ShippingMode and ashippingAddress
.StagedOrderSetShippingMethodActionBuilder Example to create an instance using the builder patternA Shipping Method tax amount can be set if the Cart has theExternalAmount
TaxMode.StagedOrderSetShippingMethodTaxAmountActionBuilder Example to create an instance using the builder patternA Shipping Method Tax Rate can be set if the Cart has theExternal
TaxMode.StagedOrderSetShippingMethodTaxRateActionBuilder Example to create an instance using the builder patternInput used to select a ShippingRatePriceTier.StagedOrderSetShippingRateInputActionBuilder Example to create an instance using the builder patternSets the Store the Order is assigned to.StagedOrderSetStoreActionBuilder Example to create an instance using the builder patternProduces the Custom Line Item State Transition Message.StagedOrderTransitionCustomLineItemStateActionBuilder Example to create an instance using the builder patternProduces the Line Item State Transition Message.StagedOrderTransitionLineItemStateActionBuilder Example to create an instance using the builder patternIf the existing State has settransitions
, there must be a direct transition to the new State.StagedOrderTransitionStateActionBuilder Example to create an instance using the builder patternUpdates an address initemShippingAddresses
by keeping the Addresskey
.StagedOrderUpdateItemShippingAddressActionBuilder Example to create an instance using the builder patternStagedOrderUpdateSyncInfoAction Example to create an instance using the builder patternStagedOrderUpdateSyncInfoActionBuilder Example to create an instance using the builder pattern