Список складов и групп складов
Возвращает список складов и, если склады объединены, список групп складов. Что такое группы складов и зачем они нужны
Среди прочего запрос позволяет определить идентификатор, который нужно использовать при передаче остатков для группы складов.
| ⚙️ Лимит: 100 запросов в минуту |
|---|
Request
GET
https://api.partner.market.yandex.ru/businesses/{businessId}/warehouses
Path parameters
|
Name |
Type |
Description |
|
businessId* |
integer<int64> |
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns. |
Responses
200 OK
Список складов и групп складов.
Body
{
"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 |
Type |
Description |
|
status |
Тип ответа.
|
|
|
result |
Информация о складах и группах складов. |
WarehousesDTO
Информация о складах и группах складов.
|
Name |
Type |
Description |
|
warehouses |
Список складов, не входящих в группы. |
|
|
warehouseGroups |
Список групп складов. |
WarehouseDTO
Информация о складе.
|
Name |
Type |
Description |
|
id* |
integer<int64> |
Идентификатор склада. |
|
name* |
string |
Название склада. |
|
campaignId* |
integer<int64> |
Идентификатор кампании в API и идентификатор магазина. |
|
express* |
boolean |
Возможна ли доставка по модели Экспресс. |
|
address |
Адрес склада. |
WarehouseGroupDTO
Информация о группе складов.
|
Name |
Type |
Description |
|
name* |
string |
Название группы складов. |
|
mainWarehouse* |
Склад, идентификатор которого нужно использовать для передачи остатков по всей группе. |
|
|
warehouses* |
Список складов, входящих в группу. |
WarehouseAddressDTO
Адрес склада.
|
Name |
Type |
Description |
|
city* |
string |
Город.
|
|
street |
string |
Улица.
|
|
number |
string |
Номер дома.
|
|
building |
string |
Номер строения.
|
|
block |
string |
Номер корпуса.
|
|
gps* |
GPS-координаты широты и долготы. |
GpsDTO
GPS-координаты широты и долготы.
|
Name |
Type |
Description |
|
latitude* |
number<decimal> |
Широта. |
|
longitude* |
number<decimal> |
Долгота. |
400 Bad Request
Запрос содержит неправильные данные.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Type |
Description |
|
status |
Тип ответа.
|
|
|
errors |
Список ошибок. |
ApiErrorDTO
Общий формат ошибки.
|
Name |
Type |
Description |
|
code* |
string |
Код ошибки. |
|
message |
string |
Описание ошибки. |
401 Unauthorized
В запросе не указаны данные для авторизации.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Type |
Description |
|
status |
Тип ответа.
|
|
|
errors |
Список ошибок. |
403 Forbidden
Данные для авторизации неверны или доступ к ресурсу запрещен.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Type |
Description |
|
status |
Тип ответа.
|
|
|
errors |
Список ошибок. |
404 Not Found
Запрашиваемый ресурс не найден.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Type |
Description |
|
status |
Тип ответа.
|
|
|
errors |
Список ошибок. |
420 Method Failure
Превышено ограничение на доступ к ресурсу.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Type |
Description |
|
status |
Тип ответа.
|
|
|
errors |
Список ошибок. |
500 Internal Server Error
Внутренняя ошибка сервера.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Type |
Description |
|
status |
Тип ответа.
|
|
|
errors |
Список ошибок. |