- Request
- Responses
- 200 OK
- Body
- ApiResponseStatusType
- ApiResponse
- OrdersStatsOrderPaymentType
- OrdersStatsDeliveryRegionDTO
- MarketSku
- ShopSku
- OrdersStatsPriceType
- OrdersStatsPriceDTO
- OrdersStatsWarehouseDTO
- OrdersStatsItemStatusType
- OrdersStatsStockType
- OrdersStatsDetailsDTO
- OrdersStatsItemDTO
- OrdersStatsPaymentType
- OrdersStatsPaymentSourceType
- OrdersStatsPaymentOrderDTO
- OrdersStatsPaymentDTO
- OrdersStatsCommissionType
- OrdersStatsCommissionDTO
- OrdersStatsSubsidyOperationType
- OrdersStatsSubsidyType
- OrdersStatsSubsidyDTO
- OrderBuyerType
- CurrencyType
- OrdersStatsOrderDTO
- ForwardScrollingPagerDTO
- OrdersStatsDTO
- 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 минут
Чтобы получить данные без задержки, используйте метод POST v1/businesses/{businessId}/orders.
В одном запросе можно получить информацию не более чем по 200 заказам.
| ⚙️ Лимит: 1 000 000 заказов в час |
|---|
Request
POST
https://api.partner.market.yandex.ru/v2/campaigns/{campaignId}/stats/orders
Path parameters
|
Name |
Description |
|
campaignId |
Type: integer Идентификатор кампании (магазина) — технический идентификатор, который представляет ваш магазин в системе Яндекс Маркета при работе через API. Он однозначно связывается с вашим магазином, но предназначен только для автоматизированного взаимодействия. Его можно узнать с помощью запроса GET v2/campaigns или найти в кабинете продавца на Маркете. Нажмите на иконку вашего аккаунта → Настройки и в меню слева выберите API и модули:
⚠️ Не путайте его с:
Min value: |
Query parameters
|
Name |
Description |
|
limit |
Type: integer Количество значений на одной странице. Min value: |
|
page_token |
Type: string Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуем передавать значение выходного параметра Если задан Example: |
Body
application/json
{
"dateFrom": "2025-01-01",
"dateTo": "2025-01-01",
"updateFrom": "2025-01-01",
"updateTo": "2025-01-01",
"orders": [
0
],
"statuses": [
"CANCELLED_BEFORE_PROCESSING"
],
"hasCis": true
}
|
Name |
Description |
|
dateFrom |
Type: string<date> Начальная дата, когда заказ был сформирован. Формат даты: Нельзя использовать вместе с параметрами Example: |
|
dateTo |
Type: string<date> Конечная дата, когда заказ был сформирован. Формат даты: Нельзя использовать вместе с параметрами Example: |
|
hasCis |
Type: boolean Фильтр для получения заказов, в которых есть хотя бы один товар с кодом идентификации в системе «Честный ЗНАК» или «ASL BELGISI» (для продавцов Market Yandex Go):
|
|
orders |
Type: integer[] | null Список идентификаторов заказов. Min items: Unique items: Example
|
|
statuses |
Type: OrderStatsStatusType[] | null Список статусов заказов. Min items: Unique items: Example
|
|
updateFrom |
Type: string<date> Начальная дата периода, за который были изменения в заказе (например, статуса или информации о платежах). Формат даты: Нельзя использовать вместе с параметрами Example: |
|
updateTo |
Type: string<date> Конечная дата периода, за который были изменения в заказе (например, статуса или информации о платежах). Формат даты: Нельзя использовать вместе с параметрами Example: |
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: string
Enum: CANCELLED_BEFORE_PROCESSING, CANCELLED_IN_DELIVERY, CANCELLED_IN_PROCESSING, DELIVERY, DELIVERED, PARTIALLY_DELIVERED, PARTIALLY_RETURNED, PENDING, PICKUP, PROCESSING, RESERVED, RETURNED, UNKNOWN, UNPAID, LOST
Responses
200 OK
Информация по заказам.
Body
application/json
{
"status": "OK"
}
Type: object
ApiResponseStatusType
Тип ответа. Возможные значения:
OK— ошибок нет.ERROR— при обработке запроса произошла ошибка.
Type: string
Enum: OK, ERROR
ApiResponse
Стандартная обертка для ответов сервера.
|
Name |
Description |
|
status |
Type: ApiResponseStatusType Тип ответа. Возможные значения:
Enum: |
Example
{
"status": "OK"
}
OrdersStatsOrderPaymentType
Тип оплаты заказа:
POSTPAID— заказ оплачен после того, как был получен.PREPAID— заказ оплачен до того, как был получен.UNKNOWN— неизвестный тип оплаты. Скорее всего покупатель отменил или вернул заказ или не было его оплаты.
Type: string
Enum: POSTPAID, PREPAID, UNKNOWN
OrdersStatsDeliveryRegionDTO
Информация о регионе доставки.
|
Name |
Description |
|
id |
Type: integer Идентификатор региона доставки. |
|
name |
Type: string Название региона доставки. Example: |
Example
{
"id": 0,
"name": "example"
}
MarketSku
Идентификатор карточки товара на Маркете.
Type: integer
Min value: 1
ShopSku
Ваш SKU — идентификатор товара в вашей системе.
Правила использования SKU:
-
У каждого товара SKU должен быть свой.
-
Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.
SKU товара можно изменить в кабинете продавца на Маркете. О том, как это сделать, читайте в Справке Маркета для продавцов.
Важно
Пробельные символы в начале и конце значения автоматически удаляются. Например, " SKU123 " и "SKU123" будут обработаны как одинаковые значения.
Что такое SKU и как его назначать
Type: string
Min length: 1
Max length: 255
Pattern: ^(?=.*\S.*)[^\x00-\x08\x0A-\x1f\x7f]{1,255}$
Example: example
OrdersStatsPriceType
Тип скидки или цена товара:
BUYER— цена товара с учетом скидок, в том числе купонов.CASHBACK— баллы Плюса.MARKETPLACE— купоны.
Type: string
Enum: BUYER, CASHBACK, MARKETPLACE
OrdersStatsPriceDTO
Цена или скидки на товар.
|
Name |
Description |
|
costPerItem |
Type: number Цена или скидка на единицу товара в заказе. Точность — два знака после запятой. Включает НДС. |
|
total |
Type: number Суммарная цена или скидка на все единицы товара в заказе. Точность — два знака после запятой. Включает НДС. |
|
type |
Type: OrdersStatsPriceType Тип скидки или цена товара. Тип скидки или цена товара:
Enum: |
Example
{
"type": "BUYER",
"costPerItem": 0.5,
"total": 0.5
}
OrdersStatsWarehouseDTO
Информация о складе, на котором хранится товар.
|
Name |
Description |
|
id |
Type: integer Идентификатор склада. |
|
name |
Type: string Название склада. Example: |
Example
{
"id": 0,
"name": "example"
}
OrdersStatsItemStatusType
Статус товара:
REJECTED— товар был добавлен в созданный заказ, но не был оплачен.RETURNED— товар вернули.
Type: string
Enum: REJECTED, RETURNED
OrdersStatsStockType
Тип товара:
-
FIT— товар надлежащего качества. -
DEFECT— товар бракованный. -
EXPIRED— товар с истекшим сроком годности.
Type: string
Enum: FIT, DEFECT, EXPIRED
OrdersStatsDetailsDTO
Информация об удалении товара из заказа.
|
Name |
Description |
|
itemCount |
Type: integer Количество товара со статусом, указанном в параметре |
|
itemStatus |
Type: OrdersStatsItemStatusType Статус товара. Статус товара:
Enum: |
|
stockType |
Type: OrdersStatsStockType Только для модели FBY Тип товара. Возвращается только после обработки возврата на складе Маркета. Тип товара:
Enum: |
|
updateDate |
Type: string<date> Только для модели FBY Дата, когда возврат был обработан на складе Маркета. Формат даты: Example: |
Example
{
"itemStatus": "REJECTED",
"itemCount": 0,
"updateDate": "2025-01-01",
"stockType": "FIT"
}
OrdersStatsItemDTO
Список товаров в заказе после возможных изменений.
В ходе обработки заказа Маркет может удалить из него единицы товаров — при проблемах на складе или по инициативе пользователя.
-
Если из заказа удалены все единицы товара, его не будет в списке
items— только в спискеinitialItems. -
Если в заказе осталась хотя бы одна единица товара, он будет и в списке
items(с уменьшенным количеством единицcount), и в спискеinitialItems(с первоначальным количеством единицinitialCount).
|
Name |
Description |
|
bidFee |
Type: integer Списанная ставка ближайшего конкурента. Указывается в процентах от стоимости товара и умножается на 100. Например, ставка 5% обозначается как 500. Min value: Max value: |
|
cisList |
Type: string[] | null Список кодов идентификации товара в системе «Честный ЗНАК» или «ASL BELGISI» (для продавцов Market Yandex Go). Min items: Unique items: Example
|
|
cofinanceThreshold |
Type: number Порог для скидок с Маркетом на момент оформления заказа. Что это такое? Точность — два знака после запятой. |
|
cofinanceValue |
Type: number Скидка с Маркетом. Что это такое? Точность — два знака после запятой. |
|
count |
Type: integer Количество единиц товара с учетом удаленных единиц. Если из заказа удалены все единицы товара, он попадет только в список |
|
details |
Type: OrdersStatsDetailsDTO[] | null Информация об удалении товара из заказа. Min items: Example
|
|
initialCount |
Type: integer Первоначальное количество единиц товара. |
|
marketSku |
Type: MarketSku Идентификатор карточки товара на Маркете. Min value: Example: |
|
offerName |
Type: string Название товара. Example: |
|
prices |
Type: OrdersStatsPriceDTO[] | null Цена или скидки на товар. Min items: Example
|
|
shopSku |
Type: ShopSku Ваш SKU — идентификатор товара в вашей системе. Правила использования SKU:
SKU товара можно изменить в кабинете продавца на Маркете. О том, как это сделать, читайте в Справке Маркета для продавцов. Важно Пробельные символы в начале и конце значения автоматически удаляются. Например, Что такое SKU и как его назначать Min length: Max length: Pattern: Example: |
|
warehouse |
Type: OrdersStatsWarehouseDTO Информация о складе, на котором хранится товар. Example
|
Example
{
"offerName": "example",
"marketSku": 1,
"shopSku": "example",
"count": 0,
"prices": [
{
"type": "BUYER",
"costPerItem": 0.5,
"total": 0.5
}
],
"warehouse": {
"id": 0,
"name": "example"
},
"details": [
{
"itemStatus": "REJECTED",
"itemCount": 0,
"updateDate": "2025-01-01",
"stockType": "FIT"
}
],
"cisList": [
"example"
],
"initialCount": 0,
"bidFee": 570,
"cofinanceThreshold": 0.5,
"cofinanceValue": 0.5
}
OrdersStatsPaymentType
Тип денежного перевода:
PAYMENT— оплата.REFUND— возврат.
Type: string
Enum: PAYMENT, REFUND
OrdersStatsPaymentSourceType
Способ денежного перевода:
BUYER— оплата или возврат деньгами.
Устаревшие способы:
CASHBACK.MARKETPLACE.SPLIT.
Type: string
Enum: BUYER, CASHBACK, MARKETPLACE, SPLIT
OrdersStatsPaymentOrderDTO
Информация о платежном поручении.
|
Name |
Description |
|
date |
Type: string<date> Дата платежного поручения. Формат даты: Example: |
|
id |
Type: string Номер платежного поручения. Example: |
Example
{
"id": "example",
"date": "2025-01-01"
}
OrdersStatsPaymentDTO
Информация о денежных переводах по заказу.
|
Name |
Description |
|
date |
Type: string<date> Дата денежного перевода. Формат даты: Example: |
|
id |
Type: string Идентификатор денежного перевода. Example: |
|
paymentOrder |
Type: OrdersStatsPaymentOrderDTO Информация о платежном поручении. Example
|
|
source |
Type: OrdersStatsPaymentSourceType Способ денежного перевода. Способ денежного перевода:
Устаревшие способы:
Enum: |
|
total |
Type: number Сумма денежного перевода. Точность — два знака после запятой. |
|
type |
Type: OrdersStatsPaymentType Тип денежного перевода. Тип денежного перевода:
Enum: |
Example
{
"id": "example",
"date": "2025-01-01",
"type": "PAYMENT",
"source": "BUYER",
"total": 0.5,
"paymentOrder": {
"id": "example",
"date": "2025-01-01"
}
}
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: string
Enum: FEE, FULFILLMENT, LOYALTY_PARTICIPATION_FEE, AUCTION_PROMOTION, INSTALLMENT, DELIVERY_TO_CUSTOMER, EXPRESS_DELIVERY_TO_CUSTOMER, AGENCY, PAYMENT_TRANSFER, RETURNED_ORDERS_STORAGE, SORTING, INTAKE_SORTING, RETURN_PROCESSING, ILLIQUID_GOODS_SALE
OrdersStatsCommissionDTO
Информация о стоимости услуг.
|
Name |
Description |
|
actual |
Type: number Сумма, которая была выставлена в момент создания заказа и которую нужно оплатить. Точность — два знака после запятой. |
|
type |
Type: OrdersStatsCommissionType Услуга. Услуга:
Enum: |
Example
{
"type": "FEE",
"actual": 0.5
}
OrdersStatsSubsidyOperationType
Тип операции с баллами, которые используются для уменьшения стоимости размещения:
ACCRUAL— начисление баллов.DEDUCTION— списание баллов.
Type: string
Enum: ACCRUAL, DEDUCTION
OrdersStatsSubsidyType
Источник баллов, которые используются для уменьшения стоимости размещения:
-
YANDEX_CASHBACK— скидка по подписке Яндекс Плюс. -
SUBSIDY— скидка Маркета (по акциям, промокодам, купонам и т. д.) -
DELIVERY— скидка за доставку (DBS).
Type: string
Enum: YANDEX_CASHBACK, SUBSIDY, DELIVERY
OrdersStatsSubsidyDTO
Информация о начислении баллов, которые используются для уменьшения стоимости размещения, и их списании в случае невыкупа или возврата.
|
Name |
Description |
|
amount |
Type: number Количество баллов, которые используются для уменьшения стоимости размещения, с точностью до двух знаков после запятой. |
|
operationType |
Type: OrdersStatsSubsidyOperationType Тип операции c баллами, которые используются для уменьшения стоимости размещения. Тип операции с баллами, которые используются для уменьшения стоимости размещения:
Enum: |
|
type |
Type: OrdersStatsSubsidyType Источник баллов, которые используются для уменьшения стоимости размещения. Источник баллов, которые используются для уменьшения стоимости размещения:
Enum: |
Example
{
"operationType": "ACCRUAL",
"type": "YANDEX_CASHBACK",
"amount": 0.5
}
OrderBuyerType
Тип покупателя:
-
PERSON— физическое лицо. -
BUSINESS— организация.
Type: string
Enum: PERSON, BUSINESS
CurrencyType
Коды валют:
RUR— российский рубль.UAH— украинская гривна.BYR— белорусский рубль.KZT— казахстанский тенге.UZS— узбекский сум.
Type: string
Enum: RUR, USD, EUR, UAH, AUD, GBP, BYR, BYN, DKK, ISK, KZT, CAD, CNY, NOK, XDR, SGD, TRY, SEK, CHF, JPY, AZN, ALL, DZD, AOA, ARS, AMD, AFN, BHD, BGN, BOB, BWP, BND, BRL, BIF, HUF, VEF, KPW, VND, GMD, GHS, GNF, HKD, GEL, AED, EGP, ZMK, ILS, INR, IDR, JOD, IQD, IRR, YER, QAR, KES, KGS, COP, CDF, CRC, KWD, CUP, LAK, LVL, SLL, LBP, LYD, SZL, LTL, MUR, MRO, MKD, MWK, MGA, MYR, MAD, MXN, MZN, MDL, MNT, NPR, NGN, NIO, NZD, OMR, PKR, PYG, PEN, PLN, KHR, SAR, RON, SCR, SYP, SKK, SOS, SDG, SRD, TJS, THB, TWD, BDT, TZS, TND, TMM, UGX, UZS, UYU, PHP, DJF, XAF, XOF, HRK, CZK, CLP, LKR, EEK, ETB, RSD, ZAR, KRW, NAD, TL, UE
OrdersStatsOrderDTO
Информация о заказе.
|
Name |
Description |
|
commissions |
Type: OrdersStatsCommissionDTO[] Информация о стоимости услуг. Example
|
|
currency |
Type: CurrencyType Валюта, в которой указаны цены в заказе. Коды валют:
Enum: |
|
items |
Type: OrdersStatsItemDTO[] Список товаров в заказе после возможных изменений. Информация о доставке заказа добавляется отдельным элементом в массиве Example
|
|
payments |
Type: OrdersStatsPaymentDTO[] Информация о расчетах по заказу. Возвращается пустым, если заказ:
Окончательная информация о расчетах по заказу вернется после его финальной обработки (например, после перехода в статус Example
|
|
buyerType |
Type: OrderBuyerType Тип покупателя: физическое лицо или организация. Этот параметр используется магазинами, размещающими товары на витрине business.market.yandex.ru. Тип покупателя:
Enum: |
|
creationDate |
Type: string<date> Дата создания заказа. Формат даты: Example: |
|
deliveryRegion |
Type: OrdersStatsDeliveryRegionDTO Информация о регионе доставки. Example
|
|
fake |
Type: boolean Тип заказа:
|
|
id |
Type: integer Идентификатор заказа. |
|
initialItems |
Type: OrdersStatsItemDTO[] | null Список товаров в заказе. Возвращается, только если было изменение количества товаров. Min items: Example
|
|
partnerOrderId |
Type: string Идентификатор заказа в информационной системе магазина. Example: |
|
paymentType |
Type: OrdersStatsOrderPaymentType Тип оплаты заказа. Тип оплаты заказа:
Enum: |
|
status |
Type: OrderStatsStatusType Текущий статус заказа:
Enum: |
|
statusUpdateDate |
Type: string<date-time> Дата и время, когда статус заказа был изменен в последний раз. Формат даты и времени: ISO 8601. Например, Example: |
|
subsidies |
Type: OrdersStatsSubsidyDTO[] | null Начисление баллов, которые используются для уменьшения стоимости размещения, и их списание в случае невыкупа или возврата. Min items: Example
|
Example
{
"id": 0,
"creationDate": "2025-01-01",
"statusUpdateDate": "2025-01-01T00:00:00Z",
"status": "CANCELLED_BEFORE_PROCESSING",
"partnerOrderId": "example",
"paymentType": "POSTPAID",
"fake": true,
"deliveryRegion": {
"id": 0,
"name": "example"
},
"items": [
{
"offerName": "example",
"marketSku": 1,
"shopSku": "example",
"count": 0,
"prices": [
{
"type": "BUYER",
"costPerItem": 0.5,
"total": 0.5
}
],
"warehouse": {
"id": 0,
"name": "example"
},
"details": [
{
"itemStatus": "REJECTED",
"itemCount": 0,
"updateDate": "2025-01-01",
"stockType": "FIT"
}
],
"cisList": [
"example"
],
"initialCount": 0,
"bidFee": 570,
"cofinanceThreshold": 0.5,
"cofinanceValue": 0.5
}
],
"initialItems": [
null
],
"payments": [
{
"id": "example",
"date": "2025-01-01",
"type": "PAYMENT",
"source": "BUYER",
"total": 0.5,
"paymentOrder": {
"id": "example",
"date": "2025-01-01"
}
}
],
"commissions": [
{
"type": "FEE",
"actual": 0.5
}
],
"subsidies": [
{
"operationType": "ACCRUAL",
"type": "YANDEX_CASHBACK",
"amount": 0.5
}
],
"buyerType": "PERSON",
"currency": "RUR"
}
ForwardScrollingPagerDTO
Идентификатор следующей страницы.
|
Name |
Description |
|
nextPageToken |
Type: string Идентификатор следующей страницы результатов. Example: |
Example
{
"nextPageToken": "example"
}
OrdersStatsDTO
Информация по заказам.
|
Name |
Description |
|
orders |
Type: OrdersStatsOrderDTO[] Список заказов. Example
|
|
paging |
Type: ForwardScrollingPagerDTO Идентификатор следующей страницы. Example
|
Example
{
"orders": [
{
"id": 0,
"creationDate": "2025-01-01",
"statusUpdateDate": "2025-01-01T00:00:00Z",
"status": "CANCELLED_BEFORE_PROCESSING",
"partnerOrderId": "example",
"paymentType": "POSTPAID",
"fake": true,
"deliveryRegion": {
"id": 0,
"name": "example"
},
"items": [
{
"offerName": "example",
"marketSku": 1,
"shopSku": "example",
"count": 0,
"prices": [
null
],
"warehouse": {},
"details": [
null
],
"cisList": [
null
],
"initialCount": 0,
"bidFee": 570,
"cofinanceThreshold": 0.5,
"cofinanceValue": 0.5
}
],
"initialItems": [
null
],
"payments": [
{
"id": "example",
"date": "2025-01-01",
"type": "PAYMENT",
"source": "BUYER",
"total": 0.5,
"paymentOrder": {}
}
],
"commissions": [
{
"type": "FEE",
"actual": 0.5
}
],
"subsidies": [
{
"operationType": "ACCRUAL",
"type": "YANDEX_CASHBACK",
"amount": 0.5
}
],
"buyerType": "PERSON",
"currency": "RUR"
}
],
"paging": {
"nextPageToken": "example"
}
}
400 Bad Request
Запрос содержит неправильные данные. Подробнее об ошибках в отчетах и документах
Body
application/json
{
"status": "OK"
}
Type: object
ApiErrorDTO
Общий формат ошибки.
|
Name |
Description |
|
code |
Type: string Код ошибки. Example: |
|
message |
Type: string Описание ошибки. Example: |
Example
{
"code": "example",
"message": "example"
}
ApiErrorResponse
Стандартная обертка для ошибок сервера.
Type: object
All of 2 types
-
Type: ApiResponse
Стандартная обертка для ответов сервера.
Example
{ "status": "OK" } -
Type: object
errors
Type: ApiErrorDTO[] | null
Список ошибок.
Min items:
1Example
[ { "code": "example", "message": "example" } ]Example
{ "errors": [ { "code": "example", "message": "example" } ] }
Example
{
"status": "OK"
}
401 Unauthorized
В запросе не указаны данные для авторизации. Подробнее об ошибке
Body
application/json
{
"status": "OK"
}
Type: object
403 Forbidden
Данные для авторизации неверны или доступ к ресурсу запрещен. Подробнее об ошибке
Body
application/json
{
"status": "OK"
}
Type: object
404 Not Found
Запрашиваемый ресурс не найден. Подробнее об ошибке
Body
application/json
{
"status": "OK"
}
Type: object
420 Method Failure
Превышено ограничение на доступ к ресурсу. Подробнее об ошибке
Body
application/json
{
"status": "OK"
}
Type: object
500 Internal Server Error
Внутренняя ошибка Маркета. Подробнее об ошибке
Body
application/json
{
"status": "OK"
}
Type: object
pathParams:
- description: "Идентификатор кампании (магазина) — технический идентификатор, который представляет ваш магазин в системе Яндекс Маркета при работе через API. Он однозначно связывается с вашим магазином, но предназначен только для автоматизированного взаимодействия.\n\nЕго можно узнать с помощью запроса [GET\_v2/campaigns](../../reference/campaigns/getCampaigns.md) или найти в кабинете продавца на Маркете. Нажмите на иконку вашего аккаунта → **Настройки** и в меню слева выберите **API и модули**:\n\n* блок **Идентификатор кампании**;\n* вкладка **Лог запросов** → выпадающий список в блоке **Показывать логи**.\n\n⚠️ Не путайте его с:\n- идентификатором магазина, который отображается в личном кабинете продавца;\n- рекламными кампаниями.\n"
name: campaignId
in: path
required: true
schema:
type: integer
format: int64
minimum: 1
searchParams:
- name: page_token
description: >
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуем передавать значение выходного параметра `nextPageToken`,
полученное при последнем запросе.
Если задан `page_token` и в запросе есть параметры `page` и `pageSize`,
они игнорируются.
in: query
required: false
example: eyBuZXh0SWQ6IDIzNDIgfQ==
schema:
type: string
- name: limit
description: |
Количество значений на одной странице.
in: query
required: false
example: 20
schema:
type: integer
format: int32
minimum: 1
headers: []
body: |-
{
"dateFrom": "2025-01-01",
"dateTo": "2025-01-01",
"updateFrom": "2025-01-01",
"updateTo": "2025-01-01",
"orders": [
0
],
"statuses": [
"CANCELLED_BEFORE_PROCESSING"
],
"hasCis": true
}
schema:
description: Запрос информации по заказам.
type: object
properties:
dateFrom:
description: |
Начальная дата, когда заказ был сформирован.
Формат даты: `ГГГГ‑ММ‑ДД`.
Нельзя использовать вместе с параметрами `updateFrom` и `updateTo`.
type: string
format: date
dateTo:
description: |
Конечная дата, когда заказ был сформирован.
Формат даты: `ГГГГ‑ММ‑ДД`.
Нельзя использовать вместе с параметрами `updateFrom` и `updateTo`.
type: string
format: date
updateFrom:
description: >
Начальная дата периода, за который были изменения в заказе (например,
статуса или информации о платежах).
Формат даты: `ГГГГ‑ММ‑ДД`.
Нельзя использовать вместе с параметрами `dateFrom` и `dateTo`.
type: string
format: date
updateTo:
description: >
Конечная дата периода, за который были изменения в заказе (например,
статуса или информации о платежах).
Формат даты: `ГГГГ‑ММ‑ДД`.
Нельзя использовать вместе с параметрами `dateFrom` и `dateTo`.
type: string
format: date
orders:
description: Список идентификаторов заказов.
type: array
nullable: true
minItems: 1
uniqueItems: true
items:
description: >
Список товаров в заказе после возможных изменений.
В ходе обработки заказа Маркет может удалить из него единицы товаров —
при проблемах на складе или по инициативе пользователя.
* Если из заказа удалены все единицы товара, его не будет в списке
`items` — только в списке `initialItems`.
* Если в заказе осталась хотя бы одна единица товара, он будет и в
списке `items` (с уменьшенным количеством единиц `count`), и в списке
`initialItems` (с первоначальным количеством единиц `initialCount`).
type: integer
format: int64
statuses:
description: Список статусов заказов.
type: array
nullable: true
minItems: 1
uniqueItems: true
items:
description: >
Текущий статус заказа:
* `CANCELLED_BEFORE_PROCESSING` — заказ отменен до начала его
обработки.
* `CANCELLED_IN_DELIVERY` — заказ отменен во время его доставки.
* `CANCELLED_IN_PROCESSING` — заказ отменен во время его обработки.
* `DELIVERY` — заказ передан службе доставки.
* `DELIVERED` — заказ доставлен.
* `PARTIALLY_DELIVERED` — заказ частично доставлен.
{% note warning "Статус заказа может перейти в `PARTIALLY_DELIVERED` не сразу" %}
Если в доставленном заказе был невыкуп, статус изменится только после получения заказа на складе Маркета.
{% endnote %}
* `PARTIALLY_RETURNED` — заказ частично возвращен покупателем.
* `PENDING` — заказ ожидает подтверждения.
* `PICKUP` — заказ доставлен в пункт выдачи.
* `PROCESSING` — заказ в обработке.
* `RESERVED` — товар зарезервирован на складе.
* `RETURNED` — заказ полностью возвращен покупателем.
* `UNKNOWN` — неизвестный статус заказа.
* `UNPAID` — заказ от юридического лица ожидает оплаты.
* `LOST` — заказ утерян.
type: string
enum:
- CANCELLED_BEFORE_PROCESSING
- CANCELLED_IN_DELIVERY
- CANCELLED_IN_PROCESSING
- DELIVERY
- DELIVERED
- PARTIALLY_DELIVERED
- PARTIALLY_RETURNED
- PENDING
- PICKUP
- PROCESSING
- RESERVED
- RETURNED
- UNKNOWN
- UNPAID
- LOST
hasCis:
description: >
Фильтр для получения заказов, в которых есть хотя бы один товар с кодом
идентификации в системе [«Честный
ЗНАК»](https://честныйзнак.рф/) или [«ASL
BELGISI»](https://aslbelgisi.uz) (для продавцов Market
Yandex Go):
* `true` — да.
* `false` — нет.
Такие коды присваиваются товарам, которые подлежат маркировке и
относятся к определенным категориям.
type: boolean
bodyType: application/json
method: post
security:
- type: apiKey
name: Api-Key
in: header
- type: oauth2
x-inline: true
flows:
implicit:
authorizationUrl: https://oauth.yandex.ru/authorize
scopes:
market:partner-api: API Яндекс.Маркета / Поиска по товарам для партнеров
path: v2/campaigns/{campaignId}/stats/orders
host: https://api.partner.market.yandex.ru
No longer supported, please use an alternative and newer version.