VariantsApi 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 = 'variants'
- VARIANT_ENDPOINT = 'catalog/products/%d/variants/%d'
- VARIANTS_ENDPOINT = 'catalog/products/%d/variants'
- __construct() : mixed
- create() : ProductVariantResponse
- get() : ProductVariantResponse
- getAll() : ProductVariantsResponse
- getClient() : Client
- getParentResourceId() : int|null
- getResourceId() : int|null
- metafield() : ProductVariantMetafieldsApi
- metafields() : ProductVariantMetafieldsApi
- update() : ProductVariantResponse
Constants
RESOURCE_NAME
public
mixed
RESOURCE_NAME
= 'variants'
VARIANT_ENDPOINT
public
mixed
VARIANT_ENDPOINT
= 'catalog/products/%d/variants/%d'
VARIANTS_ENDPOINT
public
mixed
VARIANTS_ENDPOINT
= 'catalog/products/%d/variants'
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(ProductVariant $productVariant) : ProductVariantResponse
Parameters
- $productVariant : ProductVariant
Return values
ProductVariantResponse —get()
public
get() : ProductVariantResponse
Return values
ProductVariantResponse —getAll()
public
getAll([array<string|int, mixed> $filters = [] ][, int $page = 1 ][, int $limit = 250 ]) : ProductVariantsResponse
Parameters
- $filters : array<string|int, mixed> = []
- $page : int = 1
- $limit : int = 250
Return values
ProductVariantsResponse —getClient()
public
getClient() : Client
Return values
Client —getParentResourceId()
public
getParentResourceId() : int|null
Return values
int|null —getResourceId()
public
getResourceId() : int|null
Return values
int|null —metafield()
public
metafield([int $metafieldId = null ]) : ProductVariantMetafieldsApi
Parameters
- $metafieldId : int = null
Return values
ProductVariantMetafieldsApi —metafields()
public
metafields() : ProductVariantMetafieldsApi
Return values
ProductVariantMetafieldsApi —update()
public
update(ProductVariant $productVariant) : ProductVariantResponse
Parameters
- $productVariant : ProductVariant