OpenAPI\Client\OrdersApi

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

Method	HTTP request	Description
acceptOrderCancellation()	PUT /campaigns/{campaignId}/orders/{orderId}/cancellation/accept	Отмена заказа покупателем
getOrder()	GET /campaigns/{campaignId}/orders/{orderId}	Информация о заказе
getOrders()	GET /campaigns/{campaignId}/orders	Информация о заказах
provideOrderDigitalCodes()	POST /campaigns/{campaignId}/orders/{orderId}/deliverDigitalGoods	Передача ключей цифровых товаров
provideOrderItemIdentifiers()	PUT /campaigns/{campaignId}/orders/{orderId}/identifiers	Передача уникальных кодов маркировки единиц товара (DBS)
setOrderBoxLayout()	PUT /campaigns/{campaignId}/orders/{orderId}/boxes	Подготовка заказа (FBS)
setOrderShipmentBoxes()	PUT /campaigns/{campaignId}/orders/{orderId}/delivery/shipments/{shipmentId}/boxes	Передача количества грузовых мест в заказе (DBS)
updateOrderItems()	PUT /campaigns/{campaignId}/orders/{orderId}/items	Удаление товара из заказа или уменьшение числа единиц (DBS)
updateOrderStatus()	PUT /campaigns/{campaignId}/orders/{orderId}/status	Изменение статуса заказа
updateOrderStatuses()	POST /campaigns/{campaignId}/orders/status-update	Изменение статусов заказа

`acceptOrderCancellation()`

acceptOrderCancellation($campaign_id, $order_id, $accept_order_cancellation_request): \OpenAPI\Client\Model\EmptyApiResponse

Отмена заказа покупателем

Подтверждает или отклоняет запрос покупателя на отмену заказа, который передан службе доставки. Покупатель может отменить заказ в течение его обработки или доставки. Если заказ еще обрабатывается (имеет статус PROCESSING), вам не нужно подтверждать отмену заказа — он будет отменен автоматически. Если заказ уже передан службе доставки (принимает статус DELIVERY или PICKUP) и пользователь отменил его, вы можете предупредить службу об отмене в течение 48 часов. Если служба доставки узнала об отмене до передачи заказа покупателю, подтвердите отмену с помощью запроса PUT campaigns/{campaignId}/orders/{orderId}/cancellation/accept. Если заказ уже доставлен, отклоните отмену с помощью этого же запроса. Тогда у покупателя останется заказ, и деньги за него возвращаться не будут. Чтобы узнать, какие заказы были отменены в статусе DELIVERY или PICKUP, отправьте запрос GET campaigns/{campaignId}/orders. В его URL добавьте входной параметр onlyWaitingForCancellationApprove=true. Вы также можете узнать об отмененных заказах через личный кабинет или почту — на нее придет уведомление об отмене. Если в течение 48 часов вы не подтвердите или отклоните отмену, заказ будет отменен автоматически. |⚙️ Лимит: 500 запросов в час| |-|

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\OrdersApi(
    // 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 | Идентификатор заказа.
$accept_order_cancellation_request = new \OpenAPI\Client\Model\AcceptOrderCancellationRequest(); // \OpenAPI\Client\Model\AcceptOrderCancellationRequest

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

Parameters

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

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]

`getOrder()`

getOrder($campaign_id, $order_id): \OpenAPI\Client\Model\GetOrderResponse

Информация о заказе

Возвращает информацию о заказе. Получить более подробную информацию о покупателе и его номере телефона можно с помощью запроса GET campaigns/{campaignId}/orders/{orderId}/buyer. |⚙️ Лимит: 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\OrdersApi(
    // 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->getOrder($campaign_id, $order_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrdersApi->getOrder: ', $e->getMessage(), PHP_EOL;
}

Parameters

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

Return type

\OpenAPI\Client\Model\GetOrderResponse

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]

`getOrders()`

getOrders($campaign_id, $status, $substatus, $from_date, $to_date, $supplier_shipment_date_from, $supplier_shipment_date_to, $updated_at_from, $updated_at_to, $dispatch_type, $fake, $has_cis, $only_waiting_for_cancellation_approve, $only_estimated_delivery, $page, $page_size): \OpenAPI\Client\Model\GetOrdersResponse

Информация о заказах

