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

Метод доступен для моделей: FBS, Экспресс и 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

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

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

Min value: 1

Query parameters

Name

Description

limit

Type: integer

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

Min value: 1

page_token

Type: string

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

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

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

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

Example: eyBuZXh0SWQ6IDIzNDIgfQ==

Body

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

Name

Description

campaignIds

Type: CampaignId[] | null

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

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

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

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

Min items: 1

Max items: 25

Unique items: true

Example
[
  1
]

components

Type: WarehouseComponentType[] | null

Свойства складов, которые необходимо вернуть. Если какое-то значение параметра не задано, этой информации в ответе не будет.

Передавайте параметр, только если нужна информация, которую он возвращает.

Можно передать сразу несколько значений.

Min items: 1

Unique items: true

Example
[
  "ADDRESS"
]

WarehouseComponentType

Свойства складов, которые необходимо вернуть:

  • ADDRESS — адрес склада.
  • STATUS — статус склада.

Type: string

Enum: ADDRESS, STATUS

CampaignId

Идентификатор кампании (магазина) — технический идентификатор, который представляет ваш магазин в системе Яндекс Маркета при работе через API. Он однозначно связывается с вашим магазином, но предназначен только для автоматизированного взаимодействия.

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

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

⚠️ Не путайте его с:

  • идентификатором магазина, который отображается в личном кабинете продавца;
  • рекламными кампаниями.

Type: integer

Min value: 1

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: ApiResponse

    Стандартная обертка для ответов сервера.

    Example
    {
  "status": "OK"
}
  • Type: object

    result

    Type: PagedWarehousesDTO

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

    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"
    }
  }
}

ApiResponseStatusType

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

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

Type: string

Enum: OK, ERROR

ApiResponse

Стандартная обертка для ответов сервера.

Name

Description

status

Type: ApiResponseStatusType

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

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

Enum: OK, ERROR
Example
{
  "status": "OK"
}

WarehouseGroupInfoDTO

Информация о группе, к которой принадлежит склад.

Возвращается только для складов в группах.

Что такое группы складов и зачем они нужны

Name

Description

id

Type: integer

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

name

Type: string

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

Example: example
Example
{
  "name": "example",
  "id": 0
}

GpsDTO

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

Name

Description

latitude

Type: number

Широта.

longitude

Type: number

Долгота.
Example
{
  "latitude": 0.5,
  "longitude": 0.5
}

WarehouseAddressDTO

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

Name

Description

city

Type: string

Город.

Max length: 200

Example: example

gps

Type: GpsDTO

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

Example
{
  "latitude": 0.5,
  "longitude": 0.5
}

block

Type: string

Номер корпуса.

Max length: 16

Example: example

building

Type: string

Номер строения.

Max length: 16

Example: example

number

Type: string

Номер дома.

Max length: 256

Example: example

street

Type: string

Улица.

Max length: 512

Example: example
Example
{
  "city": "example",
  "street": "example",
  "number": "example",
  "building": "example",
  "block": "example",
  "gps": {
    "latitude": 0.5,
    "longitude": 0.5
  }
}

WarehouseStatusType

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

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

Type: string

Enum: DISABLED_MANUALLY, OTHER

WarehouseStatusDTO

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

Name

Description

status

Type: WarehouseStatusType

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

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

Enum: DISABLED_MANUALLY, OTHER
Example
{
  "status": "DISABLED_MANUALLY"
}

WarehouseDetailsDTO

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

Name

Description

campaignId

Type: CampaignId

Идентификатор кампании того магазина, который связан со складом.

Идентификатор кампании (магазина) — технический идентификатор, который представляет ваш магазин в системе Яндекс Маркета при работе через API. Он однозначно связывается с вашим магазином, но предназначен только для автоматизированного взаимодействия.

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

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

⚠️ Не путайте его с:

  • идентификатором магазина, который отображается в личном кабинете продавца;
  • рекламными кампаниями.

Min value: 1

Example: 1

express

Type: boolean

Возможна ли доставка для модели Экспресс.

id

Type: integer

Идентификатор склада.

name

Type: string

Название склада.

Example: example

address

Type: WarehouseAddressDTO

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

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

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

Example
{
  "city": "example",
  "street": "example",
  "number": "example",
  "building": "example",
  "block": "example",
  "gps": {
    "latitude": 0.5,
    "longitude": 0.5
  }
}

groupInfo

Type: WarehouseGroupInfoDTO

Информация о группе, к которой принадлежит склад.

Возвращается только для складов в группах.

Что такое группы складов и зачем они нужны

Example
{
  "name": "example",
  "id": 0
}

status

Type: WarehouseStatusDTO

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

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

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

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

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

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

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"
  }
}

ForwardScrollingPagerDTO

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

Name

Description

nextPageToken

Type: string

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

Example: example
Example
{
  "nextPageToken": "example"
}

PagedWarehousesDTO

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

Name

Description

warehouses

Type: WarehouseDetailsDTO[]

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

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: ForwardScrollingPagerDTO

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

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"
  }
}

400 Bad Request

Запрос содержит неправильные данные. Подробнее об ошибке

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

  • Type: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

    Example
    {
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

ApiErrorDTO

Общий формат ошибки.

Name

Description

code

Type: string

Код ошибки.

Example: example

message

Type: string

Описание ошибки.

Example: example
Example
{
  "code": "example",
  "message": "example"
}

ApiErrorResponse

Стандартная обертка для ошибок сервера.

Type: object

All of 2 types

  • Type: ApiResponse

    Стандартная обертка для ответов сервера.

    Example
    {
  "status": "OK"
}
  • Type: object

    errors

    Type: ApiErrorDTO[] | null

    Список ошибок.

    Min items: 1

    Example
    [
  {
    "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: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

    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: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

    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: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

    Example
    {
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

500 Internal Server Error

Внутренняя ошибка Маркета. Подробнее об ошибке

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

  • Type: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

    Example
    {
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

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

Предыдущая
Отправка файла
Следующая
Изменение статуса склада