For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dev Portal
DocsAPI ReferenceLearnCommunityChangelog
DocsAPI ReferenceLearnCommunityChangelog
  • Overview
    • Quick Start
    • Sandboxes
    • Tools & SDKs
    • Support
  • Docs
      • Getting Started
      • Becoming a Partner
      • Metafields
      • Scripts
      • Shipping Providers
      • Tax Providers
          • Overview
            • Overview
            • Merchant configuration
            • Browse and discover as a shopper
            • Manage checkout as a shopper
            • Manage order as a merchant
            • Fulfill order as a merchant
            • Retire merchant configuration
          • Frequently asked questions
          • Glossary
          • Inventory adjustments
          • Locations
          • Webhooks
        • Analytics with BODL
        • Staging with Staging Pro
    • Archive
    • Closed Beta Programs
Dev Portal
LogoLogo
On this page
  • Guide
  • Prerequisites
  • Resources
DocsIntegrationsPlatform SolutionsBuy online, pick up in storeEnd-to-end guide

End-to-End API Guide

Was this page helpful?
Previous

Overview

Next

Merchant configuration

Built with

This document guides you through the steps on how to create customized Buy Online, Pick up in Store solutions for merchants and shoppers. This guide provides a sequence of API calls, framed from the perspective of the merchant and their shoppers. For more on the API endpoints that support Buy Online, Pick up in Store, see Overview.

Guide

  • Merchant configuration
  • Browse and discover as a shopper
  • Manage checkout as a shopper
  • Manage order as a merchant
  • Fulfill order as a merchant
  • Terminate configuration as a merchant

Prerequisites

This guide assumes the merchant already has the following elements configured:

  • A functioning BigCommerce store.
  • Store settings, including Catalog, Payments, Tax, Order Fulfillment, etc.
  • A storefront that uses a custom checkout, such as one of the following:
    • a new or existing checkout built with the Checkout JS SDK
    • a headless storefront that uses the Store Management Checkout API
  • A store-level API account that contains the following OAuth scopes:
UI NamePermissionParameterDescription
Store Inventorymodifystore_inventoryView and modify the store inventory
Store Locationsmodifystore_locationsView and modify store locations
Fulfillment Methodsmodifystore_fulfillment_methods_manageView and modify order fulfillment methods
Order Fulfillmentmodifystore_order_fulfillment_manageView and modify order fulfillments
  • If your implementation uses a single-click app wrapper, a separately configured app profile and app-level API account is required to manage installation and access.

Resources

  • FAQ
  • Glossary