Возвращает информацию о заказах. Запрос можно использовать, чтобы узнать, нет ли новых заказов. Доступна фильтрация по нескольким характеристикам заказов: * дате оформления; * статусу; * этапу обработки или причине отмены; * типу (настоящий или тестовый); * дате отгрузки в службу доставки; * дате и времени обновления заказа. Информация о заказах, доставленных или отмененных больше 30 дней назад, не возвращается. Ее можно получить с помощью запроса информации об отдельном заказе GET campaigns/{campaignId}/orders/{orderId} (если у вас есть идентификатор заказа) или запроса отчета по заказам POST campaigns/{campaignId}/stats/orders. Максимальный диапазон дат за один запрос к ресурсу — 30 дней. Максимальное количество заказов в выходных данных запроса — 50. Результаты возвращаются постранично. Получить более подробную информацию о покупателе и его номере телефона можно с помощью запроса GET campaigns/{campaignId}/orders/{orderId}/buyer. |⚙️ Лимит: 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\OrdersApi(
    // 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)
$status = new \OpenAPI\Client\Model\OrderStatusType(); // OrderStatusType | Статус заказа:  * `CANCELLED` — заказ отменен.  * `DELIVERED` — заказ получен покупателем.  * `DELIVERY` — заказ передан в службу доставки.  * `PICKUP` — заказ доставлен в пункт самовывоза.  * `PROCESSING` — заказ находится в обработке.  * `UNPAID` — заказ оформлен, но еще не оплачен (если выбрана оплата при оформлении).  Также могут возвращаться другие значения. Обрабатывать их не требуется.
$substatus = new \OpenAPI\Client\Model\OrderSubstatusType(); // OrderSubstatusType | Этап обработки заказа (если он имеет статус `PROCESSING`) или причина отмены заказа (если он имеет статус `CANCELLED`).  Возможные значения для заказа в статусе `PROCESSING`:  * `STARTED` — заказ подтвержден, его можно начать обрабатывать. * `READY_TO_SHIP` — заказ собран и готов к отправке. * `SHIPPED` — заказ передан службе доставки.  Возможные значения для заказа в статусе `CANCELLED`:  * `DELIVERY_SERVICE_UNDELIVERED` — служба доставки не смогла доставить заказ.  * `PROCESSING_EXPIRED` — значение более не используется.  * `REPLACING_ORDER` — покупатель решил заменить товар другим по собственной инициативе.  * `RESERVATION_EXPIRED` — покупатель не завершил оформление зарезервированного заказа в течение 10 минут.  * `RESERVATION_FAILED` — Маркет не может продолжить дальнейшую обработку заказа.  * `SHOP_FAILED` — магазин не может выполнить заказ.  * `USER_CHANGED_MIND` — покупатель отменил заказ по личным причинам.  * `USER_NOT_PAID` — покупатель не оплатил заказ (для типа оплаты `PREPAID`) в течение 30 минут.  * `USER_REFUSED_DELIVERY` — покупателя не устроили условия доставки.  * `USER_REFUSED_PRODUCT` — покупателю не подошел товар.  * `USER_REFUSED_QUALITY` — покупателя не устроило качество товара.  * `USER_UNREACHABLE` — не удалось связаться с покупателем. Для отмены с этой причиной необходимо выполнить условия:    * не менее 3 звонков с 8 до 21 в часовом поясе покупателя;   * перерыв между первым и третьим звонком не менее 90 минут;   * соединение не короче 5 секунд.    Если хотя бы одно из этих условий не выполнено (кроме случая, когда номер недоступен), отменить заказ не получится. Вернется ответ с кодом ошибки 400. * `USER_WANTS_TO_CHANGE_DELIVERY_DATE` — покупатель хочет получить заказ в другой день. * `CANCELLED_COURIER_NOT_FOUND` — не удалось найти курьера.  Также могут возвращаться другие значения. Обрабатывать их не требуется.
$from_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Начальная дата для фильтрации заказов по дате оформления.  Формат даты: `ДД-ММ-ГГГГ`.  Между начальной и конечной датой (параметр `toDate`) должно быть не больше 30 дней.  Значение по умолчанию: 30 дней назад от текущей даты.
$to_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Конечная дата для фильтрации заказов по дате оформления.  Формат даты: `ДД-ММ-ГГГГ`.  Между начальной (параметр `fromDate`) и конечной датой должно быть не больше 30 дней.  Значение по умолчанию: текущая дата.
$supplier_shipment_date_from = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Начальная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`).  Формат даты: `ДД-ММ-ГГГГ`.  Между начальной и конечной датой (параметр `supplierShipmentDateTo`) должно быть не больше 30 дней.  Начальная дата включается в интервал для фильтрации.
$supplier_shipment_date_to = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Конечная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`).  Формат даты: `ДД-ММ-ГГГГ`.  Между начальной (параметр `supplierShipmentDateFrom`) и конечной датой должно быть не больше 30 дней.  Конечная дата не включается в интервал для фильтрации.
$updated_at_from = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Начальная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`).  Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`.  Между начальной и конечной датой (параметр `updatedAtTo`) должно быть не больше 30 дней.  Начальная дата включается в интервал для фильтрации.
$updated_at_to = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Конечная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`).  Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`.  Между начальной (параметр `updatedAtFrom`) и конечной датой должно быть не больше 30 дней.  Конечная дата не включается в интервал для фильтрации.
$dispatch_type = new \OpenAPI\Client\Model\OrderDeliveryDispatchType(); // OrderDeliveryDispatchType | Способ отгрузки
$fake = false; // bool | Фильтрация заказов по типам:  * `false` — настоящий заказ покупателя.  * `true` — [тестовый](../../pushapi/concepts/sandbox.md) заказ Маркета.
$has_cis = false; // bool | Нужно ли вернуть только те заказы, в составе которых есть хотя бы один товар с кодом идентификации из системы «Честный ЗНАК»:  * `true` — да;  * `false` — нет.  Такие коды присваиваются товарам, которые подлежат маркировке и относятся к определенным категориям.
$only_waiting_for_cancellation_approve = false; // bool | Фильтрация заказов по наличию запросов покупателей на отмену:  * `true` — возвращаются только заказы, которые находятся в статусе `DELIVERY` или `PICKUP` и которые пользователи решили отменить. Чтобы подтвердить или отклонить отмену, отправьте запрос [PUT campaigns/{campaignId}/orders/{orderId}/cancellation/accept](../../reference/orders/acceptOrderCancellation).
$only_estimated_delivery = false; // bool | Фильтрация заказов с долгой доставкой (31-60 дней) по подтвержденной дате доставки:  * `true` — возвращаются только заказы с неподтвержденной датой доставки. * `false` — фильтрация не применяется.
$page = 1; // int | Номер страницы результатов.  Значение по умолчанию: 1.  Используется вместе с параметром `page_size`.  `page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
$page_size = 56; // int | Размер страницы.  Используется вместе с параметром `page_number`.  `page_size` игнорируется, если задан `page_token`, `limit` или `offset`.

