Создание и изменение лицензий для точек продаж
Передает информацию о новых и существующих лицензиях для точек продаж. Поддерживаются только лицензии на розничную продажу алкоголя.
Чтобы размещать алкогольную продукцию на Маркете, надо также прислать гарантийное письмо (если вы еще не делали этого раньше) и правильно оформить предложения в прайс-листе. Далее информация о лицензиях проходит проверку.
В течение суток этим и другими запросами о точках продаж, кроме запроса GET delivery/services, можно получить и изменить информацию об определенном суммарном количестве точек продаж. Оно зависит от количества точек продаж магазина.
⚙️ Лимит: 100 000 запросов в час |
---|
Request
POST
https://api.partner.market.yandex.ru/campaigns/{campaignId}/outlets/licenses
Path parameters
Name |
Description |
campaignId* |
Type: integer<int64> Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns. ℹ️ Что такое кабинет и магазин на Маркете
Min value: |
Body
application/json
{
"licenses": [
{
"id": 0,
"outletId": 0,
"licenseType": "ALCOHOL",
"number": "string",
"dateOfIssue": "2017-11-13T00:00:00+03:00",
"dateOfExpiry": "2022-11-20T00:00:00+03:00"
}
]
}
Name |
Description |
licenses* |
Type: OutletLicenseDTO[] Список лицензий.
Обязательный параметр, должен содержать информацию хотя бы об одной лицензии.
Min items: |
OutletLicenseDTO
Информация о лицензии.
Name |
Description |
dateOfExpiry* |
Type: string<date-time> Дата окончания действия лицензии. Формат даты: ISO 8601 со смещением относительно UTC. Нужно передать дату, указанную на лицензии, время Не может быть раньше даты выдачи, указанной в параметре Example: |
dateOfIssue* |
Type: string<date-time> Дата выдачи лицензии. Формат даты: ISO 8601 со смещением относительно UTC. Нужно передать дату, указанную на лицензии, время Не может быть позже даты окончания срока действия, указанной в параметре Example: |
licenseType* |
Type: LicenseType Тип лицензии:
Enum: |
number* |
Type: string Номер лицензии. |
outletId* |
Type: integer<int64> Идентификатор точки продаж, для которой действительна лицензия. Min value: |
id |
Type: integer<int64> Идентификатор лицензии. Параметр указывается, только если нужно изменить информацию о существующей лицензии. Ее идентификатор можно узнать с помощью запроса GET campaigns/{campaignId}/outlets/licenses. При передаче информации о новой лицензии указывать идентификатор не нужно. Идентификатор лицензии присваивается Маркетом. Не путайте его с номером, указанным на лицензии: он передается в параметре |
LicenseType
Тип лицензии:
ALCOHOL
— лицензия на розничную продажу алкогольной продукции.
Type |
Description |
Enum: |
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: |