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

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

Отчет по схождению с закрывающими документами

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

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

Запускает генерацию отчета по схождению с закрывающими документами в зависимости от типа договора.

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

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

Лист Отчёт об исполнении поручения (файл period_closure_income_summary)

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

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

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

Тип значения

PAYMENTS

payments

Платежи по отчёту

string

PAYMENTS_DESCRIPTION

paymentsDescription

Что это за платежи

string

PAYMENT_SUM

paymentSum

Сумма платежа*

number

Лист Получено от потребителей (файл period_closure_income_payments)

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

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

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

Тип значения

BUSINESS_ID

businessId

Информация о бизнесе/ID бизнес-аккаунта

integer

MODEL

model

Информация о бизнесе/Модели работы

string

PARTNER_ID

partnerId

Информация о бизнесе/ID магазинов

integer

SHOP_NAME

shopName

Информация о бизнесе/Названия магазинов

string

INN

inn

Информация о бизнесе/ИНН

string

PLACEMENT_CONTRACT

placementContract

Информация о бизнесе/Номера договоров на размещение

string

PROMOTION_CONTRACT

promotionContract

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

string

TRANSACTION_DATE

transactionDate

Информация о платежах/Дата транзакции

string

TRANSACTION_ID

transactionId

Информация о платежах/ID транзакции

string

ORDER_ID

orderId

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

integer

SHOP_ORDER_ID

shopOrderId

Информация о платежах/Ваш номер заказа

string

ORDER_CREATION_DATE

orderCreationDate

Информация о платежах/Дата оформления заказа или акта об оказанных услугах

string

CLAIM_NUMBER

claimNumber

Информация о платежах/Номер и дата претензии

string

ORDER_TYPE

orderType

Информация о платежах/Тип заказа

string

OFFER_ID

offerId

Информация о платежах/Ваш SKU

string

OFFER_NAME

offerName

Информация о платежах/Название товара

string

COUNT

count

Информация о платежах/Количество, шт.

integer

TRANSACTION_SUM

transactionSum

Информация о платежах/Сумма транзакции

number

TRANSACTION_TYPE

transactionType

Информация о платежах/Тип транзакции

string

TRANSACTION_SOURCE

transactionSource

Информация о платежах/Источник транзакции

string

PAYMENT_STATUS

paymentStatus

Информация о платежах/Статус

string

BANK_ORDER_DATE

bankOrderDate

Информация о платежах/Дата платёжного поручения

string

BANK_ORDER_ID

bankOrderId

Информация о платежах/Номер платёжного поручения

integer

BANK_ORDER_SUM

bankOrderSum

Информация о платежах/Сумма платёжного поручения или удерживаемая за услуги сумма

number

Лист Возвращено потребителям (файл period_closure_income_refunds)

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

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

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

Тип значения

BUSINESS_ID

businessId

Информация о бизнесе/ID бизнес-аккаунта

integer

MODEL

model

Информация о бизнесе/Модели работы

string

PARTNER_ID

partnerId

Информация о бизнесе/ID магазинов

integer

SHOP_NAME

shopName

Информация о бизнесе/Названия магазинов

string

INN

inn

Информация о бизнесе/ИНН

string

PLACEMENT_CONTRACT

placementContract

Информация о бизнесе/Номера договоров на размещение

string

PROMOTION_CONTRACT

promotionContract

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

string

TRANSACTION_DATE

transactionDate

Информация о платежах/Дата транзакции

string

TRANSACTION_ID

transactionId

Информация о платежах/ID транзакции

string

ORDER_ID

orderId

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

integer

SHOP_ORDER_ID

shopOrderId

Информация о платежах/Ваш номер заказа

string

ORDER_CREATION_DATE

orderCreationDate

Информация о платежах/Дата оформления заказа или акта об оказанных услугах

string

CLAIM_NUMBER

claimNumber

Информация о платежах/Номер и дата претензии

string

ORDER_TYPE

orderType

Информация о платежах/Тип заказа

string

OFFER_ID

offerId

Информация о платежах/Ваш SKU

string

OFFER_NAME

offerName

Информация о платежах/Название товара

string

COUNT

count

Информация о платежах/Количество, шт.

integer

TRANSACTION_SUM

transactionSum

Информация о платежах/Сумма транзакции

number

TRANSACTION_TYPE

transactionType

Информация о платежах/Тип транзакции

string

TRANSACTION_SOURCE

transactionSource

Информация о платежах/Источник транзакции

string

PAYMENT_STATUS

paymentStatus

Информация о платежах/Статус

string

BANK_ORDER_DATE

bankOrderDate

Информация о платежах/Дата платёжного поручения

string

BANK_ORDER_ID

bankOrderId

Информация о платежах/Номер платёжного поручения

integer

BANK_ORDER_SUM

bankOrderSum

Информация о платежах/Сумма платёжного поручения или удерживаемая за услуги сумма

number

Лист Реализовано от имени заказчика (файл period_closure_income_sold_refunds)

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

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

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

Тип значения

BUSINESS_ID

businessId

Информация о бизнесе/ID бизнес-аккаунта

integer

MODEL

model

Информация о бизнесе/Модели работы

string

PARTNER_ID

partnerId

Информация о бизнесе/ID магазинов

integer

SHOP_NAME

shopName

Информация о бизнесе/Названия магазинов

string

INN

inn

Информация о бизнесе/ИНН

string

PLACEMENT_CONTRACT

placementContract

Информация о бизнесе/Номера договоров на размещение

