Структура и содержание отчетов могут изменяться без предварительного уведомления

Например, может добавиться новая колонка или поменяться название листа.

Отчет по реализации

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

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

Запускает генерацию отчета по реализации за заданный период. Что это за отчет

Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.

Пояснение к колонкам отчета:

Лист Товары, переданные в доставку (файл transferred_to_delivery)

Название колонки в CSV

Название колонки в JSON

Название колонки в XLSX

Тип значения

ORDER_ID

orderId

Заказы/Номер заказа

integer

YOUR_ORDER_ID

yourOrderId

Заказы/Ваш номер заказа

string

ORDER_TYPE

orderType

Заказы/Тип заказа

string

OFFER_NAME

offerName

Заказы/Название товара

string

YOUR_SKU

yourSku

Заказы/Ваш SKU

string

SHOP_SKU

shopSku

Заказы/$

string

TRANSFERRED_TO_DELIVERY_COUNT

transferredToDeliveryCount

Заказы/Количество переданных в доставку, шт.

integer

ORDER_CREATION_DATE

orderCreationDate

Заказы/Дата оформления заказа

string

TRANSFERRED_TO_DELIVERY_DATE

transferredToDeliveryDate

Заказы/Дата передачи товара в доставку

string

DELIVERY_DATE

deliveryDate

Заказы/Дата доставки товара

string

PAYMENT_TYPE

paymentType

Заказы/Способ оплаты

string

VAT

vat

Заказы/Ставка НДС

string

PRICE_WITH_VAT_AND_NO_DISCOUNT

priceWithVatAndNoDiscount

Заказы/Цена c НДС без учёта скидок за шт.

number

SHOP_MARKETPLACE_DISCOUNT

shopMarketplaceDiscount

Заказы/Ваша скидка по акции маркетплейса на 1 шт.

number

SPASIBO_DISCOUNT

spasiboDiscount

Заказы/Ваша скидка по бонусам СберСпасибо (за шт.) на 1 шт.

number

YANDEX_PLUS_DISCOUNT

yandexPlusDiscount

Заказы/Ваша скидка по баллам Яндекс.Плюса на 1 шт.

number

PRICE_WITH_VAT_AND_ALL_DISCOUNTS

priceWithVatAndAllDiscounts

Заказы/Цена с НДС с учётом всех скидок за шт.

number

TRANSFERRED_TO_DELIVERY_PRICE_SUM_WITH_VAT_AND_NO_DISCOUNTS

transferredToDeliveryPriceSumWithVatAndNoDiscounts

Заказы/Стоимость всех переданных в доставку штук с НДС без учёта скидок

number

TRANSFERRED_TO_DELIVERY_DISCOUNT_SUM

transferredToDeliveryDiscountSum

Заказы/Сумма всех скидок для переданных в доставку штук

number

TRANSFERRED_TO_DELIVERY_PRICE_SUM_WITH_VAT_AND_DISCOUNTS

transferredToDeliveryPriceSumWithVatAndDiscounts

Заказы/Стоимость всех переданных в доставку штук с НДС с учётом всех скидок

number

RNPT

rnpt

Заказы/Регистрационный номер таможенной декларации или Регистрационный номер партии товара, подлежащего прослеживаемости (РНПТ)

string

ORGANIZATION

organization

Продажи бизнесу/Информация о покупателе/Наименование организации

string

INN

inn

Продажи бизнесу/Информация о покупателе/ИНН

string

KPP

kpp

Продажи бизнесу/Информация о покупателе/КПП

string

ORGANIZATION_JUR_ADDRESS

organizationJurAddress

Продажи бизнесу/Информация о покупателе/Юридический адрес

string

UPD_STATUS

updStatus

Продажи бизнесу/Электронный документооборот/Статус УПД

string

UPD_DATE

updDate

Продажи бизнесу/Электронный документооборот/Дата УПД

string

UPD_NUMBER

updNumber

Продажи бизнесу/Электронный документооборот/Номер УПД

string

UPD_STATUS

updStatus

Продажи бизнесу/Документы/Статус УПД

string

UPD_DATE

updDate

Продажи бизнесу/Документы/Дата УПД

string

UPD_NUMBER

updNumber

Продажи бизнесу/Документы/Номер УПД

string

UKD_STATUS

ukdStatus

Продажи бизнесу/Документы/Статус УКД

string

UKD_DATE

ukdDate

Продажи бизнесу/Документы/Дата УКД

string

UKD_NUMBER

ukdNumber

Продажи бизнесу/Документы/Номер УКД

string

CONSIGNMENT_NOTE_DATE

consignmentNoteDate

Продажи бизнесу/Бумажный документооборот/Дата товарной накладной

string

CONSIGNMENT_NOTE_NUMBER

consignmentNoteNumber

Продажи бизнесу/Бумажный документооборот/Номер товарной накладной

string

INVOICE_DATE

invoiceDate

Продажи бизнесу/Бумажный документооборот/Дата счёта-фактуры

string

INVOICE_NUMBER

invoiceNumber

Продажи бизнесу/Бумажный документооборот/Номер счёта фактуры

string

Лист Доставленные товары (файл delivered)

Название колонки в CSV

Название колонки в JSON

Название колонки в XLSX

Тип значения

ORDER_ID

orderId

Заказы/Номер заказа

integer

YOUR_ORDER_ID

yourOrderId

Заказы/Ваш номер заказа

string

ORDER_TYPE

orderType

Заказы/Тип заказа

string

OFFER_NAME

offerName

Заказы/Название товара

string

YOUR_SKU

yourSku

Заказы/Ваш SKU

string

SHOP_SKU

shopSku

Заказы/$

string

TRANSFERRED_TO_DELIVERY_COUNT

transferredToDeliveryCount

Заказы/Количество переданных в доставку, шт.

integer

DELIVERED_COUNT

deliveredCount

Заказы/Доставлено, шт.

integer

ORDER_CREATION_DATE

orderCreationDate

Заказы/Дата оформления заказа

string

TRANSFERRED_TO_DELIVERY_DATE

transferredToDeliveryDate

Заказы/Дата передачи товара в доставку

string

DELIVERY_DATE

deliveryDate

