Tickets - Login

merchant api

  • Developer Quickstart Guide

    There are two ways to integrate with Bolt: via platform plugin installation, or via Bolt’s Direct API for custom cart platforms. Use the following sections to quickly begin setting up your store with Bolt Checkout.

  • What is Bolt?

    When we talk about Bolt as a cohesive product experience, it’s important to understand all of the separate technical pieces that must be implemented to use Bolt with a custom cart platform. Those pieces are the following:

    • The Checkout Modal
    • The Bolt API
    • The Merchant API
    • Transaction Status Webhooks

  • How Bolt Interacts

    Now that we’ve covered the general components of Bolt in Part One of our Developer’s Guide, let’s dive into some specifics about how Bolt is communicating with your e-commerce platform. This article is a high-level framework tackling information found in our Bolt API Reference and Merchant API Reference.

  • Environment Details


    Bolt provides two account environments: Sandbox and Production. Each environment includes a unique Merchant Dashboard. All transactions that flow through Bolt’s checkout can be found in your Merchant Dashboard.

    Each merchant account has a unique API Key and Signing Secret that Bolt uses to accurately verify and associate transactions with the account’s divisions.


    A Bolt merchant account can have one or many divisions. A division represents a uniquely configured instance of Bolt Checkout to fit a specific use case or workflow (e.g., storefront and back office). Division setup often includes enabling different features and creating separate webhooks for every division.

    Common Divisions

    • Pay by Link
    • Back Office
    • NetSuite ERP

    Each merchant division has a unique Publishable Key that is used to access your transaction data outside of the Bolt Merchant Dashboard.

    Collaborating with many developers across multiple sandboxes does not require multiple divisions. Simply add each URL to your Approved Domains list.

    Account Types

    Merchant account types are associated to individual processors. Because each processor has unique workflows and setup requirements, switching your payment processor requires setting up a new Bolt merchant account that aligns with the newly chosen processor.

    API & Webhooks

    About Keys

    API Key Used for calling Bolt API from your backend server
    Signing Secret Used for signature verification on requests received from bolt
    Publishable Key Embedded on your website and used by Bolt to identify your website

  • Integrate Backoffice Operations

    You can integrate Bolt operations directly into your order management and supply chain systems using Bolt’s API. These actions can be performed via Bolt’s Merchant Dashboard without API integration.

    Available Actions

    • Authorize New Credit Card
    • Capture Authorizations Manually
    • Fetch Transaction Details
    • Recharge Existing Credit Card
    • Refund Transactions
    • Review Transaction Manually
    • Void Transactions

  • Error Codes

    You may choose to pass these error codes back to Bolt in Merchant API Responses to trigger appropriate messages for the shopper.

  • Checkout Cart Groups

    Merchants on custom cart platforms can group similar items in Bolt checkout using Cart Groups. One common use case is to group items in the shopper’s cart by expected shipping or delivery dates. Read how to enable Cart Groups.

  • Enable Cart Groups

    Cart Groups enable merchants to group items in a shopper’s cart by labels.

    How to Add Cart Groups

    You must update the create.order Merchant API call to include the itemGroup field.

      "id": "9733761171175415",
      "displayId": "5203939994859497",
      "items": [
          "reference": "2",
          "image": "",
          "name": "Item2",
          "price": "$80.32",
          "desc": "Item2 makes Item1 obsolete",
          "sku": "SK-2",
          "itemGroup": "group 1",
          "quantity": 1
      "currency": "USD"

  • Enable In-Store Pickup

    In-store Pickup enables shoppers to pick up their items from a nearby store instead of wait for a delivery. How to Enable In-Store Pickup  In-Store Pickup requires responding to Bolt’s POST request for an order’s shipping details from your Merchant API. In addition to listing delivery options, the response can also contain pickup options.  Ensure you have set up the Split Shipping and Tax endpoints. Update your shipping response to include the object pickup_options with an array of stores available, based on the shopper’s address.

  • Enable Order Tracking

    How to Set up Order Tracking 1. Bolt Initialization Reach out to your Customer Success Manager to enable this feature. Wait for confirmation before moving to the next step. 2. Update your Platform theme. BigCommerce Add the following script to your theme footer (typically found in templates/components/common.footer.html). <!--Bolt Addition--> <div> <div class="bolt-account-login"></div> <script id="bolt-account" type="text/javascript" src="" data-publishable-key={publishable_key}> </script> </div> <!--End Bolt Addition--> Refresh the page. Preview the theme and review.