string

PROMOTION_CONTRACT

promotionContract

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

string

TRANSACTION_DATE

transactionDate

Информация о платежах/Дата транзакции

string

TRANSACTION_ID

transactionId

Информация о платежах/ID транзакции

string

ORDER_ID

orderId

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

integer

SHOP_ORDER_ID

shopOrderId

Информация о платежах/Ваш номер заказа

string

ORDER_CREATION_DATE

orderCreationDate

Информация о платежах/Дата оформления заказа или акта об оказанных услугах

string

CLAIM_NUMBER

claimNumber

Информация о платежах/Номер и дата претензии

string

ORDER_TYPE

orderType

Информация о платежах/Тип заказа

string

OFFER_ID

offerId

Информация о платежах/Ваш SKU

string

OFFER_NAME

offerName

Информация о платежах/Название товара

string

COUNT

count

Информация о платежах/Количество, шт.

integer

TRANSACTION_SUM

transactionSum

Информация о платежах/Сумма транзакции

number

TRANSACTION_TYPE

transactionType

Информация о платежах/Тип транзакции

string

TRANSACTION_SOURCE

transactionSource

Информация о платежах/Источник транзакции

string

PAYMENT_STATUS

paymentStatus

Информация о платежах/Статус

string

BANK_ORDER_DATE

bankOrderDate

Информация о платежах/Дата платёжного поручения

string

BANK_ORDER_ID

bankOrderId

Информация о платежах/Номер платёжного поручения

integer

BANK_ORDER_SUM

bankOrderSum

Информация о платежах/Сумма платёжного поручения или удерживаемая за услуги сумма

number

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

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

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

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

Тип значения

BUSINESS_ID

businessId

Информация о бизнесе/ID бизнес-аккаунта

integer

MODEL

model

Информация о бизнесе/Модели работы

string

PARTNER_ID

partnerId

Информация о бизнесе/ID магазинов

integer

SHOP_NAME

shopName

Информация о бизнесе/Названия магазинов

string

INN

inn

Информация о бизнесе/ИНН

string

PLACEMENT_CONTRACT

placementContract

Информация о бизнесе/Номера договоров на размещение

string

PROMOTION_CONTRACT

promotionContract

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

string

TRANSACTION_DATE

transactionDate

Информация о платежах/Дата транзакции

string

TRANSACTION_ID

transactionId

Информация о платежах/ID транзакции

string

ORDER_ID

orderId

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

integer

SHOP_ORDER_ID

shopOrderId

Информация о платежах/Ваш номер заказа

string

ORDER_CREATION_DATE

orderCreationDate

Информация о платежах/Дата оформления заказа или акта об оказанных услугах

string

CLAIM_NUMBER

claimNumber

Информация о платежах/Номер и дата претензии

string

ORDER_TYPE

orderType

Информация о платежах/Тип заказа

string

OFFER_ID

offerId

Информация о платежах/Ваш SKU

string

OFFER_NAME

offerName

Информация о платежах/Название товара

string

COUNT

count

Информация о платежах/Количество, шт.

integer

TRANSACTION_SUM

transactionSum

Информация о платежах/Сумма транзакции

number

TRANSACTION_TYPE

transactionType

Информация о платежах/Тип транзакции

string

TRANSACTION_SOURCE

transactionSource

Информация о платежах/Источник транзакции

string

PAYMENT_STATUS

paymentStatus

Информация о платежах/Статус

string

BANK_ORDER_DATE

bankOrderDate

Информация о платежах/Дата платёжного поручения

string

BANK_ORDER_ID

bankOrderId

Информация о платежах/Номер платёжного поручения

integer

BANK_ORDER_SUM

bankOrderSum

Информация о платежах/Сумма платёжного поручения или удерживаемая за услуги сумма

number

Лист Удержано за услуги Маркета (файл period_closure_income_fees)

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

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

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

Тип значения

BUSINESS_ID

businessId

Информация о бизнесе/ID бизнес-аккаунта

integer

MODEL

model

Информация о бизнесе/Модели работы

string

PARTNER_ID

partnerId

Информация о бизнесе/ID магазинов

integer

SHOP_NAME

shopName

Информация о бизнесе/Названия магазинов

string

INN

inn

Информация о бизнесе/ИНН

string

PLACEMENT_CONTRACT

placementContract

Информация о бизнесе/Номера договоров на размещение

string

PROMOTION_CONTRACT

promotionContract

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

string

TRANSACTION_DATE

transactionDate

Информация о платежах/Дата транзакции

string

TRANSACTION_ID

transactionId

Информация о платежах/ID транзакции

string

ORDER_ID

orderId

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

integer

SHOP_ORDER_ID

shopOrderId

Информация о платежах/Ваш номер заказа

string

ORDER_CREATION_DATE

orderCreationDate

Информация о платежах/Дата оформления заказа или акта об оказанных услугах

string

CLAIM_NUMBER

claimNumber

Информация о платежах/Номер и дата претензии

string

ORDER_TYPE

orderType

Информация о платежах/Тип заказа

string

OFFER_ID

offerId

Информация о платежах/Ваш SKU

string

OFFER_NAME

offerName

Информация о платежах/Название товара

string

COUNT

count

Информация о платежах/Количество, шт.

integer

TRANSACTION_SUM

transactionSum

Информация о платежах/Сумма транзакции

number

TRANSACTION_TYPE

transactionType

Информация о платежах/Тип транзакции

string

