关于多个销售点的信息

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

Path parameters

Name

Description

campaignId

Type: integer

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

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

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

⚠️ 不要把它与:

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

Min value: 1

Query parameters

Name	Description
limit	Type: integer 每页的值数。 Min value: `1`
page_token	Type: string 结果页面的ID。如果省略该参数，则返回第一页。我们建议传输输出参数的值 `nextPageToken`，在最后一次请求期间接收。如果设置 `page_token` 并且请求有参数 `page` 和 `pageSize` 它们被忽略了。 Example: `eyBuZXh0SWQ6IDIzNDIgfQ==`
region_id	Type: integer 区域的ID。如果在任何级别设置父区域的ID，则输出数据将显示所有子区域的销售点。您可以使用以下方法获取区域ID GET v2/regions.
regionId	Type: integer 相反，使用 `region_id`.
shop_outlet_code	Type: string 店分配的销售点的ID。 Example: ``

Responses

200 OK

关于销售点的信息。

Body

application/json

{
  "outlets": [
    {
      "name": "example",
      "type": "DEPOT",
      "coords": "example",
      "isMain": true,
      "shopOutletCode": "example",
      "visibility": "HIDDEN",
      "address": {
        "regionId": 0,
        "street": "example",
        "number": "example",
        "building": "example",
        "estate": "example",
        "block": "example",
        "additional": "example",
        "km": 0,
        "city": "example"
      },
      "phones": [
        "example"
      ],
      "workingSchedule": {
        "workInHoliday": true,
        "scheduleItems": [
          null
        ]
      },
      "deliveryRules": [
        {}
      ],
      "storagePeriod": 0,
      "id": 0,
      "status": "AT_MODERATION",
      "region": {
        "id": 0,
        "name": "example",
        "type": "OTHER",
        "parent": null
      },
      "shopOutletId": "example",
      "workingTime": "example",
      "moderationReason": "example"
    }
  ],
  "paging": {
    "nextPageToken": "example",
    "prevPageToken": "example"
  },
  "pager": {
    "total": 0,
    "from": 0,
    "to": 0,
    "currentPage": 0,
    "pagesCount": 0,
    "pageSize": 0
  }
}

Name

Description

outlets

Type: object[]

关于销售点的信息。

Example

[
  {
    "name": "example",
    "type": "DEPOT",
    "coords": "example",
    "isMain": true,
    "shopOutletCode": "example",
    "visibility": "HIDDEN",
    "address": {
      "regionId": 0,
      "street": "example",
      "number": "example",
      "building": "example",
      "estate": "example",
      "block": "example",
      "additional": "example",
      "km": 0,
      "city": "example"
    },
    "phones": [
      "example"
    ],
    "workingSchedule": {
      "workInHoliday": true,
      "scheduleItems": [
        {}
      ]
    },
    "deliveryRules": [
      {
        "minDeliveryDays": 0,
        "maxDeliveryDays": 0,
        "deliveryServiceId": 0,
        "orderBefore": 0,
        "priceFreePickup": 0.5,
        "unspecifiedDeliveryInterval": true
      }
    ],
    "storagePeriod": 0,
    "id": 0,
    "status": "AT_MODERATION",
    "region": {
      "id": 0,
      "name": "example",
      "type": "OTHER",
      "parent": null
    },
    "shopOutletId": "example",
    "workingTime": "example",
    "moderationReason": "example"
  }
]

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
}

paging

Type: object

All of 2 types

Type: object

nextPageToken

Type: string

下一个结果页面的ID。

Example: example

下一页的ID。
Example
```
{
  "nextPageToken": "example"
}
```
Type: object

prevPageToken

Type: string

上一个结果页面的ID。

Example: example
Example
```
{
  "prevPageToken": "example"
}
```

有关结果页的信息。

Example

{
  "nextPageToken": "example",
  "prevPageToken": "example"
}

400 Bad Request

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

Body

application/json

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

Type: object

All of 2 types

Type: object
status
Type: string

响应的类型。可能的值:

OK — 没有错误。

ERROR — 处理请求时出错。

Enum: OK, ERROR
服务器响应的标准包装器。
Example
```
{
  "status": "OK"
}
```

Type: object

errors

Type: object[]

code

Type: string

的错误代码。

Example: example

message

Type: string

错误的描述。

Example: example

错误列表。

Min items: 1

Example

[
  {
    "code": "example",
    "message": "example"
  }
]

Example

{
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

服务器错误的标准包装器。

Example

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

401 Unauthorized

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

Body

application/json

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

Type: object

All of 2 types

Type: object
status
Type: string

响应的类型。可能的值:

OK — 没有错误。

ERROR — 处理请求时出错。

Enum: OK, ERROR
服务器响应的标准包装器。
Example
```
{
  "status": "OK"
}
```

Type: object

errors

Type: object[]

code

Type: string

的错误代码。

Example: example

message

Type: string

错误的描述。

Example: example

错误列表。

Min items: 1

Example

[
  {
    "code": "example",
    "message": "example"
  }
]

Example

{
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

服务器错误的标准包装器。

Example

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

403 Forbidden

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

Body

application/json

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

Type: object

All of 2 types

Type: object
status
Type: string

响应的类型。可能的值:

OK — 没有错误。

ERROR — 处理请求时出错。

Enum: OK, ERROR
服务器响应的标准包装器。
Example
```
{
  "status": "OK"
}
```

Type: object

errors

Type: object[]

code

Type: string

的错误代码。

Example: example

message

Type: string

错误的描述。

Example: example

错误列表。

Min items: 1

Example

[
  {
    "code": "example",
    "message": "example"
  }
]

Example

{
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

服务器错误的标准包装器。

Example

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

404 Not Found

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

Body

application/json

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

Type: object

All of 2 types

Type: object
status
Type: string

响应的类型。可能的值:

OK — 没有错误。

ERROR — 处理请求时出错。

Enum: OK, ERROR
服务器响应的标准包装器。
Example
```
{
  "status": "OK"
}
```

Type: object

errors

Type: object[]

code

Type: string

的错误代码。

Example: example

message

Type: string

错误的描述。

Example: example

错误列表。

Min items: 1

Example

[
  {
    "code": "example",
    "message": "example"
  }
]

Example

{
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

服务器错误的标准包装器。

Example

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

420 Method Failure

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

Body

application/json

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

Type: object

All of 2 types

Type: object
status
Type: string

响应的类型。可能的值:

OK — 没有错误。

ERROR — 处理请求时出错。

Enum: OK, ERROR
服务器响应的标准包装器。
Example
```
{
  "status": "OK"
}
```

Type: object

errors

Type: object[]

code

Type: string

的错误代码。

Example: example

message

Type: string

错误的描述。

Example: example

错误列表。

Min items: 1

Example

[
  {
    "code": "example",
    "message": "example"
  }
]

Example

{
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

服务器错误的标准包装器。

Example

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

500 Internal Server Error

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

Body

application/json

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

Type: object

All of 2 types

Type: object
status
Type: string

响应的类型。可能的值:

OK — 没有错误。

ERROR — 处理请求时出错。

Enum: OK, ERROR
服务器响应的标准包装器。
Example
```
{
  "status": "OK"
}
```

Type: object

errors

Type: object[]

code

Type: string

的错误代码。

Example: example

message

Type: string

错误的描述。

Example: example

错误列表。

Min items: 1

Example

[
  {
    "code": "example",
    "message": "example"
  }
]

Example

{
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

服务器错误的标准包装器。

Example

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

这篇文章是否有用？

一个销售点

创造