Manage products, brands and categories. To learn more about catalog resources see Catalog Overview. - Authentication - Differentiating Variants & Modifiers - Available Endpoints - Resources ## Authentication Requests can be authenticated by sending an access_token via X-Auth-Token HTTP header: http GET /stores/{$$.env.store_hash}/v3/catalog/summary host: api.bigcommerce.com Accept: application/json X-Auth-Token: {access_token} |Header|Parameter|Description| |-|-|-| |X-Auth-Token|access_token |Obtained by creating an API account or installing an app in a BigCommerce control panel.| ### OAuth Scopes | UI Name | Permission | Parameter | |----------|------------|-------------------------------| | Products | modify | store_v2_products | | Products | read-only | store_v2_products_read_only | For more information on OAuth Scopes, see: Authentication. For more information on Authenticating BigCommerce APIs, see: Authentication. ## Differentiating Variants and Modifiers Variants represent a physical product made up of Product Option choices, i.e. a large blue t-shirt. Each variant can have a unique SKU. Modifiers represent a choice a customer makes about a product that doesn't represent a physical item, i.e. text to be printed on a t-shirt. Assigning a SKU to a modifier will turn it into a variant. See Variant Options and Modifier Options for more information. ## Available Endpoints | Resource / Endpoint | Description | |-----------------------------------------|-------------------------------------------------------------------------| | Brand Images | Create and manage brand images | | Brand Metafields | Create and manage brand metafields | | Brands | Create and manage brands | | Catalog | Create and manage store categories, products, and brands | | Categories | Create and manage categorties | | Category Images | Create and manage category images | | Category Metafields | Create and manage category metafields | | Product Bulk Pricing Rules | Create and manage product bulk pricing rules | | Product Complex Rules | Create and manage product complex rules | | Product Custom Fields | Create and manage product custom fields | | Product Images | Create and manage product images | | Product Metafields | Create and manage product meta fields | | Product Modifier Images | Create and manage product modifer images | | Product Modifier Values | Create and manage product modifier values | | Product Modifiers | Create and manage product midifiers | | Product Reviews | Create and manage product reviews | | Product Variant Option Values | Create and manage product variant option values | | Product Variant Options | Create and manage product variant options | | Product Variants | Create and manage product variants | | Product Videos | Create and manage product videos | | Products | Create and manage products | | ProductVariant Metafields | Create and manage product meta flields | | Variants | Get and update all variants | ## Resources ### Webhooks * Products * Categories * SKU ### Related Endpoints * Catalog API

This PHP package is automatically generated by the Swagger Codegen project:

• API version:
• Build package: io.swagger.codegen.languages.PhpClientCodegen For more information, please visit

PHP 5.5 and later

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
    }
  ],
  "require": {
    "GIT_USER_ID/GIT_REPO_ID": "*@dev"
  }
}

Then run composer install

Download the files and include autoload.php:

    require_once('/path/to/SwaggerClient-php/vendor/autoload.php');

To run the unit tests:

composer install
./vendor/bin/phpunit

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: X-Auth-Token
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');

$apiInstance = new Swagger\Client\Api\BrandImagesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$brand_id = 56; // int | The ID of the `Brand` to which the resource belongs.
$accept = "application/json"; // string | 
$content_type = "application/json"; // string | 
$image_file = "/path/to/file.txt"; // \SplFileObject | 

try {
    $result = $apiInstance->createBrandImage($brand_id, $accept, $content_type, $image_file);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BrandImagesApi->createBrandImage: ', $e->getMessage(), PHP_EOL;
}

?>

All URIs are relative to https://api.bigcommerce.com/stores/{$$.env.store_hash}/v3

