关于多个销售点的信息
方法适用于模式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<int64> 活动ID。 您可以使用查询找到它 GET v2/campaigns 或者在市场上的卖家办公室找到 — 点击您的帐户图标→ 设置 在左边的菜单中,选择 Api和模块:
⚠️ 不要发送商店ID,这是在市场上的卖家帐户旁边的商店名称和一些报告。
Min value: |
Query parameters
|
Name |
Description |
|
limit |
Type: integer<int32> 每页的值数。
Min value: |
|
page_token |
Type: string 结果页面的ID。 如果省略该参数,则返回第一页。 我们建议传输输出参数的值 如果设置 |
|
regionId ⦸
|
Type: integer<int64> 相反,使用 |
|
region_id |
Type: integer<int64> 区域的ID。 如果在任何级别设置父区域的ID,则输出数据将显示所有子区域的销售点。 您可以使用以下方法获取区域ID GET v2/regions. |
|
shop_outlet_code |
Type: string 店分配的销售点的ID。 |
Responses
200 OK
关于销售点的信息。
Body
application/json
{
"outlets": [
{
"name": "string",
"type": "DEPOT",
"coords": "string",
"isMain": false,
"shopOutletCode": "string",
"visibility": "HIDDEN",
"address": {
"regionId": 0,
"street": "string",
"number": "string",
"building": "string",
"estate": "string",
"block": "string",
"additional": "string",
"km": 0,
"city": "string"
},
"phones": [
"string"
],
"workingSchedule": {
"workInHoliday": false,
"scheduleItems": [
{
"startDay": "MONDAY",
"endDay": "MONDAY",
"startTime": "09:59",
"endTime": "23:59"
}
]
},
"deliveryRules": [
{
"minDeliveryDays": 0,
"maxDeliveryDays": 0,
"deliveryServiceId": 0,
"orderBefore": 0,
"priceFreePickup": 0,
"unspecifiedDeliveryInterval": false
}
],
"storagePeriod": 0,
"id": 0,
"status": "AT_MODERATION",
"region": {
"id": 0,
"name": "string",
"type": "OTHER"
},
"shopOutletId": "string",
"workingTime": "string",
"moderationReason": "string"
}
],
"paging": {
"nextPageToken": "string",
"prevPageToken": "string"
},
"pager": {
"total": 0,
"from": 0,
"to": 0,
"currentPage": 0,
"pagesCount": 0,
"pageSize": 0
}
}
|
Name |
Description |
||||||||||||
|
outlets* |
Type: object[] 关于销售点的信息。 |
||||||||||||
|
pager |
Type: object
分页的模型。 |
||||||||||||
|
paging |
Type: object
有关结果页的信息。 |
400 Bad Request
请求包含不正确的数据。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: object[] 错误列表。 Min items: |
|
status |
Type: string 响应的类型。 可能的值:
Enum: |
401 Unauthorized
请求中未指定授权数据。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: object[] 错误列表。 Min items: |
|
status |
Type: string 响应的类型。 可能的值:
Enum: |
403 Forbidden
授权数据不正确或禁止访问资源。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: object[] 错误列表。 Min items: |
|
status |
Type: string 响应的类型。 可能的值:
Enum: |
404 Not Found
找不到请求的资源。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: object[] 错误列表。 Min items: |
|
status |
Type: string 响应的类型。 可能的值:
Enum: |
420 Method Failure
已超出资源访问限制。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: object[] 错误列表。 Min items: |
|
status |
Type: string 响应的类型。 可能的值:
Enum: |
500 Internal Server Error
市场的内部错误。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: object[] 错误列表。 Min items: |
|
status |
Type: string 响应的类型。 可能的值:
Enum: |
No longer supported, please use an alternative and newer version.