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
        • Overview
        • Localization
        • Metafields API Guides
        • Checkout URL
        • Optimized One-Page Checkout
        • Integrated Fastlane by PayPal
    • Archive
    • Closed Beta Programs
Dev Portal
LogoLogo
On this page
  • Limitations
  • Format
  • Examples
DocsAdminCheckout & Cart

Checkout URL

Was this page helpful?
Previous

Metafields API Guides

Next

Optimized One-Page Checkout

Built with

Apps or AI agents can use the Checkout URL format to create a new cart, add products, and direct a shopper to your BigCommerce storefront’s checkout. Multiple products/variants and their quantities can be added using a single URL. Optionally, you can specify the order source, and any applicable coupon code.

A new cart is created every time the URL is accessed.

Limitations

The following features are currently unavailable when the checkout URL is used:

  • The “Edit cart” link on the checkout page
  • Passwordless login
  • Products with modifier options

Format

A checkout URL is formatted the following way:

https://{store-url}/checkout/?products={id}:{quantity},{id}:{quantity}&coupon={code}&order_source={order_source}&action=buy
  • store-url — This is your storefront domain (such as mystore.com, or mystore.mybigcommerce.com).
  • id — That can be a Product ID or a SKU.
  • quantity — This represents the quantity of the preceding Product ID or SKU.
  • code — Optionally assign a coupon code.
  • order_source — Optionally designate a source for the order. Supported order sources are:
    • facebookshop
    • facebookmarketplace
    • www
    • buybutton
    • mcp

Examples

The following URL will add quantity 2 of product SKU “BIGC-MUG”:

https://mystore.com/checkout/?products=BIGC-MUG:2&action=buy

The following URL will:

  • Add quantity 1 of Product ID 12.
  • Add quantity 1 of Product ID 15.
  • Apply coupon code “FREESHIPPING”.
  • Attribute the order source to “www”.
https://mystore.mybigcommerce.com/checkout/?products=12:1,15:1&coupon=FREESHIPPING&order_source=www&action=buy