• Adjuster
• AdjusterFull
• AdjustersFull
• AdjustersFullPurchasingDisabled
• Brand
• Brand1
• Brand2
• BrandCollectionResponse
• BrandFull
• BrandResponse
• BrandResponse1
• BulkPricingRule
• BulkPricingRuleFull
• CatalogSummary
• CatalogSummaryFull
• CatalogSummaryResponse
• CategoriesTreeNodeFull
• CategoriesTreeResp
• Category
• Category1
• Category2
• CategoryBase
• CategoryFull
• CategoryResponse
• CategoryResponse1
• CollectionMeta
• ComplexRule
• ComplexRule1
• ComplexRule2
• ComplexRuleBase
• ComplexRuleCollectionResponse
• ComplexRuleCondition
• ComplexRuleConditionBase
• ConfigFull
• CustomField
• CustomField1
• CustomField2
• CustomUrlBrand
• CustomUrlCategory
• CustomUrlFull
• DetailedErrors
• ErrorBase
• ErrorNoContent
• ErrorNotFound
• ErrorResponse
• ErrorResponseFull
• GiftCertificateFull
• ImageResponse
• InlineResponse200
• InlineResponse2001
• InlineResponse2002
• InlineResponse2003
• InlineResponse2004
• InlineResponse2005
• InlineResponse2006
• InlineResponse2007
• InlineResponse2008
• InlineResponse2008Data
• Meta
• MetaCollectionFull
• MetaEmptyFull
• MetaFieldCollectionResponse
• MetaFieldCollectionResponse1
• Metafield
• MetafieldBase
• MetafieldFull
• MetafieldPost
• MetafieldPut
• MetafieldResponse
• MetafieldResponse1
• MetafieldResponse2
• MetafieldResponse3
• Modifer
• ModifierCollectionResponse
• ModifierResponse
• ModifierResponse1
• ModifierValue
• ModifierValueCollectionResponse
• ModifierValueResponse
• ModifierValueResponse1
• NotFound
• OptionCollectionResponse
• OptionConfig
• OptionResponse
• OptionValueCollectionResponse
• Pagination
• PaginationFull
• PaginationLinks
• ProductBase
• ProductCustomFieldBase
• ProductCustomFieldPost
• ProductCustomFieldPut
• ProductFull
• ProductImage
• ProductImageBase
• ProductImageCollectionResponse
• ProductImageFull
• ProductImagePost
• ProductImagePut
• ProductImageResponse
• ProductImageResponse1
• ProductModifierBase
• ProductModifierFull
• ProductModifierOptionValueBase
• ProductModifierOptionValueFull
• ProductModifierOptionValuePost
• ProductModifierOptionValuePut
• ProductModifierPost
• ProductModifierPut
• ProductOptionBase
• ProductOptionConfigFull
• ProductOptionFull
• ProductOptionOptionValueBase
• ProductOptionOptionValueFull
• ProductOptionPost
• ProductOptionPut
• ProductOptionValuePost
• ProductOptionValuePostProduct
• ProductOptionValuePut
• ProductPost
• ProductPut
• ProductPutCollection
• ProductResponse
• ProductReview
• ProductReviewBase
• ProductReviewCollectionResponse
• ProductReviewFull
• ProductReviewPost
• ProductReviewPut
• ProductReviewResponse
• ProductVariantBase
• ProductVariantFull
• ProductVariantOptionValueBase
• ProductVariantOptionValueFull
• ProductVariantOptionValuePost
• ProductVariantPost
• ProductVariantPostProduct
• ProductVariantPut
• ProductVariantPutProduct
• ProductVideo
• ProductVideoBase
• ProductVideoCollectionResponse
• ProductVideoFull
• ProductVideoPost
• ProductVideoPut
• ProductVideoResponse
• ProductVideoResponse1
• ResourceImage
• ResourceImage1
• ResourceImageFull
• RespProductImage
• RespProductOptionValue
• RespProductionOption
• RespVariantBatchError
• VariantBase
• VariantCollectionPut
• VariantCollectionResponse
• VariantCollectionResponse1
• VariantCollectionResponse2
• VariantPut
• VariantResponse
• VariantResponse1
• VariantsBatchErrorResponse

• Type: API key
• API key parameter name: X-Auth-Token
• Location: HTTP header