ProductsApi
extends ResourceWithBatchUpdateApi
in package
Uses
ProductsSubResourceApi
V3ApiBase
Add constructors and some basic scaffolding that will work for all API classes regardless of which endpoints they implement
Tags
Table of Contents
- FILTER_EXCLUDE_FIELDS = 'exclude_fields'
- FILTER_INCLUDE = 'include'
- FILTER_INCLUDE_FIELDS = 'include_fields'
- FILTER_IS_FEATURED = 'is_featured'
- FILTER_IS_VISIBLE = 'is_visible'
- FILTER_SKU_IS = 'sku'
- INCLUDE_MODIFIERS = 'modifiers'
- PRODUCT_ENDPOINT = 'catalog/products/%d'
- PRODUCTS_ENDPOINT = 'catalog/products'
- RESOURCE_NAME = 'products'
- __construct() : mixed
- batchDelete() : bool
- batchUpdate() : ProductsResponse
- bulkPricingRule() : ProductBulkPricingRulesApi
- bulkPricingRules() : ProductBulkPricingRulesApi
- complexRule() : ComplexRulesApi
- complexRules() : ComplexRulesApi
- create() : ProductResponse
- customField() : CustomFieldsApi
- customFields() : CustomFieldsApi
- delete() : ResponseInterface
- get() : ProductResponse
- getAll() : ProductsResponse
- getAllPages() : ProductsResponse
- Get all product pages combined
- getClient() : Client
- getMaxRetries() : int
- getParentResourceId() : int|null
- getResourceId() : int|null
- image() : ProductImagesApi
- images() : ProductImagesApi
- metafield() : ProductMetafieldsApi
- metafields() : ProductMetafieldsApi
- modifier() : ModifiersApi
- modifiers() : ModifiersApi
- multipleResourceUrl() : string
- option() : OptionsApi
- options() : OptionsApi
- review() : ProductReviewsApi
- reviews() : ProductReviewsApi
- setMaxRetries() : void
- singleResourceUrl() : string
- update() : ProductResponse
- variant() : VariantsApi
- variants() : VariantsApi
- video() : ProductVideosApi
- videos() : ProductVideosApi
Constants
FILTER_EXCLUDE_FIELDS
public
mixed
FILTER_EXCLUDE_FIELDS
= 'exclude_fields'
Tags
FILTER_INCLUDE
public
mixed
FILTER_INCLUDE
= 'include'
Tags
FILTER_INCLUDE_FIELDS
public
mixed
FILTER_INCLUDE_FIELDS
= 'include_fields'
Tags
FILTER_IS_FEATURED
public
mixed
FILTER_IS_FEATURED
= 'is_featured'
Tags
FILTER_IS_VISIBLE
public
mixed
FILTER_IS_VISIBLE
= 'is_visible'
Tags
FILTER_SKU_IS
public
mixed
FILTER_SKU_IS
= 'sku'
Tags
INCLUDE_MODIFIERS
public
mixed
INCLUDE_MODIFIERS
= 'modifiers'
Tags
PRODUCT_ENDPOINT
public
mixed
PRODUCT_ENDPOINT
= 'catalog/products/%d'
Tags
PRODUCTS_ENDPOINT
public
mixed
PRODUCTS_ENDPOINT
= 'catalog/products'
Tags
RESOURCE_NAME
public
mixed
RESOURCE_NAME
= 'products'
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 —batchDelete()
public
batchDelete(array<string|int, mixed> $productIds) : bool
Parameters
- $productIds : array<string|int, mixed>
Tags
Return values
bool —batchUpdate()
public
batchUpdate(array<string|int, Product> $products) : ProductsResponse
Parameters
- $products : array<string|int, Product>
Tags
Return values
ProductsResponse —bulkPricingRule()
public
bulkPricingRule(int $ruleId) : ProductBulkPricingRulesApi
Parameters
- $ruleId : int
Tags
Return values
ProductBulkPricingRulesApi —bulkPricingRules()
public
bulkPricingRules() : ProductBulkPricingRulesApi
Tags
Return values
ProductBulkPricingRulesApi —complexRule()
public
complexRule(int $ruleId) : ComplexRulesApi
Parameters
- $ruleId : int
Tags
Return values
ComplexRulesApi —complexRules()
public
complexRules() : ComplexRulesApi
Tags
Return values
ComplexRulesApi —create()
public
create(Product $product) : ProductResponse
Parameters
- $product : Product
Tags
Return values
ProductResponse —customField()
public
customField(int $customFieldId) : CustomFieldsApi
Parameters
- $customFieldId : int
Tags
Return values
CustomFieldsApi —customFields()
public
customFields() : CustomFieldsApi
Tags
Return values
CustomFieldsApi —delete()
public
delete() : ResponseInterface
Tags
Return values
ResponseInterface —get()
public
get([string|null $include = null ][, array<string|int, mixed>|null $include_fields = null ][, array<string|int, mixed>|null $exclude_fields = null ]) : ProductResponse
Parameters
- $include : string|null = null
- $include_fields : array<string|int, mixed>|null = null
- $exclude_fields : array<string|int, mixed>|null = null
Tags
Return values
ProductResponse —getAll()
public
getAll([array<string|int, mixed> $filters = [] ][, int $page = 1 ][, int $limit = 250 ]) : ProductsResponse
Parameters
- $filters : array<string|int, mixed> = []
- $page : int = 1
- $limit : int = 250
Tags
Return values
ProductsResponse —getAllPages()
Get all product pages combined
public
getAllPages([array<string|int, mixed> $filter = [] ]) : ProductsResponse
Parameters
- $filter : array<string|int, mixed> = []
Tags
Return values
ProductsResponse —getClient()
public
getClient() : Client
Tags
Return values
Client —getMaxRetries()
public
getMaxRetries() : int
Tags
Return values
int —getParentResourceId()
public
getParentResourceId() : int|null
Tags
Return values
int|null —getResourceId()
public
getResourceId() : int|null
Tags
Return values
int|null —image()
public
image(int $imageId) : ProductImagesApi
Parameters
- $imageId : int
Tags
Return values
ProductImagesApi —images()
public
images() : ProductImagesApi
Tags
Return values
ProductImagesApi —metafield()
public
metafield(int $metafieldId) : ProductMetafieldsApi
Parameters
- $metafieldId : int
Tags
Return values
ProductMetafieldsApi —metafields()
public
metafields() : ProductMetafieldsApi
Tags
Return values
ProductMetafieldsApi —modifier()
public
modifier(int $modifierId) : ModifiersApi
Parameters
- $modifierId : int
Tags
Return values
ModifiersApi —modifiers()
public
modifiers() : ModifiersApi
Tags
Return values
ModifiersApi —multipleResourceUrl()
public
abstract multipleResourceUrl() : string
Tags
Return values
string —option()
public
option(int $optionId) : OptionsApi
Parameters
- $optionId : int
Tags
Return values
OptionsApi —options()
public
options() : OptionsApi
Tags
Return values
OptionsApi —review()
public
review(int $reviewId) : ProductReviewsApi
Parameters
- $reviewId : int
Tags
Return values
ProductReviewsApi —reviews()
public
reviews() : ProductReviewsApi
Tags
Return values
ProductReviewsApi —setMaxRetries()
public
setMaxRetries(int $maxRetries) : void
Parameters
- $maxRetries : int
Tags
Return values
void —singleResourceUrl()
public
abstract singleResourceUrl() : string
Tags
Return values
string —update()
public
update(Product $product) : ProductResponse
Parameters
- $product : Product
Tags
Return values
ProductResponse —variant()
public
variant(int $variantId) : VariantsApi
Parameters
- $variantId : int
Tags
Return values
VariantsApi —variants()
public
variants() : VariantsApi
Tags
Return values
VariantsApi —video()
public
video(int $videoId) : ProductVideosApi
Parameters
- $videoId : int
Tags
Return values
ProductVideosApi —videos()
public
videos() : ProductVideosApi