try {
    $result = $apiInstance->getOrders($campaign_id, $status, $substatus, $from_date, $to_date, $supplier_shipment_date_from, $supplier_shipment_date_to, $updated_at_from, $updated_at_to, $dispatch_type, $fake, $has_cis, $only_waiting_for_cancellation_approve, $only_estimated_delivery, $page, $page_size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrdersApi->getOrders: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
campaign_id	int	Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns. ℹ️ Что такое кабинет и магазин на Маркете
status	OrderStatusType	Статус заказа: * `CANCELLED` — заказ отменен. * `DELIVERED` — заказ получен покупателем. * `DELIVERY` — заказ передан в службу доставки. * `PICKUP` — заказ доставлен в пункт самовывоза. * `PROCESSING` — заказ находится в обработке. * `UNPAID` — заказ оформлен, но еще не оплачен (если выбрана оплата при оформлении). Также могут возвращаться другие значения. Обрабатывать их не требуется.	[optional]
substatus	OrderSubstatusType	Этап обработки заказа (если он имеет статус `PROCESSING`) или причина отмены заказа (если он имеет статус `CANCELLED`). Возможные значения для заказа в статусе `PROCESSING`: * `STARTED` — заказ подтвержден, его можно начать обрабатывать. * `READY_TO_SHIP` — заказ собран и готов к отправке. * `SHIPPED` — заказ передан службе доставки. Возможные значения для заказа в статусе `CANCELLED`: * `DELIVERY_SERVICE_UNDELIVERED` — служба доставки не смогла доставить заказ. * `PROCESSING_EXPIRED` — значение более не используется. * `REPLACING_ORDER` — покупатель решил заменить товар другим по собственной инициативе. * `RESERVATION_EXPIRED` — покупатель не завершил оформление зарезервированного заказа в течение 10 минут. * `RESERVATION_FAILED` — Маркет не может продолжить дальнейшую обработку заказа. * `SHOP_FAILED` — магазин не может выполнить заказ. * `USER_CHANGED_MIND` — покупатель отменил заказ по личным причинам. * `USER_NOT_PAID` — покупатель не оплатил заказ (для типа оплаты `PREPAID`) в течение 30 минут. * `USER_REFUSED_DELIVERY` — покупателя не устроили условия доставки. * `USER_REFUSED_PRODUCT` — покупателю не подошел товар. * `USER_REFUSED_QUALITY` — покупателя не устроило качество товара. * `USER_UNREACHABLE` — не удалось связаться с покупателем. Для отмены с этой причиной необходимо выполнить условия: * не менее 3 звонков с 8 до 21 в часовом поясе покупателя; * перерыв между первым и третьим звонком не менее 90 минут; * соединение не короче 5 секунд. Если хотя бы одно из этих условий не выполнено (кроме случая, когда номер недоступен), отменить заказ не получится. Вернется ответ с кодом ошибки 400. * `USER_WANTS_TO_CHANGE_DELIVERY_DATE` — покупатель хочет получить заказ в другой день. * `CANCELLED_COURIER_NOT_FOUND` — не удалось найти курьера. Также могут возвращаться другие значения. Обрабатывать их не требуется.	[optional]
from_date	\DateTime	Начальная дата для фильтрации заказов по дате оформления. Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `toDate`) должно быть не больше 30 дней. Значение по умолчанию: 30 дней назад от текущей даты.	[optional]
to_date	\DateTime	Конечная дата для фильтрации заказов по дате оформления. Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `fromDate`) и конечной датой должно быть не больше 30 дней. Значение по умолчанию: текущая дата.	[optional]
supplier_shipment_date_from	\DateTime	Начальная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной и конечной датой (параметр `supplierShipmentDateTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации.	[optional]
supplier_shipment_date_to	\DateTime	Конечная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр `shipmentDate`). Формат даты: `ДД-ММ-ГГГГ`. Между начальной (параметр `supplierShipmentDateFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации.	[optional]
updated_at_from	\DateTime	Начальная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной и конечной датой (параметр `updatedAtTo`) должно быть не больше 30 дней. Начальная дата включается в интервал для фильтрации.	[optional]
updated_at_to	\DateTime	Конечная дата для фильтрации заказов по дате и времени обновления (параметр `updatedAt`). Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Между начальной (параметр `updatedAtFrom`) и конечной датой должно быть не больше 30 дней. Конечная дата не включается в интервал для фильтрации.	[optional]
dispatch_type	OrderDeliveryDispatchType	Способ отгрузки	[optional]
fake	bool	Фильтрация заказов по типам: * `false` — настоящий заказ покупателя. * `true` — тестовый заказ Маркета.	[optional] [default to false]
has_cis	bool	Нужно ли вернуть только те заказы, в составе которых есть хотя бы один товар с кодом идентификации из системы «Честный ЗНАК»: * `true` — да; * `false` — нет. Такие коды присваиваются товарам, которые подлежат маркировке и относятся к определенным категориям.	[optional] [default to false]
only_waiting_for_cancellation_approve	bool	Фильтрация заказов по наличию запросов покупателей на отмену: * `true` — возвращаются только заказы, которые находятся в статусе `DELIVERY` или `PICKUP` и которые пользователи решили отменить. Чтобы подтвердить или отклонить отмену, отправьте запрос PUT campaigns/{campaignId}/orders/{orderId}/cancellation/accept.	[optional] [default to false]
only_estimated_delivery	bool	Фильтрация заказов с долгой доставкой (31-60 дней) по подтвержденной дате доставки: * `true` — возвращаются только заказы с неподтвержденной датой доставки. * `false` — фильтрация не применяется.	[optional] [default to false]
page	int	Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `page_size`. `page_number` игнорируется, если задан `page_token`, `limit` или `offset`.	[optional] [default to 1]
page_size	int	Размер страницы. Используется вместе с параметром `page_number`. `page_size` игнорируется, если задан `page_token`, `limit` или `offset`.	[optional]

Return type

\OpenAPI\Client\Model\GetOrdersResponse

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]

