Перейти к содержанию

Склад

API методы для модуля store

Товары

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

GET /store/api/item/list

Метод может быть использован для получения списка товаров.

curl 'https://{HOST}.platrum.ru/store/api/item/list' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}'

{
    "status": "success",
    "data": [
        {
            "id": 123,
            "name": "some_string",
            "inventory_number": "some_string",
            "category_id": 123,
            "average_buying_price": 123,
            "residual_price": 123,
            "operation_life": 123,
            "residual_operation_life": 123,
            "quantity": 123,
            "arrival_date": 123,
            "usage_history": [
                {
                    "previous_user_id": "some_string",
                    "id": 123,
                    "user_id": "some_string",
                    "assigner_id": "some_string",
                    "assign_date": "2019-01-01 21:00:15"
                }
            ],
            "user_id": "some_string",
            "status": "some_string",
            "item_status_history": [
                {
                    "id": 123,
                    "author_id": "some_string",
                    "previous_status": "some_string",
                    "current_status": "some_string",
                    "change_date": "2019-01-01 21:00:15"
                }
            ]
        },
        {
            "id": 123,
            "name": "some_string",
            "inventory_number": "some_string",
            "category_id": 123,
            "average_buying_price": 123,
            "residual_price": 123,
            "operation_life": 123,
            "residual_operation_life": 123,
            "quantity": 123,
            "arrival_date": 123,
            "usage_history": [
                {
                    "previous_user_id": "some_string",
                    "id": 123,
                    "user_id": "some_string",
                    "assigner_id": "some_string",
                    "assign_date": "2019-01-01 21:00:15"
                }
            ],
            "user_id": "some_string",
            "status": "some_string",
            "item_status_history": [
                {
                    "id": 123,
                    "author_id": "some_string",
                    "previous_status": "some_string",
                    "current_status": "some_string",
                    "change_date": "2019-01-01 21:00:15"
                }
            ]
        }
    ]
}

Без параметров.

Параметр Описание Тип Значения
id Id товара int -
name Название товара string -
inventory_number Инвентарный номер string -
category_id Id категории товара int -
average_buying_price Id категории товара int -
residual_price Остаточная стоимость int -
operation_life Срок эксплуатации товара int -
residual_operation_life Остаточный срок эксплуатации товара int -
quantity Количество int -
arrival_date Дата поступления int -
usage_history История ответственных array[usage_history] -
user_id Ответственный за товар string -
status Статус проблемности товара string -
item_status_history История изменения статуса товара array[store.item_status_history] -

Создание и обновление

GET /store/api/item/save

Метод может быть использован как для сохранения изменений в существующем товаре, так и для создания нового. Товар передается в теле запроса. Если передан пустой id, то создается новый.

curl 'https://{HOST}.platrum.ru/store/api/item/save' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}' \ 
    --data '{"id":123,"name":"some_string","inventory_number":"some_string","category_id":123,"average_buying_price":123,"residual_price":123,"operation_life":123,"residual_operation_life":123,"quantity":123,"arrival_date":123,"usage_history":[{"previous_user_id":"some_string","id":123,"user_id":"some_string","assigner_id":"some_string","assign_date":"2019-01-01 21:00:15"}],"user_id":"some_string","status":"some_string","item_status_history":[{"id":123,"author_id":"some_string","previous_status":"some_string","current_status":"some_string","change_date":"2019-01-01 21:00:15"}]}'

{
    "status": "success",
    "data": {
        "id": 123,
        "name": "some_string",
        "inventory_number": "some_string",
        "category_id": 123,
        "average_buying_price": 123,
        "residual_price": 123,
        "operation_life": 123,
        "residual_operation_life": 123,
        "quantity": 123,
        "arrival_date": 123,
        "usage_history": [
            {
                "previous_user_id": "some_string",
                "id": 123,
                "user_id": "some_string",
                "assigner_id": "some_string",
                "assign_date": "2019-01-01 21:00:15"
            }
        ],
        "user_id": "some_string",
        "status": "some_string",
        "item_status_history": [
            {
                "id": 123,
                "author_id": "some_string",
                "previous_status": "some_string",
                "current_status": "some_string",
                "change_date": "2019-01-01 21:00:15"
            }
        ]
    }
}
Параметр Описание Тип Значения
id Id товара int -
name* Название товара string -
inventory_number Инвентарный номер string -
category_id* Id категории товара int -
average_buying_price Id категории товара int -
residual_price Остаточная стоимость int -
operation_life Срок эксплуатации товара int -
residual_operation_life Остаточный срок эксплуатации товара int -
quantity Количество int -
arrival_date Дата поступления int -
usage_history История ответственных array[usage_history] -
user_id Ответственный за товар string -
status Статус проблемности товара string -
item_status_history История изменения статуса товара array[store.item_status_history] -
Параметр Описание Тип Значения
id Id товара int -
name Название товара string -
inventory_number Инвентарный номер string -
category_id Id категории товара int -
average_buying_price Id категории товара int -
residual_price Остаточная стоимость int -
operation_life Срок эксплуатации товара int -
residual_operation_life Остаточный срок эксплуатации товара int -
quantity Количество int -
arrival_date Дата поступления int -
usage_history История ответственных array[usage_history] -
user_id Ответственный за товар string -
status Статус проблемности товара string -
item_status_history История изменения статуса товара array[store.item_status_history] -

Удаление

GET /store/api/item/delete

Метод может быть использован для удаления товаров.

curl 'https://{HOST}.platrum.ru/store/api/item/delete' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}' \ 
    --data '{"ids":[123,123]}'

