# Getting Started

Here are some steps we highly recommend to get your store up and running.

### [**Add a Product to Your Store**](/admin/catalog/products/add-new-product)

To add a product:

1. Go to [Catalog](/admin/catalog).
2. Select [Products](/admin/catalog/products).
3. Select the [Add Product](/admin/catalog/products/add-new-product) tab.&#x20;
4. Fill out the *Product Name* and *SKU* fields.

You can add add and remove products by heading over to the Products section of the plugin. Make sure you go through each of the steps for adding a product as they are all required in order for your product to available for purchase in your catalog!

### **Add a Payment Processor**

**To accept credit card payments, you will need to add a payment processor for your store transactions.**

Adding a payment processor is easy! You can add your payment processor by heading over to the Payments section of the plugin.

* [PayFabric](https://www.payfabric.com/)

### **Setup Your Store's Shipping Method(s)**

**Add shipping rates or connect to Shippo for Live Rates.**

If you don't add a shipping method, your store will default shipping to free. You can change this via the Shipping section of the plugin. If you would like to sign up with Shippo for live rates, use the link below.

* [Shippo](https://goshippo.com/)

### **Setup Store Emails**

**Setup SMTP for your store emails.**

**Customize Your Store's Communication Emails.**

SMTP is not required for your store however your emails will be sent by the store administrator's email (the email that was used for the store sign up) by default. You can customize emails sent by your store such as the checkout email, registration email and more by heading over to the Emails section of the plugin. You do not need to customize these emails but until you do they will be branded with VendorFuel logos and information.

### **Set State Tax Rates**

You can select the states that you will be collecting taxes in via the Taxes section of the plugin. We recommend using Avalara to make generating taxes easier.

* [Avalara](https://www.avalara.com/)


# Sign in to VendorFuel

How to sign in to VendorFuel.

After installing and activating the VendorFuel plugin on your WordPress site, you should see VendorFuel in the WordPress dashboard menu:

![](/files/UesN4nmVMXNiY9glQ2QA)&#x20;

To sign in to VendorFuel from the WordPress dashboard, select **VendorFuel** > **Sign in**. You should then see a form to enter your email address and password:

<figure><img src="/files/tbBIXOuQeEeFvasArRYO" alt=""><figcaption><p>Sign in page.</p></figcaption></figure>

After signing in, you will be redirected to the VendorFuel dashboard, where you'll see the sales trends for the last 60 days and the most recent orders.

### Resetting password

If you forget your password or need to reset it,

1. Select the **Forgot Password** link when you sign in. You will then be redirected to another page to enter your email address.
2. Enter the email address associated with your VendorFuel account, then select the **Submit** button. VendorFuel will then email you a link to reset your password.
3. Once you get the password reset email from VendorFuel, click the link inside to set a new password. Passwords must have at least 8 characters with at least one capital letter, at least one lower case letter, and at least one number as well as a special character.
4. After you submit your new password, you should be logged in and redirected to the VendorFuel homepage.


# Support & Contact

### Contact **VendorFuel**

**Give us a call at:** [1-(855)-998-3835](tel:185599838350)\
**(Mon-Fri 9am-5pm PDT)**

*-or-*&#x20;

<support@vendorfuel.com>


# Catalog

From the Catalog page, you can manage:

* [Products](/admin/catalog/products)
* Categories
* Collections
* Manufacturers
* Price Sheets
* Promo Codes
* Banners


# Products

Manage store products.


# Add New Product

How to add a product.

To add a new product from the Catalog page,

1. Select **Add New Product**.
2. Enter the **Name**.
3. Enter the **SKU**.
4. Select the **Save Changes** button to save the product.

{% hint style="info" %}
A new product must be saved prior to adding a price.
{% endhint %}

### Adding prices to products

To add a price to a product from the Products list page,

1. Select the product to edit it.
2. In the *Prices* tab, select the button **Add Price**. A dialog will appear displaying the available price sheets.
3. Select the pricesheet you want to add a price for. Selecting a pricesheet should close the dialog.
4. Enter a price for the pricesheet.
5. Select the **Save Changes** button.


# Categories

Manage product categories.


# Add New Category

How to add a new product category.

To add a new product category from the Catalog page

1. Select Categories > **Add New Category**.
2. On the Add New Category page, add the following fields:
   1. **Name**
   2. **Description**: This will appear under the category name on public catalog pages.
   3. Avatax Code
   4. UNSPSC
3. You can also select an image or enter a thumbnail URL.
4. Select the **Save** button.


# Collections

Manage collections of products and categories.


# Price sheets

Manage catalog product price sheets.


# Manufacturers

Manage product manufacturers.


# Merge Manufacturers

How to merge duplicate manufacturers.

To merge duplicate manufacturers,

1. Go to Catalog > Manufacturers.
2. Select **Merge Duplicate Manufacturers**. This will merge any duplicate manufacturers.


# Promo Codes

Manage promo codes, which function like coupon codes.


# Banners

Manage banners and banner areas.


# Customers

Manage customer accounts, groups and roles.


# Groups

Manage customer groups in VendorFuel.


# Add group

How to add a customer group in VendorFuel.

To add a group to VendorFuel,

1. Select **Customers** in the top navigation menu.
2. Select **Add New Group**.
3. Add the following required fields:
   1. Name
4. Select the **Save** button.

After saving the group, you will be able to add customers, view child groups, edit shipping rates, edit punchout settings and add notes.


# Accounts

Manage customer accounts.


# Add New Account

How to add a new customer account.

To add a new customer account from the WordPress dashboard,

1. Select **VendorFuel** > **Customers** in the left navigation menu to navigate to the *Customers* page.
2. Then select **Add New Customer**.
3. &#x20;On the **Add Account** page, enter the following:
   1. **Name**: usually first and last name of the customer.
   2. **Email**
   3. **Price Sheet**: Select a price sheet that will be assigned to this customer.
4. Select the **Save** button.


# Dashboard

The Dashboard shows your store's order summary, growth and links to other sections.

![The Dashboard shows gross revenue based on sales.](/files/5ibwS2ByyAy1h916zFKD)


# Orders

Manage Orders and Order Tracking.


# Order tracking logs

Upload order tracking logs.


# Exceptions & Failures

How to monitor and resolve order exceptions and failures.


# Purchasing

Manage Vendors, Cost Sheets and Document Profiles.


# Punchout

Manage Punchout Suppliers.


# Add Punchout Supplier

How to add a punchout supplier.

To add a punchout supplier from the VendorFuel Dashboard,

1. Select **Punchout** in the top navigation menu. This will take you to the *Punchout Suppliers* list.
2. Select the **Add New Supplier** button. You should then see a form to enter your punchout supplier information in the following fields:
   * *Name*
   * *Domain type***:** either **DUNS** or **Network ID**
   * *Inventory identity:* This credential is used for price availability checks.
   * *Domain identity*
   * *Domain shared secret*
   * *Punchout identity*
   * *Punchout shared secret*
   * Endpoint related fields:
     * *Update endpoints daily*
     * *Endpoint Base URL*
   * Order Request related fields
     * *Order Request Customer ID*
     * *Order Request Billing ID*
     * *Order Request Role ID*
   * SKU related fields
     * *SKU prefix*
     * *SKU priority*
   * *Logo:* The URL of a logo of the supplier that will appear in the frontend to customers.


# Adding an ODP punchout supplier

How to add an ODB Business Solutions punchout supplier.

In most cases, ODP will provide you with punchout credentials. Below is where you want to use the provided values in VendorFuel.

&#x20;

| Provided by ODP                                             | Where to use in VendorFuel                                  | Instructions                                                                                                                                                                                                                   |
| ----------------------------------------------------------- | ----------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Any "Test" value                                            |                                                             | Test URLs, identities, or shared secrets can be ignored.                                                                                                                                                                       |
| <p>View Account: <br>Prod cXML PunchOutSetupRequest URL</p> | Punchout Suppler                                            | Enter the URL in the Endpoints section, using `PunchoutSetupRequest` as the *Transaction* value.                                                                                                                               |
| <p>View Account:<br>Prod From Identity</p>                  | Punchout Supplier                                           | Enter this value in the *Punchout identity* field.                                                                                                                                                                             |
| <p>View Account:<br>Prod Sender SharedSecret</p>            | Punchout Supplier                                           | Enter this value in the *Punchout shared secret* field.                                                                                                                                                                        |
| <p>Ordering Account:<br>Prod cXML OrderRequest URL</p>      | <p>Punchout Supplier and<br>Purchasing Document Profile</p> | <p>For Punchout Supplier, enter the URL in the Endpoints section, using <code>OrderRequest</code> as the <em>Transaction</em> value.<br><br>For Purchasing Document Profile, enter the URL in the <em>Endpoint</em> field.</p> |
| <p>Ordering Account:<br>Prod From Identity</p>              | Purchasing Document Profile                                 | Enter this value in the *Account User* field.                                                                                                                                                                                  |
| <p>Ordering Account:<br>Prod Sender SharedSecret</p>        | Purchasing Document Profile                                 | Enter this value in the *Account Password* field.                                                                                                                                                                              |


# Punchout configuration checklist

How to go from a new store to punchout-ready store.

Setting up punchout requires a number of steps to go from a new store to accepting punchout orders:

1. First, request punchout credentials from your supplier. This info should include URLs, identity names and shared secret codes for both a "View" and "Ordering" account.
2. After receiving credentials, you will want to create the following in VendorFuel:
   1. **Punchout Supplier**, using the provided "View" account credentials.
   2. **Purchasing Documents Profile**, using the provided "Ordering" account credentials.
   3. **Vendor**, usually using the supplier's name.
   4. **Cost sheet**, using the previously created Supplier, Document Profile and Vendor.
3. Once the punchout configuration is finished, you can create Customers or Customer Groups that are attached to the Punchout Supplier. This will allow any customer to punchout to that supplier, add items to their cart, and then return with those added items.
4. Next, you may want to configure a Payment gateway to accept credit cards. VendorFuel integrates with PayFabric for credit card transactions.&#x20;
5. After this, you should test the configuration by signing in as a punchout customer, punch out to the supplier catalog, add items to your cart, and then proceed to the checkout process.


# Reports

Manage, download and schedule Reports.


# Users

Search and add VendorFuel admin accounts.

The Users shows all of the VendorFuel admin users. You can use the Search bar to search for an Admin Account to edit it.&#x20;

## Add Admin Account

<table><thead><tr><th>Field</th><th>Description</th><th data-type="checkbox">Required</th></tr></thead><tbody><tr><td>Name</td><td>Name of admin user.</td><td>true</td></tr><tr><td>Email</td><td>Email address of admin user.</td><td>true</td></tr><tr><td>Password</td><td></td><td>true</td></tr><tr><td>Active</td><td>Must be checked in order for Admin Account to login.</td><td>false</td></tr></tbody></table>

### Roles

Each role grants certain permissions to sections within VendorFuel.

| Field            | Has Access To                                                                   |
| ---------------- | ------------------------------------------------------------------------------- |
| Manager          | Everything.                                                                     |
| Billing          | [Accounting ](/settings/settings/accounting)and Subscription.                   |
| Catalog          | All [Catalog](/admin/catalog)-related.                                          |
| Web Developer    | All [Customer](/admin/customers)-related and [Email](/settings/settings/email). |
| Customer Service | All [Customer](/admin/customers)-related and [Orders](/admin/orders).           |

### REST API

Clicking the REST API button will generate a REST API token that other APIs can use to authenticate with VendorFuel without requiring the Account Admin's username or password.&#x20;

### Options

| Field                | Description                                                                    |
| -------------------- | ------------------------------------------------------------------------------ |
| Receive Quotes       | Enables Admin Account to receive any quote requests from customers' carts.     |
| Send New Admin Email | If checked, an email notification will be sent to the new Admin Account email. |

## Edit Admin Account

Once you've added an Admin Account, you can edit it by viewing the Admin Accounts and clicking on it.

{% hint style="info" %}
The Password and Confirm Password fields will not show the Admin Account's password, but you can use these fields to update the password.
{% endhint %}


# Template shortcodes

Front end template shortcodes

The VendorFuel plugin uses the following shortcode:

```
[vf-template name="shortcode-name"]
```

Each of the following template shortcode names correspond to a WordPress page.

| Title           | Shortcode name  | Parameters                                                                                                                      |
| --------------- | --------------- | ------------------------------------------------------------------------------------------------------------------------------- |
| Account         | account         |                                                                                                                                 |
| Addresses       | addresses       |                                                                                                                                 |
| Cart            | cart            |                                                                                                                                 |
| Catalog         | catalog         | <p><strong>cat\_id</strong> <em>(number) (Optional)</em><br>Using a cat\_id will return only products within that category.</p> |
| Checkout        | checkout        | <p><strong>po\_prefix</strong> <em>(string) (Optional)</em><br>Prefixes the purchase order.</p>                                 |
| Favorites       | favorites       |                                                                                                                                 |
| Forgot Password | forgot-password |                                                                                                                                 |
| Group Account   | group-account   |                                                                                                                                 |
| Group Orders    | group-orders    |                                                                                                                                 |
| Login           | login           |                                                                                                                                 |
| Order by SKU    | order-by-sku    |                                                                                                                                 |
| Orders          | orders          |                                                                                                                                 |
| Product Detail  | product-detail  | **product\_id** *(number) (Required)*                                                                                           |
| Punchout Return | punchout-return |                                                                                                                                 |
| Register        | register        | **customer\_role** *(number) (Optional)*                                                                                        |
| Reset Password  | reset-password  |                                                                                                                                 |
| Saved Cart      | saved-cart      |                                                                                                                                 |
| Saved Carts     | saved-carts     |                                                                                                                                 |
| View Order      | view-order      |                                                                                                                                 |

{% hint style="info" %}
Wherever a shortcode name is used (usually on the corresponding WordPress page), the matching template content is imported from `includes/templates`. For example, using `[vf-template name="login"]`will result in the content from `includes/templates/login.html` to be imported.
{% endhint %}


# Account Menu block

Block for displaying the Account Menu.


# Cart Menu block

Block for displaying the Cart Menu.


# Catalog Search block

Block for displaying a public catalog search.


# Register block

This block allows users to register a new VendorFuel account.

## Adding a Register block to a page

To add the Register block to a page using the WordPress block editor,

1. Select the blue plus button to toggle the block inserter.
2. Scroll down to the blocks in the VendorFuel category, or enter "register" in the search bar. If you start to search for "register" you should see a Register block and a Registration Page pattern.
3. Select the Register block to insert it.
4. Select the Save button to update the page.

### Setting a customer role for the Register block

If you wish users who use this registration page to automatically be assigned a role, and thus a customer group, pricesheet, punchout supplier, etc., you can specify a role for this block.

Previously, to set a customer role, you had to add the role ID to a WordPress shortcode. This is now controlled using the WordPress block editor.

To select a customer role for the Register block,

1. Select the Register block in the WordPress block editor.
2. Toggle the block setting so they are visible (usually visible by default).
3. Under the Block > Settings panel, select a Customer Role.
4. After selecting a role, select the Save button to update the page.&#x20;


# Shopping Lists block

Displays a list of the user's saved shopping lists, where the user can add items to cart, edit quantities, and remove items.

{% hint style="info" %}
Shopping Lists were previously called Saved Carts. See below for how to update the name of your page.
{% endhint %}

## Adding a Shopping Lists block to a page

To add the Shopping Lists block to a page using the WordPress block editor,

1. Select the blue plus button to toggle the block inserter.
2. Scroll down to the blocks in the VendorFuel category or enter "shopping" in the search bar. If you start to search for "shopping" you should see a Shopping Lists block and a Shopping Lists Page pattern.
3. Select the **Shopping Lists** block to insert it.
4. Select the **Save** button to update the page.

## Renaming Saved Carts to Shopping Lists

Previous versions of VendorFuel called Shopping Lists "Saved Carts". This was renamed as some actions such as "Add to Cart" could confuse the user. However, your site might still say "Saved Carts" for the page name and use "saved-carts" as a slug.

To update your Saved Carts page name and slug,

1. Edit the Saved Carts page in the WordPress block editor.
2. Select the "Saved Carts" title and change to "Shopping Lists".
3. Under the Page Settings on the right side of the editor, change the **Link** from "/saved-carts" to "/shopping-lists".
4. After updating the page, go to the WordPress dashboard and select Settings > **VendorFuel**.
5. Scroll down to Permalinks and change the end of the **Shopping Lists** permalink from "/saved-carts" to "/shopping-lists", and then select the **Save Changes** button.
6. To confirm the change has been made, sign in to your store's frontend using the Account Menu. Then select **Shopping Lists** in the Account Menu, which should take you to the updated Shopping Lists page. If instead you see a 404 error or something unexpected, verify that you changed the page's link and the settings permalink to end in "/shopping-lists".

## Deleting Saved Cart page

If you have updated your Saved Carts/Shopping Lists page to use the Shopping Lists block, you can safely delete your "Saved Cart" page as it is no longer necessary.&#x20;


# Welcome Page block

Block for displaying content to punchout users after they sign in.


# Settings

Manage VendorFuel plugin settings.

Settings for VendorFuel are stored in two locations:

* Newer settings that require no interaction with the API are under[ WordPress Dashboard > Settings > VendorFuel](/settings/wordpress-vendorfuel-settings).
* Older settings that mostly interact with the API are under WordPress Dashboard > VendorFuel > Settings.

### WordPress Settings

See [WordPress VendorFuel Settings](/settings/wordpress-vendorfuel-settings) for details.

### Settings page

The Settings page is arranged into five sections:

* [General](/settings/settings/general)
* [Store](/settings/settings/store)
* [Email](/settings/settings/email)
* [Payments](/settings/settings/payments)
* [ClearSale](/settings/settings/clearsale)


# General

### Catalog settings

#### Enabled filters

| Field                             | Description                                                                                                                                                                               |
| --------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Enable recyclable options         | Adds a 'Only recycled' filter on the catalog page, which allows users to filter only items with Post Consumer Recycled Content.                                                           |
| Enable AbilityOne                 | Enables the AbilityOne filter on the catalog pages.                                                                                                                                       |
| Enable Core List                  | Enables the Core List filter on the catalog pages.                                                                                                                                        |
| Enable GSA                        | Enables the GSA filter on the catalog pages.                                                                                                                                              |
| Disable facet filters             | Check this to disable facets such as brands, manufacturers and attributes from appearing as filters on the catalog.                                                                       |
| Exclude sold out items by default | Enable this to exclude sold-out items by default on inventory controlled catalogs. If unchecked, users can still exclude sold-out items from the catalog if inventory control is enabled. |

#### Subcategories

| Label                                   | Description                                                   |
| --------------------------------------- | ------------------------------------------------------------- |
| Show subcategory cards on catalog pages |                                                               |
| Limit of subcategory cards to show      | If empty or set to 0, all of the subcategories will be shown. |

### Product detail options

| Label                                      | Description                                                                                                                                                                                           |
| ------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Related products title                     | The title for the related products on the product detail page. Defaults to 'Related products'.                                                                                                        |
| Show related products above specifications | Enabling this will display any related products above the products specifications on the product detail page. Leave this unchecked if you want to display related products underneath specifications. |

### Cart options

| Label                            | Description                                                                                                                                                                                  |
| -------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Show free shipping minimum spend | Enable to show the free shipping minimum spend requirement in the cart menu and cart page. This can be used to encourage customers to spend more to qualify for free shipping, if available. |

### Checkout options

#### Additional checkout fields

The following fields can be enabled to be shown on the checkout page, along with being required:

* Company/Organization
* Purchase order number
* Issuing office
* Cost center code
* Attention
* Notes

{% hint style="warning" %}
**QuickBooks users:** *Purchase Order Number* will not appear on QuickBooks bills or invoices unless defined as custom fields in QuickBooks and applied to all QuickBooks documents in the QuickBooks admin dashboard.
{% endhint %}

### Registration options

| Label           | Description                                       |
| --------------- | ------------------------------------------------- |
| Require address | Require address during registration of new users. |


# Store

Store settings for the VendorFuel plugin.

| Setting                         | Description                                                                                                                        |
| ------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| Store Name                      | Your store name.                                                                                                                   |
| Store URL                       | Your URL.                                                                                                                          |
| Inventory System                | <p>Enables inventory system.</p><p><em>Default value: off</em></p>                                                                 |
| Admin Two Factor Authentication | <p>Enables two-factor authentication for VendorFuel admins.</p><p><em>Default value: off</em></p>                                  |
| Verify Users                    | <p>Requires a VendorFuel admin to verify registered users before they can do anything.</p><p><em>Default value: off</em></p>       |
| Disable Guests                  | <p>Prevents guests from proceeding through checkout. Requires that they register an account.</p><p><em>Default value: off</em></p> |
| Disable RMA                     | <p>Disables Return Merchandise Authorization process.</p><p><em>Default value: off</em></p>                                        |
| Disable Billing Address         | <p>Prevents users from setting up a separate billing address during checkout.</p><p><em>Default value: off</em></p>                |
| Force Role                      | <p>Feature for medical dispensaries.</p><p><em>Default value: off</em></p>                                                         |
| Credit Line Default On          | <p>Enables a line of credit for customers during registration.</p><p><em>Default value: off</em></p>                               |


# Email

Manage email templates and SMTP settings.


# Payments

Manage payments via PayFabric.

### PayFabric

| Field                 | Description                                                                                                   |
| --------------------- | ------------------------------------------------------------------------------------------------------------- |
| Payment Processor     | Enable PayFabric as primary payment card processor.                                                           |
| Device ID             | A unique & secure identifier to identify different applications under a single PayFabric merchant account.    |
| Password              | Assigned to a single device. Both device Id and device password are required when integrating with PayFabric. |
| Setup ID              |                                                                                                               |
| Transaction Type      | Either **Book** or **Sale**.                                                                                  |
| Ship From 5-Digit Zip | Ship from Zip details for a transaction, typically required as Level 2 data qualification.                    |


# ClearSale

| Field                                            | Description |
| ------------------------------------------------ | ----------- |
| Export order to ClearSale for credit card orders |             |
| Use Sandbox URL for ClearSale exports API key    |             |
| API Key                                          |             |
| Client ID                                        |             |
| Client secret                                    |             |


# Taxes

Manage state taxes and connect with Avalara account.


# Accounting

Link store data to QuickBooks.


# Setting up QuickBooks to connect with VendorFuel

How to set up QuickBooks to connect with VendorFuel.

{% hint style="info" %}
"Purchase Order" and "VendorFuel Order" will not appear on your QuickBooks bills or invoices unless defined as custom fields and applied to all documents in the QuickBooks admin dashboard.
{% endhint %}

1. Sign in to the QuickBooks Online Advanced dashboard.
2. Select the gear icon in the top right of the screen, then select **Account and Settings**.
3. Navigate to the **Sales** tab, then go to the **Sales Form Content** section.
4. Enable **Shipping** and then select the **Save** button.
5. Select the **Custom Fields** link.
6. Select **Add Field** to add a new custom field exactly as follows:
   1. *Name*: Purchase Order
   2. *Data Type*: Text and number
   3. *Category*: Transaction
   4. *Select Forms*: Select ALL forms and all print on form options.
7. Add another new custom field exactly as follows:
   1. *Name*: VendorFuel Order
   2. *Data Type*: Text and number
   3. *Category*: Transaction
   4. *Select Forms*: Select ALL forms and all print on form options
8. Select the **Save** button.
9. On your VendorFuel store, verify the custom fields by going to VendorFuel > Orders and select an order to test. On the Order detail page, select the **Export to QuickBooks** button to verify order is updated with Purchase Order and VendorFuel Order.


# Linking VendorFuel to QuickBooks

How to link VendorFuel with your QuickBooks account.

To link VendorFuel to your QuickBooks account,

1. Select VendorFuel > **Accounting**.
2. Select **Link to QuickBooks** button. A new browser window should appear requiring you to sign in to your QuickBooks account.&#x20;
3. Complete the QuickBooks authentication process.


# Setting QuickBooks parent customer

How to set a QuickBooks parent customer for a customer group.

In QuickBooks, how a customer is selected depends on the customer configuration in VendorFuel.

<table data-full-width="true"><thead><tr><th>VF customer email</th><th>VF group</th><th>VF group QB parent default billing address</th><th>VF order billing form</th><th>QB parent customer match</th><th>QB customer match</th></tr></thead><tbody><tr><td>John Doe<br>john@example.com</td><td>None</td><td>None</td><td>Company Billing: company@example.com</td><td>None</td><td>Company Billing : company@example.com</td></tr><tr><td>John Doe<br>john@example.com</td><td>Company</td><td>None</td><td>Company Billing: company@example.com</td><td>None</td><td>Company Billing : company@example.com</td></tr><tr><td>John Doe<br>john@example.com</td><td>Company</td><td>Company Billing: company@example.com</td><td>Any value</td><td>Company Billing: company@example.com</td><td>John Doe : john@example.com</td></tr></tbody></table>

To set a group's QuickBooks parent customer,

1. Go to VendorFuel > Customers > **Groups**.
2. Select a Group to edit it.
3. Look for the *QuickBooks: parent customer* section on the right side of the page.
4. Select the plus icon to select a customer. A dialog will then appear allowing you to search customer accounts.
5. Select a customer that has a default billing address.&#x20;
6. After selecting the customer, select the **Save** button. The dialog box should then close and you should see the customer's info in the *QuickBooks: parent customer* section.


# WordPress VendorFuel Settings

Manage settings under WordPress Settings > VendorFuel.

These settings are divided into several sections and use the WordPress Settings API to store data on your WordPress database, not the VendorFuel database.

### API

<table><thead><tr><th>Field</th><th>Description</th><th data-type="checkbox">Required</th></tr></thead><tbody><tr><td>API Key</td><td>Please contact support@vendorfuel.com if you do not have an API key.</td><td>true</td></tr><tr><td>API URL</td><td>Defaults to api.vendorfuel.com/production. You should not change this unless you are running a development environment.</td><td>true</td></tr><tr><td>Enable Debug Mode</td><td>Enabling this will send additional log messages to the browser console.</td><td>false</td></tr></tbody></table>

### Cart

<table><thead><tr><th>Field</th><th>Description</th><th data-type="checkbox">Required</th></tr></thead><tbody><tr><td>Enable Split Checkout</td><td>Enabling this will allow customers on the Cart page to split or partially checkout as separate orders.</td><td>false</td></tr><tr><td>Enable Request Quote</td><td>Enabling this will allow customers on the Cart page to request a quote on the cart items.</td><td>false</td></tr><tr><td>Enable CSV Download</td><td>Enabling this will allow customers to download a CSV of their cart items.</td><td>false</td></tr></tbody></table>

### Catalog

<table><thead><tr><th>Field</th><th>Description</th><th data-type="checkbox">Required</th></tr></thead><tbody><tr><td>Catalog Page Permalink</td><td>The permalink slug for Catalog pages.</td><td>false</td></tr><tr><td>Product Detail Page Permalink</td><td>The permalink slug for Product Detail pages.</td><td>false</td></tr></tbody></table>

### Customers

<table><thead><tr><th>Field</th><th>Description</th><th data-type="checkbox">Required</th></tr></thead><tbody><tr><td>Disable Self Registration</td><td>This will disable self registration via the Register page. It will also hide any links or button prompting the user to create or register a new account.</td><td>false</td></tr></tbody></table>

### Google Analytics

<table><thead><tr><th>Field</th><th>Description</th><th data-type="checkbox">Required</th></tr></thead><tbody><tr><td>Enable Google Analytics</td><td>Enabling this will track VendorFuel e-commerce events in Google Analytics.</td><td>false</td></tr><tr><td>Measurement ID</td><td></td><td>false</td></tr><tr><td>Site Verification Code</td><td></td><td>false</td></tr></tbody></table>


# VendorFuel release change log

Latest updates in VendorFuel plugin.

### PLUGIN \[17.5.0]

#### Added

* added invoiced cost to admin order details line items
* added cost margin to admin order details line items
* can now lock cost sheet to line item on admin order details line items card
* added purchase orders card to admin order details
* added action to purchase orders card to regenerate purchase orders
* can force transmit PO cXML to supplier through PO on purchase order card
* can download PO cXML through PO on purchase order card

#### Fixed

* fixed an issue where continuously clearing filters on indexes would break filter
* fixed an issue where orders index search would be preemptively filtered

#### Updated

* deprecated admin order details legacy view
* removed Metrc cart weight properties from customer model

### \[17.4.1]

#### Fixed

* vendors and suppliers will now be retrieved when creating a new cost sheet

### \[17.4.0]

#### Added

* add supplier invoice card to admin order details
* added price column when adding line item to existing order
* added customer invoice card action to resend/generate customer invoice

#### Fixed

* extending auto filter time of search queries to 1500ms
* fixed group order list links
* fixed issue with cached address id on checkout form addresses
* passing profile name to order confirmation

#### Updates

* removed supplier invoices from order legacy view
* fixed typo in customer invoices card shipping column
* added profile name to group order address type
* added profile name to order address type

### \[17.3.0]

#### Added

* order overview stats are now available on the orders index page
* added "completed" status to available order index status filters
* added customer table report headers: po\_number\_prefix,item\_limit,allow\_payment, mixed\_punchout,price\_availability, f1-f2\_replace\_field,f1-f3\_name,f1-f3\_value, promo\_engine
* added customer group table report headers: id
* added addresses join table report headers: phone\_extension,type
* added group\_approvers joint table headers: pending\_emails
* added group\_requesters join table headers: customer\_id,group\_id
* added customer punchout suppliers join table headers: customer\_id,supplier\_id
* added suppliers join table headers: name, id

#### Fixed

* fixed an issue preventing address deletion from checkout form
* report join table header purchase\_orders.po\_number has been fixed
* reports with no results will no longer crash page

#### Updates

### \[17.2.0]

#### Added

* customer 'last\_login' added to customers index headers
* admins can clear a custom checkout field from the customer card
* admins can share reports
* admins can copy reports (self, shared, or essential)
* admins now receive VendorFuel managed essential reports
* customers can manage saved cards from account page
* can set an email to be notified of any invoices that do not match to a purchase order

#### Fixed

* line items on admin order details uses updated API endpoints
* restored timestamp to orders index

#### Updates

* updated cost sheets products table design
* removed legacy view from admin orders details
* saved card form is automatically selected if customer has saved cards

### \[17.1.3]

#### Added

* added set default address button on checkout form saved addresses
* added a set default payment method for saved cards
* added more card details to admin order details

#### Fixed

* only clicked delete button will spin when deleting a saved card
* report downloads blocked in finished timestamp not set yet

#### Updates

* locking address form while plugin retrieves default address
* automatically selected saved cards tab if saved cards are retrieved
* removed receiving document profile from costs sheets indices
* removed "billing same as shipping" checkbox when customer has locked billing

### \[17.1.2]

#### Added

* added set default address button on checkout form saved addresses
* added a set default payment method for saved cards
* added more card details to admin order details

#### Fixed

* only clicked delete button will spin when deleting a saved card
* report downloads blocked in finished timestamp not set yet

#### Updates

* locking address form while plugin retrieves default address
* automatically selected saved cards tab if saved cards are retrieved
* removed receiving document profile from costs sheets indices
* removed "billing same as shipping" checkbox when customer has locked billing

### \[17.1.1]

#### Added

* added border spacing to credit card order completion response message
* icons for squareup saved cards
* icon for credit line
* added Cart & Checkout links to account dropdown
* added checkout link to cart dropdown
* added retrieving cards messaging when API is listing saved cards
* added no saved cards message if no saved cards are returned
* added a clear card button so user can clear squareup form if needed

#### Fixed

* squareup credit card buttons now block while order is completing
* squareup credit card form is now automatically selected if only payment option

#### Updates

* using supplier & vendor names for index table of cost sheets

### \[17.1.0]

#### Added

* Credit/Debit cards can be saved when using SquareUp payment
* admin can (un)select all when configuring tax states

#### Fixed

* Fixed an issue when checkout form matches to initial default addresses
* link to admin order details shipments/notifications now works
* RMA button on customer order details now opens specified line item
* Admin Orders index "hasErrors" filter can now filter false
* enabling SquareUp sandbox now works as intended
* order history credit card details now display correctly

#### Updates

* new customer form is invalid if no price sheet selected

### \[17.0.3]

#### Fixed

* RMA modal on Customer Order Detail page now opens correct line item
* Fixed link to Admin Order Notifications Show Page
* Fixed link to Admin Order Shipments Show Page

#### Updates

### \[17.0.2]

#### Updates

* checkboxes are now used when selecting report headers
* report headers have been organized in to separate tabs
* added purchase\_orders to available tables for reports
* added purchased\_items\_invoices.id for pivot reports
* send\_welcome\_email boolean has been added to customers import template

### \[17.0.0]

#### Fixed

* removing link to redundant and unfinished line items page
* fixed typo in Customer Invoices tab
* fixed plugin settings link to VF wordpress settings page

#### Updates

* customer po\_number\_prefix no longer pre fills the po number checkout field
* replaced some ID links with a view icon link (these ids are irrelevant and confusing to store admins)
* added line items status to line items table
* added order notification response to order notifications table
* added name override when copying customer
* added shipping name override boolean when copying customer
* added more invoice columns to reporting to allow for cost margin analysis reports

Deprecations:

### \[16.4.1]

#### Fixed

* Customer Group detail page wouldn't refresh data after adding customers, punchout suppliers, and shipping rates.
* Orders list page would fetch data twice from API.
* `Sign in to Square` button linked to Square developer portal, instead of customer login.
* Some actions on Settings > Payment Gateways > Square didn't work as expected.

### \[16.4.0]

#### Added

* Added menu to export and resend order data.
* Added page for adding order shipments, instead of using a dialog.

#### Changed

* Order shipped property changed from boolean to string.
* Order fraud and shipping details moved from legacy Order detail page to new UI.

#### Fixed

* Order customer invoices list had broken link.

#### Removed

* Legacy order detail page no longer supports export and resend functions, or shipping details. Users directed to use newer UI.

### \[16.3.0]

#### Changed

* Order index now displays link to both newer UI and legacy UI.
* Legacy order detail page no longer shows tabbed interface.

#### Fixed

* Some U.S. state selection elements were missing District of Columbia.

#### Removed

* Order line items, notifications, summary, shipping, billing and additional info removed from legacy order detail page, instructing user to view order in new UI.

### \[16.2.0]

#### Added

* Price sheet detail page now shows cost sheet ID field.
* Added `.show-is-mixed-punchout` class to hide elements unless the customer is a mixed punchout customer.
* Added `customer_prefix` and \`\` to customer upload template file.

#### Changes

* Price sheet detail page updated.

#### Removed

* Removed unused order request customer ID and order request billing ID fields from punchout supplier detail page.

### \[16.1.1]

#### Fixed

* Creating or deleting a price sheet would result in 404 error.
* Clicking the delete button on the price sheet detail page could result in accidental form submission.

### \[16.1.0]

#### Changed

* Collection detail page no longer displays a tabbed interface.
* Store settings warns admin user about enabling 2-Step Verification, as it could potentially lock all admins out of a store if enabled.

#### Fixed

* Notifications were appearing in two different styles.
* Welcome page displays errors persistently if there's an error when attempting to punchout.

#### Removed

* Removed unnecessary dependencies to reduce plugin file size and possible conflicts when attempting to update packages.
* Removed TinyMCE editor from product description field. Feature was barely used and relied on unsupported dependencies.

### \[16.0.0]

#### Added

* Admin Order detail page now shows Customer Invoices, with ability to transmit and download cXML invoices.

#### Changed

* Admin Order detail page (legacy UI) directs users to use the newer Order detail page.

#### Removed

* Deprecated Banner and Banner Area functionality removed. Conditional Content blocks are now to be used on any WordPress page to dynamically display content based on customer price sheet.
* Unused Catalog > Related Product customization settings removed.
* Unused `Disable Billing Address` store setting removed.

### \[15.5.2]

#### Fixed

* Dropdown menus on Admin Customer Group detail page would get clipped.

### \[15.5.1]

#### Fixed

* Square payment locations used sandbox mode regardless of switch setting.

### \[15.5.0]

#### Added

* Added Order Return Merchandise Authorization detail page.
* Added option on User detail page for the user to receive an email whenever an order notification fails.

#### Changed

* Moved Shipping options under Settings, as they are usually one-time settings that don't need to be accessed repeatedly.
* Moved action buttons for admin Customer Account detail page to top of page.

#### Fixed

* After copying a customer, users wouldn't be automatically navigated to the copied customer account, requiring users to manually find the account on the index page.
* Email template editor didn't show correct merge tags. Renamed "Short-codes" to "Merge tags" since to avoid confusion.
* Unable to add return merchandise authorization (RMA) on admin order detail page.

#### Removed

* Shipping removed from top and side menus, since it is under Settings now.

### \[15.4.1]

#### Fixed

* Admin Customer address form starts with shipping address type, which would be more used than the billing type.

### \[15.4.0]

#### Added

* QuickBooks parent customers can be set on the Group detail page.
* Report results now visible via `Run report` command without needing to download a spreadsheet file.

#### Changed

* Email templates now appear as a index page, with better explanation of what each template does.
* Reports page now appears as an index page, where new reports can be created or existing ones edited, rather than providing a dropdown to select a report.

#### Fixed

* Customer page "Add new role" link broken.
* "Send Order Email" button didn't work on Group Order page.
* Reports page contained `order.approver` header which would result in SQL error since it's an object. Users should use `order.approver_id` instead.

### \[15.3.0]

#### Added

* Email and phone number fields added to customer address index.
* Order shipment notifications can be resent from the Order detail page.
* Square payment gateway added as additional method for processing credit cards.

#### Changed

* Order addresses moved to separate page to improve focus and prevent distraction with other order information.

#### Fixed

* Address forms missing profile name fields.
* Headers field on Reporting page was too small, making it difficult for user to select multiple fields.
* RMA request didn't work on Orders page.
* Second address line misaligned on address validation dialog.

### \[15.2.4]

#### Fixed

* Customer Role detail page showed an error if user attempted to create a new role.
* Group detail page didn't show child groups, wouldn't allow setting parent group to none.

### \[15.2.3]

#### Fixed

* Related product links broken.

### \[15.2.2]

#### Fixed

* Customer address index missing city field.

### \[15.2.1]

#### Added

* Admin User detail page now supports REST API key generation and revoking.

#### Changed

* Admin User detail page form updated. Changing user password is now handled via a dialog to improve focus.

#### Fixed

* Admin User detail page wouldn't show password if changed.
* Admin index pages weren't showing first and last page buttons.

## 15.2.0

### Added

* Admin Reporting now has an intermediary page with links to manage, download and schedule reports.

### Changed

* Admin customer account addresses are now accessible via separate index and detail pages.
* Index pages updated to look more consistent and load faster with more sorting and filtering features. However, pagination or filter changes are no longer stored in the browser URL, which was resulting in slow rendering and undesired side-effects.
* Punchout cXML logs now display fully expanded for easier navigation.
* Taxes and Avalara settings have been moved under Settings > Taxes since they are usually a one-time configuration.

### Fixed

* Card header and list padding looked excessive.
* Many pages didn't show the page title in the browser title.

### Removed

* Remove Admin Customers > Settings page, which contained default customer and order prefix settings. These have been moved to the Settings > Store page where they belong.
* Removed unsupported "Merge Manufacturers" link from Catalog page (this action is supported on the Manufacturers page).
* Taxes no longer appears in the top navigation or WordPress admin menu, since it is now under Settings.

## 15.1.1

### Fixed

* Orders page wouldn't load.

## 15.1.0

### Added

* Order detail page allows editing of more billing and shipping address fields, including addressID.

### Changed

* cXML log detail shows better XML and JSON data with collapsible and expandable fields.
* *Accounting* page moved under Settings, as it is usually a one-time setting.
* Admin Orders index page supports filtering and sorting by customer email address and purchase order number, plus filtering by shipping profile or address ID. *Ordered by* and *Approved by* fields now show email address instead of name.
* Admin Order detail page form updated for easier use.
* Improved help text on *Settings* pages.
* 'PO number' used for all instances of purchase order number labels for consistency.

### Removed

* *Accounting* page no longer appears in the top navigation or WordPress admin menu, since it is now under Settings.
* Removed unsupported *Customers Require Manual Verification* and *Verify Users* options from *Settings*.

## 15.0.0

### Added

* Banner and Banner Areas pages show a deprecation warning, guiding admins to use Conditional Content blocks for displaying banner content based on a customer's price sheet.

### Changed

* Upgraded to [Material UI v6](https://mui.com/material-ui/migration/upgrade-to-v6/).

### Removed

* **BREAKING CHANGE:** `vf-template` shortcode functionality removed. Store admins must now use the newer VendorFuel Blocks for frontend store components. Dashboard now displays an error alert to notify admins to migrate any remaining shortcodes.
* Banner and Banner Areas no longer show buttons to create new ones, since they are a deprecated feature and will be removed in a future release.

## 14.2.0

### Added

* Account menu displays notification badges if user is an approver and there are awaiting pending orders.
* Admin Order detail page shows alert if errors detected in line items or notifications.
* Dashboard warns user if deprecated `vf-template` shortcodes are used, with instructions to update these to VendorFuel blocks.
* Dashboard and Admin Orders index page now shows Payment Type field.

### Changed

* Admin Orders index shows better error indicators, contextual colors, improved filtering and tooltips for order status.
* Updated help text on Document Profile detail page.
* Frontend `vf-template` shortcodes will more visibly fail if they are missing or using an invalid name attribute, preventing misnamed templates from silently failing and unknowingly disrupting user experience.
* Group Orders page defaults to showing orders pending approval, with clearer instructions what to do if no pending orders are available.
* Orders page directs group approvers to Group Orders page if they are wanting to approve order, providing clearer direction if they were expecting pending orders on the Orders page.

### Fixed

* Admin index pages would lose field filters when pagination or sorting changed.

## 14.1.0

### Added

* Purchasing Document Profile detail form now shows Options field.
* Purchasing Vendor detail form now shows a Dropship field.
* Return Merchandise Authorizations (RMAs) index page now available via the Orders index page.

### Changed

* Customer Account index page now shows PO prefix.
* Revised plugin description.
* Updated PayFabric Payment Gateway form to give clearer guidance to user where to find appropriate form information.

### Fixed

* Forms to sign in may not display relevant error messages to user.

## 14.0.0

### Added

* Added searchable section cards to Dashboard for easier navigation.

### Changed

* Build process now uses default WordPress Webpack configuration.
* Top navigation no longer shows dropdown menus to better enforce consistency.
* "Admin Users" renamed "Users" in WordPress plugin submenu to match name elsewhere.

### Fixed

* Build task no longer duplicates block-related folders in two output locations.
* Purchasing Cost Sheet form dropdown appearances fixed, changed to simpler select elements.

### Removed

* **BREAKING CHANGE:** Blocks for the WordPress block editor have been moved to a new plugin: [VendorFuel Blocks](https://bitbucket.org/vendorfuel/vendorfuel-blocks/). Please install and activate the [VendorFuel Block](https://bitbucket.org/vendorfuel/vendorfuel-blocks/) plugin for Gutenberg blocks.
  * *Why this was done*: An issue was discovered which could cause problems as more legacy frontend code was upgraded to be WordPress Gutenberg blocks. The best solution seemed to be to separate all block development to a new plugin that would use only the latest WordPress APIs.
  * Moving forward, all future Gutenberg block-related code will be in the [VendorFuel Blocks](https://bitbucket.org/vendorfuel/vendorfuel-blocks/) plugin, leaving the [VendorFuel](https://bitbucket.org/vendorfuel/vendorfuel/) plugin for admin-related code and legacy frontend shortcodes as they are deprecated out.

## 13.2.0

### Changed

* Added type property to Punchout cXML list page.
* Punchout cXML logs display properly formatted with syntax highlighting and collapsible tags.

## 13.1.5

#### Fixed

* Customer Group detail page wasn't showing notifications when group was saved.
* Plugin admin pages didn't warn user if required API key was missing, leading to possible invalid API requests and redirection errors.

## 13.1.4

#### Fixed

* Catalog page links weren't working.

## 13.1.3

#### Added

* Wide and full-width support added to VendorFuel blocks.

#### Fixed

* Cart and Checkout pages now direct punchout customers to place order instead of the Catalog page if their cart is empty.

## 13.1.2

#### Changed

* Updated dependency packages.
* Now requires WordPress 6.6.

## 13.1.1

#### Fixed

* Customer detail page wouldn't show selected price sheet, and wouldn't allow reverting to none after a price sheet was selected.

## 13.1.0

#### Changed

* Customer Group and Promo Code detail page user interface updated.

#### Fixed

* Cart page button still said "Save to Cart" when it should say "Add to Shopping List".
* Multiple instances of some blocks (e.g. Checkout, Cart, etc.) could be added to a page or post, when they are intended to only appear on a page or post once.
* Promo Code detail page user interface wasn't working for some fields.
* Shopping Lists block would display an empty table instead of a relevant message when the user hadn't saved any shopping lists yet.
* Users unable to select group on Role detail page.

## 13.0.0

### Added

* Permalinks for all VendorFuel-generated pages can be managed under WordPress > Settings > Vendorfuel > Permalinks.
* Punchout cXML logs can now be viewed under Punchout > cXML.
* Setting to hide billing contact information from customers added to WordPress > Settings > VendorFuel > Customers.
* Registration block supports setting customer role using WordPress block editor.
* WordPress patterns added to block editor that contain expected content for VendorFuel-generated pages.
* WordPress blocks added for VendorFuel frontend functionality to eventually replace older template shortcodes.

### Changed

* Admin Punchout page no longer shows Suppliers list, but links to cXML logs and Suppliers list.
* Checkout page redirects to Orders page after completing order with credit card.
* Document Profile form updated.
* New installations of VendorFuel will generate new pages containing blocks instead of shortcodes.
* Permalinks for Catalog and Product Detail pages moved to WordPress > Settings > VendorFuel > Permalinks.
* Saved Carts is now called Shopping Lists to avoid confusion with certain actions like 'Add to Cart'.

### Fixed

* Customer Account detail page would show Addresses tab before the customer was created and able to have addresses assigned to it.
* Document Profile page wouldn't allow updating of password.
* Punchout Supplier detail page wouldn't show endpoint fields when creating a new supplier.
* Some pages might show an error when browser refreshed on that page.
* Settings link in WordPress menu pointed to incorrect page.


# VendorFuel Blocks release change log

\= 1.2.2 =

* Fixed: No margin between Conditional Content block notice and content. Conditional Content would attempt to fetch API if not signed in to VendorFuel.

\= 1.2.1 =

* Fixed: Shopping Lists block didn't show notifications to user after actions (e.g. adding to cart, changing quantity, etc.). Shopping lists also missing product thumbnail.

## 1.2.0

* Added: Conditional Content block that can wrap content in the WordPress block editor and only allow signed-in customers using a specific price sheet to see it. Functionality replaces previous Banners and Banner Areas in the VendorFuel plugin.
* Changed: Logout and Order By SKU block uses WordPress Interactivity API.

## 1.1.0

* Changed: Search block uses WordPress Interactivity API.
* Fixed: CC-Return block now displays warning message if required OrderID or TrxKey URL parameters are missing.
* Fixed: Search block inspector controls missing field label.

## 1.0.1

* Fixed issue with block wrapper classes.

## 1.0.0

* Initial release.
* Block code moved over from VendorFuel plugin.


# Downloads

Downloadable plugin files

To install, download the appropriate release file, then upload to WordPress > Plugins > Add New Plugin.

{% file src="/files/6eVzoxnWGgVs4aPiofR7" %}
VendorFuel plugin
{% endfile %}

{% file src="/files/c8I6t65Zk3XemwZ7v6N8" %}
VendorFuel Blocks plugin
{% endfile %}