`provideOrderDigitalCodes()`

provideOrderDigitalCodes($campaign_id, $order_id, $provide_order_digital_codes_request): \OpenAPI\Client\Model\EmptyApiResponse

Передача ключей цифровых товаров

Передает ключи цифровых товаров, которые покупатель заказал и оплатил. После выполнения запроса Маркет отправит ему письмо с ключами и инструкциями по активации, а также переведет заказ в финальный статус DELIVERED. Ключ нужно передать в течение 30 минут после перехода заказа в статус PROCESSING. Если в один заказ входят несколько ключей, передавайте их все в одном запросе. |⚙️ Лимит: 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\OrdersApi(
    // 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 | Идентификатор заказа.
$provide_order_digital_codes_request = new \OpenAPI\Client\Model\ProvideOrderDigitalCodesRequest(); // \OpenAPI\Client\Model\ProvideOrderDigitalCodesRequest

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

Parameters

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

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]

`provideOrderItemIdentifiers()`

provideOrderItemIdentifiers($campaign_id, $order_id, $provide_order_item_identifiers_request): \OpenAPI\Client\Model\ProvideOrderItemIdentifiersResponse

Передача уникальных кодов маркировки единиц товара (DBS)

{% note warning "Этот запрос только для DBS" %} Если вы работаете по модели FBS, пользуйтесь PUT campaigns/{campaignId}/orders/{orderId}/boxes. {% endnote %} Передает Маркету коды маркировки для единиц товара в указанном заказе. Принимаются коды следующих типов: * Коды «Честного знака». * УИН для ювелирных изделий. * РНПТ и ГТД для импортных прослеживаемых товаров. {% note warning %} Прежде чем работать с этим методом, обязательно прочтите статью о работе с маркируемыми товарами. {% endnote %} Для каждой позиции в заказе, требующей маркировки, нужно передать список кодов — по одному для каждой единицы товара. Например, если в заказе две пары тапочек и одна пара туфель, получится список из двух кодов для первой позиции и список из одного кода для второй. |⚙️ Лимит: 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\OrdersApi(
    // 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 | Идентификатор заказа.
$provide_order_item_identifiers_request = new \OpenAPI\Client\Model\ProvideOrderItemIdentifiersRequest(); // \OpenAPI\Client\Model\ProvideOrderItemIdentifiersRequest

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

Parameters

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

Return type

\OpenAPI\Client\Model\ProvideOrderItemIdentifiersResponse

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]

