Package io.sphere.sdk.orders.commands.updateactions

Provides the possible operations which can be performed on update commands for orders.

See: Description

Class Summary

Class	Description
AddDelivery	Adds a delivery.
AddItemShippingAddress	Updates the itemShippingAddresses property of a Order.
AddParcelToDelivery	Adds a parcel to a delivery.
AddPayment	This action adds a payment to the PaymentInfo.
AddReturnInfo	Adds return data to an order.
ChangeOrderState	Changes the order state.
ChangePaymentState	Changes the payment state.
ChangeShipmentState	Changes the shipment state.
ImportCustomLineItemState	These import of states does not follow any predefined rules and should be only used if no transitions are defined.
ImportLineItemState	These import of states does not follow any predefined rules and should be only used if no transitions are defined.
RemoveDelivery	Updates the deliveries property of a Order.
RemoveItemShippingAddress	Updates the itemShippingAddresses property of a Order.
RemoveParcelFromDelivery	Updates the parcels property of a Order.
RemovePayment	This action removes a payment from the PaymentInfo.
SetBillingAddress	Sets the billing address.
SetCustomerEmail	Sets the customer email.
SetCustomerId	Updates the customerId property of a Order.
SetCustomField	Updates a custom field.
SetCustomLineItemCustomField	Updates a custom field in a custom line item.
SetCustomLineItemCustomType	Sets or removes a custom type in a custom line item.
SetCustomLineItemShippingDetails	Updates the customLineItems property of a Order.
SetCustomType	Sets or removes a custom type.
SetDeliveryAddress	Sets the address value on an existing Delivery
SetDeliveryCustomField	Updates a custom field in a delivery.
SetDeliveryCustomType	Sets or removes a custom type in a delivery See also OrderUpdateCommand.
SetDeliveryItems	Updates the items property of a Order.
SetLineItemCustomField	Updates a custom field in a line item.
SetLineItemCustomType	Sets or removes a custom type in a line item.
SetLineItemShippingDetails	Updates the lineItems property of a Order.
SetLocale	Sets the locale.
SetOrderNumber	Sets the order number.
SetParcelCustomField	Updates a custom field in a parcel.
SetParcelCustomType	Sets or removes a custom type in a parcel.
SetParcelItems	Updates the items property of a Order.
SetParcelMeasurements	Updates the measurements property of a Order.
SetParcelTrackingData	Updates the trackingData property of a Order.
SetReturnInfo	Sets return data to an order.
SetReturnItemCustomField	Updates a custom field in a return item.
SetReturnItemCustomType	Sets or removes a custom type in a return item.
SetReturnPaymentState	Sets the return payment state.
SetReturnShipmentState	Sets the return shipment state.
SetShippingAddress	Sets the shipping address of an order (not its cart) to a new value or to null.
SetStore	Sets the store.
TransitionCustomLineItemState	Change the state of a Custom Line Item according to allowed transitions.
TransitionLineItemState	Change the state of a Line Item according to allowed transitions See also OrderUpdateCommand. withStandardStates(client(), (State initialState, State nextState) -> withOrder(client(), order -> { final LineItem lineItem = order.getLineItems().get(0); assertThat(lineItem).has(state(initialState)).has(not(state(nextState))); final long quantity = 1; final ZonedDateTime actualTransitionDate = ZonedDateTime_IN_PAST; final Order updatedOrder = client().executeBlocking(OrderUpdateCommand.of(order, TransitionLineItemState.of(lineItem, quantity, initialState, nextState, actualTransitionDate))); assertThat(updatedOrder.getLineItems().get(0)).has(itemStates(ItemState.of(nextState, quantity))); //you can observe a message final Query<LineItemStateTransitionMessage> messageQuery = MessageQuery.of() .withPredicates(m -> m.resource().is(order)) .forMessageType(LineItemStateTransitionMessage.MESSAGE_HINT); assertEventually(() -> { final Optional<LineItemStateTransitionMessage> lineItemStateTransitionMessageOptional = client().executeBlocking(messageQuery).head(); assertThat(lineItemStateTransitionMessageOptional).isPresent(); final LineItemStateTransitionMessage lineItemStateTransitionMessage = lineItemStateTransitionMessageOptional.get(); final String lineItemIdFromMessage = lineItemStateTransitionMessage.getLineItemId(); assertThat(lineItemIdFromMessage).isEqualTo(order.getLineItems().get(0).getId()); final ZonedDateTime transitionDateFromMessage = lineItemStateTransitionMessage.getTransitionDate(); assertThat(transitionDateFromMessage).isEqualTo(actualTransitionDate); final Long quantityFromMessage = lineItemStateTransitionMessage.getQuantity(); assertThat(quantityFromMessage).isEqualTo(quantity); final Reference<State> fromStateReference = lineItemStateTransitionMessage.getFromState(); assertThat(fromStateReference).isEqualTo(initialState.toReference()); final Reference<State> toStateReference = lineItemStateTransitionMessage.getToState(); assertThat(toStateReference).isEqualTo(nextState.toReference()); }); return updatedOrder; }) ); See the test code.
TransitionState	Transition to a new state.
UpdateItemShippingAddress	Updates the itemShippingAddresses property of a Order.
UpdateSyncInfo	Updates the synchronization info.

Package io.sphere.sdk.orders.commands.updateactions Description

Provides the possible operations which can be performed on update commands for orders.