OpenAPI\Client\OrderDeliveryApi

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

Method	HTTP request	Description
getOrderBuyerInfo()	GET /campaigns/{campaignId}/orders/{orderId}/buyer	Информация о покупателе — физическом лице (DBS)
setOrderDeliveryDate()	PUT /campaigns/{campaignId}/orders/{orderId}/delivery/date	Изменение даты доставки заказа
setOrderDeliveryTrackCode()	POST /campaigns/{campaignId}/orders/{orderId}/delivery/track	Передача трек‑номера посылки (DBS)
updateOrderStorageLimit()	PUT /campaigns/{campaignId}/orders/{orderId}/delivery/storage-limit	Продление срока хранения заказа
verifyOrderEac()	PUT /campaigns/{campaignId}/orders/{orderId}/verifyEac	Передача кода проверки

`getOrderBuyerInfo()`

getOrderBuyerInfo($campaign_id, $order_id): \OpenAPI\Client\Model\GetOrderBuyerInfoResponse

Информация о покупателе — физическом лице (DBS)

Возвращает информацию о покупателе по идентификатору заказа. {% note info "" %} Чтобы получить информацию о покупателе, который является юридическим лицом, воспользуйтесь запросом POST campaigns/{campaignId}/orders/{orderId}/business-buyer. {% endnote %} Получить данные можно, только если заказ находится в статусе PROCESSING, DELIVERY или PICKUP. |⚙️ Лимит: 3 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\OrderDeliveryApi(
    // 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 | Идентификатор заказа.

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

Parameters

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

Return type

\OpenAPI\Client\Model\GetOrderBuyerInfoResponse

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]

`setOrderDeliveryDate()`

setOrderDeliveryDate($campaign_id, $order_id, $set_order_delivery_date_request): \OpenAPI\Client\Model\EmptyApiResponse

Изменение даты доставки заказа

Метод изменяет дату доставки заказа в статусе PROCESSING или DELIVERY. Для заказов с другими статусами дату доставки изменить нельзя. |⚙️ Лимит: 1 000 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\OrderDeliveryApi(
    // 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 | Идентификатор заказа.
$set_order_delivery_date_request = new \OpenAPI\Client\Model\SetOrderDeliveryDateRequest(); // \OpenAPI\Client\Model\SetOrderDeliveryDateRequest

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

Parameters

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

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]

`setOrderDeliveryTrackCode()`

setOrderDeliveryTrackCode($campaign_id, $order_id, $set_order_delivery_track_code_request): \OpenAPI\Client\Model\EmptyApiResponse

Передача трек‑номера посылки (DBS)

{% note warning "Этот запрос только для DBS" %} Вы можете использовать запрос, чтобы повысить лояльность покупателей. Если они могут узнать, на каком этапе доставки находятся их заказы, доверие покупателей к вашему магазину может возрасти. {% endnote %} Передает Маркету трек‑номер, по которому покупатель может отследить посылку со своим заказом через службу доставки. Передать трек‑номер можно, только если заказ находится в статусе PROCESSING, DELIVERY или PICKUP. |⚙️ Лимит: 1 000 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\OrderDeliveryApi(
    // 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 | Идентификатор заказа.
$set_order_delivery_track_code_request = new \OpenAPI\Client\Model\SetOrderDeliveryTrackCodeRequest(); // \OpenAPI\Client\Model\SetOrderDeliveryTrackCodeRequest

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

Parameters

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

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]

`updateOrderStorageLimit()`

updateOrderStorageLimit($campaign_id, $order_id, $update_order_storage_limit_request): \OpenAPI\Client\Model\EmptyApiResponse

Продление срока хранения заказа

Продлевает срок хранения заказа в пункте выдачи продавца. Заказ должен быть в статусе PICKUP. Продлить срок можно только один раз, не больше чем на 30 дней. Новый срок хранения можно получить в параметре outletStorageLimitDate запроса GET campaigns/{campaignId}/orders/{orderId}. |⚙️ Лимит: 1 000 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\OrderDeliveryApi(
    // 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 | Идентификатор заказа.
$update_order_storage_limit_request = new \OpenAPI\Client\Model\UpdateOrderStorageLimitRequest(); // \OpenAPI\Client\Model\UpdateOrderStorageLimitRequest

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

Parameters

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

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]

`verifyOrderEac()`

verifyOrderEac($campaign_id, $order_id, $verify_order_eac_request): \OpenAPI\Client\Model\VerifyOrderEacResponse

Передача кода проверки

Отправляет Маркету код подтверждения для его проверки. Код подтверждает передачу заказа или невыкупа: * курьеру — курьер должен назвать магазину код; * магазину — магазин называет код курьеру. Если магазин получает невыкупленный заказ, то ему нужно назвать курьеру код из личного кабинета или приложения. Если у магазина настроена работа с кодами подтверждения, в запросах POST order/status, PUT campaigns/{campaignId}/orders/{orderId}/status, GET campaigns/{campaignId}/orders, GET campaigns/{campaignId}/orders/{orderId} в параметре delivery, вложенном в order будет возвращаться параметр eacType с типом Enum — тип кода подтверждения для передачи заказа. Возможные значения: MERCHANT_TO_COURIER — магазин называет код курьеру, COURIER_TO_MERCHANT — курьер называет код магазину. Параметр eacType возвращается при статусах заказа COURIER_FOUND, COURIER_ARRIVED_TO_SENDER и DELIVERY_SERVICE_UNDELIVERED. Если заказ в других статусах, параметр может отсутствовать. |⚙️ Лимит: 1 000 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\OrderDeliveryApi(
    // 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 | Идентификатор заказа.
$verify_order_eac_request = new \OpenAPI\Client\Model\VerifyOrderEacRequest(); // \OpenAPI\Client\Model\VerifyOrderEacRequest

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

Parameters

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

Return type

\OpenAPI\Client\Model\VerifyOrderEacResponse

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]

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

OrderDeliveryApi.md

OrderDeliveryApi.md

OpenAPI\Client\OrderDeliveryApi

`getOrderBuyerInfo()`

Example

Parameters

Return type

Authorization

HTTP request headers

`setOrderDeliveryDate()`

Example

Parameters

Return type

Authorization

HTTP request headers

`setOrderDeliveryTrackCode()`

Example

Parameters

Return type

Authorization

HTTP request headers

`updateOrderStorageLimit()`

Example

Parameters

Return type

Authorization

HTTP request headers

`verifyOrderEac()`

Example

Parameters

Return type

Authorization

HTTP request headers

Files

OrderDeliveryApi.md

Latest commit

History

OrderDeliveryApi.md

File metadata and controls

OpenAPI\Client\OrderDeliveryApi

getOrderBuyerInfo()

Example

Parameters

Return type

Authorization

HTTP request headers

setOrderDeliveryDate()

Example

Parameters

Return type

Authorization

HTTP request headers

setOrderDeliveryTrackCode()

Example

Parameters

Return type

Authorization

HTTP request headers

updateOrderStorageLimit()

Example

Parameters

Return type

Authorization

HTTP request headers

verifyOrderEac()

Example

Parameters

Return type

Authorization

HTTP request headers

`getOrderBuyerInfo()`

`setOrderDeliveryDate()`

`setOrderDeliveryTrackCode()`

`updateOrderStorageLimit()`

`verifyOrderEac()`