AkeneoPresales\DescrbAPI\ProductApi

All URIs are relative to https://app.descrb.com.

Method	HTTP request	Description
createDemoProductAdApiV1ProductDemoPost()	POST /api/v1/product/demo/	Create Demo Product Ad
createProductAdApiV1ProductPost()	POST /api/v1/product/	Create Product Ad
editBrandDescriptionApiV1ProductBrandDescriptionIdPatch()	PATCH /api/v1/product/brand/{description_id}	Edit Brand Description
editDescriptionApiV1ProductDescriptionDescriptionIdPatch()	PATCH /api/v1/product/description/{description_id}	Edit Description
editHistoryDescriptionApiV1ProductHistoryDescriptionIdPatch()	PATCH /api/v1/product/history/{description_id}	Edit History Description
exportChosenToCsvApiV1ProductExportChosenPut()	PUT /api/v1/product/export-chosen	Export Chosen To Csv
exportPageToCsvAdminPanelApiV1ProductAdminExportCurrentPageGet()	GET /api/v1/product/admin/export-current-page	Export Page To Csv Admin Panel
exportPageToCsvApiV1ProductExportCurrentPageGet()	GET /api/v1/product/export-current-page	Export Page To Csv
exportToCsvAdminPanelApiV1ProductAdminExportAllGet()	GET /api/v1/product/admin/export-all	Export To Csv Admin Panel
exportToCsvApiV1ProductExportAllGet()	GET /api/v1/product/export-all	Export To Csv
getDescriptionApiV1ProductDescriptionIdGet()	GET /api/v1/product/{description_id}	Get Description
readAllProductDescriptionsApiV1ProductAllGet()	GET /api/v1/product/all	Read All Product Descriptions
readUserProductDescriptionsApiV1ProductMyReviewsGet()	GET /api/v1/product/my-reviews	Read User Product Descriptions
regenerateBrandDescriptionApiV1ProductRegenerateBrandDescriptionDescriptionIdPost()	POST /api/v1/product/regenerate-brand-description/{description_id}	Regenerate Brand Description
regenerateDescriptionApiV1ProductRegenerateDescriptionDescriptionIdPost()	POST /api/v1/product/regenerate-description/{description_id}	Regenerate Description
regenerateEmptyApiV1ProductRegenerateEmptyDescriptionDescriptionIdPost()	POST /api/v1/product/regenerate-empty-description/{description_id}	Regenerate Empty
regenerateHistoryDescriptionApiV1ProductRegenerateHistoryDescriptionDescriptionIdPost()	POST /api/v1/product/regenerate-history-description/{description_id}	Regenerate History Description
regenerateTechnologyApiV1ProductRegenerateTechnologiesDescriptionDescriptionIdPost()	POST /api/v1/product/regenerate-technologies-description/{description_id}	Regenerate Technology
reviewBrandDescriptionApiV1ProductBrandDescriptionIdReviewPost()	POST /api/v1/product/brand/{description_id}/review	Review Brand Description
reviewDescriptionApiV1ProductDescriptionDescriptionIdReviewPost()	POST /api/v1/product/description/{description_id}/review	Review Description
reviewHistoryDescriptionApiV1ProductHistoryDescriptionIdReviewPost()	POST /api/v1/product/history/{description_id}/review	Review History Description
translateDescriptionApiV1ProductTranslateDescriptionDescriptionIdPost()	POST /api/v1/product/translate-description/{description_id}	Translate Description

`createDemoProductAdApiV1ProductDemoPost()`

createDemoProductAdApiV1ProductDemoPost($base_image, $segmented_image, $photo_url, $name, $product_id, $length, $language, $data_language, $language_style, $keywords, $seotags, $product_history, $manufacturer_history, $technologies, $labels, $logos, $search_codes, $unique_product, $describe_colors, $describe_materials): mixed

Create Demo Product Ad

Create new demo ad

Example

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



