Идентификаторы складов Маркета

Метод доступен для модели FBY.

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

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

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

Request

GET

https://api.partner.market.yandex.ru/v2/warehouses

Query parameters

Name

Description

campaignId

Type: CampaignId

Идентификатор кампании магазина.

Указывается, если нужно вернуть все склады Маркета, которые привязаны к определенной кампании магазина.

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

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

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

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

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

Min value: 1

Example: ``

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",
        "address": {}
      }
    ]
  }
}

Type: object

All of 2 types
  • Type: ApiResponse

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

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

    result

    Type: FulfillmentWarehousesDTO

    Список складов Маркета (FBY).

    Example
    {
      "warehouses": [
        {
          "id": 0,
          "name": "example",
          "address": {
            "city": "example",
            "street": "example",
            "number": "example",
            "building": "example",
            "block": "example",
            "gps": {
              "latitude": 0.5,
              "longitude": 0.5
            }
          }
        }
      ]
    }
    
    Example
    {
      "result": {
        "warehouses": [
          {
            "id": 0,
            "name": "example",
            "address": {
              "city": "example",
              "street": "example",
              "number": "example",
              "building": "example",
              "block": "example",
              "gps": {}
            }
          }
        ]
      }
    }
    

ApiResponseStatusType

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

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

Type: string

Enum: OK, ERROR

ApiResponse

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

Name

Description

status

Type: ApiResponseStatusType

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

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

Enum: OK, ERROR

Example
{
  "status": "OK"
}

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

FulfillmentWarehouseDTO

Склад Маркета (FBY).

Name

Description

id

Type: integer

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

name

Type: string

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

Example: example

address

Type: WarehouseAddressDTO

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

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

FulfillmentWarehousesDTO

Список складов Маркета (FBY).

Name

Description

warehouses

Type: FulfillmentWarehouseDTO[]

Список складов Маркета (FBY).

Example
[
  {
    "id": 0,
    "name": "example",
    "address": {
      "city": "example",
      "street": "example",
      "number": "example",
      "building": "example",
      "block": "example",
      "gps": {
        "latitude": 0.5,
        "longitude": 0.5
      }
    }
  }
]
Example
{
  "warehouses": [
    {
      "id": 0,
      "name": "example",
      "address": {
        "city": "example",
        "street": "example",
        "number": "example",
        "building": "example",
        "block": "example",
        "gps": {
          "latitude": 0.5,
          "longitude": 0.5
        }
      }
    }
  ]
}

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

404 Not Found

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

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.