OpenAPI\Client\CategoryApi

All URIs are relative to https://api.api2cart.com/v1.1, except if the operation defines another base path.

Method	HTTP request	Description
categoryAdd()	POST /category.add.json	category.add
categoryAddBatch()	POST /category.add.batch.json	category.add.batch
categoryAssign()	POST /category.assign.json	category.assign
categoryCount()	GET /category.count.json	category.count
categoryDelete()	DELETE /category.delete.json	category.delete
categoryFind()	GET /category.find.json	category.find
categoryImageAdd()	POST /category.image.add.json	category.image.add
categoryImageDelete()	DELETE /category.image.delete.json	category.image.delete
categoryInfo()	GET /category.info.json	category.info
categoryList()	GET /category.list.json	category.list
categoryUnassign()	POST /category.unassign.json	category.unassign
categoryUpdate()	PUT /category.update.json	category.update

`categoryAdd()`

categoryAdd($name, $parent_id, $stores_ids, $store_id, $lang_id, $avail, $sort_order, $created_time, $modified_time, $description, $short_description, $meta_title, $meta_description, $meta_keywords, $seo_url): \OpenAPI\Client\Model\CategoryAdd200Response

category.add

Add new category in store

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: StoreKeyAuth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('x-store-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-store-key', 'Bearer');

// Configure API key authorization: ApiKeyAuth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\CategoryApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$name = Shoes; // string | Defines category's name that has to be added
$parent_id = 6; // string | Adds categories specified by parent id
$stores_ids = 1,2; // string | Create category in the stores that is specified by comma-separated stores' id
$store_id = 1; // string | Store Id
$lang_id = 3; // string | Language id
$avail = false; // bool | Defines category's visibility status
$sort_order = 2; // int | Sort number in the list
$created_time = 2014-01-30 15:58:41; // string | Entity's date creation
$modified_time = 2014-07-30 15:58:41; // string | Entity's date modification
$description = Test category; // string | Defines category's description
$short_description = Short description. This is very short description; // string | Defines short description
$meta_title = category,test; // string | Defines unique meta title for each entity
$meta_description = category,test; // string | Defines unique meta description of a entity
$meta_keywords = category,test; // string | Defines unique meta keywords for each entity
$seo_url = category,test; // string | Defines unique category's URL for SEO

