Data for self-label production

Info

Console

The method is available for models: FBS, Express and DBS.

Not yet available for Market Yandex Go sellers.

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
inventory-and-order-processing:read-only — View order information
all-methods — Full account management
all-methods:read-only — View all data

Returns information on labels that are glued to boxes in the order.

⚙️ Limit: 100,000 requests per hour

Request

GET

https://api.partner.market.yandex.ru/v2/campaigns/{campaignId}/orders/{orderId}/delivery/labels/data

Path parameters

Name

Description

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:

block Campaign ID;
tab Query log → drop-down list in the block Show logs.

⚠️ 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: 1

orderId*

Type: integer<int64>

The order ID.

Responses

200 OK

Information for printing labels.

Body

application/json

{
    "status": "OK",
    "result": {
        "orderId": 0,
        "placesNumber": 0,
        "url": "string",
        "parcelBoxLabels": [
            {
                "url": "string",
                "supplierName": "string",
                "deliveryServiceName": "string",
                "orderId": 0,
                "orderNum": "string",
                "recipientName": "string",
                "boxId": 0,
                "fulfilmentId": "string",
                "place": "string",
                "weight": "string",
                "deliveryServiceId": "string",
                "deliveryAddress": "string",
                "shipmentDate": "string"
            }
        ]
    }
}

Name

Description

status*

Type: ApiResponseStatusType

The type of response. Possible values:

OK — There are no errors.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

result

Type: OrderLabelDTO

Data for printing the label.

ApiResponseStatusType

The type of response. Possible values:

OK — There are no errors.
ERROR — an error occurred while processing the request.

Type	Description
ApiResponseStatusType	Enum: `OK`, `ERROR`

OrderLabelDTO

Data for printing the label.

Name	Description
orderId*	Type: integer<int64> The order ID.
parcelBoxLabels*	Type: ParcelBoxLabelDTO[] Information on the label. Information about the label for the box.
placesNumber*	Type: integer<int32> The number of boxes in the order.
url* ⦸	Type: string URL a file with label labels for all the boxes in the order. Respond URL, for which the request is being executed GET v2/campaigns/{campaignId}/orders/{orderId}/delivery/labels. Min length: `1` Max length: `2000`

ParcelBoxLabelDTO

Information about the label for the box.

Name	Description
boxId*	Type: integer<int64> The ID of the box.
deliveryServiceId*	Type: string The delivery service ID. Information about the delivery service can be obtained by requesting GET delivery/services.
deliveryServiceName*	Type: string The legal name of the delivery service.
fulfilmentId*	Type: string The ID of the box in the store's information system. Returned in the format: `The order number on the Market is the box number.`. For example, `7206821‑1`, `7206821‑2` and so on .
orderId*	Type: integer<int64> The order ID in the Market system.
orderNum*	Type: string The order ID in the store's information system. Matches with `orderId` if the Market does not know the order number in the store's system.
place*	Type: string The box number in the order. Returned in the format: `seat number/total number of seats`.
recipientName*	Type: string Last name and initials of the recipient of the order.
supplierName*	Type: string The legal name of the store.
url*	Type: string Respond URL, for which the request is being executed GET v2/campaigns/{campaignId}/orders/{orderId}/delivery/shipments/{shipmentId}/boxes/{boxId}/label. Min length: `1` Max length: `2000`
weight* ⦸	Type: string The total weight of all items in the order. Returned in the format `weight kg`.
deliveryAddress	Type: string Recipient's address.
shipmentDate	Type: string Date of shipment in the format `dd.MM.yyyy`.

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.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

OK — There are no errors.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

ApiErrorDTO

The general error format.

Name

Description

code*

Type: string

The error code.

message

Type: string

Description of the error.

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.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

OK — There are no errors.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

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.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

OK — There are no errors.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

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.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

OK — There are no errors.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

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.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

OK — There are no errors.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

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.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

OK — There are no errors.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

Was the article helpful?

Ready-made labels for multiple orders

Labels for trust acceptance (FBS)