TRANSACTION_SOURCE

transactionSource

Информация о платежах/Источник транзакции

string

PAYMENT_STATUS

paymentStatus

Информация о платежах/Статус

string

BANK_ORDER_DATE

bankOrderDate

Информация о платежах/Дата платёжного поручения

string

BANK_ORDER_ID

bankOrderId

Информация о платежах/Номер платёжного поручения

integer

BANK_ORDER_SUM

bankOrderSum

Информация о платежах/Сумма платёжного поручения или удерживаемая за услуги сумма

number

Лист Удержано штрафов (файл period_closure_income_fines)

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

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

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

Тип значения

BUSINESS_ID

businessId

Информация о бизнесе/ID бизнес-аккаунта

integer

MODEL

model

Информация о бизнесе/Модели работы

string

PARTNER_ID

partnerId

Информация о бизнесе/ID магазинов

integer

SHOP_NAME

shopName

Информация о бизнесе/Названия магазинов

string

INN

inn

Информация о бизнесе/ИНН

string

PLACEMENT_CONTRACT

placementContract

Информация о бизнесе/Номера договоров на размещение

string

PROMOTION_CONTRACT

promotionContract

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

string

TRANSACTION_DATE

transactionDate

Информация о платежах/Дата транзакции

string

TRANSACTION_ID

transactionId

Информация о платежах/ID транзакции

string

ORDER_ID

orderId

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

integer

SHOP_ORDER_ID

shopOrderId

Информация о платежах/Ваш номер заказа

string

ORDER_CREATION_DATE

orderCreationDate

Информация о платежах/Дата оформления заказа или акта об оказанных услугах

string

CLAIM_NUMBER

claimNumber

Информация о платежах/Номер и дата претензии

string

ORDER_TYPE

orderType

Информация о платежах/Тип заказа

string

OFFER_ID

offerId

Информация о платежах/Ваш SKU

string

OFFER_NAME

offerName

Информация о платежах/Название товара

string

COUNT

count

Информация о платежах/Количество, шт.

integer

TRANSACTION_SUM

transactionSum

Информация о платежах/Сумма транзакции

number

TRANSACTION_TYPE

transactionType

Информация о платежах/Тип транзакции

string

TRANSACTION_SOURCE

transactionSource

Информация о платежах/Источник транзакции

string

PAYMENT_STATUS

paymentStatus

Информация о платежах/Статус

string

BANK_ORDER_DATE

bankOrderDate

Информация о платежах/Дата платёжного поручения

string

BANK_ORDER_ID

bankOrderId

Информация о платежах/Номер платёжного поручения

integer

BANK_ORDER_SUM

bankOrderSum

Информация о платежах/Сумма платёжного поручения или удерживаемая за услуги сумма

number

Лист Компенсации от Маркета (файл period_closure_income_compensations)

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

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

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

Тип значения

BUSINESS_ID

businessId

Информация о бизнесе/ID бизнес-аккаунта

integer

MODEL

model

Информация о бизнесе/Модели работы

string

PARTNER_ID

partnerId

Информация о бизнесе/ID магазинов

integer

SHOP_NAME

shopName

Информация о бизнесе/Названия магазинов

string

INN

inn

Информация о бизнесе/ИНН

string

PLACEMENT_CONTRACT

placementContract

Информация о бизнесе/Номера договоров на размещение

string

PROMOTION_CONTRACT

promotionContract

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

string

TRANSACTION_DATE

transactionDate

Информация о платежах/Дата транзакции

string

TRANSACTION_ID

transactionId

Информация о платежах/ID транзакции

string

ORDER_ID

orderId

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

integer

SHOP_ORDER_ID

shopOrderId

Информация о платежах/Ваш номер заказа

string

ORDER_CREATION_DATE

orderCreationDate

Информация о платежах/Дата оформления заказа или акта об оказанных услугах

string

CLAIM_NUMBER

claimNumber

Информация о платежах/Номер и дата претензии

string

ORDER_TYPE

orderType

Информация о платежах/Тип заказа

string

OFFER_ID

offerId

Информация о платежах/Ваш SKU

string

OFFER_NAME

offerName

Информация о платежах/Название товара

string

COUNT

count

Информация о платежах/Количество, шт.

integer

TRANSACTION_SUM

transactionSum

Информация о платежах/Сумма транзакции

number

TRANSACTION_TYPE

transactionType

Информация о платежах/Тип транзакции

string

TRANSACTION_SOURCE

transactionSource

Информация о платежах/Источник транзакции

string

PAYMENT_STATUS

paymentStatus

Информация о платежах/Статус

string

BANK_ORDER_DATE

bankOrderDate

Информация о платежах/Дата платёжного поручения

string

BANK_ORDER_ID

bankOrderId

Информация о платежах/Номер платёжного поручения

integer

BANK_ORDER_SUM

bankOrderSum

Информация о платежах/Сумма платёжного поручения или удерживаемая за услуги сумма

number

Лист ** Премия** (файл period_closure_income_netting)

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

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

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

Тип значения

BUSINESS_ID

businessId

Информация о бизнесе/ID бизнес-аккаунта

integer

MODEL

model

Информация о бизнесе/Модели работы

string

PARTNER_ID

partnerId

Информация о бизнесе/ID магазинов

integer

SHOP_NAME

shopName

Информация о бизнесе/Названия магазинов

string

INN

inn

Информация о бизнесе/ИНН

string

PLACEMENT_CONTRACT

placementContract

