Package com.commercetools.api.models.order

Interface ReturnInfo

public interface ReturnInfo

Stores information about returns connected to an Order.

Example to create an instance using the builder pattern 

     ReturnInfo returnInfo = ReturnInfo.builder()
             .plusItems(itemsBuilder -> itemsBuilder)
             .build()

  • Method Details

    • getItems

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

      Information on the Line Items or Custom Line Items returned.

      Returns:
      items

    • getReturnTrackingId

      String getReturnTrackingId()

      User-defined identifier to track the return.

      Returns:
      returnTrackingId

    • getReturnDate

      ZonedDateTime getReturnDate()

      Date and time (UTC) the return is initiated.

      Returns:
      returnDate

    • setItems

      void setItems(ReturnItem... items)

      Information on the Line Items or Custom Line Items returned.

      Parameters:
      items - values to be set

    • setItems

      void setItems(List<ReturnItem> items)

      Information on the Line Items or Custom Line Items returned.

      Parameters:
      items - values to be set

    • setReturnTrackingId

      void setReturnTrackingId(String returnTrackingId)

      User-defined identifier to track the return.

      Parameters:
      returnTrackingId - value to be set

    • setReturnDate

      void setReturnDate(ZonedDateTime returnDate)

      Date and time (UTC) the return is initiated.

      Parameters:
      returnDate - value to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static ReturnInfoBuilder builder()
      builder factory method for ReturnInfo
      Returns:
      builder

    • builder

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

    • withReturnInfo

      default <T> T withReturnInfo(Function<ReturnInfo,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<ReturnInfo> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference