📍 Bolt Help / Developers / Developer Guides / Integration Setup / Connect Ordergroove with Bolt

Connect Ordergroove with Bolt

The Ordergroove integration enables merchants to offer subscriptions to their customers. It is currently compatible with the SFCC platform.

Before You Start

Merchants must have implemented the following Bolt settings:

  • Bolt Managed Checkout
  • Cart that supports the Ordergroove integration (SFCC)

Merchants must have completed the following Ordergroove setup steps:

  • Download the Ordergroove integration into your workspace.
  • Use the Ordergroove SFCC Installation Guide (included in the downloaded cartridge files) to set up the cartridge.
    • • Go to Setup > Configuration and use steps 1 through 7 to complete the required configuration.

If you have existing subscriptions with Ordergroove, please contact your Bolt customer success manager to perform a migration so your existing subscriptions continue to process correctly.

Implementation

Enable Ordergroove Webhook

  1. Log into the Ordergroove RC3 dashboard and navigate to Account > Developers > Webhooks.
  2. Select Enabled.
  3. Add the URL for your environment type:
    • Prod: https://api.bolt.com/v1/webhooks/ordergroove
    • Sandbox: https://api-sandbox.bolt.com/v1/webhooks/ordergroove

Connect Bolt and Ordergroove

Obtain Ordergroove Account Keys

Contact your Ordergroove account representative to obtain the following keys:

  • API private key
  • API username
  • Customer private key
  • Public ID
  • SFTP username
  • SFTP password

Obtain Ordergroove Webhook Key

  1. Log into the Ordergroove RC3 dashboard and navigate to Account > Developers > Webhooks.
  2. Locate Verification Key and select Show.
  3. Copy this key for use in a later step. This is the webhook private key.

Add Keys to Bolt

Contact your Bolt customer success manager and send the six Ordergroove account keys and the Ordergroove webhook private key. The CSM will work with the technical team to connect your Bolt and Ordergroove accounts.

Configure Payment Method Updater

To enable shoppers to update their payment method from their merchant storefront account, embed the payment method updater component in the page where a shopper can manage their subscriptions.

The appropriate steps vary based on whether you have implemented Bolt SSO.

Load Bolt Script

  1. Log into the Ordergroove RC3 dashboard and navigate to Subscriptions > Management Interface > Code Editor.
  2. Locate the /scripts folder and click script.js.
  3. Paste the following code at the bottom:


With SSO



Without SSO


By default, this component renders the payment method updater in a new tab. For this integration, we recommend overriding this functionality and embedding the component in your storefront for a more seamless user experience.

  1. Locate the /views folder and click billing-shipping-details.liquid. This file controls the subscription management page.
  2. Locate this code block (around line 39):
{% if 'external_payment_enabled' | setting %}
  <a class="og-link og-edit-payment" href="{{ 'external_payment_url' | setting }}">{{ 'shipment_unsent_footer_billing_edit' | t }}</a>
{% endif %}

and replace it with the following code:


With SSO



Without SSO


Update Card Details in Storefront

To trigger updatePaymentMethod() to update the card details in the storefront UI, add data-bolt-id elements to the subscription management page.

  1. Locate the /views folder and click billing-shipping-details.liquid. This file controls the subscription management page.
  2. Locate this code block (around line 28):
<div og-payment-id="{{payment.public_id}}">
      <span class="og-payment-type">
          {{ payment.cc_type }} {{ payment_method_names[payment.payment_method] }}
      </span>
      {% if payment.cc_number_ending %}
        {{ 'form_billing_ending_in' | t }}
      {% endif %}
    </div>
    <div class="og-payment-expiration-date">
      {% if payment.public_id %}
        {{ 'form_billing_expiration_date' | t }}
      {% endif %}
    </div>

and replace it with the following:

<div og-payment-id="{{payment.public_id}}">
      <span class="og-payment-type">
          <span data-bolt-id="bolt-billing-cc-type">{{ payment.cc_type }}</span> {{ payment_method_names[payment.payment_method] }}
      </span>
      {% if payment.cc_number_ending %}
        <span data-bolt-id="bolt-billing-last-4" class="og-payment-last-4">{{ 'form_billing_ending_in' | t }}</span>
      {% endif %}
    </div>
    <div class="og-payment-expiration-date">
      {% if payment.public_id %}
        <span data-bolt-id="bolt-billing-expiry-date" class="og-exp-date">{{ 'form_billing_expiration_date' | t }}</span>
      {% endif %}
    </div>

Enable Ordergroove in SFCC

  1. Log into SFCC and navigate to Merchant Tools > RefArch > Site Preferences > Custom Preferences > Ordergroove.
  2. Locate the OrderGrooveEnable setting and set it to yes.

Enable Feature in Ordergroove

Contact Ordergroove and request enablement of the feature Batch order placement.

📖On This Page