Получение списка складов

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

Request

GET

https://api.kit.yandex.net/v1/warehouses

Query parameters

Name	Description
status	Type: WarehouseStatus[] Фильтр по статусу склада. Example: ``
page	Type: integer Номер страницы. Default: `1` Min value: `1`
per_page	Type: integer Количество элементов на странице. Default: `25` Min value: `1` Max value: `100`

WarehouseStatus

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

Type: string

Enum: ACTIVE, ARCHIVED

Responses

200 OK

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

Body

application/json

{
  "warehouses": [
    {
      "id": "019b21d9-c5d9-777d-80bd-d67c664bc6d9",
      "slug": "main-warehouse",
      "title": "Основной склад",
      "status": "ACTIVE"
    }
  ],
  "total_count": 100
}

Name

Description

total_count

Type: integer

Общее количество складов.

warehouses

Type: Warehouse[]

Example

[
  {
    "id": "019b21d9-c5d9-777d-80bd-d67c664bc6d9",
    "slug": "main-warehouse",
    "title": "Основной склад",
    "status": "ACTIVE"
  }
]

WarehouseID

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

Type: string<uuid>

Example: 019b21d9-c5d9-777d-80bd-d67c664bc6d9

Warehouse

Name	Description
id	Type: WarehouseID Идентификатор склада. Example: `019b21d9-c5d9-777d-80bd-d67c664bc6d9`
slug	Type: string URL-идентификатор склада. Example: `main-warehouse`
status	Type: WarehouseStatus Статус склада. Enum: `ACTIVE`, `ARCHIVED`
title	Type: string Название склада. Example: `Основной склад`

Example

{
  "id": "019b21d9-c5d9-777d-80bd-d67c664bc6d9",
  "slug": "main-warehouse",
  "title": "Основной склад",
  "status": "ACTIVE"
}

400 Bad Request

Некорректный запрос.

Body

application/json

{
  "code": "VALIDATION_ERROR",
  "message": "Invalid input",
  "trace_id": "00000000000000000000000000000000"
}

Name	Description
code	Type: string Example: `VALIDATION_ERROR`
message	Type: string Example: `Invalid input`
trace_id	Type: string Уникальный идентификатор запроса для отладки. Example: `00000000000000000000000000000000`

401 Unauthorized

Не авторизован.

Body

application/json

{
  "code": "VALIDATION_ERROR",
  "message": "Invalid input",
  "trace_id": "00000000000000000000000000000000"
}

Name	Description
code	Type: string Example: `VALIDATION_ERROR`
message	Type: string Example: `Invalid input`
trace_id	Type: string Уникальный идентификатор запроса для отладки. Example: `00000000000000000000000000000000`

500 Internal Server Error

Внутренняя ошибка сервера.

Body

application/json

{
  "code": "VALIDATION_ERROR",
  "message": "Invalid input",
  "trace_id": "00000000000000000000000000000000"
}

Name	Description
code	Type: string Example: `VALIDATION_ERROR`
message	Type: string Example: `Invalid input`
trace_id	Type: string Уникальный идентификатор запроса для отладки. Example: `00000000000000000000000000000000`

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

Список ресурсов

Создание нового склада