`setOrderBoxLayout()`

setOrderBoxLayout($campaign_id, $order_id, $set_order_box_layout_request): \OpenAPI\Client\Model\SetOrderBoxLayoutResponse

Подготовка заказа (FBS)

Позволяет выполнить три операции: * передать Маркету информацию о распределении товаров по коробкам; * передать Маркету коды маркировки для товаров; * удалить товар из заказа, если его не оказалось на складе. {% note tip "Подходит и для DBS" %} Запрос предназначен для работы с FBS-заказами, но вы можете использовать его для обработки DBS-заказов, если это удобно. {% endnote %} Если нужно что-то поправить в переданных данных, просто повторите запрос — это можно делать сколько угодно раз до перевода заказа в статус Готов к отгрузке. ⚠️ Если вы меняете раскладку уже после печати и расклейки ярлыков, не забудье перепечатать их и наклеить заново. ## Как передать информацию о распределении товаров В этом запросе вам нужно передать Маркету список коробок и указать, какие именно товары лежат в каждой из них. Коробки могут быть двух типов: * Содержащие товары целиком. Такая коробка может содержать сколько угодно единиц любых товаров. * Содержащие часть товара. Такие коробки содержат по одной части одного товара. Например, одна содержит внешний блок кондиционера, а другая — внутренний блок. ⚠️ Одна коробка не может содержать и товары целиком, и части товаров. ## Как передавать коды маркировки Если в заказе есть товары, подлежащие маркировке, в запросе нужно передать соответствующие уникальные коды. Что такое маркировка? Принимаются коды следующих типов: * Коды «Честного знака». * УИН для ювелирных изделий. * РНПТ и ГТД для импортных прослеживаемых товаров. Для каждой позиции в заказе, требующей маркировки, нужно передать список кодов — по одному для каждой единицы товара. Например, если в заказе две пары тапочек и одна пара туфель, получится список из двух кодов для первой позиции и список из одного кода для второй. Если товар едет в нескольких коробках, код маркировки нужно передать для каждой из них. ## Как удалить товар из заказа Чтобы удалить товар из заказа: 1. Добавьте в запрос allowRemove: true. 2. Передайте распределение по коробкам без товара, который нужно удалить. {% note warning "Удаление нельзя отменить" %} Эта операция необратима: покупатель сразу получит уведомление, а состав заказа изменится. {% endnote %} Чтобы удалить позицию целиком, не передавайте соответствующий OrderBoxLayoutItemDTO. Чтобы уменьшить количество товара, передайте уменьшенное значение в поле fullCount. Нельзя удалить или уменьшить количество товара, если он: * добавлен по акции; * составляет 99% стоимости заказа; * единственный товар в заказе. Если вы не можете отгрузить такой товар, отмените заказ. Для этого отправьте запрос методом PUT campaigns/{campaignId}/orders/{orderId}/status и передайте статус заказа CANCELLED с причиной отмены SHOP_FAILED. {% note info "Увеличить заказ нельзя" %} С помощью запроса нельзя увеличить количество одинаковых товаров, добавить новые товары в заказ или заменить один товар другим. {% endnote %} ## Примеры {% cut "Товар умещается в коробку" %} Вот как будет выглядеть запрос, если в одной коробке едут: * три единицы одного товара, требующего маркировки; * одна единица другого товара, не требущего маркировки. json { \"boxes\": [ { \"items\": [ { \"id\": 123456, \"fullCount\": 3, \"instances\": [ { \"cis\": \"01030410947874432155Qbag!\\u001d93Zjqw\" }, { \"cis\": \"010304109478gftJ14545762!\\u001dhGt264\" }, { \"cis\": \"010304109478fRs28323ks23!\\u001dhet201\" } ] }, { \"id\": 654321, \"fullCount\": 1 } ] } ] } {% endcut %} {% cut "Товар едет в разных коробках" %} Вот как будет выглядеть запрос, если товар едет в двух коробках: json { \"boxes\": [ { \"items\": [ { \"id\": 123456, \"partialCount\": { \"current\": 1, \"total\": 2 }, \"instances\": [ { \"cis\": \"01030410947874432155Qbag!\\u001d93Zjqw\" } ] } ] }, { \"items\": [ { \"id\": 123456, \"partialCount\": { \"current\": 2, \"total\": 2 }, \"instances\": [ { \"cis\": \"01030410947874432155Qbag!\\u001d93Zjqw\" } ] } ] } ] } {% endcut %} |⚙️ Лимит: 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\OrdersApi(
    // 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_box_layout_request = new \OpenAPI\Client\Model\SetOrderBoxLayoutRequest(); // \OpenAPI\Client\Model\SetOrderBoxLayoutRequest

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

