Список складов и групп складов

Deprecated

Info

Console

Метод доступен для моделей: FBS, Экспресс и DBS.

Если вы используете API-Key-токен, для вызова метода необходим один из доступов в списке

inventory-and-order-processing — Обработка заказов и учёт товаров
inventory-and-order-processing:read-only — Просмотр информации о заказах
all-methods — Полное управление кабинетом
all-methods:read-only — Просмотр всех данных

Этот метод устарел

Вместо него используйте POST businesses/{businessId}/warehouses.

Возвращает список складов и, если склады объединены, список групп складов. Что такое группы складов и зачем они нужны

Среди прочего запрос позволяет определить идентификатор, который нужно использовать при передаче остатков для группы складов.

⚙️ Лимит: 100 запросов в минуту

Request

GET

https://api.partner.market.yandex.ru/businesses/{businessId}/warehouses

Path parameters

Name

Description

businessId*

Type: integer<int64>

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

Min value: 1

Responses

200 OK

Список складов и групп складов.

Body

application/json

{
    "status": "OK",
    "result": {
        "warehouses": [
            {
                "id": 0,
                "name": "string",
                "campaignId": 0,
                "express": false,
                "address": {
                    "city": "string",
                    "street": "string",
                    "number": "string",
                    "building": "string",
                    "block": "string",
                    "gps": {
                        "latitude": 0,
                        "longitude": 0
                    }
                }
            }
        ],
        "warehouseGroups": [
            {
                "name": "string",
                "mainWarehouse": {
                    "id": 0,
                    "name": "string",
                    "campaignId": 0,
                    "express": false,
                    "address": {
                        "city": "string",
                        "street": "string",
                        "number": "string",
                        "building": "string",
                        "block": "string",
                        "gps": {
                            "latitude": 0,
                            "longitude": 0
                        }
                    }
                },
                "warehouses": [
                    {
                        "id": 0,
                        "name": "string",
                        "campaignId": 0,
                        "express": false,
                        "address": {
                            "city": "string",
                            "street": "string",
                            "number": "string",
                            "building": "string",
                            "block": "string",
                            "gps": {
                                "latitude": 0,
                                "longitude": 0
                            }
                        }
                    }
                ]
            }
        ]
    }
}

Name

Description

result

Type: WarehousesDTO

Информация о складах и группах складов.

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

WarehousesDTO

Информация о складах и группах складов.

Name

Description

warehouseGroups*

Type: WarehouseGroupDTO[]

Список групп складов.
Информация о группе складов.

warehouses*

Type: WarehouseDTO[]

Список складов, не входящих в группы.
Информация о складе.

ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

Type	Description
ApiResponseStatusType	Enum: `OK`, `ERROR`

WarehouseGroupDTO

Информация о группе складов.

Name	Description
mainWarehouse*	Type: WarehouseDTO Информация о складе.
name*	Type: string Название группы складов.
warehouses*	Type: WarehouseDTO[] Список складов, входящих в группу. Информация о складе.

WarehouseDTO

Информация о складе.

Name	Description
campaignId*	Type: integer<int64> Идентификатор магазина в кабинете.
express*	Type: boolean Возможна ли доставка по модели Экспресс.
id*	Type: integer<int64> Идентификатор склада.
name*	Type: string Название склада.
address	Type: WarehouseAddressDTO Адрес склада.

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`

GpsDTO

GPS-координаты широты и долготы.

Name

Description

latitude*

Type: number<decimal>

Широта.

longitude*

Type: number<decimal>

Долгота.

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

404 Not Found

Запрашиваемый ресурс не найден.

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

Была ли статья полезна?

Передача кодов «Честного знака»

Регион магазина