Получает пресет компании по идентификатору.

  1. HTTP-запрос
  2. Path-параметры
  3. Ответы
    1. Код 200
      1. Представление
      2. Поля
    2. Код 401
    3. Код 403
    4. Код 422
    5. Код 500

Получает информацию о пресете и тело пресета.

HTTP-запрос

GET https://courier.yandex.ru/api/v1/reference-book/companies/{company_id}/presets/{preset_id}

Path-параметры

company_id *

integer

ID компании, пресеты которой надо получить.

preset_id *

string

Идентификатор пресета в справочнике.

company_id *

integer

ID компании, пресеты которой надо получить.

preset_id *

string

Идентификатор пресета в справочнике.

Ответы

Код 200

Пресет успешно возвращен.

{
  "body": {},
  "history": {
    "created_at": string,
    "updated_at": string,
    "updated_by": string
  },
  "id": string,
  "number": string,
  "type": string,
  "x-description-en": string
}
Скопировано

Представление

Свернуть всё
Развернуть всё

Поля

body

object

Тело пресета в виде json, схема должна соответствовать типу пресета.

history

object

history.created_at

string

Время создания пресета в формате YYYY-MM-DDThh:mm:ssZ.

history.updated_at

string

Время обновления пресета в формате YYYY-MM-DDThh:mm:ssZ.

history.updated_by

string

Кто произвел последние изменения.

id

string

Идентификатор пресета в справочнике.

number

string

Номер пресета. Не может начинаться с public_ и содержать символ запятой.

type

string

Тип пресета.

Возможные значения
  1. depot
  2. location
  3. options
  4. vehicle
  5. vehicle-shift

x-description-en

string

Описание пресета.

body

object

Тело пресета в виде json, схема должна соответствовать типу пресета.

history

object

history.created_at

string

Время создания пресета в формате YYYY-MM-DDThh:mm:ssZ.

history.updated_at

string

Время обновления пресета в формате YYYY-MM-DDThh:mm:ssZ.

history.updated_by

string

Кто произвел последние изменения.

id

string

Идентификатор пресета в справочнике.

number

string

Номер пресета. Не может начинаться с public_ и содержать символ запятой.

type

string

Тип пресета.

Возможные значения
  1. depot
  2. location
  3. options
  4. vehicle
  5. vehicle-shift

x-description-en

string

Описание пресета.

Код 401

Ошибка авторизации. Убедитесь, что заголовок запроса содержит правильный OAuth-токен.

Код 403

У вас нет доступа к этому объекту.

Код 422

Неверный ввод. Пресет связан с другой компанией.

Код 500

Ошибка сервера при обработке запроса.