Documentation

Client extends BaseApiClient
in package

The parent API class

Usage Examples

Trivial example of updating a product name:

$api = new BigCommerce\ApiV3\Client($_ENV['hash'], $_ENV['CLIENT_ID'], $_ENV['ACCESS_TOKEN']);

$product = $api->catalog()->product(123)->get()->getProduct();
$product->name = 'Updated product name';
try {
    $api->catalog()->product($product->id)->update($product);
} catch (\Psr\Http\Client\ClientExceptionInterface $exception) {
    echo "Unable to update product: {$exception->getMessage()}";
}

Fetching all visible products (all pages of products):

$api = new BigCommerce\ApiV3\Client($_ENV['hash'], $_ENV['CLIENT_ID'], $_ENV['ACCESS_TOKEN']);

$productsResponse = $api->catalog()->products()->getAllPages(['is_visible' => true]);

echo "Found {$productsResponse->getPagination()->total} products";

$products = $productsResponse->getProducts();

Example of updating a product variant

$api = new BigCommerce\ApiV3\Client($_ENV['hash'], $_ENV['CLIENT_ID'], $_ENV['ACCESS_TOKEN']);

$productVariant = $api->catalog()->product(123)->variant(456)->get()->getProductVariant();
$productVariant->price = '12';

try {
    $api->catalog()->product($productVariant->product_id)->variant($productVariant->id)->update($productVariant);
} catch (\Psr\Http\Client\ClientExceptionInterface $exception) {
    echo "Unable to update product variant: {$exception->getMessage()}";
}

Example of creating a product variant

$api = new BigCommerce\ApiV3\Client($_ENV['hash'], $_ENV['CLIENT_ID'], $_ENV['ACCESS_TOKEN']);

$productVariant = new \BigCommerce\ApiV3\ResourceModels\Catalog\Product\ProductVariant();
$productVariant->product_id = 123;
$productVariant->sku = "SKU-123";
//...

try {
    $api->catalog()->product($productVariant->product_id)->variants()->create($productVariant);
} catch (\Psr\Http\Client\ClientExceptionInterface $exception) {
    echo "Unable to create product variant: {$exception->getMessage()}";
}
Tags

Table of Contents

API_URI  = 'https://api.bigcommerce.com/stores/%s/v3/'
DEFAULT_BASE_URI  = 'base_uri'
DEFAULT_HANDLER  = 'handler'
DEFAULT_HEADERS  = 'headers'
DEFAULT_TIMEOUT  = 'timeout'
__construct()  : mixed
cart()  : CartsApi
carts()  : CartsApi
catalog()  : CatalogApi
channel()  : ChannelsApi
channels()  : ChannelsApi
content()  : WidgetsApi
customer()  : CustomersApi
customers()  : CustomersApi
customTemplateAssociations()  : CustomTemplateAssociationsApi
getBaseUri()  : string
getDebugContainer()  : array<string|int, mixed>
getRestClient()  : Client
order()  : OrdersApi
page()  : PagesApi
pages()  : PagesApi
payments()  : PaymentsProcessingApi
priceList()  : PriceListsApi
priceLists()  : PriceListsApi
printDebug()  : mixed
printDebugLastRequest()  : mixed
redirects()  : RedirectsApi
script()  : ScriptsApi
scripts()  : ScriptsApi
setBaseUri()  : mixed
setRestClient()  : void
site()  : SitesApi
sites()  : SitesApi
storeLogs()  : StoreLogsApi
theme()  : ThemesApi
themes()  : ThemesApi
widgets()  : WidgetsApi
wishlist()  : WishlistsApi
wishlists()  : WishlistsApi

Constants

API_URI

public mixed API_URI = 'https://api.bigcommerce.com/stores/%s/v3/'
Tags

DEFAULT_BASE_URI

public mixed DEFAULT_BASE_URI = 'base_uri'
Tags

DEFAULT_HANDLER

public mixed DEFAULT_HANDLER = 'handler'
Tags

DEFAULT_HEADERS

public mixed DEFAULT_HEADERS = 'headers'
Tags

DEFAULT_TIMEOUT

public mixed DEFAULT_TIMEOUT = 'timeout'
Tags

Methods

__construct()

public __construct(string $storeHash, string $clientId, string $accessToken[, Client|null $client = null ][, array<string|int, mixed>|null $clientOptions = [] ]) : mixed
Parameters
$storeHash : string
$clientId : string
$accessToken : string
$client : Client|null = null
$clientOptions : array<string|int, mixed>|null = []
Tags
Return values
mixed —

getBaseUri()

public getBaseUri() : string
Tags
Return values
string —

getDebugContainer()

public getDebugContainer() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —

getRestClient()

public getRestClient() : Client
Tags
Return values
Client —

printDebug()

public printDebug() : mixed
Tags
Return values
mixed —

printDebugLastRequest()

public printDebugLastRequest() : mixed
Tags
Return values
mixed —

setBaseUri()

public setBaseUri(string $baseUri) : mixed
Parameters
$baseUri : string
Tags
Return values
mixed —

setRestClient()

public setRestClient(Client $client) : void
Parameters
$client : Client
Tags
Return values
void — 

        

        
    




    

    

                

    

        

            
Search results