OnBuy Integration Setup Guide

This page provides a step-by-step guide to help users configure and activate their OnBuy sales channel within Helm. It covers obtaining API credentials, setting up the integration in the platform, and configuring optional modules such as stock sync, branding, and notifications.

Last updated 25 days ago

Prerequisites

Before proceeding, ensure you have the following:

  • Administrative access to your Helm account

  • An active OnBuy Seller account

  • Access to your Site ID, Consumer Key, and Secret Key via the OnBuy seller portal

Step 1: Obtain API Credentials from OnBuy

To integrate OnBuy with Helm, you must first retrieve your API credentials.

  1. Go to the OnBuy Seller Portal:
    https://seller.onbuy.com

  2. Log in with your seller credentials.

  3. Navigate to:
    Listing → Imports & Integration

  4. Under Enabled Integrations, click OnBuy API.

  5. Locate and make a note of the following from the Live Keys section:

    • Site ID

    • Consumer Key

    • Secret Key

🔐 These credentials are required to complete the integration in Helm. Keep them stored securely.

Step 2: Add OnBuy as a Sales Channel in Helm

  1. From your Helm dashboard, go to Settings in the bottom-left corner.

  2. Navigate to the Sales Channels section in the sidebar.

  3. Scroll through the list and select OnBuy.

  4. Click Install to begin setup.

Step 3: Configure Integration Fields

You will now be prompted to complete the integration form. Fill in the following:

  • Active – Toggle ON to activate the channel

  • Name – Provide a recognisable name (e.g. OnBuy UK)

  • Site ID – Paste the Site ID from OnBuy

  • Consumer Key – Enter the Consumer Key retrieved earlier

  • Secret Key – Paste the Secret Key provided by OnBuy

Step 4: Additional Configuration (Optional)

Use the top navigation tabs to tailor the integration further:

  • Settings – Choose the warehouse from which goods will be dispatched for this integration

  • Stock Control – Set up auto-sync rules for inventory

  • Brand – Link the channel to your company information

  • Commercial Invoice – Define invoice data specific to this channel

  • Despatch Emails – Configure automatic shipment notification emails

  • Feedback Emails – Enable automated post-sale feedback requests

Adjust these based on your business preferences.

Step 5: Finalise the Integration

  1. Once all required fields and configurations are complete, click Submit.

  2. A confirmation message will appear in the top-right corner.

Completion

Your OnBuy channel is now successfully connected to Helm. Orders, inventory, and status updates will begin syncing automatically.

You can revisit Sales Channels at any time to update credentials or adjust your configuration.