Better Inventory with Gravity Forms

• November 11, 2012: Fixed issue where database prefix was not applied via $wpdb->prefix.

Overview

Gravity Forms does not support the concept of inventory out of the box. This snippet provides an easy method for setting up simple, one-off inventory limits on a per field basis.

1. Overview
2. Using the Snippet
   1. Prerequisites
   2. Add a Product Field
   3. Update Snippet with Parameters
      1. Custom Stock Level Messages
         1. Out of Stock
         2. Not Enough Stock
3. Parameters
4. Shortcodes
5. Taking It Further
   1. Approved Payments

Using the Snippet

Prerequisites

Confirm that you have Gravity Forms installed and activated and that you’ve installed the snippet.

Add a Product Field

With the snippet installed, add a Product field to your form. Note the Product field’s ID.

Update Snippet with Parameters

Update the form_id and field_id in the snippet to match your Form ID and Field ID. Depending on the way your form is set up, you’ll need to format the Field IDs differently:

• If your form uses a separate Quantity field for the Product’s quantity, set the field_id to the Quantity field’s ID.
• If your Product uses the built-in quantity sub-field, set the field ID to your Product ID and add .3 to the end.

new GW_Inventory( array(
    'form_id'                  => 123,
    'field_id'                 => 4.3,
    'stock_qty'                => 20,
) );

Custom Stock Level Messages

Better Inventory includes default “out of stock” and “not enough stock” messages. These messages can be customized using the out_of_stock_message and not_enough_stock_message parameters.

new GW_Inventory( array(
    'form_id'                  => 123,
    'field_id'                 => 4.3,
    'stock_qty'                => 20,
    'out_of_stock_message'     => 'Sorry, there are no more tickets!',
    'not_enough_stock_message' => 'You ordered %1$s tickets. There are only %2$s tickets left.',
) );

Out of Stock

The out_of_stock_message is displayed when the product limit has been reached. You can get fancy with this and add HTML. Be sure to escape any double quotes with a backslash. Here’s an advanced example:

'out_of_stock_message' = '<div style="border: 1px solid #e6db55; background-color: #FFFFE0; padding: 10px;">Sorry, this show is sold out.</div>'

Not Enough Stock

The not_enough_stock_message is displayed on the field if the limit has not been reached, but the user’s requested quantity would exceed the product limit.

Parameters

• form_id (integer) (required)

  The ID of the form you are working with.

• field_id (integer|float) (required)

  The ID of your product or quantity field. If using a Single Product field, specify the quantity input ID, which will always be {field ID}.3. If using a separate Quantity field, simply specify the field ID.

• stock_qty (integer) (required)

  The number of this item you have available.

• out_of_stock_message (string) (optional)

  The message which should be displayed to users when the product limit has been reached.

• not_enough_stock_message (string) (optional)

  The message which should be displayed on the field if the limit has not been reached, but the user’s requested quantity would exceed the product limit.

• approved_payments_only (boolean) (optional)

  Indicate whether all submissions for this field should be counted against the limit or only submissions with an approved payment.

• hide_form (boolean) (optional)

  By default this snippet will only hide the field when the limit has been reached. If you would rather hide the entire form, set this to true.

• enable_notifications (boolean) (optional)

  Enable the ability to create notifications that are sent when the stock of a product (or any configured field) has been exhausted

Shortcodes

• Remaining
  Show the quantity remaining for the specified input and limit. [gravityforms action="remaining" id="1" input_id="2.3" limit="50"]

• Sum
  Show the current sum of quantities ordered for this field across all entries. [gravityforms action="sum" id="1" input_id="2.3"]

Taking It Further

Approved Payments

By default, all submissions are counted against the stock quantity. Use the approved_payments_only parameter to indicate that only submissions with an approved payment should be counted. You’ll want to be careful here when using PayPal Standard due to the delay between the form submission and the payment being approved. It could lead to users exceeding the limit.

new GW_Inventory( array(
    'form_id'                  => 123,
    'field_id'                 => 4.3,
    'stock_qty'                => 20,
    'approved_payments_only'   => true,
) );