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

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

Отчет по заказам

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

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

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

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

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

Лист Транзакции по заказам и товарам (файл orders_and_offers_transactions)

Название колонки в 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

ORDER_ID

orderId

Информация о заказах/Номер заказа

integer

PARTNER_ORDER_ID

partnerOrderId

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

string

CREATION_DATE

creationDate

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

string

ORDER_TYPE

orderType

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

string

SHOP_SKU

shopSku

Информация о заказах/Ваш SKU

string

OFFER_NAME

offerName

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

string

PARTNER_PRICE_FOR_DELIVERY

partnerPriceForDelivery

Информация о заказах/Ваша цена (за шт.)

number

BILLING_PRICE

billingPrice

Информация о заказах/Цена продажи (за шт.)

number

COFINANCE_TRESHOLD

cofinanceTreshold

Информация о заказах/Ваш порог снижения цены для участия в софинансировании на момент оформления заказа (за шт.)

number

COFINANCE_VALUE

cofinanceValue

Информация о заказах/Ваша скидка, если товар участвовал в софинансировании (за шт.)

number

COFINANCE_SUBSIDY

cofinanceSubsidy

Информация о заказах/Скидка Маркета, если товар участвовал в софинансировании

number

MARKETPLACE_SUBSIDY

marketplaceSubsidy

Информация о заказах/Другие скидки Маркета

number

SPASIBO

spasibo

Информация о заказах/Оплата бонусами СберСпасибо (за шт.)

number

YANDEX_PLUS

yandexPlus

Информация о заказах/Оплата баллами Яндекс Плюса (за шт.)

number

TRANSFERRED_FOR_DELIVERY

transferredForDelivery

Информация о заказах/Передано в доставку

integer

DELIVERED_OR_RETURNED

deliveredOrReturned

Информация о заказах/Доставлено или возвращено

integer

DELIVERY_DATE

deliveryDate

Информация о заказах/Дата доставки заказа

string

OFFER_STATUS

offerStatus

Информация о заказах/Статус товара

string

STATUS_CHANGED

statusChanged

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

string

PAYMENT_TYPE

paymentType

Информация о заказах/Способ оплаты

string

SHIPMENT_WAREHOUSE

shipmentWarehouse

Информация о заказах/Склад отгрузки

string

SHIPMENT_DATE

shipmentDate

Информация о заказах/Дата отгрузки

string

DELIVERY_REGION

deliveryRegion

Информация о заказах/Регион доставки

string

BUYER_PAYMENT_AMOUNT

buyerPaymentAmount

Платёж покупателя/Сумма платежа

number

BUYER_PAYMENT_BANK_ORDER_ID

buyerPaymentBankOrderId

Платёж покупателя/Номер платежного поручения

string

BUYER_PAYMENT_BANK_ORDER_DATE

buyerPaymentBankOrderDate

Платёж покупателя/Дата платежного поручения

string

BUYER_PAYMENT_ID

buyerPaymentId

Платёж покупателя/Идентификатор платежа

string

BUYER_PAYMENT_HANDLING_TIME

buyerPaymentHandlingTime

Платёж покупателя/Дата реестра платежей

string

MARKETPLACE_DISCOUNT_PAYMENT_AMOUNT

marketplaceDiscountPaymentAmount

Платёж за скидку Маркета/Сумма платежа

number

MARKETPLACE_DISCOUNT_PAYMENT_BANK_ORDER_ID

marketplaceDiscountPaymentBankOrderId

Платёж за скидку Маркета/Номер платежного поручения

string

MARKETPLACE_DISCOUNT_PAYMENT_BANK_ORDER_DATE

marketplaceDiscountPaymentBankOrderDate

Платёж за скидку Маркета/Дата платежного поручения

string

MARKETPLACE_DISCOUNT_PAYMENT_ID

marketplaceDiscountPaymentId

Платёж за скидку Маркета/Идентификатор платежа

string

MARKETPLACE_DISCOUNT_PAYMENT_HANDLING_TIME

marketplaceDiscountPaymentHandlingTime

Платёж за скидку Маркета/Дата реестра платежей

string

SPASIBO_PAYMENT_AMOUNT

spasiboPaymentAmount

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

number

SPASIBO_PAYMENT_BANK_ORDER_ID

spasiboPaymentBankOrderId

