按其名称搜索区域

Info

Console

方法适用于模式：FBY, FBS, 快递和DBS.

如果您使用API-Key令牌，调用该方法时需要具备列表中可用权限之一

inventory-and-order-processing — 订单处理和商品核算
inventory-and-order-processing:read-only — 查看订单信息
pricing — 价格管理
pricing:read-only — 查看价格
offers-and-cards-management — 商品和卡片管理
offers-and-cards-management:read-only — 查看商品和卡片
promotion — 商品推广
promotion:read-only — 查看商品推广信息
finance-and-accounting — 查看财务信息和报告
communication — 与买家沟通
settings-management — 店铺设置
supplies-management:read-only — 获取有关FBY应用程序的信息
all-methods — 全面管理账户
all-methods:read-only — 查看所有数据

返回有关满足查询中指定的搜索条件的区域的信息。

如果找到满足搜索条件的多个区域，则为找到的每个区域（但不超过十个区域）返回信息，以按父区域确定所需的区域。

对于方法 获取v2/地区, GETv2/regions/{regionId} 和 GETv2/regions/{regionId}/children 组资源限制生效。该限制是对区域总数施加的，使用这些方法请求哪些信息（不超过100,000个区域）。

白天可以完成的对资源的请求量取决于区域的总数。

参数的限制 limit

不要传递大于20的值。

⚙️ 限制：每小时50,000个请求

Request

GET

https://api.partner.market.yandex.ru/v2/regions

Query parameters

Name	Description
name*	Type: string 区域的名称。重要的是要考虑到大小写：第一个字母应该是大写的，其余的应该是小写的。例如, `Москва`.
limit	Type: integer<int32> 每页的值数。 Min value: `1` Example: `20`
page_token	Type: string 结果页面的ID。如果省略该参数，则返回第一页。我们建议传输输出参数的值 `nextPageToken`，在最后一次请求期间接收。如果设置 `page_token` 并且请求有参数 `page` 和 `pageSize` 它们被忽略了。 Example: `eyBuZXh0SWQ6IDIzNDIgfQ==`

Responses

200 OK

找到的区域的列表。

Body

application/json

{
    "regions": [
        {
            "id": 0,
            "name": "string",
            "type": "OTHER"
        }
    ],
    "paging": {
        "nextPageToken": "string"
    }
}

Name

Description

regions*

Type: RegionDTO[]

的输送区域。
的输送区域。

paging

Type: ForwardScrollingPagerDTO

Идентификатор следующей страницы.

RegionDTO

的输送区域。

Name	Description
id*	Type: integer<int64> 区域的ID。
name*	Type: string 区域的名称。
type*	Type: RegionType 区域的类型。可能的值: `CITY_DISTRICT` -城市的面积。 `CITY` -一个大城市。 `CONTINENT` -大陆。 `COUNTRY_DISTRICT` -区域。 `COUNTRY` -国家。 `REGION` -地区。 `REPUBLIC_AREA` -联邦主体区。 `REPUBLIC` -联邦的主题。 `SUBWAY_STATION` -地铁站。 `VILLAGE` -城市。 `OTHER` -未知区域。 Enum: `OTHER`, `CONTINENT`, `REGION`, `COUNTRY`, `COUNTRY_DISTRICT`, `REPUBLIC`, `CITY`, `VILLAGE`, `CITY_DISTRICT`, `SUBWAY_STATION`, `REPUBLIC_AREA`
parent	Type: RegionDTO 的输送区域。

ForwardScrollingPagerDTO

下一页的ID。

Name

Description

nextPageToken

Type: string

下一个结果页面的ID。

RegionType

区域的类型。

可能的值:

CITY_DISTRICT -城市的面积。
CITY -一个大城市。
CONTINENT -大陆。
COUNTRY_DISTRICT -区域。
COUNTRY -国家。
REGION -地区。
REPUBLIC_AREA -联邦主体区。
REPUBLIC -联邦的主题。
SUBWAY_STATION -地铁站。
VILLAGE -城市。
OTHER -未知区域。

Type	Description
RegionType	Enum: `OTHER`, `CONTINENT`, `REGION`, `COUNTRY`, `COUNTRY_DISTRICT`, `REPUBLIC`, `CITY`, `VILLAGE`, `CITY_DISTRICT`, `SUBWAY_STATION`, `REPUBLIC_AREA`

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

ApiErrorDTO

一般错误格式。

Name

Description

code*

Type: string

的错误代码。

message

Type: string

错误的描述。

ApiResponseStatusType

响应的类型。可能的值:

OK -没有错误。
ERROR -处理请求时发生错误。

Type	Description
ApiResponseStatusType	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

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

Yandex的内部错误。市场。有关错误的更多信息

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

这篇文章是否有用？

国家代码列表

有关地区的资料