有关儿童地区的资料

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 — 查看所有数据

返回有关区域的信息，这些区域是请求中指定其ID的区域的子区域。

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

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

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

Request

GET

https://api.partner.market.yandex.ru/v2/regions/{regionId}/children

Path parameters

Name

Description

regionId*

Type: integer<int64>

区域的ID。

您可以使用请求获取区域ID :no-translate[GET v2/regions].

Query parameters

Name

Description

page

Type: integer<int32>

如果方法有 page_token

用它代替参数 page.

了解有关分页类型及其使用的更多信息

结果页的编号。

与参数一起使用 pageSize.

page 如果指定，则忽略 page_token 或 limit.

Default: 1

Max value: 10000

pageSize

Type: integer<int32>

页面大小。

与参数一起使用 page.

pageSize 如果指定，则忽略 page_token 或 limit.

Responses

200 OK

是请求中指定的区域的子区域。

Body

application/json

{
    "pager": {
        "total": 0,
        "from": 0,
        "to": 0,
        "currentPage": 0,
        "pagesCount": 0,
        "pageSize": 0
    },
    "regions": {
        "id": 0,
        "name": "string",
        "type": "OTHER",
        "parent": {
            "id": 0,
            "name": "string",
            "type": "OTHER"
        },
        "children": [
            {
                "id": 0,
                "name": "string",
                "type": "OTHER"
            }
        ]
    }
}

Name

Description

pager

Type: FlippingPagerDTO

分页的模型。

regions

Type: RegionWithChildrenDTO

有关父区域和子区域的信息。
的输送区域。

FlippingPagerDTO

分页的模型。

Name	Description
currentPage	Type: integer<int32> 当前页面。
from	Type: integer<int32> 页上找到的元素的初始编号。
pageSize	Type: integer<int32> 页面大小。
pagesCount	Type: integer<int32> 的总页数。
to	Type: integer<int32> 页上找到的元素的最终编号。
total	Type: integer<int32> 总共找到了多少件物品。

RegionWithChildrenDTO

有关父区域和子区域的信息。

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`
children	Type: RegionDTO[] 子区域。的输送区域。 Min items: `1`
parent	Type: RegionDTO 的输送区域。

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`

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 的输送区域。

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

错误的描述。

ApiResponseStatusType

响应的类型。可能的值:

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

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

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

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

这篇文章是否有用？

有关地区的资料

添加和编辑产品