Заказы/Дата доставки товара

string

PAYMENT_TYPE

paymentType

Заказы/Способ оплаты

string

VAT

vat

Заказы/Ставка НДС

string

PRICE_WITH_VAT_AND_NO_DISCOUNT

priceWithVatAndNoDiscount

Заказы/Цена c НДС без учёта скидок за шт.

number

SHOP_MARKETPLACE_DISCOUNT

shopMarketplaceDiscount

Заказы/Ваша скидка по акции маркетплейса на 1 шт.

number

SPASIBO_DISCOUNT

spasiboDiscount

Заказы/Ваша скидка по бонусам СберСпасибо (за шт.) на 1 шт.

number

YANDEX_PLUS_DISCOUNT

yandexPlusDiscount

Заказы/Ваша скидка по баллам Яндекс.Плюса на 1 шт.

number

PRICE_WITH_VAT_AND_ALL_DISCOUNTS

priceWithVatAndAllDiscounts

Заказы/Цена с НДС с учётом всех скидок за шт.

number

DELIVERED_PRICE_SUM_WITH_VAT_AND_NO_DISCOUNTS

deliveredPriceSumWithVatAndNoDiscounts

Заказы/Стоимость всех доставленных штук с НДС без учёта скидок

number

DELIVERED_DISCOUNT_SUM

deliveredDiscountSum

Заказы/Сумма всех скидок для доставленных штук

number

DELIVERED_PRICE_SUM_WITH_VAT_AND_DISCOUNTS

deliveredPriceSumWithVatAndDiscounts

Заказы/Стоимость всех доставленных штук с НДС с учётом всех скидок

number

RNPT

rnpt

Заказы/Регистрационный номер таможенной декларации или Регистрационный номер партии товара, подлежащего прослеживаемости (РНПТ)

string

ORGANIZATION

organization

Продажи бизнесу/Информация о покупателе/Наименование организации

string

INN

inn

Продажи бизнесу/Информация о покупателе/ИНН

string

KPP

kpp

Продажи бизнесу/Информация о покупателе/КПП

string

ORGANIZATION_JUR_ADDRESS

organizationJurAddress

Продажи бизнесу/Информация о покупателе/Юридический адрес

string

UPD_STATUS

updStatus

Продажи бизнесу/Электронный документооборот/Статус УПД

string

UPD_DATE

updDate

Продажи бизнесу/Электронный документооборот/Дата УПД

string

UPD_NUMBER

updNumber

Продажи бизнесу/Электронный документооборот/Номер УПД

string

UPD_STATUS

updStatus

Продажи бизнесу/Документы/Статус УПД

string

UPD_DATE

updDate

Продажи бизнесу/Документы/Дата УПД

string

UPD_NUMBER

updNumber

Продажи бизнесу/Документы/Номер УПД

string

CONSIGNMENT_NOTE_DATE

consignmentNoteDate

Продажи бизнесу/Бумажный документооборот/Дата товарной накладной

string

CONSIGNMENT_NOTE_NUMBER

consignmentNoteNumber

Продажи бизнесу/Бумажный документооборот/Номер товарной накладной

string

INVOICE_DATE

invoiceDate

Продажи бизнесу/Бумажный документооборот/Дата счёта-фактуры

string

INVOICE_NUMBER

invoiceNumber

Продажи бизнесу/Бумажный документооборот/Номер счёта фактуры

string

Лист Невыкупленные товары (файл unredeemed)

Название колонки в CSV

Название колонки в JSON

Название колонки в XLSX

Тип значения

ORDER_ID

orderId

Заказы/Номер заказа

integer

YOUR_ORDER_ID

yourOrderId

Заказы/Ваш номер заказа

string

ORDER_TYPE

orderType

Заказы/Тип заказа

string

OFFER_NAME

offerName

Заказы/Название товара

string

YOUR_SKU

yourSku

Заказы/Ваш SKU

string

SHOP_SKU

shopSku

Заказы/$

string

TRANSFERRED_TO_DELIVERY_COUNT

transferredToDeliveryCount

Заказы/Количество переданных в доставку, шт.

integer

UNREDEEMED_COUNT

unredeemedCount

Заказы/Не выкуплено, шт.

integer

ORDER_CREATION_DATE

orderCreationDate

Заказы/Дата оформления заказа

string

TRANSFERRED_TO_DELIVERY_DATE

transferredToDeliveryDate

Заказы/Дата передачи товара в доставку

string

DELIVERY_DATE

deliveryDate

Заказы/Дата доставки товара

string

UNREDEEMED_WAREHOUSE_OR_SC_ACCEPT_DATE

unredeemedWarehouseOrScAcceptDate

Заказы/Дата приёма невыкупа складом или сортировочным центром

string

PAYMENT_TYPE

paymentType

Заказы/Способ оплаты

string

VAT

vat

Заказы/Ставка НДС

string

PRICE_WITH_VAT_AND_NO_DISCOUNT

priceWithVatAndNoDiscount

Заказы/Цена c НДС без учёта скидок за шт.

number

SHOP_MARKETPLACE_DISCOUNT

shopMarketplaceDiscount

Заказы/Ваша скидка по акции маркетплейса на 1 шт.

number

SPASIBO_DISCOUNT

spasiboDiscount

Заказы/Ваша скидка по бонусам СберСпасибо (за шт.) на 1 шт.

number

YANDEX_PLUS_DISCOUNT

yandexPlusDiscount

Заказы/Ваша скидка по баллам Яндекс.Плюса на 1 шт.

number

PRICE_WITH_VAT_AND_ALL_DISCOUNTS

priceWithVatAndAllDiscounts

Заказы/Цена с НДС с учётом всех скидок за шт.

number

UNREDEEMED_PRICE_SUM_WITH_VAT_AND_NO_DISCOUNTS

unredeemedPriceSumWithVatAndNoDiscounts

Заказы/Стоимость всех невыкупленных штук с НДС без учёта скидок

number

UNREDEEMED_DISCOUNT_SUM

unredeemedDiscountSum

Заказы/Сумма всех скидок для невыкупленных штук

number

UNREDEEMED_PRICE_SUM_WITH_VAT_AND_DISCOUNTS