Платёж за скидку по бонусам СберСпасибо/Номер платежного поручения

string

SPASIBO_PAYMENT_BANK_ORDER_DATE

spasiboPaymentBankOrderDate

Платёж за скидку по бонусам СберСпасибо/Дата платежного поручения

string

SPASIBO_PAYMENT_ID

spasiboPaymentId

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

string

SPASIBO_PAYMENT_HANDLING_TIME

spasiboPaymentHandlingTime

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

string

YANDEX_PLUS_PAYMENT_AMOUNT

yandexPlusPaymentAmount

Платёж за скидку Яндекс Плюс/Сумма платежа

number

YANDEX_PLUS_PAYMENT_BANK_ORDER_ID

yandexPlusPaymentBankOrderId

Платёж за скидку Яндекс Плюс/Номер платежного поручения

string

YANDEX_PLUS_PAYMENT_BANK_ORDER_DATE

yandexPlusPaymentBankOrderDate

Платёж за скидку Яндекс Плюс/Дата платежного поручения

string

YANDEX_PLUS_PAYMENT_ID

yandexPlusPaymentId

Платёж за скидку Яндекс Плюс/Идентификатор платежа

string

YANDEX_PLUS_PAYMENT_HANDLING_TIME

yandexPlusPaymentHandlingTime

Платёж за скидку Яндекс Плюс/Дата реестра платежей

string

REFUND_BUYER_PAYMENT_AMOUNT

refundBuyerPaymentAmount

Возврат платежа покупателя/Сумма возврата

number

REFUND_BUYER_PAYMENT_BANK_ORDER_ID

refundBuyerPaymentBankOrderId

Возврат платежа покупателя/Номер платежного поручения

string

REFUND_BUYER_PAYMENT_BANK_ORDER_DATE

refundBuyerPaymentBankOrderDate

Возврат платежа покупателя/Дата платежного поручения

string

REFUND_BUYER_PAYMENT_ID

refundBuyerPaymentId

Возврат платежа покупателя/Идентификатор платежа

string

REFUND_BUYER_PAYMENT_HANDLING_TIME

refundBuyerPaymentHandlingTime

Возврат платежа покупателя/Дата реестра платежей

string

REFUND_MARKETPLACE_DISCOUNT_PAYMENT_AMOUNT

refundMarketplaceDiscountPaymentAmount

Возврат платежа за скидку Маркета/Сумма возврата

number

REFUND_MARKETPLACE_DISCOUNT_PAYMENT_BANK_ORDER_ID

refundMarketplaceDiscountPaymentBankOrderId

Возврат платежа за скидку Маркета/Номер платежного поручения

string

REFUND_MARKETPLACE_DISCOUNT_PAYMENT_BANK_ORDER_DATE

refundMarketplaceDiscountPaymentBankOrderDate

Возврат платежа за скидку Маркета/Дата платежного поручения

string

REFUND_MARKETPLACE_DISCOUNT_PAYMENT_ID

refundMarketplaceDiscountPaymentId

Возврат платежа за скидку Маркета/Идентификатор платежа

string

REFUND_MARKETPLACE_DISCOUNT_PAYMENT_HANDLING_TIME

refundMarketplaceDiscountPaymentHandlingTime

Возврат платежа за скидку Маркета/Дата реестра платежей

string

REFUND_SPASIBO_PAYMENT_AMOUNT

refundSpasiboPaymentAmount

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

number

REFUND_SPASIBO_PAYMENT_BANK_ORDER_ID

refundSpasiboPaymentBankOrderId

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

string

REFUND_SPASIBO_PAYMENT_BANK_ORDER_DATE

refundSpasiboPaymentBankOrderDate

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

string

REFUND_SPASIBO_PAYMENT_ID

refundSpasiboPaymentId

Возврат платежа за скидку по бонусам СберСпасибо/Идентификатор платежа

string

REFUND_SPASIBO_PAYMENT_HANDLING_TIME

refundSpasiboPaymentHandlingTime

Возврат платежа за скидку по бонусам СберСпасибо/Дата реестра платежей

string

REFUND_YANDEX_PLUS_PAYMENT_AMOUNT

refundYandexPlusPaymentAmount

Возврат платежа за скидку Яндекс Плюс/Сумма возврата

number

