Skip to content

Latest commit

 

History

History
204 lines (141 loc) · 11.1 KB

OrderLabelsApi.md

File metadata and controls

204 lines (141 loc) · 11.1 KB
Raw

YandexMarketApi\OrderLabelsApi

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

Method HTTP request Description
generateOrderLabel() GET /campaigns/{campaignId}/orders/{orderId}/delivery/shipments/{shipmentId}/boxes/{boxId}/label Ярлык‑наклейка для коробки в заказе
generateOrderLabels() GET /campaigns/{campaignId}/orders/{orderId}/delivery/labels Ярлыки‑наклейки на все грузовые места в заказе
getOrderLabelsData() GET /campaigns/{campaignId}/orders/{orderId}/delivery/labels/data Информация на ярлыках‑наклейках

generateOrderLabel()

generateOrderLabel($campaign_id, $order_id, $shipment_id, $box_id, $format): \SplFileObject

Ярлык‑наклейка для коробки в заказе

Формирует ярлык‑наклейку для коробки в заказе и возвращает ярлык в PDF‑файле. |⚙️ Лимит: 1 000 000 запросов в час| |-|

Example

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


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


$apiInstance = new YandexMarketApi\Api\OrderLabelsApi(
    // 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 | Идентификатор заказа.
$shipment_id = 56; // int | Идентификатор грузоместа.
$box_id = 56; // int | Идентификатор коробки.
$format = new \YandexMarketApi\Model\PageFormatType(); // PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6.

try {
    $result = $apiInstance->generateOrderLabel($campaign_id, $order_id, $shipment_id, $box_id, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrderLabelsApi->generateOrderLabel: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
campaign_id int Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns. ℹ️ Что такое кабинет и магазин на Маркете
order_id int Идентификатор заказа.
shipment_id int Идентификатор грузоместа.
box_id int Идентификатор коробки.
format PageFormatType Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6. [optional]

Return type

\SplFileObject

Authorization

OAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/pdf, application/json

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

generateOrderLabels()

generateOrderLabels($campaign_id, $order_id, $format): \SplFileObject

Ярлыки‑наклейки на все грузовые места в заказе

Возвращает PDF-файл с ярлыками, которые нужно наклеить на посылки перед отгрузкой. Подробно о том, зачем они нужны и как выглядят, рассказано в Справке. На вход нужно передать идентификатор заказа и один необязательный параметр, который управляет версткой PDF-файла. |⚙️ Лимит: 1 000 000 запросов в час| |-|

Example

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


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


$apiInstance = new YandexMarketApi\Api\OrderLabelsApi(
    // 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 | Идентификатор заказа.
$format = new \YandexMarketApi\Model\PageFormatType(); // PageFormatType | Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6.

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

Parameters

Name Type Description Notes
campaign_id int Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns. ℹ️ Что такое кабинет и магазин на Маркете
order_id int Идентификатор заказа.
format PageFormatType Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6. [optional]

Return type

\SplFileObject

Authorization

OAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/pdf, application/json

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

getOrderLabelsData()

getOrderLabelsData($campaign_id, $order_id): \YandexMarketApi\Model\GetOrderLabelsDataResponse

Информация на ярлыках‑наклейках

Возвращает информацию на ярлыках, которые клеятся на коробки в заказе. |⚙️ Лимит: 1 000 000 запросов в час| |-|

Example

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


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


$apiInstance = new YandexMarketApi\Api\OrderLabelsApi(
    // 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->getOrderLabelsData($campaign_id, $order_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrderLabelsApi->getOrderLabelsData: ', $e->getMessage(), PHP_EOL;
}

Parameters

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

Return type

\YandexMarketApi\Model\GetOrderLabelsDataResponse

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]