Детальная информация по заказам

Метод доступен для всех моделей.

Если вы используете API-Key-токен, для вызова метода необходим один из доступов в списке

Возвращает информацию по заказам на Маркете, в которых есть ваши товары.

С помощью нее вы можете собрать статистику по вашим заказам и узнать, например, какие из товаров чаще всего возвращаются покупателями, какие, наоборот, пользуются большим спросом и т. п.

Информация по созданным или обновленным заказам может появиться с задержкой до 40 минут

Чтобы получить данные без задержки, используйте метод получения информации о заказах.

В одном запросе можно получить информацию не более чем по 200 заказам.

⚙️ Лимит: 1 000 000 заказов в час

Request

POST

https://api.partner.market.yandex.ru/campaigns/{campaignId}/stats/orders

Path parameters

Name

Description

campaignId*

Type: integer<int64>

Идентификатор магазина в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

Min value: 1

Query parameters

Name

Description

limit

Type: integer<int32>

Количество значений на одной странице.
Example: 20

page_token

Type: string

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры page_number и page_size, они игнорируются.
Example: eyBuZXh0SWQ6IDIzNDIgfQ==

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>

Начальная дата, когда заказ был сформирован.

Формат даты: ГГГГ‑ММ‑ДД.

Нельзя использовать вместе с параметрами updateFrom и updateTo.

dateTo

Type: string<date>

Конечная дата, когда заказ был сформирован.

Формат даты: ГГГГ‑ММ‑ДД.

Нельзя использовать вместе с параметрами updateFrom и updateTo.

hasCis

Type: boolean

Нужно ли вернуть только те заказы, в составе которых есть хотя бы один товар с кодом идентификации в системе «Честный ЗНАК» или «ASL BELGISI» (для продавцов Market Yandex Go):

  • true — да.
  • false — нет. Такие коды присваиваются товарам, которые подлежат маркировке и относятся к определенным категориям.

orders

Type: integer<int64>[]

Список идентификаторов заказов.
Список товаров в заказе после возможных изменений.

В ходе обработки заказа Маркет может удалить из него единицы товаров — при проблемах на складе или по инициативе пользователя.

  • Если из заказа удалены все единицы товара, его не будет в списке items — только в списке initialItems.

  • Если в заказе осталась хотя бы одна единица товара, он будет и в списке items (с уменьшенным количеством единиц count), и в списке initialItems (с первоначальным количеством единиц initialCount).

Min items: 1

statuses

Type: 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 — заказ утерян.

Enum: CANCELLED_BEFORE_PROCESSING, CANCELLED_IN_DELIVERY, CANCELLED_IN_PROCESSING, DELIVERY, DELIVERED, PARTIALLY_DELIVERED, PARTIALLY_RETURNED, PENDING, PICKUP, PROCESSING, RESERVED, RETURNED, UNKNOWN, UNPAID, LOST

Min items: 1

updateFrom

Type: string<date>

Начальная дата периода, за который были изменения в заказе (например, статуса или информации о платежах).

Формат даты: ГГГГ‑ММ‑ДД.

Нельзя использовать вместе с параметрами dateFrom и dateTo.

updateTo

Type: string<date>

Конечная дата периода, за который были изменения в заказе (например, статуса или информации о платежах).

Формат даты: ГГГГ‑ММ‑ДД.

Нельзя использовать вместе с параметрами dateFrom и dateTo.

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

OrderStatsStatusType

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",
    "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

result

Type: OrdersStatsDTO

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

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

OrdersStatsDTO

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

Name

Description

orders*

Type: OrdersStatsOrderDTO[]

Список заказов.
Информация о заказе.

paging

Type: ForwardScrollingPagerDTO

Ссылка на следующую страницу.

ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Type

Description

ApiResponseStatusType

Enum: OK, ERROR

OrdersStatsOrderDTO

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

Name

Description

commissions*

Type: OrdersStatsCommissionDTO[]

