OpenAPI\Client\ShipmentsApi

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

Method	HTTP request	Description
confirmShipment()	POST /campaigns/{campaignId}/first-mile/shipments/{shipmentId}/confirm	Подтверждение отгрузки
downloadShipmentAct()	GET /campaigns/{campaignId}/first-mile/shipments/{shipmentId}/act	Получение акта приема-передачи
downloadShipmentDiscrepancyAct()	GET /campaigns/{campaignId}/first-mile/shipments/{shipmentId}/discrepancy-act	Получение акта расхождений
downloadShipmentInboundAct()	GET /campaigns/{campaignId}/first-mile/shipments/{shipmentId}/inbound-act	Получение фактического акта приема-передачи
downloadShipmentPalletLabels()	GET /campaigns/{campaignId}/first-mile/shipments/{shipmentId}/pallet/labels	Ярлыки на все упаковки в отгрузке
downloadShipmentReceptionTransferAct()	GET /campaigns/{campaignId}/shipments/reception-transfer-act	Подтверждение ближайшей отгрузки и получение акта приема-передачи для нее
downloadShipmentTransportationWaybill()	GET /campaigns/{campaignId}/first-mile/shipments/{shipmentId}/transportation-waybill	Получение транспортной накладной
getShipment()	GET /campaigns/{campaignId}/first-mile/shipments/{shipmentId}	Получение информации об отгрузке
getShipmentOrdersInfo()	GET /campaigns/{campaignId}/first-mile/shipments/{shipmentId}/orders/info	Получение информации о ярлыках
searchShipments()	PUT /campaigns/{campaignId}/first-mile/shipments	Получение информации об отгрузках
setShipmentPalletsCount()	PUT /campaigns/{campaignId}/first-mile/shipments/{shipmentId}/pallets	Передача количества упаковок в отгрузке
transferOrdersFromShipment()	POST /campaigns/{campaignId}/first-mile/shipments/{shipmentId}/orders/transfer	Перенос заказов в следующую отгрузку

`confirmShipment()`

confirmShipment($campaign_id, $shipment_id, $confirm_shipment_request): \OpenAPI\Client\Model\EmptyApiResponse

Подтверждение отгрузки