Информация о бизнесе/Номера договоров на размещение

string

PROMOTION_CONTRACT

promotionContract

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

string

TRANSACTION_DATE

transactionDate

Информация о платежах/Дата транзакции

string

TRANSACTION_ID

transactionId

Информация о платежах/ID транзакции

string

ORDER_ID

orderId

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

integer

SHOP_ORDER_ID

shopOrderId

Информация о платежах/Ваш номер заказа

string

ORDER_CREATION_DATE

orderCreationDate

Информация о платежах/Дата оформления заказа или акта об оказанных услугах

string

CLAIM_NUMBER

claimNumber

Информация о платежах/Номер и дата претензии

string

ORDER_TYPE

orderType

Информация о платежах/Тип заказа

string

OFFER_ID

offerId

Информация о платежах/Ваш SKU

string

OFFER_NAME

offerName

Информация о платежах/Название товара

string

COUNT

count

Информация о платежах/Количество, шт.

integer

TRANSACTION_SUM

transactionSum

Информация о платежах/Сумма транзакции

number

TRANSACTION_TYPE

transactionType

Информация о платежах/Тип транзакции

string

TRANSACTION_SOURCE

transactionSource

Информация о платежах/Источник транзакции

string

PAYMENT_STATUS

paymentStatus

Информация о платежах/Статус

string

BANK_ORDER_DATE

bankOrderDate

Информация о платежах/Дата платёжного поручения

string

BANK_ORDER_ID

bankOrderId

Информация о платежах/Номер платёжного поручения

integer

BANK_ORDER_SUM

bankOrderSum

Информация о платежах/Сумма платёжного поручения или удерживаемая за услуги сумма

number

Лист Корректировка Премии (файл period_closure_income_premium_correction)

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

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

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

Тип значения

BUSINESS_ID

businessId

Информация о бизнесе/ID бизнес-аккаунта

integer

MODEL

model

Информация о бизнесе/Модели работы

string

PARTNER_ID

partnerId

Информация о бизнесе/ID магазинов

integer

SHOP_NAME

shopName

Информация о бизнесе/Названия магазинов

string

INN

inn

Информация о бизнесе/ИНН

string

PLACEMENT_CONTRACT

placementContract

Информация о бизнесе/Номера договоров на размещение

string

PROMOTION_CONTRACT

promotionContract

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

string

TRANSACTION_DATE

transactionDate

Информация о платежах/Дата транзакции

string

TRANSACTION_ID

transactionId

Информация о платежах/ID транзакции

string

ORDER_ID

orderId

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

integer

SHOP_ORDER_ID

shopOrderId

Информация о платежах/Ваш номер заказа

string

ORDER_CREATION_DATE

orderCreationDate

Информация о платежах/Дата оформления заказа или акта об оказанных услугах

string

CLAIM_NUMBER

claimNumber

Информация о платежах/Номер и дата претензии

string

ORDER_TYPE

orderType

Информация о платежах/Тип заказа

string

OFFER_ID

offerId

Информация о платежах/Ваш SKU

string

OFFER_NAME

offerName

Информация о платежах/Название товара

string

COUNT

count

Информация о платежах/Количество, шт.

integer

TRANSACTION_SUM

transactionSum

Информация о платежах/Сумма транзакции

number

TRANSACTION_TYPE

transactionType

Информация о платежах/Тип транзакции

string

TRANSACTION_SOURCE

transactionSource

Информация о платежах/Источник транзакции

string

PAYMENT_STATUS

paymentStatus

Информация о платежах/Статус

string

BANK_ORDER_DATE

bankOrderDate

Информация о платежах/Дата платёжного поручения

string

BANK_ORDER_ID

bankOrderId

Информация о платежах/Номер платёжного поручения

integer

BANK_ORDER_SUM

bankOrderSum

Информация о платежах/Сумма платёжного поручения или удерживаемая за услуги сумма

number

Лист Подлежит перечислению вам (файл period_closure_income_will_be_paid)

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

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

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

Тип значения

BUSINESS_ID

businessId

Информация о бизнесе/ID бизнес-аккаунта

integer

MODEL

model

Информация о бизнесе/Модели работы

string

PARTNER_ID

partnerId

Информация о бизнесе/ID магазинов

integer

SHOP_NAME

shopName

Информация о бизнесе/Названия магазинов

string

INN

inn

Информация о бизнесе/ИНН

string

PLACEMENT_CONTRACT

placementContract

Информация о бизнесе/Номера договоров на размещение

string

PROMOTION_CONTRACT

promotionContract

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

string

TRANSACTION_DATE

transactionDate

Информация о платежах/Дата транзакции

string

TRANSACTION_ID

transactionId

Информация о платежах/ID транзакции

string

ORDER_ID

orderId

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

integer

SHOP_ORDER_ID

shopOrderId

Информация о платежах/Ваш номер заказа

string

ORDER_CREATION_DATE

orderCreationDate

Информация о платежах/Дата оформления заказа или акта об оказанных услугах

string

CLAIM_NUMBER

claimNumber

Информация о платежах/Номер и дата претензии

string

ORDER_TYPE

orderType

Информация о платежах/Тип заказа

string

OFFER_ID

offerId

Информация о платежах/Ваш SKU

string

OFFER_NAME

offerName

Информация о платежах/Название товара

string

COUNT

count

Информация о платежах/Количество, шт.

integer

TRANSACTION_SUM

transactionSum

Информация о платежах/Сумма транзакции

number

