Ready‑made labels-stickers for all boxes in several orders
The method is available for models: FBS, Express and DBS.
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
- all-methods — Full account management
Starts the generation of a PDF file with shortcuts for transferred orders. Details about why they are needed and what they look like are described in the Help of the Market for sellers.
You can find out the generation status and get a link to the finished file using a request. GET reports/info/{reportId}.
| , Limit: 1,000 requests per hour |
|---|
Request
POST
https://api.partner.market.yandex.ru/reports/documents/labels/generate
Query parameters
|
Name |
Description |
|
format |
Type: PageFormatType Setting up the placement of shortcuts on the page. If there is no parameter, a PDF with labels in A7 format is returned. |
PageFormatType
Placement of labels on the PDF file page:
-
A9_HORIZONTALLY— a 58 ×40 mm borderless label, close to the A9 format.An example of a label for Market sellers
An example of a shortcut for Market Yandex Go sellers
-
A9— the label is 40x58 mm in size without margins, close to the A9 format.An example of a label for Market sellers
An example of a shortcut for Market Yandex Go sellers
-
A7— the label is 75 × 120 mm (80.4 × 125.6 mm including margins), close to the A7 format.An example of a label for Market sellers
An example of a shortcut for Market Yandex Go sellers
-
A4— on the A4 sheet there is a label of the format that is selected in the seller's office on the Market — go to the page Orders → Orders and shipments → on the tab of the desired work model, click Label format.
|
Type |
Description |
|
Enum: |
Body
application/json
{
"businessId": 0,
"orderIds": [
0
],
"sortingType": "SORT_BY_GIVEN_ORDER"
}
|
Name |
Description |
|
businessId* |
Type: integer<int64> Cabinet ID. |
|
orderIds* |
Type: integer<int64>[] List of order IDs. Min items: Max items: Unique items |
|
sortingType |
Type: LabelsSortingType The type of sorting shortcuts in the file. Enum: |
LabelsSortingType
Label sorting type:
SORT_BY_GIVEN_ORDER— The order labels will be arranged in the same order as the order IDs were transmitted in the request.SORT_BY_ORDER_CREATED_AT— The labels will be arranged according to the date the order was created and grouped by stores.
If no parameter is specified, the labels are sorted by creation date.
|
Type |
Description |
|
Enum: |
Responses
200 OK
In response, you receive an identifier that allows you to find out the generation status and download the finished file.
If a part of the orders could not be found during the generation, the sub-status will be returned in response to the request to receive the finished file. RESOURCE_NOT_FOUND.
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.