Documentation

ProductsApi extends ResourceWithBatchUpdateApi

V3ApiBase

Add constructors and some basic scaffolding that will work for all API classes regardless of which endpoints they implement

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
create()  : ProductResponse
get()  : ProductResponse
getAll()  : ProductsResponse
getAllPages()  : ProductsResponse
Get all product pages combined
getClient()  : Client
getParentResourceId()  : int|null
getResourceId()  : int|null
update()  : ProductResponse

Constants

FILTER_EXCLUDE_FIELDS

public mixed FILTER_EXCLUDE_FIELDS = 'exclude_fields'

FILTER_INCLUDE

public mixed FILTER_INCLUDE = 'include'

FILTER_INCLUDE_FIELDS

public mixed FILTER_INCLUDE_FIELDS = 'include_fields'

FILTER_IS_FEATURED

public mixed FILTER_IS_FEATURED = 'is_featured'

FILTER_IS_VISIBLE

public mixed FILTER_IS_VISIBLE = 'is_visible'

INCLUDE_MODIFIERS

public mixed INCLUDE_MODIFIERS = 'modifiers'

PRODUCT_ENDPOINT

public mixed PRODUCT_ENDPOINT = 'catalog/products/%d'

PRODUCTS_ENDPOINT

public mixed PRODUCTS_ENDPOINT = 'catalog/products'

RESOURCE_NAME

public mixed RESOURCE_NAME = 'products'

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 —

batchDelete()

public batchDelete(array<string|int, mixed> $productIds) : bool
Parameters
$productIds : array<string|int, mixed>
Return values
bool —

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
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
Return values
ProductsResponse —

getParentResourceId()

public getParentResourceId() : int|null
Return values
int|null —

getResourceId()

public getResourceId() : int|null
Return values
int|null —

Search results