REFUND_YANDEX_PLUS_PAYMENT_BANK_ORDER_ID

refundYandexPlusPaymentBankOrderId

Возврат платежа за скидку Яндекс Плюс/Номер платежного поручения

string

REFUND_YANDEX_PLUS_PAYMENT_BANK_ORDER_DATE

refundYandexPlusPaymentBankOrderDate

Возврат платежа за скидку Яндекс Плюс/Дата платежного поручения

string

REFUND_YANDEX_PLUS_PAYMENT_ID

refundYandexPlusPaymentId

Возврат платежа за скидку Яндекс Плюс/Идентификатор платежа

string

REFUND_YANDEX_PLUS_PAYMENT_HANDLING_TIME

refundYandexPlusPaymentHandlingTime

Возврат платежа за скидку Яндекс Плюс/Дата реестра платежей

string

DEFECT_REFUND_PAYMENT_AMOUNT

defectRefundPaymentAmount

Выплата расходов покупателю при возврате товара ненадлежащего качества/Удержанная сумма

number

DEFECT_REFUND_PAYMENT_BANK_ORDER_ID

defectRefundPaymentBankOrderId

Выплата расходов покупателю при возврате товара ненадлежащего качества/Номер платежного поручения

string

DEFECT_REFUND_PAYMENT_BANK_ORDER_DATE

defectRefundPaymentBankOrderDate

Выплата расходов покупателю при возврате товара ненадлежащего качества/Дата платежного поручения

string

DEFECT_REFUND_PAYMENT_ID

defectRefundPaymentId

Выплата расходов покупателю при возврате товара ненадлежащего качества/Идентификатор платежа

string

DEFECT_REFUND_PAYMENT_HANDLING_TIME

defectRefundPaymentHandlingTime

Выплата расходов покупателю при возврате товара ненадлежащего качества/Дата реестра платежей

string

NETTING_AMOUNT

nettingAmount

Баллы за скидки Маркета и скидки Яндекс Плюс/Сумма баллов

number

NETTING_TRANSACTION_STATUS

nettingTransactionStatus

Баллы за скидки Маркета и скидки Яндекс Плюс/Статус (справочно)

string

Лист Услуги и маржа по заказам (файл services_and_orders_margin)

Название колонки в 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

ORDER_ID

orderId

Информация о заказах/Номер заказа

integer

PARTNER_ORDER_ID

partnerOrderId

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

string

ORDER_STATUS

orderStatus

Информация о заказах/Статус заказа

string

CREATION_DATE

creationDate

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

string

ORDER_TYPE

orderType

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

string

SUMMARY_COMMISSION

summaryCommission

Информация по денежным средствам/Все услуги Маркета за заказы

number

SUM_BILLING_PRICE_OF_ITEMS

sumBillingPriceOfItems

Информация по денежным средствам/Цена продажи (за шт.)

number

INCOME_WITHOUT_SERVICES

incomeWithoutServices

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

number

BUYER_PAYMENT

buyerPayment

Информация по денежным средствам/Платёж покупателя, не включает скидки Маркета и баллы Плюса

number

BUYER_PAYMENT_STATUS

buyerPaymentStatus

Информация по денежным средствам/Статус платежа покупателя

string

BANK_ORDER_ID

bankOrderId

Информация по денежным средствам/Номер платежного поручения

string

SALE_COMMISSION

saleCommission

Информация по услугам/Размещение товаров на витрине

number

WAREHOUSE_PROCESSING

warehouseProcessing

Информация по услугам/Складская обработка

number

LOYALTY_PROGRAM

loyaltyProgram

Информация по услугам/Участие в программе лояльности

number

BOOST

boost

Информация по услугам/Буст продаж

number

INSTALLMENT

installment

Информация по услугам/Рассрочка

number

BUYER_DELIVERY

buyerDelivery

Информация по услугам/Доставка покупателю

number

BUYER_EXPRESS_DELIVERY

buyerExpressDelivery

Информация по услугам/Экспресс-доставка покупателю

number

BUYER_PAYMENT_ACCEPT

buyerPaymentAccept

Информация по услугам/Приём платежа покупателя

number

BUYER_PAYMENT_TRANSFER

buyerPaymentTransfer

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

number

ORDER_PROCESSING

orderProcessing

Информация по услугам/Обработка заказа

number

