CategoryImageApi extends ResourceImageApi
Category Images API
Usage (creating an image for Category with ID of 1):
$api = new BigCommerce\ApiV3\Client($_ENV['hash'], $_ENV['CLIENT_ID'], $_ENV['ACCESS_TOKEN']);
$api->catalog()->category(1)->image()->create('/path/to/image.png');
Tags
Table of Contents
- CATEGORY_IMAGE_ENDPOINT = 'catalog/categories/%d/image'
- __construct() : mixed
- get() : SingleResourceResponse
- getAll() : PaginatedResponse
- getClient() : Client
- getParentResourceId() : int|null
- getResourceId() : int|null
Constants
CATEGORY_IMAGE_ENDPOINT
public
mixed
CATEGORY_IMAGE_ENDPOINT
= 'catalog/categories/%d/image'
Methods
__construct()
public
__construct(Client $client[, int|null $resourceId = null ][, int|null $parentResourceId = null ]) : mixed
Parameters
- $client : Client
- $resourceId : int|null = null
- $parentResourceId : int|null = null
Return values
mixed —get()
public
abstract get() : SingleResourceResponse
Return values
SingleResourceResponse —getAll()
public
abstract getAll([array<string|int, mixed> $filters = [] ][, int $page = 1 ][, int $limit = 250 ]) : PaginatedResponse
Parameters
- $filters : array<string|int, mixed> = []
- $page : int = 1
- $limit : int = 250
Return values
PaginatedResponse —getClient()
public
getClient() : Client
Return values
Client —getParentResourceId()
public
getParentResourceId() : int|null
Return values
int|null —getResourceId()
public
getResourceId() : int|null