ProductModifierValuesApi extends ResourceApi
V3ApiBase
Add constructors and some basic scaffolding that will work for all API classes regardless of which endpoints they implement
Table of Contents
- RESOURCE_NAME = 'values'
- VALUE_ENDPOINT = 'catalog/products/%d/modifiers/%d/values/%d'
- VALUES_ENDPOINT = 'catalog/products/%d/modifiers/%d/values'
- __construct() : mixed
- create() : ProductModifierValueResponse
- get() : ProductModifierValueResponse
- getAll() : ProductModifierValuesResponse
- getClient() : Client
- getParentResourceId() : int|null
- getProductId() : int
- getResourceId() : int|null
- setProductId() : void
- update() : ProductModifierValueResponse
Constants
RESOURCE_NAME
public
mixed
RESOURCE_NAME
= 'values'
VALUE_ENDPOINT
public
mixed
VALUE_ENDPOINT
= 'catalog/products/%d/modifiers/%d/values/%d'
VALUES_ENDPOINT
public
mixed
VALUES_ENDPOINT
= 'catalog/products/%d/modifiers/%d/values'
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 —create()
public
create(ProductModifierValue $modifierValue) : ProductModifierValueResponse
Parameters
- $modifierValue : ProductModifierValue
Return values
ProductModifierValueResponse —get()
public
get() : ProductModifierValueResponse
Return values
ProductModifierValueResponse —getAll()
public
getAll([array<string|int, mixed> $filters = [] ][, int $page = 1 ][, int $limit = 250 ]) : ProductModifierValuesResponse
Parameters
- $filters : array<string|int, mixed> = []
- $page : int = 1
- $limit : int = 250
Return values
ProductModifierValuesResponse —getClient()
public
getClient() : Client
Return values
Client —getParentResourceId()
public
getParentResourceId() : int|null
Return values
int|null —getProductId()
public
getProductId() : int
Return values
int —getResourceId()
public
getResourceId() : int|null
Return values
int|null —setProductId()
public
setProductId(int $productId) : void
Parameters
- $productId : int
Return values
void —update()
public
update(ProductModifierValue $modifierValue) : ProductModifierValueResponse
Parameters
- $modifierValue : ProductModifierValue