Package com.commercetools.api.models.order

Interface OrderSetParcelTrackingDataAction

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

Produces the ParcelTrackingDataUpdated Message.

Example to create an instance using the builder pattern 

     OrderSetParcelTrackingDataAction orderSetParcelTrackingDataAction = OrderSetParcelTrackingDataAction.builder()
             .build()

  • Field Details

    • SET_PARCEL_TRACKING_DATA

      static final String SET_PARCEL_TRACKING_DATA
      discriminator value for OrderSetParcelTrackingDataAction
      See Also:

  • Method Details

    • getParcelId

      String getParcelId()

      id of an existing Parcel.

      Either parcelId or parcelKey must be provided.

      Returns:
      parcelId

    • getParcelKey

      String getParcelKey()

      key of an existing Parcel.

      Either parcelId or parcelKey must be provided.

      Returns:
      parcelKey

    • getTrackingData

      @Valid @Valid TrackingData getTrackingData()

      Value to set. If empty, any existing value is removed.

      Returns:
      trackingData

    • setParcelId

      void setParcelId(String parcelId)

      id of an existing Parcel.

      Either parcelId or parcelKey must be provided.

      Parameters:
      parcelId - value to be set

    • setParcelKey

      void setParcelKey(String parcelKey)

      key of an existing Parcel.

      Either parcelId or parcelKey must be provided.

      Parameters:
      parcelKey - value to be set

    • setTrackingData

      void setTrackingData(TrackingData trackingData)

      Value to set. If empty, any existing value is removed.

      Parameters:
      trackingData - value to be set

    • of

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

    • of

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

    • copyDeep

      OrderSetParcelTrackingDataAction copyDeep()
      Specified by:
      copyDeep in interface OrderUpdateAction

    • deepCopy

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

    • builder

      static OrderSetParcelTrackingDataActionBuilder builder()
      builder factory method for OrderSetParcelTrackingDataAction
      Returns:
      builder

    • builder

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

    • withOrderSetParcelTrackingDataAction

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