ProductOptionValuesApi
extends ResourceApi
in package
Referred to in the documentation as Product Variant Options Values
https://developer.bigcommerce.com/api-reference/store-management/catalog/product-variant-option-values/createoptionvalue
Tags
Table of Contents
- RESOURCE_NAME = 'values'
- VALUE_ENDPOINT = 'catalog/products/%d/options/%d/values/%d'
- VALUES_ENDPOINT = 'catalog/products/%d/options/%d/values'
- __construct() : mixed
- create() : ProductOptionValueResponse
- delete() : ResponseInterface
- get() : ProductOptionValueResponse
- getAll() : ProductOptionValuesResponse
- getClient() : Client
- getParentResourceId() : int|null
- getProductId() : int
- getResourceId() : int|null
- multipleResourceUrl() : string
- setProductId() : void
- singleResourceUrl() : string
- update() : ProductOptionValueResponse
Constants
RESOURCE_NAME
public
mixed
RESOURCE_NAME
= 'values'
Tags
VALUE_ENDPOINT
public
mixed
VALUE_ENDPOINT
= 'catalog/products/%d/options/%d/values/%d'
Tags
VALUES_ENDPOINT
public
mixed
VALUES_ENDPOINT
= 'catalog/products/%d/options/%d/values'
Tags
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(ProductOptionValue $optionValue) : ProductOptionValueResponse
Parameters
- $optionValue : ProductOptionValue
Tags
Return values
ProductOptionValueResponse —delete()
public
delete() : ResponseInterface
Tags
Return values
ResponseInterface —get()
public
get() : ProductOptionValueResponse
Tags
Return values
ProductOptionValueResponse —getAll()
public
getAll([array<string|int, mixed> $filters = [] ][, int $page = 1 ][, int $limit = 250 ]) : ProductOptionValuesResponse
Parameters
- $filters : array<string|int, mixed> = []
- $page : int = 1
- $limit : int = 250
Tags
Return values
ProductOptionValuesResponse —getClient()
public
getClient() : Client
Tags
Return values
Client —getParentResourceId()
public
getParentResourceId() : int|null
Tags
Return values
int|null —getProductId()
public
getProductId() : int
Tags
Return values
int —getResourceId()
public
getResourceId() : int|null
Tags
Return values
int|null —multipleResourceUrl()
public
abstract multipleResourceUrl() : string
Tags
Return values
string —setProductId()
public
setProductId(int $productId) : void
Parameters
- $productId : int
Tags
Return values
void —singleResourceUrl()
public
abstract singleResourceUrl() : string
Tags
Return values
string —update()
public
update(ProductOptionValue $optionValue) : ProductOptionValueResponse
Parameters
- $optionValue : ProductOptionValue