获取给定的报告或文档

Info

Console

方法适用于模式：FBY, FBS, Express 和 DBS.

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

inventory-and-order-processing — 订单处理和商品核算
inventory-and-order-processing:read-only — 查看订单信息
pricing — 价格管理
pricing:read-only — 查看价格
offers-and-cards-management — 商品和卡片管理
offers-and-cards-management:read-only — 查看商品和卡片
promotion — 商品推广
promotion:read-only — 查看商品推广信息
finance-and-accounting — 查看财务信息和报告
communication — 与买家沟通
settings-management — 店铺设置
supplies-management:read-only — 获取有关FBY应用程序的信息
all-methods — 全面管理账户
all-methods:read-only — 查看所有数据

返回指定报告或文档的生成状态，如果已准备就绪，则返回下载链接。

要使用此请求，您首先需要开始生成报告或文档。指示手册

⚙️ 限制: 每分钟100个请求

Request

GET

https://api.partner.market.yandex.ru/v2/reports/info/{reportId}

Path parameters

Name

Description

reportId*

Type: string

生成后收到的报告或文档的ID。

Min length: 1

Max length: 255

Responses

200 OK

报表或文档生成的状态以及链接（如果已存在）。

生成状态 FAILED 或 NO_DATA

检查生成请求的正确性。例如，广告系列ID、期间或付款订单号是否正确。

Body

application/json

{
    "status": "OK",
    "result": {
        "status": "PENDING",
        "subStatus": "NO_DATA",
        "generationRequestedAt": "2022-12-29T18:02:01Z",
        "generationFinishedAt": "2022-12-29T18:02:01Z",
        "file": "string",
        "estimatedGenerationTime": 0
    }
}

Name

Description

status*

Type: ApiResponseStatusType

响应的类型。可能的值:

OK — 没有错误。
ERROR — 处理请求时出错。

Enum: OK, ERROR

result

Type: ReportInfoDTO

生成状态以及指向已完成报告或文档的链接。

ApiResponseStatusType

响应的类型。可能的值:

OK — 没有错误。
ERROR — 处理请求时出错。

Type	Description
ApiResponseStatusType	Enum: `OK`, `ERROR`

ReportInfoDTO

生成状态以及指向已完成报告或文档的链接。

Name	Description
generationRequestedAt*	Type: string<date-time> 生成请求的日期和时间。
status*	Type: ReportStatusType 生成状态: `PENDING` — 等待一代人。 `PROCESSING` — 产生的。 `FAILED` — 生成期间发生错误。 `DONE` — 报告或文件已准备就绪。 Enum: `PENDING`, `PROCESSING`, `FAILED`, `DONE`
estimatedGenerationTime	Type: integer<int64> 以毫秒为单位的预期生成时间。
file	Type: string 已完成报告或文档的链接。
generationFinishedAt	Type: string<date-time> 生成完成的日期和时间。
subStatus	Type: ReportSubStatusType 代子状态: `NO_DATA` — 这种报告或文件没有可用的数据。 `TOO_LARGE` — 报告或文档超出了允许的大小 — 指定较短的时间段或指定请求的条款。 `RESOURCE_NOT_FOUND` — 有些实体无法找到这样的报告或文件。 Enum: `NO_DATA`, `TOO_LARGE`, `RESOURCE_NOT_FOUND`

ReportStatusType

生成状态:

PENDING — 等待一代人。
PROCESSING — 产生的。
FAILED — 生成期间发生错误。
DONE — 报告或文件已准备就绪。

Type	Description
ReportStatusType	Enum: `PENDING`, `PROCESSING`, `FAILED`, `DONE`

ReportSubStatusType

代子状态:

NO_DATA — 这种报告或文件没有可用的数据。
TOO_LARGE — 报告或文档超出了允许的大小 — 指定较短的时间段或指定请求的条款。
RESOURCE_NOT_FOUND — 有些实体无法找到这样的报告或文件。

Type	Description
ReportSubStatusType	Enum: `NO_DATA`, `TOO_LARGE`, `RESOURCE_NOT_FOUND`

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

404 Not Found

找不到请求的资源。有关错误的更多信息

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

这篇文章是否有用？

价格报告

所有评论