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. Placing labels on a page PDF-file:
Enum: |
Body
application/json
{
"businessId": 1,
"orderIds": [
0
],
"sortingType": "SORT_BY_GIVEN_ORDER"
}
|
Name |
Description |
|
businessId |
Type: integer Cabinet ID. To find out, use the request GET v2/campaigns. ℹ️ What is a cabinet and a store on the Market? Min value: |
|
orderIds |
Type: integer[] List of order IDs. Min items: Max items: Unique items: Example |
|
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"
}
Type: object
400 Bad Request
The request contains incorrect data. More information about the error
Body
application/json
{
"status": "OK"
}
Type: object
401 Unauthorized
The authorization data is not specified in the request. More information about the error
Body
application/json
{
"status": "OK"
}
Type: object
403 Forbidden
The authorization data is incorrect or access to the resource is prohibited. More information about the error
Body
application/json
{
"status": "OK"
}
Type: object
420 Method Failure
The resource access limit has been exceeded. More information about the error
Body
application/json
{
"status": "OK"
}
Type: object
500 Internal Server Error
Internal error in Yandex. Market. More information about the error
Body
application/json
{
"status": "OK"
}
Type: object
pathParams: []
searchParams:
- description: >-
Setting up the placement of shortcuts on the page. If there is no
parameter, it is returned PDF with format labels
A7.
name: format
in: query
required: false
schema:
description: >
Placing labels on a page PDF-file:
* `A9_HORIZONTALLY` — the label is 58 × 40
mm in size, without margins, close to the format A9.
{% cut "An example of a label for Market sellers" %}
{% endcut %}
{% cut "An example of a shortcut for Market Yandex Go sellers" %}
{% endcut %}
* `A9` — the label is 40x58 mm in size
without margins, close to the A9 format.
{% cut "An example of a label for Market sellers" %}
{% endcut %}
{% cut "An example of a shortcut for Market Yandex Go sellers" %}
{% endcut %}
* `A7` — the label is 75 × 120 mm (80.4 ×
125.6 mm including margins), close to the format A7.
{% cut "An example of a label for Market sellers" %}
{% endcut %}
{% cut "An example of a shortcut for Market Yandex Go sellers" %}
{% endcut %}
* `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: string
enum:
- A9_HORIZONTALLY
- A9
- A7
- A4
headers: []
body: |-
{
"businessId": 1,
"orderIds": [
0
],
"sortingType": "SORT_BY_GIVEN_ORDER"
}
schema:
description: |
The data required to generate the file.
type: object
required:
- businessId
- orderIds
properties:
businessId:
description: "Cabinet ID. To find out, use the request [GET\_v2/campaigns](../../reference/campaigns/getCampaigns.md).\n\nℹ️ [What is a cabinet and a store on the Market?](https://yandex.ru/support/marketplace/account/introduction.html)\n"
type: integer
format: int64
minimum: 1
orderIds:
description: List of order IDs.
type: array
minItems: 1
maxItems: 1000
uniqueItems: true
items:
description: The order ID.
format: int64
type: integer
sortingType:
description: >
Label sorting type:
* `SORT_BY_GIVEN_ORDER` — The order labels
will be arranged in the same order as the order IDs were passed 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: string
enum:
- SORT_BY_GIVEN_ORDER
- SORT_BY_ORDER_CREATED_AT
bodyType: application/json
method: post
security:
- type: apiKey
name: 'Api-Key'
in: header
- type: oauth2
x-inline: true
flows:
implicit:
authorizationUrl: https://oauth.yandex.ru/authorize
scopes:
market:partner-api: API Яндекс.Маркета / Поиска по товарам для партнеров
path: v2/reports/documents/labels/generate
host: https://api.partner.market.yandex.ru
No longer supported, please use an alternative and newer version.