try {
    $result = $apiInstance->categoryAdd($name, $parent_id, $stores_ids, $store_id, $lang_id, $avail, $sort_order, $created_time, $modified_time, $description, $short_description, $meta_title, $meta_description, $meta_keywords, $seo_url);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CategoryApi->categoryAdd: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
name	string	Defines category's name that has to be added
parent_id	string	Adds categories specified by parent id	[optional]
stores_ids	string	Create category in the stores that is specified by comma-separated stores' id	[optional]
store_id	string	Store Id	[optional]
lang_id	string	Language id	[optional]
avail	bool	Defines category's visibility status	[optional] [default to true]
sort_order	int	Sort number in the list	[optional] [default to 0]
created_time	string	Entity's date creation	[optional]
modified_time	string	Entity's date modification	[optional]
description	string	Defines category's description	[optional]
short_description	string	Defines short description	[optional]
meta_title	string	Defines unique meta title for each entity	[optional]
meta_description	string	Defines unique meta description of a entity	[optional]
meta_keywords	string	Defines unique meta keywords for each entity	[optional]
seo_url	string	Defines unique category's URL for SEO	[optional]

Return type

\OpenAPI\Client\Model\CategoryAdd200Response

Authorization

StoreKeyAuth, ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`categoryAddBatch()`

categoryAddBatch($category_add_batch): \OpenAPI\Client\Model\CategoryAddBatch200Response

category.add.batch

Add new categories to the store.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: StoreKeyAuth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('x-store-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-store-key', 'Bearer');

// Configure API key authorization: ApiKeyAuth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\CategoryApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$category_add_batch = new \OpenAPI\Client\Model\CategoryAddBatch(); // \OpenAPI\Client\Model\CategoryAddBatch

try {
    $result = $apiInstance->categoryAddBatch($category_add_batch);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CategoryApi->categoryAddBatch: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
category_add_batch	\OpenAPI\Client\Model\CategoryAddBatch

Return type

\OpenAPI\Client\Model\CategoryAddBatch200Response

Authorization

StoreKeyAuth, ApiKeyAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`categoryAssign()`

categoryAssign($product_id, $category_id, $store_id): \OpenAPI\Client\Model\CartConfigUpdate200Response

category.assign

Assign category to product

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: StoreKeyAuth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('x-store-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-store-key', 'Bearer');

// Configure API key authorization: ApiKeyAuth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\CategoryApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$product_id = 10; // string | Defines category assign to the product, specified by product id
$category_id = 6; // string | Defines category assign, specified by category id
$store_id = 1; // string | Store Id

try {
    $result = $apiInstance->categoryAssign($product_id, $category_id, $store_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CategoryApi->categoryAssign: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
product_id	string	Defines category assign to the product, specified by product id
category_id	string	Defines category assign, specified by category id
store_id	string	Store Id	[optional]

Return type

\OpenAPI\Client\Model\CartConfigUpdate200Response

Authorization

StoreKeyAuth, ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`categoryCount()`

categoryCount($parent_id, $store_id, $lang_id, $created_from, $created_to, $modified_from, $modified_to, $avail, $product_type, $find_value, $find_where, $report_request_id, $disable_report_cache): \OpenAPI\Client\Model\CategoryCount200Response

category.count

Count categories in store.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: StoreKeyAuth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('x-store-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-store-key', 'Bearer');

// Configure API key authorization: ApiKeyAuth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\CategoryApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$parent_id = 6; // string | Counts categories specified by parent id
$store_id = 1; // string | Counts category specified by store id
$lang_id = 3; // string | Counts category specified by language id
$created_from = 2010-07-29 13:45:52; // string | Retrieve entities from their creation date
$created_to = 2100-08-29 13:45:52; // string | Retrieve entities to their creation date
$modified_from = 2010-07-29 13:45:52; // string | Retrieve entities from their modification date
$modified_to = 2100-08-29 13:45:52; // string | Retrieve entities to their modification date
$avail = false; // bool | Defines category's visibility status
$product_type = BICYCLE; // string | A categorization for the product
$find_value = Demo category 1; // string | Entity search that is specified by some value
$find_where = email; // string | Counts categories that are searched specified by field
$report_request_id = 105245017661; // string | Report request id
$disable_report_cache = false; // bool | Disable report cache for current request

try {
    $result = $apiInstance->categoryCount($parent_id, $store_id, $lang_id, $created_from, $created_to, $modified_from, $modified_to, $avail, $product_type, $find_value, $find_where, $report_request_id, $disable_report_cache);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CategoryApi->categoryCount: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
parent_id	string	Counts categories specified by parent id	[optional]
store_id	string	Counts category specified by store id	[optional]
lang_id	string	Counts category specified by language id	[optional]
created_from	string	Retrieve entities from their creation date	[optional]
created_to	string	Retrieve entities to their creation date	[optional]
modified_from	string	Retrieve entities from their modification date	[optional]
modified_to	string	Retrieve entities to their modification date	[optional]
avail	bool	Defines category's visibility status	[optional] [default to true]
product_type	string	A categorization for the product	[optional]
find_value	string	Entity search that is specified by some value	[optional]
find_where	string	Counts categories that are searched specified by field	[optional]
report_request_id	string	Report request id	[optional]
disable_report_cache	bool	Disable report cache for current request	[optional] [default to false]

Return type

\OpenAPI\Client\Model\CategoryCount200Response

Authorization

StoreKeyAuth, ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`categoryDelete()`

categoryDelete($id, $store_id): \OpenAPI\Client\Model\CategoryDelete200Response

category.delete

Delete category in store

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: StoreKeyAuth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('x-store-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-store-key', 'Bearer');

// Configure API key authorization: ApiKeyAuth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\CategoryApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 10; // string | Defines category removal, specified by category id
$store_id = 1; // string | Store Id

try {
    $result = $apiInstance->categoryDelete($id, $store_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CategoryApi->categoryDelete: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string	Defines category removal, specified by category id
store_id	string	Store Id	[optional]

Return type

\OpenAPI\Client\Model\CategoryDelete200Response

Authorization

StoreKeyAuth, ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`categoryFind()`

categoryFind($find_value, $find_where, $find_params, $store_id, $lang_id): \OpenAPI\Client\Model\CategoryFind200Response

category.find

Search category in store. "Laptop" is specified here by default.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: StoreKeyAuth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('x-store-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-store-key', 'Bearer');

// Configure API key authorization: ApiKeyAuth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\CategoryApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$find_value = Demo category 1; // string | Entity search that is specified by some value
$find_where = name; // string | Entity search that is specified by the comma-separated unique fields
$find_params = regex; // string | Entity search that is specified by comma-separated parameters
$store_id = 1; // string | Store Id
$lang_id = 3; // string | Language id

try {
    $result = $apiInstance->categoryFind($find_value, $find_where, $find_params, $store_id, $lang_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CategoryApi->categoryFind: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
find_value	string	Entity search that is specified by some value
find_where	string	Entity search that is specified by the comma-separated unique fields	[optional] [default to 'name']
find_params	string	Entity search that is specified by comma-separated parameters	[optional] [default to 'whole_words']
store_id	string	Store Id	[optional]
lang_id	string	Language id	[optional]

Return type

\OpenAPI\Client\Model\CategoryFind200Response

Authorization

StoreKeyAuth, ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`categoryImageAdd()`

categoryImageAdd($category_id, $image_name, $url, $type, $label, $mime, $position, $store_id): \OpenAPI\Client\Model\CategoryImageAdd200Response

category.image.add

Add image to category

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: StoreKeyAuth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('x-store-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-store-key', 'Bearer');

// Configure API key authorization: ApiKeyAuth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\CategoryApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$category_id = 6; // string | Defines category id where the image should be added
$image_name = bag-gray.png; // string | Defines image's name
$url = http://docs.api2cart.com/img/logo.png; // string | Defines URL of the image that has to be added
$type = base; // string | Defines image's types that are specified by comma-separated list
$label = This cool image; // string | Defines alternative text that has to be attached to the picture
$mime = image/jpeg; // string | Mime type of image http://en.wikipedia.org/wiki/Internet_media_type.
$position = 5; // int | Defines image’s position in the list
$store_id = 1; // string | Store Id

try {
    $result = $apiInstance->categoryImageAdd($category_id, $image_name, $url, $type, $label, $mime, $position, $store_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CategoryApi->categoryImageAdd: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
category_id	string	Defines category id where the image should be added
image_name	string	Defines image's name
url	string	Defines URL of the image that has to be added
type	string	Defines image's types that are specified by comma-separated list
label	string	Defines alternative text that has to be attached to the picture	[optional]
mime	string	Mime type of image http://en.wikipedia.org/wiki/Internet_media_type.	[optional]
position	int	Defines image’s position in the list	[optional] [default to 0]
store_id	string	Store Id	[optional]

Return type

\OpenAPI\Client\Model\CategoryImageAdd200Response

Authorization

StoreKeyAuth, ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`categoryImageDelete()`

categoryImageDelete($category_id, $image_id, $store_id): \OpenAPI\Client\Model\AttributeDelete200Response

category.image.delete

Delete image

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: StoreKeyAuth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('x-store-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-store-key', 'Bearer');

// Configure API key authorization: ApiKeyAuth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\CategoryApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$category_id = 6; // string | Defines category id where the image should be deleted
$image_id = 82950b84f468edff480680f99cedbe0d; // string | Define image id
$store_id = 1; // string | Store Id

try {
    $result = $apiInstance->categoryImageDelete($category_id, $image_id, $store_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CategoryApi->categoryImageDelete: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
category_id	string	Defines category id where the image should be deleted
image_id	string	Define image id
store_id	string	Store Id	[optional]

Return type

\OpenAPI\Client\Model\AttributeDelete200Response

Authorization

StoreKeyAuth, ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`categoryInfo()`

categoryInfo($id, $params, $response_fields, $exclude, $store_id, $lang_id, $schema_type, $report_request_id, $disable_report_cache): \OpenAPI\Client\Model\CategoryInfo200Response

category.info

Get category info about category ID*** or specify other category ID.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: StoreKeyAuth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('x-store-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-store-key', 'Bearer');

// Configure API key authorization: ApiKeyAuth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\CategoryApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 10; // string | Retrieves category's info specified by category id
$params = id,parent_id,name; // string | Set this parameter in order to choose which entity fields you want to retrieve
$response_fields = {result{id,name,parent_id,modified_at{value},images}}; // string | Set this parameter in order to choose which entity fields you want to retrieve
$exclude = id,parent_id,name; // string | Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all
$store_id = 1; // string | Retrieves category info  specified by store id
$lang_id = 3; // string | Retrieves category info  specified by language id
$schema_type = LISTING; // string | The name of the requirements set for the provided schema.
$report_request_id = 105245017661; // string | Report request id
$disable_report_cache = false; // bool | Disable report cache for current request

try {
    $result = $apiInstance->categoryInfo($id, $params, $response_fields, $exclude, $store_id, $lang_id, $schema_type, $report_request_id, $disable_report_cache);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CategoryApi->categoryInfo: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string	Retrieves category's info specified by category id
params	string	Set this parameter in order to choose which entity fields you want to retrieve	[optional] [default to 'id,parent_id,name,description']
response_fields	string	Set this parameter in order to choose which entity fields you want to retrieve	[optional]
exclude	string	Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all	[optional]
store_id	string	Retrieves category info specified by store id	[optional]
lang_id	string	Retrieves category info specified by language id	[optional]
schema_type	string	The name of the requirements set for the provided schema.	[optional]
report_request_id	string	Report request id	[optional]
disable_report_cache	bool	Disable report cache for current request	[optional] [default to false]

Return type

\OpenAPI\Client\Model\CategoryInfo200Response

Authorization

StoreKeyAuth, ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`categoryList()`

categoryList($start, $count, $page_cursor, $parent_id, $params, $response_fields, $exclude, $store_id, $lang_id, $created_from, $created_to, $modified_from, $modified_to, $avail, $product_type, $find_value, $find_where, $report_request_id, $disable_report_cache, $disable_cache): \OpenAPI\Client\Model\ModelResponseCategoryList

category.list

Get list of categories from store.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: StoreKeyAuth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('x-store-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-store-key', 'Bearer');

// Configure API key authorization: ApiKeyAuth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\CategoryApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$start = 0; // int | This parameter sets the number from which you want to get entities
$count = 20; // int | This parameter sets the entity amount that has to be retrieved. Max allowed count=250
$page_cursor = ; // string | Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)
$parent_id = 6; // string | Retrieves categories specified by parent id
$params = id,parent_id,name; // string | Set this parameter in order to choose which entity fields you want to retrieve
$response_fields = {result{categories_count,category{id,parent_id,modified_at{value},images}}}; // string | Set this parameter in order to choose which entity fields you want to retrieve
$exclude = id,parent_id,name; // string | Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all
$store_id = 1; // string | Retrieves categories specified by store id
$lang_id = 3; // string | Retrieves categorys specified by language id
$created_from = 2010-07-29 13:45:52; // string | Retrieve entities from their creation date
$created_to = 2100-08-29 13:45:52; // string | Retrieve entities to their creation date
$modified_from = 2010-07-29 13:45:52; // string | Retrieve entities from their modification date
$modified_to = 2100-08-29 13:45:52; // string | Retrieve entities to their modification date
$avail = false; // bool | Defines category's visibility status
$product_type = BICYCLE; // string | A categorization for the product
$find_value = Demo category 1; // string | Entity search that is specified by some value
$find_where = name; // string | Category search that is specified by field
$report_request_id = 105245017661; // string | Report request id
$disable_report_cache = false; // bool | Disable report cache for current request
$disable_cache = false; // bool | Disable cache for current request

try {
    $result = $apiInstance->categoryList($start, $count, $page_cursor, $parent_id, $params, $response_fields, $exclude, $store_id, $lang_id, $created_from, $created_to, $modified_from, $modified_to, $avail, $product_type, $find_value, $find_where, $report_request_id, $disable_report_cache, $disable_cache);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CategoryApi->categoryList: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
start	int	This parameter sets the number from which you want to get entities	[optional] [default to 0]
count	int	This parameter sets the entity amount that has to be retrieved. Max allowed count=250	[optional] [default to 10]
page_cursor	string	Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)	[optional]
parent_id	string	Retrieves categories specified by parent id	[optional]
params	string	Set this parameter in order to choose which entity fields you want to retrieve	[optional] [default to 'id,parent_id,name,description']
response_fields	string	Set this parameter in order to choose which entity fields you want to retrieve	[optional]
exclude	string	Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all	[optional]
store_id	string	Retrieves categories specified by store id	[optional]
lang_id	string	Retrieves categorys specified by language id	[optional]
created_from	string	Retrieve entities from their creation date	[optional]
created_to	string	Retrieve entities to their creation date	[optional]
modified_from	string	Retrieve entities from their modification date	[optional]
modified_to	string	Retrieve entities to their modification date	[optional]
avail	bool	Defines category's visibility status	[optional] [default to true]
product_type	string	A categorization for the product	[optional]
find_value	string	Entity search that is specified by some value	[optional]
find_where	string	Category search that is specified by field	[optional]
report_request_id	string	Report request id	[optional]
disable_report_cache	bool	Disable report cache for current request	[optional] [default to false]
disable_cache	bool	Disable cache for current request	[optional] [default to false]

Return type

\OpenAPI\Client\Model\ModelResponseCategoryList

Authorization

StoreKeyAuth, ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`categoryUnassign()`

categoryUnassign($category_id, $product_id, $store_id): \OpenAPI\Client\Model\CartConfigUpdate200Response

category.unassign

Unassign category to product

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: StoreKeyAuth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('x-store-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-store-key', 'Bearer');

// Configure API key authorization: ApiKeyAuth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\CategoryApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$category_id = 6; // string | Defines category unassign, specified by category id
$product_id = 10; // string | Defines category unassign to the product, specified by product id
$store_id = 1; // string | Store Id

try {
    $result = $apiInstance->categoryUnassign($category_id, $product_id, $store_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CategoryApi->categoryUnassign: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
category_id	string	Defines category unassign, specified by category id
product_id	string	Defines category unassign to the product, specified by product id
store_id	string	Store Id	[optional]

Return type

\OpenAPI\Client\Model\CartConfigUpdate200Response

Authorization

StoreKeyAuth, ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`categoryUpdate()`

categoryUpdate($id, $name, $parent_id, $stores_ids, $avail, $sort_order, $modified_time, $description, $short_description, $meta_title, $meta_description, $meta_keywords, $seo_url, $lang_id, $store_id): \OpenAPI\Client\Model\AccountConfigUpdate200Response

category.update

Update category in store

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: StoreKeyAuth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('x-store-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-store-key', 'Bearer');

// Configure API key authorization: ApiKeyAuth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\CategoryApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 10; // string | Defines category update specified by category id
$name = NEW Shoes; // string | Defines new category’s name
$parent_id = 6; // string | Defines new parent category id
$stores_ids = 1,2; // string | Update category in the stores that is specified by comma-separated stores' id
$avail = false; // bool | Defines category's visibility status
$sort_order = 2; // int | Sort number in the list
$modified_time = 2014-07-30 15:58:41; // string | Entity's date modification
$description = New test category; // string | Defines new category's description
$short_description = Short description. This is very short description; // string | Defines short description
$meta_title = category,test; // string | Defines unique meta title for each entity
$meta_description = category,test; // string | Defines unique meta description of a entity
$meta_keywords = category,test; // string | Defines unique meta keywords for each entity
$seo_url = category,test; // string | Defines unique category's URL for SEO
$lang_id = 3; // string | Language id
$store_id = 1; // string | Store Id

try {
    $result = $apiInstance->categoryUpdate($id, $name, $parent_id, $stores_ids, $avail, $sort_order, $modified_time, $description, $short_description, $meta_title, $meta_description, $meta_keywords, $seo_url, $lang_id, $store_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CategoryApi->categoryUpdate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string	Defines category update specified by category id
name	string	Defines new category’s name	[optional]
parent_id	string	Defines new parent category id	[optional]
stores_ids	string	Update category in the stores that is specified by comma-separated stores' id	[optional]
avail	bool	Defines category's visibility status	[optional]
sort_order	int	Sort number in the list	[optional]
modified_time	string	Entity's date modification	[optional]
description	string	Defines new category's description	[optional]
short_description	string	Defines short description	[optional]
meta_title	string	Defines unique meta title for each entity	[optional]
meta_description	string	Defines unique meta description of a entity	[optional]
meta_keywords	string	Defines unique meta keywords for each entity	[optional]
seo_url	string	Defines unique category's URL for SEO	[optional]
lang_id	string	Language id	[optional]
store_id	string	Store Id	[optional]

Return type

\OpenAPI\Client\Model\AccountConfigUpdate200Response

Authorization

StoreKeyAuth, ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

CategoryApi.md

Latest commit

History

CategoryApi.md

File metadata and controls

OpenAPI\Client\CategoryApi

categoryAdd()

Example

Parameters

Return type

Authorization

HTTP request headers

categoryAddBatch()

Example

Parameters

Return type

Authorization

HTTP request headers

categoryAssign()

Example

Parameters

Return type

Authorization

HTTP request headers

categoryCount()

Example

Parameters

Return type

Authorization

HTTP request headers

categoryDelete()

Example

Parameters

Return type

Authorization

HTTP request headers

categoryFind()

Example

Parameters

Return type

Authorization

HTTP request headers

categoryImageAdd()

Example

Parameters

Return type

Authorization

HTTP request headers

categoryImageDelete()

Example

Parameters

Return type

Authorization

HTTP request headers

categoryInfo()

Example

Parameters

Return type

Authorization

HTTP request headers

categoryList()

Example

Parameters

Return type

Authorization

HTTP request headers

categoryUnassign()

Example

Parameters

Return type

Authorization

HTTP request headers

categoryUpdate()

Example

Parameters

Return type

Authorization

HTTP request headers

`categoryAdd()`

`categoryAddBatch()`

`categoryAssign()`

`categoryCount()`

`categoryDelete()`

`categoryFind()`

`categoryImageAdd()`

`categoryImageDelete()`

`categoryInfo()`

`categoryList()`

`categoryUnassign()`

`categoryUpdate()`