Ready‑made labels-stickers for all boxes in one order
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
Returns PDF-a file with labels that need to be pasted on the boxes before shipment. Details about why they are needed and what they look like are described in the Help of the Market for sellers.
You need to pass the order ID and one optional parameter that controls the layout to the input. PDF- the file.
To display the external order ID on the label, pass it in the method POST v2/campaigns/{campaignId}/orders/{orderId}/external-id.
| ⚙️ Limit: 100,000 requests per hour |
|---|
Request
GET
https://api.partner.market.yandex.ru/v2/campaigns/{campaignId}/orders/{orderId}/delivery/labels
Path parameters
|
Name |
Description |
|
campaignId |
Type: integer The ID of the campaign (store) — The technical identifier that represents your store in the Yandex Market system when working through the API. It is uniquely linked to your store, but it is intended only for automated interaction. You can find it using a query GET v2/campaigns or find it in the seller's office on the Market. Click on your account icon → Settings and in the menu on the left, select APIs and modules:
⚠️ Do not confuse it with:
Min value: |
|
orderId |
Type: integer The order ID. |
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: |
Responses
200 OK
PDF‑a file with labels for all the boxes.
Body
application/pdf
Type: string
Format: binary
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
404 Not Found
The requested resource was not found. 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 of the Market. More information about the error
Body
application/json
{
"status": "OK"
}
Type: object
pathParams:
- description: "The ID of the campaign (store) — The technical identifier that represents your store in the Yandex Market system when working through the API. It is uniquely linked to your store, but it is intended only for automated interaction.\n\nYou can find it using a query [GET\_v2/campaigns](../../reference/campaigns/getCampaigns.md) or find it in the seller's office on the Market. Click on your account icon → **Settings** and in the menu on the left, select **APIs and modules**:\n\n* block **Campaign ID**;\n* tab **Query log** → drop-down list in the block **Show logs**.\n\n⚠️ Do not confuse it with:\n- the store's identifier, which is displayed in the merchant's personal account.\n- advertising campaigns.\n"
name: campaignId
in: path
required: true
schema:
type: integer
format: int64
minimum: 1
- description: The order ID.
name: orderId
in: path
required: true
schema:
type: integer
format: int64
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: null
schema: {}
method: get
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/campaigns/{campaignId}/orders/{orderId}/delivery/labels
host: https://api.partner.market.yandex.ru
No longer supported, please use an alternative and newer version.





