Package com.commercetools.api.models.order

Class OrderFromCartDraftBuilder

java.lang.Object
com.commercetools.api.models.order.OrderFromCartDraftBuilder
All Implemented Interfaces:
Builder<OrderFromCartDraft>
public class OrderFromCartDraftBuilder extends Object implements Builder<OrderFromCartDraft>
OrderFromCartDraftBuilder
Example to create an instance using the builder pattern 

     OrderFromCartDraft orderFromCartDraft = OrderFromCartDraft.builder()
             .version(0.3)
             .build()

  • Constructor Details

    • OrderFromCartDraftBuilder

      public OrderFromCartDraftBuilder()

  • Method Details

    • id

      @Deprecated public OrderFromCartDraftBuilder id(@Nullable String id)
      Deprecated.

      id of the Cart used to create the Order.

      Parameters:
      id - value to be set
      Returns:
      Builder

    • cart

      public OrderFromCartDraftBuilder cart(Function<CartResourceIdentifierBuilder,CartResourceIdentifierBuilder> builder)

      ResourceIdentifier to the Cart from which the Order is created.

      This field is required, but is marked as optional for backwards compatibility reasons.

      Parameters:
      builder - function to build the cart value
      Returns:
      Builder

    • withCart

      public OrderFromCartDraftBuilder withCart(Function<CartResourceIdentifierBuilder,CartResourceIdentifier> builder)

      ResourceIdentifier to the Cart from which the Order is created.

      This field is required, but is marked as optional for backwards compatibility reasons.

      Parameters:
      builder - function to build the cart value
      Returns:
      Builder

    • cart

      public OrderFromCartDraftBuilder cart(@Nullable CartResourceIdentifier cart)

      ResourceIdentifier to the Cart from which the Order is created.

      This field is required, but is marked as optional for backwards compatibility reasons.

      Parameters:
      cart - value to be set
      Returns:
      Builder

    • version

      public OrderFromCartDraftBuilder version(Long version)

      version of the Cart from which the Order is created.

      Parameters:
      version - value to be set
      Returns:
      Builder

    • orderNumber

      public OrderFromCartDraftBuilder orderNumber(@Nullable String orderNumber)

      User-defined identifier for the Order that is unique across a Project. Once set, the value cannot be changed.

      Parameters:
      orderNumber - value to be set
      Returns:
      Builder

    • purchaseOrderNumber

      public OrderFromCartDraftBuilder purchaseOrderNumber(@Nullable String purchaseOrderNumber)

      User-defined identifier for a purchase order.

      It is typically set by the Buyer or Merchant to track the purchase order during the quote and order flow.

      If not provided, the purchaseOrderNumber from the referenced Cart is used.

      Parameters:
      purchaseOrderNumber - value to be set
      Returns:
      Builder

    • paymentState

      public OrderFromCartDraftBuilder paymentState(@Nullable PaymentState paymentState)

      Payment status for the Order.

      Parameters:
      paymentState - value to be set
      Returns:
      Builder

    • shipmentState

      public OrderFromCartDraftBuilder shipmentState(@Nullable ShipmentState shipmentState)

      Shipment status for the Order.

      Parameters:
      shipmentState - value to be set
      Returns:
      Builder

    • orderState

      public OrderFromCartDraftBuilder orderState(@Nullable OrderState orderState)

      Current status for the Order.

      Parameters:
      orderState - value to be set
      Returns:
      Builder

    • state

      public OrderFromCartDraftBuilder state(Function<StateResourceIdentifierBuilder,StateResourceIdentifierBuilder> builder)

      State for the Order in a custom workflow.

      Parameters:
      builder - function to build the state value
      Returns:
      Builder

    • withState

      public OrderFromCartDraftBuilder withState(Function<StateResourceIdentifierBuilder,StateResourceIdentifier> builder)

      State for the Order in a custom workflow.

      Parameters:
      builder - function to build the state value
      Returns:
      Builder

    • state

      public OrderFromCartDraftBuilder state(@Nullable StateResourceIdentifier state)

      State for the Order in a custom workflow.

      Parameters:
      state - value to be set
      Returns:
      Builder

    • custom

      public OrderFromCartDraftBuilder custom(Function<CustomFieldsDraftBuilder,CustomFieldsDraftBuilder> builder)

      Custom Fields for the Order. The Custom Fields' type must match the Custom Fields' type in the referenced Cart.

      • If empty, the Custom Fields on the referenced Cart are added to the Order automatically.
      • If specified, the Custom Fields are merged with the Custom Fields on the referenced Cart and added to the Order.
      Parameters:
      builder - function to build the custom value
      Returns:
      Builder

    • withCustom

      public OrderFromCartDraftBuilder withCustom(Function<CustomFieldsDraftBuilder,CustomFieldsDraft> builder)

      Custom Fields for the Order. The Custom Fields' type must match the Custom Fields' type in the referenced Cart.

      • If empty, the Custom Fields on the referenced Cart are added to the Order automatically.
      • If specified, the Custom Fields are merged with the Custom Fields on the referenced Cart and added to the Order.
      Parameters:
      builder - function to build the custom value
      Returns:
      Builder

    • custom

      public OrderFromCartDraftBuilder custom(@Nullable CustomFieldsDraft custom)

      Custom Fields for the Order. The Custom Fields' type must match the Custom Fields' type in the referenced Cart.

      • If empty, the Custom Fields on the referenced Cart are added to the Order automatically.
      • If specified, the Custom Fields are merged with the Custom Fields on the referenced Cart and added to the Order.
      Parameters:
      custom - value to be set
      Returns:
      Builder

    • getId

      @Deprecated @Nullable public String getId()
      Deprecated.

      id of the Cart used to create the Order.

      Returns:
      id

    • getCart

      @Nullable public CartResourceIdentifier getCart()

      ResourceIdentifier to the Cart from which the Order is created.

      This field is required, but is marked as optional for backwards compatibility reasons.

      Returns:
      cart

    • getVersion

      public Long getVersion()

      version of the Cart from which the Order is created.

      Returns:
      version

    • getOrderNumber

      @Nullable public String getOrderNumber()

      User-defined identifier for the Order that is unique across a Project. Once set, the value cannot be changed.

      Returns:
      orderNumber

    • getPurchaseOrderNumber

      @Nullable public String getPurchaseOrderNumber()

      User-defined identifier for a purchase order.

      It is typically set by the Buyer or Merchant to track the purchase order during the quote and order flow.

      If not provided, the purchaseOrderNumber from the referenced Cart is used.

      Returns:
      purchaseOrderNumber

    • getPaymentState

      @Nullable public PaymentState getPaymentState()

      Payment status for the Order.

      Returns:
      paymentState

    • getShipmentState

      @Nullable public ShipmentState getShipmentState()

      Shipment status for the Order.

      Returns:
      shipmentState

    • getOrderState

      @Nullable public OrderState getOrderState()

      Current status for the Order.

      Returns:
      orderState

    • getState

      @Nullable public StateResourceIdentifier getState()

      State for the Order in a custom workflow.

      Returns:
      state

    • getCustom

      @Nullable public CustomFieldsDraft getCustom()

      Custom Fields for the Order. The Custom Fields' type must match the Custom Fields' type in the referenced Cart.

      • If empty, the Custom Fields on the referenced Cart are added to the Order automatically.
      • If specified, the Custom Fields are merged with the Custom Fields on the referenced Cart and added to the Order.
      Returns:
      custom

    • build

      public OrderFromCartDraft build()
      builds OrderFromCartDraft with checking for non-null required values
      Specified by:
      build in interface Builder<OrderFromCartDraft>
      Returns:
      OrderFromCartDraft

    • buildUnchecked

      public OrderFromCartDraft buildUnchecked()
      builds OrderFromCartDraft without checking for non-null required values
      Returns:
      OrderFromCartDraft

    • of

      public static OrderFromCartDraftBuilder of()
      factory method for an instance of OrderFromCartDraftBuilder
      Returns:
      builder

    • of

      public static OrderFromCartDraftBuilder of(OrderFromCartDraft template)
      create builder for OrderFromCartDraft instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder