OpenAPI\Client\ModelsApi

All URIs are relative to https://api.partner.market.yandex.ru, except if the operation defines another base path.

Method	HTTP request	Description
getModel()	GET /models/{modelId}	Информация о модели
getModelOffers()	GET /models/{modelId}/offers	Список предложений для модели
getModels()	POST /models	Информация о нескольких моделях
getModelsOffers()	POST /models/offers	Список предложений для нескольких моделей
searchModels()	GET /models	Поиск модели товара

`getModel()`

getModel($model_id, $region_id, $currency): \OpenAPI\Client\Model\GetModelsResponse

Информация о модели

Возвращает информацию о модели товара. Для методов GET models, GET models/{modelId} и POST models действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество моделей, информация о которых запрошена при помощи этих методов. |⚙️ Лимит: рассчитывается индивидуально| |-| [//]: <> (rule: Суточный лимит зависит от количества предложений на карточках моделей и активных магазинов клиента. Количество предложений считается по данным за последние семь дней, не включая сегодня. Для новых магазинов, еще не разместивших предложения, ограничение равно 0 и пересчитывается на следующий день после размещения первых предложений. Для клиентов с несколькими магазинами ограничение рассчитывается с учетом количества предложений, являющегося максимальным среди всех магазинов клиента. Для агентств ограничение суммируется по всем субклиентам агентства.)

Example

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


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


$apiInstance = new OpenAPI\Client\Api\ModelsApi(
    // 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
);
$model_id = 56; // int | Идентификатор модели товара.
$region_id = 56; // int | Идентификатор региона.  Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).
$currency = new \OpenAPI\Client\Model\CurrencyType(); // CurrencyType | Валюта, в которой отображаются цены предложений на страницах с результатами поиска.  Возможные значения:  * `BYN` — белорусский рубль.  * `KZT` — казахстанский тенге.  * `RUR` — российский рубль.  * `UAH` — украинская гривна.  Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).

try {
    $result = $apiInstance->getModel($model_id, $region_id, $currency);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModelsApi->getModel: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
model_id	int	Идентификатор модели товара.
region_id	int	Идентификатор региона. Идентификатор региона можно получить c помощью запроса GET regions.
currency	CurrencyType	Валюта, в которой отображаются цены предложений на страницах с результатами поиска. Возможные значения: * `BYN` — белорусский рубль. * `KZT` — казахстанский тенге. * `RUR` — российский рубль. * `UAH` — украинская гривна. Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).	[optional]

Return type

\OpenAPI\Client\Model\GetModelsResponse

Authorization

OAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`getModelOffers()`

getModelOffers($model_id, $region_id, $currency, $order_by_price, $count, $page): \OpenAPI\Client\Model\GetModelsOffersResponse

Список предложений для модели

Возвращает информацию о первых десяти предложениях, расположенных на карточке модели. Предложения выдаются для определенного региона и располагаются в том же порядке, в котором они показываются в выдаче Маркета на карточке модели. Для групповых моделей метод не поддерживается. Идентификатор групповой модели игнорируется. Для методов GET models/{modelId}/offers и POST models/offers действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество моделей, информация о которых запрошена при помощи этих методов. |⚙️ Лимит: рассчитывается индивидуально| |-| [//]: <> (rule: Суточный лимит зависит от количества предложений на карточках моделей и активных магазинов клиента. Количество предложений считается по данным за последние семь дней, не включая сегодня. Для новых магазинов, еще не разместивших предложения, ограничение равно 0 и пересчитывается на следующий день после размещения первых предложений. Для клиентов с несколькими магазинами ограничение рассчитывается с учетом количества предложений, являющегося максимальным среди всех магазинов клиента. Для агентств ограничение суммируется по всем субклиентам агентства.)

Example

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


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


$apiInstance = new OpenAPI\Client\Api\ModelsApi(
    // 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
);
$model_id = 56; // int | Идентификатор модели товара.
$region_id = 56; // int | Идентификатор региона.  Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).
$currency = new \OpenAPI\Client\Model\CurrencyType(); // CurrencyType | Валюта, в которой отображаются цены предложений на страницах с результатами поиска.  Возможные значения:  * `BYN` — белорусский рубль.  * `KZT` — казахстанский тенге.  * `RUR` — российский рубль.  * `UAH` — украинская гривна.  Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).
$order_by_price = new \OpenAPI\Client\Model\SortOrderType(); // SortOrderType | Направление сортировки по цене.  Возможные значения: * `ASC` — сортировка по возрастанию. * `DESC` — сортировка по убыванию.  Значение по умолчанию: предложения выводятся в произвольном порядке.
$count = 10; // int | Количество предложений на странице ответа.
$page = 1; // int | Номер страницы результатов.  Значение по умолчанию: 1.  Используется вместе с параметром `page_size`.  `page_number` игнорируется, если задан `page_token`, `limit` или `offset`.

try {
    $result = $apiInstance->getModelOffers($model_id, $region_id, $currency, $order_by_price, $count, $page);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModelsApi->getModelOffers: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
model_id	int	Идентификатор модели товара.
region_id	int	Идентификатор региона. Идентификатор региона можно получить c помощью запроса GET regions.
currency	CurrencyType	Валюта, в которой отображаются цены предложений на страницах с результатами поиска. Возможные значения: * `BYN` — белорусский рубль. * `KZT` — казахстанский тенге. * `RUR` — российский рубль. * `UAH` — украинская гривна. Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).	[optional]
order_by_price	SortOrderType	Направление сортировки по цене. Возможные значения: * `ASC` — сортировка по возрастанию. * `DESC` — сортировка по убыванию. Значение по умолчанию: предложения выводятся в произвольном порядке.	[optional]
count	int	Количество предложений на странице ответа.	[optional] [default to 10]
page	int	Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `page_size`. `page_number` игнорируется, если задан `page_token`, `limit` или `offset`.	[optional] [default to 1]

Return type

\OpenAPI\Client\Model\GetModelsOffersResponse

Authorization

OAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`getModels()`

getModels($region_id, $get_models_request, $currency): \OpenAPI\Client\Model\GetModelsResponse

Информация о нескольких моделях

Возвращает информацию о моделях товаров. В одном запросе можно получить информацию не более чем о 100 моделях. Для методов GET models, GET models/{modelId} и POST models действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество моделей, информация о которых запрошена при помощи этих методов. |⚙️ Лимит: рассчитывается индивидуально| |-| [//]: <> (rule: Суточный лимит зависит от количества предложений на карточках моделей и активных магазинов клиента. Количество предложений считается по данным за последние семь дней, не включая сегодня. Для новых магазинов, еще не разместивших предложения, ограничение равно 0 и пересчитывается на следующий день после размещения первых предложений. Для клиентов с несколькими магазинами ограничение рассчитывается с учетом количества предложений, являющегося максимальным среди всех магазинов клиента. Для агентств ограничение суммируется по всем субклиентам агентства.)

Example

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


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


$apiInstance = new OpenAPI\Client\Api\ModelsApi(
    // 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
);
$region_id = 56; // int | Идентификатор региона.  Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).
$get_models_request = new \OpenAPI\Client\Model\GetModelsRequest(); // \OpenAPI\Client\Model\GetModelsRequest
$currency = new \OpenAPI\Client\Model\CurrencyType(); // CurrencyType | Валюта, в которой отображаются цены предложений на страницах с результатами поиска.  Возможные значения:  * `BYN` — белорусский рубль.  * `KZT` — казахстанский тенге.  * `RUR` — российский рубль.  * `UAH` — украинская гривна.  Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).

try {
    $result = $apiInstance->getModels($region_id, $get_models_request, $currency);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModelsApi->getModels: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
region_id	int	Идентификатор региона. Идентификатор региона можно получить c помощью запроса GET regions.
get_models_request	\OpenAPI\Client\Model\GetModelsRequest
currency	CurrencyType	Валюта, в которой отображаются цены предложений на страницах с результатами поиска. Возможные значения: * `BYN` — белорусский рубль. * `KZT` — казахстанский тенге. * `RUR` — российский рубль. * `UAH` — украинская гривна. Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).	[optional]

Return type

\OpenAPI\Client\Model\GetModelsResponse

Authorization

OAuth

HTTP request headers

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

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

`getModelsOffers()`

getModelsOffers($region_id, $get_models_request, $currency, $order_by_price): \OpenAPI\Client\Model\GetModelsOffersResponse

Список предложений для нескольких моделей

Возвращает информацию о первых десяти предложениях, расположенных на карточках моделей, идентификаторы которых указаны в запросе. Предложения выдаются для определенного региона и располагаются в том же порядке, в котором они показываются в выдаче Маркета на карточке модели. Для групповых моделей выдача предложений не поддерживается. Идентификаторы групповых моделей игнорируются. В одном запросе можно получить информацию о предложениях не более чем для 100 моделей. Для методов GET models/{modelId}/offers и POST models/offers действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество моделей, информация о которых запрошена при помощи этих методов. |⚙️ Лимит: рассчитывается индивидуально| |-| [//]: <> (rule: Суточный лимит зависит от количества предложений на карточках моделей и активных магазинов клиента. Количество предложений считается по данным за последние семь дней, не включая сегодня. Для новых магазинов, еще не разместивших предложения, ограничение равно 0 и пересчитывается на следующий день после размещения первых предложений. Для клиентов с несколькими магазинами ограничение рассчитывается с учетом количества предложений, являющегося максимальным среди всех магазинов клиента. Для агентств ограничение суммируется по всем субклиентам агентства.)

Example

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


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


$apiInstance = new OpenAPI\Client\Api\ModelsApi(
    // 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
);
$region_id = 56; // int | Идентификатор региона.  Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).
$get_models_request = new \OpenAPI\Client\Model\GetModelsRequest(); // \OpenAPI\Client\Model\GetModelsRequest
$currency = new \OpenAPI\Client\Model\CurrencyType(); // CurrencyType | Валюта, в которой отображаются цены предложений на страницах с результатами поиска.  Возможные значения:  * `BYN` — белорусский рубль.  * `KZT` — казахстанский тенге.  * `RUR` — российский рубль.  * `UAH` — украинская гривна.  Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).
$order_by_price = new \OpenAPI\Client\Model\SortOrderType(); // SortOrderType | Направление сортировки по цене.  Возможные значения: * `ASC` — сортировка по возрастанию. * `DESC` — сортировка по убыванию.  Значение по умолчанию: предложения выводятся в произвольном порядке.

try {
    $result = $apiInstance->getModelsOffers($region_id, $get_models_request, $currency, $order_by_price);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModelsApi->getModelsOffers: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
region_id	int	Идентификатор региона. Идентификатор региона можно получить c помощью запроса GET regions.
get_models_request	\OpenAPI\Client\Model\GetModelsRequest
currency	CurrencyType	Валюта, в которой отображаются цены предложений на страницах с результатами поиска. Возможные значения: * `BYN` — белорусский рубль. * `KZT` — казахстанский тенге. * `RUR` — российский рубль. * `UAH` — украинская гривна. Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).	[optional]
order_by_price	SortOrderType	Направление сортировки по цене. Возможные значения: * `ASC` — сортировка по возрастанию. * `DESC` — сортировка по убыванию. Значение по умолчанию: предложения выводятся в произвольном порядке.	[optional]

Return type

\OpenAPI\Client\Model\GetModelsOffersResponse

Authorization

OAuth

HTTP request headers

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

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

`searchModels()`

searchModels($query, $region_id, $currency, $page, $page_size): \OpenAPI\Client\Model\SearchModelsResponse

Поиск модели товара

Возвращает информацию о моделях, удовлетворяющих заданным в запросе условиям поиска. В одном запросе можно получить информацию не более чем о 100 моделях. Для методов GET models, GET models/{modelId} и POST models действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество моделей, информация о которых запрошена при помощи этих методов. |⚙️ Лимит: рассчитывается индивидуально| |-| [//]: <> (rule: Суточный лимит зависит от количества предложений на карточках моделей и активных магазинов клиента. Количество предложений считается по данным за последние семь дней, не включая сегодня. Для новых магазинов, еще не разместивших предложения, ограничение равно 0 и пересчитывается на следующий день после размещения первых предложений. Для клиентов с несколькими магазинами ограничение рассчитывается с учетом количества предложений, являющегося максимальным среди всех магазинов клиента. Для агентств ограничение суммируется по всем субклиентам агентства.)

Example

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


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


$apiInstance = new OpenAPI\Client\Api\ModelsApi(
    // 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
);
$query = 'query_example'; // string | Поисковый запрос по названию модели товара.
$region_id = 56; // int | Идентификатор региона.  Идентификатор региона можно получить c помощью запроса [GET regions](../../reference/regions/searchRegionsByName.md).
$currency = new \OpenAPI\Client\Model\CurrencyType(); // CurrencyType | Валюта, в которой отображаются цены предложений на страницах с результатами поиска.  Возможные значения:  * `BYN` — белорусский рубль.  * `KZT` — казахстанский тенге.  * `RUR` — российский рубль.  * `UAH` — украинская гривна.  Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).
$page = 1; // int | Номер страницы результатов.  Значение по умолчанию: 1.  Используется вместе с параметром `page_size`.  `page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
$page_size = 56; // int | Размер страницы.  Используется вместе с параметром `page_number`.  `page_size` игнорируется, если задан `page_token`, `limit` или `offset`.

try {
    $result = $apiInstance->searchModels($query, $region_id, $currency, $page, $page_size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModelsApi->searchModels: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
query	string	Поисковый запрос по названию модели товара.
region_id	int	Идентификатор региона. Идентификатор региона можно получить c помощью запроса GET regions.
currency	CurrencyType	Валюта, в которой отображаются цены предложений на страницах с результатами поиска. Возможные значения: * `BYN` — белорусский рубль. * `KZT` — казахстанский тенге. * `RUR` — российский рубль. * `UAH` — украинская гривна. Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).	[optional]
page	int	Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `page_size`. `page_number` игнорируется, если задан `page_token`, `limit` или `offset`.	[optional] [default to 1]
page_size	int	Размер страницы. Используется вместе с параметром `page_number`. `page_size` игнорируется, если задан `page_token`, `limit` или `offset`.	[optional]

Return type

\OpenAPI\Client\Model\SearchModelsResponse

Authorization

OAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ModelsApi.md

ModelsApi.md

OpenAPI\Client\ModelsApi

`getModel()`

Example

Parameters

Return type

Authorization

HTTP request headers

`getModelOffers()`

Example

Parameters

Return type

Authorization

HTTP request headers

`getModels()`

Example

Parameters

Return type

Authorization

HTTP request headers

`getModelsOffers()`

Example

Parameters

Return type

Authorization

HTTP request headers

`searchModels()`

Example

Parameters

Return type

Authorization

HTTP request headers

Files

ModelsApi.md

Latest commit

History

ModelsApi.md

File metadata and controls

OpenAPI\Client\ModelsApi

getModel()

Example

Parameters

Return type

Authorization

HTTP request headers

getModelOffers()

Example

Parameters

Return type

Authorization

HTTP request headers

getModels()

Example

Parameters

Return type

Authorization

HTTP request headers

getModelsOffers()

Example

Parameters

Return type

Authorization

HTTP request headers

searchModels()

Example

Parameters

Return type

Authorization

HTTP request headers

`getModel()`

`getModelOffers()`

`getModels()`

`getModelsOffers()`

`searchModels()`