Parameters

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

Return type

\OpenAPI\Client\Model\SetOrderBoxLayoutResponse

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]

`setOrderShipmentBoxes()`

setOrderShipmentBoxes($campaign_id, $order_id, $shipment_id, $set_order_shipment_boxes_request): \OpenAPI\Client\Model\SetOrderShipmentBoxesResponse

Передача количества грузовых мест в заказе (DBS)

{% note warning "Этот запрос только для DBS" %} Если вы работаете по модели FBS, пользуйтесь PUT campaigns/{campaignId}/orders/{orderId}/boxes. {% endnote %} Отгружаемый Маркету заказ может не влезть в одну коробку или упаковку — в этом случае получается, что он занимает несколько грузовых мест. Количество грузовых мест нужно обязательно передавать Маркету, если оно не равно 1. Это делается перед переводом его в статус Готов к отгрузке. Подробно о том, что в какой момент нужно передавать, рассказано в пошаговой инструкции. Метод устроен немного нестандартно: количество задается длиной массива пустых объектов. Раньше метод требовал передачи большего количества данных. Запросы, оформленные по старому образцу, работают, но лучше делать по-новому. {% cut "Как было раньше" %} Структура тела PUT-запроса: { \"boxes\": [ { \"fulfilmentId\": \"{string}\", \"weight\": {int64}, \"width\": {int64}, \"height\": {int64}, \"depth\": {int64}, \"items\": [ { \"id\": {int64}, \"count\": {int32} }, ... ] }, ... ] } | Параметр | Тип | Значение | | ----------- | ----------- | ----------- | | boxes | | Список грузовых мест. | Параметры, вложенные в boxes | Параметр | Тип | Значение | | ----------- | ----------- | ----------- | | fulfilmentId | String | Идентификатор грузового места в информационной системе магазина. Сформируйте идентификатор по шаблону: номер заказа на Маркете-номер грузового места. Например, 7206821‑1, 7206821‑2 и т. д. | | weight | Int64 | Масса брутто грузового места (суммарная масса упаковки и содержимого) в граммах. | | width | Int64 | Ширина грузового места в сантиметрах. | | height | Int64 | Высота грузового места в сантиметрах. | | depth | Int64 | Глубина грузового места в сантиметрах. | | items | Int64 | Список товаров в грузовом месте. | Параметры, вложенные в items | Параметр | Тип | Значение | | ----------- | ----------- | ----------- | | id | Int64 | Идентификатор товара в рамках заказа. | | count | Int32 | Количество единиц товара в грузовом месте. | {% endcut %} |⚙️ Лимит: 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\OrdersApi(
    // 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 | Параметр больше не используется. Вставьте любое число — просто чтобы получился корректный URL.
$set_order_shipment_boxes_request = new \OpenAPI\Client\Model\SetOrderShipmentBoxesRequest(); // \OpenAPI\Client\Model\SetOrderShipmentBoxesRequest

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

Parameters

Name	Type	Description
campaign_id	int	Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns. ℹ️ Что такое кабинет и магазин на Маркете
order_id	int	Идентификатор заказа.
shipment_id	int	Параметр больше не используется. Вставьте любое число — просто чтобы получился корректный URL.
set_order_shipment_boxes_request	\OpenAPI\Client\Model\SetOrderShipmentBoxesRequest

Return type

\OpenAPI\Client\Model\SetOrderShipmentBoxesResponse

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]

