用户的商店列表

Info

Console

方法适用于模式：FBY, FBS, Express 和 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 — 查看所有数据

**为 Api-Key-令牌：**返回发出令牌的柜内商店名单。您无法获得仅子代理商店的列表。

**对于OAuth令牌：**返回用户有权访问的存储列表 — 请求中使用的授权令牌的所有者。对于代理用户，该列表由子代理存储组成。

⚙️ 限制: 每小时1,000个请求

Request

GET

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

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

{
    "campaigns": [
        {
            "domain": "string",
            "id": 0,
            "clientId": 0,
            "business": {
                "id": 0,
                "name": "string"
            },
            "placementType": "FBS",
            "apiAvailability": "AVAILABLE"
        }
    ],
    "pager": {
        "total": 0,
        "from": 0,
        "to": 0,
        "currentPage": 0,
        "pagesCount": 0,
        "pageSize": 0
    }
}

Name

Description

campaigns*

Type: CampaignDTO[]

每个商店的信息列表。
有关商店的信息。

pager

Type: FlippingPagerDTO

分页的模型。

CampaignDTO

有关商店的信息。

Name	Description
apiAvailability	Type: ApiAvailabilityStatusType 使用API的能力: `AVAILABLE` — API方法可用于执行请求。 `DISABLED_BY_INACTIVITY` — 由于[商店或橱柜不活动]，API方法不可用(inactivity). Enum:* `AVAILABLE`, `DISABLED_BY_INACTIVITY`
business	Type: BusinessDTO 柜的信息。
clientId ⦸	Type: integer<int64> 付款人在Yandex中的ID。平衡。
domain	Type: string 这家商店的名字。
id	Type: integer<int64> 活动ID。您可以使用查询找到它 GET v2/campaigns 或者在市场上的卖家办公室找到 — 点击您的帐户图标→ 设置在左边的菜单中，选择 Api和模块: 座运动ID; 标签查询日志 →块中的下拉列表显示日志. ⚠️ 不要发送商店ID，这是在市场上的卖家帐户旁边的商店名称和一些报告。
placementType	Type: PlacementType 商店使用的模型: `FBS` — FBS 或 Express. `FBY` — FBY. `DBS` — DBS. Enum: `FBS`, `FBY`, `DBS`, `LAAS`

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> 总共找到了多少件物品。

ApiAvailabilityStatusType

使用API的能力:

AVAILABLE — API方法可用于执行请求。
DISABLED_BY_INACTIVITY — 由于[商店或橱柜不活动]，API方法不可用(*inactivity).

Type	Description
ApiAvailabilityStatusType	Enum: `AVAILABLE`, `DISABLED_BY_INACTIVITY`

BusinessDTO

柜的信息。

Name

Description

Type: integer<int64>

内阁ID。

name

Type: string

企业名称。

PlacementType

商店使用的模型:

FBS — FBS 或 Express.
FBY — FBY.
DBS — DBS.

Type	Description
PlacementType	Enum: `FBS`, `FBY`, `DBS`, `LAAS`

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

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

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

这篇文章是否有用？

所有更新

商店资料