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.
LogoLogo
Dev Portal
DocsAPI ReferenceLearnCommunityChangelog
DocsAPI ReferenceLearnCommunityChangelog
  • Overview
    • Quick Start
    • Sandboxes
    • Tools & SDKs
    • Support
  • Docs
    • Archive
    • Closed Beta Programs
  • Quick Start
  • Sandboxes
  • Tools & SDKs
  • Support
  • API Accounts
  • Rate Limits
  • Integration Design
  • Deprecations & Sunsets
  • Getting Started
  • Overview
  • Overview
  • Local Development
  • Versioning
  • One-Click Catalyst
  • Manually Create Catalyst Channel
  • Build an Integration
  • Contribute
  • Custom Components
  • Manually Installing Scripts
  • Mailchimp Newsletter
  • Algolia Search
  • Customer Group Component
  • Prerequisites
  • Manual Installation
  • Environment Variables
  • Optimization
  • Sessions
  • Session Sync
  • Middleware
  • CDN and Images
  • Caching
  • Overview
  • Vercel
  • Overview
  • Getting Started
  • Overview
  • Overview
  • Static Translations
  • Overview
  • Setup
  • Overview
  • Setup
  • Sitemap
  • B2B Edition
  • Client
  • CLI
  • Testing
  • Wishlists
  • Security
  • 1.7.0
  • 1.6.0
  • 1.5.0
  • 1.4.0
  • 1.3.7
  • 1.3.6
  • 1.3.5
  • 1.3.0
  • 1.2.0
  • Overview
  • About Stencil
  • Stencil Tech Stack
  • Installing Stencil CLI
  • Starting the Development Server
  • Options and Commands
  • Handling Unexpected Behavior
  • Incompatible SCSS Directives
  • Node-sass Sunset
  • Handle Events
  • Query APIs
  • Stencil Utils Reference
  • Defining Global Styles
  • Creating Customizable Themes
  • Theme Variations
  • Directory Structure
  • Integrating React Components
  • Developing Accessible Themes
  • WCAG Compliance Levels
  • Implementing WCAG Guidelines
  • Localizing Stores
  • Translating Descriptions
  • Translating Page Regions
  • Using Translation Keys
  • Tutorial
  • Storefront Selector
  • Page Composition and Styling
  • Custom Sass Functions
  • Custom Fonts and Icons
  • Assets
  • Custom Templates
  • Modify the Login Form
  • Checkout Confirmation
  • Order Confirmation
  • Blog Commenting with Disqus
  • Dynamic Template Rendering
  • Elements
  • Schemas
  • Handlebars Helpers Reference
  • Frontmatter: Adding Data to Page Context
  • Frontmatter Reference with GraphQL Queries
  • Catalog Price Object Examples
  • Customizing Template JavaScript
  • Adding Additional JavaScript
  • Enable PayPal Smart Buttons
  • Add Wallet Buttons to Product Pages
  • Add Stored Payment Methods
  • Performance Optimization
  • Using Early Hints
  • Checking a Theme's Size
  • Uploading a Theme
  • Upload Errors
  • Updates and Version Control
  • Theme Metadata: Images
  • Page Builder
  • Third-party Widgets
  • reCAPTCHA Support
  • B2B Edition for Stencil
  • Overview
  • Installation
  • Plugin Settings
  • Multi-site Setup
  • Features
  • Proxy REST API Endpoints
  • Product Import
  • Multi-channel Capabilities
  • App Compatibility
  • Plugin Code Reference
  • Unexpected Behavior
  • Enabling AMP (Deprecated)
  • Guide
  • Launch Checklist
  • Creating Reliable Cron Jobs
  • Gutenberg Support
  • Shortcodes
  • Introduction to Headless Commerce
  • REST Management API: Headless Checkout Flow
  • GraphQL Storefront API: Headless Checkout Flow
  • Session Syncing: Headless Checkout
  • Creating Channels
  • Working with Products
  • Faceted and Textual Search
  • Managing Carts
  • Recovering Abandoned Carts
  • Creating Checkouts
  • Orders
  • Customers
  • PCI Compliance
  • Routes
  • Using API Site Content
  • Customer Login
  • Current Customer
  • Passwordless Login
  • Overview
  • Authentication
  • Best Practices
  • Analytics
  • B2B
  • Customers
  • Inventory Settings
  • Inventory Queries
  • Locations Settings
  • Locations Queries
  • Orders
  • Example Queries
  • Products
  • Variants
  • Product Reviews
  • Multi-Language Support
  • Storefront Scripts
  • Getting Started
  • Products overview
  • Contextual filters
  • Overview
  • Product basic information
  • Product SEO information
  • Product variant options
  • Product modifier options
  • Product URL
  • Product attributes
  • Product custom fields
  • Product images
  • Inventory adjustments
  • Inventory locations
  • Backorders (Beta)
  • Price Lists
  • Calculations
  • Overview
  • Currency-Specific Promotions
  • Multi-Currency
  • API vs UI Features
  • Brand
  • Category
  • Customer
  • Order
  • Product
  • Shipping
  • Storewide
  • Using logical operators
  • Using multiple rules
  • Overview
  • Comparison of operations
  • Overview
  • Prepare Data
  • Test Data
  • Error Handling
  • Complete Migration
  • Delta Migration
  • Overview
  • GraphQL Storefront
  • REST Storefront
  • REST Management
  • Add to Cart URLs
  • Consignments
  • Localization
  • Metafields API Guides
  • Checkout URL
  • Optimized One-Page Checkout
  • Integrated Fastlane by PayPal
  • Integrating Google Pay Direct Pay
  • Overview
  • Guide
  • PCI Compliance Guide
  • Overview
  • Tutorial
  • Overview
  • Tutorial
  • Overview
  • Transactions API (Beta)
  • Stored Instruments API (Beta)
  • Overview
  • Refunds
  • Invoice Templates
  • Customers and Subscribers
  • Creating channel-specific customers
  • Overview
  • User Guide
  • Promotions API
  • Definitions and Relationships
  • FAQs
  • Store configuration
  • Locales configuration
  • Store logs
  • Data layer
  • Overview
  • How currencies work
  • Tax settings
  • Tax rates and zones
  • Tax properties
  • Tax customers
  • Overview
  • MSF International Enhancements
  • Shipper HQ
  • Editing packing slips
  • Overview
  • Global Email Object
  • Abandoned Cart
  • Abandoned Cart (Deprecated)
  • Account Details Changed
  • Account Reset Password
  • Combined Order Status
  • Create Account
  • Create Guest Account
  • Gift Certificate
  • Invoice
  • Order Message Notification
  • Order Ready for Pickup
  • Passwordless Login
  • Product Review
  • Return Confirmation
  • Return Status Change
  • Examples
  • Store Metafields
  • Reassign Metafields Owner
  • Overview
  • Products
  • Product Modifiers
  • Product Listings
  • Product Filters
  • Product URLs (Beta)
  • Customer Form Fields
  • Promotions
  • Address Form Fields
  • Checkout Settings
  • Shipping Methods
  • Tax Rates
  • Order Statuses
  • Locations
  • Payment Methods
  • Error Handling
  • Overview
  • API Guide
  • Overview
  • Localization
  • Schema
  • Alignment
  • Boolean
  • Box Model
  • Code
  • Color
  • Element Settings
  • Image Manager
  • Input
  • Number
  • Product ID
  • Product Image
  • Range
  • Regex Input
  • Select
  • Text
  • Typography
  • Visibility
  • Overview
  • Guide
  • Overview
  • Versioning
  • Global Regions
  • GraphQL Templates
  • Examples
  • Widget Builder
  • Scripts
  • Getting Started
  • Becoming a Partner
  • Introduction
  • Quick start
  • Types of apps
  • Building Catalyst-compatible apps and integrations
  • Beginning development
  • Managing apps in Dev Portal
  • Locating app IDs
  • Implementing OAuth
  • Handling callbacks
  • Supporting multiple users
  • Listening for events
  • Designing the UI
  • Creating install buttons
  • Following best practices
  • Approval requirements
  • Publishing apps
  • Overview
  • Guide
  • Glossary
  • Postman collection
  • Introduction
  • Quick start: Deploy to Heroku install flow
  • Step 1: Set up your local environment
  • Step 2: Connect your app to BigCommerce
  • Step 3: Integrate BigCommerce APIs and add a database
  • Step 4: Enhance the user experience with BigDesign
  • Overview
  • Example queries and mutations
  • Postman collection
  • Optimizing multi-storefront apps
  • Building for Catalyst
  • Introduction
  • Quick start
  • Building channel apps
  • Extending existing apps
  • Building storefront channels
  • Best practices
  • Approval requirements
  • Channels toolkit reference
  • Overview
  • Tutorial
  • HTTPS
  • Google Cloud Platform Pub/Sub Webhooks
  • Events
  • Channel events
  • Inventory and location events
  • B2B Edition events
  • 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
  • Storefront
  • Add to cart
  • Checkout
  • Orders
  • Frequently asked questions
  • Glossary
  • Analytics with BODL
  • Staging with Staging Pro
  • Order Management Systems
  • Enterprise Resource Planning
  • Product Information Management
  • Overview
  • Basics
  • Grammar
  • Mechanics
  • Interactions
  • Status Messages
  • Mobile
  • Localization
  • Glossary
  • Overview
  • B2B APIs
  • Authentication
  • Best Practices
  • Overview
  • Stencil
  • Headless
  • Overview
  • Stencil Themes (Legacy)
  • Stencil Theme Elements
  • Company Account Registration
  • Other Frameworks
  • Archive
  • Making Requests
  • Developer Portal
  • Developer Resources
  • Staying Current with Platform Changes
  • Stored Credit Card Management
  • Add Google Data Tags
  • Transitioning to Stencil
  • Next.js Commerce v1
  • Next.js Commerce v2
  • ReCAPTCHA v2
  • Anatomy of a Theme
  • Blueprint and Developer Mode
  • Theme Update Process
  • Style Editor
  • Product Filtering Toolkit
  • Template Syntax
  • Store-Wide Global Panels
  • Store-Wide Global Variables
  • Global Variables
  • LNG Variables
  • Email Templates
  • Checkout Styling
  • Layouts
  • Panels
  • Snippets
  • V2 vs V3
  • SKU
  • Videos
  • Product Rules
  • Product Reviews
  • Product Options
  • Product Images
  • Option Values
  • Option Set Options
  • Option Sets
  • Options
  • Custom Fields
  • Categories
  • Bulk Pricing Rules
  • Products
  • Brands
  • V2 API
  • Convert Country State
  • Get Company Addresses
  • Create A Company Address
  • Get A Company Address
  • Update A Company Address
  • Delete A Company Address
  • Create Company From CG
  • Get Company Basic Information
  • Update Company Basic Information
  • Delete Company With Related
  • Get BC Order Id List By Company Id
  • Get Company By CustomerId
  • Create Order Without CompanyID
  • Get Company Orders
  • Create An Order
  • Update Company Order With BC OrderId
  • Update BC Order's 'Company attribute'
  • Update B2BE User's Orders' company attribute.
  • Get Orders Images
  • Get Company By BC OrderId
  • Get Company Id By Order Id
  • Get Order Detail
  • Get Order Product
  • Get Company Payments Methods
  • Update Company Payments Methods
  • Get Store's All Payments
  • Get Company Sales Reps
  • Update Company Sales reps
  • Get Companies & Sales reps
  • Update A Company User
  • Get Company Users
  • Create A Company User
  • Update Company User
  • Bulk Create Company User
  • Get A Company User
  • Delete A Company User
  • Third party API proxy
  • Closed Beta Programs
  • Overview
  • API Reference
  • Get All Price Lists
  • Create a Price List
  • Get a Price List
  • Update a Price List
  • Overview
  • API Reference
  • List Extensions
  • Create Extension
  • Get Extension
  • Update Extension
  • Delete Extension
  • Overview
  • Overview
  • API Reference
  • Get Page Snapshot
  • Publish or Overwrite Page Content
  • API Documentation
  • Check List
  • Code Samples
  • Guiding Questions
  • Iterative Feature Development
  • API Reference
  • List Accounts
  • Create Account
  • Get Account
  • Update Account
  • Create Account with Set Password
  • Create Store
  • Get Store
  • Create Store Login URL
  • List Stores
  • Create Store Plan Change
  • Create Store Cancellation
  • Create Store Suspension
  • Create Store Reactivation
  • Get OAuth Token
  • Overview
  • Getting Started
  • Catalog Data
  • ML Models
  • Request Recommendations
  • Search
  • Shopper Events
  • Stencil Headless Catalyst
  • API Reference
  • Update Google Vertex Ai Settings
  • Delete Google Vertex Ai Settings
  • Overview
  • HTTP Webhooks
  • AWS Webhooks
  • Postman Collection
Dev Portal
On this page
  • Other Resources

Archive

Deprecated
Deprecated Content

All content in Archived Docs is deprecated and no longer maintained. APIs, features, and integrations documented here may have been removed or replaced. For current documentation, see the Docs or API Reference section. For recent changes, see the Changelog.

Getting Started

Legacy API request tutorials, Developer Portal overview, and partner resources.

Storefront

Archived Stencil features, Next.js Commerce integration guides, and legacy Blueprint theme documentation.

Store Operations

V2 Catalog API reference, including products, categories, brands, and options.

B2B Edition

Deprecated B2B Edition V2 API reference.

Other Resources

Catalog V3 versus Catalog V2

Learn how the Catalog V3 API differs from Catalog V2.

Catalog V2 API reference

Find all the relevant information about the Catalog V2 API.

Blueprint themes

Find answers to your questions about the (legacy) Blueprint base theme.

Blueprint Reference

Access template reference for the Blueprint theme engine.

Was this page helpful?
Previous

Other Frameworks

Next

Quick Start

Built with