Gravity Forms eCommerce Fields

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

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. Translations
4. Developer’s Notes
5. Known Limitations
6. FAQs
   1. How can I programmatically set the discount amount?
   2. Can I deduct a deposit from the Order Summary?
   3. How do I pass Stripe fees on to customers?
7. Hooks
8. Related Resources

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}

Gravity Forms provides an order summary that is automatically appended to any entry that has a Gravity Forms Pricing field. It can be inserted into confirmations and notifications using {pricing_fields} merge tag.

GF eCommerce Fields improves on this summary to better support the new Pricing fields it provides. It also adds the improved {order_summary} merge tag as a replacement for {pricing_fields}.

The {order_summary} merge tag displays a preformatted HTML table containing the 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.

Translations

You can use the free Loco Translate plugin to create translations for any of our Perks. If you’ve never used Loco translate before, here’s a tutorial written for beginners.

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.

Known Limitations

• Excluding products from a Subtotal field does not exclude them from the order’s subtotal. These are separate entities. With that said, if no products are filtered out of a Subtotal field, it will match the order subtotal.

  • So what is the point of filtering which product fields are included in a Subtotal field? These customized subtotals can provide useful feedback to customers on their order by adding multiple subtotals for different groups of products or be used in calculations to simplify formulas. In the future, we plan to make it possible to use a Subtotal field as the amount captured via a payment gateway.

• The {subtotal} merge tag cannot be included in multiple calculated Product fields. This creates a loop where each Product will increase the subtotal, and the Product fields will be recalculated. You can work around this issue by following these steps:

  1. Create a new Subtotal field on your form and exclude the calculated Product fields. Take note of the field ID.
  2. Insert that specific subtotal merge tag into your form. If the field ID is 9, the format would be: {subtotal:9}.

FAQs

How can I programmatically set the discount amount?

If you’d like to set the discount for a field programmatically, use this snippet as a blueprint. Follow these steps to use the snippet:

1. Paste everything below the opening <?php line to your theme’s functions.php file.
2. Update 123 to your Form ID.
3. Update 2 to your Discount field ID and set the discount amount.

Can I deduct a deposit from the Order Summary?

We have a snippet that enables deposit deductions. To use it, first download the snippet and add it to your theme’s functions.php file.

Once installed, update the form_id parameter to your form’s ID and the deposit_field_id parameter to the Product field that functions as your deposit.

new GW_Deduct_Deposit( array(
	'form_id'          => 123, // Update "123" to the ID of your form.
	'deposit_field_id' => 4,   // Update the "4" to your deposit field ID.
) );

The deposit will be deducted from the total anywhere the Order Summary is displayed.

How do I pass Stripe fees on to customers?

Stripe fees are calculated using this formula.

To include Stripe fees in your form, follow these steps:

1. Open your form and add a new Product field under the Pricing Fields header.
2. Under the General field settings, Set the Field Type to Calculation.
3. In the Formula box, insert this calculation code:

( ( {subtotal} + 0.30 ) / ( 1 - 0.029 ) - {subtotal} )

Hooks

• gpecf_apply_custom_order_summary
  
• gpecf_discount_total (JS)
  
• gpecf_discount_total (PHP)
  
• gpecf_field_total (JS)
  
• gpecf_field_total (PHP)
  
• gpecf_order_labels
  
• gpecf_order_sumary_markup
  
• gpecf_order_summary
  
• gpecf_styles
  

Related Resources

• 6 Examples of the Best Gravity Forms Add-Ons and Extensions
  Use Gravity Perks to create all sorts of neat Gravity Forms examples on your WordPress website in just a few simple steps.
• Gravity Forms eCommerce Tutorial | The Comprehensive Guide
  A comprehensive guide to Gravity Forms eCommerce and the addons, snippets and tutorials you need to amplify your eCommerce store using Gravity Forms.
• How to Apply Discounts with Gravity Forms
  Flexible, conditional, and easy discounts for Gravity Forms.
• How to Calculate Tax or VAT with Gravity Forms
  Add tax to your Gravity Forms' submissions in 5 minutes or less.
• How to Do Calculations with Gravity Forms
  If you’re using Gravity Forms on your WordPress website, you might need an easy way to do Gravity Forms calculations on form fields and user submissions.
• How to Properly Connect PayPal to Gravity Forms for Payment Forms
  Learn how to use Gravity Forms to accept PayPal payments on your site with this step by step guide.
• How to Setup Gravity Forms to Accept Stripe Payments
  Today's tutorial covers everything you need to know about accepting Stripe payments on your Gravity Forms via the official Gravity Forms Stripe add-on and the GP eCommerce Fields Add-on.