Передача ключей цифровых товаров

Info

Console

Метод доступен для модели DBS.

Пока недоступен для продавцов Market Yandex Go.

Если вы используете API-Key-токен, для вызова метода необходим один из доступов в списке

inventory-and-order-processing — Обработка заказов и учёт товаров
all-methods — Полное управление кабинетом

Передает ключи цифровых товаров, которые покупатель заказал и оплатил. После выполнения запроса Маркет отправит ему письмо с ключами и инструкциями по активации. Если письмо будет доставлено, Маркет переведет заказ в финальный статус DELIVERED.

После передачи кода покупателю статус заказа изменится не сразу

Подключите API-уведомления — Маркет отправит вам запрос POST notification, когда заказ перейдет в статус DELIVERED.

Как работать с уведомлениями

Ключ нужно передать в течение 30 минут после перехода заказа в статус PROCESSING.

Если в один заказ входят несколько ключей, передавайте их все в одном запросе.

Каждый товар с уникальным id передавайте в виде отдельного элемента в массиве items, а ключи товара — в массиве codes.

⚙️ Лимит: 100 000 запросов в час

Request

POST

https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/deliverDigitalGoods

Path parameters

Name

Description

campaignId*

Type: integer<int64>

Идентификатор магазина в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

Min value: 1

orderId*

Type: integer<int64>

Идентификатор заказа.

Body

application/json

{
    "items": [
        {
            "id": 0,
            "code": "string",
            "codes": [
                "string"
            ],
            "slip": "string",
            "activate_till": "string"
        }
    ]
}

Name

Description

items*

Type: OrderDigitalItemDTO[]

Список проданных товаров.

Если в заказе есть несколько одинаковых товаров (например, несколько ключей к одной и той же подписке), передайте ключи в виде массива к этому товару. Параметр id у этих элементов должен быть один и тот же.
Цифровой товар.

Min items: 1

Max items: 100

OrderDigitalItemDTO

Цифровой товар.

Name	Description
activate_till*	Type: string<date> Дата, до которой нужно активировать ключи. Если ключи действуют бессрочно, укажите любую дату в отдаленном будущем. Формат даты: `ГГГГ-ММ-ДД`.
id*	Type: integer<int64> Идентификатор товара в заказе. Он приходит в ответе на запрос GET campaigns/{campaignId}/orders/{orderId} — параметр `id` в `items`.
slip*	Type: string Инструкция по активации. Max length: `10000`
code ⦸	Type: string Этот параметр устарел Вместо него используйте `codes`. Совместное использование обоих параметров приведет к ошибке. Сам ключ.
codes	Type: string[] Ключи, относящиеся к товару. Min items: `1` Max items: `5000` Unique items

Responses

200 OK

Пустой ответ.

Ответ 200 сам по себе не значит, что ключи переданы покупателю

Если письмо с ключами удалось доставить, Маркет переведет заказ в финальный статус DELIVERED.

Статус заказа можно узнать с помощью метода GET campaigns/{campaignId}/orders/{orderId} или GET campaigns/{campaignId}/orders.

Body

application/json

{
    "status": "OK"
}

Name

Description

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

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

400 Bad Request

Запрос содержит неправильные данные.

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

ApiErrorDTO

Общий формат ошибки.

Name

Description

code*

Type: string

Код ошибки.

message

Type: string

Описание ошибки.

401 Unauthorized

В запросе не указаны данные для авторизации.

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

403 Forbidden

Данные для авторизации неверны или доступ к ресурсу запрещен.

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

404 Not Found

Запрашиваемый ресурс не найден.

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

420 Method Failure

Превышено ограничение на доступ к ресурсу.

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

500 Internal Server Error

Внутренняя ошибка сервера.

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

Была ли статья полезна?

Отмена заказа покупателем

Передача кодов маркировки