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

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

订单报告

方法适用于所有模式.

如果您使用API-Key令牌,调用该方法时需要具备列表中可用权限之一

开始生成指定期间的订单报告。 这是什么报告

您可以使用请求查找生成状态并获取指向已完成报告的链接。 GET v2/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

企业信息/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

订单信息/Yandex Market 折扣,如果商品为共同出资

number

MARKETPLACE_SUBSIDY

marketplaceSubsidy

订单信息/其他市场折扣(每件)

number

SPASIBO

spasibo

订单信息/以 Sberbank 奖金付款(每件)

number

YANDEX_PLUS

yandexPlus

订单信息/通过 Yandex Plus 积分付款(每件)

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

买家付款/付款 ID

string

BUYER_PAYMENT_HANDLING_TIME

buyerPaymentHandlingTime

买家付款/付款登记日期

string

MARKETPLACE_DISCOUNT_PAYMENT_AMOUNT

marketplaceDiscountPaymentAmount

Yandex Market 折扣付款/付款金额

number

MARKETPLACE_DISCOUNT_PAYMENT_BANK_ORDER_ID

marketplaceDiscountPaymentBankOrderId

Yandex Market 折扣付款/付款订单号

string

MARKETPLACE_DISCOUNT_PAYMENT_BANK_ORDER_DATE

marketplaceDiscountPaymentBankOrderDate

Yandex Market 折扣付款/付款订单日期

string

MARKETPLACE_DISCOUNT_PAYMENT_ID

marketplaceDiscountPaymentId

Yandex Market 折扣付款/付款 ID

string

MARKETPLACE_DISCOUNT_PAYMENT_HANDLING_TIME

marketplaceDiscountPaymentHandlingTime

Yandex Market 折扣付款/付款登记日期

string

SPASIBO_PAYMENT_AMOUNT

spasiboPaymentAmount

用 SberSpasibo 积分支付折扣/付款金额

number

SPASIBO_PAYMENT_BANK_ORDER_ID

spasiboPaymentBankOrderId

用 SberSpasibo 积分支付折扣/付款订单号

string

SPASIBO_PAYMENT_BANK_ORDER_DATE

spasiboPaymentBankOrderDate

用 SberSpasibo 积分支付折扣/付款订单日期

string

SPASIBO_PAYMENT_ID

spasiboPaymentId

用 SberSpasibo 积分支付折扣/付款 ID

string

SPASIBO_PAYMENT_HANDLING_TIME

spasiboPaymentHandlingTime

用 SberSpasibo 积分支付折扣/付款登记日期

string

YANDEX_PLUS_PAYMENT_AMOUNT

yandexPlusPaymentAmount

Yandex Plus 折扣付款/付款金额

number

YANDEX_PLUS_PAYMENT_BANK_ORDER_ID

yandexPlusPaymentBankOrderId

Yandex Plus 折扣付款/付款订单号

string

YANDEX_PLUS_PAYMENT_BANK_ORDER_DATE

yandexPlusPaymentBankOrderDate

Yandex Plus 折扣付款/付款订单日期

string

YANDEX_PLUS_PAYMENT_ID

yandexPlusPaymentId

Yandex Plus 折扣付款/付款 ID

string

YANDEX_PLUS_PAYMENT_HANDLING_TIME

yandexPlusPaymentHandlingTime

Yandex Plus 折扣付款/付款登记日期

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

退回买家付款/付款 ID

string

REFUND_BUYER_PAYMENT_HANDLING_TIME

refundBuyerPaymentHandlingTime

退回买家付款/付款登记日期

string

REFUND_MARKETPLACE_DISCOUNT_PAYMENT_AMOUNT

refundMarketplaceDiscountPaymentAmount

退回 Yandex Market 折扣付款/退款金额

number

REFUND_MARKETPLACE_DISCOUNT_PAYMENT_BANK_ORDER_ID

refundMarketplaceDiscountPaymentBankOrderId

退回 Yandex Market 折扣付款/付款订单号

string

REFUND_MARKETPLACE_DISCOUNT_PAYMENT_BANK_ORDER_DATE

refundMarketplaceDiscountPaymentBankOrderDate

退回 Yandex Market 折扣付款/付款订单日期

string

REFUND_MARKETPLACE_DISCOUNT_PAYMENT_ID

refundMarketplaceDiscountPaymentId

退回 Yandex Market 折扣付款/付款 ID

string

REFUND_MARKETPLACE_DISCOUNT_PAYMENT_HANDLING_TIME

refundMarketplaceDiscountPaymentHandlingTime

退回 Yandex Market 折扣付款/付款登记日期

string

REFUND_SPASIBO_PAYMENT_AMOUNT

refundSpasiboPaymentAmount

退回使用 SberSpasibo 积分支付的折扣付款/退款金额

number

REFUND_SPASIBO_PAYMENT_BANK_ORDER_ID

