dotConnect for BigCommerce Documentation
Devart.Data.Bigcommerce Namespace / BigcommerceConnectionStringBuilder Class / APIVersion Property

In This Topic
    APIVersion Property
    In This Topic
    Gets or sets the BigCommerce API version to use.
    Syntax
    'Declaration
     
    Public Property APIVersion As APIVersion
    public APIVersion APIVersion {get; set;}

    Property Value

    One of the APIVersion values.
    Remarks

    Note that BigCommerce API v3 does not support all the BigCommerce objects. Even if you use APIVersion.v3 in your connection, access to some objects is still performed via API v2. Besides the lists of objects and their structure is different for BigCommerce API v2 and API v3. The main differences are connected with objects, storing data about products, their variants, options, prices, brands, etc. Here is the list of objects, supported by BigCommerce API v3:

    • Brands
    • Categories
    • ProductsBulkPricingRules
    • ProductCustomFields
    • ProductImages
    • ProductReviews
    • ProductComplexRules
    • ComplexRulesCondition
    • Products
    • ProductVariants
    • ProductVideos
    • ProductVariantOptionValues
    • ProductVariantOptions
    • VariantOptionValues
    • BrandMetafields
    • CategoryMetafields
    • ProductMetafields
    • ProductVariantMetafields
    • PriceLists
    • PriceListRecords
    • ProductModifiers
    • ProductModifiersValues
    • CatalogSummary

    Here is the list of objects with the corresponding data, available via API v2 connections:

    • Brands
    • Categories
    • ProductsBulkPricingRules
    • ProductCustomFields
    • ProductImages
    • ProductReviews
    • ProductRules
    • Products
    • ProductSkus
    • ProductVideos
    • OptionSets
    • Options
    • OptionSetsOptions
    • OptionValues
    • ProductOptions
    • ProductConfigurableFields
    • ProductGoogleProductSearch

    All the other objects are always accessed via API v2, and are the same in both API v2 and API v3 connections.

    You can find more information about API version differences in BigCommerce documentation.

    Requirements

    Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

    See Also