Package com.commercetools.importapi.models.order_patches

Interface DeliveryParcel

public interface DeliveryParcel
DeliveryParcel
Example to create an instance using the builder pattern 

     DeliveryParcel deliveryParcel = DeliveryParcel.builder()
             .deliveryId("{deliveryId}")
             .build()

  • Method Details

    • getDeliveryId

      @NotNull @NotNull String getDeliveryId()

      Unique identifier of the Delivery.

      Returns:
      deliveryId

    • getMeasurements

      @Valid @Valid ParcelMeasurements getMeasurements()

      Information about the dimensions of the Parcel.

      Returns:
      measurements

    • getTrackingData

      @Valid @Valid TrackingData getTrackingData()

      Shipment tracking information of the Parcel.

      Returns:
      trackingData

    • getItems

      @Valid @Valid List<DeliveryItem> getItems()

      Line Items or Custom Line Items delivered in this Parcel.

      Returns:
      items

    • setDeliveryId

      void setDeliveryId(String deliveryId)

      Unique identifier of the Delivery.

      Parameters:
      deliveryId - value to be set

    • setMeasurements

      void setMeasurements(ParcelMeasurements measurements)

      Information about the dimensions of the Parcel.

      Parameters:
      measurements - value to be set

    • setTrackingData

      void setTrackingData(TrackingData trackingData)

      Shipment tracking information of the Parcel.

      Parameters:
      trackingData - value to be set

    • setItems

      void setItems(DeliveryItem... items)

      Line Items or Custom Line Items delivered in this Parcel.

      Parameters:
      items - values to be set

    • setItems

      void setItems(List<DeliveryItem> items)

      Line Items or Custom Line Items delivered in this Parcel.

      Parameters:
      items - values to be set

    • of

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

    • of

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

    • copyDeep

      DeliveryParcel copyDeep()

    • deepCopy

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

    • builder

      static DeliveryParcelBuilder builder()
      builder factory method for DeliveryParcel
      Returns:
      builder

    • builder

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

    • withDeliveryParcel

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