unredeemedPriceSumWithVatAndDiscounts

Заказы/Стоимость всех невыкупленных штук с НДС с учётом всех скидок

number

RNPT

rnpt

Заказы/Регистрационный номер таможенной декларации или Регистрационный номер партии товара, подлежащего прослеживаемости (РНПТ)

string

ORGANIZATION

organization

Продажи бизнесу/Информация о покупателе/Наименование организации

string

INN

inn

Продажи бизнесу/Информация о покупателе/ИНН

string

KPP

kpp

Продажи бизнесу/Информация о покупателе/КПП

string

ORGANIZATION_JUR_ADDRESS

organizationJurAddress

Продажи бизнесу/Информация о покупателе/Юридический адрес

string

UKD_STATUS

ukdStatus

Продажи бизнесу/Электронный документооборот/Статус УКД

string

UKD_DATE

ukdDate

Продажи бизнесу/Электронный документооборот/Дата УКД

string

UKD_NUMBER

ukdNumber

Продажи бизнесу/Электронный документооборот/Номер УКД

string

CONSIGNMENT_NOTE_DATE

consignmentNoteDate

Продажи бизнесу/Бумажный документооборот/Дата товарной накладной

string

CONSIGNMENT_NOTE_NUMBER

consignmentNoteNumber

Продажи бизнесу/Бумажный документооборот/Номер товарной накладной

string

INVOICE_DATE

invoiceDate

Продажи бизнесу/Бумажный документооборот/Дата счёта-фактуры

string

INVOICE_NUMBER

invoiceNumber

Продажи бизнесу/Бумажный документооборот/Номер счёта фактуры

string

ADJUSTMENT_INVOICE_DATE

adjustmentInvoiceDate

Продажи бизнесу/Бумажный документооборот/Дата корректировочного счёта-фактуры

string

ADJUSTMENT_INVOICE_NUMBER

adjustmentInvoiceNumber

Продажи бизнесу/Бумажный документооборот/Номер корректировочного счёта фактуры

string

REDEEMED_PRICE

redeemedPrice

Продажи бизнесу/Стоимость выкупленного товара

string

UPD_STATUS

updStatus

Продажи бизнесу/Электронный документооборот/Статус УПД

string

UPD_DATE

updDate

Продажи бизнесу/Электронный документооборот/Дата УПД

string

UPD_NUMBER

updNumber

Продажи бизнесу/Электронный документооборот/Номер УПД

string

UPD_STATUS

updStatus

Продажи бизнесу/Документы/Статус УПД

string

UPD_DATE

updDate

Продажи бизнесу/Документы/Дата УПД

string

UPD_NUMBER

updNumber

Продажи бизнесу/Документы/Номер УПД

string

UKD_STATUS

ukdStatus

Продажи бизнесу/Документы/Статус УКД

string

UKD_DATE

ukdDate

Продажи бизнесу/Документы/Дата УКД

string

UKD_NUMBER

ukdNumber

Продажи бизнесу/Документы/Номер УКД

string

REDEEMED_PRICE

redeemedPrice

Продажи бизнесу/Документы/Стоимость выкупленного товара

string

Лист Возвращенные товары (файл returned)

Название колонки в CSV

Название колонки в JSON

Название колонки в XLSX

Тип значения

ORDER_ID

orderId

Заказы/Номер заказа

integer

YOUR_ORDER_ID

yourOrderId

Заказы/Ваш номер заказа

string

ORDER_TYPE

orderType

Заказы/Тип заказа

string

OFFER_NAME

offerName

Заказы/Название товара

string

YOUR_SKU

yourSku

Заказы/Ваш SKU

string

SHOP_SKU

shopSku

Заказы/$

string

DELIVERED_COUNT

deliveredCount

Заказы/Количество доставленных, шт.

integer

RETURNED_COUNT

returnedCount

Заказы/Возвращено, шт.

integer

ORDER_CREATION_DATE

orderCreationDate

Заказы/Дата оформления заказа

string

TRANSFERRED_TO_DELIVERY_DATE

transferredToDeliveryDate

Заказы/Дата передачи товара в доставку

string

DELIVERY_DATE

deliveryDate

Заказы/Дата доставки товара

string

RETURN_WAREHOUSE_OR_SC_ACCEPT_DATE

returnWarehouseOrScAcceptDate

Заказы/Дата приёма возврата складом или сортировочным центром

string

PAYMENT_TYPE

paymentType

Заказы/Способ оплаты

string

VAT

vat

Заказы/Ставка НДС

string

PRICE_WITH_VAT_AND_NO_DISCOUNT

priceWithVatAndNoDiscount

Заказы/Цена c НДС без учёта скидок за шт.

number

SHOP_MARKETPLACE_DISCOUNT

shopMarketplaceDiscount

Заказы/Ваша скидка по акции маркетплейса на 1 шт.

number

SPASIBO_DISCOUNT

spasiboDiscount

Заказы/Ваша скидка по бонусам СберСпасибо (за шт.) на 1 шт.

number

YANDEX_PLUS_DISCOUNT

yandexPlusDiscount

Заказы/Ваша скидка по баллам Яндекс.Плюса на 1 шт.

number

PRICE_WITH_VAT_AND_ALL_DISCOUNTS

priceWithVatAndAllDiscounts

Заказы/Цена с НДС с учётом всех скидок за шт.

number

RETURN_PRICE_SUM_WITH_VAT_AND_NO_DISCOUNTS

returnPriceSumWithVatAndNoDiscounts

Заказы/Стоимость всех возвращённых штук с НДС без учёта скидок

number

RETURN_DISCOUNT_SUM

returnDiscountSum

Заказы/Сумма всех скидок для возвращённых штук

number

RETURN_PRICE_SUM_WITH_VAT_AND_DISCOUNTS

returnPriceSumWithVatAndDiscounts

Заказы/Стоимость всех возвращённых штук с НДС с учётом всех скидок

number

ORGANIZATION

organization

Продажи бизнесу/Информация о покупателе/Наименование организации

string

INN

inn

Продажи бизнесу/Информация о покупателе/ИНН

string

KPP

kpp

Продажи бизнесу/Информация о покупателе/КПП

