1. Home
  2. Docs
  3. Magento 2 Check out Extensions
  4. Magento 2 Checkout Custom Field
  5. Installation Guide

Installation Guide

After finishing the purchasing process, we will immediately send you an email containing the link to download this extension.

Before installing, please note that we provide you lists of Restful API supported by the module. Let's take a look at these lists in the User Guide.

Restful API support is included in the main module package (from Magento 2 Checkout Custom Field v1.2.5).

To use Restful API, follow this guide to install the main package.

(Please turn off Merge-JS before installing the module. Only Turn on Merge-JS when finishing the installation).

1. Install the extension

Step 1:

Unzip the file.

Step 2:

Create another directory called app/code/Bss/CheckoutCustomField/. CheckoutCustomField is the module's internal identifier. You can find it in the "composer.json" file in the extension ZIP file you downloaded, look at the node


This is what you call the directory, and then you put the contents of the extension ZIP file in there.

Step 3:

Upload the directory app/code/Bss/CheckoutCustomField/ into the root directory of your Magento installation. The root directory of Magento is the directory that contains the directories "app", "bin", "lib" and more. All directories should match the existing directory structure.

Step 4:

Go to Magento 2 root directory.

Run: php bin/magentosetup:upgrade.


Run: php bin/magentosetup:static-content:deploy.

Step 6:

Clear all Caches.

2. Install/Uninstall/Disable the GraphQL Support package

  • To install the GraphQL support package, run commands:

- php bin/magento module:enable Bss_CheckoutCustomFieldGraphQl
- php bin/magento setup:upgrade
- php bin/magento setup:static-content:deploy

  • To disable the GraphQL support package, run commands:

- php bin/magento module:disable Bss_CheckoutCustomFieldGraphQl
- php bin/magento cache:flush"

  • To uninstall the GraphQL support package, run commands:

- bin/magento module:disable Bss_CheckoutCustomFieldGraphQl
- remove directory from app/code manually
- bin/magento setup:upgrade
- bin/magento cache:flush

3. Install/Uninstall/Disable the Hyva Theme Compatibility package

The following instruction is used for the Hyva theme compatibility package ONLY.

3.1. To install the Hyva compatibility package: 

Step 1: Install the extension by the above Composer (If you already installed the module, then skip this step)

Step 2: Install the Hyva compatibility package:

a. Install via composer, run commands:

- composer require hyva-themes/magento2-bsscommerce-checkoutcustomfield

- php bin/magento s:up

b. Enable module, run command:

- bin/magento setup:upgrade

3.2. To disable the Hyva compatibility package, run command: 

- php bin/magento module:disable Hyva_BssCheckoutCustomField

3.3. To uninstall the Hyva compatibility package, run commands:

- composer remove hyva-themes/magento2-bsscommerce-checkoutcustomfield

*Note 1:

When installing module, you need to run the following commands to receive css:

- bin/magento hyva:config:generate

Adding the file including tailwind css: "src": "vendor\/hyva-themes\/magento2-bsscommerce-ModuleName\/src" to file app/etc/hyva-themes.json

- cd /path/vendor/hyva-themes/magento2-default-theme/web/tailwind/

(This path is for theme Hyva default in your site)

- cd /path/to/project/app/design/frontend/VendorName/ModuleName/web/tailwind/

(This path is for custom theme in your site)

- npm run build-prod

*Note 2:

After purchasing this module, just add our skype account at support.bsscommerce, BSS Support Team will help you to install this extension immediately. Further assistance is available via Email and Skype.

In case you have followed all the above steps but the extension still doesn’t work properly, you can delete the file or change the module’s filename to keep your website function as normal. Then please contact us via sales@bsscommerce.com or Skype: support.bsscommerce, our supporters will assist you in resolving any issues within 24 hours.

Was this article helpful to you? Yes 2 No

How can we help?