OpenAPI\Client\ReturnsApi

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

Method	HTTP request	Description
getReturn()	GET /campaigns/{campaignId}/orders/{orderId}/returns/{returnId}	Информация о возврате или невыкупе
getReturnApplication()	GET /campaigns/{campaignId}/orders/{orderId}/returns/{returnId}/application	Получение заявления на возврат
getReturnPhoto()	GET /campaigns/{campaignId}/orders/{orderId}/returns/{returnId}/decision/{itemId}/image/{imageHash}	Получение фотографии возврата
getReturns()	GET /campaigns/{campaignId}/returns	Список возвратов и невыкупов
setReturnDecision()	POST /campaigns/{campaignId}/orders/{orderId}/returns/{returnId}/decision	Принятие/изменение решения по позиции в возврате
submitReturnDecision()	POST /campaigns/{campaignId}/orders/{orderId}/returns/{returnId}/decision/submit	Подтверждение решения по возвратным позициям

`getReturn()`

getReturn($campaign_id, $order_id, $return_id): \OpenAPI\Client\Model\GetReturnResponse

Информация о возврате или невыкупе

Получает информацию по одному возврату или невыкупу. |⚙️ Лимит: 10 000 запросов в час| |-|

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\ReturnsApi(
    // 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
);
$campaign_id = 56; // int | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.  Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).  ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
$order_id = 56; // int | Идентификатор заказа.
$return_id = 56; // int | Идентификатор возврата

