In this directory you can find examples which you may find helpful to reference in development. If you have some useful snippets, please feel free to open a PR into the appropriate file(s).
Resource Reference
For reference on the individual resources and the schema of the objects, please visit developer.bigcommerce.com.
Configuration
Private Apps
Public apps (also known as Single-Click Apps) must use OAuth authentication.
Public Apps
To develop a custom integration for one store, your app needs to use Basic Authentication.
Content
Blog Posts
A content entry in the store’s blog
Blog Tags
Index of tags used on the store’s blog.
Redirects
A 301 redirect, mapping from a given URL path to another URL
Customers
Customers
Identity and account details for customers shopping on Bigcommerce stores
Customer Addresses
Postal address belonging to a Customer
Customer Groups
Grouping of customers who share the same level of access and discounts at a store
Geography
Countries
A country or territory, identifiable by an ISO 3166 country code
States
A state or province, identifiable by an ISO 3166 subdivision code
Marketing
Coupons
Applies a category or product discount to an order for customers who enter a given code
Orders
Orders
The order object contains a record of the purchase agreement between a shopper and a merchant.
Order Coupons
Coupon code applied to an order
Order Messages
Messages associated with an order.
Order Products
Product line items associated with an order.
Order Shipping Addresses
Shipping addresses associated with an order.
Order Statuses
Statuses that can be assigned to orders. Each status represents a state in the fulfilment workflow.
Order Taxes
Taxes applied to an order.
Shipments
Shipping package consignments tracked from an order.
Payments
Payment Methods
Enabled payment methods.
Products
Brands
Brand facets for identifying and categorising products according to their manufacturer or company metonym.
Bulk Pricing Rules
Bulk pricing rules applied to a product.
Categories
Index of hierarchical categories used to organise and group products.
Configurable Fields
Configurable fields associated with a product.
Custom Fields
Custom fields associated with a product.
Google Product Search Mappings
Custom fields associated with a product.
Options
Shared attributes that control value facets on a product.
Option Sets
A reusable set of option facets that can be applied to products.
Option Set Options
Options belonging to an option set.
Option Values
Values that can be selected for an option.
Products
Catalog of saleable items in the store.
Product Images
Images associated with a product.
Product Options
Options associated directly with a product.
Product Reviews
Reviews associated to a product.
Product Rules
Rules that modify the default behaviour of products.
Product Videos
Embedded videos displayed on product listings.
SKUs
Stock Keeping Unit identifiers associated with products.
Shipping
Shipping Methods
List of enabled shipping methods.
Store
Store Information
Metadata that describes the store.
System
Time
Timestamp ping to check the system status.
Tax
Tax Classes
Applies a category or product discount to an order for customers who enter a given code
Webhooks
Webhooks
Applies a category or product discount to an order for customers who enter a given code
Exception Handling
Exceptions
All the errors we will throw with a convenient method to rescue the errors and take an action for each type