string

ORGANIZATION_JUR_ADDRESS

organizationJurAddress

Продажи бизнесу/Информация о покупателе/Юридический адрес

string

UPD_STATUS

updStatus

Продажи бизнесу/Документы/Статус УПД

string

UPD_DATE

updDate

Продажи бизнесу/Документы/Дата УПД

string

UPD_NUMBER

updNumber

Продажи бизнесу/Документы/Номер УПД

string

UKD_STATUS

ukdStatus

Продажи бизнесу/Документы/Статус УКД

string

UKD_DATE

ukdDate

Продажи бизнесу/Документы/Дата УКД

string

UKD_NUMBER

ukdNumber

Продажи бизнесу/Документы/Номер УКД

string

REDEEMED_PRICE

redeemedPrice

Продажи бизнесу/Документы/Стоимость выкупленного товара

number

UPD_STATUS

updStatus

Продажи бизнесу/Электронный документооборот/Статус УПД

string

UPD_DATE

updDate

Продажи бизнесу/Электронный документооборот/Дата УПД

string

UPD_NUMBER

updNumber

Продажи бизнесу/Электронный документооборот/Номер УПД

string

UKD_STATUS

ukdStatus

Продажи бизнесу/Электронный документооборот/Статус УКД

string

UKD_DATE

ukdDate

Продажи бизнесу/Электронный документооборот/Дата УКД

string

UKD_NUMBER

ukdNumber

Продажи бизнесу/Электронный документооборот/Номер УКД

string

CONSIGNMENT_NOTE_DATE

consignmentNoteDate

Продажи бизнесу/Бумажный документооборот/Дата товарной накладной

string

CONSIGNMENT_NOTE_NUMBER

consignmentNoteNumber

Продажи бизнесу/Бумажный документооборот/Номер товарной накладной

string

INVOICE_DATE

invoiceDate

Продажи бизнесу/Бумажный документооборот/Дата счёта-фактуры

string

INVOICE_NUMBER

invoiceNumber

Продажи бизнесу/Бумажный документооборот/Номер счёта фактуры

string

ADJUSTMENT_INVOICE_DATE

adjustmentInvoiceDate

Продажи бизнесу/Бумажный документооборот/Дата корректировочного счёта-фактуры

string

ADJUSTMENT_INVOICE_NUMBER

adjustmentInvoiceNumber

Продажи бизнесу/Бумажный документооборот/Номер корректировочного счёта фактуры

string

REDEEMED_PRICE

redeemedPrice

Продажи бизнесу/Стоимость выкупленного товара

number

RNPT

rnpt

Заказы/Регистрационный номер таможенной декларации или Регистрационный номер партии товара, подлежащего прослеживаемости (РНПТ)

string

Лист Товары, утраченные в доставке (файл lost_items)

Название колонки в CSV

Название колонки в JSON

Название колонки в XLSX

Тип значения

ORDER_ID

orderId

Заказы/Номер заказа

integer

YOUR_ORDER_ID

yourOrderId

Заказы/Ваш номер заказа

string

ORDER_TYPE

orderType

Заказы/Тип заказа

string

OFFER_NAME

offerName

Заказы/Название товара

string

YOUR_SKU

yourSku

Заказы/Ваш SKU

string

SHOP_SKU

shopSku

Заказы/$

string

TRANSFERRED_TO_DELIVERY_COUNT

transferredToDeliveryCount

Заказы/Количество переданных в доставку, шт.

integer

ORDER_CREATION_DATE

orderCreationDate

Заказы/Дата оформления заказа

string

TRANSFERRED_TO_DELIVERY_DATE

transferredToDeliveryDate

Заказы/Дата передачи товара в доставку

string

DELIVERY_DATE

deliveryDate

Заказы/Дата доставки товара

string

PAYMENT_TYPE

paymentType

Заказы/Способ оплаты

string

VAT

vat

Заказы/Ставка НДС

string

PRICE_WITH_VAT_AND_NO_DISCOUNT

priceWithVatAndNoDiscount

Заказы/Цена c НДС без учёта скидок за шт.

number

SHOP_MARKETPLACE_DISCOUNT

shopMarketplaceDiscount

Заказы/Ваша скидка по акции маркетплейса на 1 шт.

number

SPASIBO_DISCOUNT

spasiboDiscount

Заказы/Ваша скидка по бонусам СберСпасибо (за шт.) на 1 шт.

number

YANDEX_PLUS_DISCOUNT

yandexPlusDiscount

Заказы/Ваша скидка по баллам Яндекс.Плюса на 1 шт.

number

PRICE_WITH_VAT_AND_ALL_DISCOUNTS

priceWithVatAndAllDiscounts

Заказы/Цена с НДС с учётом всех скидок за шт.

number

TRANSFERRED_TO_DELIVERY_PRICE_SUM_WITH_VAT_AND_NO_DISCOUNTS

transferredToDeliveryPriceSumWithVatAndNoDiscounts

Заказы/Стоимость всех переданных в доставку штук с НДС без учёта скидок

number

TRANSFERRED_TO_DELIVERY_DISCOUNT_SUM

transferredToDeliveryDiscountSum

Заказы/Сумма всех скидок для переданных в доставку штук

number

TRANSFERRED_TO_DELIVERY_PRICE_SUM_WITH_VAT_AND_DISCOUNTS

transferredToDeliveryPriceSumWithVatAndDiscounts

Заказы/Стоимость всех переданных в доставку штук с НДС с учётом всех скидок

number

RNPT

rnpt

Заказы/Регистрационный номер таможенной декларации или Регистрационный номер партии товара, подлежащего прослеживаемости (РНПТ)

string

COMPENSATION_DATE

compensationDate

Компенсации/Дата автокомпенсации

string

COMPENSATION_AMOUNT

compensationAmount

Компенсации/Сумма автокомпенсации

number

LOST_RETURN_RECEIVED_DATE

lostReturnReceivedDate

Компенсации/Дата приёма заказа складом Маркета или выдачи продавцу с СЦ

string

DECOMPENSATION_DATE

decompensationDate

Компенсации/Дата декомпенсации

string

DECOMPENSATION_AMOUNT

decompensationAmount

