为销售点创建和更改许可证

方法适用于模式DBS.

如果您使用API-Key令牌,调用该方法时需要具备列表中可用权限之一
  • settings-management — 店铺设置
  • all-methods — 全面管理账户

传输有关销售点的新许可证和现有许可证的信息。 仅支持酒精零售许可证。

要将酒精饮料放在市场上,您还必须发送保证书(如果您以前没有这样做),并正确安排价格表中的优惠。 接下来,检查许可证信息。

⚙️ 限制: 每小时100,000次请求

Request

POST

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

Path parameters

Name

Description

campaignId*

Type: integer<int64>

活动ID。

您可以使用查询找到它 GET v2/campaigns 或者在市场上的卖家办公室找到 — 点击您的帐户图标→ 设置 在左边的菜单中,选择 Api和模块:

  • 运动ID;
  • 标签 查询日志 →块中的下拉列表 显示日志.

⚠️ 不要发送商店ID,这是在市场上的卖家帐户旁边的商店名称和一些报告。

Min value: 1

Body

application/json
{
    "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"
        }
    ]
}

Name

Description

licenses*

Type: OutletLicenseDTO[]

许可证列表。 必需参数必须包含有关至少一个许可证的信息。
许可证信息。

Min items: 1

Max items: 500

OutletLicenseDTO

许可证信息。

Name

Description

dateOfExpiry*

Type: string<date-time>

许可证到期日期。

日期格式: ISO 8601 具有相对于 UTC. 有必要传送许可证上注明的日期,时间 00:00:00 和与销售点的区域相对应的时区。 例如,如果莫斯科销售点的许可证于2022年11月20日结束,则该参数应具有该值 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 和与销售点的区域相对应的时区。 例如,如果莫斯科销售点的许可证于2017年11月13日颁发,则该参数应具有该值 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>

许可证有效的销售点ID。

Min value: 1

id

Type: integer<int64>

许可证ID。

仅当您需要更改有关现有许可证的信息时才指定此参数。 您可以使用请求查找其ID。 GET v2/campaigns/{campaignId}/outlets/licenses. 在传输有关新许可证的信息时,不需要指定ID。

许可证ID由Yandex分配。市场。 不要将其与许可证号混淆:它在参数中传递 number.

LicenseType

许可证类型:

  • ALCOHOL — 酒精饮料零售许可证。
  • UNKNOWN — 未知许可证类型。

Type

Description

LicenseType

Enum: ALCOHOL, UNKNOWN

Responses

200 OK

一个空洞的答案。

Body

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

Name

Description

status*

Type: ApiResponseStatusType

响应的类型。 可能的值:

  • OK — 没有错误。
  • ERROR — 处理请求时出错。

Enum: OK, ERROR

ApiResponseStatusType

响应的类型。 可能的值:

  • OK — 没有错误。
  • ERROR — 处理请求时出错。

Type

Description

ApiResponseStatusType

Enum: OK, ERROR

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.