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 a PDF 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.
To enter, you need to pass the order ID and one optional parameter that controls the layout of the PDF file.
| ⚙️ 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<int64> The campaign ID. You can find it using a query :no-translate[GET v2/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's ID instead, which is indicated in the seller's account on the Market next to the store's name and in some reports.
Min value: |
|
orderId* |
Type: integer<int64> The order ID. |
Query parameters
|
Name |
Description |
|
format |
Type: PageFormatType Setting up the placement of shortcuts on the page. If there is no parameter, it is returned PDF with format labels A7. |
PageFormatType
Placement of labels on the PDF file page:
-
A9_HORIZONTALLY— a 58 × 40 mm label with no margins, close to the format A9.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— label size 75 × 120 mm (80.4 × 125.6 mm including margins), close to the format A7.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: |
Responses
200 OK
A PDF 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",
"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. |
ApiResponseStatusType
The type of response. Possible values:
OK— there are no mistakes.ERROR— an error occurred while processing the request.
|
Type |
Description |
|
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: 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: |
404 Not Found
The requested resource was not found. 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 of the 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.