refundSpasiboPaymentBankOrderId

退回使用 SberSpasibo 积分支付的折扣付款/付款订单号

string

REFUND_SPASIBO_PAYMENT_BANK_ORDER_DATE

refundSpasiboPaymentBankOrderDate

退回使用 SberSpasibo 积分支付的折扣付款/付款订单日期

string

REFUND_SPASIBO_PAYMENT_ID

refundSpasiboPaymentId

退回使用 SberSpasibo 积分支付的折扣付款/付款 ID

string

REFUND_SPASIBO_PAYMENT_HANDLING_TIME

refundSpasiboPaymentHandlingTime

退回使用 SberSpasibo 积分支付的折扣付款/付款登记日期

string

REFUND_YANDEX_PLUS_PAYMENT_AMOUNT

refundYandexPlusPaymentAmount

退回 Yandex Plus 折扣付款/退款金额

number

REFUND_YANDEX_PLUS_PAYMENT_BANK_ORDER_ID

refundYandexPlusPaymentBankOrderId

退回 Yandex Plus 折扣付款/付款订单号

string

REFUND_YANDEX_PLUS_PAYMENT_BANK_ORDER_DATE

refundYandexPlusPaymentBankOrderDate

退回 Yandex Plus 折扣付款/付款订单日期

string

REFUND_YANDEX_PLUS_PAYMENT_ID

refundYandexPlusPaymentId

退回 Yandex Plus 折扣付款/付款 ID

string

REFUND_YANDEX_PLUS_PAYMENT_HANDLING_TIME

refundYandexPlusPaymentHandlingTime

退回 Yandex Plus 折扣付款/付款登记日期

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

如果质量不符合标准的产品被退回,向买家偿还费用/付款 ID

string

DEFECT_REFUND_PAYMENT_HANDLING_TIME

defectRefundPaymentHandlingTime

如果质量不符合标准的产品被退回,向买家偿还费用/付款登记日期

string

NETTING_AMOUNT

nettingAmount

Market折扣和Yandex Plus折扣的积分/总积分

number

NETTING_TRANSACTION_STATUS

nettingTransactionStatus

Market折扣和Yandex Plus折扣的积分/状态(参考)

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

企业信息/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

资金信息/订单的所有 Yandex Market 服务

number

SUM_BILLING_PRICE_OF_ITEMS

sumBillingPriceOfItems

资金信息/销售价格(每件)

number

INCOME_WITHOUT_SERVICES

incomeWithoutServices

资金信息/扣除 Yandex Market 服务后的收入

number

BUYER_PAYMENT

buyerPayment

资金信息/买家付款,不包括 Yandex Market 折扣和 Plus 积分

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

企业信息/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

资金信息/买家付款,不包括 Yandex Market 折扣和 Plus 积分

number

EXTRA_INCOME

extraIncome

资金信息/您的价格与销售价格之间的差额

number

SUMMARY_COMMISSION

summaryCommission

资金信息/订单的所有 Yandex Market 服务

number

INCOME_WITHOUT_SERVICES

incomeWithoutServices

资金信息/扣除 Yandex Market 服务后的收入

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/v2/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>

内阁ID。

dateFrom*

Type: string<date>

期的开始,包括在内。

dateTo*

Type: string<date>

期结束,包括在内。 最长期限为1年。

campaignIds

Type: integer<int64>[]

报表中需要的那些商店的营销活动Id列表。

您可以使用查询找到它们 GET v2/campaigns 或者在市场上的卖家办公室找到它-点击您的企业名称并转到页面:

  • 模块和 API→区块 向Yandex发送数据。街市.
  • 查询日志 →块中的下拉列表 显示日志.

请勿使用商店Id,这些Id列在商店名称旁边的市场上的卖家帐户和某些报告中。

Min items: 1

Unique items  

promoId

Type: string

报告中需要来自产品的促销的ID。

Responses

200 OK

作为响应,您会收到一个标识符,该标识符允许您查找生成状态并下载完成的报告。

Body

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

Name

Description

status*

Type: ApiResponseStatusType

响应的类型。 可能的值:

  • OK -没有错误。
  • ERROR -处理请求时发生错误。

Enum: OK, ERROR

result

Type: GenerateReportDTO

跟踪生成状态和接收完成的报告或文档所需的ID。

ApiResponseStatusType

响应的类型。 可能的值:

  • OK -没有错误。
  • ERROR -处理请求时发生错误。

Type

Description

ApiResponseStatusType

Enum: OK, ERROR

GenerateReportDTO

跟踪生成状态和接收完成的报告或文档所需的ID。

Name

Description

estimatedGenerationTime*

Type: integer<int64>

以毫秒为单位的预期生成时间。

reportId*

Type: string

跟踪生成状态和接收完成的报告或文档所需的ID。

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

Yandex中的内部错误。 市场。 有关错误的更多信息

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.