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

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:

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

⚠️ Do not confuse it with:

the store's identifier, which is displayed in the merchant's personal account.
advertising campaigns.

Min value: 1

orderId

Type: integer

The order ID.

Responses

200 OK

Information for printing labels.

Body

application/json

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

Type: object

All of 2 types

Type: object
status

Type: string

The type of response. Possible values:

OK — There are no errors.

ERROR — an error occurred while processing the request.

Enum: OK, ERROR
The standard wrapper for server responses.
Example
```
{
  "status": "OK"
}
```

Type: object

result

Type: object

orderId

Type: integer

The order ID.

parcelBoxLabels

Type: object[]

boxId	Type: integer 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. Example: `example`
deliveryServiceName	Type: string The legal name of the delivery service. Example: `example`
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 . Example: `example`
orderId	Type: integer 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. Example: `example`
place	Type: string The box number in the order. Returned in the format: `seat number/total number of seats`. Example: `example`
recipientName	Type: string Last name and initials of the recipient of the order. Example: `example`
supplierName	Type: string The legal name of the store. Example: `example`
url	Type: string Min length: `1` Max length: `2000` Example: `example`
weight	Type: string The total weight of all the items in the order. Returned in the format `weight kg`. Example: `example`
deliveryAddress	Type: string Recipient's address. Example: `example`
shipmentDate	Type: string Date of shipment in the format `dd.MM.yyyy`. Example: `example`

Information on the label.

Example

[
  {
    "url": "example",
    "supplierName": "example",
    "deliveryServiceName": "example",
    "orderId": 0,
    "orderNum": "example",
    "recipientName": "example",
    "boxId": 0,
    "fulfilmentId": "example",
    "place": "example",
    "weight": "example",
    "deliveryServiceId": "example",
    "deliveryAddress": "example",
    "shipmentDate": "example"
  }
]

placesNumber

Type: integer

The number of boxes in the order.

url

Type: string

Min length: 1

Max length: 2000

Example: example

Data for printing the label.

Example

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

Example

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

400 Bad Request

The request contains incorrect data. More information about the error

Body

application/json

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

Type: object

All of 2 types

Type: object
status
Type: string

The type of response. Possible values:

OK — There are no errors.

ERROR — an error occurred while processing the request.

Enum: OK, ERROR
The standard wrapper for server responses.
Example
```
{
  "status": "OK"
}
```

Type: object

errors

Type: object[]

code

Type: string

The error code.

Example: example

message

Type: string

Description of the error.

Example: example

A list of errors.

Min items: 1

Example

[
  {
    "code": "example",
    "message": "example"
  }
]

Example

{
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

A standard wrapper for server errors.

Example

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

401 Unauthorized

The authorization data is not specified in the request. More information about the error

Body

application/json

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

Type: object

All of 2 types

Type: object
status
Type: string

The type of response. Possible values:

OK — There are no errors.

ERROR — an error occurred while processing the request.

Enum: OK, ERROR
The standard wrapper for server responses.
Example
```
{
  "status": "OK"
}
```

Type: object

errors

Type: object[]

code

Type: string

The error code.

Example: example

message

Type: string

Description of the error.

Example: example

A list of errors.

Min items: 1

Example

[
  {
    "code": "example",
    "message": "example"
  }
]

Example

{
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

A standard wrapper for server errors.

Example

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

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": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

Type: object

All of 2 types

Type: object
status
Type: string

The type of response. Possible values:

OK — There are no errors.

ERROR — an error occurred while processing the request.

Enum: OK, ERROR
The standard wrapper for server responses.
Example
```
{
  "status": "OK"
}
```

Type: object

errors

Type: object[]

code

Type: string

The error code.

Example: example

message

Type: string

Description of the error.

Example: example

A list of errors.

Min items: 1

Example

[
  {
    "code": "example",
    "message": "example"
  }
]

Example

{
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

A standard wrapper for server errors.

Example

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

404 Not Found

The requested resource was not found. More information about the error

Body

application/json

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

Type: object

All of 2 types

Type: object
status
Type: string

The type of response. Possible values:

OK — There are no errors.

ERROR — an error occurred while processing the request.

Enum: OK, ERROR
The standard wrapper for server responses.
Example
```
{
  "status": "OK"
}
```

Type: object

errors

Type: object[]

code

Type: string

The error code.

Example: example

message

Type: string

Description of the error.

Example: example

A list of errors.

Min items: 1

Example

[
  {
    "code": "example",
    "message": "example"
  }
]

Example

{
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

A standard wrapper for server errors.

Example

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

420 Method Failure

The resource access limit has been exceeded. More information about the error

Body

application/json

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

Type: object

All of 2 types

Type: object
status
Type: string

The type of response. Possible values:

OK — There are no errors.

ERROR — an error occurred while processing the request.

Enum: OK, ERROR
The standard wrapper for server responses.
Example
```
{
  "status": "OK"
}
```

Type: object

errors

Type: object[]

code

Type: string

The error code.

Example: example

message

Type: string

Description of the error.

Example: example

A list of errors.

Min items: 1

Example

[
  {
    "code": "example",
    "message": "example"
  }
]

Example

{
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

A standard wrapper for server errors.

Example

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

500 Internal Server Error

Internal error of Yandex. Market. More information about the error

Body

application/json

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

Type: object

All of 2 types

Type: object
status
Type: string

The type of response. Possible values:

OK — There are no errors.

ERROR — an error occurred while processing the request.

Enum: OK, ERROR
The standard wrapper for server responses.
Example
```
{
  "status": "OK"
}
```

Type: object

errors

Type: object[]

code

Type: string

The error code.

Example: example

message

Type: string

Description of the error.

Example: example

A list of errors.

Min items: 1

Example

[
  {
    "code": "example",
    "message": "example"
  }
]

Example

{
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

A standard wrapper for server errors.

Example

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Was the article helpful?

Ready-made labels for multiple orders

Information about the ability to print labels (FBS)