{
    "status": "success",
    "data": true
}
Параметр Описание Тип Значения
ids Id удаляемых товаров array[int] -

bool

Категории товаров

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

GET /store/api/item/category/list

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

curl 'https://{HOST}.platrum.ru/store/api/item/category/list' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}'

{
    "status": "success",
    "data": [
        {
            "parent_names": [
                "some_string",
                "some_string"
            ],
            "has_children": true,
            "level": 123,
            "id": 123,
            "parent_id": 123,
            "author_id": "some_string",
            "is_archived": true,
            "creation_date": "2019-01-01 21:00:15",
            "is_default": true,
            "initial_writeoff_percentage": 123,
            "min_residual_price_percentage": 123,
            "key": "some_string",
            "name": "some_string",
            "order": 123,
            "is_system": true,
            "last_editor_id": "some_string",
            "update_date": "2019-01-01 21:00:15"
        },
        {
            "parent_names": [
                "some_string",
                "some_string"
            ],
            "has_children": true,
            "level": 123,
            "id": 123,
            "parent_id": 123,
            "author_id": "some_string",
            "is_archived": true,
            "creation_date": "2019-01-01 21:00:15",
            "is_default": true,
            "initial_writeoff_percentage": 123,
            "min_residual_price_percentage": 123,
            "key": "some_string",
            "name": "some_string",
            "order": 123,
            "is_system": true,
            "last_editor_id": "some_string",
            "update_date": "2019-01-01 21:00:15"
        }
    ]
}

Без параметров.

Параметр Описание Тип Значения
parent_names Названия родительских категорий array[string] -
has_children Наличие дочерних категорий bool -
level Уровень вложенности int -
id int -
parent_id Id родительской категории int -
author_id ID автора string -
is_archived Статус архивации bool -
creation_date Дата создания date -
is_default Является ли элементом по-умолчанию bool -
initial_writeoff_percentage Первичный процент списания int -
min_residual_price_percentage Минимальный процент остаточной стоимости int -
key Ключ string -
name Название string -
order Порядок сортировки int -
is_system Является ли элемент системным bool -
last_editor_id ID последнего редактора string -
update_date Дата редактирования date -

Создание и обновление

GET /store/api/item/category/save

Метод может быть использован как для сохранения изменений в существующей категории товаров, так и для создания новой. Если передан пустой id, то создается новая категория.

curl 'https://{HOST}.platrum.ru/store/api/item/category/save' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}' \ 
    --data '{"id":123,"name":"some_string","parent_id":123,"initial_writeoff_percentage":123,"min_residual_price_percentage":123}'

{
    "status": "success",
    "data": true
}
Параметр Описание Тип Значения
id Id категории int -
name* Название категории string -
parent_id Id родительской категории int -
initial_writeoff_percentage Первичный процент списания int -
min_residual_price_percentage Минимальный процент остаточной стоимости int -

bool

Удаление

GET /store/api/item/category/remove

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

curl 'https://{HOST}.platrum.ru/store/api/item/category/remove' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}' \ 
    --data '{"id":123}'

{
    "status": "success",
    "data": true
}
Параметр Описание Тип Значения
id* Id категории int -

bool

Поступления

Создание и обновление

GET /store/api/arrival/save

Метод может быть использован как для сохранения изменений в существующем поступлении, так и для создания нового. Если передан пустой id, то создается новое поступление.

curl 'https://{HOST}.platrum.ru/store/api/arrival/save' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}' \ 
    --data '{"id":123,"arrival_date":"2019-01-01 21:00:15","arrival_items":[{"id":123,"name":"some_string","inventory_number":"some_string","category_id":123,"average_buying_price":123,"residual_price":123,"operation_life":123,"residual_operation_life":123,"quantity":123,"arrival_date":123,"usage_history":[{"previous_user_id":"some_string","id":123,"user_id":"some_string","assigner_id":"some_string","assign_date":"2019-01-01 21:00:15"}],"user_id":"some_string","status":"some_string","item_status_history":[{"id":123,"author_id":"some_string","previous_status":"some_string","current_status":"some_string","change_date":"2019-01-01 21:00:15"}]}],"comment":"some_string","is_deleted":true,"is_editable":true,"is_fixed":true,"store_key":"some_string"}'

{
    "status": "success",
    "data": {
        "items_count": 123,
        "id": 123,
        "author_id": "some_string",
        "store_key": "some_string",
        "items": [
            {
                "id": 123,
                "item_id": 123,
                "quantity": 123,
                "buying_price": 123,
                "residual_price": 123
            }
        ],
        "sum": 123,
        "comment": "some_string",
        "is_fixed": true,
        "date_fixed": "2019-01-01 21:00:15",
        "is_deleted": true,
        "is_editable": true,
        "update_date": "2019-01-01 21:00:15",
        "creation_date": "2019-01-01 21:00:15",
        "arrival_date": "2019-01-01 21:00:15"
    }
}
Параметр Описание Тип Значения
id Id поступления int -
arrival_date Дата поступления date -
arrival_items Товары array[item_data] -
comment Комментарий string -
is_deleted Статус архивации bool -
is_editable Возможность редактирования bool -
is_fixed Статус проведения bool -
store_key Ключ склада string -
Параметр Описание Тип Значения
items_count Количество товаров в поступлении int -
id ID int -
author_id string -
store_key string -
items array[store.arrival_item] -
sum int -
comment string -
is_fixed bool -
date_fixed date -
is_deleted bool -
is_editable bool -
update_date date -
creation_date date -
arrival_date date -