Ready‑made label-sticker for the box in the 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
Generates a label sticker for the box in the order and returns the label to 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/shipments/{shipmentId}/boxes/{boxId}/label
Path parameters
|
Name |
Description |
|
boxId* |
Type: integer<int64> The ID of the box. |
|
campaignId* |
Type: integer<int64> The campaign ID. 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 send the store ID instead, which is indicated in the seller's account on the Market next to the store name and in some reports.
Min value: |
|
orderId* |
Type: integer<int64> The order ID. |
|
shipmentId* ⦸
|
Type: integer<int64> Pass any number to get the correct one. URL. The cargo location 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
Placing labels on a page PDF-file:
-
A9_HORIZONTALLY— the label is 58 × 40 mm in size, without 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— the label is 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
PDF‑a file with labels for the box. The file contains one page with a shortcut.
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 errors.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 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.