Client
Table of Contents
- API_URI = 'https://api.bigcommerce.com/stores/%s/v3/'
- DEFAULT_BASE_URI = 'base_uri'
- DEFAULT_HANDLER = 'handler'
- DEFAULT_HEADERS = 'headers'
- HEADERS__AUTH_CLIENT = 'X-Auth-Client'
- HEADERS__AUTH_TOKEN = 'X-Auth-Token'
- __construct() : mixed
- cart() : CartsApi
- carts() : CartsApi
- catalog() : CatalogApi
- channel() : ChannelsApi
- channels() : ChannelsApi
- content() : WidgetsApi
- customers() : CustomersApi
- customTemplateAssociations() : CustomTemplateAssociationsApi
- getBaseUri() : string
- getRestClient() : Client
- order() : OrdersApi
- payments() : PaymentsProcessingApi
- priceList() : PriceListsApi
- priceLists() : PriceListsApi
- printDebug() : mixed
- printDebugLastRequest() : mixed
- redirects() : RedirectsApi
- script() : ScriptsApi
- scripts() : ScriptsApi
- setBaseUri() : mixed
- setRestClient() : void
- theme() : ThemesApi
- themes() : ThemesApi
- widgets() : WidgetsApi
Constants
API_URI
public
mixed
API_URI
= 'https://api.bigcommerce.com/stores/%s/v3/'
DEFAULT_BASE_URI
public
mixed
DEFAULT_BASE_URI
= 'base_uri'
DEFAULT_HANDLER
public
mixed
DEFAULT_HANDLER
= 'handler'
DEFAULT_HEADERS
public
mixed
DEFAULT_HEADERS
= 'headers'
HEADERS__AUTH_CLIENT
public
mixed
HEADERS__AUTH_CLIENT
= 'X-Auth-Client'
HEADERS__AUTH_TOKEN
public
mixed
HEADERS__AUTH_TOKEN
= 'X-Auth-Token'
Methods
__construct()
public
__construct(string $storeHash, string $clientId, string $accessToken[, Client|null $client = null ]) : mixed
Parameters
- $storeHash : string
- $clientId : string
- $accessToken : string
- $client : Client|null = null
Return values
mixed —cart()
public
cart(string $uuid) : CartsApi
Parameters
- $uuid : string
Return values
CartsApi —carts()
public
carts() : CartsApi
Return values
CartsApi —catalog()
public
catalog() : CatalogApi
Return values
CatalogApi —channel()
public
channel(int $id) : ChannelsApi
Parameters
- $id : int
Return values
ChannelsApi —channels()
public
channels() : ChannelsApi
Return values
ChannelsApi —content()
public
content() : WidgetsApi
Return values
WidgetsApi —customers()
public
customers() : CustomersApi
Return values
CustomersApi —customTemplateAssociations()
public
customTemplateAssociations() : CustomTemplateAssociationsApi
Return values
CustomTemplateAssociationsApi —getBaseUri()
public
getBaseUri() : string
Return values
string —getRestClient()
public
getRestClient() : Client
Return values
Client —order()
public
order(int $orderId) : OrdersApi
Parameters
- $orderId : int
Return values
OrdersApi —payments()
public
payments() : PaymentsProcessingApi
Return values
PaymentsProcessingApi —priceList()
public
priceList(int $priceListId) : PriceListsApi
Parameters
- $priceListId : int
Return values
PriceListsApi —priceLists()
public
priceLists() : PriceListsApi
Return values
PriceListsApi —printDebug()
public
printDebug() : mixed
Return values
mixed —printDebugLastRequest()
public
printDebugLastRequest() : mixed
Return values
mixed —redirects()
public
redirects() : RedirectsApi
Return values
RedirectsApi —script()
public
script(string $uuid) : ScriptsApi
Parameters
- $uuid : string
Return values
ScriptsApi —scripts()
public
scripts() : ScriptsApi
Return values
ScriptsApi —setBaseUri()
public
setBaseUri(string $baseUri) : mixed
Parameters
- $baseUri : string
Return values
mixed —setRestClient()
public
setRestClient(Client $client) : void
Parameters
- $client : Client
Return values
void —theme()
public
theme(string $uuid) : ThemesApi
Parameters
- $uuid : string
Return values
ThemesApi —themes()
public
themes() : ThemesApi
Return values
ThemesApi —widgets()
public
widgets() : WidgetsApi