Getting a given report or document

Info

Console

The method is available for all models.

If you are using an API Key token, one of the accesses in the list is required to call the method

inventory-and-order-processing — Order processing and inventory
inventory-and-order-processing:read-only — View order information
pricing — Manage prices
pricing:read-only — View prices
offers-and-cards-management — Manage products and cards
offers-and-cards-management:read-only — View products and cards
promotion — Product promotion
promotion:read-only — View promotion information
finance-and-accounting — View financial data and reports
communication — Customer communication
settings-management — Store settings
supplies-management:read-only — View FBY requests
all-methods — Full account management
all-methods:read-only — View all data

Returns the generation status of the specified report or document and, if it is ready, a download link.

To use this request, you first need to start generating a report or document. Instruction manual

, Limit: 100 requests per minute

Request

GET

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

Path parameters

Name

Description

reportId*

Type: string

ID of the report or document that you received after generating it.

Min length: 1

Max length: 255

Responses

200 OK

The status of the report or document generation and the link, if it already exists.

Generation status FAILED or NO_DATA

Check the correctness of the generation request. For example, whether the campaign ID, period, or payment order number is correct.

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

result

Type: ReportInfoDTO

The generation status and a link to the finished report or document.

status

Type: ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

ReportInfoDTO

The generation status and a link to the finished report or document.

Name	Description
generationRequestedAt*	Type: string<date-time> Date and time of the generation request.
status*	Type: ReportStatusType Generation status: `PENDING` — awaiting generation. `PROCESSING` — generated. `FAILED` — an error occurred during generation. `DONE` — the report or document is ready. Enum: `PENDING`, `PROCESSING`, `FAILED`, `DONE`
estimatedGenerationTime	Type: integer<int64> Expected generation time in milliseconds.
file	Type: string A link to the finished report or document.
generationFinishedAt	Type: string<date-time> The date and time when the generation was completed.
subStatus	Type: ReportSubStatusType Generation sub-status: `NO_DATA` — there is no data for such a report or document. `TOO_LARGE` — the report or document has exceeded the allowed size — specify a shorter period of time or specify the terms of the request. `RESOURCE_NOT_FOUND` — part of the entities could not be found for such a report or document. Enum: `NO_DATA`, `TOO_LARGE`, `RESOURCE_NOT_FOUND`

ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

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

ReportStatusType

Generation status:

PENDING — awaiting generation.
PROCESSING — generated.
FAILED — an error occurred during generation.
DONE — the report or document is ready.

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

ReportSubStatusType

Generation sub-status:

NO_DATA — there is no data for such a report or document.
TOO_LARGE — the report or document has exceeded the allowed size — specify a shorter period of time or specify the terms of the request.
RESOURCE_NOT_FOUND — part of the entities could not be found for such a report or document.

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

400 Bad Request

The request contains incorrect data. More information about the error

Body

application/json

{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

ApiErrorDTO

The general error format.

Name

Description

code*

Type: string

The error code.

message

Type: string

Description of the error.

401 Unauthorized

The authorization data is not specified in the request. More information about the error

Body

application/json

{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

403 Forbidden

The authorization data is incorrect or access to the resource is prohibited. More information about the error

Body

application/json

{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

404 Not Found

The requested resource was not found. More information about the error

Body

application/json

{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

420 Method Failure

The resource access limit has been exceeded. More information about the error

Body

application/json

{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

500 Internal Server Error

Internal error in Yandex. Market. More information about the error

Body

application/json

{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

Was the article helpful?

The "Market Prices" report

All reviews