仓库一览表

方法适用于模式: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<int64>

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

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

Min value: 1

Query parameters

Name

Description

limit

Type: integer<int32>

每页的值数。

Min value: 1
Example: 20

page_token

Type: string

结果页面的ID。

如果省略该参数,则返回第一页。

我们建议传输输出参数的值 nextPageToken,在最后一次请求期间接收。

如果设置 page_token 并且请求有参数 pagepageSize 它们被忽略了。
Example: eyBuZXh0SWQ6IDIzNDIgfQ==

Body

application/json
{
    "components": [
        "ADDRESS"
    ],
    "campaignIds": [
        0
    ]
}

Name

Description

campaignIds

Type: integer<int64>[]

需要退回仓库的商店的活动Id列表。

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

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

⚠️ 请勿使用商店Id,这些Id列在商店名称旁边的市场上的卖家帐户和某些报告中。

Min value: 1

Min items: 1

Max items: 25

Unique items  

components

Type: WarehouseComponentType[]

需要返回的仓库的属性。 如果省略了某些参数值,则此信息将不包含在响应中。

仅当您需要它返回的信息时才传递参数。

您可以一次传递多个值。
需要返回的仓库属性:

  • ADDRESS — 仓库地址。
  • STATUS — 仓库的状态。

Enum: ADDRESS, STATUS

Min items: 1

Unique items  

WarehouseComponentType

需要返回的仓库属性:

  • ADDRESS — 仓库地址。
  • STATUS — 仓库的状态。

Type

Description

WarehouseComponentType

Enum: ADDRESS, STATUS

Responses

200 OK

您请求的仓库及其属性的列表。

Body

application/json
{
    "status": "OK",
    "result": {
        "warehouses": [
            {
                "id": 0,
                "name": "string",
                "campaignId": 0,
                "express": false,
                "groupInfo": {
                    "name": "string",
                    "id": 0
                },
                "address": {
                    "city": "string",
                    "street": "string",
                    "number": "string",
                    "building": "string",
                    "block": "string",
                    "gps": {
                        "latitude": 0,
                        "longitude": 0
                    }
                },
                "status": {
                    "status": "DISABLED_MANUALLY"
                }
            }
        ],
        "paging": {
            "nextPageToken": "string"
        }
    }
}

Name

Description

status*

Type: ApiResponseStatusType

响应的类型。 可能的值:

  • OK — 没有错误。
  • ERROR — 处理请求时出错。

Enum: OK, ERROR

result

Type: PagedWarehousesDTO

关于内阁仓库的信息。

ApiResponseStatusType

响应的类型。 可能的值:

  • OK — 没有错误。
  • ERROR — 处理请求时出错。

Type

Description

ApiResponseStatusType

Enum: OK, ERROR

PagedWarehousesDTO

关于内阁仓库的信息。

Name

Description

warehouses*

Type: WarehouseDetailsDTO[]

仓库列表。
有关仓库的信息。

paging

Type: ForwardScrollingPagerDTO

下一页的ID。

WarehouseDetailsDTO

有关仓库的信息。

Name

Description

campaignId*

Type: integer<int64>

与仓库关联的商店的市场活动ID。

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

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

⚠️ 不要发送商店ID,这是在市场上的卖家帐户旁边的商店名称和一些报告。

express*

Type: boolean

模型是否可能交付 Express.

id*

Type: integer<int64>

仓库ID。

name*

Type: string

仓库的名称。

address

Type: WarehouseAddressDTO

Адрес склада.

Возвращается, только если в запросе параметр components принимает значение ADDRESS.

groupInfo

Type: WarehouseGroupInfoDTO

仓所属组的信息。

它只为成组的仓库返回。

什么是仓库组,为什么需要它们?

status

Type: WarehouseStatusDTO

Статус склада.

Возвращается, только если в запросе параметр components принимает значение STATUS.

Статус склада, полученный через API, может не совпадать со статусом в кабинете

Например, сначала Маркет отключил склад, а затем вы с помощью метода POST v2/campaigns/{campaignId}/warehouse/status.

Статус в кабинете — Отключен Маркетом, а через API вернется DISABLED_MANUALLY (отключен вами).

ForwardScrollingPagerDTO

下一页的ID。

Name

Description

nextPageToken

Type: string

下一个结果页面的ID。

WarehouseAddressDTO

仓库地址。

Name

Description

city*

Type: string

城市。

Max length: 200

gps*

Type: GpsDTO

纬度和经度的GPS坐标。

block

Type: string

建筑物编号。

Max length: 16

building

Type: string

建筑物编号。

Max length: 16

number

Type: string

门牌号。

Max length: 256

street

Type: string

街道。

Max length: 512

WarehouseGroupInfoDTO

仓所属组的信息。

它只为成组的仓库返回。

什么是仓库组,为什么需要它们?

Name

Description

id*

Type: integer<int64>

仓库组的ID。

name*

Type: string

仓库所属的组的名称。

WarehouseStatusDTO

仓库状态的信息。

Name

Description

status*

Type: WarehouseStatusType

仓库状况:

  • DISABLED_MANUALLY -被你禁用。
  • OTHER -不同的状态。 例如,yandex启用或禁用仓库。 市场。

Enum: DISABLED_MANUALLY, OTHER

GpsDTO

纬度和经度的GPS坐标。

Name

Description

latitude*

Type: number

宽度。

longitude*

Type: number

经度。

WarehouseStatusType

仓库状况:

  • DISABLED_MANUALLY -被你禁用。
  • OTHER -不同的状态。 例如,yandex启用或禁用仓库。 市场。

Type

Description

WarehouseStatusType

Enum: DISABLED_MANUALLY, OTHER

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

错误的描述。

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

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

No longer supported, please use an alternative and newer version.