Компенсации/Сумма декомпенсации

number

ORGANIZATION

organization

Продажи бизнесу/Информация о покупателе/Наименование организации

string

INN

inn

Продажи бизнесу/Информация о покупателе/ИНН

string

KPP

kpp

Продажи бизнесу/Информация о покупателе/КПП

string

ORGANIZATION_JUR_ADDRESS

organizationJurAddress

Продажи бизнесу/Информация о покупателе/Юридический адрес

string

UPD_STATUS

updStatus

Продажи бизнесу/Электронный документооборот/Статус УПД

string

UPD_DATE

updDate

Продажи бизнесу/Электронный документооборот/Дата УПД

string

UPD_NUMBER

updNumber

Продажи бизнесу/Электронный документооборот/Номер УПД

string

CONSIGNMENT_NOTE_DATE

consignmentNoteDate

Продажи бизнесу/Бумажный документооборот/Дата товарной накладной

string

CONSIGNMENT_NOTE_NUMBER

consignmentNoteNumber

Продажи бизнесу/Бумажный документооборот/Номер товарной накладной

string

INVOICE_DATE

invoiceDate

Продажи бизнесу/Бумажный документооборот/Дата счёта-фактуры

string

INVOICE_NUMBER

invoiceNumber

Продажи бизнесу/Бумажный документооборот/Номер счёта фактуры

string

UKD_STATUS

ukdStatus

Продажи бизнесу/Электронный документооборот/Статус УКД

string

UKD_DATE

ukdDate

Продажи бизнесу/Электронный документооборот/Дата УКД

string

UKD_NUMBER

ukdNumber

Продажи бизнесу/Электронный документооборот/Номер УКД

string

ADJUSTMENT_INVOICE_DATE

adjustmentInvoiceDate

Продажи бизнесу/Бумажный документооборот/Дата корректировочного счёта-фактуры

string

ADJUSTMENT_INVOICE_NUMBER

adjustmentInvoiceNumber

Продажи бизнесу/Бумажный документооборот/Номер корректировочного счёта фактуры

string

Пояснение к колонкам отчета:

Лист Передано в доставку (файл transferred_to_delivery)

Название колонки в CSV

Название колонки в JSON

Название колонки в XLSX

Тип значения

ORDER_ID

orderId

Заказы/Номер заказа

integer

YOUR_ORDER_ID

yourOrderId

Заказы/Ваш номер заказа

string

ORDER_TYPE

orderType

Заказы/Тип заказа

string

OFFER_NAME

offerName

Заказы/Название

string

YOUR_SKU

yourSku

Заказы/Ваш SKU

string

SHOP_SKU

shopSku

Заказы/$

string

TRANSFERRED_TO_DELIVERY_COUNT

transferredToDeliveryCount

Заказы/Количество переданных в доставку, шт.

integer

ORDER_CREATION_DATE

orderCreationDate

Заказы/Дата оформления заказа

string

TRANSFERRED_TO_DELIVERY_DATE

transferredToDeliveryDate

Заказы/Дата передачи товара в доставку

string

DELIVERY_DATE

deliveryDate

Заказы/Дата доставки товара

string

PAYMENT_TYPE

paymentType

Заказы/Способ оплаты

string

VAT

vat

Заказы/Ставка НДС

string

PRICE_WITH_VAT_AND_NO_DISCOUNT

priceWithVatAndNoDiscount

Заказы/Цена c НДС без учёта скидок за шт.

number

SHOP_MARKETPLACE_DISCOUNT

shopMarketplaceDiscount

Заказы/Ваша скидка по акции маркетплейса на 1 шт.

number

SPASIBO_DISCOUNT

spasiboDiscount

Заказы/Ваша скидка по бонусам СберСпасибо (за шт.) на 1 шт.

number

YANDEX_PLUS_DISCOUNT

yandexPlusDiscount

Заказы/Ваша скидка по баллам Яндекс.Плюса на 1 шт.

number

PRICE_WITH_VAT_AND_ALL_DISCOUNTS

priceWithVatAndAllDiscounts

Заказы/Цена с НДС с учётом всех скидок за шт.

number

TRANSFERRED_TO_DELIVERY_PRICE_SUM_WITH_VAT_AND_NO_DISCOUNTS

transferredToDeliveryPriceSumWithVatAndNoDiscounts

Заказы/Стоимость всех переданных в доставку штук с НДС без учёта скидок

number

TRANSFERRED_TO_DELIVERY_DISCOUNT_SUM

transferredToDeliveryDiscountSum

Заказы/Сумма всех скидок для переданных в доставку штук

number

TRANSFERRED_TO_DELIVERY_PRICE_SUM_WITH_VAT_AND_DISCOUNTS

transferredToDeliveryPriceSumWithVatAndDiscounts

Заказы/Стоимость всех переданных в доставку штук с НДС с учётом всех скидок

number

RNPT

rnpt

Заказы/Регистрационный номер таможенной декларации или Регистрационный номер партии товара, подлежащего прослеживаемости (РНПТ)

string

ORGANIZATION

organization

Продажи бизнесу/Информация о покупателе/Наименование организации

string

INN

inn

Продажи бизнесу/Информация о покупателе/ИНН

string

KPP

kpp

Продажи бизнесу/Информация о покупателе/КПП

string

ORGANIZATION_JUR_ADDRESS

organizationJurAddress

Продажи бизнесу/Информация о покупателе/Юридический адрес

string

UPD_STATUS

updStatus

Продажи бизнесу/Электронный документооборот/Статус УПД

string

UPD_DATE

updDate

Продажи бизнесу/Электронный документооборот/Дата УПД

string

UPD_NUMBER

updNumber

Продажи бизнесу/Электронный документооборот/Номер УПД

string

UPD_STATUS

updStatus

Продажи бизнесу/Документы/Статус УПД

string

UPD_DATE

updDate

Продажи бизнесу/Документы/Дата УПД

string

UPD_NUMBER

updNumber

Продажи бизнесу/Документы/Номер УПД

string

UKD_STATUS

ukdStatus

Продажи бизнесу/Документы/Статус УКД

string

UKD_DATE

ukdDate

Продажи бизнесу/Документы/Дата УКД

string

UKD_NUMBER

ukdNumber

Продажи бизнесу/Документы/Номер УКД

string

CONSIGNMENT_NOTE_DATE

consignmentNoteDate

Продажи бизнесу/Бумажный документооборот/Дата товарной накладной

string

CONSIGNMENT_NOTE_NUMBER

consignmentNoteNumber

Продажи бизнесу/Бумажный документооборот/Номер товарной накладной

string

INVOICE_DATE

invoiceDate

Продажи бизнесу/Бумажный документооборот/Дата счёта-фактуры

string

INVOICE_NUMBER

invoiceNumber

Продажи бизнесу/Бумажный документооборот/Номер счёта фактуры

string

Лист Доставлено (файл delivered)

Название колонки в CSV

Название колонки в JSON

Название колонки в XLSX

Тип значения

ORDER_ID

orderId

Заказы/Номер заказа

integer

YOUR_ORDER_ID

yourOrderId

Заказы/Ваш номер заказа

string

ORDER_TYPE

orderType

Заказы/Тип заказа

string

OFFER_NAME

offerName

Заказы/Название

string

YOUR_SKU

yourSku

Заказы/Ваш SKU

string

SHOP_SKU

shopSku

Заказы/$

string

TRANSFERRED_TO_DELIVERY_COUNT

transferredToDeliveryCount

Заказы/Количество переданных в доставку, шт.

integer

DELIVERED_COUNT

deliveredCount

Заказы/Доставлено, шт.

integer

ORDER_CREATION_DATE

orderCreationDate

Заказы/Дата оформления заказа

string

TRANSFERRED_TO_DELIVERY_DATE

transferredToDeliveryDate

Заказы/Дата передачи товара в доставку

string

DELIVERY_DATE

deliveryDate

Заказы/Дата доставки товара

string

PAYMENT_TYPE

paymentType

Заказы/Способ оплаты

string

VAT

vat

Заказы/Ставка НДС

string

PRICE_WITH_VAT_AND_NO_DISCOUNT

priceWithVatAndNoDiscount

Заказы/Цена c НДС без учёта скидок за шт.

number

SHOP_MARKETPLACE_DISCOUNT

shopMarketplaceDiscount

Заказы/Ваша скидка по акции маркетплейса на 1 шт.

number

SPASIBO_DISCOUNT

spasiboDiscount

Заказы/Ваша скидка по бонусам СберСпасибо (за шт.) на 1 шт.

number

YANDEX_PLUS_DISCOUNT

yandexPlusDiscount

Заказы/Ваша скидка по баллам Яндекс.Плюса на 1 шт.

number

PRICE_WITH_VAT_AND_ALL_DISCOUNTS

priceWithVatAndAllDiscounts

Заказы/Цена с НДС с учётом всех скидок за шт.

number

DELIVERED_PRICE_SUM_WITH_VAT_AND_NO_DISCOUNTS

deliveredPriceSumWithVatAndNoDiscounts

Заказы/Стоимость всех доставленных штук с НДС без учёта скидок

number

DELIVERED_DISCOUNT_SUM

deliveredDiscountSum

Заказы/Сумма всех скидок для доставленных штук

number

DELIVERED_PRICE_SUM_WITH_VAT_AND_DISCOUNTS

deliveredPriceSumWithVatAndDiscounts

Заказы/Стоимость всех доставленных штук с НДС с учётом всех скидок

number

RNPT

rnpt

Заказы/Регистрационный номер таможенной декларации или Регистрационный номер партии товара, подлежащего прослеживаемости (РНПТ)

string

ORGANIZATION

organization

Продажи бизнесу/Информация о покупателе/Наименование организации

string

INN

inn

Продажи бизнесу/Информация о покупателе/ИНН

string

KPP

kpp

Продажи бизнесу/Информация о покупателе/КПП

string

ORGANIZATION_JUR_ADDRESS

organizationJurAddress

Продажи бизнесу/Информация о покупателе/Юридический адрес

string

UPD_STATUS

updStatus

Продажи бизнесу/Электронный документооборот/Статус УПД

string

UPD_DATE

updDate

Продажи бизнесу/Электронный документооборот/Дата УПД

string

UPD_NUMBER

updNumber

Продажи бизнесу/Электронный документооборот/Номер УПД

string

UPD_STATUS

updStatus

Продажи бизнесу/Документы/Статус УПД

string

UPD_DATE

updDate

Продажи бизнесу/Документы/Дата УПД

string

UPD_NUMBER

updNumber

Продажи бизнесу/Документы/Номер УПД

string

CONSIGNMENT_NOTE_DATE

consignmentNoteDate

Продажи бизнесу/Бумажный документооборот/Дата товарной накладной

string

CONSIGNMENT_NOTE_NUMBER

consignmentNoteNumber

Продажи бизнесу/Бумажный документооборот/Номер товарной накладной

string

INVOICE_DATE

invoiceDate

Продажи бизнесу/Бумажный документооборот/Дата счёта-фактуры

string

INVOICE_NUMBER

invoiceNumber

Продажи бизнесу/Бумажный документооборот/Номер счёта фактуры

string

Лист Невыкуплено (файл unredeemed)

Название колонки в CSV

Название колонки в JSON

Название колонки в XLSX

Тип значения

ORDER_ID

orderId

Заказы/Номер заказа

integer

YOUR_ORDER_ID

yourOrderId

Заказы/Ваш номер заказа

string

ORDER_TYPE

orderType

Заказы/Тип заказа

string

OFFER_NAME

offerName

Заказы/Название

string

YOUR_SKU

yourSku

Заказы/Ваш SKU

string

SHOP_SKU

shopSku

Заказы/$

string

TRANSFERRED_TO_DELIVERY_COUNT

transferredToDeliveryCount

Заказы/Количество переданных в доставку, шт.

integer

UNREDEEMED_COUNT

unredeemedCount

Заказы/Невыкуплено, шт.

integer

ORDER_CREATION_DATE

orderCreationDate

Заказы/Дата оформления заказа

string

TRANSFERRED_TO_DELIVERY_DATE

transferredToDeliveryDate

Заказы/Дата передачи товара в доставку

string

