Единицы измерения

У каждого продукта должна быть единица измерения. Операции с единицами измерения перечислены ниже.

Базовый URL: https://api.planadoapp.com/v2/catalog/products/units

Список единиц измерения

$ curl -H "Authorization: Bearer api-key" https://api.planadoapp.com/v2/catalog/products/units | jq
{
  "units": [
    {
      "uuid": "f6672a42-77f5-42ce-a88b-c219525f87f4",
      "name": "килограмм",
      "code": "kg",
      "external_id": "unit-kg",
      "archived": false
    },
    {
      "uuid": "5051d58c-0030-498b-a5c2-41b13ecc0a9c",
      "name": "миля",
      "code": "ml",
      "external_id": null,
      "archived": true
    },
    ...
  ]
}
Table 1. Поля элементов units
Поле Тип JSON-тип Может быть null Описание

uuid

UUID

Строка

Нет

Уникальный идентификатор

name

Строка

Строка

Нет

Название единицы измерения

code

Строка

Строка

Нет

Короткий код единицы измерения

external_id

Строка

Строка

Да

Внешний идентификатор

archived

Булев

Булев

Нет

Архивирована ли единица измерения

Добавление единицы измерения

Для добавления единицы измерения отправьте POST-запрос на адрес https://api.planadoapp.com/v2/catalog/products/units.

$ curl --data "{\"name\":\"Килограмм\",\"code\":\"кг\"}" \
       -H "Authorization: Bearer api-key" \
       https://api.planadoapp.com/v2/catalog/products/units | jq
{
  "unit_uuid": "72e522d5-632c-44a0-9999-65de8389bb8b"
}

В ответ API возвращает uuid созданной единицы.

Схема запроса

Поле Тип JSON-тип Обязательно Может быть null Описание

name

Строка

Строка

Да

Нет

Название единицы измерения. Ограничено 250 символами

code

Строка

Строка

Да

Нет

Короткий код единицы измерения. Ограничено 50 символами

external_id

Строка

Строка

Нет

Нет

Внешний идентификатор

Получение единицы измерения

Единицы измерения могут быть получены по uuid или external_id.

С помощью uuid
$ curl -H "Authorization: Bearer api-key" \
  https://api.planadoapp.com/v2/catalog/products/units/9a009fdd-31c7-4195-8a6a-4c3cdea28781 | jq
{
  "unit": {
    "uuid": "9a009fdd-31c7-4195-8a6a-4c3cdea28781",
    "name": "Килограмм",
    "code": "кг",
    "external_id": "unit-kg",
    "archived": false
  }
}
С помощью external_id
$ curl -H "Authorization: Bearer api-key" https://api.planadoapp.com/v2/catalog/products/units/unit-kg | jq
{
  "unit": {
    "uuid": "9a009fdd-31c7-4195-8a6a-4c3cdea28781",
    "name": "Килограмм",
    "code": "кг",
    "external_id": "unit-kg",
    "archived": false
  }
}

Обновление единицы измерения

Для обновления единицы отправьте PATCH-запрос на https://api.planadoapp.com/v2/catalog/products/units/:unit_id. Здесь :unit_id - это значение uuid или external_id единицы.

Обновление имени единицы измерения
$ curl --data "{\"name\":\"Кило\"}" \
       -X PATCH \
       -H "Authorization: Bearer api-key" \
       https://api.planadoapp.com/v2/catalog/products/units/9a009fdd-31c7-4195-8a6a-4c3cdea28781 | jq
{
  "unit_uuid": "9a009fdd-31c7-4195-8a6a-4c3cdea28781"
}

Схема запроса

Поле Тип JSON-тип Обязательно Может быть null Описание

name

Строка

Строка

Нет

Нет

Название единицы измерения. Ограничено 250 символами

code

Строка

Строка

Нет

Нет

Короткий код единицы измерения. Ограничено 50 символами

Удаление единицы измерения

Отправьте DELETE-запрос с uuid или external_id для удаления единицы измерения.

Удаление с помощью uuid
$ curl -H "Authorization: Bearer api-key" -X DELETE https://api.planadoapp.com/v2/catalog/products/units/5051d58c-0030-498b-a5c2-41b13ecc0a9c | jq
{
  "message": "Performed"
}

Архивация единицы измерения

Единицы измерения могут быть архивированы и разархивированы. Архивные единицы измерения скрываются в интерфейсе. Для переключения отправьте соответствующий POST-запрос на https://api.planadoapp.com/v2/catalog/products/units/:unit_id/archive или https://api.planadoapp.com/v2/catalog/products/units/:unit_id/unarchive.

Архивирование с помощью uuid
$ curl -H "Authorization: Bearer api-key" -X POST "https://api.planadoapp.com/v2/catalog/products/units/9a009fdd-31c7-4195-8a6a-4c3cdea28781/archive" | jq
{
  "unit_uuid": "9a009fdd-31c7-4195-8a6a-4c3cdea28781"
}