$apiInstance = new AkeneoPresales\DescrbAPI\Api\ProductApi(
    // 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()
);
$base_image = array("/path/to/file.txt"); // \SplFileObject[] | Image Files
$segmented_image = array(new \AkeneoPresales\DescrbAPI\Model\AnyOfFileString()); // AnyOfFileString[] | Segmented Image Files
$photo_url = ''; // string | Photo URL
$name = array('name_example'); // string[] | Product Names
$product_id = array('product_id_example'); // string[] | Product IDs
$length = 512; // int | Numer of Tokens
$language = 'pl'; // string | Supported languages: en,de,fr,es,ro,pl
$data_language = ''; // string | Data Source Language
$language_style = 'Neutral'; // string | Choose between Neutral, Casual, Specialist
$keywords = ''; // string | Important Keywords to include
$seotags = false; // bool | Add SEO Tags
$product_history = false; // bool | Add Product History
$manufacturer_history = false; // bool | Add Manufacturer History
$technologies = false; // bool | Add List of Technologies
$labels = false; // bool | Add Labels
$logos = false; // bool | Add Logo Detection
$search_codes = false; // bool | Search for SKU, MPU, Product ID
$unique_product = false; // bool | Unique product, use captions
$describe_colors = false; // bool | Should the description include colors
$describe_materials = false; // bool | Should the description include materials