DELIVERY_DATE

deliveryDate

Заказы/Дата доставки товара

string

UNREDEEMED_WAREHOUSE_OR_SC_ACCEPT_DATE

unredeemedWarehouseOrScAcceptDate

Заказы/Дата приёма невыкупа складом или сортировочным центром

string

PAYMENT_TYPE

paymentType

Заказы/Способ оплаты

string

VAT

vat

Заказы/Ставка НДС

string

PRICE_WITH_VAT_AND_NO_DISCOUNT

priceWithVatAndNoDiscount

Заказы/Цена c НДС без учёта скидок за шт.

number

SHOP_MARKETPLACE_DISCOUNT

shopMarketplaceDiscount

Заказы/Ваша скидка по акции маркетплейса на 1 шт.

number

SPASIBO_DISCOUNT

spasiboDiscount

Заказы/Ваша скидка по бонусам СберСпасибо (за шт.) на 1 шт.

number

YANDEX_PLUS_DISCOUNT

yandexPlusDiscount

Заказы/Ваша скидка по баллам Яндекс.Плюса на 1 шт.

number

PRICE_WITH_VAT_AND_ALL_DISCOUNTS

priceWithVatAndAllDiscounts

Заказы/Цена с НДС с учётом всех скидок за шт.

number

UNREDEEMED_PRICE_SUM_WITH_VAT_AND_NO_DISCOUNTS

unredeemedPriceSumWithVatAndNoDiscounts

Заказы/Стоимость всех невыкупленных штук с НДС без учёта скидок

number

UNREDEEMED_DISCOUNT_SUM

unredeemedDiscountSum

Заказы/Сумма всех скидок для невыкупленных штук

number

UNREDEEMED_PRICE_SUM_WITH_VAT_AND_DISCOUNTS

unredeemedPriceSumWithVatAndDiscounts

Заказы/Стоимость всех невыкупленных штук с НДС с учётом всех скидок

number

RNPT

rnpt

Заказы/Регистрационный номер таможенной декларации или Регистрационный номер партии товара, подлежащего прослеживаемости (РНПТ)

string

ORGANIZATION

organization

Продажи бизнесу/Информация о покупателе/Наименование организации

string

INN

inn

Продажи бизнесу/Информация о покупателе/ИНН

string

KPP

kpp

Продажи бизнесу/Информация о покупателе/КПП

string

ORGANIZATION_JUR_ADDRESS

organizationJurAddress

Продажи бизнесу/Информация о покупателе/Юридический адрес

string

UKD_STATUS

ukdStatus

Продажи бизнесу/Электронный документооборот/Статус УКД

string

UKD_DATE

ukdDate

Продажи бизнесу/Электронный документооборот/Дата УКД

string

UKD_NUMBER

ukdNumber

Продажи бизнесу/Электронный документооборот/Номер УКД

string

CONSIGNMENT_NOTE_DATE

consignmentNoteDate

Продажи бизнесу/Бумажный документооборот/Дата товарной накладной

string

CONSIGNMENT_NOTE_NUMBER

consignmentNoteNumber

Продажи бизнесу/Бумажный документооборот/Номер товарной накладной

string

INVOICE_DATE

invoiceDate

Продажи бизнесу/Бумажный документооборот/Дата счёта-фактуры

string

INVOICE_NUMBER

invoiceNumber

Продажи бизнесу/Бумажный документооборот/Номер счёта фактуры

string

ADJUSTMENT_INVOICE_DATE

adjustmentInvoiceDate

Продажи бизнесу/Бумажный документооборот/Дата корректировочного счёта-фактуры

string

ADJUSTMENT_INVOICE_NUMBER

adjustmentInvoiceNumber

Продажи бизнесу/Бумажный документооборот/Номер корректировочного счёта фактуры

string

REDEEMED_PRICE

redeemedPrice

Продажи бизнесу/Стоимость выкупленного товара

string

UPD_STATUS

updStatus

Продажи бизнесу/Электронный документооборот/Статус УПД

string

UPD_DATE

updDate

Продажи бизнесу/Электронный документооборот/Дата УПД

string

UPD_NUMBER

updNumber

Продажи бизнесу/Электронный документооборот/Номер УПД

string

UPD_STATUS

updStatus

Продажи бизнесу/Документы/Статус УПД

string

UPD_DATE

updDate

Продажи бизнесу/Документы/Дата УПД

string

UPD_NUMBER

updNumber

Продажи бизнесу/Документы/Номер УПД

string

UKD_STATUS

ukdStatus

Продажи бизнесу/Документы/Статус УКД

string

UKD_DATE

ukdDate

Продажи бизнесу/Документы/Дата УКД

string

UKD_NUMBER

ukdNumber

Продажи бизнесу/Документы/Номер УКД

string

REDEEMED_PRICE

redeemedPrice

Продажи бизнесу/Документы/Стоимость выкупленного товара

string

Лист Возвращено (файл returned)

Название колонки в CSV

Название колонки в JSON

Название колонки в XLSX

Тип значения

ORDER_ID

orderId

Заказы/Номер заказа

integer

YOUR_ORDER_ID

yourOrderId

Заказы/Ваш номер заказа

string

ORDER_TYPE

orderType

Заказы/Тип заказа

string

OFFER_NAME

offerName

Заказы/Название

string

YOUR_SKU

yourSku

Заказы/Ваш SKU

string

SHOP_SKU

shopSku

Заказы/$

string

DELIVERED_COUNT

deliveredCount

Заказы/Количество доставленных, шт.

integer

RETURNED_COUNT

returnedCount

Заказы/Возвращено, шт.

integer

ORDER_CREATION_DATE

orderCreationDate

Заказы/Дата оформления заказа

string

TRANSFERRED_TO_DELIVERY_DATE

transferredToDeliveryDate

Заказы/Дата передачи товара в доставку

string

DELIVERY_DATE

deliveryDate

Заказы/Дата доставки товара

string

RETURN_WAREHOUSE_OR_SC_ACCEPT_DATE

returnWarehouseOrScAcceptDate

Заказы/Дата выдачи возврата вам

string

PAYMENT_TYPE

paymentType

Заказы/Способ оплаты

string

