Package com.commercetools.api.models.order

Interface OrderSetReturnShipmentStateAction

All Superinterfaces:
OrderUpdateAction, ResourceUpdateAction<OrderUpdateAction>
public interface OrderSetReturnShipmentStateAction extends OrderUpdateAction

To set a ReturnShipmentState, the Order returnInfo must have at least one ReturnItem.

Produces the Order Return Shipment State Changed Message.

Example to create an instance using the builder pattern 

     OrderSetReturnShipmentStateAction orderSetReturnShipmentStateAction = OrderSetReturnShipmentStateAction.builder()
             .shipmentState(ReturnShipmentState.ADVISED)
             .build()

  • Field Details

    • SET_RETURN_SHIPMENT_STATE

      static final String SET_RETURN_SHIPMENT_STATE
      discriminator value for OrderSetReturnShipmentStateAction
      See Also:

  • Method Details

    • getReturnItemId

      String getReturnItemId()

      id of the ReturnItem to update. Either returnItemId or returnItemKey is required.

      Returns:
      returnItemId

    • getReturnItemKey

      String getReturnItemKey()

      key of the ReturnItem to update. Either returnItemId or returnItemKey is required.

      Returns:
      returnItemKey

    • getShipmentState

      @NotNull @NotNull ReturnShipmentState getShipmentState()

      New shipment state of the ReturnItem.

      This update action can only transition Return Items from the Returned state to BackInStock or Unusable. The initial Advised and Returned states can only be set at creation time on ReturnItemDraft.

      Returns:
      shipmentState

    • setReturnItemId

      void setReturnItemId(String returnItemId)

      id of the ReturnItem to update. Either returnItemId or returnItemKey is required.

      Parameters:
      returnItemId - value to be set

    • setReturnItemKey

      void setReturnItemKey(String returnItemKey)

      key of the ReturnItem to update. Either returnItemId or returnItemKey is required.

      Parameters:
      returnItemKey - value to be set

    • setShipmentState

      void setShipmentState(ReturnShipmentState shipmentState)

      New shipment state of the ReturnItem.

      This update action can only transition Return Items from the Returned state to BackInStock or Unusable. The initial Advised and Returned states can only be set at creation time on ReturnItemDraft.

      Parameters:
      shipmentState - value to be set

    • of

      static OrderSetReturnShipmentStateAction of()
      factory method
      Returns:
      instance of OrderSetReturnShipmentStateAction

    • of

      static OrderSetReturnShipmentStateAction of(OrderSetReturnShipmentStateAction template)
      factory method to create a shallow copy OrderSetReturnShipmentStateAction
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • copyDeep

      OrderSetReturnShipmentStateAction copyDeep()
      Specified by:
      copyDeep in interface OrderUpdateAction

    • deepCopy

      @Nullable static OrderSetReturnShipmentStateAction deepCopy(@Nullable OrderSetReturnShipmentStateAction template)
      factory method to create a deep copy of OrderSetReturnShipmentStateAction
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • builder

      static OrderSetReturnShipmentStateActionBuilder builder()
      builder factory method for OrderSetReturnShipmentStateAction
      Returns:
      builder

    • builder

      static OrderSetReturnShipmentStateActionBuilder builder(OrderSetReturnShipmentStateAction template)
      create builder for OrderSetReturnShipmentStateAction instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder

    • withOrderSetReturnShipmentStateAction

      default <T> T withOrderSetReturnShipmentStateAction(Function<OrderSetReturnShipmentStateAction,T> helper)
      accessor map function
      Type Parameters:
      T - mapped type
      Parameters:
      helper - function to map the object
      Returns:
      mapped value

    • typeReference

      static tools.jackson.core.type.TypeReference<OrderSetReturnShipmentStateAction> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference