Список складов

Info

Console

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

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

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

Возвращает список складов и информацию о них.

Ограничение для параметра limit

Не передавайте значение больше 25.

⚙️ Лимит: 1 000 запросов в час

Request

POST

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

Path parameters

Name

Description

businessId*

Type: integer<int64>

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

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

Min value: 1

Query parameters

Name

Description

limit

Type: integer<int32>

Количество значений на одной странице.

Min value: 1
Example: 20

page_token

Type: string

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуем передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры page и pageSize, они игнорируются.
Example: eyBuZXh0SWQ6IDIzNDIgfQ==

Body

application/json

{
    "components": [
        "ADDRESS"
    ],
    "campaignIds": [
        0
    ]
}

Name

Description

campaignIds

Type: integer[]

Список идентификаторов кампании тех магазинов, склады которых необходимо вернуть.

Их можно узнать с помощью запроса GET v2/campaigns или найти в кабинете продавца на Маркете — нажмите на иконку вашего аккаунта → Настройки и в меню слева выберите API и модули:

блок Идентификатор кампании;
вкладка Лог запросов → выпадающий список в блоке Показывать логи.

⚠️ Не используйте вместо них идентификаторы магазинов, которые указаны в кабинете продавца на Маркете рядом с названием магазина и в некоторых отчетах.

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

Идентификатор следующей страницы.

WarehouseDetailsDTO

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

Name	Description
campaignId*	Type: integer<int64> Идентификатор кампании того магазина, который связан со складом. Его можно узнать с помощью запроса GET v2/campaigns или найти в кабинете продавца на Маркете — нажмите на иконку вашего аккаунта → Настройки и в меню слева выберите API и модули: блок Идентификатор кампании; вкладка Лог запросов → выпадающий список в блоке Показывать логи. ⚠️ Не передавайте вместо него идентификатор магазина, который указан в кабинете продавца на Маркете рядом с названием магазина и в некоторых отчетах.
express*	Type: boolean Возможна ли доставка для модели Экспресс.
id*	Type: integer<int64> Идентификатор склада.
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

Идентификатор следующей страницы.

Name

Description

nextPageToken

Type: string

Идентификатор следующей страницы результатов.

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>

Идентификатор группы складов.

name*

Type: string

Название группы, к которой принадлежит склад.

WarehouseStatusDTO

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

Name

Description

status*

Type: WarehouseStatusType

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

DISABLED_MANUALLY – отключен вами.
OTHER – другой статус. Например, склад включен или отключен Маркетом.

Enum: DISABLED_MANUALLY, OTHER

GpsDTO

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

Name

Description

latitude*

Type: number

Широта.

longitude*

Type: number

Долгота.

WarehouseStatusType

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

DISABLED_MANUALLY – отключен вами.
OTHER – другой статус. Например, склад включен или отключен Маркетом.

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

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

Отправка файла

Изменение статуса склада