Skip to content

Latest commit

 

History

History
133 lines (90 loc) · 6.99 KB

OrderBusinessInformationApi.md

File metadata and controls

133 lines (90 loc) · 6.99 KB

OpenAPI\Client\OrderBusinessInformationApi

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

Method HTTP request Description
getOrderBusinessBuyerInfo() POST /campaigns/{campaignId}/orders/{orderId}/business-buyer Информация о покупателе — юридическом лице
getOrderBusinessDocumentsInfo() POST /campaigns/{campaignId}/orders/{orderId}/documents Информация о документах

getOrderBusinessBuyerInfo()

getOrderBusinessBuyerInfo($campaign_id, $order_id): \OpenAPI\Client\Model\GetBusinessBuyerInfoResponse

Информация о покупателе — юридическом лице

Возвращает информацию о покупателе по идентификатору заказа. {% note info "" %} Чтобы получить информацию о покупателе, который является физическим лицом, воспользуйтесь запросом GET campaigns/{campaignId}/orders/{orderId}/buyer. {% endnote %} Получить данные можно, только если заказ находится в статусе DELIVERY, PICKUP или DELIVERED. |⚙️ Лимит: 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\OrderBusinessInformationApi(
    // 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->getOrderBusinessBuyerInfo($campaign_id, $order_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrderBusinessInformationApi->getOrderBusinessBuyerInfo: ', $e->getMessage(), PHP_EOL;
}

Parameters

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

Return type

\OpenAPI\Client\Model\GetBusinessBuyerInfoResponse

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]

getOrderBusinessDocumentsInfo()

getOrderBusinessDocumentsInfo($campaign_id, $order_id): \OpenAPI\Client\Model\GetBusinessDocumentsInfoResponse

Информация о документах

Возвращает информацию о документах по идентификатору заказа. |⚙️ Лимит: 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\OrderBusinessInformationApi(
    // 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->getOrderBusinessDocumentsInfo($campaign_id, $order_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrderBusinessInformationApi->getOrderBusinessDocumentsInfo: ', $e->getMessage(), PHP_EOL;
}

Parameters

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

Return type

\OpenAPI\Client\Model\GetBusinessDocumentsInfoResponse

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]