VAT

vat

Заказы/Ставка НДС

string

PRICE_WITH_VAT_AND_NO_DISCOUNT

priceWithVatAndNoDiscount

Заказы/Цена c НДС без учёта скидок за шт.

number

SHOP_MARKETPLACE_DISCOUNT

shopMarketplaceDiscount

Заказы/Ваша скидка по акции маркетплейса на 1 шт.

number

SPASIBO_DISCOUNT

spasiboDiscount

Заказы/Ваша скидка по бонусам СберСпасибо (за шт.) на 1 шт.

number

YANDEX_PLUS_DISCOUNT

yandexPlusDiscount

Заказы/Ваша скидка по баллам Яндекс.Плюса на 1 шт.

number

PRICE_WITH_VAT_AND_ALL_DISCOUNTS

priceWithVatAndAllDiscounts

Заказы/Цена с НДС с учётом всех скидок за шт.

number

RETURN_PRICE_SUM_WITH_VAT_AND_NO_DISCOUNTS

returnPriceSumWithVatAndNoDiscounts

Заказы/Стоимость всех возвращённых штук с НДС без учёта скидок

number

RETURN_DISCOUNT_SUM

returnDiscountSum

Заказы/Сумма всех скидок для возвращённых штук

number

RETURN_PRICE_SUM_WITH_VAT_AND_DISCOUNTS

returnPriceSumWithVatAndDiscounts

Заказы/Стоимость всех возвращённых штук с НДС с учётом всех скидок

number

ORGANIZATION

organization

Продажи бизнесу/Информация о покупателе/Наименование организации

string

INN

inn

Продажи бизнесу/Информация о покупателе/ИНН

string

KPP

kpp

Продажи бизнесу/Информация о покупателе/КПП

string

ORGANIZATION_JUR_ADDRESS

organizationJurAddress

Продажи бизнесу/Информация о покупателе/Юридический адрес

string

UPD_STATUS

updStatus

Продажи бизнесу/Документы/Статус УПД

string

UPD_DATE

updDate

Продажи бизнесу/Документы/Дата УПД

string

UPD_NUMBER

updNumber

Продажи бизнесу/Документы/Номер УПД

string

UKD_STATUS

ukdStatus

Продажи бизнесу/Документы/Статус УКД

string

UKD_DATE

ukdDate

Продажи бизнесу/Документы/Дата УКД

string

UKD_NUMBER

ukdNumber

Продажи бизнесу/Документы/Номер УКД

string

REDEEMED_PRICE

redeemedPrice

Продажи бизнесу/Документы/Стоимость выкупленного товара

number

UPD_STATUS

updStatus

Продажи бизнесу/Электронный документооборот/Статус УПД

string

UPD_DATE

updDate

Продажи бизнесу/Электронный документооборот/Дата УПД

string

UPD_NUMBER

updNumber

Продажи бизнесу/Электронный документооборот/Номер УПД

string

UKD_STATUS

ukdStatus

Продажи бизнесу/Электронный документооборот/Статус УКД

string

UKD_DATE

ukdDate

Продажи бизнесу/Электронный документооборот/Дата УКД

string

UKD_NUMBER

ukdNumber

Продажи бизнесу/Электронный документооборот/Номер УКД

string

CONSIGNMENT_NOTE_DATE

consignmentNoteDate

Продажи бизнесу/Бумажный документооборот/Дата товарной накладной

string

CONSIGNMENT_NOTE_NUMBER

consignmentNoteNumber

Продажи бизнесу/Бумажный документооборот/Номер товарной накладной

string

INVOICE_DATE

invoiceDate

Продажи бизнесу/Бумажный документооборот/Дата счёта-фактуры

string

INVOICE_NUMBER

invoiceNumber

Продажи бизнесу/Бумажный документооборот/Номер счёта фактуры

string

ADJUSTMENT_INVOICE_DATE

adjustmentInvoiceDate

Продажи бизнесу/Бумажный документооборот/Дата корректировочного счёта-фактуры

string

ADJUSTMENT_INVOICE_NUMBER

adjustmentInvoiceNumber

Продажи бизнесу/Бумажный документооборот/Номер корректировочного счёта фактуры

string

REDEEMED_PRICE

redeemedPrice

Продажи бизнесу/Стоимость выкупленного товара

number

RNPT

rnpt

Заказы/Регистрационный номер таможенной декларации или Регистрационный номер партии товара, подлежащего прослеживаемости (РНПТ)

string

⚙️ Лимит: 100 запросов в час

Request

POST

https://api.partner.market.yandex.ru/reports/goods-realization/generate

Query parameters

Name

Description

format

Type: ReportFormatType

Формат отчета.

ReportFormatType

Формат отчета:

  • FILE — файл с электронной таблицей (XLSX).
  • CSV — ZIP-архив с CSV-файлами на каждый лист отчета.
  • JSON — ZIP-архив с JSON-файлами на каждый лист отчета.

Type

Description

ReportFormatType

Default: FILE

Enum: FILE, CSV, JSON

Body

application/json
{
    "campaignId": 0,
    "year": 2025,
    "month": 12
}

Name

Description

campaignId*

Type: integer<int64>

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

month*

Type: integer<int32>

Номер месяца.

Example: 12

Min value: 1

Max value: 12

year*

Type: integer<int32>

Год.

Example: 2025

Responses

200 OK

В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет.

Body

application/json
{
    "status": "OK",
    "result": {
        "reportId": "string",
        "estimatedGenerationTime": 0
    }
}

Name

Description

result

Type: GenerateReportDTO

Идентификатор, который понадобится для отслеживания статуса генерации и получения готового отчета.

status

Type: ApiResponseStatusType

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

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

Enum: OK, ERROR

GenerateReportDTO

Идентификатор, который понадобится для отслеживания статуса генерации и получения готового отчета.

Name

Description

estimatedGenerationTime*

Type: integer<int64>

Ожидаемая продолжительность генерации в миллисекундах.

reportId*

Type: string

Идентификатор, который понадобится для отслеживания статуса генерации и получения готового отчета.

ApiResponseStatusType

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

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

Type

Description

ApiResponseStatusType

Enum: OK, ERROR

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

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