有关销售点许可证的信息

Info

Console

方法适用于模式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>

活动ID。

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

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

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

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

您需要获取有关许可证信息的销售点Id列表。标识符用逗号分隔。

请求必须包含参数 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` 和与销售点的区域相对应的时区。例如，如果莫斯科销售点的许可证于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`
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> 许可证ID。仅当您需要更改有关现有许可证的信息时才指定此参数。您可以使用请求查找其ID。 GET v2/campaigns/{campaignId}/outlets/licenses. 在传输有关新许可证的信息时，不需要指定ID。许可证ID由Yandex分配。市场。不要将其与许可证号混淆：它在参数中传递 `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

这篇文章是否有用？

移走

创建和修改