Информация о лицензиях для точек продаж
Метод доступен для модели DBS.
Если вы используете API-Key-токен, для вызова метода необходим один из доступов в списке
- settings-management — Настройка магазинов
- all-methods — Полное управление кабинетом
- all-methods:read-only — Просмотр всех данных
Возвращает информацию о лицензиях для точек продаж.
⚙️ Лимит: 100 000 запросов в час |
---|
Request
GET
https://api.partner.market.yandex.ru/campaigns/{campaignId}/outlets/licenses
Path parameters
Name |
Description |
campaignId* |
Type: integer<int64> Идентификатор кампании. Его можно узнать с помощью запроса GET campaigns или найти в кабинете продавца на Маркете — нажмите на название своего бизнеса и перейдите на страницу:
⚠️ Не передавайте вместо него идентификатор магазина, который указан в кабинете продавца на Маркете рядом с названием магазина и в некоторых отчетах.
Min value: |
Query parameters
Name |
Description |
ids |
Type: integer<int64>[] Список идентификаторов лицензий, информацию о которых нужно получить. Идентификаторы указываются через запятую. Идентификатор лицензии присваивается Маркетом. Не путайте его с номером, указанным на лицензии. В запросе должен быть либо параметр Min value: Unique items |
outletIds |
Type: integer<int64>[] Список идентификаторов точек продаж, для которых нужно получить информацию о лицензиях. Идентификаторы указываются через запятую. В запросе должен быть либо параметр Min value: Min items: Max items: Unique items |
Responses
200 OK
Найденные лицензии собственных точек продаж.
Body
application/json
{
"status": "OK",
"result": {
"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",
"checkStatus": "NEW",
"checkComment": "string"
}
]
}
}
Name |
Description |
result |
Type: OutletLicensesResponseDTO Ответ на запрос информации о лицензиях для точек продаж. |
status |
Type: ApiResponseStatusType Тип ответа. Возможные значения:
Enum: |
OutletLicensesResponseDTO
Ответ на запрос информации о лицензиях для точек продаж.
Name |
Description |
licenses* |
Type: FullOutletLicenseDTO[] Список лицензий. |
ApiResponseStatusType
Тип ответа. Возможные значения:
OK
— ошибок нет.ERROR
— при обработке запроса произошла ошибка.
Type |
Description |
Enum: |
FullOutletLicenseDTO
Информация о лицензии.
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: |
checkComment |
Type: string Причина, по которой лицензия не прошла проверку. Параметр возвращается, только если параметр |
checkStatus |
Type: LicenseCheckStatusType Статус проверки лицензии:
Enum: |
id |
Type: integer<int64> Идентификатор лицензии. Параметр указывается, только если нужно изменить информацию о существующей лицензии. Ее идентификатор можно узнать с помощью запроса GET campaigns/{campaignId}/outlets/licenses. При передаче информации о новой лицензии указывать идентификатор не нужно. Идентификатор лицензии присваивается Маркетом. Не путайте его с номером, указанным на лицензии: он передается в параметре |
LicenseType
Тип лицензии:
ALCOHOL
— лицензия на розничную продажу алкогольной продукции.UNKNOWN
— неизвестный тип лицензии.
Type |
Description |
Enum: |
LicenseCheckStatusType
Статус проверки лицензии:
NEW
— лицензия проверяется.SUCCESS
— лицензия прошла проверку.FAIL
— лицензия не прошла проверку.REVOKE
— лицензия отозвана службой качества.DONT_WANT
— не проверяется.FAIL_MANUAL
— лицензия не прошла проверку службы качества.
Type |
Description |
Enum: |
400 Bad Request
Запрос содержит неправильные данные. Подробнее об ошибке
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] Список ошибок. Min items: |
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[] Список ошибок. Min items: |
status |
Type: ApiResponseStatusType Тип ответа. Возможные значения:
Enum: |
403 Forbidden
Данные для авторизации неверны или доступ к ресурсу запрещен. Подробнее об ошибке
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] Список ошибок. Min items: |
status |
Type: ApiResponseStatusType Тип ответа. Возможные значения:
Enum: |
404 Not Found
Запрашиваемый ресурс не найден. Подробнее об ошибке
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] Список ошибок. Min items: |
status |
Type: ApiResponseStatusType Тип ответа. Возможные значения:
Enum: |
420 Method Failure
Превышено ограничение на доступ к ресурсу. Подробнее об ошибке
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] Список ошибок. Min items: |
status |
Type: ApiResponseStatusType Тип ответа. Возможные значения:
Enum: |
500 Internal Server Error
Внутренняя ошибка Маркета. Подробнее об ошибке
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] Список ошибок. Min items: |
status |
Type: ApiResponseStatusType Тип ответа. Возможные значения:
Enum: |
No longer supported, please use an alternative and newer version.