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 generation PDF-a file with labels for transferred orders. Details about why they are needed and what they look like are described in the Help of the Market for sellers.
To display the external order ID on the label, pass it in the method POST v2/campaigns/{campaignId}/orders/{orderId}/external-id.
You can find out the generation status and get a link to the finished file using a request. GET v2/reports/info/{reportId}.
| ⚙️ Limit: 1,000 requests per hour |
|---|
Request
POST
https://api.partner.market.yandex.ru/v2/reports/documents/labels/generate
Query parameters
|
Name |
Description |
|
format |
Type: string Setting up the placement of shortcuts on the page. If there is no parameter, it is returned PDF with format labels A7.
Enum: |
Body
application/json
{
"businessId": 0,
"orderIds": [
0
],
"sortingType": "SORT_BY_GIVEN_ORDER"
}
|
Name |
Description |
|
businessId* |
Type: integer<int64> Cabinet ID. |
|
orderIds* |
Type: integer[] List of order IDs. Min items: Max items: Unique items |
|
sortingType |
Type: string Label sorting type:
If no parameter is specified, the labels are sorted by creation date. 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 |
||||
|
status* |
Type: string The type of response. Possible values:
Enum: |
||||
|
result |
Type: object
The ID that will be needed to track the generation status and receive the finished report or document. |
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: object[] A list of errors. Min items: |
|
status |
Type: string The type of response. Possible values:
Enum: |
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: object[] A list of errors. Min items: |
|
status |
Type: string 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: object[] A list of errors. Min items: |
|
status |
Type: string 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: object[] A list of errors. Min items: |
|
status |
Type: string The type of response. Possible values:
Enum: |
500 Internal Server Error
Internal error of the Market. More information about the error
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: object[] A list of errors. Min items: |
|
status |
Type: string The type of response. Possible values:
Enum: |
No longer supported, please use an alternative and newer version.