报告的结构及内容如有更改,恕不另行通知。
例如,可以添加新列或更改工作表的名称。
关于与结束文件趋同的报告
方法适用于模式:FBY, FBS, Express 和 DBS.
如果您使用API-Key令牌,调用该方法时需要具备列表中可用权限之一
- finance-and-accounting — 查看财务信息和报告
- all-methods — 全面管理账户
- all-methods:read-only — 查看所有数据
根据合同的类型,开始生成收敛报告和结束文件。
您可以使用请求查找生成状态并获取指向已完成报告的链接。 GET v2/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 |
企业信息/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 |
企业信息/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 |
企业信息/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 |
企业信息/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 |
表单为 Yandex Market 服务预扣(文件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 |
企业信息/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 |
企业信息/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 |
表单Yandex Market 的补偿(文件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 |
企业信息/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 |
企业信息/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 |
企业信息/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 |
企业信息/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 |
企业信息/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 |
企业信息/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 |
表单Yandex Plus 积分(文件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 |
企业信息/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 |
企业信息/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 |
企业信息/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/v2/reports/closure-documents/detalization/generate
Query parameters
|
Name |
Description |
|
format |
Type: ReportFormatType 报告或文档的格式。 |
ReportFormatType
报告格式:
FILE— 电子表格文件(XLSX).CSV— 每个报告表都有一个包含CSV文件的ZIP存档。JSON— 每个报告表都有一个带有JSON文件的ZIP压缩包.
|
Type |
Description |
|
Default: Enum: |
Body
application/json
{
"campaignId": 0,
"monthOfYear": {
"year": 2025,
"month": 12
},
"contractType": "INCOME"
}
|
Name |
Description |
|
campaignId* |
Type: integer<int64> 活动ID。 您可以使用查询找到它 GET v2/campaigns 或者在市场上的卖家办公室找到 — 点击您的帐户图标→ 设置 在左边的菜单中,选择 Api和模块:
⚠️ 不要发送商店ID,这是在市场上的卖家帐户旁边的商店名称和一些报告。 |
|
contractType* |
Type: ClosureDocumentsContractType 协议类型:
Enum: |
|
monthOfYear* |
Type: ClosureDocumentsMonthOfYearDTO Месяц, за который сформированы необходимые закрывающие документы. |
ClosureDocumentsContractType
协议类型:
-
INCOME— 的住宿协议。 -
OUTCOME— 的推广协议。 -
MARKETING— 一份营销合同。
|
Type |
Description |
|
Enum: |
ClosureDocumentsMonthOfYearDTO
月份和年份。
|
Name |
Description |
|
month* |
Type: integer<int32> 月号。 Example: Min value: Max value: |
|
year* |
Type: integer<int32> 年。 Example: |
Responses
200 OK
作为响应,您会收到一个标识符,该标识符允许您查找生成状态并下载完成的报告。
Body
application/json
{
"status": "OK",
"result": {
"reportId": "string",
"estimatedGenerationTime": 0
}
}
|
Name |
Description |
|
status* |
Type: ApiResponseStatusType 响应的类型。 可能的值:
Enum: |
|
result |
Type: GenerateReportDTO 跟踪生成状态和接收完成的报告或文档所需的ID。 |
ApiResponseStatusType
响应的类型。 可能的值:
OK— 没有错误。ERROR— 处理请求时出错。
|
Type |
Description |
|
Enum: |
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: |
|
status |
Type: ApiResponseStatusType 响应的类型。 可能的值:
Enum: |
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: |
|
status |
Type: ApiResponseStatusType 响应的类型。 可能的值:
Enum: |
403 Forbidden
授权数据不正确或禁止访问资源。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: ApiErrorDTO[] 错误列表。 Min items: |
|
status |
Type: ApiResponseStatusType 响应的类型。 可能的值:
Enum: |
420 Method Failure
已超出资源访问限制。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: ApiErrorDTO[] 错误列表。 Min items: |
|
status |
Type: ApiResponseStatusType 响应的类型。 可能的值:
Enum: |
500 Internal Server Error
市场的内部错误。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: ApiErrorDTO[] 错误列表。 Min items: |
|
status |
Type: ApiResponseStatusType 响应的类型。 可能的值:
Enum: |
No longer supported, please use an alternative and newer version.