仓库一览表
方法适用于模式:FBS, Express 和 DBS.
如果您使用API-Key令牌,调用该方法时需要具备列表中可用权限之一
返回仓库列表及其相关信息。
参数的限制 limit
不传输大于25的值。
| ⚙️ 限制: 每小时1,000个请求 |
|---|
Request
POST
https://api.partner.market.yandex.ru/v2/businesses/{businessId}/warehouses
Path parameters
|
Name |
Description |
|
businessId |
Type: integer 内阁ID。 要找到答案,请使用请求 GET v2/campaigns. Min value: |
Query parameters
|
Name |
Description |
|
limit |
Type: integer 每页的值数。 Min value: |
|
page_token |
Type: string 结果页面的ID。 如果省略该参数,则返回第一页。 我们建议传输输出参数的值 如果设置 Example: |
Body
application/json
{
"components": [
"ADDRESS"
],
"campaignIds": [
1
]
}
|
Name |
Description |
|
campaignIds |
Type: integer[] | null 需要退回仓库的商店的活动Id列表。 您可以使用查询找到它们。 GET v2/campaigns 或者在市场上的卖家办公室找到 — 点击您的帐户图标→ 设置 在左边的菜单中,选择 Api和模块:
⚠️ 请勿使用商店Id,这些Id列在商店名称旁边的市场上的卖家帐户和某些报告中。 Min items: Max items: Unique items: Example
|
|
components |
Type: string[] | null 需要返回的仓库的属性。 如果省略了某些参数值,则此信息将不包含在响应中。 仅当您需要它返回的信息时才传递参数。 您可以一次传递多个值。 Min items: Unique items: Example
|
Responses
200 OK
您请求的仓库及其属性的列表。
Body
application/json
{
"status": "OK",
"result": {
"warehouses": [
{
"id": 0,
"name": "example",
"campaignId": 1,
"express": true,
"groupInfo": {},
"address": {},
"status": {}
}
],
"paging": {
"nextPageToken": "example"
}
}
}
Type: object
All of 2 types
-
Type: object
status
Type: string
响应的类型。 可能的值:
OK— 没有错误。ERROR— 处理请求时出错。
Enum:
OK,ERROR服务器响应的标准包装器。
Example
{ "status": "OK" } -
Type: object
result
Type: object
warehouses
Type: object[]
campaignId
Type: integer
广告系列(商店)的ID — 通过API工作时,代表您在Yandex市场系统中的商店的技术标识符。 它与您的商店唯一链接,但仅用于自动交互。
您可以使用查询找到它 GET v2/campaigns 或者在市场上的卖家办公室找到它。 点击您的帐户图标→ 设置 在左边的菜单中,选择 Api和模块:
- 座 运动ID;
- 标签 查询日志 →块中的下拉列表 显示日志.
⚠️ 不要把它与:
- 商店的标识符,显示在商家的个人帐户中。
- 广告活动。
Min value:
1express
Type: boolean
模型是否可能交付 Express.
id
Type: integer
仓库ID。
name
Type: string
仓库的名称。
Example:
exampleaddress
Type: object
city
Type: string
城市。
Max length:
200Example:
examplegps
Type: object
latitude
Type: number
宽度。
longitude
Type: number
经度。
纬度和经度的GPS坐标。
Example
{ "latitude": 0.5, "longitude": 0.5 }block
Type: string
建筑物编号。
Max length:
16Example:
examplebuilding
Type: string
建筑物编号。
Max length:
16Example:
examplenumber
Type: string
门牌号。
Max length:
256Example:
examplestreet
Type: string
街道。
Max length:
512Example:
example仓库地址。
Example
{ "city": "example", "street": "example", "number": "example", "building": "example", "block": "example", "gps": { "latitude": 0.5, "longitude": 0.5 } }groupInfo
Type: object
id
Type: integer
仓库组的ID。
name
Type: string
仓库所属的组的名称。
Example:
example仓所属组的信息。
它只为成组的仓库返回。
Example
{ "name": "example", "id": 0 }status
Type: object
status
Type: string
仓库状况:
DISABLED_MANUALLY-被你禁用。OTHER-不同的状态。 例如,yandex启用或禁用仓库。 市场。
Enum:
DISABLED_MANUALLY,OTHER仓库状态的信息。
Example
{ "status": "DISABLED_MANUALLY" }仓库列表。
Example
[ { "id": 0, "name": "example", "campaignId": 1, "express": true, "groupInfo": { "name": "example", "id": 0 }, "address": { "city": "example", "street": "example", "number": "example", "building": "example", "block": "example", "gps": { "latitude": 0.5, "longitude": 0.5 } }, "status": { "status": "DISABLED_MANUALLY" } } ]paging
Type: object
nextPageToken
Type: string
下一个结果页面的ID。
Example:
example下一页的ID。
Example
{ "nextPageToken": "example" }关于内阁仓库的信息。
Example
{ "warehouses": [ { "id": 0, "name": "example", "campaignId": 1, "express": true, "groupInfo": { "name": "example", "id": 0 }, "address": { "city": "example", "street": "example", "number": "example", "building": "example", "block": "example", "gps": { "latitude": 0.5, "longitude": 0.5 } }, "status": { "status": "DISABLED_MANUALLY" } } ], "paging": { "nextPageToken": "example" } }Example
{ "result": { "warehouses": [ { "id": 0, "name": "example", "campaignId": 1, "express": true, "groupInfo": { "name": "example", "id": 0 }, "address": { "city": "example", "street": "example", "number": "example", "building": "example", "block": "example", "gps": {} }, "status": { "status": "DISABLED_MANUALLY" } } ], "paging": { "nextPageToken": "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:
examplemessage
Type: string
错误的描述。
Example:
example错误列表。
Min items:
1Example
[ { "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:
examplemessage
Type: string
错误的描述。
Example:
example错误列表。
Min items:
1Example
[ { "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:
examplemessage
Type: string
错误的描述。
Example:
example错误列表。
Min items:
1Example
[ { "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:
examplemessage
Type: string
错误的描述。
Example:
example错误列表。
Min items:
1Example
[ { "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:
examplemessage
Type: string
错误的描述。
Example:
example错误列表。
Min items:
1Example
[ { "code": "example", "message": "example" } ]Example
{ "errors": [ { "code": "example", "message": "example" } ] }
服务器错误的标准包装器。
Example
{ "status": "OK", "errors": [ { "code": "example", "message": "example" } ] } -
No longer supported, please use an alternative and newer version.