Список методів

/service/list	Отримання списку послуг
/service/add	Створення нової послуги
/service/update	Внесення змін до послуги
/service/folder/list	Отримання списку папок
/service/folder/add	Створення нової папки
/service/folder/update	Внесення змін до папки

Отримання списку послуг

Назва методу: /service/list

Повертає список послуг. Для навігації використовується номер сторінки (page).
Розмір сторінки фіксований і дорівнює 100 елементам.

Параметри запиту:

filter Тип: object (необов'язковий)	Доступні поля для фільтрації (Фільтр завжди використовує логіку “AND“):
	ParentFolder - Id батьківської папки. Необов'язковий параметр. <br>Для отримання послуг, які не належать до жодної з папок, тобто не мають прив'язки до папки, потрібно вказувати значення null.
	Id - ідентифікатор послуги. Необов'язковий параметр
	PriceType - масив ідентифікаторів типиів цін. Необов'язковий параметр
	Archive \- Ознака того, що треба повертати архівні елементи
page Тип: integer (необов'язковий)	Якщо в запиті не передати, за замовчуванням буде встановлена перша сторінка.

Результат запиту:

Якщо в запиті фільтр відсутній, то повертається список послуг у порядку зростання Id.

Значення полів послуг, що повертаються методом:

Id	Ідентифікатор послуги
Name	Назва послуги (string)
ParentFolder	ID батьківської папки (integer)
PrintName	Назва для друку (string)
Memo	Коментар (string)
Barcode	Штрих код (string)
UnitName	Назва одиниці виміру (string)
Description	Опис послуги (string)
Article	Артикул (string)
Images	Зображення (масив). Основна картинка товару завжди є першою в масиві.
Prices	Ціни (масив)

Приклад:

Запит:

{
    "filter": {
        "ParentFolder": 110,
        "PriceType": [
            339
        ]
    },
    "page": 1
}

Результат:

{
    "success": true,
    "data": [
        {
            "Id": 111,
            "ParentFolder": 110,
            "Name": "Product_1",
            "Images": [
                {
                    "Id": 586,
                    "Name": "flowers.jpg",
                    "Url": "https://qfinprod.blob.core.windows.net/images/8c87c4db-9e0f-4e34-bf8f-d4cbc20e9f44_flowers.jpg"
                },
                ...
            ],
            ...
            "Prices": [
                {
                    "Id": 106609,
                    "Date": "2022-08-15T00:00:00Z",
                    "PriceType": 339,
                    "Product": 89272,
                    "Price": 5.500000,
                    "Currency": "USD"
                },
              ...
            ],
        },
        ...
    ]
}

Створення або оновлення послуги

Метод створення послуги(уг): /api/v2/service/add

Метод оновлення послуги(уг): /api/v2/service/update

Методи додають або оновлюють послуги. Максимальна кількість послуг в одному пакеті - 100.

Параметри запитів у методів майже ідентичні. Тільки для методу /service/update обов'язковим є передача Id послуги. Якщо в запиті відсутній Id, повертається помилка і жодна з послуг не оновлюється.
Якщо в запиті Id переданий, але не знайдений в довіднику послуг, жодна з послуг також не оновлюється і додатково повертається перелік не знайдених Id.

Параметри запиту:

array Тип: масив (Обов'язковий)	Кожна послуга в масиві являє собою об'єкт з переліком полів. Доступні поля:
	id Ідентифікатор послуги. Враховується та є обов'язковим тільки для методу /product/update
	Name Назва послуги (string)
	ParentFolder ID батьківської папки (integer)
	PrintName Назва для друку (string)
	Memo Коментар (string)
	Barcode Штрих код (string)
	UnitName Одиниця виміру (string). Одиниця виміру має бути вказана без зайвих символів. Якщо в процесі додавання послуги буде вказана одиниця виміру яка відсутня у списку одиниць, то її буде автоматично створено.
	Description Опис (string)
	Article Артикул (string)

Результат запиту:

Метод повертає масив:

success	true или false
data	Масив ідентифікаторів створених послуг
error	Код та зміст помилки (вказується, якщо success = false)

Приклад:

Запит:

{
    "array": [
        {
            "Name": "Hola_product_0",
            "Article": "5555",
            "ParentFolder": "110",
            ...
        },
        ...
    ]
}

Результат:

{
    "success": true,
    "data": [
        {
            "id": 116
        },
        ...
    ]
}

Отримання списку папок

Назва методу: /api/v2/service/folder/list

Повертає список папок каталогу послуг. Для навігації використовується номер сторінки (page).

Розмір сторінки фіксований і дорівнює 100 елементам.

Параметри запиту:

filter Тип: object (необов'язковий)	Доступні поля для фільтрації (Фільтр завжди використовує логіку “AND“):
	ParentFolder - Id батьківської папки. Необов'язковий параметр.<br><br>Для отримання папок першого рівня, потрібно вказувати значення null.
	Id - ідентифікатор папки. Необов'язковий параметр
page Тип: integer (необов'язковий)	Якщо в запиті не передати, за замовчуванням буде встановлена перша сторінка.

Результат запиту:

Якщо в запиті фільтр відсутній, то повертається список папок у порядку зростання Id.

Приклад:

{
    "success": true,
    "data": [
        {
            "Id": 118,
            "ParentFolder": 110,
            "Name": "Hola_Folder_111"
        },
        ...
    ]
}

Створення або оновлення папки

Метод створення папки(ок): /api/v2/service/folder/add

Метод оновлення папки(ок): /api/v2/service/folder/update

Методи додають або оновлюють папки. Максимальна кількість папок в одному пакеті - 100.

Параметри запитів у методів майже ідентичні. Тільки для методу /service/folder/update обов'язковим є передача Id папки. Якщо в запиті відсутній Id, повертається помилка і жодна з папок не оновлюється.
Якщо в запиті Id переданий, але не знайдений в довіднику папок, жодна з папок також не оновлюється і додатково повертається перелік не знайдених Id.

Параметри запиту:

array Тип: масив (Обов'язковий)	Кожна папка в масиві являє собою об'єкт з переліком полів. Доступні поля:
	Id Ідентифікатор папки. Враховується та є обов'язковим тільки для методу /service/folder/update
	Name Назва папки (string)
	ParentFolder ID батьківської папки (integer)

Результат запиту:

Метод повертає масив:

success	true или false
data	Масив ідентифікаторів створених папок для методу /service/folder/add або масив ідентифікаторів оновлених папок для методу /service/folder/update
error	Код та зміст помилки (вказується, якщо success = false)

Приклад:

Запит:

{
    "array": [
        {
            "Id": 110,
            "Name": "Directory_111",
            "ParentFolder": 100
        },
      ...
    ]
}

Результат:

{
    "success": true,
    "data": [
        {
            "id": 129
        },
        ...
    ]
}

Оновлено: 26/10/2022