module Bigcommerce

Blog Post Content entries in the store's blog. developer.bigcommerce.com/api/stores/v2/blog/posts

Blog Tag Index of tags used on the store's blog. developer.bigcommerce.com/api/stores/v2/blog/tags

Redirect Redirects are used to create custom URL paths that map to resources on the storefront (such as products, categories, brands, etc.) or manually defined static URLs. developer.bigcommerce.com/api/stores/v2/redirects

Customer Identity and account details for customers shopping at a Bigcommerce store. developer.bigcommerce.com/api/stores/v2/customers

Customer Address Postal addresses belonging to a customer. developer.bigcommerce.com/api/stores/v2/customers/addresses

Customer Group Groups of customers who share the same level of access and discounts at a store. developer.bigcommerce.com/api/stores/v2/customer_groups

Country Countries and territories, identified by their ISO 3166 country codes. developer.bigcommerce.com/api/stores/v2/countries

State States and subdivisions belonging to countries. developer.bigcommerce.com/api/stores/v2/countries/states

Banner HTML element on webpages to advertise discounts or other content relevant to shoppers. developer.bigcommerce.com/api/stores/v2/banners

Coupon Category or product discounts that can be applied to orders for customers who enter a given code. developer.bigcommerce.com/api/stores/v2/coupons

Gift Certificates Code that can be applied by customers to their order to provide full or partial payment. developer.bigcommerce.com/api/stores/v2/gift_certificates

Order Purchases from a store. developer.bigcommerce.com/api/stores/v2/orders

Order Coupon Coupons applied to an order. developer.bigcommerce.com/api/stores/v2/orders/coupons

Order Message Messages associated with an order. developer.bigcommerce.com/api/stores/v2/orders/messages

Order Product Product line items associated with an order. developer.bigcommerce.com/api/stores/v2/orders/products

Order Shipping Addresses Shipping addresses associated with an order. developer.bigcommerce.com/api/stores/v2/orders/shipping_addresses

Order Status Statuses that can be assigned to orders. Each status represents a state in the fulfilment workflow. developer.bigcommerce.com/api/stores/v2/order_statuses

Order Shipping Addresses Shipping addresses associated with an order. developer.bigcommerce.com/api/stores/v2/orders/shipping_addresses

Order Shipment Shipping package consignments tracked from an order. developer.bigcommerce.com/api/stores/v2/orders/shipments

Payment Method Enabled payment methods. developer.bigcommerce.com/api/stores/v2/payments/methods

Brand Brand facets for identifying and categorising products according to their manufacturer or company metonym. developer.bigcommerce.com/api/stores/v2/brands

Bulk Pricing Rule Bulk pricing rules applied to a product. developer.bigcommerce.com/api/stores/v2/products/discount_rules

Category Index of hierarchical categories used to organise and group products. developer.bigcommerce.com/api/stores/v2/categories

Configurable Field Configurable fields associated with a product. developer.bigcommerce.com/api/stores/v2/products/configurable_fields

Custom Field Custom fields associated with a product. developer.bigcommerce.com/api/stores/v2/products/custom_fields

Google Product Search Mapping Google Product Search mappings for a product. developer.bigcommerce.com/api/stores/v2/products/googleproductsearch

Option Shared attributes that control value facets on a product. developer.bigcommerce.com/api/stores/v2/options

Option Set A reusable set of option facets that can be applied to products. developer.bigcommerce.com/api/stores/v2/options_sets

Option Set Option Options belonging to an option set. developer.bigcommerce.com/api/stores/v2/option_sets/options

Option Value Values that can be selected for an option. developer.bigcommerce.com/api/stores/v2/options/values

Product Catalog of saleable items in the store. developer.bigcommerce.com/api/stores/v2/products

Product Image Images associated with a product. developer.bigcommerce.com/api/stores/v2/products/images

Product Option Options associated directly with a product. developer.bigcommerce.com/api/stores/v2/products/options

Product Review Options associated directly with a product. developer.bigcommerce.com/api/stores/v2/products/reviews

Product Rule Rules that modify the default behaviour of products. developer.bigcommerce.com/api/stores/v2/products/rules

Product Video Embedded videos displayed on product listings. developer.bigcommerce.com/api/stores/v2/products/videos

SKU Stock Keeping Unit identifiers associated with products. developer.bigcommerce.com/api/stores/v2/products/skus

Shipping Method List of enabled shipping methods. developer.bigcommerce.com/api/stores/v2/shipping/methods

Store Information Metadata that describes the store. developer.bigcommerce.com/api/stores/v2/store_information

Time Timestamp ping to check the system status. developer.bigcommerce.com/api/stores/v2/time

Tax Class Tax classes are used to apply different tax rates for specific types of products and orders. developer.bigcommerce.com/api/stores/v2/tax_classes

Webhook Register and manage webhooks that connect events from a store to external URLs. developer.bigcommerce.com/api/stores/v2/webhooks

Constants

VERSION

Attributes

api[R]
config[R]

Public Class Methods

configure() { |h| ... } click to toggle source
# File lib/bigcommerce.rb, line 17
def configure
  @config = Bigcommerce::Config.new.tap { |h| yield(h) }
  @api = Bigcommerce::Connection.build(@config)
end