API Documentation
\
MerchantAPI
Http
ListQuery
Model
MultiCall
Request
Response

\MerchantAPI\RequestProductVariantListLoadProduct

Handles API Request ProductVariantList_Load_Product.

Scope: Store

Summary

Methods
Properties
Constants
getFunction()
getScope()
getStoreCode()
setStoreCode()
toArray()
__construct()
getProductId()
getProductCode()
getEditProduct()
getProductSku()
getIncludeDefaultVariant()
getLimits()
getExclusions()
setProductId()
setProductCode()
setEditProduct()
setProductSku()
setIncludeDefaultVariant()
setLimits()
setExclusions()
addLimit()
addLimits()
addExclusion()
addExclusions()
createResponse()
No public properties found
No constants found
No protected methods found
$storeCode
$scope
$function
$productId
$productCode
$editProduct
$productSku
$includeDefaultVariant
$limits
$exclusions
N/A
No private methods found
No private properties found
N/A

Properties

$storeCode

$storeCode : null|string

Type

null|string

$scope

$scope : string

Type

string — The request scope

$function

$function : string

Type

string — The API function name

$productId

$productId : integer

Type

integer

$productCode

$productCode : string

Type

string

$editProduct

$editProduct : string

Type

string

$productSku

$productSku : string

Type

string

$includeDefaultVariant

$includeDefaultVariant : boolean

Type

boolean

Methods

getFunction()

getFunction() : string

Returns the API function name to be executed.

Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293 Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293

Returns

string

getScope()

getScope() : string

Get the scope of the request. Returns a RequestInterface::REQUEST_SCOPE_* constant.

Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293 Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293

Returns

string

getStoreCode()

getStoreCode() : mixed

Get the request level store code, if set.

Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293 Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293

Returns

mixed

setStoreCode()

setStoreCode(  $storeCode) : \MerchantAPI\ResponseInterface

Override client level store code from the request. Only applies to store scoped requests.

Parameters

$storeCode
Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293 Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293

Returns

\MerchantAPI\ResponseInterface

toArray()

toArray() : array

Returns the data for the request as an array.

Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293 Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293

Returns

array

__construct()

__construct(\MerchantAPI\Model\Product  $product = null)

Constructor.

Parameters

\MerchantAPI\Model\Product $product
Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293 Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293

getProductId()

getProductId() : integer

Get Product_ID.

Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293 Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293

Returns

integer

getProductCode()

getProductCode() : string

Get Product_Code.

Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293 Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293

Returns

string

getEditProduct()

getEditProduct() : string

Get Edit_Product.

Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293 Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293

Returns

string

getProductSku()

getProductSku() : string

Get Product_SKU.

Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293 Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293

Returns

string

getIncludeDefaultVariant()

getIncludeDefaultVariant() : boolean

Get Include_Default_Variant.

Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293 Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293

Returns

boolean

getLimits()

getLimits() : array<mixed,\MerchantAPI\Model\ProductVariantLimit>

Get Limits.

Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293 Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293

Returns

array<mixed,\MerchantAPI\Model\ProductVariantLimit>

getExclusions()

getExclusions() : array<mixed,\MerchantAPI\Model\ProductVariantExclusion>

Get Exclusions.

Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293 Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293

Returns

array<mixed,\MerchantAPI\Model\ProductVariantExclusion>

setProductId()

setProductId(  $productId) : $this

Set Product_ID.

Parameters

$productId
Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293 Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293

Returns

$this

setProductCode()

setProductCode(  $productCode) : $this

Set Product_Code.

Parameters

$productCode
Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293 Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293

Returns

$this

setEditProduct()

setEditProduct(  $editProduct) : $this

Set Edit_Product.

Parameters

$editProduct
Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293 Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293

Returns

$this

setProductSku()

setProductSku(  $productSku) : $this

Set Product_SKU.

Parameters

$productSku
Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293 Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293

Returns

$this

setIncludeDefaultVariant()

setIncludeDefaultVariant(  $includeDefaultVariant) : $this

Set Include_Default_Variant.

Parameters

$includeDefaultVariant
Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293 Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293

Returns

$this

setLimits()

setLimits(array  $limits) : $this

Set Limits.

Parameters

array $limits

Throws

\InvalidArgumentException

Returns

$this

setExclusions()

setExclusions(array  $exclusions) : $this

Set Exclusions.

Parameters

array $exclusions

Throws

\InvalidArgumentException

Returns

$this

addLimit()

addLimit(\MerchantAPI\Model\ProductVariantLimit  $model) : $this

Add Limits.

Parameters

\MerchantAPI\Model\ProductVariantLimit $model
Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293 Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293

Returns

$this

addLimits()

addLimits(array  $limits) : $this

Add many ProductVariantLimit.

Parameters

array $limits

Throws

\InvalidArgumentException

Returns

$this

addExclusion()

addExclusion(\MerchantAPI\Model\ProductVariantExclusion  $model) : $this

Add Exclusions.

Parameters

\MerchantAPI\Model\ProductVariantExclusion $model
Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293 Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293

Returns

$this

addExclusions()

addExclusions(array  $exclusions) : $this

Add many ProductVariantExclusion.

Parameters

array $exclusions

Throws

\InvalidArgumentException

Returns

$this

createResponse()

createResponse(\MerchantAPI\Http\HttpResponse  $httpResponse, array  $data)

Parameters

\MerchantAPI\Http\HttpResponse $httpResponse
array $data
Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293 Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293