Documentation

V2ApiClient extends BaseApiClient
in package

Class for accessing BigCommerce V2 Endpoints

Currently only the Create Order endpoint is implement as it has no V3 equivalent.

The class is used similarly to the V3 client.

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

$order = new BigCommerce\ApiV2\ResourceModels\Order\Order();
// set order details...

try {
    $api->orders->create($order);
} catch (\Psr\Http\Client\ClientExceptionInterface $exception) {
    echo "Unable to update product: {$exception->getMessage()}";
}
Tags

Table of Contents

DEFAULT_BASE_URI  = 'base_uri'
DEFAULT_HANDLER  = 'handler'
DEFAULT_HEADERS  = 'headers'
DEFAULT_TIMEOUT  = 'timeout'
__construct()  : mixed
getBaseUri()  : string
getDebugContainer()  : array<string|int, mixed>
getRestClient()  : Client
order()  : OrdersApi
orders()  : OrdersApi
printDebug()  : mixed
printDebugLastRequest()  : mixed
setBaseUri()  : mixed
setRestClient()  : void
storeInformation()  : StoreInformationApi

Constants

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