TRANSACTION_TYPE

transactionType

Информация о платежах/Тип транзакции

string

TRANSACTION_SOURCE

transactionSource

Информация о платежах/Источник транзакции

string

PAYMENT_STATUS

paymentStatus

Информация о платежах/Статус

string

BANK_ORDER_DATE

bankOrderDate

Информация о платежах/Дата платёжного поручения

string

BANK_ORDER_ID

bankOrderId

Информация о платежах/Номер платёжного поручения

integer

BANK_ORDER_SUM

bankOrderSum

Информация о платежах/Сумма платёжного поручения или удерживаемая за услуги сумма

number

Лист Перечислено на ваш счёт (файл period_closure_income_paid)

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

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

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

Тип значения

BUSINESS_ID

businessId

Информация о бизнесе/ID бизнес-аккаунта

integer

MODEL

model

Информация о бизнесе/Модели работы

string

PARTNER_ID

partnerId

Информация о бизнесе/ID магазинов

integer

SHOP_NAME

shopName

Информация о бизнесе/Названия магазинов

string

INN

inn

Информация о бизнесе/ИНН

string

PLACEMENT_CONTRACT

placementContract

Информация о бизнесе/Номера договоров на размещение

string

PROMOTION_CONTRACT

promotionContract

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

string

TRANSACTION_DATE

transactionDate

Информация о платежах/Дата транзакции

string

TRANSACTION_ID

transactionId

Информация о платежах/ID транзакции

string

ORDER_ID

orderId

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

integer

SHOP_ORDER_ID

shopOrderId

Информация о платежах/Ваш номер заказа

string

ORDER_CREATION_DATE

orderCreationDate

Информация о платежах/Дата оформления заказа или акта об оказанных услугах

string

CLAIM_NUMBER

claimNumber

Информация о платежах/Номер и дата претензии

string

ORDER_TYPE

orderType

Информация о платежах/Тип заказа

string

OFFER_ID

offerId

Информация о платежах/Ваш SKU

string

OFFER_NAME

offerName

Информация о платежах/Название товара

string

COUNT

count

Информация о платежах/Количество, шт.

integer

TRANSACTION_SUM

transactionSum

Информация о платежах/Сумма транзакции

number

TRANSACTION_TYPE

transactionType

Информация о платежах/Тип транзакции

string

TRANSACTION_SOURCE

transactionSource

Информация о платежах/Источник транзакции

string

PAYMENT_STATUS

paymentStatus

Информация о платежах/Статус

string

BANK_ORDER_DATE

bankOrderDate

Информация о платежах/Дата платёжного поручения

string

BANK_ORDER_ID

bankOrderId

Информация о платежах/Номер платёжного поручения

integer

BANK_ORDER_SUM

bankOrderSum

Информация о платежах/Сумма платёжного поручения или удерживаемая за услуги сумма

number

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

Лист Акт об услугах по продвижению (файл period_closure_outcome_summary)

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

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

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

Тип значения

SERVICES

services

Услуги в акте

string

SERVICES_DESCRIPTION

servicesDescription

Что компенсируется по этой услуге

string

SERVICES_SUM

servicesSum

Стоимость услуг*

number

Лист Скидки маркетплейса (файл period_closure_outcome_subsidy)

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

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

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

Тип значения

BUSINESS_ID

businessId

Информация о бизнесе/ID бизнес-аккаунта

integer

MODEL

model

Информация о бизнесе/Модели работы

string

PARTNER_ID

partnerId

Информация о бизнесе/ID магазинов

integer

SHOP_NAME

shopName

Информация о бизнесе/Названия магазинов

string

INN

inn

Информация о бизнесе/ИНН

string

PLACEMENT_CONTRACT

placementContract

Информация о бизнесе/Номера договоров на размещение

string

PROMOTION_CONTRACT

promotionContract

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

string

TRANSACTION_DATE

transactionDate

Информация о платежах/Дата транзакции

string

TRANSACTION_ID

transactionId

Информация о платежах/ID транзакции

string

ORDER_ID

orderId

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

integer

SHOP_ORDER_ID

shopOrderId

Информация о платежах/Ваш номер заказа

string

ORDER_CREATION_DATE

orderCreationDate

Информация о платежах/Дата оформления заказа или акта об оказанных услугах

string

CLAIM_NUMBER

claimNumber

Информация о платежах/Номер и дата претензии

string

ORDER_TYPE

orderType

Информация о платежах/Тип заказа

string

OFFER_ID

offerId

Информация о платежах/Ваш SKU

string

OFFER_NAME

offerName

Информация о платежах/Название товара

string

COUNT

count

Информация о платежах/Количество, шт.

integer

TRANSACTION_SUM

transactionSum

Информация о платежах/Сумма транзакции

number

TRANSACTION_TYPE

transactionType

Информация о платежах/Тип транзакции

string

TRANSACTION_SOURCE

transactionSource

Информация о платежах/Источник транзакции

string

PAYMENT_STATUS

paymentStatus

Информация о платежах/Статус

string

BANK_ORDER_DATE

bankOrderDate

Информация о платежах/Дата платёжного поручения

string

BANK_ORDER_ID

bankOrderId

Информация о платежах/Номер платёжного поручения

integer

BANK_ORDER_SUM

bankOrderSum

Информация о платежах/Сумма платёжного поручения или удерживаемая за услуги сумма

number

Лист Баллы Яндекс Плюса (файл period_closure_outcome_plus)

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

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

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

Тип значения

