Создание и изменение лицензий для точек продаж

Передает информацию о новых и существующих лицензиях для точек продаж. Поддерживаются только лицензии на розничную продажу алкоголя. Чтобы размещать алкогольную продукцию на Маркете, надо также прислать гарантийное письмо (если вы еще не делали этого раньше) и правильно оформить предложения в прайс-листе. Информация о лицензиях проходит проверку. В течение суток этим и другими запросами о точках продаж, кроме запроса GET delivery/services, можно получить и изменить информацию об определенном суммарном количестве точек продаж. Оно зависит от количества точек продаж магазина.

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

Request

POST

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

Path parameters

Name

Type

Description

campaignId*

integer<int64>

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

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

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

Body

application/json
{
    "licenses": [
        {
            "id": 0,
            "outletId": 0,
            "licenseType": "ALCOHOL",
            "number": "string",
            "dateOfIssue": "2022-12-29T18:02:01Z",
            "dateOfExpiry": "2022-12-29T18:02:01Z"
        }
    ]
}

Name

Type

Description

licenses*

OutletLicenseDTO[]

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

OutletLicenseDTO

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

Name

Type

Description

id

integer<int64>

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

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

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

outletId

integer<int64>

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

licenseType

LicenseType

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

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


Enum: ALCOHOL, UNKNOWN

number

string

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

dateOfIssue

string<date-time>

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

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

Обязательный параметр.

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

dateOfExpiry

string<date-time>

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

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

Обязательный параметр.

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

LicenseType

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

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

Type

Description

LicenseType

Enum: ALCOHOL, UNKNOWN

Responses

200 OK

Пустой ответ

Body

application/json
{
    "status": "OK"
}

Name

Type

Description

status

ApiResponseStatusType

Тип ответа.
Enum: OK, ERROR

ApiResponseStatusType

Тип ответа.

Type

Description

ApiResponseStatusType

Enum: OK, ERROR

400 Bad Request

Запрос содержит неправильные данные.

Body

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

Name

Type

Description

status

ApiResponseStatusType

Тип ответа.
Enum: OK, ERROR

errors

ApiErrorDTO[]

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

ApiErrorDTO

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

Name

Type

Description

code*

string

Код ошибки.

message

string

Описание ошибки.

401 Unauthorized

В запросе не указаны данные для авторизации.

Body

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

Name

Type

Description

status

ApiResponseStatusType

Тип ответа.
Enum: OK, ERROR

errors

ApiErrorDTO[]

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

403 Forbidden

Данные для авторизации неверны или доступ к ресурсу запрещен.

Body

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

Name

Type

Description

status

ApiResponseStatusType

Тип ответа.
Enum: OK, ERROR

errors

ApiErrorDTO[]

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

404 Not Found

Запрашиваемый ресурс не найден.

Body

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

Name

Type

Description

status

ApiResponseStatusType

Тип ответа.
Enum: OK, ERROR

errors

ApiErrorDTO[]

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

420 Method Failure

Превышено ограничение на доступ к ресурсу.

Body

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

Name

Type

Description

status

ApiResponseStatusType

Тип ответа.
Enum: OK, ERROR

errors

ApiErrorDTO[]

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

500 Internal Server Error

Внутренняя ошибка сервера.

Body

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

Name

Type

Description

status

ApiResponseStatusType

Тип ответа.
Enum: OK, ERROR

errors

ApiErrorDTO[]

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