`updateOrderItems()`

updateOrderItems($campaign_id, $order_id, $update_order_item_request)

Удаление товара из заказа или уменьшение числа единиц (DBS)

{% note warning "Этот запрос только для DBS" %} Если вы работаете по модели FBS, пользуйтесь PUT campaigns/{campaignId}/orders/{orderId}/boxes. {% endnote %} Изменяет состав заказа, если позволяет выбранная служба доставки, в случаях: * покупатель уменьшил количество товара; * магазин не может поставить все товары в заказе. Для этого заказ должен находится в статусе \"status\": \"PROCESSING\" этапа обработки \"substatus\": \"STARTED\". После передачи статуса \"substatus\": \"READY_TO_SHIP\" изменить состав невозможно. Если одинаковых товаров несколько, для уменьшения количества передайте обновленное значение в атрибуте count параметра item. Чтобы полностью удалить товар из заказа: * передайте значение 0; или * не передавайте параметр item. Нельзя удалить или уменьшить количество товара, если он: * добавлен по акции; * составляет 99% стоимости заказа; * единственный товар в заказе. Если необходимо удалить такой товар, отмените заказ. Для этого отправьте запрос методом PUT campaigns/{campaignId}/orders/{orderId}/status и передайте статус заказа CANCELLED с причиной отмены SHOP_FAILED. {% note info "Увеличить заказ нельзя" %} С помощью запроса нельзя увеличить количество одинаковых товаров, добавить новые товары в заказ или заменить один товар другим. {% endnote %} Возврат денег покупателю Если покупатель оплатил товар при оформлении, Маркет вернет ему деньги за удаленные из заказа товары в течение двух дней: * при оплате банковской картой — с момента, когда магазин переведет заказ в статус SHIPPED; * при оплате через Apple Pay или Google Pay — с момента, когда магазин удалит товар из заказа. |⚙️ Лимит: 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\OrdersApi(
    // 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_item_request = new \OpenAPI\Client\Model\UpdateOrderItemRequest(); // \OpenAPI\Client\Model\UpdateOrderItemRequest

try {
    $apiInstance->updateOrderItems($campaign_id, $order_id, $update_order_item_request);
} catch (Exception $e) {
    echo 'Exception when calling OrdersApi->updateOrderItems: ', $e->getMessage(), PHP_EOL;
}

Parameters

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

Return type

void (empty response body)

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]

`updateOrderStatus()`

updateOrderStatus($campaign_id, $order_id, $update_order_status_request): \OpenAPI\Client\Model\UpdateOrderStatusResponse

Изменение статуса заказа