Информация о стоимости услуг.
Информация о стоимости услуг.

currency*

Type: CurrencyType

Валюта, в которой указаны цены в заказе.

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

items*

Type: OrdersStatsItemDTO[]

Список товаров в заказе после возможных изменений.

Информация о доставке заказа добавляется отдельным элементом в массиве items— параметр offerName со значением Доставка.
Список товаров в заказе после возможных изменений.

В ходе обработки заказа Маркет может удалить из него единицы товаров — при проблемах на складе или по инициативе пользователя.

  • Если из заказа удалены все единицы товара, его не будет в списке items — только в списке initialItems.

  • Если в заказе осталась хотя бы одна единица товара, он будет и в списке items (с уменьшенным количеством единиц count), и в списке initialItems (с первоначальным количеством единиц initialCount).

payments*

Type: OrdersStatsPaymentDTO[]

Информация о денежных переводах по заказу.

Может вернуться пустым, если нет данных о переводах.
Информация о денежных переводах по заказу.

creationDate

Type: string<date>

Дата создания заказа.

Формат даты: ГГГГ-ММ-ДД.

deliveryRegion

Type: OrdersStatsDeliveryRegionDTO

Информация о регионе доставки.

fake

Type: boolean

Тип заказа:

  • false — настоящий заказ покупателя.

  • true — тестовый заказ Маркета.

id

Type: integer<int64>

Идентификатор заказа.

initialItems

Type: OrdersStatsItemDTO[]

Список товаров в заказе до изменений.
Список товаров в заказе после возможных изменений.

В ходе обработки заказа Маркет может удалить из него единицы товаров — при проблемах на складе или по инициативе пользователя.

  • Если из заказа удалены все единицы товара, его не будет в списке items — только в списке initialItems.

  • Если в заказе осталась хотя бы одна единица товара, он будет и в списке items (с уменьшенным количеством единиц count), и в списке initialItems (с первоначальным количеством единиц initialCount).

Min items: 1

partnerOrderId

Type: string

Идентификатор заказа в информационной системе магазина.

paymentType

Type: OrdersStatsOrderPaymentType

Тип оплаты заказа.

Enum: POSTPAID, PREPAID, UNKNOWN

status

Type: 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 — заказ утерян.

Enum: CANCELLED_BEFORE_PROCESSING, CANCELLED_IN_DELIVERY, CANCELLED_IN_PROCESSING, DELIVERY, DELIVERED, PARTIALLY_DELIVERED, PARTIALLY_RETURNED, PENDING, PICKUP, PROCESSING, RESERVED, RETURNED, UNKNOWN, UNPAID, LOST

statusUpdateDate

Type: string<date-time>

Дата и время, когда статус заказа был изменен в последний раз.

Формат даты и времени: ISO 8601. Например, 2017-11-21T00:00:00. Часовой пояс — UTC+03:00 (Москва).

subsidies

Type: OrdersStatsSubsidyDTO[]

Начисление баллов, которые используются для уменьшения стоимости размещения, и их списание в случае невыкупа или возврата.
Информация о начислении баллов, которые используются для уменьшения стоимости размещения, и их списании в случае невыкупа или возврата.

Min items: 1

ForwardScrollingPagerDTO

Ссылка на следующую страницу.

Name

Description

nextPageToken

Type: string

Идентификатор следующей страницы результатов.

OrdersStatsCommissionDTO

Информация о стоимости услуг.

Name

Description

actual

Type: number

Сумма, которая была выставлена в момент создания заказа и которую нужно оплатить. Точность — два знака после запятой.

type

Type: OrdersStatsCommissionType

Услуга.

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

CurrencyType

Коды валют. Возможные значения:

  • RUR — российский рубль.
  • UAH — украинская гривна.
  • BYR — белорусский рубль.
  • KZT — казахстанский тенге.
  • UZS — узбекский сум.

Type

Description

CurrencyType

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

OrdersStatsItemDTO

Список товаров в заказе после возможных изменений.

