Skip to main content

Install and Configure

Install the WordPress Plugin and connect it to your Propeller environment. By the end of this page you will have a running B2B portal loading products, pricing and account features from Propeller.

Prerequisites​

  • A WordPress installation (version 6.2 or higher)
  • PHP 8.1 or higher
  • Two Propeller GraphQL API keys: one for general storefront operations and one for order processing (how to get credentials)

Step 1: Install the plugin​

There are two ways to install the plugin. Pick whichever suits your setup.

Option A: Install from WordPress​

Coming soon

Option A will be available when the V2 plugin is published to the WordPress plugin directory. For now, use Option B.

  1. Go to Plugins > Add New in your WordPress admin
  2. Search for Propeller
  3. Click Install Now and then Activate

Option B: Install manually​

  1. Download the plugin from the Propeller Commerce GitHub and upload the folder to /wp-content/plugins/
  2. Go to Plugins in your WordPress admin and activate Propeller

After activation​

Go to the Propeller page in your WordPress admin. This is where you connect the plugin to your Propeller environment.

Step 2: Configure the connection​

  1. Go to Propeller > General in your WordPress admin
  2. The API URL is pre-filled with the Propeller GraphQL endpoint. Leave the default unless you use a custom environment
  3. Enter your API key for general storefront operations such as catalog browsing, authentication and product data (how to get one)
  4. Enter your Orders API key for order processing such as cart mutations and placing orders
  5. Set the Channel ID to match your Propeller channel
  6. Set the Anonymous user ID. Propeller requires a user context for pricing and availability. This ID determines which prices anonymous visitors see
  7. Set the Catalog root ID. The plugin starts browsing from this category and shows all its descendants
  8. The Default language setting does not control the website language. To set the website language, go to WordPress Settings > General > Site Language. When you change the site language, product and catalog data is also fetched in that language
  9. Set the Default currency (for example EUR, USD). This controls the currency symbol displayed next to prices. It does not convert prices between currencies
  10. Click Save settings

The Propeller menu also has pages for Pages, Behavior, Translations and Sitemap. You can explore these after verifying the shop works. See General settings for a full description of each field.

Step 3: Add header shortcodes​

The plugin creates all commerce pages (login, cart, account, checkout) with the correct shortcodes. However, the header navigation elements are not added automatically. You need to place these shortcodes in your theme's header.

Add the following shortcode blocks to your theme header area using your page builder (WordPress ships with Gutenberg by default, but any page builder works):

  • [menu] — category navigation menu
  • [search] — search bar
  • [mini-account] — account icon and login link
  • [mini-shopping-cart] — cart icon with item count

These four shortcodes give you a functional shop header with navigation, search, account access and cart.

Without these shortcodes the commerce pages still work (you can access them by typing URLs directly), but the site will not have navigation, search or cart access in the header.

Step 4: Verify the shop​

  1. Visit your WordPress site frontend
  2. You should see the category navigation in the header (from the [menu] shortcode)
  3. Navigate to a category page. Products from your Propeller environment should appear
  4. Click a product to see the product detail page with pricing

If the catalog is empty, check that your API key is correct, the Channel ID matches a channel with published products and the Catalog root ID points to a category with products in Propeller.

Good to know​

  • Sitemaps — The plugin generates sitemaps automatically (runs once after midnight). Sitemaps are for SEO only. Your shop works without them and you do not need to wait for the first sitemap run.
  • Translations — The plugin's default UI labels (buttons, form text) are in English. To change the site language, go to WordPress Settings > General > Site Language. For multi-language setups, see Translations and valuesets.
  • Default theme — The plugin works with any WordPress theme, including the default theme (for example Twenty Twenty-Five).

Next: Explore B2B Features​

Your portal is running. Walk through the key B2B features to see what Propeller can do.

Explore B2B Features →