io.sphere.sdk.orders.commands

Interface OrderUpdateCommand

All Superinterfaces:

Command<Order>, ExpansionPathContainer<Order>, MetaModelReferenceExpansionDsl<Order,OrderUpdateCommand,OrderExpansionModel<Order>>, ReferenceExpansionDsl<Order,OrderUpdateCommand>, ReferenceExpansionSupport<Order>, SphereRequest<Order>, UpdateCommand<Order>, UpdateCommandDsl<Order,OrderUpdateCommand>

public interface OrderUpdateCommand
extends UpdateCommandDsl<Order,OrderUpdateCommand>, MetaModelReferenceExpansionDsl<Order,OrderUpdateCommand,OrderExpansionModel<Order>>

Command object to update a Order.

Known UpdateActions

• AddDelivery
• AddItemShippingAddress
• AddParcelToDelivery
• AddPayment
• AddReturnInfo
• ChangeOrderState
• ChangePaymentState
• ChangeShipmentState
• ImportCustomLineItemState
• ImportLineItemState
• RemoveDelivery
• RemoveItemShippingAddress
• RemoveParcelFromDelivery
• RemovePayment
• SetBillingAddress
• SetCustomField
• SetCustomLineItemCustomField
• SetCustomLineItemCustomType
• SetCustomLineItemShippingDetails
• SetCustomType
• SetCustomerEmail
• SetCustomerId
• SetDeliveryAddress
• SetDeliveryCustomField
• SetDeliveryCustomType
• SetDeliveryItems
• SetLineItemCustomField
• SetLineItemCustomType
• SetLineItemShippingDetails
• SetLocale
• SetOrderNumber
• SetParcelCustomField
• SetParcelCustomType
• SetParcelItems
• SetParcelMeasurements
• SetParcelTrackingData
• SetReturnInfo
• SetReturnItemCustomField
• SetReturnItemCustomType
• SetReturnPaymentState
• SetReturnShipmentState
• SetShippingAddress
• SetStore
• TransitionCustomLineItemState
• TransitionLineItemState
• TransitionState
• UpdateItemShippingAddress
• UpdateSyncInfo

See Also:

Order

Method Summary

Modifier and Type	Method and Description
static OrderUpdateCommand	of(Versioned<Order> versioned, List<? extends UpdateAction<Order>> updateActions) Creates a command to update a Order selected by its ID using several update actions.
static OrderUpdateCommand	of(Versioned<Order> versioned, UpdateAction<Order> updateAction, UpdateAction<Order>... updateActions) Creates a command to update a Order selected by its ID using one update action.
static OrderUpdateCommand	ofOrderNumber(String orderNumber, Long version, List<? extends UpdateAction<Order>> updateActions) Creates a command to update a Order selected by its orderNumber using several update actions.
static OrderUpdateCommand	ofOrderNumber(String orderNumber, Long version, UpdateAction<Order> updateAction) Creates a command to update a Order selected by its orderNumber using one update action.

Methods inherited from interface io.sphere.sdk.commands.UpdateCommandDsl

plusUpdateActions, withAdditionalHttpQueryParameters, withUpdateActions, withVersion, withVersion

Methods inherited from interface io.sphere.sdk.commands.UpdateCommand

getUpdateActions

Methods inherited from interface io.sphere.sdk.client.SphereRequest

canDeserialize, deserialize, httpRequestIntent

Methods inherited from interface io.sphere.sdk.expansion.MetaModelReferenceExpansionDsl

plusExpansionPaths, withExpansionPaths

Methods inherited from interface io.sphere.sdk.expansion.ReferenceExpansionDsl

plusExpansionPaths, plusExpansionPaths, plusExpansionPaths, plusExpansionPaths, withExpansionPaths, withExpansionPaths, withExpansionPaths, withExpansionPaths

Methods inherited from interface io.sphere.sdk.expansion.ReferenceExpansionSupport

expansionPaths

Method Detail

of

static OrderUpdateCommand of(Versioned<Order> versioned,
                             List<? extends UpdateAction<Order>> updateActions)

Creates a command to update a Order selected by its ID using several update actions.

Parameters:

versioned - the object to update (so directly a Order) or just the version/ID information of it

updateActions - the updates

Returns:

the update command for Order

of

@SafeVarargs
static OrderUpdateCommand of(Versioned<Order> versioned,
                                          UpdateAction<Order> updateAction,
                                          UpdateAction<Order>... updateActions)

Creates a command to update a Order selected by its ID using one update action.

Parameters:

versioned - the object to update (so directly a Order) or just the version/ID information of it

updateAction - the update to perform

updateActions - additional updates to perform

Returns:

the update command for Order

ofOrderNumber

static OrderUpdateCommand ofOrderNumber(String orderNumber,
                                        Long version,
                                        List<? extends UpdateAction<Order>> updateActions)

Creates a command to update a Order selected by its orderNumber using several update actions.

Parameters:

orderNumber - the orderNumber of the Order to update, see Order.getOrderNumber()

version - the current version of the Order, see Resource.getVersion()

updateActions - the updates

Returns:

the update command for Order

ofOrderNumber

static OrderUpdateCommand ofOrderNumber(String orderNumber,
                                        Long version,
                                        UpdateAction<Order> updateAction)

Creates a command to update a Order selected by its orderNumber using one update action.

Parameters:

orderNumber - the orderNumber of the Order to update, see Order.getOrderNumber()

version - the current version of the Order, see Resource.getVersion()

updateAction - the update to perform

Returns:

the update command for Order