BUSINESS_ID

businessId

Информация о бизнесе/ID бизнес-аккаунта

integer

MODEL

model

Информация о бизнесе/Модели работы

string

PARTNER_ID

partnerId

Информация о бизнесе/ID магазинов

integer

SHOP_NAME

shopName

Информация о бизнесе/Названия магазинов

string

INN

inn

Информация о бизнесе/ИНН

string

PLACEMENT_CONTRACT

placementContract

Информация о бизнесе/Номера договоров на размещение

string

PROMOTION_CONTRACT

promotionContract

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

string

TRANSACTION_DATE

transactionDate

Информация о платежах/Дата транзакции

string

TRANSACTION_ID

transactionId

Информация о платежах/ID транзакции

string

ORDER_ID

orderId

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

integer

SHOP_ORDER_ID

shopOrderId

Информация о платежах/Ваш номер заказа

string

ORDER_CREATION_DATE

orderCreationDate

Информация о платежах/Дата оформления заказа или акта об оказанных услугах

string

CLAIM_NUMBER

claimNumber

Информация о платежах/Номер и дата претензии

string

ORDER_TYPE

orderType

Информация о платежах/Тип заказа

string

OFFER_ID

offerId

Информация о платежах/Ваш SKU

string

OFFER_NAME

offerName

Информация о платежах/Название товара

string

COUNT

count

Информация о платежах/Количество, шт.

integer

TRANSACTION_SUM

transactionSum

Информация о платежах/Сумма транзакции

number

TRANSACTION_TYPE

transactionType

Информация о платежах/Тип транзакции

string

TRANSACTION_SOURCE

transactionSource

Информация о платежах/Источник транзакции

string

PAYMENT_STATUS

paymentStatus

Информация о платежах/Статус

string

BANK_ORDER_DATE

bankOrderDate

Информация о платежах/Дата платёжного поручения

string

BANK_ORDER_ID

bankOrderId

Информация о платежах/Номер платёжного поручения

integer

BANK_ORDER_SUM

bankOrderSum

Информация о платежах/Сумма платёжного поручения или удерживаемая за услуги сумма

number

Лист Премия за выполнение вызова (файл period_closure_outcome_benefits)

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

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

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

Тип значения

BUSINESS_ID

businessId

Информация о бизнесе/ID бизнес-аккаунта

integer

MODEL

model

Информация о бизнесе/Модели работы

string

PARTNER_ID

partnerId

Информация о бизнесе/ID магазинов

integer

SHOP_NAME

shopName

Информация о бизнесе/Названия магазинов

string

INN

inn

Информация о бизнесе/ИНН

string

PLACEMENT_CONTRACT

placementContract

Информация о бизнесе/Номера договоров на размещение

string

PROMOTION_CONTRACT

promotionContract

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

string

TRANSACTION_DATE

transactionDate

Информация о платежах/Дата транзакции

string

TRANSACTION_ID

transactionId

Информация о платежах/ID транзакции

string

ORDER_ID

orderId

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

integer

SHOP_ORDER_ID

shopOrderId

Информация о платежах/Ваш номер заказа

string

ORDER_CREATION_DATE

orderCreationDate

Информация о платежах/Дата оформления заказа или акта об оказанных услугах

string

CLAIM_NUMBER

claimNumber

Информация о платежах/Номер и дата претензии

string

ORDER_TYPE

orderType

Информация о платежах/Тип заказа

string

OFFER_ID

offerId

Информация о платежах/Ваш SKU

string

OFFER_NAME

offerName

Информация о платежах/Название товара

string

COUNT

count

Информация о платежах/Количество, шт.

integer

TRANSACTION_SUM

transactionSum

Информация о платежах/Сумма транзакции

number

TRANSACTION_TYPE

transactionType

Информация о платежах/Тип транзакции

string

TRANSACTION_SOURCE

transactionSource

Информация о платежах/Источник транзакции

string

PAYMENT_STATUS

paymentStatus

Информация о платежах/Статус

string

BANK_ORDER_DATE

bankOrderDate

Информация о платежах/Дата платёжного поручения

string

BANK_ORDER_ID

bankOrderId

Информация о платежах/Номер платёжного поручения

integer

BANK_ORDER_SUM

bankOrderSum

Информация о платежах/Сумма платёжного поручения или удерживаемая за услуги сумма

number

Лист Скидки маркетплейса на доставку (файл period_closure_outcome_delivery)

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

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

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

Тип значения

BUSINESS_ID

businessId

Информация о бизнесе/ID бизнес-аккаунта

integer

MODEL

model

Информация о бизнесе/Модели работы

string

PARTNER_ID

partnerId

Информация о бизнесе/ID магазинов

integer

SHOP_NAME

shopName

Информация о бизнесе/Названия магазинов

string

INN

inn

Информация о бизнесе/ИНН

string

PLACEMENT_CONTRACT

placementContract

Информация о бизнесе/Номера договоров на размещение

string

PROMOTION_CONTRACT

promotionContract

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

string

TRANSACTION_DATE

transactionDate

Информация о платежах/Дата транзакции

string

TRANSACTION_ID

transactionId

Информация о платежах/ID транзакции

string

ORDER_ID

orderId

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

integer

SHOP_ORDER_ID

shopOrderId

Информация о платежах/Ваш номер заказа

string

ORDER_CREATION_DATE

orderCreationDate

Информация о платежах/Дата оформления заказа или акта об оказанных услугах

string

CLAIM_NUMBER

