CategoryMetafieldsApi
extends ResourceApi
in package
Category Metafields API
Usage:
$api = new BigCommerce\ApiV3\Client($_ENV['hash'], $_ENV['CLIENT_ID'], $_ENV['ACCESS_TOKEN']);
// Get All Metafields
$metafields = $api->catalog()->category(1)->metafields();
// Delete a single Metafield
$api->catalog()->category(1)->metafield($metafields[0]->id)->delete();
Tags
Table of Contents
- __construct() : mixed
- create() : CategoryMetafieldResponse
- delete() : ResponseInterface
- get() : CategoryMetafieldResponse
- getAll() : CategoryMetafieldsResponse
- getClient() : Client
- getParentResourceId() : int|null
- getResourceId() : int|null
- multipleResourceUrl() : string
- singleResourceUrl() : string
- update() : CategoryMetafieldResponse
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
Tags
Return values
mixed —create()
public
create(CategoryMetafield $categoryMetafield) : CategoryMetafieldResponse
Parameters
- $categoryMetafield : CategoryMetafield
Tags
Return values
CategoryMetafieldResponse —delete()
public
delete() : ResponseInterface
Tags
Return values
ResponseInterface —get()
public
get() : CategoryMetafieldResponse
Tags
Return values
CategoryMetafieldResponse —getAll()
public
getAll([array<string|int, mixed> $filters = [] ][, int $page = 1 ][, int $limit = 250 ]) : CategoryMetafieldsResponse
Parameters
- $filters : array<string|int, mixed> = []
- $page : int = 1
- $limit : int = 250
Tags
Return values
CategoryMetafieldsResponse —getClient()
public
getClient() : Client
Tags
Return values
Client —getParentResourceId()
public
getParentResourceId() : int|null
Tags
Return values
int|null —getResourceId()
public
getResourceId() : int|null
Tags
Return values
int|null —multipleResourceUrl()
public
abstract multipleResourceUrl() : string
Tags
Return values
string —singleResourceUrl()
public
abstract singleResourceUrl() : string
Tags
Return values
string —update()
public
update(CategoryMetafield $categoryMetafield) : CategoryMetafieldResponse
Parameters
- $categoryMetafield : CategoryMetafield