В ходе обработки заказа Маркет может удалить из него единицы товаров — при проблемах на складе или по инициативе пользователя.

  • Если из заказа удалены все единицы товара, его не будет в списке items — только в списке initialItems.

  • Если в заказе осталась хотя бы одна единица товара, он будет и в списке items (с уменьшенным количеством единиц count), и в списке initialItems (с первоначальным количеством единиц initialCount).

Name

Description

bidFee

Type: integer<int32>

Списанная ставка ближайшего конкурента.

Указывается в процентах от стоимости товара и умножается на 100. Например, ставка 5% обозначается как 500.

Example: 570

Min value: 0

Max value: 10000

cisList

Type: string[]

Список кодов идентификации товара в системе «Честный ЗНАК» или «ASL BELGISI» (для продавцов Market Yandex Go).

Min items: 1

cofinanceThreshold

Type: number

Порог для скидок с Маркетом на момент оформления заказа. Что это такое?

Точность — два знака после запятой.

cofinanceValue

Type: number

Скидка с Маркетом. Что это такое?

Точность — два знака после запятой.

count

Type: integer<int32>

Количество единиц товара с учетом удаленных единиц.

Если из заказа удалены все единицы товара, он попадет только в список initialItems.

details

Type: OrdersStatsDetailsDTO[]

Информация об удалении товара из заказа.
Информация об удалении товара из заказа.

Min items: 1

initialCount

Type: integer<int32>

Первоначальное количество единиц товара.

marketSku

Type: integer<int64>

SKU на Маркете.

Min value: 1

offerName

Type: string

Название товара.

prices

Type: OrdersStatsPriceDTO[]

Цена или скидки на товар.
Цена или скидки на товар.

Min items: 1

shopSku

Type: string

Ваш SKU — идентификатор товара в вашей системе.

Правила использования SKU:

  • У каждого товара SKU должен быть свой.

  • Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.

SKU товара можно изменить в кабинете продавца на Маркете. О том, как это сделать, читайте в Справке Маркета для продавцов.

Что такое SKU и как его назначать

Min length: 1

Max length: 255

Pattern: ^(?=.*\S.*)[^\x00-\x08\x0A-\x1f\x7f]{1,255}$

warehouse

Type: OrdersStatsWarehouseDTO

Информация о складе, на котором хранится товар.

OrdersStatsPaymentDTO

Информация о денежных переводах по заказу.

Name

Description

date

Type: string<date>

Дата денежного перевода.

Формат даты: ГГГГ-ММ-ДД.

id

Type: string

Идентификатор денежного перевода.

paymentOrder

Type: OrdersStatsPaymentOrderDTO

Информация о платежном поручении.

source

Type: OrdersStatsPaymentSourceType

Способ денежного перевода.

Enum: BUYER, CASHBACK, MARKETPLACE, SPLIT

total

Type: number

Сумма денежного перевода.

Точность — два знака после запятой.

type

Type: OrdersStatsPaymentType

Тип денежного перевода.

Enum: PAYMENT, REFUND

OrdersStatsDeliveryRegionDTO

Информация о регионе доставки.

Name

Description

id

Type: integer<int64>

Идентификатор региона доставки.

name

Type: string

Название региона доставки.

OrdersStatsOrderPaymentType

Тип оплаты заказа:

  • POSTPAID — заказ оплачен после того, как был получен.
  • PREPAID — заказ оплачен до того, как был получен.
  • UNKNOWN — неизвестный тип оплаты. Скорее всего покупатель отменил или вернул заказ или не было его оплаты.

Type

Description

OrdersStatsOrderPaymentType

Enum: POSTPAID, PREPAID, UNKNOWN

OrdersStatsSubsidyDTO

Информация о начислении баллов, которые используются для уменьшения стоимости размещения, и их списании в случае невыкупа или возврата.

Name

Description

amount*

Type: number

Количество баллов, которые используются для уменьшения стоимости размещения, с точностью до двух знаков после запятой.