Подтверждает отгрузку товаров в сортировочный центр или пункт приема заказов. |⚙️ Лимит: 100 запросов в час| |-|

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\ShipmentsApi(
    // 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)
$shipment_id = 56; // int | Идентификатор отгрузки.
$confirm_shipment_request = new \OpenAPI\Client\Model\ConfirmShipmentRequest(); // \OpenAPI\Client\Model\ConfirmShipmentRequest

try {
    $result = $apiInstance->confirmShipment($campaign_id, $shipment_id, $confirm_shipment_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ShipmentsApi->confirmShipment: ', $e->getMessage(), PHP_EOL;
}

Parameters

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

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]

`downloadShipmentAct()`

downloadShipmentAct($campaign_id, $shipment_id): \SplFileObject

Получение акта приема-передачи

{% note alert %} Если ваш магазин подключен к экспресс‑доставке и вы отгружаете заказы курьерам Яндекс Go, подготавливать акт приема‑передачи не нужно. {% endnote %} Запрос формирует акт приема-передачи заказов, входящих в отгрузку, и возвращает акт в формате PDF. В акте содержатся собранные и готовые к отправке заказы. Можно запросить акт в день отгрузки или накануне — в зависимости от указанного времени формирования отгрузки в личном кабинете. При формировании акта Маркет автоматически находит и подставляет в шаблон следующие данные: {% cut "Данные, из которых Маркет формирует акт" %} | Данные в акте | Описание | | ----------- | ----------- | | Дата | Дата запроса. | | Отправитель | Название вашего юридического лица, указанное в личном кабинете магазина. | | Исполнитель | Название юридического лица сортировочного центра или службы доставки. | | № отправления в системе заказчика | Ваш идентификатор заказа, который вы указали в ответе на запрос POST order/accept от Маркета. | | № отправления в системе исполнителя (субподрядчика) | Идентификатор заказа на Маркете, как в выходных данных запроса GET campaigns/{campaignId}/orders. | | Объявленная ценность | Общая сумма заказа без учета стоимости доставки, как в выходных данных запроса GET campaigns/{campaignId}/orders или GET campaigns/{campaignId}/orders/{orderId}. | | Вес | Масса брутто грузового места (суммарная масса упаковки и содержимого), как в выходных данных запроса GET campaigns/{campaignId}/orders или GET campaigns/{campaignId}/orders/{orderId}. | | Количество мест | Количество грузовых мест в заказе, как в выходных данных запроса GET campaigns/{campaignId}/orders или GET campaigns/{campaignId}/orders/{orderId}. | {% endcut %} Остальные поля нужно заполнить самостоятельно в распечатанном акте. |⚙️ Лимит: 100 запросов в час| |-|

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\ShipmentsApi(
    // 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)
$shipment_id = 56; // int | Идентификатор отгрузки.

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

Parameters

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

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]

`downloadShipmentDiscrepancyAct()`

downloadShipmentDiscrepancyAct($campaign_id, $shipment_id): \SplFileObject

Получение акта расхождений

Возвращает акт расхождений для заданной отгрузки. |⚙️ Лимит: 200 запросов в час| |-|

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\ShipmentsApi(
    // 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)
$shipment_id = 56; // int | Идентификатор отгрузки.

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

Parameters

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

Return type

\SplFileObject

Authorization

OAuth

HTTP request headers

Content-Type: Not defined
Accept: application/vnd.ms-excel, application/json

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

`downloadShipmentInboundAct()`

downloadShipmentInboundAct($campaign_id, $shipment_id): \SplFileObject

Получение фактического акта приема-передачи

Возвращает фактический акт приема-передачи для заданной отгрузки. Такой акт становится доступен спустя несколько часов после завершения отгрузки. Он может понадобиться, если после отгрузки обнаружатся расхождения. |⚙️ Лимит: 200 запросов в час| |-|

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\ShipmentsApi(
    // 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)
$shipment_id = 56; // int | Идентификатор отгрузки.

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

Parameters

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

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]

`downloadShipmentPalletLabels()`

downloadShipmentPalletLabels($campaign_id, $shipment_id, $format): \SplFileObject

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

PDF-файл с ярлыками на каждый короб или палету в отгрузке для доверительной приемки. Подробнее про доверительную приемку написано в Справке Маркета. Распечатайте по несколько копий каждого ярлыка: на одну тару нужно наклеить минимум 2 ярлыка с разных сторон. Количество упаковок в отгрузке задается в запросе PUT campaigns/{campaignId}/first-mile/shipments/{shipmentId}/pallets. |⚙️ Лимит: 200 запросов в час| |-|

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\ShipmentsApi(
    // 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)
$shipment_id = 56; // int | Идентификатор отгрузки.
$format = new \OpenAPI\Client\Model\ShipmentPalletLabelPageFormatType(); // ShipmentPalletLabelPageFormatType | Формат страниц PDF-файла с ярлыками: * `A4` — по 16 ярлыков на странице. * `A8` — по одному ярлыку на странице.

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

Parameters

Name	Type	Description	Notes
campaign_id	int	Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns. ℹ️ Что такое кабинет и магазин на Маркете
shipment_id	int	Идентификатор отгрузки.
format	ShipmentPalletLabelPageFormatType	Формат страниц PDF-файла с ярлыками: * `A4` — по 16 ярлыков на странице. * `A8` — по одному ярлыку на странице.	[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]

`downloadShipmentReceptionTransferAct()`

downloadShipmentReceptionTransferAct($campaign_id, $warehouse_id): \SplFileObject

Подтверждение ближайшей отгрузки и получение акта приема-передачи для нее

Запрос подтверждает ближайшую отгрузку и возвращает акт приема-передачи в формате PDF. Можно запросить акт в день отгрузки или накануне — в зависимости от указанного времени формирования отгрузки в личном кабинете. {% note warning %} Если ваш магазин подключен к экспресс‑доставке и вы отгружаете заказы курьерам Яндекс Go, подготавливать акт приема‑передачи не нужно. {% endnote %} В акт входят собранные и готовые к отправке заказы, которые отгружаются в сортировочный центр / пункт приема или курьерам Маркета. При формировании акта Маркет автоматически находит и подставляет в шаблон следующие данные: {% cut "Данные, из которых Маркет формирует акт" %} | Данные в акте | Описание | | ----------- | ----------- | | Отправитель | Название вашего юридического лица, указанное в личном кабинете магазина. | | Исполнитель | Название юридического лица сортировочного центра или службы доставки. | | № отправления в системе заказчика | Ваш идентификатор заказа, который вы указали в ответе на запрос POST order/accept от Маркета. | | № отправления в системе исполнителя (субподрядчика) | Идентификатор заказа на Маркете, как в выходных данных запроса GET campaigns/{campaignId}/orders. | | Объявленная ценность | Общая сумма заказа без учета стоимости доставки, как в выходных данных запроса GET campaigns/{campaignId}/orders или GET campaigns/{campaignId}/orders/{orderId}. | | Стоимость всех товаров в заказе | Стоимость всех заказанных товаров. | | Вес | Масса брутто грузового места (суммарная масса упаковки и содержимого), как в выходных данных запроса GET campaigns/{campaignId}/orders или GET campaigns/{campaignId}/orders/{orderId}. | | Количество мест | Количество грузовых мест в заказе, как в выходных данных запроса GET campaigns/{campaignId}/orders или GET campaigns/{campaignId}/orders/{orderId}. | {% endcut %} Остальные поля нужно заполнить самостоятельно в распечатанном акте. |⚙️ Лимит: 100 запросов в час| |-|

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\ShipmentsApi(
    // 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)
$warehouse_id = 123123; // int | Идентификатор склада

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

Parameters

Name	Type	Description	Notes
campaign_id	int	Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns. ℹ️ Что такое кабинет и магазин на Маркете
warehouse_id	int	Идентификатор склада	[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]

`downloadShipmentTransportationWaybill()`

downloadShipmentTransportationWaybill($campaign_id, $shipment_id): \SplFileObject

Получение транспортной накладной

Возвращает транспортную накладную для заданной отгрузки. Транспортная накладная понадобится, если вы отгружаете товары непосредственно со своего склада. Подробно об этом способе отгрузки |⚙️ Лимит: 200 запросов в час| |-|

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\ShipmentsApi(
    // 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)
$shipment_id = 56; // int | Идентификатор отгрузки.

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

Parameters

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

Return type

\SplFileObject

Authorization

OAuth

HTTP request headers

Content-Type: Not defined
Accept: application/vnd.ms-excel, application/json

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

`getShipment()`

getShipment($campaign_id, $shipment_id): \OpenAPI\Client\Model\GetShipmentResponse

Получение информации об отгрузке

Возвращает информацию об отгрузке по ее идентификатору. |⚙️ Лимит: 100 запросов в час| |-|

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\ShipmentsApi(
    // 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)
$shipment_id = 56; // int | Идентификатор отгрузки.

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

Parameters

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

Return type

\OpenAPI\Client\Model\GetShipmentResponse

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]

`getShipmentOrdersInfo()`

getShipmentOrdersInfo($campaign_id, $shipment_id): \OpenAPI\Client\Model\GetShipmentOrdersInfoResponse

Получение информации о ярлыках

Возвращает информацию о возможности печати ярлыков-наклеек для заказов в отгрузке. |⚙️ Лимит: 100 запросов в час| |-|

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\ShipmentsApi(
    // 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)
$shipment_id = 56; // int | Идентификатор отгрузки.

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

Parameters

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

Return type

\OpenAPI\Client\Model\GetShipmentOrdersInfoResponse

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]

`searchShipments()`

searchShipments($campaign_id, $search_shipments_request, $page_token, $limit): \OpenAPI\Client\Model\SearchShipmentsResponse

Получение информации об отгрузках

Возвращает информацию об отгрузках по заданным параметрам: * дате; * статусу; * идентификаторам заказов. Результаты возвращаются постранично. |⚙️ Лимит: 100 запросов в час| |-|

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\ShipmentsApi(
    // 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)
$search_shipments_request = new \OpenAPI\Client\Model\SearchShipmentsRequest(); // \OpenAPI\Client\Model\SearchShipmentsRequest
$page_token = eyBuZXh0SWQ6IDIzNDIgfQ==; // string | Идентификатор страницы c результатами.  Если параметр не указан, возвращается самая старая страница.  Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.  Если задан `page_token`, параметры `offset`, `page_number` и `page_size` игнорируются.
$limit = 20; // int | Количество товаров на одной странице.

try {
    $result = $apiInstance->searchShipments($campaign_id, $search_shipments_request, $page_token, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ShipmentsApi->searchShipments: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
campaign_id	int	Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns. ℹ️ Что такое кабинет и магазин на Маркете
search_shipments_request	\OpenAPI\Client\Model\SearchShipmentsRequest
page_token	string	Идентификатор страницы c результатами. Если параметр не указан, возвращается самая старая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token`, параметры `offset`, `page_number` и `page_size` игнорируются.	[optional]
limit	int	Количество товаров на одной странице.	[optional]

Return type

\OpenAPI\Client\Model\SearchShipmentsResponse

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]

`setShipmentPalletsCount()`

setShipmentPalletsCount($campaign_id, $shipment_id, $set_shipment_pallets_count_request): \OpenAPI\Client\Model\EmptyApiResponse

Передача количества упаковок в отгрузке

Передает Маркету количество коробов или палет в отгрузке для доверительной приемки. Подробнее про доверительную приемку написано в Справке Маркета. Получить PDF-файл с ярлыками для упаковок можно с помощью запроса GET campaigns/{campaignId}/first-mile/shipments/{shipmentId}/pallet/labels. |⚙️ Лимит: 200 запросов в час| |-|

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\ShipmentsApi(
    // 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)
$shipment_id = 56; // int | Идентификатор отгрузки.
$set_shipment_pallets_count_request = new \OpenAPI\Client\Model\SetShipmentPalletsCountRequest(); // \OpenAPI\Client\Model\SetShipmentPalletsCountRequest

try {
    $result = $apiInstance->setShipmentPalletsCount($campaign_id, $shipment_id, $set_shipment_pallets_count_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ShipmentsApi->setShipmentPalletsCount: ', $e->getMessage(), PHP_EOL;
}

Parameters

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

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]

`transferOrdersFromShipment()`

transferOrdersFromShipment($campaign_id, $shipment_id, $transfer_orders_from_shipment_request): \OpenAPI\Client\Model\EmptyApiResponse

Перенос заказов в следующую отгрузку

Переносит указанные заказы из указанной отгрузки в следующую отгрузку. Что такое отгрузка? Используйте этот запрос, если не успеваете собрать и упаковать заказы вовремя. {% note warning "Такие переносы снижают индекс качества магазина" %} Этот запрос предназначен для исключительных случаев. Если вы будете переносить заказы слишком часто, магазин столкнется с ограничениями. Что за ограничения? {% endnote %} Переносить заказы можно, если до формирования отгрузки осталось больше получаса. Перенос происходит не мгновенно, а занимает несколько минут. |⚙️ Лимит: 200 запросов в час| |-|

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\ShipmentsApi(
    // 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)
$shipment_id = 56; // int | Идентификатор отгрузки.
$transfer_orders_from_shipment_request = new \OpenAPI\Client\Model\TransferOrdersFromShipmentRequest(); // \OpenAPI\Client\Model\TransferOrdersFromShipmentRequest

try {
    $result = $apiInstance->transferOrdersFromShipment($campaign_id, $shipment_id, $transfer_orders_from_shipment_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ShipmentsApi->transferOrdersFromShipment: ', $e->getMessage(), PHP_EOL;
}

Parameters

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

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]

FilesExpand file tree

ShipmentsApi.md

Latest commit

History

ShipmentsApi.md

File metadata and controls

OpenAPI\Client\ShipmentsApi

confirmShipment()

Example

Parameters

Return type

Authorization

HTTP request headers

downloadShipmentAct()

Example

Parameters

Return type

Authorization

HTTP request headers

downloadShipmentDiscrepancyAct()

Example

Parameters

Return type

Authorization

HTTP request headers

downloadShipmentInboundAct()

Example

Parameters

Return type

Authorization

HTTP request headers

downloadShipmentPalletLabels()

Example

Parameters

Return type

Authorization

HTTP request headers

downloadShipmentReceptionTransferAct()

Example

Parameters

Return type

Authorization

HTTP request headers

downloadShipmentTransportationWaybill()

Example

Parameters

Return type

Authorization

HTTP request headers

getShipment()

Example

Parameters

Return type

Authorization

HTTP request headers

getShipmentOrdersInfo()

Example

Parameters

Return type

Authorization

HTTP request headers

searchShipments()

Example

Parameters

Return type

Authorization

HTTP request headers

setShipmentPalletsCount()

Example

Parameters

Return type

Authorization

HTTP request headers

transferOrdersFromShipment()

Example

Parameters

Return type

Authorization

HTTP request headers

`confirmShipment()`

`downloadShipmentAct()`

`downloadShipmentDiscrepancyAct()`

`downloadShipmentInboundAct()`

`downloadShipmentPalletLabels()`

`downloadShipmentReceptionTransferAct()`

`downloadShipmentTransportationWaybill()`

`getShipment()`

`getShipmentOrdersInfo()`

`searchShipments()`

`setShipmentPalletsCount()`

`transferOrdersFromShipment()`