- Request
- Responses
- 200 OK
- Body
- ApiResponseStatusType
- OrdersStatsDTO
- OrdersStatsOrderDTO
- ForwardScrollingPagerDTO
- OrdersStatsCommissionDTO
- CurrencyType
- OrdersStatsItemDTO
- OrdersStatsPaymentDTO
- OrdersStatsDeliveryRegionDTO
- OrdersStatsOrderPaymentType
- OrdersStatsSubsidyDTO
- OrdersStatsCommissionType
- OrdersStatsDetailsDTO
- OrdersStatsPriceDTO
- OrdersStatsWarehouseDTO
- OrdersStatsPaymentOrderDTO
- OrdersStatsPaymentSourceType
- OrdersStatsPaymentType
- OrdersStatsSubsidyOperationType
- OrdersStatsSubsidyType
- OrdersStatsItemStatusType
- OrdersStatsStockType
- OrdersStatsPriceType
- 400 Bad Request
- 401 Unauthorized
- 403 Forbidden
- 404 Not Found
- 420 Method Failure
- 500 Internal Server Error
Детальная информация по заказам
Метод доступен для всех моделей.
Если вы используете API-Key-токен, для вызова метода необходим один из доступов в списке
- inventory-and-order-processing — Обработка заказов и учёт товаров
- inventory-and-order-processing:read-only — Просмотр информации о заказах
- all-methods — Полное управление кабинетом
- all-methods:read-only — Просмотр всех данных
Возвращает информацию по заказам на Маркете, в которых есть ваши товары.
С помощью нее вы можете собрать статистику по вашим заказам и узнать, например, какие из товаров чаще всего возвращаются покупателями, какие, наоборот, пользуются большим спросом и т. п.
Информация по созданным или обновленным заказам может появиться с задержкой до 40 минут
Чтобы получить данные без задержки, используйте метод получения информации о заказах.
В одном запросе можно получить информацию не более чем по 200 заказам.
| ⚙️ Лимит: 1 000 000 заказов в час |
|---|
Request
POST
https://api.partner.market.yandex.ru/v2/campaigns/{campaignId}/stats/orders
Path parameters
|
Name |
Description |
|
campaignId* |
Type: integer<int64> Идентификатор кампании. Его можно узнать с помощью запроса GET v2/campaigns или найти в кабинете продавца на Маркете — нажмите на иконку вашего аккаунта → Настройки и в меню слева выберите API и модули:
⚠️ Не передавайте вместо него идентификатор магазина, который указан в кабинете продавца на Маркете рядом с названием магазина и в некоторых отчетах.
Min value: |
Query parameters
|
Name |
Description |
|
limit |
Type: integer<int32> Количество значений на одной странице.
Min value: |
|
page_token |
Type: string Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуем передавать значение выходного параметра Если задан |
Body
application/json
{
"dateFrom": "string",
"dateTo": "string",
"updateFrom": "string",
"updateTo": "string",
"orders": [
0
],
"statuses": [
"CANCELLED_BEFORE_PROCESSING"
],
"hasCis": false
}
|
Name |
Description |
|
dateFrom |
Type: string<date> Начальная дата, когда заказ был сформирован. Формат даты: Нельзя использовать вместе с параметрами |
|
dateTo |
Type: string<date> Конечная дата, когда заказ был сформирован. Формат даты: Нельзя использовать вместе с параметрами |
|
hasCis |
Type: boolean Нужно ли вернуть только те заказы, в составе которых есть хотя бы один товар с кодом идентификации в системе «Честный ЗНАК» или «ASL BELGISI» (для продавцов Market Yandex Go):
|
|
orders |
Type: integer<int64>[] Список идентификаторов заказов. В ходе обработки заказа Маркет может удалить из него единицы товаров — при проблемах на складе или по инициативе пользователя.
Min items: Unique items |
|
statuses |
Type: OrderStatsStatusType[] Список статусов заказов.
Enum: Min items: Unique items |
|
updateFrom |
Type: string<date> Начальная дата периода, за который были изменения в заказе (например, статуса или информации о платежах). Формат даты: Нельзя использовать вместе с параметрами |
|
updateTo |
Type: string<date> Конечная дата периода, за который были изменения в заказе (например, статуса или информации о платежах). Формат даты: Нельзя использовать вместе с параметрами |
OrderStatsStatusType
Текущий статус заказа:
-
CANCELLED_BEFORE_PROCESSING— заказ отменен до начала его обработки. -
CANCELLED_IN_DELIVERY— заказ отменен во время его доставки. -
CANCELLED_IN_PROCESSING— заказ отменен во время его обработки. -
DELIVERY— заказ передан службе доставки. -
DELIVERED— заказ доставлен. -
PARTIALLY_DELIVERED— заказ частично доставлен.Статус заказа может перейти в
PARTIALLY_DELIVEREDне сразуЕсли в доставленном заказе был невыкуп, статус изменится только после получения заказа на складе Маркета.
-
PARTIALLY_RETURNED— заказ частично возвращен покупателем. -
PENDING— заказ ожидает подтверждения. -
PICKUP— заказ доставлен в пункт выдачи. -
PROCESSING— заказ в обработке. -
RESERVED— товар зарезервирован на складе. -
RETURNED— заказ полностью возвращен покупателем. -
UNKNOWN— неизвестный статус заказа. -
UNPAID— заказ от юридического лица ожидает оплаты. -
LOST— заказ утерян.
|
Type |
Description |
|
Enum: |
Responses
200 OK
Информация по заказам.
Body
application/json
{
"status": "OK",
"result": {
"orders": [
{
"id": 0,
"creationDate": "string",
"statusUpdateDate": "2022-12-29T18:02:01Z",
"status": "CANCELLED_BEFORE_PROCESSING",
"partnerOrderId": "string",
"paymentType": "POSTPAID",
"fake": false,
"deliveryRegion": {
"id": 0,
"name": "string"
},
"items": [
{
"offerName": "string",
"marketSku": 0,
"shopSku": "string",
"count": 0,
"prices": [
{
"type": "BUYER",
"costPerItem": 0,
"total": 0
}
],
"warehouse": {
"id": 0,
"name": "string"
},
"details": [
{
"itemStatus": "REJECTED",
"itemCount": 0,
"updateDate": "string",
"stockType": "FIT"
}
],
"cisList": [
"string"
],
"initialCount": 0,
"bidFee": 570,
"cofinanceThreshold": 0,
"cofinanceValue": 0
}
],
"initialItems": [
{
"offerName": "string",
"marketSku": 0,
"shopSku": "string",
"count": 0,
"prices": [
{
"type": "BUYER",
"costPerItem": 0,
"total": 0
}
],
"warehouse": {
"id": 0,
"name": "string"
},
"details": [
{
"itemStatus": "REJECTED",
"itemCount": 0,
"updateDate": "string",
"stockType": "FIT"
}
],
"cisList": [
"string"
],
"initialCount": 0,
"bidFee": 570,
"cofinanceThreshold": 0,
"cofinanceValue": 0
}
],
"payments": [
{
"id": "string",
"date": "string",
"type": "PAYMENT",
"source": "BUYER",
"total": 0,
"paymentOrder": {
"id": "string",
"date": "string"
}
}
],
"commissions": [
{
"type": "FEE",
"actual": 0
}
],
"subsidies": [
{
"operationType": "ACCRUAL",
"type": "YANDEX_CASHBACK",
"amount": 0
}
],
"currency": "RUR"
}
],
"paging": {
"nextPageToken": "string"
}
}
}
|
Name |
Description |
|
status* |
Type: ApiResponseStatusType Тип ответа. Возможные значения:
Enum: |
|
result |
Type: OrdersStatsDTO Информация по заказам. |
ApiResponseStatusType
Тип ответа. Возможные значения:
OK— ошибок нет.ERROR— при обработке запроса произошла ошибка.
|
Type |
Description |
|
Enum: |
OrdersStatsDTO
Информация по заказам.
|
Name |
Description |
|
orders* |
Type: OrdersStatsOrderDTO[] Список заказов. |
|
paging |
Type: ForwardScrollingPagerDTO Идентификатор следующей страницы. |
OrdersStatsOrderDTO
Информация о заказе.
|
Name |
Description |
|
commissions* |
Type: OrdersStatsCommissionDTO[] Информация о стоимости услуг. |
|
currency* |
Type: CurrencyType Валюта, в которой указаны цены в заказе. Enum: |
|
items* |
Type: OrdersStatsItemDTO[] Список товаров в заказе после возможных изменений. Информация о доставке заказа добавляется отдельным элементом в массиве В ходе обработки заказа Маркет может удалить из него единицы товаров — при проблемах на складе или по инициативе пользователя.
|
|
payments* |
Type: OrdersStatsPaymentDTO[] Информация о расчетах по заказу. Возвращается пустым, если заказ:
Окончательная информация о расчетах по заказу вернется после его финальной обработки (например, после перехода в статус |
|
creationDate |
Type: string<date> Дата создания заказа. Формат даты: |
|
deliveryRegion |
Type: OrdersStatsDeliveryRegionDTO Информация о регионе доставки. |
|
fake |
Type: boolean Тип заказа:
|
|
id |
Type: integer<int64> Идентификатор заказа. |
|
initialItems |
Type: OrdersStatsItemDTO[] Список товаров в заказе. Возвращается, только если было изменение количества товаров.
В ходе обработки заказа Маркет может удалить из него единицы товаров — при проблемах на складе или по инициативе пользователя.
Min items: |
|
partnerOrderId |
Type: string Идентификатор заказа в информационной системе магазина. |
|
paymentType |
Type: OrdersStatsOrderPaymentType Тип оплаты заказа. Enum: |
|
status |
Type: OrderStatsStatusType Текущий статус заказа:
Enum: |
|
statusUpdateDate |
Type: string<date-time> Дата и время, когда статус заказа был изменен в последний раз. Формат даты и времени: ISO 8601. Например, |
|
subsidies |
Type: OrdersStatsSubsidyDTO[] Начисление баллов, которые используются для уменьшения стоимости размещения, и их списание в случае невыкупа или возврата. Min items: |
ForwardScrollingPagerDTO
Идентификатор следующей страницы.
|
Name |
Description |
|
nextPageToken |
Type: string Идентификатор следующей страницы результатов. |
OrdersStatsCommissionDTO
Информация о стоимости услуг.
|
Name |
Description |
|
actual |
Type: number Сумма, которая была выставлена в момент создания заказа и которую нужно оплатить. Точность — два знака после запятой. |
|
type |
Type: OrdersStatsCommissionType Услуга. Enum: |
CurrencyType
Коды валют:
RUR— российский рубль.UAH— украинская гривна.BYR— белорусский рубль.KZT— казахстанский тенге.UZS— узбекский сум.
|
Type |
Description |
|
Enum: |
OrdersStatsItemDTO
Список товаров в заказе после возможных изменений.
В ходе обработки заказа Маркет может удалить из него единицы товаров — при проблемах на складе или по инициативе пользователя.
-
Если из заказа удалены все единицы товара, его не будет в списке
items— только в спискеinitialItems. -
Если в заказе осталась хотя бы одна единица товара, он будет и в списке
items(с уменьшенным количеством единицcount), и в спискеinitialItems(с первоначальным количеством единицinitialCount).
|
Name |
Description |
|
bidFee |
Type: integer<int32> Списанная ставка ближайшего конкурента. Указывается в процентах от стоимости товара и умножается на 100. Например, ставка 5% обозначается как 500. Example: Min value: Max value: |
|
cisList |
Type: string[] Список кодов идентификации товара в системе «Честный ЗНАК» или «ASL BELGISI» (для продавцов Market Yandex Go). Min items: Unique items |
|
cofinanceThreshold |
Type: number Порог для скидок с Маркетом на момент оформления заказа. Что это такое? Точность — два знака после запятой. |
|
cofinanceValue |
Type: number Скидка с Маркетом. Что это такое? Точность — два знака после запятой. |
|
count |
Type: integer<int32> Количество единиц товара с учетом удаленных единиц. Если из заказа удалены все единицы товара, он попадет только в список |
|
details |
Type: OrdersStatsDetailsDTO[] Информация об удалении товара из заказа. Min items: |
|
initialCount |
Type: integer<int32> Первоначальное количество единиц товара. |
|
marketSku |
Type: integer<int64> Идентификатор карточки товара на Маркете. Min value: |
|
offerName |
Type: string Название товара. |
|
prices |
Type: OrdersStatsPriceDTO[] Цена или скидки на товар. Min items: |
|
shopSku |
Type: string Ваш SKU — идентификатор товара в вашей системе. Правила использования SKU:
SKU товара можно изменить в кабинете продавца на Маркете. О том, как это сделать, читайте в Справке Маркета для продавцов. Что такое SKU и как его назначать Min length: Max length: Pattern: |
|
warehouse |
Type: OrdersStatsWarehouseDTO Информация о складе, на котором хранится товар. |
OrdersStatsPaymentDTO
Информация о денежных переводах по заказу.
|
Name |
Description |
|
date |
Type: string<date> Дата денежного перевода. Формат даты: |
|
id |
Type: string Идентификатор денежного перевода. |
|
paymentOrder |
Type: OrdersStatsPaymentOrderDTO Информация о платежном поручении. |
|
source |
Type: OrdersStatsPaymentSourceType Способ денежного перевода. Enum: |
|
total |
Type: number Сумма денежного перевода. Точность — два знака после запятой. |
|
type |
Type: OrdersStatsPaymentType Тип денежного перевода. Enum: |
OrdersStatsDeliveryRegionDTO
Информация о регионе доставки.
|
Name |
Description |
|
id |
Type: integer<int64> Идентификатор региона доставки. |
|
name |
Type: string Название региона доставки. |
OrdersStatsOrderPaymentType
Тип оплаты заказа:
POSTPAID— заказ оплачен после того, как был получен.PREPAID— заказ оплачен до того, как был получен.UNKNOWN— неизвестный тип оплаты. Скорее всего покупатель отменил или вернул заказ или не было его оплаты.
|
Type |
Description |
|
Enum: |
OrdersStatsSubsidyDTO
Информация о начислении баллов, которые используются для уменьшения стоимости размещения, и их списании в случае невыкупа или возврата.
|
Name |
Description |
|
amount* |
Type: number Количество баллов, которые используются для уменьшения стоимости размещения, с точностью до двух знаков после запятой. |
|
operationType* |
Type: OrdersStatsSubsidyOperationType Тип операции c баллами, которые используются для уменьшения стоимости размещения. Enum: |
|
type* |
Type: OrdersStatsSubsidyType Источник баллов, которые используются для уменьшения стоимости размещения. Enum: |
OrdersStatsCommissionType
Услуга:
FEE— размещение товара на Маркете.FULFILLMENT— складская обработка. Не возвращается с 1 января 2024 года.LOYALTY_PARTICIPATION_FEE— участие в программе лояльности и отзывы за баллы.AUCTION_PROMOTION— буст продаж с оплатой за продажи.INSTALLMENT— рассрочка. Не возвращается с 24 февраля 2022 года.DELIVERY_TO_CUSTOMER— доставка покупателю (FBY, FBS). Для DBS и Экспресс — если заказ возвращается через логистику Маркета.EXPRESS_DELIVERY_TO_CUSTOMER— экспресс-доставка покупателю (Экспресс).AGENCY— прием платежа покупателя.PAYMENT_TRANSFER— перевод платежа покупателя.RETURNED_ORDERS_STORAGE— хранение невыкупов и возвратов (FBS). Для DBS и Экспресс — если заказ возвращается через логистику Маркета.SORTING— обработка заказа (FBS).INTAKE_SORTING— организация забора заказов со склада продавца (FBS).RETURN_PROCESSING— обработка заказов на складе (FBS). Для DBS и Экспресс — если заказ возвращается через логистику Маркета.ILLIQUID_GOODS_SALE— вознаграждение за продажу невывезенных товаров.
|
Type |
Description |
|
Enum: |
OrdersStatsDetailsDTO
Информация об удалении товара из заказа.
|
Name |
Description |
|
itemCount |
Type: integer<int64> Количество товара со статусом, указанном в параметре |
|
itemStatus |
Type: OrdersStatsItemStatusType Статус товара. Enum: |
|
stockType |
Type: OrdersStatsStockType Тип товара. Enum: |
|
updateDate |
Type: string<date> Дата, когда товар получил статус, указанный в параметре Формат даты: |
OrdersStatsPriceDTO
Цена или скидки на товар.
|
Name |
Description |
|
costPerItem |
Type: number Цена или скидка на единицу товара в заказе. Точность — два знака после запятой. Включает НДС. |
|
total |
Type: number Суммарная цена или скидка на все единицы товара в заказе. Точность — два знака после запятой. Включает НДС. |
|
type |
Type: OrdersStatsPriceType Тип скидки или цена товара. Enum: |
OrdersStatsWarehouseDTO
Информация о складе, на котором хранится товар.
|
Name |
Description |
|
id |
Type: integer<int64> Идентификатор склада. |
|
name |
Type: string Название склада. |
OrdersStatsPaymentOrderDTO
Информация о платежном поручении.
|
Name |
Description |
|
date |
Type: string<date> Дата платежного поручения. Формат даты: |
|
id |
Type: string Номер платежного поручения. |
OrdersStatsPaymentSourceType
Способ денежного перевода:
BUYER— оплата или возврат деньгами.
Устаревшие способы:
CASHBACK.MARKETPLACE.SPLIT.
|
Type |
Description |
|
Enum: |
OrdersStatsPaymentType
Тип денежного перевода:
PAYMENT— оплата.REFUND— возврат.
|
Type |
Description |
|
Enum: |
OrdersStatsSubsidyOperationType
Тип операции с баллами, которые используются для уменьшения стоимости размещения:
ACCRUAL— начисление баллов.DEDUCTION— списание баллов.
|
Type |
Description |
|
Enum: |
OrdersStatsSubsidyType
Источник баллов, которые используются для уменьшения стоимости размещения:
-
YANDEX_CASHBACK— скидка по подписке Яндекс Плюс. -
SUBSIDY— скидка Маркета (по акциям, промокодам, купонам и т. д.) -
DELIVERY— скидка за доставку (DBS).
|
Type |
Description |
|
Enum: |
OrdersStatsItemStatusType
Статус товара:
REJECTED— товар был добавлен в созданный заказ, но не был оплачен.RETURNED— товар вернули.
|
Type |
Description |
|
Enum: |
OrdersStatsStockType
Тип товара:
-
FIT— товар надлежащего качества. -
DEFECT— товар бракованный. -
EXPIRED— товар с истекшим сроком годности.
|
Type |
Description |
|
Enum: |
OrdersStatsPriceType
Тип скидки или цена товара:
BUYER— цена товара с учетом скидок, в том числе купонов.CASHBACK— баллы Плюса.MARKETPLACE— купоны.
|
Type |
Description |
|
Enum: |
400 Bad Request
Запрос содержит неправильные данные. Подробнее об ошибке
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: ApiErrorDTO[] Список ошибок. Min items: |
|
status |
Type: ApiResponseStatusType Тип ответа. Возможные значения:
Enum: |
ApiErrorDTO
Общий формат ошибки.
|
Name |
Description |
|
code* |
Type: string Код ошибки. |
|
message |
Type: string Описание ошибки. |
401 Unauthorized
В запросе не указаны данные для авторизации. Подробнее об ошибке
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: ApiErrorDTO[] Список ошибок. Min items: |
|
status |
Type: ApiResponseStatusType Тип ответа. Возможные значения:
Enum: |
403 Forbidden
Данные для авторизации неверны или доступ к ресурсу запрещен. Подробнее об ошибке
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: ApiErrorDTO[] Список ошибок. Min items: |
|
status |
Type: ApiResponseStatusType Тип ответа. Возможные значения:
Enum: |
404 Not Found
Запрашиваемый ресурс не найден. Подробнее об ошибке
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: ApiErrorDTO[] Список ошибок. Min items: |
|
status |
Type: ApiResponseStatusType Тип ответа. Возможные значения:
Enum: |
420 Method Failure
Превышено ограничение на доступ к ресурсу. Подробнее об ошибке
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: ApiErrorDTO[] Список ошибок. Min items: |
|
status |
Type: ApiResponseStatusType Тип ответа. Возможные значения:
Enum: |
500 Internal Server Error
Внутренняя ошибка Маркета. Подробнее об ошибке
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: ApiErrorDTO[] Список ошибок. Min items: |
|
status |
Type: ApiResponseStatusType Тип ответа. Возможные значения:
Enum: |
No longer supported, please use an alternative and newer version.