Swagger\Client\ProductsApi

All URIs are relative to https://api.{environment}

Method	HTTP request	Description
getFlatProductParametersUsingGET	GET /sale/categories/{categoryId}/product-parameters	Get product parameters available in given category
getProductChangeProposal	GET /sale/products/change-proposals/{changeProposalId}	Get all data of the particular product changes proposal
getSaleProduct	GET /sale/products/{productId}	Get all data of the particular product
getSaleProducts	GET /sale/products	Get search products results
productChangeProposal	POST /sale/products/{productId}/change-proposals	Propose changes in product
proposeSaleProduct	POST /sale/product-proposals	Propose a product

getFlatProductParametersUsingGET

\Swagger\Client\Model\CategoryProductParameterList getFlatProductParametersUsingGET($category_id)

Get product parameters available in given category

Use this resource to get the list of product parameters available in given category. You can use these parameters to create a new product. Read more: <a href="../../productization/#6-jak-dodać-produkt" target="_blank">PL / <a href="../../en/productization/#6-how-to-create-a-product" target="_blank">EN.

Example

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

// Configure OAuth2 access token for authorization: bearer-token-for-application
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: bearer-token-for-user
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Swagger\Client\Api\ProductsApi(
    // 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 = "category_id_example"; // string | The category ID.

try {
    $result = $apiInstance->getFlatProductParametersUsingGET($category_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductsApi->getFlatProductParametersUsingGET: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
category_id	string	The category ID.

Return type

\Swagger\Client\Model\CategoryProductParameterList

Authorization

bearer-token-for-application, bearer-token-for-user

HTTP request headers

Content-Type: Not defined
Accept: application/vnd.allegro.public.v1+json

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

getProductChangeProposal

\Swagger\Client\Model\ProductChangeProposalDto getProductChangeProposal($change_proposal_id)

Get all data of the particular product changes proposal

Use this resource to retrieve all data of the particular product changes proposal.

Example

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

// Configure OAuth2 access token for authorization: bearer-token-for-user
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Swagger\Client\Api\ProductsApi(
    // 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
);
$change_proposal_id = "change_proposal_id_example"; // string | The product changes proposal identifier.

try {
    $result = $apiInstance->getProductChangeProposal($change_proposal_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductsApi->getProductChangeProposal: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
change_proposal_id	string	The product changes proposal identifier.

Return type

\Swagger\Client\Model\ProductChangeProposalDto

Authorization

bearer-token-for-user

HTTP request headers

Content-Type: Not defined
Accept: application/vnd.allegro.public.v1+json

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

getSaleProduct

\Swagger\Client\Model\SaleProductDto getSaleProduct($product_id, $category_id)

Get all data of the particular product

Use this resource to retrieve all data of the particular product. Read more: <a href="../../productization/#3-jak-pobrać-pełne-dane-o-produkcie" target="_blank">PL / <a href="../../en/productization/#3-how-to-get-the-complete-data-on-a-product" target="_blank">EN.

Example

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

// Configure OAuth2 access token for authorization: bearer-token-for-user
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Swagger\Client\Api\ProductsApi(
    // 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 = "product_id_example"; // string | The product identifier.
$category_id = "category_id_example"; // string | The similar category identifier. You can choose a category from 'similar categories' to filter the list of parameters available in the category context.

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

Parameters

Name	Type	Description	Notes
product_id	string	The product identifier.
category_id	string	The similar category identifier. You can choose a category from 'similar categories' to filter the list of parameters available in the category context.	[optional]

Return type

\Swagger\Client\Model\SaleProductDto

Authorization

bearer-token-for-user

HTTP request headers

Content-Type: Not defined
Accept: application/vnd.allegro.public.v1+json

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

getSaleProducts

\Swagger\Client\Model\GetSaleProductsResponse getSaleProducts($ean, $phrase, $category_id, $dynamic_filters, $page_id, $search_features)

Get search products results

Use this resource to get a list of products according to provided parameters. At least ean or phrase parameter is required. Read more: <a href="../../productization/#2-jak-wyszukać-produkt" target="_blank">PL / <a href="../../en/productization/#2-how-to-search-for-products" target="_blank">EN.

Example

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

// Configure OAuth2 access token for authorization: bearer-token-for-user
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Swagger\Client\Api\ProductsApi(
    // 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
);
$ean = "ean_example"; // string | The EAN values can include EAN, ISBN, and UPC identifier types.
$phrase = "phrase_example"; // string | Search phrase.
$category_id = "category_id_example"; // string | The category identifier to filter results. This can only be used when searching by phrase.
$dynamic_filters = array('key' => "dynamic_filters_example"); // map[string,string] | You can filter and customize your search results to find exactly what you need by applying filters ids and their dictionary values to query according to the flowing pattern: id=value. When the filter definition looks like:   ````   {     \"id\": \"127448\",     \"name\": \"Kolor\",     \"type\": \"SINGLE\",     \"values\": [       {         \"name\": \"biały\",         \"value\": \"2\"       },       {         \"name\": \"czarny\",         \"value\": \"1\" }     ]   }   ```` You can use 'Kolor' filter to query results, i.e.:   * `127448=2` for \"biały\"   * `127448=1` for \"czarny\".
$page_id = "page_id_example"; // string | A \"cursor\" to the next set of results.
$search_features = "search_features_example"; // string | Enables additional search options: - *SIMILAR_CATEGORIES* - searching in the indicated category (category.id) and in 'similar categories' (works only if category.id is a leaf category).

try {
    $result = $apiInstance->getSaleProducts($ean, $phrase, $category_id, $dynamic_filters, $page_id, $search_features);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductsApi->getSaleProducts: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
ean	string	The EAN values can include EAN, ISBN, and UPC identifier types.	[optional]
phrase	string	Search phrase.	[optional]
category_id	string	The category identifier to filter results. This can only be used when searching by phrase.	[optional]
dynamic_filters	map[string,string]	You can filter and customize your search results to find exactly what you need by applying filters ids and their dictionary values to query according to the flowing pattern: id=value. When the filter definition looks like: ```` { "id": "127448", "name": "Kolor", "type": "SINGLE", "values": [ { "name": "biały", "value": "2" }, { "name": "czarny", "value": "1" } ] } ```` You can use 'Kolor' filter to query results, i.e.: * `127448=2` for "biały" * `127448=1` for "czarny".	[optional]
page_id	string	A "cursor" to the next set of results.	[optional]
search_features	string	Enables additional search options: - SIMILAR_CATEGORIES - searching in the indicated category (category.id) and in 'similar categories' (works only if category.id is a leaf category).	[optional]

Return type

\Swagger\Client\Model\GetSaleProductsResponse

Authorization

bearer-token-for-user

HTTP request headers

Content-Type: Not defined
Accept: application/vnd.allegro.public.v1+json

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

productChangeProposal

\Swagger\Client\Model\ProductChangeProposalDto productChangeProposal($body, $product_id)

Propose changes in product

Use this resource to propose changes in product.

Example

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

// Configure OAuth2 access token for authorization: bearer-token-for-user
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Swagger\Client\Api\ProductsApi(
    // 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
);
$body = new \Swagger\Client\Model\ProductChangeProposalRequest(); // \Swagger\Client\Model\ProductChangeProposalRequest | 
$product_id = "product_id_example"; // string | The product identifier.

try {
    $result = $apiInstance->productChangeProposal($body, $product_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductsApi->productChangeProposal: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
body	\Swagger\Client\Model\ProductChangeProposalRequest
product_id	string	The product identifier.

Return type

\Swagger\Client\Model\ProductChangeProposalDto

Authorization

bearer-token-for-user

HTTP request headers

Content-Type: application/vnd.allegro.public.v1+json
Accept: application/vnd.allegro.public.v1+json

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

proposeSaleProduct

\Swagger\Client\Model\SaleProductDto proposeSaleProduct($body)

Propose a product

Use this resource to propose a product. Read more: <a href="../../productization/#6-jak-dodać-produkt" target="_blank">PL / <a href="../../en/productization/#6-how-to-create-a-product" target="_blank">EN.

Example

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

// Configure OAuth2 access token for authorization: bearer-token-for-user
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Swagger\Client\Api\ProductsApi(
    // 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
);
$body = new \Swagger\Client\Model\ProposeSaleProductRequest(); // \Swagger\Client\Model\ProposeSaleProductRequest | 

try {
    $result = $apiInstance->proposeSaleProduct($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductsApi->proposeSaleProduct: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
body	\Swagger\Client\Model\ProposeSaleProductRequest

Return type

\Swagger\Client\Model\SaleProductDto

Authorization

bearer-token-for-user

HTTP request headers

Content-Type: application/vnd.allegro.public.v1+json
Accept: application/vnd.allegro.public.v1+json

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

Files

ProductsApi.md

Latest commit

History

ProductsApi.md

File metadata and controls

Swagger\Client\ProductsApi

getFlatProductParametersUsingGET

Example

Parameters

Return type

Authorization

HTTP request headers

getProductChangeProposal

Example

Parameters

Return type

Authorization

HTTP request headers

getSaleProduct

Example

Parameters

Return type

Authorization

HTTP request headers

getSaleProducts

Example

Parameters

Return type

Authorization

HTTP request headers

productChangeProposal

Example

Parameters

Return type

Authorization

HTTP request headers

proposeSaleProduct

Example

Parameters

Return type

Authorization

HTTP request headers