The structure and content of the reports are subject to change without prior notice.
For example, a new column may be added or the name of the sheet may be changed.
Jewelry Order Report
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
- finance-and-accounting — View financial data and reports
- all-methods — Full account management
Starts generating a report on jewelry orders.
You can find out the generation status and get a link to the finished report using a request. GET reports/info/{reportId}.
Explanation of the report columns:
Sheet Отчет (file orders_jewelry_fiscal_report)
|
CSV column name |
JSON column name |
XLSX column name |
Value type |
|
ORDER_ID |
orderId |
Номер |
integer |
|
ORDER_STATUS |
orderStatus |
Статус |
string |
|
ORDER_CREATION_DATE |
orderCreationDate |
Время создания |
string |
|
OFFER_ID |
offerId |
Идентификатор товара |
string |
|
OFFER_NAME |
offerName |
Имя товара |
string |
|
BUYER_PRICE |
buyerPrice |
Цена товара (руб) |
integer |
|
UIN |
uin |
УИН |
string |
|
FISCAL_DEVICE_ID |
fiscalDeviceId |
Номер накопителя |
string |
|
FISCAL_DOCUMENT_ID |
fiscalDocumentId |
Номер документа |
integer |
|
FISCAL_DOCUMENT_DATE |
fiscalDocumentDate |
Дата документа |
string |
| , Limit: 100 requests per hour |
|---|
Request
POST
https://api.partner.market.yandex.ru/reports/jewelry-fiscal/generate
Query parameters
|
Name |
Description |
|
format |
Type: ReportFormatType The format of the report or document. |
ReportFormatType
Report format:
FILE— a spreadsheet file (XLSX).CSV— ZIP archive with CSV files for each report sheet.JSON— ZIP archive with JSON files for each report sheet.
|
Type |
Description |
|
Default: Enum: |
Body
application/json
{
"campaignId": 0,
"dateFrom": "string",
"dateTo": "string"
}
|
Name |
Description |
|
campaignId* |
Type: integer<int64> The campaign ID. You can find it using a query GET campaigns or find it in the seller's office on the Market — click on the name of your business and go to the page:
, Do not send the store ID instead, which is indicated in the seller's account on the Market next to the store name and in some reports. |
|
dateFrom* |
Type: string<date> The beginning of the period, inclusive. |
|
dateTo* |
Type: string<date> End of the period, inclusive. |
Responses
200 OK
In response, you receive an identifier that allows you to find out the generation status and download the finished report.
Body
application/json
{
"status": "OK",
"result": {
"reportId": "string",
"estimatedGenerationTime": 0
}
}
|
Name |
Description |
|
result |
Type: GenerateReportDTO The ID that will be needed to track the generation status and receive the finished report or document. |
|
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
GenerateReportDTO
The ID that will be needed to track the generation status and receive the finished report or document.
|
Name |
Description |
|
estimatedGenerationTime* |
Type: integer<int64> Expected generation time in milliseconds. |
|
reportId* |
Type: string The ID that will be needed to track the generation status and receive the finished report or document. |
ApiResponseStatusType
The type of response. Possible values:
OK— there are no mistakes.ERROR— an error occurred while processing the request.
|
Type |
Description |
|
Enum: |
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. Min items: |
|
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
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. Min items: |
|
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
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. Min items: |
|
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
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. Min items: |
|
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
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. Min items: |
|
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
No longer supported, please use an alternative and newer version.