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).
For reference on the individual resources and the schema of the objects, please visit developer.bigcommerce.com.
Public apps (also known as Single-Click Apps) must use OAuth authentication.
To develop a custom integration for one store, your app needs to use Basic Authentication.
A content entry in the store’s blog
Index of tags used on the store’s blog.
A 301 redirect, mapping from a given URL path to another URL
Identity and account details for customers shopping on Bigcommerce stores
Postal address belonging to a Customer
Grouping of customers who share the same level of access and discounts at a store
A country or territory, identifiable by an ISO 3166 country code
A state or province, identifiable by an ISO 3166 subdivision code
Applies a category or product discount to an order for customers who enter a given code
The order object contains a record of the purchase agreement between a shopper and a merchant.
Coupon code applied to an order
Messages associated with an order.
Product line items associated with an order.
Shipping addresses associated with an order.
Statuses that can be assigned to orders. Each status represents a state in the fulfilment workflow.
Taxes applied to an order.
Shipping package consignments tracked from an order.
Enabled payment methods.
Brand facets for identifying and categorising products according to their manufacturer or company metonym.
Bulk pricing rules applied to a product.
Index of hierarchical categories used to organise and group products.
Configurable fields associated with a product.
Custom fields associated with a product.
Custom fields associated with a product.
Shared attributes that control value facets on a product.
A reusable set of option facets that can be applied to products.
Options belonging to an option set.
Values that can be selected for an option.
Catalog of saleable items in the store.
Images associated with a product.
Options associated directly with a product.
Reviews associated to a product.
Rules that modify the default behaviour of products.
Embedded videos displayed on product listings.
Stock Keeping Unit identifiers associated with products.
List of enabled shipping methods.
Metadata that describes the store.
Timestamp ping to check the system status.
Applies a category or product discount to an order for customers who enter a given code
Applies a category or product discount to an order for customers who enter a given code
All the errors we will throw with a convenient method to rescue the errors and take an action for each type