operationType*

Type: OrdersStatsSubsidyOperationType

Тип операции c баллами, которые используются для уменьшения стоимости размещения.

Enum: ACCRUAL, DEDUCTION

type*

Type: OrdersStatsSubsidyType

Источник баллов, которые используются для уменьшения стоимости размещения.

Enum: YANDEX_CASHBACK, SUBSIDY, DELIVERY

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

OrdersStatsCommissionType

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

OrdersStatsDetailsDTO

Информация об удалении товара из заказа.

Name

Description

itemCount

Type: integer<int64>

Количество товара со статусом, указанном в параметре itemStatus.

itemStatus

Type: OrdersStatsItemStatusType

Статус товара.

Enum: REJECTED, RETURNED

stockType

Type: OrdersStatsStockType

Тип товара.

Enum: FIT, DEFECT, EXPIRED

updateDate

Type: string<date>

Дата, когда товар получил статус, указанный в параметре itemStatus.

Формат даты: ГГГГ-ММ-ДД.

OrdersStatsPriceDTO

Цена или скидки на товар.

Name

Description

costPerItem

Type: number

Цена или скидка на единицу товара в заказе.

Точность — два знака после запятой.

total

Type: number

Суммарная цена или скидка на все единицы товара в заказе.

Точность — два знака после запятой.

type

Type: OrdersStatsPriceType

Тип скидки или цена на товар.

Enum: BUYER, CASHBACK, MARKETPLACE

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

OrdersStatsPaymentSourceType

Enum: BUYER, CASHBACK, MARKETPLACE, SPLIT

OrdersStatsPaymentType

Тип денежного перевода:

  • PAYMENT — оплата.
  • REFUND — возврат.

Type

Description

OrdersStatsPaymentType

Enum: PAYMENT, REFUND

OrdersStatsSubsidyOperationType

Тип операции с баллами, которые используются для уменьшения стоимости размещения:

  • ACCRUAL — начисление баллов.
  • DEDUCTION — списание баллов.

Type

Description

OrdersStatsSubsidyOperationType

Enum: ACCRUAL, DEDUCTION

OrdersStatsSubsidyType

Источник баллов, которые используются для уменьшения стоимости размещения:

  • YANDEX_CASHBACK — скидка по подписке Яндекс Плюс.

  • SUBSIDY — скидка Маркета (по акциям, промокодам, купонам и т. д.)

  • DELIVERY — скидка за доставку (DBS).

Type

Description

OrdersStatsSubsidyType

Enum: YANDEX_CASHBACK, SUBSIDY, DELIVERY

OrdersStatsItemStatusType

Статус товара:

  • REJECTED — товар был добавлен в созданный заказ, но не был оплачен.
  • RETURNED — товар вернули.

Type

Description

OrdersStatsItemStatusType

Enum: REJECTED, RETURNED

OrdersStatsStockType

Тип товара:

  • FIT — товар надлежащего качества.

  • DEFECT — товар бракованный.

  • EXPIRED — товар с истекшим сроком годности.

Type

Description

OrdersStatsStockType

Enum: FIT, DEFECT, EXPIRED

OrdersStatsPriceType

Тип скидки или цена на товар:

  • BUYER — цена на товар с учетом скидок, в том числе купонов.
  • CASHBACK — баллы Плюса.
  • MARKETPLACE — купоны.

Type

Description

OrdersStatsPriceType

Enum: BUYER, CASHBACK, MARKETPLACE

400 Bad Request

Запрос содержит неправильные данные.

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

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: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

403 Forbidden

Данные для авторизации неверны или доступ к ресурсу запрещен.

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

404 Not Found

Запрашиваемый ресурс не найден.

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

420 Method Failure

Превышено ограничение на доступ к ресурсу.

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

500 Internal Server Error

Внутренняя ошибка сервера.

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR
Предыдущая
Подтверждение решения
Следующая
Отчет «Аналитика продаж»