BigCommerce Integration Steps

Overview

This guide describes the steps to integrate Bread into the BigCommerce platform. It will explain how to install and configure the Bread App.

Install the Bread Pay App

Installation Steps

1. Get started by logging into your BigCommerce store. From the left-hand menu, select Apps > Marketplace.

2. Search for “Bread” and click on the result that displays the Bread logo.

3. Click on the logo to see the Bread App details page. From there, click Install to add the Bread App to your store. After completing these steps, the app will be displayed in the Store as shown below:

Configure the Bread Pay App Settings

Plugin Settings And Configuration

In this section, we will first walk through the steps to get Bread working on your BigCommerce site. There will be information on the different configuration options found at the bottom of the section.

Once the Bread App is installed, you can find it in your store under Apps > My Apps > Bread Finance. Click on Bread Finance to access the app, then click on App Settings from within the app.

Enter Your Sandbox API Keys

Your Bread API keys, which tie transactions made from your store to your Bread account, should be entered into API Key and API Secret under API Configuration.

1. Find your sandbox API keys in your sandbox Bread Merchant Portal.
   a. This is your sandbox merchant portal — you should be able to log in with credentials provided by your main success point of contact.
   b. Your API and Secret key will be listed within the Bread merchant portal under Account > API & Secret Keys.
2. Copy the API Key and Secret Key, and paste both in their corresponding fields within the BigCommerce app.
   a. Additionally, make sure Use Sandbox Mode? is enabled.
3. Once these changes have been made, hit the Save button in the lower right corner of the Bread App settings.

Add Bread Placements to Your Site

Adding Bread to the Product Details Page

1. Navigate back to the Bread App settings and find the Product Page Settings. Make sure Product promotions are enabled. You should now see additional options:

Adding Bread to the Cart Summary Page

1. Navigate back to the Bread App settings and find the Product Page Settings. Make sure Product promotions are enabled. You should now see additional options:

Adding Bread to the Checkout Page

1. Navigate back to the Bread App and select on General Settings and find the Payment Method. Make sure Product promotions are enabled.
2. You should now see additional options
   a. Note: ALL products are REQUIRED to have product images and SKUs for Bread to load successfully on your checkout page.
3. Select the check as a payment method and put in a name for payment label.

4. Get started by logging into your BigCommerce admin and navigating to Store Setup > Payments.
   a. If your store uses BigCommerce Optimized One-Page Checkout, under the Checkout Payment Settings tab, scroll down and expand Offline Payment Methods.
5. Toggle on Cash on Delivery payment method. Enter a name for Display Name such as "BreadPay".

6. You should now be able to see the payment method on the checkout page.