Изменяет статус заказа. Возможные изменения статусов: * Если магазин подтвердил и подготовил заказ к отправке, то заказ из статуса \"status\": \"PROCESSING\" и этапа обработки \"substatus\": \"STARTED\" нужно перевести в статус \"status\": \"PROCESSING\" и этап обработки \"substatus\": \"READY_TO_SHIP\". * Если магазин подтвердил заказ, но не может его выполнить (например, товар числится в базе, но отсутствует на складе или нет нужного цвета), то заказ из статуса \"status\": \"PROCESSING\" и этапа обработки \"substatus\": \"STARTED\" нужно перевести в статус \"status\": \"CANCELLED\" с причиной отмены заказа \"substatus\": \"SHOP_FAILED\". * Если магазин подготовил заказ к отгрузке, но не может его выполнить (например, последний товар был поврежден или оказался с браком), то заказ из статуса \"status\": \"PROCESSING\" и этапа обработки \"substatus\": \"READY_TO_SHIP\" нужно перевести в статус \"status\": \"CANCELLED\" с причиной отмены заказа \"substatus\": \"SHOP_FAILED\". |⚙️ Лимит: 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\OrdersApi(
    // 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_status_request = new \OpenAPI\Client\Model\UpdateOrderStatusRequest(); // \OpenAPI\Client\Model\UpdateOrderStatusRequest

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

Parameters

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

Return type

\OpenAPI\Client\Model\UpdateOrderStatusResponse

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]

`updateOrderStatuses()`

updateOrderStatuses($campaign_id, $update_order_statuses_request): \OpenAPI\Client\Model\UpdateOrderStatusesResponse

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

Изменяет статусы нескольких заказов. Максимальное количество заказов, у которых можно изменить статус в одном запросе, — 30. Возможные изменения статусов: * Если магазин подтвердил и подготовил заказ к отправке, то заказ из статуса \"status\": \"PROCESSING\"и этапа обработки \"substatus\": \"STARTED\" нужно перевести в статус \"status\": \"PROCESSING\" и этап обработки \"substatus\": \"READY_TO_SHIP\". * Если магазин подтвердил заказ, но не может его выполнить (например, товар числится в базе, но отсутствует на складе или нет нужного цвета), то заказ из статуса \"status\": \"PROCESSING\" и этапа обработки \"substatus\": \"STARTED\" нужно перевести в статус \"status\": \"CANCELLED\" с причиной отмены заказа \"substatus\": \"SHOP_FAILED\". * Если магазин подготовил заказ к отгрузке, но не может его выполнить (например, последний товар был поврежден или оказался с браком), то заказ из статуса \"status\": \"PROCESSING\" и этапа обработки \"substatus\": \"READY_TO_SHIP\" нужно перевести в статус \"status\": \"CANCELLED\" с причиной отмены заказа \"substatus\": \"SHOP_FAILED\". Максимальное количество заказов, у которых можно изменить статус в одном запросе, — 30. |⚙️ Лимит: 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\OrdersApi(
    // 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)
$update_order_statuses_request = new \OpenAPI\Client\Model\UpdateOrderStatusesRequest(); // \OpenAPI\Client\Model\UpdateOrderStatusesRequest

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

Parameters

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

Return type

\OpenAPI\Client\Model\UpdateOrderStatusesResponse

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]

Files

OrdersApi.md

Latest commit

History

OrdersApi.md

File metadata and controls

OpenAPI\Client\OrdersApi

acceptOrderCancellation()

Example

Parameters

Return type

Authorization

HTTP request headers

getOrder()

Example

Parameters

Return type

Authorization

HTTP request headers

getOrders()

Example

Parameters

Return type

Authorization

HTTP request headers

provideOrderDigitalCodes()

Example

Parameters

Return type

Authorization

HTTP request headers

provideOrderItemIdentifiers()

Example

Parameters

Return type

Authorization

HTTP request headers

setOrderBoxLayout()

Example

Parameters

Return type

Authorization

HTTP request headers

setOrderShipmentBoxes()

Example

Parameters

Return type

Authorization

HTTP request headers

updateOrderItems()

Example

Parameters

Return type

Authorization

HTTP request headers

updateOrderStatus()

Example

Parameters

Return type

Authorization

HTTP request headers

updateOrderStatuses()

Example

Parameters

Return type

Authorization

HTTP request headers

`acceptOrderCancellation()`

`getOrder()`

`getOrders()`

`provideOrderDigitalCodes()`

`provideOrderItemIdentifiers()`

`setOrderBoxLayout()`

`setOrderShipmentBoxes()`

`updateOrderItems()`

`updateOrderStatus()`

`updateOrderStatuses()`