Передача ключей цифровых товаров
Передает ключи цифровых товаров, которые покупатель заказал и оплатил. После выполнения запроса Маркет отправит ему письмо с ключами и инструкциями по активации, а также переведет заказ в финальный статус DELIVERED.
Ключ нужно передать в течение 30 минут после перехода заказа в статус PROCESSING.
Если в один заказ входят несколько ключей, передавайте их все в одном запросе.
| ⚙️ Лимит: 100 000 запросов в час |
|---|
Request
POST
https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/deliverDigitalGoods
Path parameters
|
Name |
Description |
|
campaignId* |
Type: integer<int64> Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns. ℹ️ Что такое кабинет и магазин на Маркете
Min value: |
|
orderId* |
Type: integer<int64> Идентификатор заказа. |
Body
application/json
{
"items": [
{
"id": 0,
"code": "string",
"slip": "string",
"activate_till": "string"
}
]
}
|
Name |
Description |
|
items* |
Type: OrderDigitalItemDTO[] Список проданных ключей. Если в заказе есть несколько одинаковых товаров (например, несколько ключей к одной и той же подписке), передайте каждый в виде отдельного элемента массива. |
OrderDigitalItemDTO
Ключ цифрового товара.
|
Name |
Description |
|
activate_till* |
Type: string<date> Дата, до которой нужно активировать ключ. Если ключ действует бессрочно, укажите любую дату в отдаленном будущем. Формат даты: |
|
code* |
Type: string Сам ключ. |
|
id* |
Type: integer<int64> Идентификатор товара в заказе. Он приходит в ответе на запрос GET campaigns/{campaignId}/orders/{orderId} и в запросе Маркета POST order/accept — параметр |
|
slip* |
Type: string Инструкция по активации. |
Responses
200 OK
Пустой ответ.
Body
application/json
{
"status": "OK"
}
|
Name |
Description |
|
status |
Type: ApiResponseStatusType Тип ответа. Enum: |
400 Bad Request
Запрос содержит неправильные данные.
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: ApiErrorDTO[] Список ошибок. |
|
status |
Type: ApiResponseStatusType Тип ответа. Enum: |
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[] Список ошибок. |
|
status |
Type: ApiResponseStatusType Тип ответа. Enum: |
403 Forbidden
Данные для авторизации неверны или доступ к ресурсу запрещен.
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: ApiErrorDTO[] Список ошибок. |
|
status |
Type: ApiResponseStatusType Тип ответа. Enum: |
404 Not Found
Запрашиваемый ресурс не найден.
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: ApiErrorDTO[] Список ошибок. |
|
status |
Type: ApiResponseStatusType Тип ответа. Enum: |
420 Method Failure
Превышено ограничение на доступ к ресурсу.
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: ApiErrorDTO[] Список ошибок. |
|
status |
Type: ApiResponseStatusType Тип ответа. Enum: |
500 Internal Server Error
Внутренняя ошибка сервера.
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: ApiErrorDTO[] Список ошибок. |
|
status |
Type: ApiResponseStatusType Тип ответа. Enum: |