用户的商店列表

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

如果方法有 page_token

用它代替参数 page.

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

结果页的编号。

与参数一起使用 pageSize.

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

Default: 1

Max value: 10000

pageSize

Type: integer

页面大小。

与参数一起使用 page.

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

Responses

200 OK

用户的商店。

Body

application/json

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

Name

Description

campaigns

Type: object[]

apiAvailability

Type: string

使用API的能力:

AVAILABLE — API方法可用于执行请求。
DISABLED_BY_INACTIVITY — API方法不可用，因为商店没有在展柜中放置产品超过90天。
DISABLED_BY_NO_ACTIVE_CONTRACT — 由于缺乏与Yandex的有效合同，API方法不可用。市场。
MANUALLY_DISABLED — API方法不可用，因为手动禁用了集成。
DISABLED_BY_NO_PLACEMENT_TYPE — API方法不可用，因为商店未连接到放置程序。

恢复访问的详细说明

Enum: AVAILABLE, DISABLED_BY_INACTIVITY, DISABLED_BY_NO_ACTIVE_CONTRACT, MANUALLY_DISABLED, DISABLED_BY_NO_PLACEMENT_TYPE

business

Type: object

Type: integer

内阁ID。要找到答案，请使用请求 GET v2/campaigns.

ℹ️ 什么是市场上的橱柜和商店？

Min value: 1

name

Type: string

企业名称。

Example: example

柜的信息。

Example

{
  "id": 1,
  "name": "example"
}

clientId

Type: integer

付款人在Yandex中的ID。平衡。

domain

Type: string

这家商店的名字。

Example: example

Type: integer

广告系列（商店）的ID — 通过API工作时，代表您在Yandex市场系统中的商店的技术标识符。它与您的商店唯一链接，但仅用于自动交互。

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

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

⚠️ 不要把它与:

商店的标识符，显示在商家的个人帐户中。
广告活动。

Min value: 1

placementType

Type: string

商店使用的模型:

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

Enum: FBS, FBY, DBS, LAAS

每个商店的信息列表。

Example

[
  {
    "domain": "example",
    "id": 1,
    "clientId": 0,
    "business": {
      "id": 1,
      "name": "example"
    },
    "placementType": "FBS",
    "apiAvailability": "AVAILABLE"
  }
]

pager

Type: object

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

分页的模型。

Example

{
  "total": 0,
  "from": 0,
  "to": 0,
  "currentPage": 0,
  "pagesCount": 0,
  "pageSize": 0
}

400 Bad Request

请求包含不正确的数据。有关错误的更多信息

Body

application/json

{
  "status": "OK"
}

Type: object

401 Unauthorized

请求中未指定授权数据。有关错误的更多信息

Body

application/json

{
  "status": "OK"
}

Type: object

403 Forbidden

授权数据不正确或禁止访问资源。有关错误的更多信息

Body

application/json

{
  "status": "OK"
}

Type: object

404 Not Found

找不到请求的资源。有关错误的更多信息

Body

application/json

{
  "status": "OK"
}

Type: object

420 Method Failure

已超出资源访问限制。有关错误的更多信息

Body

application/json

{
  "status": "OK"
}

Type: object

500 Internal Server Error

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

Body

application/json

{
  "status": "OK"
}

Type: object

这篇文章是否有用？

所有更新

商店资料