RESUPPLY_HANDLING

resupplyHandling

Информация по услугам/Хранение невыкупов и возвратов

number

RETURN_RESUPPLY

returnResupply

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

number

ORDER_INTAKE

orderIntake

Информация по услугам/Организация забора заказов

number

EXPROPRIATION_RESALE

expropriationResale

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

number

Лист Заказы с умн.ценообразованием (файл services_with_decoupling)

Название колонки в 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

ORDER_ID

orderId

Информация о заказах/Номер заказа

integer

SHOP_ORDER_ID

shopOrderId

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

string

ORDER_STATUS

orderStatus

Информация о заказах/Статус заказа

string

CREATION_DATE

creationDate

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

string

ORDER_TYPE

orderType

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

string

SHOP_SKU

shopSku

Информация о заказах/Ваш SKU

string

OFFER_NAME

offerName

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

string

COUNT

count

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

integer

SHOP_PRICE

shopPrice

Информация по денежным средствам/Ваша цена (за шт.)

number

SELLING_PRICE

sellingPrice

Информация по денежным средствам/Цена продажи (за шт.)

number

BUYER_PAYMENT

buyerPayment

Информация по денежным средствам/Платёж покупателя, не включает скидки Маркета и баллы Плюса

number

EXTRA_INCOME

extraIncome

Информация по денежным средствам/Разница между вашей ценой и ценой продажи

number

SUMMARY_COMMISSION

summaryCommission

Информация по денежным средствам/Все услуги Маркета за заказы

number

INCOME_WITHOUT_SERVICES

incomeWithoutServices

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

number

EXTRA_DECOUPLING_MARGIN

extraDecouplingMargin

Информация по денежным средствам/Доп.выручка от умного предложения

number

NET_DECOUPLING_GAIN

netDecouplingGain

Информация по денежным средствам/Доп. доход от умного предложения

number

SALE_COMMISSION

saleCommission

Информация по услугам/Размещение товаров на витрине

number

EXTRA_DECOUPLING_SALE_COMMISSION

extraDecouplingSaleCommission

Информация по услугам/Умное предложение (доп.тариф на размещение)

number

WAREHOUSE_HANDLING

warehouseHandling

Информация по услугам/Складская обработка

number

LOYALTY_PROGRAM

loyaltyProgram

Информация по услугам/Участие в программе лояльности

number

BOOST

boost

Информация по услугам/Буст продаж

number

INSTALLMENT

installment

Информация по услугам/Рассрочка

number

DELIVERY

delivery

Информация по услугам/Доставка покупателю

number

EXPRESS_DELIVERY

expressDelivery

Информация по услугам/Экспресс-доставка покупателю

number

PAYMENT_ACCEPTING

paymentAccepting

Информация по услугам/Приём платежа покупателя

number

PAYMENT_TRANSFER

paymentTransfer

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

number

ORDER_PROCESSING

orderProcessing

Информация по услугам/Обработка заказа

number

RESUPPLY_STORAGE

resupplyStorage

Информация по услугам/Хранение невыкупов и возвратов

number

RESUPPLY_RETURN

resupplyReturn

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

number

ORDER_INTAKE

orderIntake

Информация по услугам/Организация забора заказов

number

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

Request

POST

https://api.partner.market.yandex.ru/reports/united-orders/generate

Query parameters

Name

Description

format

Type: ReportFormatType

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

language

Type: ReportLanguageType

Язык отчета.

ReportFormatType

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

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

Type

Description

ReportFormatType

Default: FILE

Enum: FILE, CSV, JSON

ReportLanguageType

Язык отчета:

  • RU — русский язык.
  • EN — английский язык.

Type

Description

ReportLanguageType

Enum: RU, EN

Body

application/json
{
    "businessId": 0,
    "dateFrom": "string",
    "dateTo": "string",
    "campaignIds": [
        0
    ],
    "promoId": "string"
}

Name

Description

businessId*

Type: integer<int64>

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

dateFrom*

Type: string<date>

Начало периода, включительно.

dateTo*

Type: string<date>

Конец периода, включительно. Максимальный период — 1 год.

campaignIds

Type: integer<int64>[]

Список магазинов, которые нужны в отчете.

Min items: 1

promoId

Type: string

Идентификатор акции, товары из которой нужны в отчете.

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