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

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

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

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

Для каждого склада возвращается список моделей работы (FBS, DBS, Экспресс) и доступность API для каждой модели.

Метод подходит, только если в кабинете нет групп складов

Метод возвращает только отдельные склады и не возвращает группы складов. Если в кабинете есть группы складов, используйте метод POST v2/businesses/{businessId}/warehouses. Что такое группы складов и зачем они нужны.

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

Request

POST

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

Path parameters

Name

Description

businessId

Type: integer

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

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

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

Min value: 1

Query parameters

Name

Description

limit

Type: integer

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

Default: 15

Min value: 1

Max value: 30

pageToken

Type: string

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

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

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

Example: ``

Body

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

Name

Description

components

Type: PartnerWarehouseComponentType[] | null

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

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

Min items: 1

Unique items: true

Example
[
  "example"
]

warehouseIds

Type: integer[] | null

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

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

Min items: 1

Unique items: true

Example
[
  1
]

PartnerWarehouseComponentType

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

  • ADDRESS — адрес склада.

Type: string

Const: ADDRESS

Example: example

Responses

200 OK

Список складов и их свойства, которые вы запрашивали.

Body

application/json
{
  "status": "OK",
  "result": {
    "warehouses": [
      {
        "id": 1,
        "name": "example",
        "models": [
          null
        ],
        "address": {}
      }
    ],
    "paging": {
      "nextPageToken": "example"
    }
  }
}

Type: object

All of 2 types

  • Type: ApiResponse

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

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

    result

    Type: PartnerWarehousesDTO

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

    Example
    {
  "warehouses": [
    {
      "id": 1,
      "name": "example",
      "models": [
        {
          "placementType": "FBS",
          "apiAvailability": "AVAILABLE"
        }
      ],
      "address": {
        "city": "example",
        "street": "example",
        "number": "example",
        "building": "example",
        "block": "example",
        "gps": {
          "latitude": 0.5,
          "longitude": 0.5
        }
      }
    }
  ],
  "paging": {
    "nextPageToken": "example"
  }
}
    Example
    {
  "result": {
    "warehouses": [
      {
        "id": 1,
        "name": "example",
        "models": [
          {}
        ],
        "address": {
          "city": "example",
          "street": "example",
          "number": "example",
          "building": "example",
          "block": "example",
          "gps": {}
        }
      }
    ],
    "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"
}

WarehouseProgramType

Модель работы:

  • FBS — FBS.
  • DBS — DBS.
  • EXPRESS — Экспресс.

Type: string

Enum: FBS, DBS, EXPRESS

ApiAvailabilityStatusType

Возможность использовать API:

  • AVAILABLE — методы API доступны для выполнения запросов.
  • DISABLED_BY_INACTIVITY — методы API недоступны, так как магазин не размещал товары на витрине больше 90 дней.
  • DISABLED_BY_NO_ACTIVE_CONTRACT — методы API недоступны из-за отсутствия активного договора с Маркетом.
  • MANUALLY_DISABLED — методы API недоступны, так как интеграция выключена вручную.
  • DISABLED_BY_NO_PLACEMENT_TYPE — методы API недоступны, так как магазин не подключен к программе размещения.

Подробная инструкция по восстановлению доступа

Type: string

Enum: AVAILABLE, DISABLED_BY_INACTIVITY, DISABLED_BY_NO_ACTIVE_CONTRACT, MANUALLY_DISABLED, DISABLED_BY_NO_PLACEMENT_TYPE

PartnerWarehouseModelDTO

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

Name

Description

apiAvailability

Type: ApiAvailabilityStatusType

Возможность использовать API:

  • AVAILABLE — методы API доступны для выполнения запросов.
  • DISABLED_BY_INACTIVITY — методы API недоступны, так как магазин не размещал товары на витрине больше 90 дней.
  • DISABLED_BY_NO_ACTIVE_CONTRACT — методы API недоступны из-за отсутствия активного договора с Маркетом.
  • MANUALLY_DISABLED — методы API недоступны, так как интеграция выключена вручную.
  • DISABLED_BY_NO_PLACEMENT_TYPE — методы API недоступны, так как магазин не подключен к программе размещения.

Подробная инструкция по восстановлению доступа

Enum: AVAILABLE, DISABLED_BY_INACTIVITY, DISABLED_BY_NO_ACTIVE_CONTRACT, MANUALLY_DISABLED, DISABLED_BY_NO_PLACEMENT_TYPE

placementType

Type: WarehouseProgramType

Модель работы:

  • FBS — FBS.
  • DBS — DBS.
  • EXPRESS — Экспресс.

Enum: FBS, DBS, EXPRESS
Example
{
  "placementType": "FBS",
  "apiAvailability": "AVAILABLE"
}

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

PartnerWarehouseDTO

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

Name

Description

id

Type: integer

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

Min value: 1

models

Type: PartnerWarehouseModelDTO[]

Модели работы, доступные для склада.

Example
[
  {
    "placementType": "FBS",
    "apiAvailability": "AVAILABLE"
  }
]

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
  }
}
Example
{
  "id": 1,
  "name": "example",
  "models": [
    {
      "placementType": "FBS",
      "apiAvailability": "AVAILABLE"
    }
  ],
  "address": {
    "city": "example",
    "street": "example",
    "number": "example",
    "building": "example",
    "block": "example",
    "gps": {
      "latitude": 0.5,
      "longitude": 0.5
    }
  }
}

PackagingForwardScrollingPagerDTO

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

Name

Description

nextPageToken

Type: string

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

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

PartnerWarehousesDTO

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

Name

Description

warehouses

Type: PartnerWarehouseDTO[]

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

Example
[
  {
    "id": 1,
    "name": "example",
    "models": [
      {
        "placementType": "FBS",
        "apiAvailability": "AVAILABLE"
      }
    ],
    "address": {
      "city": "example",
      "street": "example",
      "number": "example",
      "building": "example",
      "block": "example",
      "gps": {
        "latitude": 0.5,
        "longitude": 0.5
      }
    }
  }
]

paging

Type: PackagingForwardScrollingPagerDTO

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

Example
{
  "nextPageToken": "example"
}
Example
{
  "warehouses": [
    {
      "id": 1,
      "name": "example",
      "models": [
        {
          "placementType": "FBS",
          "apiAvailability": "AVAILABLE"
        }
      ],
      "address": {
        "city": "example",
        "street": "example",
        "number": "example",
        "building": "example",
        "block": "example",
        "gps": {
          "latitude": 0.5,
          "longitude": 0.5
        }
      }
    }
  ],
  "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"
    }
  ]
}
Предыдущая
Список складов для кабинетов с группами складов
Следующая
Включение/выключение модели работы склада