try {
    $result = $apiInstance->getReturn($campaign_id, $order_id, $return_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReturnsApi->getReturn: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description
campaign_id	int	Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns. ℹ️ Что такое кабинет и магазин на Маркете
order_id	int	Идентификатор заказа.
return_id	int	Идентификатор возврата

Return type

\OpenAPI\Client\Model\GetReturnResponse

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]

`getReturnApplication()`

getReturnApplication($campaign_id, $order_id, $return_id): \SplFileObject

Получение заявления на возврат

Загружает заявление покупателя на возврат товара. |⚙️ Лимит: 10 000 запросов в час| |-|

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\ReturnsApi(
    // 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
);
$campaign_id = 56; // int | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.  Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).  ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
$order_id = 56; // int | Идентификатор заказа.
$return_id = 56; // int | Идентификатор возврата

try {
    $result = $apiInstance->getReturnApplication($campaign_id, $order_id, $return_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReturnsApi->getReturnApplication: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description
campaign_id	int	Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns. ℹ️ Что такое кабинет и магазин на Маркете
order_id	int	Идентификатор заказа.
return_id	int	Идентификатор возврата

Return type

\SplFileObject

Authorization

OAuth

HTTP request headers

Content-Type: Not defined
Accept: application/octet-stream, application/json

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

`getReturnPhoto()`

getReturnPhoto($campaign_id, $order_id, $return_id, $item_id, $image_hash): \SplFileObject

Получение фотографии возврата

Получает фотографии, которые покупатель приложил к заявлению на возврат товара. |⚙️ Лимит: 10 000 запросов в час| |-|

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\ReturnsApi(
    // 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
);
$campaign_id = 56; // int | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.  Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).  ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
$order_id = 56; // int | Идентификатор заказа.
$return_id = 56; // int | Идентификатор возврата
$item_id = 56; // int | Идентификатор товара в возврате
$image_hash = 'image_hash_example'; // string | Хеш ссылки изображения для загрузки

try {
    $result = $apiInstance->getReturnPhoto($campaign_id, $order_id, $return_id, $item_id, $image_hash);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReturnsApi->getReturnPhoto: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description
campaign_id	int	Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns. ℹ️ Что такое кабинет и магазин на Маркете
order_id	int	Идентификатор заказа.
return_id	int	Идентификатор возврата
item_id	int	Идентификатор товара в возврате
image_hash	string	Хеш ссылки изображения для загрузки

Return type

\SplFileObject

Authorization

OAuth

HTTP request headers

Content-Type: Not defined
Accept: application/octet-stream, application/json

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

`getReturns()`

getReturns($campaign_id, $page_token, $limit, $order_ids, $statuses, $type, $from_date, $to_date, $from_date2, $to_date2): \OpenAPI\Client\Model\GetReturnsResponse

Список возвратов и невыкупов

Получает список возвратов и невыкупов. Чтобы получить информацию по одному возврату или невыкупу, выполните запрос GET campaigns/{campaignId}/orders/{orderId}/returns/{returnId}. |⚙️ Лимит: 10 000 запросов в час| |-|

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\ReturnsApi(
    // 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
);
$campaign_id = 56; // int | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.  Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).  ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
$page_token = eyBuZXh0SWQ6IDIzNDIgfQ==; // string | Идентификатор страницы c результатами.  Если параметр не указан, возвращается самая старая страница.  Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.  Если задан `page_token`, параметры `offset`, `page_number` и `page_size` игнорируются.
$limit = 20; // int | Количество товаров на одной странице.
$order_ids = array(56); // int[] | Идентификаторы заказов — для фильтрации результатов.  Несколько идентификаторов перечисляются через запятую без пробела.
$statuses = STARTED_BY_USER,WAITING_FOR_DECISION; // \OpenAPI\Client\Model\RefundStatusType[] | Статусы возвратов или невыкупов — для фильтрации результатов.  Несколько статусов перечисляются через запятую.
$type = new \OpenAPI\Client\Model\ReturnType(); // ReturnType | Тип заказа для фильтрации:  * `RETURN` — возврат.  * `UNREDEEMED` — невыкуп.  Если не указывать, в ответе будут и возвраты, и невыкупы.
$from_date = 2022-10-31; // \DateTime | Начальные дата и время для фильтрации возвратов или невыкупов по дате оформления.  Формат: `ГГГГ-ММ-ДД`.
$to_date = 2022-11-30; // \DateTime | Конечные дата и время для фильтрации возвратов или невыкупов по дате оформления.  Формат: `ГГГГ-ММ-ДД`.
$from_date2 = 2022-10-31; // \DateTime | Дата, с которой интересуют возвраты (устаревшее, будет удалено).
$to_date2 = 2022-11-30; // \DateTime | Дата, до которой интересуют возвраты (устаревшее, будет удалено).

try {
    $result = $apiInstance->getReturns($campaign_id, $page_token, $limit, $order_ids, $statuses, $type, $from_date, $to_date, $from_date2, $to_date2);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReturnsApi->getReturns: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
campaign_id	int	Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns. ℹ️ Что такое кабинет и магазин на Маркете
page_token	string	Идентификатор страницы c результатами. Если параметр не указан, возвращается самая старая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token`, параметры `offset`, `page_number` и `page_size` игнорируются.	[optional]
limit	int	Количество товаров на одной странице.	[optional]
order_ids	int[]	Идентификаторы заказов — для фильтрации результатов. Несколько идентификаторов перечисляются через запятую без пробела.	[optional]
statuses	\OpenAPI\Client\Model\RefundStatusType[]	Статусы возвратов или невыкупов — для фильтрации результатов. Несколько статусов перечисляются через запятую.	[optional]
type	ReturnType	Тип заказа для фильтрации: * `RETURN` — возврат. * `UNREDEEMED` — невыкуп. Если не указывать, в ответе будут и возвраты, и невыкупы.	[optional]
from_date	\DateTime	Начальные дата и время для фильтрации возвратов или невыкупов по дате оформления. Формат: `ГГГГ-ММ-ДД`.	[optional]
to_date	\DateTime	Конечные дата и время для фильтрации возвратов или невыкупов по дате оформления. Формат: `ГГГГ-ММ-ДД`.	[optional]
from_date2	\DateTime	Дата, с которой интересуют возвраты (устаревшее, будет удалено).	[optional]
to_date2	\DateTime	Дата, до которой интересуют возвраты (устаревшее, будет удалено).	[optional]

Return type

\OpenAPI\Client\Model\GetReturnsResponse

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]

`setReturnDecision()`

setReturnDecision($campaign_id, $order_id, $return_id, $set_return_decision_request): \OpenAPI\Client\Model\EmptyApiResponse

Принятие/изменение решения по позиции в возврате

Выбирает решение по возврату от покупателя. После этого для подтверждения решения нужно выполнить запрос POST campaigns/{campaignId}/orders/{orderId}/returns/{returnId}/decision/submit. |⚙️ Лимит: 10 000 запросов в час| |-|

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\ReturnsApi(
    // 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
);
$campaign_id = 56; // int | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.  Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).  ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
$order_id = 56; // int | Идентификатор заказа.
$return_id = 56; // int | Идентификатор возврата
$set_return_decision_request = new \OpenAPI\Client\Model\SetReturnDecisionRequest(); // \OpenAPI\Client\Model\SetReturnDecisionRequest

try {
    $result = $apiInstance->setReturnDecision($campaign_id, $order_id, $return_id, $set_return_decision_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReturnsApi->setReturnDecision: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description
campaign_id	int	Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns. ℹ️ Что такое кабинет и магазин на Маркете
order_id	int	Идентификатор заказа.
return_id	int	Идентификатор возврата
set_return_decision_request	\OpenAPI\Client\Model\SetReturnDecisionRequest

Return type

\OpenAPI\Client\Model\EmptyApiResponse

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]

`submitReturnDecision()`

submitReturnDecision($campaign_id, $order_id, $return_id): \OpenAPI\Client\Model\EmptyApiResponse

Подтверждение решения по возвратным позициям

Подтверждает выбранное решение по возврату, отправленное в запросе POST campaigns/{campaignId}/orders/{orderId}/returns/{returnId}/decision. |⚙️ Лимит: 10 000 запросов в час| |-|

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\ReturnsApi(
    // 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
);
$campaign_id = 56; // int | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.  Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).  ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
$order_id = 56; // int | Идентификатор заказа.
$return_id = 56; // int | Идентификатор возврата

try {
    $result = $apiInstance->submitReturnDecision($campaign_id, $order_id, $return_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReturnsApi->submitReturnDecision: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description
campaign_id	int	Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns. ℹ️ Что такое кабинет и магазин на Маркете
order_id	int	Идентификатор заказа.
return_id	int	Идентификатор возврата

Return type

\OpenAPI\Client\Model\EmptyApiResponse

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]

Files

ReturnsApi.md

Latest commit

History

ReturnsApi.md

File metadata and controls

OpenAPI\Client\ReturnsApi

getReturn()

Example

Parameters

Return type

Authorization

HTTP request headers

getReturnApplication()

Example

Parameters

Return type

Authorization

HTTP request headers

getReturnPhoto()

Example

Parameters

Return type

Authorization

HTTP request headers

getReturns()

Example

Parameters

Return type

Authorization

HTTP request headers

setReturnDecision()

Example

Parameters

Return type

Authorization

HTTP request headers

submitReturnDecision()

Example

Parameters

Return type

Authorization

HTTP request headers

`getReturn()`

`getReturnApplication()`

`getReturnPhoto()`

`getReturns()`

`setReturnDecision()`

`submitReturnDecision()`