Информация о лицензиях для точек продаж

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

Если вы используете API-Key-токен, для вызова метода необходим один из доступов в списке
  • settings-management — Настройка магазинов
  • all-methods — Полное управление кабинетом
  • all-methods:read-only — Просмотр всех данных

Возвращает информацию о лицензиях для точек продаж.

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

Request

GET

https://api.partner.market.yandex.ru/v2/campaigns/{campaignId}/outlets/licenses

Path parameters

Name

Description

campaignId*

Type: integer<int64>

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

Его можно узнать с помощью запроса GET v2/campaigns или найти в кабинете продавца на Маркете — нажмите на иконку вашего аккаунта → Настройки и в меню слева выберите API и модули:

  • блок Идентификатор кампании;
  • вкладка Лог запросов → выпадающий список в блоке Показывать логи.

⚠️ Не передавайте вместо него идентификатор магазина, который указан в кабинете продавца на Маркете рядом с названием магазина и в некоторых отчетах.

Min value: 1

Query parameters

Name

Description

ids

Type: integer<int64>[]

Список идентификаторов лицензий, информацию о которых нужно получить.

Идентификаторы указываются через запятую. Идентификатор лицензии присваивается Маркетом. Не путайте его с номером, указанным на лицензии.

В запросе должен быть либо параметр outletIds, либо параметр ids. Запрос с обоими параметрами или без них приведет к ошибке.

Min value: 1

Min items: 1

Max items: 500

Unique items  

outletIds

Type: integer<int64>[]

Список идентификаторов точек продаж, для которых нужно получить информацию о лицензиях. Идентификаторы указываются через запятую.

В запросе должен быть либо параметр outletIds, либо параметр ids. Запрос с обоими параметрами или без них приведет к ошибке.

Min value: 1

Min items: 1

Max items: 500

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

status*

Type: ApiResponseStatusType

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

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

Enum: OK, ERROR

result

Type: OutletLicensesResponseDTO

Ответ на запрос информации о лицензиях для точек продаж.

ApiResponseStatusType

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

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

Type

Description

ApiResponseStatusType

Enum: OK, ERROR

OutletLicensesResponseDTO

Ответ на запрос информации о лицензиях для точек продаж.

Name

Description

licenses*

Type: FullOutletLicenseDTO[]

Список лицензий.
Информация о лицензии.
Информация о лицензии.

FullOutletLicenseDTO

Информация о лицензии.

Name

Description

dateOfExpiry*

Type: string<date-time>

Дата окончания действия лицензии.

Формат даты: ISO 8601 со смещением относительно UTC. Нужно передать дату, указанную на лицензии, время 00:00:00 и часовой пояс, соответствующий региону точки продаж. Например, если действие лицензии для точки продаж в Москве заканчивается 20 ноября 2022 года, то параметр должен иметь значение 2022-11-20T00:00:00+03:00.

Не может быть раньше даты выдачи, указанной в параметре dateOfIssue.

Example: 2022-11-20T00:00:00+03:00

dateOfIssue*

Type: string<date-time>

Дата выдачи лицензии.

Формат даты: ISO 8601 со смещением относительно UTC. Нужно передать дату, указанную на лицензии, время 00:00:00 и часовой пояс, соответствующий региону точки продаж. Например, если лицензия для точки продаж в Москве выдана 13 ноября 2017 года, то параметр должен иметь значение 2017-11-13T00:00:00+03:00.

Не может быть позже даты окончания срока действия, указанной в параметре dateOfExpiry.

Example: 2017-11-13T00:00:00+03:00

licenseType*

Type: LicenseType

Тип лицензии:

  • ALCOHOL — лицензия на розничную продажу алкогольной продукции.
  • UNKNOWN — неизвестный тип лицензии.

Enum: ALCOHOL, UNKNOWN

number*

Type: string

Номер лицензии.

outletId*

Type: integer<int64>

Идентификатор точки продаж, для которой действительна лицензия.

Min value: 1

checkComment

Type: string

Причина, по которой лицензия не прошла проверку.

Параметр возвращается, только если параметр checkStatus имеет значение FAIL.

checkStatus

Type: LicenseCheckStatusType

Статус проверки лицензии:

  • NEW — лицензия проверяется.
  • SUCCESS — лицензия прошла проверку.
  • FAIL — лицензия не прошла проверку.
  • REVOKE — лицензия отозвана службой качества.
  • DONT_WANT — не проверяется.
  • FAIL_MANUAL — лицензия не прошла проверку службы качества.

Enum: NEW, SUCCESS, FAIL, REVOKE, DONT_WANT, FAIL_MANUAL

id

Type: integer<int64>

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

Параметр указывается, только если нужно изменить информацию о существующей лицензии. Ее идентификатор можно узнать с помощью запроса GET v2/campaigns/{campaignId}/outlets/licenses. При передаче информации о новой лицензии указывать идентификатор не нужно.

Идентификатор лицензии присваивается Маркетом. Не путайте его с номером, указанным на лицензии: он передается в параметре number.

LicenseType

Тип лицензии:

  • ALCOHOL — лицензия на розничную продажу алкогольной продукции.
  • UNKNOWN — неизвестный тип лицензии.

Type

Description

LicenseType

Enum: ALCOHOL, UNKNOWN

LicenseCheckStatusType

Статус проверки лицензии:

  • NEW — лицензия проверяется.
  • SUCCESS — лицензия прошла проверку.
  • FAIL — лицензия не прошла проверку.
  • REVOKE — лицензия отозвана службой качества.
  • DONT_WANT — не проверяется.
  • FAIL_MANUAL — лицензия не прошла проверку службы качества.

Type

Description

LicenseCheckStatusType

Enum: NEW, SUCCESS, FAIL, REVOKE, DONT_WANT, FAIL_MANUAL

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

No longer supported, please use an alternative and newer version.

Предыдущая
Удаление
Следующая
Создание и изменение