What does it do?

With the GF eCommerce Fields plugin you can easily add eCommerce field types to your Gravity Forms. The new pricing fields include Discount, Tax, and Subtotal. This plugin also improves upon the functionality of Gravity Forms’ Coupons and Shipping fields.

GF eCommerce also adds support for special merge tags for including the subtotal, coupon and discount amounts in calculation-enabled fields along with a handy merge tag for displaying the order summary in your confirmations and notifications.

Features

Beautifully improved order summary.

—

Documentation

1. How do I enable this functionality?
2. Feature Details
   1. Fields
      1. Tax Field
      2. Subtotal Field
      3. Discount Field
      4. Coupon Field
      5. Shipping Field
   2. Merge Tags
      1. {subtotal}
      2. {coupons}
      3. {discounts}
      4. {order_summary}
3. Developer’s Notes
4. Hooks
5. Gravity Forms Hook Reference

How do I enable this functionality?

This document assumes you know how to create a form. For information on creating a form, visit Creating a form.

Fields described in this document can be found under “Pricing fields”. Pricing fields allow you to add fields to your form to calculate pricing for selling goods and services.

Feature Details

Fields

Tax Field

The Tax Field allows you to add a preconfigured tax to the form. End users can view the Field Label, the amount to be paid, and the Description.

The Tax Field supports percentage values only. You can apply the tax to all products, specific products or all products except one(s) selected. You can add multiple Tax Fields to the form.

Subtotal Field

The Subtotal Field is used to display the sum of the line item total prices in the form. As the user selects products and options, the subtotal automatically updates. End users can view the Field Label, the subtotal amount, and the Description.

Subtotal does not include tax and discounts. You can select if to calculate subtotal values for all listed products, specific products or to exclude the selected products. You can add multiple Subtotal Fields to the form.

Discount Field

The Discount Field allows you to add a preconfigured discount to the form. End users can view the Field Label, the amount to be discounted, and the Description.

The amount to be discounted can be a flat rate adjustment or a percentage of the price of the product. You can apply the discount to the form total, specific products or apply to all products except one(s) selected. You can add multiple Discount Fields to the form.

Coupon Field

Coupons are price reductions. The Coupon Field is available when you use the Gravity Forms Coupons Add-on. The Coupon Field displays the Field Label, the coupon code entry field and the Description on your form. The end user types in the code to the field and clicks the displayed “Apply” button to reveal the new total.

Coupons reduce the amount subject to the Tax. When GF eCommerce Fields is active, coupon automatically will not include shipping. Coupons will also not influence the value of Subtotal or Discount fields.

Shipping Field

The Shipping Field is a default Gravity Forms field allowing a shipping fee to be added to the form. GF eCommerce Fields alters the default functionality. End users can view the field label, the shipping fee to be paid, and the description.

The shipping value is not included in the subtotal, discounts or coupons. The shipping charge is always included in Tax fields and the form total.

Merge Tags

Gravity Forms uses merge tags to allow you to populate dynamic data in various contexts throughout the plugin. GF eCommerce Fields expands this functionality to provide the ‘{subtotal}’, ‘{coupons}’, and ‘{discounts}’ merge tags for use in calculation formulas and other places Gravity Forms merge tags are supported. GFEC also provides support for a ‘{order_summary}’ for displaying the order summary in notifications and confirmations.

Gravity Forms uses merge tags to allow you to populate submitted field values and other dynamic information in calculation of the field values, notification emails, post content templates, etc.

The following merge tags can be used in calculation of field values.

{subtotal}

The sum of all product prices. This merge tag can be used in calculation of Number and Product Fields in calculation formulas. The result of the formula is dynamically populated as the value for this field.

{coupons}

The sum of all coupon deductions. This merge tag can be used in calculation of Number and Product Fields in calculation formulas.

{discounts}

The sum of all discount and coupons deductions. This merge tag can be used in calculation of Number and Product Fields in calculation formulas.

{order_summary}

Order Summary is provided by Gravity Forms by default. Order Summary is automatically appended to any entry that has a Gravity Forms Pricing field. The GF eCommerce Fields plugin improves Order Summary to better support the new Pricing fields it provides.

The merge tag displays a preformatted HTML table containing order summary (the list of products, subtotal, discount, coupons, shipping, taxes and grand total). This merge tag can be used in areas such as notifications and confirmations to preview the order information.

Example output of the {order_summary} merge tag.

Developer’s Notes

GF eCommerce Fields makes some changes to how Gravity Forms processes pricing fields. If you are a developer, you will want to be aware of the following.

• Field types are processed in this order:
  Subtotal › Discounts › Coupons › Shipping › Taxes › Total
• Shipping is automatically excluded from Discounts and Coupons.
• Shipping is automatically included in Taxes and Total.
• Coupons are displayed in the totals section of the order summary, rather than the products list.

Hooks

• gpecf_apply_custom_order_summary
  
• gpecf_styles
  

Gravity Forms Hook Reference