Package com.commercetools.api.models.order

Interface OrderAddReturnInfoAction

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

Produces the Return Info Added Message.

Example to create an instance using the builder pattern 

     OrderAddReturnInfoAction orderAddReturnInfoAction = OrderAddReturnInfoAction.builder()
             .plusItems(itemsBuilder -> itemsBuilder)
             .build()

  • Field Details

    • ADD_RETURN_INFO

      static final String ADD_RETURN_INFO
      discriminator value for OrderAddReturnInfoAction
      See Also:

  • Method Details

    • getReturnTrackingId

      String getReturnTrackingId()

      Value to set.

      Returns:
      returnTrackingId

    • getItems

      @NotNull @Valid @NotNull @Valid List<ReturnItemDraft> getItems()

      Items to be returned. Must not be empty.

      Returns:
      items

    • getReturnDate

      ZonedDateTime getReturnDate()

      Value to set. If not set, it defaults to the current date and time.

      Returns:
      returnDate

    • setReturnTrackingId

      void setReturnTrackingId(String returnTrackingId)

      Value to set.

      Parameters:
      returnTrackingId - value to be set

    • setItems

      void setItems(ReturnItemDraft... items)

      Items to be returned. Must not be empty.

      Parameters:
      items - values to be set

    • setItems

      void setItems(List<ReturnItemDraft> items)

      Items to be returned. Must not be empty.

      Parameters:
      items - values to be set

    • setReturnDate

      void setReturnDate(ZonedDateTime returnDate)

      Value to set. If not set, it defaults to the current date and time.

      Parameters:
      returnDate - value to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static OrderAddReturnInfoActionBuilder builder()
      builder factory method for OrderAddReturnInfoAction
      Returns:
      builder

    • builder

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

    • withOrderAddReturnInfoAction

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

    • typeReference

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