Информация о лицензиях для точек продаж
Возвращает информацию о лицензиях для точек продаж.
В течение суток этим и другими запросами о точках продаж, кроме запроса GET delivery/services, можно получить и изменить информацию об определенном суммарном количестве точек продаж. Оно зависит от количества точек продаж магазина.
| ⚙️ Лимит: 100 000 запросов в час |
|---|
Request
GET
https://api.partner.market.yandex.ru/campaigns/{campaignId}/outlets/licenses
Path parameters
|
Name |
Type |
Description |
|
campaignId* |
integer<int64> |
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns. |
Query parameters
|
Name |
Type |
Description |
|
outletIds |
integer<int64>[] |
Список идентификаторов точек продаж, для которых нужно получить информацию о лицензиях. Идентификаторы указываются через запятую.
В запросе должен быть либо параметр |
|
ids |
integer<int64>[] |
Список идентификаторов лицензий, информацию о которых нужно получить. Идентификаторы указываются через запятую. Идентификатор лицензии присваивается Маркетом. Не путайте его с номером, указанным на лицензии. В запросе должен быть либо параметр |
Responses
200 OK
Найденная отгрузка
Body
{
"status": "OK",
"result": {
"licenses": [
{
"id": 0,
"outletId": 0,
"licenseType": "ALCOHOL",
"number": "string",
"dateOfIssue": "2022-12-29T18:02:01Z",
"dateOfExpiry": "2022-12-29T18:02:01Z",
"checkStatus": "NEW",
"checkComment": "string"
}
]
}
}
|
Name |
Type |
Description |
|
status |
Тип ответа.
|
|
|
result |
Ответ на запрос информации о лицензиях для точек продаж. |
OutletLicensesResponseDTO
Ответ на запрос информации о лицензиях для точек продаж.
|
Name |
Type |
Description |
|
licenses |
Список лицензий. |
FullOutletLicenseDTO
Информация о лицензии.
|
Name |
Type |
Description |
|
id |
integer<int64> |
Идентификатор лицензии. Параметр указывается, только если нужно изменить информацию о существующей лицензии. Ее идентификатор можно узнать с помощью запроса GET campaigns/{campaignId}/outlets/licenses. При передаче информации о новой лицензии указывать идентификатор не нужно. Идентификатор лицензии присваивается Маркетом. Не путайте его с номером, указанным на лицензии: он передается в параметре |
|
outletId |
integer<int64> |
Идентификатор точки продаж, для которой действительна лицензия. |
|
licenseType |
Тип лицензии:
|
|
|
number |
string |
Номер лицензии. |
|
dateOfIssue |
string<date-time> |
Дата выдачи лицензии. Формат даты: ISO 8601 со смещением относительно UTC. Нужно передать дату, указанную на лицензии, время Обязательный параметр. Не может быть позже даты окончания срока действия, указанной в параметре |
|
dateOfExpiry |
string<date-time> |
Дата окончания действия лицензии. Формат даты: ISO 8601 со смещением относительно UTC. Нужно передать дату, указанную на лицензии, время Обязательный параметр. Не может быть раньше даты выдачи, указанной в параметре |
|
checkStatus |
Статус проверки лицензии:
|
|
|
checkComment |
string |
Причина, по которой лицензия не прошла проверку.
Параметр возвращается, только если параметр |
LicenseType
Тип лицензии:
ALCOHOL— лицензия на розничную продажу алкогольной продукции.
|
Type |
Description |
|
Enum: |
LicenseCheckStatusType
Статус проверки лицензии:
NEW— лицензия проверяется.SUCCESS— лицензия прошла проверку.FAIL— лицензия не прошла проверку.
|
Type |
Description |
|
Enum: |
400 Bad Request
Запрос содержит неправильные данные.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Type |
Description |
|
status |
Тип ответа.
|
|
|
errors |
Список ошибок. |
ApiErrorDTO
Общий формат ошибки.
|
Name |
Type |
Description |
|
code* |
string |
Код ошибки. |
|
message |
string |
Описание ошибки. |
401 Unauthorized
В запросе не указаны данные для авторизации.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Type |
Description |
|
status |
Тип ответа.
|
|
|
errors |
Список ошибок. |
403 Forbidden
Данные для авторизации неверны или доступ к ресурсу запрещен.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Type |
Description |
|
status |
Тип ответа.
|
|
|
errors |
Список ошибок. |
404 Not Found
Запрашиваемый ресурс не найден.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Type |
Description |
|
status |
Тип ответа.
|
|
|
errors |
Список ошибок. |
420 Method Failure
Превышено ограничение на доступ к ресурсу.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Type |
Description |
|
status |
Тип ответа.
|
|
|
errors |
Список ошибок. |
500 Internal Server Error
Внутренняя ошибка сервера.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Type |
Description |
|
status |
Тип ответа.
|
|
|
errors |
Список ошибок. |