claimNumber

Информация о платежах/Номер и дата претензии

string

ORDER_TYPE

orderType

Информация о платежах/Тип заказа

string

OFFER_ID

offerId

Информация о платежах/Ваш SKU

string

OFFER_NAME

offerName

Информация о платежах/Название товара

string

COUNT

count

Информация о платежах/Количество, шт.

integer

TRANSACTION_SUM

transactionSum

Информация о платежах/Сумма транзакции

number

TRANSACTION_TYPE

transactionType

Информация о платежах/Тип транзакции

string

TRANSACTION_SOURCE

transactionSource

Информация о платежах/Источник транзакции

string

PAYMENT_STATUS

paymentStatus

Информация о платежах/Статус

string

BANK_ORDER_DATE

bankOrderDate

Информация о платежах/Дата платёжного поручения

string

BANK_ORDER_ID

bankOrderId

Информация о платежах/Номер платёжного поручения

integer

BANK_ORDER_SUM

bankOrderSum

Информация о платежах/Сумма платёжного поручения или удерживаемая за услуги сумма

number

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

Лист Полки (файл advertiser_operations_shelf)

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

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

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

Тип значения

DATE

date

Дата

string

SUM

sum

Сумма (с НДС), ₽

number

DEDUCTED_BONUSES

deductedBonuses

Списано бонусов

number

CAMPAIGN_NAME

campaignName

Кампания

string

OPERATION_TYPE

operationType

Тип операции

string

CABINET_TYPE

cabinetType

Тип кабинета

string

CABINET_NAME

cabinetName

Название кабинета

string

Лист Буст продаж, оплата за показы (файл advertiser_operations_cpm_boost)

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

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

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

Тип значения

DATE

date

Дата

string

SUM

sum

Сумма (с НДС), ₽

number

DEDUCTED_BONUSES

deductedBonuses

Списано бонусов

number

CAMPAIGN_NAME

campaignName

Кампания

string

OPERATION_TYPE

operationType

Тип операции

string

CABINET_TYPE

cabinetType

Тип кабинета

string

CABINET_NAME

cabinetName

Название кабинета

string

Лист Буст продаж, оплата за продажи (файл advertiser_operations_cpa_auction_promotion)

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

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

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

Тип значения

DATE

date

Дата

string

SUM

sum

Сумма (с НДС), ₽

number

DEDUCTED_BONUSES

deductedBonuses

Списано бонусов

number

CAMPAIGN_NAME

campaignName

Кампания

string

OPERATION_TYPE

operationType

Тип операции

string

CABINET_TYPE

cabinetType

Тип кабинета

string

CABINET_NAME

cabinetName

Название кабинета

string

Лист Баннеры (бронирование) (файл advertiser_operations_package_banners)

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

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

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

Тип значения

DATE

date

Дата

string

SUM

sum

Сумма (с НДС), ₽

number

DEDUCTED_BONUSES

deductedBonuses

Списано бонусов

number

CAMPAIGN_NAME

campaignName

Кампания

string

OPERATION_TYPE

operationType

Тип операции

string

CABINET_TYPE

cabinetType

Тип кабинета

string

CABINET_NAME

cabinetName

Название кабинета

string

Лист Баннеры (аукцион) (файл advertiser_operations_auction_banners)

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

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

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

Тип значения

DATE

date

Дата

string

SUM

sum

Сумма (с НДС), ₽

number

DEDUCTED_BONUSES

deductedBonuses

Списано бонусов

number

CAMPAIGN_NAME

campaignName

Кампания

string

OPERATION_TYPE

operationType

Тип операции

string

CABINET_TYPE

cabinetType

Тип кабинета

string

CABINET_NAME

cabinetName

Название кабинета

string

Лист Пуши (бронирование) (файл advertiser_operations_package_pushes)

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

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

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

Тип значения

DATE

date

Дата

string

SUM

sum

Сумма (с НДС), ₽

number

CAMPAIGN_NAME

campaignName

Кампания

string

OPERATION_TYPE

operationType

Тип операции

string

CABINET_TYPE

cabinetType

Тип кабинета

string

CABINET_NAME

cabinetName

Название кабинета

string

Лист Пуши (аукцион) (файл advertiser_operations_auction_pushes)

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

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

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

Тип значения

DATE

date

Дата

string

SUM

sum

Сумма (с НДС), ₽

number

CAMPAIGN_NAME

campaignName

Кампания

string

OPERATION_TYPE

operationType

Тип операции

string

CABINET_TYPE

cabinetType

Тип кабинета

string

CABINET_NAME

cabinetName

Название кабинета

string