try {
    $result = $apiInstance->createDemoProductAdApiV1ProductDemoPost($base_image, $segmented_image, $photo_url, $name, $product_id, $length, $language, $data_language, $language_style, $keywords, $seotags, $product_history, $manufacturer_history, $technologies, $labels, $logos, $search_codes, $unique_product, $describe_colors, $describe_materials);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductApi->createDemoProductAdApiV1ProductDemoPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
base_image	\SplFileObject[]	Image Files	[optional]
segmented_image	AnyOfFileString[]	Segmented Image Files	[optional]
photo_url	string	Photo URL	[optional] [default to '']
name	string[]	Product Names	[optional]
product_id	string[]	Product IDs	[optional]
length	int	Numer of Tokens	[optional] [default to 512]
language	string	Supported languages: en,de,fr,es,ro,pl	[optional] [default to 'pl']
data_language	string	Data Source Language	[optional] [default to '']
language_style	string	Choose between Neutral, Casual, Specialist	[optional] [default to 'Neutral']
keywords	string	Important Keywords to include	[optional] [default to '']
seotags	bool	Add SEO Tags	[optional] [default to false]
product_history	bool	Add Product History	[optional] [default to false]
manufacturer_history	bool	Add Manufacturer History	[optional] [default to false]
technologies	bool	Add List of Technologies	[optional] [default to false]
labels	bool	Add Labels	[optional] [default to false]
logos	bool	Add Logo Detection	[optional] [default to false]
search_codes	bool	Search for SKU, MPU, Product ID	[optional] [default to false]
unique_product	bool	Unique product, use captions	[optional] [default to false]
describe_colors	bool	Should the description include colors	[optional] [default to false]
describe_materials	bool	Should the description include materials	[optional] [default to false]

Return type

mixed

Authorization

No authorization required

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json

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

`createProductAdApiV1ProductPost()`

createProductAdApiV1ProductPost($base_image, $segmented_image, $photo_url, $name, $product_id, $length, $language, $data_language, $language_style, $keywords, $seotags, $product_history, $manufacturer_history, $technologies, $labels, $logos, $search_codes, $unique_product, $describe_colors, $describe_materials): mixed

Create Product Ad

Create new ad

Example

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


// Configure OAuth2 access token for authorization: OAuth2PasswordBearer
$config = AkeneoPresales\DescrbAPI\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new AkeneoPresales\DescrbAPI\Api\ProductApi(
    // 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
);
$base_image = array("/path/to/file.txt"); // \SplFileObject[] | Image Files
$segmented_image = array(new \AkeneoPresales\DescrbAPI\Model\AnyOfFileString()); // AnyOfFileString[] | Segmented Image Files
$photo_url = ''; // string | Photo URL
$name = array('name_example'); // string[] | Product Names
$product_id = array('product_id_example'); // string[] | Product IDs
$length = 512; // int | Numer of Tokens
$language = 'pl'; // string | Supported languages: en,de,fr,es,ro,pl
$data_language = ''; // string | Data Source Language
$language_style = 'Neutral'; // string | Choose between Neutral, Casual, Specialist
$keywords = ''; // string | Important Keywords to include
$seotags = false; // bool | Add SEO Tags
$product_history = false; // bool | Add Product History
$manufacturer_history = false; // bool | Add Manufacturer History
$technologies = false; // bool | Add List of Technologies
$labels = false; // bool | Add Labels
$logos = false; // bool | Add Logo Detection
$search_codes = false; // bool | Search for SKU, MPU, Product ID
$unique_product = false; // bool | Unique product, use captions
$describe_colors = false; // bool | Should the description include colors
$describe_materials = false; // bool | Should the description include materials

try {
    $result = $apiInstance->createProductAdApiV1ProductPost($base_image, $segmented_image, $photo_url, $name, $product_id, $length, $language, $data_language, $language_style, $keywords, $seotags, $product_history, $manufacturer_history, $technologies, $labels, $logos, $search_codes, $unique_product, $describe_colors, $describe_materials);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductApi->createProductAdApiV1ProductPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
base_image	\SplFileObject[]	Image Files	[optional]
segmented_image	AnyOfFileString[]	Segmented Image Files	[optional]
photo_url	string	Photo URL	[optional] [default to '']
name	string[]	Product Names	[optional]
product_id	string[]	Product IDs	[optional]
length	int	Numer of Tokens	[optional] [default to 512]
language	string	Supported languages: en,de,fr,es,ro,pl	[optional] [default to 'pl']
data_language	string	Data Source Language	[optional] [default to '']
language_style	string	Choose between Neutral, Casual, Specialist	[optional] [default to 'Neutral']
keywords	string	Important Keywords to include	[optional] [default to '']
seotags	bool	Add SEO Tags	[optional] [default to false]
product_history	bool	Add Product History	[optional] [default to false]
manufacturer_history	bool	Add Manufacturer History	[optional] [default to false]
technologies	bool	Add List of Technologies	[optional] [default to false]
labels	bool	Add Labels	[optional] [default to false]
logos	bool	Add Logo Detection	[optional] [default to false]
search_codes	bool	Search for SKU, MPU, Product ID	[optional] [default to false]
unique_product	bool	Unique product, use captions	[optional] [default to false]
describe_colors	bool	Should the description include colors	[optional] [default to false]
describe_materials	bool	Should the description include materials	[optional] [default to false]

Return type

mixed

Authorization

OAuth2PasswordBearer

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json

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

`editBrandDescriptionApiV1ProductBrandDescriptionIdPatch()`

editBrandDescriptionApiV1ProductBrandDescriptionIdPatch($description_id, $brand_description_update): \AkeneoPresales\DescrbAPI\Model\BrandDescriptionUpdate

Edit Brand Description

Get description by ID.

Example

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


// Configure OAuth2 access token for authorization: OAuth2PasswordBearer
$config = AkeneoPresales\DescrbAPI\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new AkeneoPresales\DescrbAPI\Api\ProductApi(
    // 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
);
$description_id = 'description_id_example'; // string
$brand_description_update = new \AkeneoPresales\DescrbAPI\Model\BrandDescriptionUpdate(); // \AkeneoPresales\DescrbAPI\Model\BrandDescriptionUpdate

try {
    $result = $apiInstance->editBrandDescriptionApiV1ProductBrandDescriptionIdPatch($description_id, $brand_description_update);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductApi->editBrandDescriptionApiV1ProductBrandDescriptionIdPatch: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
description_id	string
brand_description_update	\AkeneoPresales\DescrbAPI\Model\BrandDescriptionUpdate

Return type

\AkeneoPresales\DescrbAPI\Model\BrandDescriptionUpdate

Authorization

OAuth2PasswordBearer

HTTP request headers

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

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

`editDescriptionApiV1ProductDescriptionDescriptionIdPatch()`

editDescriptionApiV1ProductDescriptionDescriptionIdPatch($description_id, $product_description_update): \AkeneoPresales\DescrbAPI\Model\ProductDescriptionUpdate

Edit Description

Get description by ID.

Example

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


// Configure OAuth2 access token for authorization: OAuth2PasswordBearer
$config = AkeneoPresales\DescrbAPI\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new AkeneoPresales\DescrbAPI\Api\ProductApi(
    // 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
);
$description_id = 'description_id_example'; // string
$product_description_update = new \AkeneoPresales\DescrbAPI\Model\ProductDescriptionUpdate(); // \AkeneoPresales\DescrbAPI\Model\ProductDescriptionUpdate

try {
    $result = $apiInstance->editDescriptionApiV1ProductDescriptionDescriptionIdPatch($description_id, $product_description_update);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductApi->editDescriptionApiV1ProductDescriptionDescriptionIdPatch: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
description_id	string
product_description_update	\AkeneoPresales\DescrbAPI\Model\ProductDescriptionUpdate

Return type

\AkeneoPresales\DescrbAPI\Model\ProductDescriptionUpdate

Authorization

OAuth2PasswordBearer

HTTP request headers

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

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

`editHistoryDescriptionApiV1ProductHistoryDescriptionIdPatch()`

editHistoryDescriptionApiV1ProductHistoryDescriptionIdPatch($description_id, $product_history_update): \AkeneoPresales\DescrbAPI\Model\ProductHistoryUpdate

Edit History Description

Get description by ID.

Example

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


// Configure OAuth2 access token for authorization: OAuth2PasswordBearer
$config = AkeneoPresales\DescrbAPI\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new AkeneoPresales\DescrbAPI\Api\ProductApi(
    // 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
);
$description_id = 'description_id_example'; // string
$product_history_update = new \AkeneoPresales\DescrbAPI\Model\ProductHistoryUpdate(); // \AkeneoPresales\DescrbAPI\Model\ProductHistoryUpdate

try {
    $result = $apiInstance->editHistoryDescriptionApiV1ProductHistoryDescriptionIdPatch($description_id, $product_history_update);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductApi->editHistoryDescriptionApiV1ProductHistoryDescriptionIdPatch: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
description_id	string
product_history_update	\AkeneoPresales\DescrbAPI\Model\ProductHistoryUpdate

Return type

\AkeneoPresales\DescrbAPI\Model\ProductHistoryUpdate

Authorization

OAuth2PasswordBearer

HTTP request headers

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

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

`exportChosenToCsvApiV1ProductExportChosenPut()`

exportChosenToCsvApiV1ProductExportChosenPut($request_body): mixed

Export Chosen To Csv

Example

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


// Configure OAuth2 access token for authorization: OAuth2PasswordBearer
$config = AkeneoPresales\DescrbAPI\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new AkeneoPresales\DescrbAPI\Api\ProductApi(
    // 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
);
$request_body = NULL; // mixed[]

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

Parameters

Name	Type	Description	Notes
request_body	mixed[]

Return type

mixed

Authorization

OAuth2PasswordBearer

HTTP request headers

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

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

`exportPageToCsvAdminPanelApiV1ProductAdminExportCurrentPageGet()`

exportPageToCsvAdminPanelApiV1ProductAdminExportCurrentPageGet($user_id, $limit, $offset): mixed

Export Page To Csv Admin Panel

Example

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


// Configure OAuth2 access token for authorization: OAuth2PasswordBearer
$config = AkeneoPresales\DescrbAPI\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new AkeneoPresales\DescrbAPI\Api\ProductApi(
    // 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
);
$user_id = 'user_id_example'; // string
$limit = 50; // int
$offset = 0; // int

try {
    $result = $apiInstance->exportPageToCsvAdminPanelApiV1ProductAdminExportCurrentPageGet($user_id, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductApi->exportPageToCsvAdminPanelApiV1ProductAdminExportCurrentPageGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Notes
user_id	string	[optional]
limit	int	[optional] [default to 50]
offset	int	[optional] [default to 0]

Return type

mixed

Authorization

OAuth2PasswordBearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`exportPageToCsvApiV1ProductExportCurrentPageGet()`

exportPageToCsvApiV1ProductExportCurrentPageGet($limit, $offset): mixed

Export Page To Csv

Example

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


// Configure OAuth2 access token for authorization: OAuth2PasswordBearer
$config = AkeneoPresales\DescrbAPI\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new AkeneoPresales\DescrbAPI\Api\ProductApi(
    // 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
);
$limit = 50; // int
$offset = 0; // int

try {
    $result = $apiInstance->exportPageToCsvApiV1ProductExportCurrentPageGet($limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductApi->exportPageToCsvApiV1ProductExportCurrentPageGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
limit	int		[optional] [default to 50]
offset	int		[optional] [default to 0]

Return type

mixed

Authorization

OAuth2PasswordBearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`exportToCsvAdminPanelApiV1ProductAdminExportAllGet()`

exportToCsvAdminPanelApiV1ProductAdminExportAllGet($user_id, $limit, $offset): mixed

Export To Csv Admin Panel

Example

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


// Configure OAuth2 access token for authorization: OAuth2PasswordBearer
$config = AkeneoPresales\DescrbAPI\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new AkeneoPresales\DescrbAPI\Api\ProductApi(
    // 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
);
$user_id = 'user_id_example'; // string
$limit = NULL; // mixed
$offset = NULL; // mixed

try {
    $result = $apiInstance->exportToCsvAdminPanelApiV1ProductAdminExportAllGet($user_id, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductApi->exportToCsvAdminPanelApiV1ProductAdminExportAllGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Notes
user_id	string	[optional]
limit	mixed	[optional]
offset	mixed	[optional]

Return type

mixed

Authorization

OAuth2PasswordBearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`exportToCsvApiV1ProductExportAllGet()`

exportToCsvApiV1ProductExportAllGet($limit, $offset): mixed

Export To Csv

Example

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


// Configure OAuth2 access token for authorization: OAuth2PasswordBearer
$config = AkeneoPresales\DescrbAPI\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new AkeneoPresales\DescrbAPI\Api\ProductApi(
    // 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
);
$limit = NULL; // mixed
$offset = NULL; // mixed

try {
    $result = $apiInstance->exportToCsvApiV1ProductExportAllGet($limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductApi->exportToCsvApiV1ProductExportAllGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
limit	mixed		[optional]
offset	mixed		[optional]

Return type

mixed

Authorization

OAuth2PasswordBearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`getDescriptionApiV1ProductDescriptionIdGet()`

getDescriptionApiV1ProductDescriptionIdGet($description_id): \AkeneoPresales\DescrbAPI\Model\ProductDescriptionExtended

Get Description

Get description by ID.

Example

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


// Configure OAuth2 access token for authorization: OAuth2PasswordBearer
$config = AkeneoPresales\DescrbAPI\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new AkeneoPresales\DescrbAPI\Api\ProductApi(
    // 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
);
$description_id = 'description_id_example'; // string

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

Parameters

Name	Type	Description	Notes
description_id	string

Return type

\AkeneoPresales\DescrbAPI\Model\ProductDescriptionExtended

Authorization

OAuth2PasswordBearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`readAllProductDescriptionsApiV1ProductAllGet()`

readAllProductDescriptionsApiV1ProductAllGet($score, $name__ilike, $brand_name__ilike, $order_by, $limit, $offset): \AkeneoPresales\DescrbAPI\Model\LimitOffsetPageProductDescriptionInDB

Read All Product Descriptions

Retrieve all product descriptions.

Example

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


// Configure OAuth2 access token for authorization: OAuth2PasswordBearer
$config = AkeneoPresales\DescrbAPI\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new AkeneoPresales\DescrbAPI\Api\ProductApi(
    // 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
);
$score = 56; // int
$name__ilike = 'name__ilike_example'; // string
$brand_name__ilike = 'brand_name__ilike_example'; // string
$order_by = 'score,name,brand_name,created_at,brand_description_bool,product_history_description_bool,technologies_bool'; // string
$limit = 50; // int
$offset = 0; // int

try {
    $result = $apiInstance->readAllProductDescriptionsApiV1ProductAllGet($score, $name__ilike, $brand_name__ilike, $order_by, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductApi->readAllProductDescriptionsApiV1ProductAllGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Notes
score	int	[optional]
name__ilike	string	[optional]
brand_name__ilike	string	[optional]
order_by	string	[optional] [default to 'score,name,brand_name,created_at,brand_description_bool,product_history_description_bool,technologies_bool']
limit	int	[optional] [default to 50]
offset	int	[optional] [default to 0]

Return type

\AkeneoPresales\DescrbAPI\Model\LimitOffsetPageProductDescriptionInDB

Authorization

OAuth2PasswordBearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`readUserProductDescriptionsApiV1ProductMyReviewsGet()`

readUserProductDescriptionsApiV1ProductMyReviewsGet($score, $name__ilike, $brand_name__ilike, $order_by, $limit, $offset): \AkeneoPresales\DescrbAPI\Model\LimitOffsetPageProductDescriptionInDB

Read User Product Descriptions

Retrieve user product descriptions.

Example

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


// Configure OAuth2 access token for authorization: OAuth2PasswordBearer
$config = AkeneoPresales\DescrbAPI\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new AkeneoPresales\DescrbAPI\Api\ProductApi(
    // 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
);
$score = 56; // int
$name__ilike = 'name__ilike_example'; // string
$brand_name__ilike = 'brand_name__ilike_example'; // string
$order_by = 'score,name,brand_name,created_at,brand_description_bool,product_history_description_bool,technologies_bool'; // string
$limit = 50; // int
$offset = 0; // int

try {
    $result = $apiInstance->readUserProductDescriptionsApiV1ProductMyReviewsGet($score, $name__ilike, $brand_name__ilike, $order_by, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductApi->readUserProductDescriptionsApiV1ProductMyReviewsGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Notes
score	int	[optional]
name__ilike	string	[optional]
brand_name__ilike	string	[optional]
order_by	string	[optional] [default to 'score,name,brand_name,created_at,brand_description_bool,product_history_description_bool,technologies_bool']
limit	int	[optional] [default to 50]
offset	int	[optional] [default to 0]

Return type

\AkeneoPresales\DescrbAPI\Model\LimitOffsetPageProductDescriptionInDB

Authorization

OAuth2PasswordBearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`regenerateBrandDescriptionApiV1ProductRegenerateBrandDescriptionDescriptionIdPost()`

regenerateBrandDescriptionApiV1ProductRegenerateBrandDescriptionDescriptionIdPost($description_id): \AkeneoPresales\DescrbAPI\Model\BrandDescription

Regenerate Brand Description

Example

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


// Configure OAuth2 access token for authorization: OAuth2PasswordBearer
$config = AkeneoPresales\DescrbAPI\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new AkeneoPresales\DescrbAPI\Api\ProductApi(
    // 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
);
$description_id = 'description_id_example'; // string

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

Parameters

Name	Type	Description	Notes
description_id	string

Return type

\AkeneoPresales\DescrbAPI\Model\BrandDescription

Authorization

OAuth2PasswordBearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`regenerateDescriptionApiV1ProductRegenerateDescriptionDescriptionIdPost()`

regenerateDescriptionApiV1ProductRegenerateDescriptionDescriptionIdPost($description_id): \AkeneoPresales\DescrbAPI\Model\ProductDescription

Regenerate Description

Example

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


// Configure OAuth2 access token for authorization: OAuth2PasswordBearer
$config = AkeneoPresales\DescrbAPI\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new AkeneoPresales\DescrbAPI\Api\ProductApi(
    // 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
);
$description_id = 'description_id_example'; // string

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

Parameters

Name	Type	Description	Notes
description_id	string

Return type

\AkeneoPresales\DescrbAPI\Model\ProductDescription

Authorization

OAuth2PasswordBearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`regenerateEmptyApiV1ProductRegenerateEmptyDescriptionDescriptionIdPost()`

regenerateEmptyApiV1ProductRegenerateEmptyDescriptionDescriptionIdPost($description_id): mixed

Regenerate Empty

Example

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


// Configure OAuth2 access token for authorization: OAuth2PasswordBearer
$config = AkeneoPresales\DescrbAPI\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new AkeneoPresales\DescrbAPI\Api\ProductApi(
    // 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
);
$description_id = 'description_id_example'; // string

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

Parameters

Name	Type	Description	Notes
description_id	string

Return type

mixed

Authorization

OAuth2PasswordBearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`regenerateHistoryDescriptionApiV1ProductRegenerateHistoryDescriptionDescriptionIdPost()`

regenerateHistoryDescriptionApiV1ProductRegenerateHistoryDescriptionDescriptionIdPost($description_id): \AkeneoPresales\DescrbAPI\Model\ProductHistory

Regenerate History Description

Example

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


// Configure OAuth2 access token for authorization: OAuth2PasswordBearer
$config = AkeneoPresales\DescrbAPI\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new AkeneoPresales\DescrbAPI\Api\ProductApi(
    // 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
);
$description_id = 'description_id_example'; // string

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

Parameters

Name	Type	Description	Notes
description_id	string

Return type

\AkeneoPresales\DescrbAPI\Model\ProductHistory

Authorization

OAuth2PasswordBearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`regenerateTechnologyApiV1ProductRegenerateTechnologiesDescriptionDescriptionIdPost()`

regenerateTechnologyApiV1ProductRegenerateTechnologiesDescriptionDescriptionIdPost($description_id): \AkeneoPresales\DescrbAPI\Model\Technologies

Regenerate Technology

Example

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


// Configure OAuth2 access token for authorization: OAuth2PasswordBearer
$config = AkeneoPresales\DescrbAPI\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new AkeneoPresales\DescrbAPI\Api\ProductApi(
    // 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
);
$description_id = 'description_id_example'; // string

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

Parameters

Name	Type	Description	Notes
description_id	string

Return type

\AkeneoPresales\DescrbAPI\Model\Technologies

Authorization

OAuth2PasswordBearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`reviewBrandDescriptionApiV1ProductBrandDescriptionIdReviewPost()`

reviewBrandDescriptionApiV1ProductBrandDescriptionIdReviewPost($description_id, $brand_description_update): \AkeneoPresales\DescrbAPI\Model\BrandDescriptionUpdate

Review Brand Description

Get description by ID.

Example

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


// Configure OAuth2 access token for authorization: OAuth2PasswordBearer
$config = AkeneoPresales\DescrbAPI\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new AkeneoPresales\DescrbAPI\Api\ProductApi(
    // 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
);
$description_id = 'description_id_example'; // string
$brand_description_update = new \AkeneoPresales\DescrbAPI\Model\BrandDescriptionUpdate(); // \AkeneoPresales\DescrbAPI\Model\BrandDescriptionUpdate

try {
    $result = $apiInstance->reviewBrandDescriptionApiV1ProductBrandDescriptionIdReviewPost($description_id, $brand_description_update);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductApi->reviewBrandDescriptionApiV1ProductBrandDescriptionIdReviewPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
description_id	string
brand_description_update	\AkeneoPresales\DescrbAPI\Model\BrandDescriptionUpdate

Return type

\AkeneoPresales\DescrbAPI\Model\BrandDescriptionUpdate

Authorization

OAuth2PasswordBearer

HTTP request headers

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

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

`reviewDescriptionApiV1ProductDescriptionDescriptionIdReviewPost()`

reviewDescriptionApiV1ProductDescriptionDescriptionIdReviewPost($description_id, $product_description_update): \AkeneoPresales\DescrbAPI\Model\ProductDescriptionUpdate

Review Description

Get description by ID.

Example

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


// Configure OAuth2 access token for authorization: OAuth2PasswordBearer
$config = AkeneoPresales\DescrbAPI\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new AkeneoPresales\DescrbAPI\Api\ProductApi(
    // 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
);
$description_id = 'description_id_example'; // string
$product_description_update = new \AkeneoPresales\DescrbAPI\Model\ProductDescriptionUpdate(); // \AkeneoPresales\DescrbAPI\Model\ProductDescriptionUpdate

try {
    $result = $apiInstance->reviewDescriptionApiV1ProductDescriptionDescriptionIdReviewPost($description_id, $product_description_update);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductApi->reviewDescriptionApiV1ProductDescriptionDescriptionIdReviewPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
description_id	string
product_description_update	\AkeneoPresales\DescrbAPI\Model\ProductDescriptionUpdate

Return type

\AkeneoPresales\DescrbAPI\Model\ProductDescriptionUpdate

Authorization

OAuth2PasswordBearer

HTTP request headers

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

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

`reviewHistoryDescriptionApiV1ProductHistoryDescriptionIdReviewPost()`

reviewHistoryDescriptionApiV1ProductHistoryDescriptionIdReviewPost($description_id, $product_history_update): \AkeneoPresales\DescrbAPI\Model\ProductHistoryUpdate

Review History Description

Get description by ID.

Example

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


// Configure OAuth2 access token for authorization: OAuth2PasswordBearer
$config = AkeneoPresales\DescrbAPI\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new AkeneoPresales\DescrbAPI\Api\ProductApi(
    // 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
);
$description_id = 'description_id_example'; // string
$product_history_update = new \AkeneoPresales\DescrbAPI\Model\ProductHistoryUpdate(); // \AkeneoPresales\DescrbAPI\Model\ProductHistoryUpdate

try {
    $result = $apiInstance->reviewHistoryDescriptionApiV1ProductHistoryDescriptionIdReviewPost($description_id, $product_history_update);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductApi->reviewHistoryDescriptionApiV1ProductHistoryDescriptionIdReviewPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
description_id	string
product_history_update	\AkeneoPresales\DescrbAPI\Model\ProductHistoryUpdate

Return type

\AkeneoPresales\DescrbAPI\Model\ProductHistoryUpdate

Authorization

OAuth2PasswordBearer

HTTP request headers

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

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

`translateDescriptionApiV1ProductTranslateDescriptionDescriptionIdPost()`

translateDescriptionApiV1ProductTranslateDescriptionDescriptionIdPost($description_id, $language): mixed

Translate Description

Example

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


// Configure OAuth2 access token for authorization: OAuth2PasswordBearer
$config = AkeneoPresales\DescrbAPI\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new AkeneoPresales\DescrbAPI\Api\ProductApi(
    // 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
);
$description_id = 'description_id_example'; // string
$language = 'language_example'; // string

try {
    $result = $apiInstance->translateDescriptionApiV1ProductTranslateDescriptionDescriptionIdPost($description_id, $language);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductApi->translateDescriptionApiV1ProductTranslateDescriptionDescriptionIdPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
description_id	string
language	string

Return type

mixed

Authorization

OAuth2PasswordBearer

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

ProductApi.md

Latest commit

History

ProductApi.md

File metadata and controls

AkeneoPresales\DescrbAPI\ProductApi

createDemoProductAdApiV1ProductDemoPost()

Example

Parameters

Return type

Authorization

HTTP request headers

createProductAdApiV1ProductPost()

Example

Parameters

Return type

Authorization

HTTP request headers

editBrandDescriptionApiV1ProductBrandDescriptionIdPatch()

Example

Parameters

Return type

Authorization

HTTP request headers

editDescriptionApiV1ProductDescriptionDescriptionIdPatch()

Example

Parameters

Return type

Authorization

HTTP request headers

editHistoryDescriptionApiV1ProductHistoryDescriptionIdPatch()

Example

Parameters

Return type

Authorization

HTTP request headers

exportChosenToCsvApiV1ProductExportChosenPut()

Example

Parameters

Return type

Authorization

HTTP request headers

exportPageToCsvAdminPanelApiV1ProductAdminExportCurrentPageGet()

Example

Parameters

Return type

Authorization

HTTP request headers

exportPageToCsvApiV1ProductExportCurrentPageGet()

Example

Parameters

Return type

Authorization

HTTP request headers

exportToCsvAdminPanelApiV1ProductAdminExportAllGet()

Example

Parameters

Return type

Authorization

HTTP request headers

exportToCsvApiV1ProductExportAllGet()

Example

Parameters

Return type

Authorization

HTTP request headers

getDescriptionApiV1ProductDescriptionIdGet()

Example

Parameters

Return type

Authorization

HTTP request headers

readAllProductDescriptionsApiV1ProductAllGet()

Example

Parameters

Return type

Authorization

HTTP request headers

readUserProductDescriptionsApiV1ProductMyReviewsGet()

`createDemoProductAdApiV1ProductDemoPost()`

`createProductAdApiV1ProductPost()`

`editBrandDescriptionApiV1ProductBrandDescriptionIdPatch()`

`editDescriptionApiV1ProductDescriptionDescriptionIdPatch()`

`editHistoryDescriptionApiV1ProductHistoryDescriptionIdPatch()`

`exportChosenToCsvApiV1ProductExportChosenPut()`

`exportPageToCsvAdminPanelApiV1ProductAdminExportCurrentPageGet()`

`exportPageToCsvApiV1ProductExportCurrentPageGet()`

`exportToCsvAdminPanelApiV1ProductAdminExportAllGet()`

`exportToCsvApiV1ProductExportAllGet()`

`getDescriptionApiV1ProductDescriptionIdGet()`

`readAllProductDescriptionsApiV1ProductAllGet()`

`readUserProductDescriptionsApiV1ProductMyReviewsGet()`

`regenerateBrandDescriptionApiV1ProductRegenerateBrandDescriptionDescriptionIdPost()`

`regenerateDescriptionApiV1ProductRegenerateDescriptionDescriptionIdPost()`

`regenerateEmptyApiV1ProductRegenerateEmptyDescriptionDescriptionIdPost()`

`regenerateHistoryDescriptionApiV1ProductRegenerateHistoryDescriptionDescriptionIdPost()`

`regenerateTechnologyApiV1ProductRegenerateTechnologiesDescriptionDescriptionIdPost()`

`reviewBrandDescriptionApiV1ProductBrandDescriptionIdReviewPost()`

`reviewDescriptionApiV1ProductDescriptionDescriptionIdReviewPost()`

`reviewHistoryDescriptionApiV1ProductHistoryDescriptionIdReviewPost()`

`translateDescriptionApiV1ProductTranslateDescriptionDescriptionIdPost()`