Package com.commercetools.api.models.order

Interface OrderFromCartDraft

All Superinterfaces:
Draft<OrderFromCartDraft>
public interface OrderFromCartDraft extends Draft<OrderFromCartDraft>
OrderFromCartDraft
Example to create an instance using the builder pattern 

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

  • Method Details

    • getId

      @Deprecated String getId()
      Deprecated.

      id of the Cart used to create the Order.

      Returns:
      id

    • getCart

      @Valid @Valid 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

      @NotNull @NotNull Long getVersion()

      version of the Cart from which the Order is created.

      Returns:
      version

    • getOrderNumber

      String getOrderNumber()

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

      Returns:
      orderNumber

    • getPurchaseOrderNumber

      String getPurchaseOrderNumber()

      User-defined identifier for a purchase Order.

      It is typically set by the Buyer and can be used with Quotes to track the purchase Order during the quote and order flow.

      Returns:
      purchaseOrderNumber

    • getPaymentState

      PaymentState getPaymentState()

      Payment status for the Order.

      Returns:
      paymentState

    • getShipmentState

      ShipmentState getShipmentState()

      Shipment status for the Order.

      Returns:
      shipmentState

    • getOrderState

      OrderState getOrderState()

      Current status for the Order.

      Returns:
      orderState

    • getState

      @Valid @Valid StateResourceIdentifier getState()

      State for the Order in a custom workflow.

      Returns:
      state

    • getCustom

      @Valid @Valid 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

    • setId

      @Deprecated void setId(String id)
      Deprecated.

      id of the Cart used to create the Order.

      Parameters:
      id - value to be set

    • setCart

      void setCart(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

    • setVersion

      void setVersion(Long version)

      version of the Cart from which the Order is created.

      Parameters:
      version - value to be set

    • setOrderNumber

      void setOrderNumber(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

    • setPurchaseOrderNumber

      void setPurchaseOrderNumber(String purchaseOrderNumber)

      User-defined identifier for a purchase Order.

      It is typically set by the Buyer and can be used with Quotes to track the purchase Order during the quote and order flow.

      Parameters:
      purchaseOrderNumber - value to be set

    • setPaymentState

      void setPaymentState(PaymentState paymentState)

      Payment status for the Order.

      Parameters:
      paymentState - value to be set

    • setShipmentState

      void setShipmentState(ShipmentState shipmentState)

      Shipment status for the Order.

      Parameters:
      shipmentState - value to be set

    • setOrderState

      void setOrderState(OrderState orderState)

      Current status for the Order.

      Parameters:
      orderState - value to be set

    • setState

      void setState(StateResourceIdentifier state)

      State for the Order in a custom workflow.

      Parameters:
      state - value to be set

    • setCustom

      void setCustom(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

    • of

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

    • of

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

    • copyDeep

      OrderFromCartDraft copyDeep()

    • deepCopy

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

    • builder

      static OrderFromCartDraftBuilder builder()
      builder factory method for OrderFromCartDraft
      Returns:
      builder

    • builder

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

    • withOrderFromCartDraft

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