Лист Поп-ап уведомления (бронировани (файл advertiser_operations_package_popups)

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

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

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

Тип значения

DATE

date

Дата

string

SUM

sum

Сумма (с НДС), ₽

number

CAMPAIGN_NAME

campaignName

Кампания

string

OPERATION_TYPE

operationType

Тип операции

string

CABINET_TYPE

cabinetType

Тип кабинета

string

CABINET_NAME

cabinetName

Название кабинета

string

Лист Поп-ап уведомления (аукцион) (файл advertiser_operations_auction_popups)

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

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

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

Тип значения

DATE

date

Дата

string

SUM

sum

Сумма (с НДС), ₽

number

CAMPAIGN_NAME

campaignName

Кампания

string

OPERATION_TYPE

operationType

Тип операции

string

CABINET_TYPE

cabinetType

Тип кабинета

string

CABINET_NAME

cabinetName

Название кабинета

string

Лист Полки с оплатой по дням (файл advertiser_operations_cpd_promotion)

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

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

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

Тип значения

DATE

date

Дата

string

SUM

sum

Сумма (с НДС), ₽

number

CAMPAIGN_NAME

campaignName

Кампания

string

OPERATION_TYPE

operationType

Тип операции

string

CABINET_TYPE

cabinetType

Тип кабинета

string

CABINET_NAME

cabinetName

Название кабинета

string

Лист Рекламно-информационные материа (файл advertiser_operations_marketing_promo_yandex_market)

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

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

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

Тип значения

DATE

date

Дата

string

SUM

sum

Сумма (с НДС), ₽

number

SERVICE_TYPE

serviceType

Тип услуги

string

CAMPAIGN_NAME

campaignName

Кампания

string

OPERATION_TYPE

operationType

Тип операции

string

CABINET_TYPE

cabinetType

Тип кабинета

string

CABINET_NAME

cabinetName

Название кабинета

string

Лист Реклама на внешних площадках (файл advertiser_operations_marketing_promo_web)

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

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

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

Тип значения

DATE

date

Дата

string

SUM

sum

Сумма (с НДС), ₽

number

SERVICE_TYPE

serviceType

Тип услуги

string

CAMPAIGN_NAME

campaignName

Кампания

string

OPERATION_TYPE

operationType

Тип операции

string

CABINET_TYPE

cabinetType

Тип кабинета

string

CABINET_NAME

cabinetName

Название кабинета

string

Лист ТВ реклама (файл advertiser_operations_marketing_promo_tv)

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

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

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

Тип значения

DATE

date

Дата

string

SUM

sum

Сумма (с НДС), ₽

number

SERVICE_TYPE

serviceType

Тип услуги

string

CAMPAIGN_NAME

campaignName

Кампания

string

OPERATION_TYPE

operationType

Тип операции

string

CABINET_TYPE

cabinetType

Тип кабинета

string

CABINET_NAME

cabinetName

Название кабинета

string

Лист Информационная рассылка по зада (файл advertiser_operations_marketing_promo_mailing)

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

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

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

Тип значения

DATE

date

Дата

string

SUM

sum

Сумма (с НДС), ₽

number

SERVICE_TYPE

serviceType

Тип услуги

string

CAMPAIGN_NAME

campaignName

Кампания

string

OPERATION_TYPE

operationType

Тип операции

string

CABINET_TYPE

cabinetType

Тип кабинета

string

CABINET_NAME

cabinetName

Название кабинета

string

Лист Организация и проведение маркет (файл advertiser_operations_marketing_promo_for_sales)

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

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

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

Тип значения

DATE

date

Дата

string

SUM

sum

Сумма (с НДС), ₽

number

SERVICE_TYPE

serviceType

Тип услуги

string

CAMPAIGN_NAME

campaignName

Кампания

string

OPERATION_TYPE

operationType

Тип операции

string

CABINET_TYPE

cabinetType

Тип кабинета

string

CABINET_NAME

cabinetName

Название кабинета

string

Лист Специальные размещения (файл advertiser_operations_marketing_promo_adfox)

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

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

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

Тип значения

DATE

date

Дата

string

SUM

sum

Сумма (с НДС), ₽

number

SERVICE_TYPE

serviceType

Тип услуги

string

CAMPAIGN_NAME

campaignName

Кампания

string

OPERATION_TYPE

operationType

Тип операции

string

CABINET_TYPE

cabinetType

Тип кабинета

string

CABINET_NAME

cabinetName

Название кабинета

string

Лист Отзывы за баллы (файл advertiser_operations_paid_opinion)

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

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

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

Тип значения

DATE

date

Дата

string

SUM

sum

Сумма (с НДС), ₽

number

BRAND

brand

Бренд

string

CATEGORY

category

Категория

string

MODEL

model

Товар

string

MARKET_URL

marketUrl

Ссылка на Маркет

string

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

Request

POST

https://api.partner.market.yandex.ru/reports/closure-documents/detalization/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,
    "monthOfYear": {
        "year": 2025,
        "month": 12
    },
    "contractType": "INCOME"
}

Name

Description

campaignId*

Type: integer<int64>

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

Его можно узнать с помощью запроса GET campaigns или найти в кабинете продавца на Маркете — нажмите на название своего бизнеса и перейдите на страницу:

  • Модули и API → блок Передача данных Маркету.
  • Лог запросов → выпадающий список в блоке Показывать логи.

⚠️ Не передавайте вместо него идентификатор магазина, который указан в кабинете продавца на Маркете рядом с названием магазина и в некоторых отчетах.

contractType*

Type: ClosureDocumentsContractType

Тип договора:

  • INCOME — договор на размещение.

  • OUTCOME — договор на продвижение.

  • MARKETING — договор на маркетинг.

Enum: INCOME, OUTCOME, MARKETING

monthOfYear*

Type: ClosureDocumentsMonthOfYearDTO

Месяц, за который сформированы необходимые закрывающие документы.

ClosureDocumentsContractType

Тип договора:

  • INCOME — договор на размещение.

  • OUTCOME — договор на продвижение.

  • MARKETING — договор на маркетинг.

Type

Description

ClosureDocumentsContractType

Enum: INCOME, OUTCOME, MARKETING

ClosureDocumentsMonthOfYearDTO

Месяц и год.

Name

Description

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

No longer supported, please use an alternative and newer version.