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

Info

Console

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

В течение суток этим и другими запросами о точках продаж, кроме запроса GET delivery/services, можно получить и изменить информацию об определенном суммарном количестве точек продаж. Оно зависит от количества точек продаж магазина.

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

Request

GET

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

Path parameters

Name

Description

campaignId*

Type: integer<int64>

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

Min value: 1

Query parameters

Name

Description

ids

Type: integer<int64>[]

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

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

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

Min value: 1

Unique items:

outletIds

Type: integer<int64>[]

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

Min value: 1

Max items: 500

Min items: 1

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: OK, ERROR

OutletLicensesResponseDTO

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

Name

Description

licenses*

Type: FullOutletLicenseDTO[]

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

ApiResponseStatusType

Тип ответа.

Type	Description
ApiResponseStatusType	Enum: `OK`, `ERROR`

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` — лицензия на розничную продажу алкогольной продукции. Enum: `ALCOHOL`, `UNKNOWN`
number*	Type: string Номер лицензии.
outletId*	Type: integer<int64> Идентификатор точки продаж, для которой действительна лицензия. Min value: `1`
checkComment	Type: string Причина, по которой лицензия не прошла проверку. Параметр возвращается, только если параметр `checkStatus` имеет значение `FAIL`.
checkStatus	Type: LicenseCheckStatusType Статус проверки лицензии: `NEW` — лицензия проверяется. `SUCCESS` — лицензия прошла проверку. `FAIL` — лицензия не прошла проверку. Enum: `NEW`, `SUCCESS`, `FAIL`, `REVOKE`, `DONT_WANT`, `FAIL_MANUAL`
id	Type: integer<int64> Идентификатор лицензии. Параметр указывается, только если нужно изменить информацию о существующей лицензии. Ее идентификатор можно узнать с помощью запроса GET campaigns/{campaignId}/outlets/licenses. При передаче информации о новой лицензии указывать идентификатор не нужно. Идентификатор лицензии присваивается Маркетом. Не путайте его с номером, указанным на лицензии: он передается в параметре `number`.

LicenseType

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

ALCOHOL — лицензия на розничную продажу алкогольной продукции.

Type	Description
LicenseType	Enum: `ALCOHOL`, `UNKNOWN`

LicenseCheckStatusType

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

NEW — лицензия проверяется.
SUCCESS — лицензия прошла проверку.
FAIL — лицензия не прошла проверку.

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[]

Список ошибок.
Общий формат ошибки.

status

Type: ApiResponseStatusType

Тип ответа.

application/json

{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

status

Type: ApiResponseStatusType

Тип ответа.

Enum: OK, ERROR

Была ли статья полезна?

Удаление

Создание и изменение