Бізнес-блок

Довідники, категорії та налаштування

Контрагенти, постачальники, дисконтні картки, категорії товарів, переклади й параметри користувача.

28усього
2читання
26запис
Показано 28 із 28 Глобальний пошук · Ctrl + K — пошук на сторінці
Кожна картка містить готовий HTTP-приклад. Значення в ньому демонстраційні: замініть їх даними зі своєї бази. Для операцій запису використовуйте новий Idempotency-Key для кожної окремої бізнес-операції. Як сформувати ключ і повторювати запит.
catalog

Довідники

15 методів
catalog.contrag.deleteВидаляє контрагента з довідника. запис catalog.write з 0.4.0

Видаляє контрагента з довідника.

Перевірити JSON JSON Schema
Стабільність: стабільний Scope: catalog.write Idempotency-Key: потрібен

Параметри params

ПолеЩо означаєТип і форматПравила
Основні
keyКлюч запису

Стабільний ключ запису, отриманий попереднім методом читання цього самого довідника.

string
обов’язковийПриклад: "Приклад"
Точна схема параметрів
{
    "key": {
        "type": "string",
        "required": true,
        "max": 512,
        "title": "Ключ запису",
        "description": "Стабільний ключ запису, отриманий попереднім методом читання цього самого довідника.",
        "group": "Основні",
        "example": "Приклад"
    }
}

Результат

Форма відповіді: status
ПолеЗмістТипПриклад
catalogCatalogПовернене значення «Catalog» відповідного запису, документа або підсумку ARM20.string"Приклад"
affectedЗмінено записівКількість записів, які upstream фактично змінив.string"Приклад"
Точна схема результату
{
    "mode": "status",
    "fields": [
        "catalog",
        "affected"
    ],
    "field_specs": {
        "catalog": {
            "title": "Catalog",
            "description": "Повернене значення «Catalog» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        },
        "affected": {
            "title": "Змінено записів",
            "description": "Кількість записів, які upstream фактично змінив.",
            "type": "string",
            "example": "Приклад"
        }
    }
}

Приклад запиту

POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
Idempotency-Key: example-catalog-contrag-delete-0001

{
    "method": "catalog.contrag.delete",
    "params": {
        "key": "Приклад"
    },
    "id": "example-catalog-contrag-delete"
}

Замініть демонстраційні значення даними зі своєї бази.

Приклад успішної відповіді

{
    "ok": true,
    "data": {
        "method": "catalog.contrag.delete",
        "result": {
            "upstream": {
                "name": "UPMAPI",
                "version": "1",
                "resource": "catalog"
            },
            "status": {
                "code": "OK",
                "operation": "contrag.delete",
                "catalog": "Приклад",
                "affected": "Приклад"
            },
            "rows": []
        },
        "id": "example-catalog-contrag-delete"
    },
    "request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
КодHTTPПричинаДія клієнта
INVALID_PARAMETER422Один із параметрів має неправильний тип, формат або значення.Виправити запит; автоматично не повторювати.
UPSTREAM_FAILURE502Сервер бізнес-операції недоступний або відхилив безпечний контракт.Не створювати новий Idempotency-Key; перевірити журнал і бізнес-об’єкт.
IDEMPOTENCY_KEY_REQUIRED422Для виконання запису не передано Idempotency-Key.Створити ключ для цієї бізнес-операції та повторити.
IDEMPOTENCY_RESULT_UNKNOWN409Результат попередньої спроби невідомий; gateway не виконав запис повторно.Звірити документ, чек або платіж; не створювати новий ключ автоматично.
catalog.contrag.saveСтворює або оновлює картку контрагента. запис catalog.write з 0.4.0

Створює або оновлює картку контрагента.

Перевірити JSON JSON Schema
Стабільність: стабільний Scope: catalog.write Idempotency-Key: потрібен

Параметри params

ПолеЩо означаєТип і форматПравила
Основні
keyКлюч запису

Стабільний ключ запису, отриманий попереднім методом читання цього самого довідника.

string
необов’язковийПриклад: "Приклад"
ntНазва контрагента

Поле «Назва контрагента» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.

string
обов’язковийПриклад: "Тестовий товар"
Додаткові
rekvРеквізити

Поле «Реквізити» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.

string
необов’язковийПриклад: "Приклад"
Точна схема параметрів
{
    "key": {
        "type": "string",
        "max": 512,
        "title": "Ключ запису",
        "description": "Стабільний ключ запису, отриманий попереднім методом читання цього самого довідника.",
        "group": "Основні",
        "example": "Приклад"
    },
    "nt": {
        "type": "string",
        "max": 255,
        "required": true,
        "title": "Назва контрагента",
        "description": "Поле «Назва контрагента» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Основні",
        "example": "Тестовий товар"
    },
    "rekv": {
        "type": "string",
        "max": 4096,
        "title": "Реквізити",
        "description": "Поле «Реквізити» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": "Приклад"
    }
}

Результат

Форма відповіді: status
ПолеЗмістТипПриклад
catalogCatalogПовернене значення «Catalog» відповідного запису, документа або підсумку ARM20.string"Приклад"
affectedЗмінено записівКількість записів, які upstream фактично змінив.string"Приклад"
Точна схема результату
{
    "mode": "status",
    "fields": [
        "catalog",
        "affected"
    ],
    "field_specs": {
        "catalog": {
            "title": "Catalog",
            "description": "Повернене значення «Catalog» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        },
        "affected": {
            "title": "Змінено записів",
            "description": "Кількість записів, які upstream фактично змінив.",
            "type": "string",
            "example": "Приклад"
        }
    }
}

Приклад запиту

POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
Idempotency-Key: example-catalog-contrag-save-0001

{
    "method": "catalog.contrag.save",
    "params": {
        "nt": "Тестовий товар"
    },
    "id": "example-catalog-contrag-save"
}

Замініть демонстраційні значення даними зі своєї бази.

Приклад успішної відповіді

{
    "ok": true,
    "data": {
        "method": "catalog.contrag.save",
        "result": {
            "upstream": {
                "name": "UPMAPI",
                "version": "1",
                "resource": "catalog"
            },
            "status": {
                "code": "OK",
                "operation": "contrag.save",
                "catalog": "Приклад",
                "affected": "Приклад"
            },
            "rows": []
        },
        "id": "example-catalog-contrag-save"
    },
    "request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
КодHTTPПричинаДія клієнта
INVALID_PARAMETER422Один із параметрів має неправильний тип, формат або значення.Виправити запит; автоматично не повторювати.
UPSTREAM_FAILURE502Сервер бізнес-операції недоступний або відхилив безпечний контракт.Не створювати новий Idempotency-Key; перевірити журнал і бізнес-об’єкт.
IDEMPOTENCY_KEY_REQUIRED422Для виконання запису не передано Idempotency-Key.Створити ключ для цієї бізнес-операції та повторити.
IDEMPOTENCY_RESULT_UNKNOWN409Результат попередньої спроби невідомий; gateway не виконав запис повторно.Звірити документ, чек або платіж; не створювати новий ключ автоматично.
catalog.discount_actions.deleteВидаляє правило акції зі знижкою або бонусом. запис catalog.write з 0.4.0

Видаляє правило акції зі знижкою або бонусом.

Перевірити JSON JSON Schema
Стабільність: стабільний Scope: catalog.write Idempotency-Key: потрібен

Параметри params

ПолеЩо означаєТип і форматПравила
Основні
keyКлюч запису

Стабільний ключ запису, отриманий попереднім методом читання цього самого довідника.

string
обов’язковийПриклад: "Приклад"
Точна схема параметрів
{
    "key": {
        "type": "string",
        "required": true,
        "max": 512,
        "title": "Ключ запису",
        "description": "Стабільний ключ запису, отриманий попереднім методом читання цього самого довідника.",
        "group": "Основні",
        "example": "Приклад"
    }
}

Результат

Форма відповіді: status
ПолеЗмістТипПриклад
catalogCatalogПовернене значення «Catalog» відповідного запису, документа або підсумку ARM20.string"Приклад"
affectedЗмінено записівКількість записів, які upstream фактично змінив.string"Приклад"
Точна схема результату
{
    "mode": "status",
    "fields": [
        "catalog",
        "affected"
    ],
    "field_specs": {
        "catalog": {
            "title": "Catalog",
            "description": "Повернене значення «Catalog» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        },
        "affected": {
            "title": "Змінено записів",
            "description": "Кількість записів, які upstream фактично змінив.",
            "type": "string",
            "example": "Приклад"
        }
    }
}

Приклад запиту

POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
Idempotency-Key: example-catalog-discount-actions-delete-0001

{
    "method": "catalog.discount_actions.delete",
    "params": {
        "key": "Приклад"
    },
    "id": "example-catalog-discount-actions-delete"
}

Замініть демонстраційні значення даними зі своєї бази.

Приклад успішної відповіді

{
    "ok": true,
    "data": {
        "method": "catalog.discount_actions.delete",
        "result": {
            "upstream": {
                "name": "UPMAPI",
                "version": "1",
                "resource": "catalog"
            },
            "status": {
                "code": "OK",
                "operation": "discount_actions.delete",
                "catalog": "Приклад",
                "affected": "Приклад"
            },
            "rows": []
        },
        "id": "example-catalog-discount-actions-delete"
    },
    "request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
КодHTTPПричинаДія клієнта
INVALID_PARAMETER422Один із параметрів має неправильний тип, формат або значення.Виправити запит; автоматично не повторювати.
UPSTREAM_FAILURE502Сервер бізнес-операції недоступний або відхилив безпечний контракт.Не створювати новий Idempotency-Key; перевірити журнал і бізнес-об’єкт.
IDEMPOTENCY_KEY_REQUIRED422Для виконання запису не передано Idempotency-Key.Створити ключ для цієї бізнес-операції та повторити.
IDEMPOTENCY_RESULT_UNKNOWN409Результат попередньої спроби невідомий; gateway не виконав запис повторно.Звірити документ, чек або платіж; не створювати новий ключ автоматично.
catalog.discount_actions.saveСтворює або оновлює правило акції зі знижкою або бонусом. запис catalog.write з 0.4.0

Створює або оновлює правило акції зі знижкою або бонусом.

Перевірити JSON JSON Schema
Стабільність: стабільний Scope: catalog.write Idempotency-Key: потрібен

Параметри params

ПолеЩо означаєТип і форматПравила
Основні
keyКлюч запису

Стабільний ключ запису, отриманий попереднім методом читання цього самого довідника.

string
необов’язковийПриклад: "Приклад"
uinІдентифікатор запису

Внутрішній числовий ідентифікатор запису, отриманий методом читання відповідного довідника.

int
обов’язковийПриклад: 1
Суми та кількості
discВідсоток знижки

Точне числове значення «Відсоток знижки» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається.

string · decimal-string · percent
обов’язковийПриклад: "100.00"
Додаткові
action_typeТип операції

Поле «Тип операції» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.

int
обов’язковийПриклад: 1
Дати й час
dfrПочаткова дата

Дата «Початкова дата» у календарному форматі YYYY-MM-DD.

string · date
обов’язковийПриклад: "2026-07-23"
dtoКінцева дата

Дата «Кінцева дата» у календарному форматі YYYY-MM-DD.

string · date
обов’язковийПриклад: "2026-07-23"
hfromЧас від

Час «Час від» у форматі HH:MM:SS.

string · time
необов’язковийПриклад: "12:00:00"
htoЧас до

Час «Час до» у форматі HH:MM:SS.

string · time
необов’язковийПриклад: "12:00:00"
Точна схема параметрів
{
    "key": {
        "type": "string",
        "max": 512,
        "title": "Ключ запису",
        "description": "Стабільний ключ запису, отриманий попереднім методом читання цього самого довідника.",
        "group": "Основні",
        "example": "Приклад"
    },
    "uin": {
        "type": "int",
        "min": -2147483648,
        "max": 2147483647,
        "required": true,
        "title": "Ідентифікатор запису",
        "description": "Внутрішній числовий ідентифікатор запису, отриманий методом читання відповідного довідника.",
        "group": "Основні",
        "example": 1
    },
    "disc": {
        "type": "string",
        "max": 64,
        "pattern": "/^-?[0-9]+(?:[.,][0-9]+)?$/D",
        "required": true,
        "title": "Відсоток знижки",
        "description": "Точне числове значення «Відсоток знижки» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається.",
        "group": "Суми та кількості",
        "format": "decimal-string",
        "unit": "percent",
        "example": "100.00"
    },
    "action_type": {
        "type": "int",
        "min": -2147483648,
        "max": 2147483647,
        "required": true,
        "title": "Тип операції",
        "description": "Поле «Тип операції» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": 1
    },
    "dfr": {
        "type": "string",
        "max": 30,
        "required": true,
        "title": "Початкова дата",
        "description": "Дата «Початкова дата» у календарному форматі YYYY-MM-DD.",
        "group": "Дати й час",
        "format": "date",
        "example": "2026-07-23"
    },
    "dto": {
        "type": "string",
        "max": 30,
        "required": true,
        "title": "Кінцева дата",
        "description": "Дата «Кінцева дата» у календарному форматі YYYY-MM-DD.",
        "group": "Дати й час",
        "format": "date",
        "example": "2026-07-23"
    },
    "hfrom": {
        "type": "string",
        "max": 12,
        "title": "Час від",
        "description": "Час «Час від» у форматі HH:MM:SS.",
        "group": "Дати й час",
        "format": "time",
        "example": "12:00:00"
    },
    "hto": {
        "type": "string",
        "max": 12,
        "title": "Час до",
        "description": "Час «Час до» у форматі HH:MM:SS.",
        "group": "Дати й час",
        "format": "time",
        "example": "12:00:00"
    }
}

Результат

Форма відповіді: status
ПолеЗмістТипПриклад
catalogCatalogПовернене значення «Catalog» відповідного запису, документа або підсумку ARM20.string"Приклад"
affectedЗмінено записівКількість записів, які upstream фактично змінив.string"Приклад"
Точна схема результату
{
    "mode": "status",
    "fields": [
        "catalog",
        "affected"
    ],
    "field_specs": {
        "catalog": {
            "title": "Catalog",
            "description": "Повернене значення «Catalog» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        },
        "affected": {
            "title": "Змінено записів",
            "description": "Кількість записів, які upstream фактично змінив.",
            "type": "string",
            "example": "Приклад"
        }
    }
}

Приклад запиту

POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
Idempotency-Key: example-catalog-discount-actions-save-0001

{
    "method": "catalog.discount_actions.save",
    "params": {
        "uin": 1,
        "disc": "1001",
        "action_type": 1,
        "dfr": "2026-07-01",
        "dto": "2026-07-31"
    },
    "id": "example-catalog-discount-actions-save"
}

Замініть демонстраційні значення даними зі своєї бази.

Приклад успішної відповіді

{
    "ok": true,
    "data": {
        "method": "catalog.discount_actions.save",
        "result": {
            "upstream": {
                "name": "UPMAPI",
                "version": "1",
                "resource": "catalog"
            },
            "status": {
                "code": "OK",
                "operation": "discount_actions.save",
                "catalog": "Приклад",
                "affected": "Приклад"
            },
            "rows": []
        },
        "id": "example-catalog-discount-actions-save"
    },
    "request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
КодHTTPПричинаДія клієнта
INVALID_PARAMETER422Один із параметрів має неправильний тип, формат або значення.Виправити запит; автоматично не повторювати.
UPSTREAM_FAILURE502Сервер бізнес-операції недоступний або відхилив безпечний контракт.Не створювати новий Idempotency-Key; перевірити журнал і бізнес-об’єкт.
IDEMPOTENCY_KEY_REQUIRED422Для виконання запису не передано Idempotency-Key.Створити ключ для цієї бізнес-операції та повторити.
IDEMPOTENCY_RESULT_UNKNOWN409Результат попередньої спроби невідомий; gateway не виконав запис повторно.Звірити документ, чек або платіж; не створювати новий ключ автоматично.
catalog.discount_cards.deleteВидаляє дисконтну картку з довідника. запис catalog.write з 0.4.0

Видаляє дисконтну картку з довідника.

Перевірити JSON JSON Schema
Стабільність: стабільний Scope: catalog.write Idempotency-Key: потрібен

Параметри params

ПолеЩо означаєТип і форматПравила
Основні
keyКлюч запису

Стабільний ключ запису, отриманий попереднім методом читання цього самого довідника.

string
обов’язковийПриклад: "Приклад"
Точна схема параметрів
{
    "key": {
        "type": "string",
        "required": true,
        "max": 512,
        "title": "Ключ запису",
        "description": "Стабільний ключ запису, отриманий попереднім методом читання цього самого довідника.",
        "group": "Основні",
        "example": "Приклад"
    }
}

Результат

Форма відповіді: status
ПолеЗмістТипПриклад
catalogCatalogПовернене значення «Catalog» відповідного запису, документа або підсумку ARM20.string"Приклад"
affectedЗмінено записівКількість записів, які upstream фактично змінив.string"Приклад"
Точна схема результату
{
    "mode": "status",
    "fields": [
        "catalog",
        "affected"
    ],
    "field_specs": {
        "catalog": {
            "title": "Catalog",
            "description": "Повернене значення «Catalog» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        },
        "affected": {
            "title": "Змінено записів",
            "description": "Кількість записів, які upstream фактично змінив.",
            "type": "string",
            "example": "Приклад"
        }
    }
}

Приклад запиту

POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
Idempotency-Key: example-catalog-discount-cards-delete-0001

{
    "method": "catalog.discount_cards.delete",
    "params": {
        "key": "Приклад"
    },
    "id": "example-catalog-discount-cards-delete"
}

Замініть демонстраційні значення даними зі своєї бази.

Приклад успішної відповіді

{
    "ok": true,
    "data": {
        "method": "catalog.discount_cards.delete",
        "result": {
            "upstream": {
                "name": "UPMAPI",
                "version": "1",
                "resource": "catalog"
            },
            "status": {
                "code": "OK",
                "operation": "discount_cards.delete",
                "catalog": "Приклад",
                "affected": "Приклад"
            },
            "rows": []
        },
        "id": "example-catalog-discount-cards-delete"
    },
    "request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
КодHTTPПричинаДія клієнта
INVALID_PARAMETER422Один із параметрів має неправильний тип, формат або значення.Виправити запит; автоматично не повторювати.
UPSTREAM_FAILURE502Сервер бізнес-операції недоступний або відхилив безпечний контракт.Не створювати новий Idempotency-Key; перевірити журнал і бізнес-об’єкт.
IDEMPOTENCY_KEY_REQUIRED422Для виконання запису не передано Idempotency-Key.Створити ключ для цієї бізнес-операції та повторити.
IDEMPOTENCY_RESULT_UNKNOWN409Результат попередньої спроби невідомий; gateway не виконав запис повторно.Звірити документ, чек або платіж; не створювати новий ключ автоматично.
catalog.discount_cards.saveСтворює або оновлює дисконтну картку клієнта. запис catalog.write з 0.4.0

Створює або оновлює дисконтну картку клієнта.

Перевірити JSON JSON Schema
Стабільність: стабільний Scope: catalog.write Idempotency-Key: потрібен

Параметри params

ПолеЩо означаєТип і форматПравила
Основні
keyКлюч запису

Стабільний ключ запису, отриманий попереднім методом читання цього самого довідника.

string
необов’язковийПриклад: "Приклад"
codeНомер дисконтної картки

Публічний код товару, картки або іншого запису, як він відображається у програмі.

string
обов’язковийПриклад: "1001"
Додаткові
dfПрізвище

Поле «Прізвище» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.

string
необов’язковийПриклад: "Приклад"
diІм’я

Поле «Ім’я» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.

string
необов’язковийПриклад: "Приклад"
doПо батькові

Поле «По батькові» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.

string
необов’язковийПриклад: "Приклад"
dopinfДодаткова інформація

Поле «Додаткова інформація» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.

string
необов’язковийПриклад: "Приклад"
assigned_user_idПризначений користувач

Ідентифікатор «Призначений користувач», отриманий із результату відповідного методу читання цієї бази.

int
необов’язковийПриклад: 1
isdolgДозволити борг

Поле «Дозволити борг» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.

int
необов’язковийПриклад: 1
telТелефон

Поле «Телефон» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.

string · phone
необов’язковийПриклад: "+380501234567"
Дати й час
birth_dateДата народження

Дата «Дата народження» у календарному форматі YYYY-MM-DD.

string · date
необов’язковийПриклад: "2026-07-23"
dateaddedДата додавання

Дата «Дата додавання» у календарному форматі YYYY-MM-DD.

string · date
необов’язковийПриклад: "2026-07-23"
Суми та кількості
discВідсоток знижки

Точне числове значення «Відсоток знижки» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається.

string · decimal-string · percent
необов’язковийПриклад: "100.00"
sumpokСума покупок

Точне числове значення «Сума покупок» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається.

string · decimal-string · currency-of-operation
необов’язковийПриклад: "100.00"
maxdolgЛіміт боргу

Точне числове значення «Ліміт боргу» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається.

string · decimal-string · currency-of-operation
необов’язковийПриклад: "100.00"
bonus_pВідсоток бонусів

Точне числове значення «Відсоток бонусів» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається.

string · decimal-string · percent
необов’язковийПриклад: "100.00"
Точна схема параметрів
{
    "key": {
        "type": "string",
        "max": 512,
        "title": "Ключ запису",
        "description": "Стабільний ключ запису, отриманий попереднім методом читання цього самого довідника.",
        "group": "Основні",
        "example": "Приклад"
    },
    "code": {
        "type": "string",
        "max": 50,
        "required": true,
        "title": "Номер дисконтної картки",
        "description": "Публічний код товару, картки або іншого запису, як він відображається у програмі.",
        "group": "Основні",
        "example": "1001"
    },
    "df": {
        "type": "string",
        "max": 250,
        "title": "Прізвище",
        "description": "Поле «Прізвище» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": "Приклад"
    },
    "di": {
        "type": "string",
        "max": 250,
        "title": "Ім’я",
        "description": "Поле «Ім’я» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": "Приклад"
    },
    "do": {
        "type": "string",
        "max": 250,
        "title": "По батькові",
        "description": "Поле «По батькові» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": "Приклад"
    },
    "birth_date": {
        "type": "string",
        "max": 20,
        "title": "Дата народження",
        "description": "Дата «Дата народження» у календарному форматі YYYY-MM-DD.",
        "group": "Дати й час",
        "format": "date",
        "example": "2026-07-23"
    },
    "disc": {
        "type": "string",
        "max": 64,
        "pattern": "/^-?[0-9]+(?:[.,][0-9]+)?$/D",
        "title": "Відсоток знижки",
        "description": "Точне числове значення «Відсоток знижки» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається.",
        "group": "Суми та кількості",
        "format": "decimal-string",
        "unit": "percent",
        "example": "100.00"
    },
    "sumpok": {
        "type": "string",
        "max": 64,
        "pattern": "/^-?[0-9]+(?:[.,][0-9]+)?$/D",
        "title": "Сума покупок",
        "description": "Точне числове значення «Сума покупок» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається.",
        "group": "Суми та кількості",
        "format": "decimal-string",
        "unit": "currency-of-operation",
        "example": "100.00"
    },
    "dateadded": {
        "type": "string",
        "max": 30,
        "title": "Дата додавання",
        "description": "Дата «Дата додавання» у календарному форматі YYYY-MM-DD.",
        "group": "Дати й час",
        "format": "date",
        "example": "2026-07-23"
    },
    "dopinf": {
        "type": "string",
        "max": 4096,
        "title": "Додаткова інформація",
        "description": "Поле «Додаткова інформація» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": "Приклад"
    },
    "assigned_user_id": {
        "type": "int",
        "min": -2147483648,
        "max": 2147483647,
        "title": "Призначений користувач",
        "description": "Ідентифікатор «Призначений користувач», отриманий із результату відповідного методу читання цієї бази.",
        "group": "Додаткові",
        "example": 1
    },
    "isdolg": {
        "type": "int",
        "min": -2147483648,
        "max": 2147483647,
        "title": "Дозволити борг",
        "description": "Поле «Дозволити борг» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": 1
    },
    "maxdolg": {
        "type": "string",
        "max": 64,
        "pattern": "/^-?[0-9]+(?:[.,][0-9]+)?$/D",
        "title": "Ліміт боргу",
        "description": "Точне числове значення «Ліміт боргу» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається.",
        "group": "Суми та кількості",
        "format": "decimal-string",
        "unit": "currency-of-operation",
        "example": "100.00"
    },
    "tel": {
        "type": "string",
        "max": 30,
        "title": "Телефон",
        "description": "Поле «Телефон» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "format": "phone",
        "example": "+380501234567"
    },
    "bonus_p": {
        "type": "string",
        "max": 64,
        "pattern": "/^-?[0-9]+(?:[.,][0-9]+)?$/D",
        "title": "Відсоток бонусів",
        "description": "Точне числове значення «Відсоток бонусів» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається.",
        "group": "Суми та кількості",
        "format": "decimal-string",
        "unit": "percent",
        "example": "100.00"
    }
}

Результат

Форма відповіді: status
ПолеЗмістТипПриклад
catalogCatalogПовернене значення «Catalog» відповідного запису, документа або підсумку ARM20.string"Приклад"
affectedЗмінено записівКількість записів, які upstream фактично змінив.string"Приклад"
Точна схема результату
{
    "mode": "status",
    "fields": [
        "catalog",
        "affected"
    ],
    "field_specs": {
        "catalog": {
            "title": "Catalog",
            "description": "Повернене значення «Catalog» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        },
        "affected": {
            "title": "Змінено записів",
            "description": "Кількість записів, які upstream фактично змінив.",
            "type": "string",
            "example": "Приклад"
        }
    }
}

Приклад запиту

POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
Idempotency-Key: example-catalog-discount-cards-save-0001

{
    "method": "catalog.discount_cards.save",
    "params": {
        "code": "990000001",
        "df": "Петренко",
        "di": "Олена",
        "do": "Іванівна",
        "disc": "5",
        "tel": "+380501234567"
    },
    "id": "example-catalog-discount-cards-save"
}

Замініть демонстраційні значення даними зі своєї бази.

Приклад успішної відповіді

{
    "ok": true,
    "data": {
        "method": "catalog.discount_cards.save",
        "result": {
            "upstream": {
                "name": "UPMAPI",
                "version": "1",
                "resource": "catalog"
            },
            "status": {
                "code": "OK",
                "operation": "discount_cards.save",
                "catalog": "Приклад",
                "affected": "Приклад"
            },
            "rows": []
        },
        "id": "example-catalog-discount-cards-save"
    },
    "request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
КодHTTPПричинаДія клієнта
INVALID_PARAMETER422Один із параметрів має неправильний тип, формат або значення.Виправити запит; автоматично не повторювати.
UPSTREAM_FAILURE502Сервер бізнес-операції недоступний або відхилив безпечний контракт.Не створювати новий Idempotency-Key; перевірити журнал і бізнес-об’єкт.
IDEMPOTENCY_KEY_REQUIRED422Для виконання запису не передано Idempotency-Key.Створити ключ для цієї бізнес-операції та повторити.
IDEMPOTENCY_RESULT_UNKNOWN409Результат попередньої спроби невідомий; gateway не виконав запис повторно.Звірити документ, чек або платіж; не створювати новий ключ автоматично.
catalog.post.deleteВидаляє постачальника з довідника. запис catalog.write з 0.4.0

Видаляє постачальника з довідника.

Перевірити JSON JSON Schema
Стабільність: стабільний Scope: catalog.write Idempotency-Key: потрібен

Параметри params

ПолеЩо означаєТип і форматПравила
Основні
keyКлюч запису

Стабільний ключ запису, отриманий попереднім методом читання цього самого довідника.

string
обов’язковийПриклад: "Приклад"
Точна схема параметрів
{
    "key": {
        "type": "string",
        "required": true,
        "max": 512,
        "title": "Ключ запису",
        "description": "Стабільний ключ запису, отриманий попереднім методом читання цього самого довідника.",
        "group": "Основні",
        "example": "Приклад"
    }
}

Результат

Форма відповіді: status
ПолеЗмістТипПриклад
catalogCatalogПовернене значення «Catalog» відповідного запису, документа або підсумку ARM20.string"Приклад"
affectedЗмінено записівКількість записів, які upstream фактично змінив.string"Приклад"
Точна схема результату
{
    "mode": "status",
    "fields": [
        "catalog",
        "affected"
    ],
    "field_specs": {
        "catalog": {
            "title": "Catalog",
            "description": "Повернене значення «Catalog» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        },
        "affected": {
            "title": "Змінено записів",
            "description": "Кількість записів, які upstream фактично змінив.",
            "type": "string",
            "example": "Приклад"
        }
    }
}

Приклад запиту

POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
Idempotency-Key: example-catalog-post-delete-0001

{
    "method": "catalog.post.delete",
    "params": {
        "key": "Приклад"
    },
    "id": "example-catalog-post-delete"
}

Замініть демонстраційні значення даними зі своєї бази.

Приклад успішної відповіді

{
    "ok": true,
    "data": {
        "method": "catalog.post.delete",
        "result": {
            "upstream": {
                "name": "UPMAPI",
                "version": "1",
                "resource": "catalog"
            },
            "status": {
                "code": "OK",
                "operation": "post.delete",
                "catalog": "Приклад",
                "affected": "Приклад"
            },
            "rows": []
        },
        "id": "example-catalog-post-delete"
    },
    "request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
КодHTTPПричинаДія клієнта
INVALID_PARAMETER422Один із параметрів має неправильний тип, формат або значення.Виправити запит; автоматично не повторювати.
UPSTREAM_FAILURE502Сервер бізнес-операції недоступний або відхилив безпечний контракт.Не створювати новий Idempotency-Key; перевірити журнал і бізнес-об’єкт.
IDEMPOTENCY_KEY_REQUIRED422Для виконання запису не передано Idempotency-Key.Створити ключ для цієї бізнес-операції та повторити.
IDEMPOTENCY_RESULT_UNKNOWN409Результат попередньої спроби невідомий; gateway не виконав запис повторно.Звірити документ, чек або платіж; не створювати новий ключ автоматично.
catalog.post.restoreВідновлює раніше видаленого постачальника. запис catalog.write з 0.4.0

Відновлює раніше видаленого постачальника.

Перевірити JSON JSON Schema
Стабільність: стабільний Scope: catalog.write Idempotency-Key: потрібен

Параметри params

ПолеЩо означаєТип і форматПравила
Основні
keyКлюч запису

Стабільний ключ запису, отриманий попереднім методом читання цього самого довідника.

string
обов’язковийПриклад: "Приклад"
Точна схема параметрів
{
    "key": {
        "type": "string",
        "required": true,
        "max": 512,
        "title": "Ключ запису",
        "description": "Стабільний ключ запису, отриманий попереднім методом читання цього самого довідника.",
        "group": "Основні",
        "example": "Приклад"
    }
}

Результат

Форма відповіді: status
ПолеЗмістТипПриклад
catalogCatalogПовернене значення «Catalog» відповідного запису, документа або підсумку ARM20.string"Приклад"
affectedЗмінено записівКількість записів, які upstream фактично змінив.string"Приклад"
Точна схема результату
{
    "mode": "status",
    "fields": [
        "catalog",
        "affected"
    ],
    "field_specs": {
        "catalog": {
            "title": "Catalog",
            "description": "Повернене значення «Catalog» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        },
        "affected": {
            "title": "Змінено записів",
            "description": "Кількість записів, які upstream фактично змінив.",
            "type": "string",
            "example": "Приклад"
        }
    }
}

Приклад запиту

POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
Idempotency-Key: example-catalog-post-restore-0001

{
    "method": "catalog.post.restore",
    "params": {
        "key": "Приклад"
    },
    "id": "example-catalog-post-restore"
}

Замініть демонстраційні значення даними зі своєї бази.

Приклад успішної відповіді

{
    "ok": true,
    "data": {
        "method": "catalog.post.restore",
        "result": {
            "upstream": {
                "name": "UPMAPI",
                "version": "1",
                "resource": "catalog"
            },
            "status": {
                "code": "OK",
                "operation": "post.restore",
                "catalog": "Приклад",
                "affected": "Приклад"
            },
            "rows": []
        },
        "id": "example-catalog-post-restore"
    },
    "request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
КодHTTPПричинаДія клієнта
INVALID_PARAMETER422Один із параметрів має неправильний тип, формат або значення.Виправити запит; автоматично не повторювати.
UPSTREAM_FAILURE502Сервер бізнес-операції недоступний або відхилив безпечний контракт.Не створювати новий Idempotency-Key; перевірити журнал і бізнес-об’єкт.
IDEMPOTENCY_KEY_REQUIRED422Для виконання запису не передано Idempotency-Key.Створити ключ для цієї бізнес-операції та повторити.
IDEMPOTENCY_RESULT_UNKNOWN409Результат попередньої спроби невідомий; gateway не виконав запис повторно.Звірити документ, чек або платіж; не створювати новий ключ автоматично.
catalog.post.saveСтворює або оновлює картку постачальника. запис catalog.write з 0.4.0

Створює або оновлює картку постачальника.

Перевірити JSON JSON Schema
Стабільність: стабільний Scope: catalog.write Idempotency-Key: потрібен

Параметри params

ПолеЩо означаєТип і форматПравила
Основні
keyКлюч запису

Стабільний ключ запису, отриманий попереднім методом читання цього самого довідника.

string
необов’язковийПриклад: "Приклад"
ntНазва постачальника

Поле «Назва постачальника» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.

string
обов’язковийПриклад: "Тестовий товар"
Додаткові
rekvРеквізити

Поле «Реквізити» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.

string
необов’язковийПриклад: "Приклад"
Суми та кількості
otsrВідстрочка платежу

Точне числове значення «Відстрочка платежу» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається.

string · decimal-string · currency-of-operation
необов’язковийПриклад: "100.00"
sumdСума боргу

Точне числове значення «Сума боргу» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається.

string · decimal-string · currency-of-operation
необов’язковийПриклад: "100.00"
Точна схема параметрів
{
    "key": {
        "type": "string",
        "max": 512,
        "title": "Ключ запису",
        "description": "Стабільний ключ запису, отриманий попереднім методом читання цього самого довідника.",
        "group": "Основні",
        "example": "Приклад"
    },
    "nt": {
        "type": "string",
        "max": 255,
        "required": true,
        "title": "Назва постачальника",
        "description": "Поле «Назва постачальника» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Основні",
        "example": "Тестовий товар"
    },
    "rekv": {
        "type": "string",
        "max": 4096,
        "title": "Реквізити",
        "description": "Поле «Реквізити» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": "Приклад"
    },
    "otsr": {
        "type": "string",
        "max": 64,
        "pattern": "/^-?[0-9]+(?:[.,][0-9]+)?$/D",
        "title": "Відстрочка платежу",
        "description": "Точне числове значення «Відстрочка платежу» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається.",
        "group": "Суми та кількості",
        "format": "decimal-string",
        "unit": "currency-of-operation",
        "example": "100.00"
    },
    "sumd": {
        "type": "string",
        "max": 64,
        "pattern": "/^-?[0-9]+(?:[.,][0-9]+)?$/D",
        "title": "Сума боргу",
        "description": "Точне числове значення «Сума боргу» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається.",
        "group": "Суми та кількості",
        "format": "decimal-string",
        "unit": "currency-of-operation",
        "example": "100.00"
    }
}

Результат

Форма відповіді: status
ПолеЗмістТипПриклад
catalogCatalogПовернене значення «Catalog» відповідного запису, документа або підсумку ARM20.string"Приклад"
affectedЗмінено записівКількість записів, які upstream фактично змінив.string"Приклад"
Точна схема результату
{
    "mode": "status",
    "fields": [
        "catalog",
        "affected"
    ],
    "field_specs": {
        "catalog": {
            "title": "Catalog",
            "description": "Повернене значення «Catalog» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        },
        "affected": {
            "title": "Змінено записів",
            "description": "Кількість записів, які upstream фактично змінив.",
            "type": "string",
            "example": "Приклад"
        }
    }
}

Приклад запиту

POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
Idempotency-Key: example-catalog-post-save-0001

{
    "method": "catalog.post.save",
    "params": {
        "nt": "Тестовий товар"
    },
    "id": "example-catalog-post-save"
}

Замініть демонстраційні значення даними зі своєї бази.

Приклад успішної відповіді

{
    "ok": true,
    "data": {
        "method": "catalog.post.save",
        "result": {
            "upstream": {
                "name": "UPMAPI",
                "version": "1",
                "resource": "catalog"
            },
            "status": {
                "code": "OK",
                "operation": "post.save",
                "catalog": "Приклад",
                "affected": "Приклад"
            },
            "rows": []
        },
        "id": "example-catalog-post-save"
    },
    "request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
КодHTTPПричинаДія клієнта
INVALID_PARAMETER422Один із параметрів має неправильний тип, формат або значення.Виправити запит; автоматично не повторювати.
UPSTREAM_FAILURE502Сервер бізнес-операції недоступний або відхилив безпечний контракт.Не створювати новий Idempotency-Key; перевірити журнал і бізнес-об’єкт.
IDEMPOTENCY_KEY_REQUIRED422Для виконання запису не передано Idempotency-Key.Створити ключ для цієї бізнес-операції та повторити.
IDEMPOTENCY_RESULT_UNKNOWN409Результат попередньої спроби невідомий; gateway не виконав запис повторно.Звірити документ, чек або платіж; не створювати новий ключ автоматично.
catalog.translate_kupm.deleteВидаляє переклад елемента інтерфейсу програми. запис catalog.write з 0.4.0

Видаляє переклад елемента інтерфейсу програми.

Перевірити JSON JSON Schema
Стабільність: стабільний Scope: catalog.write Idempotency-Key: потрібен

Параметри params

ПолеЩо означаєТип і форматПравила
Основні
keyКлюч запису

Стабільний ключ запису, отриманий попереднім методом читання цього самого довідника.

string
обов’язковийПриклад: "Приклад"
Точна схема параметрів
{
    "key": {
        "type": "string",
        "required": true,
        "max": 512,
        "title": "Ключ запису",
        "description": "Стабільний ключ запису, отриманий попереднім методом читання цього самого довідника.",
        "group": "Основні",
        "example": "Приклад"
    }
}

Результат

Форма відповіді: status
ПолеЗмістТипПриклад
catalogCatalogПовернене значення «Catalog» відповідного запису, документа або підсумку ARM20.string"Приклад"
affectedЗмінено записівКількість записів, які upstream фактично змінив.string"Приклад"
Точна схема результату
{
    "mode": "status",
    "fields": [
        "catalog",
        "affected"
    ],
    "field_specs": {
        "catalog": {
            "title": "Catalog",
            "description": "Повернене значення «Catalog» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        },
        "affected": {
            "title": "Змінено записів",
            "description": "Кількість записів, які upstream фактично змінив.",
            "type": "string",
            "example": "Приклад"
        }
    }
}

Приклад запиту

POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
Idempotency-Key: example-catalog-translate-kupm-delete-0001

{
    "method": "catalog.translate_kupm.delete",
    "params": {
        "key": "Приклад"
    },
    "id": "example-catalog-translate-kupm-delete"
}

Замініть демонстраційні значення даними зі своєї бази.

Приклад успішної відповіді

{
    "ok": true,
    "data": {
        "method": "catalog.translate_kupm.delete",
        "result": {
            "upstream": {
                "name": "UPMAPI",
                "version": "1",
                "resource": "catalog"
            },
            "status": {
                "code": "OK",
                "operation": "translate_kupm.delete",
                "catalog": "Приклад",
                "affected": "Приклад"
            },
            "rows": []
        },
        "id": "example-catalog-translate-kupm-delete"
    },
    "request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
КодHTTPПричинаДія клієнта
INVALID_PARAMETER422Один із параметрів має неправильний тип, формат або значення.Виправити запит; автоматично не повторювати.
UPSTREAM_FAILURE502Сервер бізнес-операції недоступний або відхилив безпечний контракт.Не створювати новий Idempotency-Key; перевірити журнал і бізнес-об’єкт.
IDEMPOTENCY_KEY_REQUIRED422Для виконання запису не передано Idempotency-Key.Створити ключ для цієї бізнес-операції та повторити.
IDEMPOTENCY_RESULT_UNKNOWN409Результат попередньої спроби невідомий; gateway не виконав запис повторно.Звірити документ, чек або платіж; не створювати новий ключ автоматично.
catalog.translate_kupm.saveСтворює або оновлює переклад елемента інтерфейсу програми. запис catalog.write з 0.4.0

Створює або оновлює переклад елемента інтерфейсу програми.

Перевірити JSON JSON Schema
Стабільність: стабільний Scope: catalog.write Idempotency-Key: потрібен

Параметри params

ПолеЩо означаєТип і форматПравила
Основні
keyКлюч запису

Стабільний ключ запису, отриманий попереднім методом читання цього самого довідника.

string
необов’язковийПриклад: "Приклад"
Додаткові
fldСистемне ім’я поля

Поле «Системне ім’я поля» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.

string
обов’язковийПриклад: "Приклад"
rusРосійський текст

Поле «Російський текст» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.

string
обов’язковийПриклад: "Приклад"
ukrУкраїнський текст

Поле «Український текст» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.

string
обов’язковийПриклад: "Приклад"
widthШирина колонки

Поле «Ширина колонки» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.

int
необов’язковийПриклад: 1
Точна схема параметрів
{
    "key": {
        "type": "string",
        "max": 512,
        "title": "Ключ запису",
        "description": "Стабільний ключ запису, отриманий попереднім методом читання цього самого довідника.",
        "group": "Основні",
        "example": "Приклад"
    },
    "fld": {
        "type": "string",
        "max": 250,
        "required": true,
        "title": "Системне ім’я поля",
        "description": "Поле «Системне ім’я поля» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": "Приклад"
    },
    "rus": {
        "type": "string",
        "max": 255,
        "required": true,
        "title": "Російський текст",
        "description": "Поле «Російський текст» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": "Приклад"
    },
    "ukr": {
        "type": "string",
        "max": 250,
        "required": true,
        "title": "Український текст",
        "description": "Поле «Український текст» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": "Приклад"
    },
    "width": {
        "type": "int",
        "min": -2147483648,
        "max": 2147483647,
        "title": "Ширина колонки",
        "description": "Поле «Ширина колонки» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": 1
    }
}

Результат

Форма відповіді: status
ПолеЗмістТипПриклад
catalogCatalogПовернене значення «Catalog» відповідного запису, документа або підсумку ARM20.string"Приклад"
affectedЗмінено записівКількість записів, які upstream фактично змінив.string"Приклад"
Точна схема результату
{
    "mode": "status",
    "fields": [
        "catalog",
        "affected"
    ],
    "field_specs": {
        "catalog": {
            "title": "Catalog",
            "description": "Повернене значення «Catalog» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        },
        "affected": {
            "title": "Змінено записів",
            "description": "Кількість записів, які upstream фактично змінив.",
            "type": "string",
            "example": "Приклад"
        }
    }
}

Приклад запиту

POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
Idempotency-Key: example-catalog-translate-kupm-save-0001

{
    "method": "catalog.translate_kupm.save",
    "params": {
        "fld": "Main.Code",
        "rus": "Название",
        "ukr": "Назва"
    },
    "id": "example-catalog-translate-kupm-save"
}

Замініть демонстраційні значення даними зі своєї бази.

Приклад успішної відповіді

{
    "ok": true,
    "data": {
        "method": "catalog.translate_kupm.save",
        "result": {
            "upstream": {
                "name": "UPMAPI",
                "version": "1",
                "resource": "catalog"
            },
            "status": {
                "code": "OK",
                "operation": "translate_kupm.save",
                "catalog": "Приклад",
                "affected": "Приклад"
            },
            "rows": []
        },
        "id": "example-catalog-translate-kupm-save"
    },
    "request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
КодHTTPПричинаДія клієнта
INVALID_PARAMETER422Один із параметрів має неправильний тип, формат або значення.Виправити запит; автоматично не повторювати.
UPSTREAM_FAILURE502Сервер бізнес-операції недоступний або відхилив безпечний контракт.Не створювати новий Idempotency-Key; перевірити журнал і бізнес-об’єкт.
IDEMPOTENCY_KEY_REQUIRED422Для виконання запису не передано Idempotency-Key.Створити ключ для цієї бізнес-операції та повторити.
IDEMPOTENCY_RESULT_UNKNOWN409Результат попередньої спроби невідомий; gateway не виконав запис повторно.Звірити документ, чек або платіж; не створювати новий ключ автоматично.
catalog.translate_zap.deleteВидаляє налаштування підпису та вигляду колонки. запис catalog.write з 0.4.0

Видаляє налаштування підпису та вигляду колонки.

Перевірити JSON JSON Schema
Стабільність: стабільний Scope: catalog.write Idempotency-Key: потрібен

Параметри params

ПолеЩо означаєТип і форматПравила
Основні
keyКлюч запису

Стабільний ключ запису, отриманий попереднім методом читання цього самого довідника.

string
обов’язковийПриклад: "Приклад"
Точна схема параметрів
{
    "key": {
        "type": "string",
        "required": true,
        "max": 512,
        "title": "Ключ запису",
        "description": "Стабільний ключ запису, отриманий попереднім методом читання цього самого довідника.",
        "group": "Основні",
        "example": "Приклад"
    }
}

Результат

Форма відповіді: status
ПолеЗмістТипПриклад
catalogCatalogПовернене значення «Catalog» відповідного запису, документа або підсумку ARM20.string"Приклад"
affectedЗмінено записівКількість записів, які upstream фактично змінив.string"Приклад"
Точна схема результату
{
    "mode": "status",
    "fields": [
        "catalog",
        "affected"
    ],
    "field_specs": {
        "catalog": {
            "title": "Catalog",
            "description": "Повернене значення «Catalog» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        },
        "affected": {
            "title": "Змінено записів",
            "description": "Кількість записів, які upstream фактично змінив.",
            "type": "string",
            "example": "Приклад"
        }
    }
}

Приклад запиту

POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
Idempotency-Key: example-catalog-translate-zap-delete-0001

{
    "method": "catalog.translate_zap.delete",
    "params": {
        "key": "Приклад"
    },
    "id": "example-catalog-translate-zap-delete"
}

Замініть демонстраційні значення даними зі своєї бази.

Приклад успішної відповіді

{
    "ok": true,
    "data": {
        "method": "catalog.translate_zap.delete",
        "result": {
            "upstream": {
                "name": "UPMAPI",
                "version": "1",
                "resource": "catalog"
            },
            "status": {
                "code": "OK",
                "operation": "translate_zap.delete",
                "catalog": "Приклад",
                "affected": "Приклад"
            },
            "rows": []
        },
        "id": "example-catalog-translate-zap-delete"
    },
    "request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
КодHTTPПричинаДія клієнта
INVALID_PARAMETER422Один із параметрів має неправильний тип, формат або значення.Виправити запит; автоматично не повторювати.
UPSTREAM_FAILURE502Сервер бізнес-операції недоступний або відхилив безпечний контракт.Не створювати новий Idempotency-Key; перевірити журнал і бізнес-об’єкт.
IDEMPOTENCY_KEY_REQUIRED422Для виконання запису не передано Idempotency-Key.Створити ключ для цієї бізнес-операції та повторити.
IDEMPOTENCY_RESULT_UNKNOWN409Результат попередньої спроби невідомий; gateway не виконав запис повторно.Звірити документ, чек або платіж; не створювати новий ключ автоматично.
catalog.translate_zap.saveСтворює або оновлює підпис, ширину та вирівнювання колонки. запис catalog.write з 0.4.0

Створює або оновлює підпис, ширину та вирівнювання колонки.

Перевірити JSON JSON Schema
Стабільність: стабільний Scope: catalog.write Idempotency-Key: потрібен

Параметри params

ПолеЩо означаєТип і форматПравила
Основні
keyКлюч запису

Стабільний ключ запису, отриманий попереднім методом читання цього самого довідника.

string
необов’язковийПриклад: "Приклад"
Додаткові
fldСистемне ім’я поля

Поле «Системне ім’я поля» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.

string
обов’язковийПриклад: "Приклад"
rusРосійський текст

Поле «Російський текст» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.

string
обов’язковийПриклад: "Приклад"
ukrУкраїнський текст

Поле «Український текст» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.

string
обов’язковийПриклад: "Приклад"
widthШирина колонки

Поле «Ширина колонки» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.

int
необов’язковийПриклад: 1
Точна схема параметрів
{
    "key": {
        "type": "string",
        "max": 512,
        "title": "Ключ запису",
        "description": "Стабільний ключ запису, отриманий попереднім методом читання цього самого довідника.",
        "group": "Основні",
        "example": "Приклад"
    },
    "fld": {
        "type": "string",
        "max": 250,
        "required": true,
        "title": "Системне ім’я поля",
        "description": "Поле «Системне ім’я поля» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": "Приклад"
    },
    "rus": {
        "type": "string",
        "max": 255,
        "required": true,
        "title": "Російський текст",
        "description": "Поле «Російський текст» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": "Приклад"
    },
    "ukr": {
        "type": "string",
        "max": 250,
        "required": true,
        "title": "Український текст",
        "description": "Поле «Український текст» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": "Приклад"
    },
    "width": {
        "type": "int",
        "min": -2147483648,
        "max": 2147483647,
        "title": "Ширина колонки",
        "description": "Поле «Ширина колонки» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": 1
    }
}

Результат

Форма відповіді: status
ПолеЗмістТипПриклад
catalogCatalogПовернене значення «Catalog» відповідного запису, документа або підсумку ARM20.string"Приклад"
affectedЗмінено записівКількість записів, які upstream фактично змінив.string"Приклад"
Точна схема результату
{
    "mode": "status",
    "fields": [
        "catalog",
        "affected"
    ],
    "field_specs": {
        "catalog": {
            "title": "Catalog",
            "description": "Повернене значення «Catalog» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        },
        "affected": {
            "title": "Змінено записів",
            "description": "Кількість записів, які upstream фактично змінив.",
            "type": "string",
            "example": "Приклад"
        }
    }
}

Приклад запиту

POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
Idempotency-Key: example-catalog-translate-zap-save-0001

{
    "method": "catalog.translate_zap.save",
    "params": {
        "fld": "Main.Code",
        "rus": "Название",
        "ukr": "Назва"
    },
    "id": "example-catalog-translate-zap-save"
}

Замініть демонстраційні значення даними зі своєї бази.

Приклад успішної відповіді

{
    "ok": true,
    "data": {
        "method": "catalog.translate_zap.save",
        "result": {
            "upstream": {
                "name": "UPMAPI",
                "version": "1",
                "resource": "catalog"
            },
            "status": {
                "code": "OK",
                "operation": "translate_zap.save",
                "catalog": "Приклад",
                "affected": "Приклад"
            },
            "rows": []
        },
        "id": "example-catalog-translate-zap-save"
    },
    "request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
КодHTTPПричинаДія клієнта
INVALID_PARAMETER422Один із параметрів має неправильний тип, формат або значення.Виправити запит; автоматично не повторювати.
UPSTREAM_FAILURE502Сервер бізнес-операції недоступний або відхилив безпечний контракт.Не створювати новий Idempotency-Key; перевірити журнал і бізнес-об’єкт.
IDEMPOTENCY_KEY_REQUIRED422Для виконання запису не передано Idempotency-Key.Створити ключ для цієї бізнес-операції та повторити.
IDEMPOTENCY_RESULT_UNKNOWN409Результат попередньої спроби невідомий; gateway не виконав запис повторно.Звірити документ, чек або платіж; не створювати новий ключ автоматично.
catalog.users.deleteВидаляє користувача з довідника працівників. запис catalog.write з 0.4.0

Видаляє користувача з довідника працівників.

Перевірити JSON JSON Schema
Стабільність: стабільний Scope: catalog.write Idempotency-Key: потрібен

Параметри params

ПолеЩо означаєТип і форматПравила
Основні
keyКлюч запису

Стабільний ключ запису, отриманий попереднім методом читання цього самого довідника.

string
обов’язковийПриклад: "Приклад"
Точна схема параметрів
{
    "key": {
        "type": "string",
        "required": true,
        "max": 512,
        "title": "Ключ запису",
        "description": "Стабільний ключ запису, отриманий попереднім методом читання цього самого довідника.",
        "group": "Основні",
        "example": "Приклад"
    }
}

Результат

Форма відповіді: status
ПолеЗмістТипПриклад
catalogCatalogПовернене значення «Catalog» відповідного запису, документа або підсумку ARM20.string"Приклад"
affectedЗмінено записівКількість записів, які upstream фактично змінив.string"Приклад"
Точна схема результату
{
    "mode": "status",
    "fields": [
        "catalog",
        "affected"
    ],
    "field_specs": {
        "catalog": {
            "title": "Catalog",
            "description": "Повернене значення «Catalog» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        },
        "affected": {
            "title": "Змінено записів",
            "description": "Кількість записів, які upstream фактично змінив.",
            "type": "string",
            "example": "Приклад"
        }
    }
}

Приклад запиту

POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
Idempotency-Key: example-catalog-users-delete-0001

{
    "method": "catalog.users.delete",
    "params": {
        "key": "Приклад"
    },
    "id": "example-catalog-users-delete"
}

Замініть демонстраційні значення даними зі своєї бази.

Приклад успішної відповіді

{
    "ok": true,
    "data": {
        "method": "catalog.users.delete",
        "result": {
            "upstream": {
                "name": "UPMAPI",
                "version": "1",
                "resource": "catalog"
            },
            "status": {
                "code": "OK",
                "operation": "users.delete",
                "catalog": "Приклад",
                "affected": "Приклад"
            },
            "rows": []
        },
        "id": "example-catalog-users-delete"
    },
    "request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
КодHTTPПричинаДія клієнта
INVALID_PARAMETER422Один із параметрів має неправильний тип, формат або значення.Виправити запит; автоматично не повторювати.
UPSTREAM_FAILURE502Сервер бізнес-операції недоступний або відхилив безпечний контракт.Не створювати новий Idempotency-Key; перевірити журнал і бізнес-об’єкт.
IDEMPOTENCY_KEY_REQUIRED422Для виконання запису не передано Idempotency-Key.Створити ключ для цієї бізнес-операції та повторити.
IDEMPOTENCY_RESULT_UNKNOWN409Результат попередньої спроби невідомий; gateway не виконав запис повторно.Звірити документ, чек або платіж; не створювати новий ключ автоматично.
catalog.users.saveСтворює або оновлює користувача в довіднику працівників. запис catalog.write з 0.4.0

Створює або оновлює користувача в довіднику працівників.

Перевірити JSON JSON Schema
Стабільність: стабільний Scope: catalog.write Idempotency-Key: потрібен

Параметри params

ПолеЩо означаєТип і форматПравила
Основні
keyКлюч запису

Стабільний ключ запису, отриманий попереднім методом читання цього самого довідника.

string
необов’язковийПриклад: "Приклад"
ntІм’я користувача

Поле «Ім’я користувача» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.

string
обов’язковийПриклад: "Тестовий товар"
Додаткові
cardКартка користувача

Поле «Картка користувача» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.

string
обов’язковийПриклад: "990000001"
rekvРеквізити

Поле «Реквізити» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.

string
необов’язковийПриклад: "Приклад"
levelРівень категорії

Поле «Рівень категорії» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.

string
обов’язковийПриклад: "Приклад"
kasxНомер каси

Поле «Номер каси» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.

int
необов’язковийПриклад: 1
typexТип запису

Поле «Тип запису» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.

string
необов’язковийПриклад: "Приклад"
telТелефон

Поле «Телефон» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.

string · phone
необов’язковийПриклад: "+380501234567"
Суми та кількості
kfКоефіцієнт

Точне числове значення «Коефіцієнт» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається.

string · decimal-string · ratio
необов’язковийПриклад: "100.00"
Точна схема параметрів
{
    "key": {
        "type": "string",
        "max": 512,
        "title": "Ключ запису",
        "description": "Стабільний ключ запису, отриманий попереднім методом читання цього самого довідника.",
        "group": "Основні",
        "example": "Приклад"
    },
    "nt": {
        "type": "string",
        "max": 255,
        "required": true,
        "title": "Ім’я користувача",
        "description": "Поле «Ім’я користувача» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Основні",
        "example": "Тестовий товар"
    },
    "card": {
        "type": "string",
        "max": 45,
        "required": true,
        "title": "Картка користувача",
        "description": "Поле «Картка користувача» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": "990000001"
    },
    "rekv": {
        "type": "string",
        "max": 4096,
        "title": "Реквізити",
        "description": "Поле «Реквізити» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": "Приклад"
    },
    "level": {
        "type": "string",
        "max": 2,
        "required": true,
        "title": "Рівень категорії",
        "description": "Поле «Рівень категорії» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": "Приклад"
    },
    "kf": {
        "type": "string",
        "max": 64,
        "pattern": "/^-?[0-9]+(?:[.,][0-9]+)?$/D",
        "title": "Коефіцієнт",
        "description": "Точне числове значення «Коефіцієнт» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається.",
        "group": "Суми та кількості",
        "format": "decimal-string",
        "unit": "ratio",
        "example": "100.00"
    },
    "kasx": {
        "type": "int",
        "min": -2147483648,
        "max": 2147483647,
        "title": "Номер каси",
        "description": "Поле «Номер каси» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": 1
    },
    "typex": {
        "type": "string",
        "max": 20,
        "title": "Тип запису",
        "description": "Поле «Тип запису» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": "Приклад"
    },
    "tel": {
        "type": "string",
        "max": 100,
        "title": "Телефон",
        "description": "Поле «Телефон» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "format": "phone",
        "example": "+380501234567"
    }
}

Результат

Форма відповіді: status
ПолеЗмістТипПриклад
catalogCatalogПовернене значення «Catalog» відповідного запису, документа або підсумку ARM20.string"Приклад"
affectedЗмінено записівКількість записів, які upstream фактично змінив.string"Приклад"
Точна схема результату
{
    "mode": "status",
    "fields": [
        "catalog",
        "affected"
    ],
    "field_specs": {
        "catalog": {
            "title": "Catalog",
            "description": "Повернене значення «Catalog» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        },
        "affected": {
            "title": "Змінено записів",
            "description": "Кількість записів, які upstream фактично змінив.",
            "type": "string",
            "example": "Приклад"
        }
    }
}

Приклад запиту

POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
Idempotency-Key: example-catalog-users-save-0001

{
    "method": "catalog.users.save",
    "params": {
        "nt": "Тестовий товар",
        "card": "990000001",
        "level": "Пр"
    },
    "id": "example-catalog-users-save"
}

Замініть демонстраційні значення даними зі своєї бази.

Приклад успішної відповіді

{
    "ok": true,
    "data": {
        "method": "catalog.users.save",
        "result": {
            "upstream": {
                "name": "UPMAPI",
                "version": "1",
                "resource": "catalog"
            },
            "status": {
                "code": "OK",
                "operation": "users.save",
                "catalog": "Приклад",
                "affected": "Приклад"
            },
            "rows": []
        },
        "id": "example-catalog-users-save"
    },
    "request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
КодHTTPПричинаДія клієнта
INVALID_PARAMETER422Один із параметрів має неправильний тип, формат або значення.Виправити запит; автоматично не повторювати.
UPSTREAM_FAILURE502Сервер бізнес-операції недоступний або відхилив безпечний контракт.Не створювати новий Idempotency-Key; перевірити журнал і бізнес-об’єкт.
IDEMPOTENCY_KEY_REQUIRED422Для виконання запису не передано Idempotency-Key.Створити ключ для цієї бізнес-операції та повторити.
IDEMPOTENCY_RESULT_UNKNOWN409Результат попередньої спроби невідомий; gateway не виконав запис повторно.Звірити документ, чек або платіж; не створювати новий ключ автоматично.
category

Категорії товарів

7 методів
category.addДодає нову категорію або підкатегорію товарів. запис catalog.write з 0.4.0

Додає нову категорію або підкатегорію товарів.

Перевірити JSON JSON Schema
Стабільність: стабільний Scope: catalog.write Idempotency-Key: потрібен

Параметри params

ПолеЩо означаєТип і форматПравила
Додаткові
levelРівень категорії

Поле «Рівень категорії» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.

int
необов’язковийПриклад: 1За замовчуванням: 0
parent_nameБатьківська категорія

Поле «Батьківська категорія» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.

string
необов’язковийПриклад: ""За замовчуванням: ""
uktzedКод УКТ ЗЕД

Поле «Код УКТ ЗЕД» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.

string
необов’язковийПриклад: ""За замовчуванням: ""
nocloudНе публікувати у хмарі

Визначає, чи застосовувати параметр «Не публікувати у хмарі». Передавайте JSON true або false.

bool
необов’язковийПриклад: falseЗа замовчуванням: false
nominusЗаборонити від’ємний залишок

Визначає, чи застосовувати параметр «Заборонити від’ємний залишок». Передавайте JSON true або false.

bool
необов’язковийПриклад: falseЗа замовчуванням: false
Основні
nameНазва

Поле «Назва» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.

string
обов’язковийПриклад: "Тестовий товар"
Суми та кількості
upercНацінка категорії

Точне числове значення «Націнка категорії» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається.

decimal · decimal-string · percent
необов’язковийПриклад: "100.00"За замовчуванням: "0"
k_discКоефіцієнт знижки

Точне числове значення «Коефіцієнт знижки» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається.

decimal · decimal-string · currency-of-operation
необов’язковийПриклад: "100.00"За замовчуванням: "0"
k_bonusКоефіцієнт бонусів

Точне числове значення «Коефіцієнт бонусів» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається.

decimal · decimal-string · currency-of-operation
необов’язковийПриклад: "100.00"За замовчуванням: "0"
Точна схема параметрів
{
    "level": {
        "type": "int",
        "min": 0,
        "max": 1,
        "default": 0,
        "title": "Рівень категорії",
        "description": "Поле «Рівень категорії» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": 1
    },
    "name": {
        "type": "string",
        "required": true,
        "max": 512,
        "pattern": "/^[^\\x00-\\x1F\\x7F]{3,512}$/uD",
        "title": "Назва",
        "description": "Поле «Назва» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Основні",
        "example": "Тестовий товар"
    },
    "parent_name": {
        "type": "string",
        "max": 512,
        "default": "",
        "title": "Батьківська категорія",
        "description": "Поле «Батьківська категорія» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": ""
    },
    "uktzed": {
        "type": "string",
        "max": 4096,
        "default": "",
        "title": "Код УКТ ЗЕД",
        "description": "Поле «Код УКТ ЗЕД» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": ""
    },
    "uperc": {
        "type": "decimal",
        "max": 32,
        "scale": 8,
        "default": "0",
        "title": "Націнка категорії",
        "description": "Точне числове значення «Націнка категорії» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається.",
        "group": "Суми та кількості",
        "format": "decimal-string",
        "unit": "percent",
        "example": "100.00"
    },
    "nocloud": {
        "type": "bool",
        "default": false,
        "title": "Не публікувати у хмарі",
        "description": "Визначає, чи застосовувати параметр «Не публікувати у хмарі». Передавайте JSON true або false.",
        "group": "Додаткові",
        "example": false
    },
    "nominus": {
        "type": "bool",
        "default": false,
        "title": "Заборонити від’ємний залишок",
        "description": "Визначає, чи застосовувати параметр «Заборонити від’ємний залишок». Передавайте JSON true або false.",
        "group": "Додаткові",
        "example": false
    },
    "k_disc": {
        "type": "decimal",
        "max": 32,
        "scale": 8,
        "default": "0",
        "title": "Коефіцієнт знижки",
        "description": "Точне числове значення «Коефіцієнт знижки» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається.",
        "group": "Суми та кількості",
        "format": "decimal-string",
        "unit": "currency-of-operation",
        "example": "100.00"
    },
    "k_bonus": {
        "type": "decimal",
        "max": 32,
        "scale": 8,
        "default": "0",
        "title": "Коефіцієнт бонусів",
        "description": "Точне числове значення «Коефіцієнт бонусів» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається.",
        "group": "Суми та кількості",
        "format": "decimal-string",
        "unit": "currency-of-operation",
        "example": "100.00"
    }
}

Результат

Форма відповіді: status
ПолеЗмістТипПриклад
category_idІдентифікатор категоріїПовернене значення «Ідентифікатор категорії» відповідного запису, документа або підсумку ARM20.string"Приклад"
Точна схема результату
{
    "mode": "status",
    "fields": [
        "category_id"
    ],
    "field_specs": {
        "category_id": {
            "title": "Ідентифікатор категорії",
            "description": "Повернене значення «Ідентифікатор категорії» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        }
    }
}

Приклад запиту

POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
Idempotency-Key: example-category-add-0001

{
    "method": "category.add",
    "params": {
        "level": 0,
        "name": "Напої",
        "uperc": "12.5000",
        "nocloud": false,
        "nominus": false
    },
    "id": "example-category-add"
}

Замініть демонстраційні значення даними зі своєї бази.

Приклад успішної відповіді

{
    "ok": true,
    "data": {
        "method": "category.add",
        "result": {
            "upstream": {
                "name": "UPMAPI",
                "version": "1",
                "resource": "category"
            },
            "status": {
                "code": "OK",
                "operation": "add",
                "category_id": "Приклад"
            },
            "rows": []
        },
        "id": "example-category-add"
    },
    "request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
КодHTTPПричинаДія клієнта
INVALID_PARAMETER422Один із параметрів має неправильний тип, формат або значення.Виправити запит; автоматично не повторювати.
UPSTREAM_FAILURE502Сервер бізнес-операції недоступний або відхилив безпечний контракт.Не створювати новий Idempotency-Key; перевірити журнал і бізнес-об’єкт.
IDEMPOTENCY_KEY_REQUIRED422Для виконання запису не передано Idempotency-Key.Створити ключ для цієї бізнес-операції та повторити.
IDEMPOTENCY_RESULT_UNKNOWN409Результат попередньої спроби невідомий; gateway не виконав запис повторно.Звірити документ, чек або платіж; не створювати новий ключ автоматично.
category.clear_pictureВидаляє зображення вибраної категорії товарів. запис catalog.write з 0.4.0

Видаляє зображення вибраної категорії товарів.

Перевірити JSON JSON Schema
Стабільність: стабільний Scope: catalog.write Idempotency-Key: потрібен

Параметри params

ПолеЩо означаєТип і форматПравила
Основні
uinІдентифікатор запису

Внутрішній числовий ідентифікатор запису, отриманий методом читання відповідного довідника.

string
обов’язковийПриклад: "Приклад"
Точна схема параметрів
{
    "uin": {
        "type": "string",
        "max": 4096,
        "required": true,
        "title": "Ідентифікатор запису",
        "description": "Внутрішній числовий ідентифікатор запису, отриманий методом читання відповідного довідника.",
        "group": "Основні",
        "example": "Приклад"
    }
}

Результат

Форма відповіді: status
ПолеЗмістТипПриклад
affectedЗмінено записівКількість записів, які upstream фактично змінив.string"Приклад"
Точна схема результату
{
    "mode": "status",
    "fields": [
        "affected"
    ],
    "field_specs": {
        "affected": {
            "title": "Змінено записів",
            "description": "Кількість записів, які upstream фактично змінив.",
            "type": "string",
            "example": "Приклад"
        }
    }
}

Приклад запиту

POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
Idempotency-Key: example-category-clear-picture-0001

{
    "method": "category.clear_picture",
    "params": {
        "uin": "Приклад"
    },
    "id": "example-category-clear-picture"
}

Замініть демонстраційні значення даними зі своєї бази.

Приклад успішної відповіді

{
    "ok": true,
    "data": {
        "method": "category.clear_picture",
        "result": {
            "upstream": {
                "name": "UPMAPI",
                "version": "1",
                "resource": "category"
            },
            "status": {
                "code": "OK",
                "operation": "clear_picture",
                "affected": "Приклад"
            },
            "rows": []
        },
        "id": "example-category-clear-picture"
    },
    "request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
КодHTTPПричинаДія клієнта
INVALID_PARAMETER422Один із параметрів має неправильний тип, формат або значення.Виправити запит; автоматично не повторювати.
UPSTREAM_FAILURE502Сервер бізнес-операції недоступний або відхилив безпечний контракт.Не створювати новий Idempotency-Key; перевірити журнал і бізнес-об’єкт.
IDEMPOTENCY_KEY_REQUIRED422Для виконання запису не передано Idempotency-Key.Створити ключ для цієї бізнес-операції та повторити.
IDEMPOTENCY_RESULT_UNKNOWN409Результат попередньої спроби невідомий; gateway не виконав запис повторно.Звірити документ, чек або платіж; не створювати новий ключ автоматично.
category.clear_temp_pictureОчищає тимчасове зображення після скасування створення категорії. запис catalog.write з 0.4.0

Очищає тимчасове зображення після скасування створення категорії.

Перевірити JSON JSON Schema
Стабільність: стабільний Scope: catalog.write Idempotency-Key: потрібен

Параметри params

Параметри не потрібні. Передайте порожній об’єкт {}.
Точна схема параметрів
{}

Результат

Форма відповіді: status
ПолеЗмістТипПриклад
affectedЗмінено записівКількість записів, які upstream фактично змінив.string"Приклад"
Точна схема результату
{
    "mode": "status",
    "fields": [
        "affected"
    ],
    "field_specs": {
        "affected": {
            "title": "Змінено записів",
            "description": "Кількість записів, які upstream фактично змінив.",
            "type": "string",
            "example": "Приклад"
        }
    }
}

Приклад запиту

POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
Idempotency-Key: example-category-clear-temp-picture-0001

{
    "method": "category.clear_temp_picture",
    "params": [],
    "id": "example-category-clear-temp-picture"
}

Замініть демонстраційні значення даними зі своєї бази.

Приклад успішної відповіді

{
    "ok": true,
    "data": {
        "method": "category.clear_temp_picture",
        "result": {
            "upstream": {
                "name": "UPMAPI",
                "version": "1",
                "resource": "category"
            },
            "status": {
                "code": "OK",
                "operation": "clear_temp_picture",
                "affected": "Приклад"
            },
            "rows": []
        },
        "id": "example-category-clear-temp-picture"
    },
    "request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
КодHTTPПричинаДія клієнта
INVALID_PARAMETER422Один із параметрів має неправильний тип, формат або значення.Виправити запит; автоматично не повторювати.
UPSTREAM_FAILURE502Сервер бізнес-операції недоступний або відхилив безпечний контракт.Не створювати новий Idempotency-Key; перевірити журнал і бізнес-об’єкт.
IDEMPOTENCY_KEY_REQUIRED422Для виконання запису не передано Idempotency-Key.Створити ключ для цієї бізнес-операції та повторити.
IDEMPOTENCY_RESULT_UNKNOWN409Результат попередньої спроби невідомий; gateway не виконав запис повторно.Звірити документ, чек або платіж; не створювати новий ключ автоматично.
category.deleteВидаляє категорію або підкатегорію товарів. запис catalog.write з 0.4.0

Видаляє категорію або підкатегорію товарів.

Перевірити JSON JSON Schema
Стабільність: стабільний Scope: catalog.write Idempotency-Key: потрібен

Параметри params

ПолеЩо означаєТип і форматПравила
Основні
uinІдентифікатор запису

Внутрішній числовий ідентифікатор запису, отриманий методом читання відповідного довідника.

int
необов’язковийПриклад: 1За замовчуванням: 0
Точна схема параметрів
{
    "uin": {
        "type": "int",
        "min": -2147483648,
        "max": 2147483647,
        "default": 0,
        "title": "Ідентифікатор запису",
        "description": "Внутрішній числовий ідентифікатор запису, отриманий методом читання відповідного довідника.",
        "group": "Основні",
        "example": 1
    }
}

Результат

Форма відповіді: status
ПолеЗмістТипПриклад
category_idІдентифікатор категоріїПовернене значення «Ідентифікатор категорії» відповідного запису, документа або підсумку ARM20.string"Приклад"
Точна схема результату
{
    "mode": "status",
    "fields": [
        "category_id"
    ],
    "field_specs": {
        "category_id": {
            "title": "Ідентифікатор категорії",
            "description": "Повернене значення «Ідентифікатор категорії» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        }
    }
}

Приклад запиту

POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
Idempotency-Key: example-category-delete-0001

{
    "method": "category.delete",
    "params": {
        "uin": 1
    },
    "id": "example-category-delete"
}

Замініть демонстраційні значення даними зі своєї бази.

Приклад успішної відповіді

{
    "ok": true,
    "data": {
        "method": "category.delete",
        "result": {
            "upstream": {
                "name": "UPMAPI",
                "version": "1",
                "resource": "category"
            },
            "status": {
                "code": "OK",
                "operation": "delete",
                "category_id": "Приклад"
            },
            "rows": []
        },
        "id": "example-category-delete"
    },
    "request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
КодHTTPПричинаДія клієнта
INVALID_PARAMETER422Один із параметрів має неправильний тип, формат або значення.Виправити запит; автоматично не повторювати.
UPSTREAM_FAILURE502Сервер бізнес-операції недоступний або відхилив безпечний контракт.Не створювати новий Idempotency-Key; перевірити журнал і бізнес-об’єкт.
IDEMPOTENCY_KEY_REQUIRED422Для виконання запису не передано Idempotency-Key.Створити ключ для цієї бізнес-операції та повторити.
IDEMPOTENCY_RESULT_UNKNOWN409Результат попередньої спроби невідомий; gateway не виконав запис повторно.Звірити документ, чек або платіж; не створювати новий ключ автоматично.
category.move_goodsПереносить вибрані товари до іншої підкатегорії або прибирає їх із категорії. запис catalog.write з 0.4.0

Переносить вибрані товари до іншої підкатегорії або прибирає їх із категорії.

Перевірити JSON JSON Schema
Стабільність: стабільний Scope: catalog.write Idempotency-Key: потрібен

Параметри params

ПолеЩо означаєТип і форматПравила
Основні
uinІдентифікатор запису

Внутрішній числовий ідентифікатор запису, отриманий методом читання відповідного довідника.

int
обов’язковийПриклад: 1
Колекції
codesКоди товарів

Масив кодів товарів. Порядок елементів зберігається під час передавання до операції.

array<string>
обов’язковийПриклад: []
Точна схема параметрів
{
    "uin": {
        "type": "int",
        "required": true,
        "min": 0,
        "max": 2147483647,
        "title": "Ідентифікатор запису",
        "description": "Внутрішній числовий ідентифікатор запису, отриманий методом читання відповідного довідника.",
        "group": "Основні",
        "example": 1
    },
    "codes": {
        "type": "array",
        "required": true,
        "min_items": 1,
        "max_items": 900,
        "unique": true,
        "items": {
            "type": "string",
            "required": true,
            "max": 190,
            "pattern": "/^[^\\x00-\\x1F\\x7F]{1,190}$/uD",
            "title": "Codes item",
            "description": "Поле «Codes item» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
            "group": "Додаткові",
            "example": "Приклад"
        },
        "title": "Коди товарів",
        "description": "Масив кодів товарів. Порядок елементів зберігається під час передавання до операції.",
        "group": "Колекції",
        "example": []
    }
}

Результат

Форма відповіді: status
ПолеЗмістТипПриклад
requested_countRequested countПовернене значення «Requested count» відповідного запису, документа або підсумку ARM20.string"Приклад"
Точна схема результату
{
    "mode": "status",
    "fields": [
        "requested_count"
    ],
    "field_specs": {
        "requested_count": {
            "title": "Requested count",
            "description": "Повернене значення «Requested count» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        }
    }
}

Приклад запиту

POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
Idempotency-Key: example-category-move-goods-0001

{
    "method": "category.move_goods",
    "params": {
        "uin": 5,
        "codes": [
            "1001",
            "1002"
        ]
    },
    "id": "example-category-move-goods"
}

Замініть демонстраційні значення даними зі своєї бази.

Приклад успішної відповіді

{
    "ok": true,
    "data": {
        "method": "category.move_goods",
        "result": {
            "upstream": {
                "name": "UPMAPI",
                "version": "1",
                "resource": "category"
            },
            "status": {
                "code": "OK",
                "operation": "move_goods",
                "requested_count": "Приклад"
            },
            "rows": []
        },
        "id": "example-category-move-goods"
    },
    "request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
КодHTTPПричинаДія клієнта
INVALID_PARAMETER422Один із параметрів має неправильний тип, формат або значення.Виправити запит; автоматично не повторювати.
UPSTREAM_FAILURE502Сервер бізнес-операції недоступний або відхилив безпечний контракт.Не створювати новий Idempotency-Key; перевірити журнал і бізнес-об’єкт.
IDEMPOTENCY_KEY_REQUIRED422Для виконання запису не передано Idempotency-Key.Створити ключ для цієї бізнес-операції та повторити.
IDEMPOTENCY_RESULT_UNKNOWN409Результат попередньої спроби невідомий; gateway не виконав запис повторно.Звірити документ, чек або платіж; не створювати новий ключ автоматично.
category.renameПерейменовує категорію товарів і зберігає її параметри. запис catalog.write з 0.4.0

Перейменовує категорію товарів і зберігає її параметри.

Перевірити JSON JSON Schema
Стабільність: стабільний Scope: catalog.write Idempotency-Key: потрібен

Параметри params

ПолеЩо означаєТип і форматПравила
Основні
nameНазва

Поле «Назва» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.

string
обов’язковийПриклад: "Тестовий товар"
uinІдентифікатор запису

Внутрішній числовий ідентифікатор запису, отриманий методом читання відповідного довідника.

int
обов’язковийПриклад: 1
Додаткові
uktzedКод УКТ ЗЕД

Поле «Код УКТ ЗЕД» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.

string
необов’язковийПриклад: ""За замовчуванням: ""
nocloudНе публікувати у хмарі

Визначає, чи застосовувати параметр «Не публікувати у хмарі». Передавайте JSON true або false.

bool
необов’язковийПриклад: falseЗа замовчуванням: false
nominusЗаборонити від’ємний залишок

Визначає, чи застосовувати параметр «Заборонити від’ємний залишок». Передавайте JSON true або false.

bool
необов’язковийПриклад: falseЗа замовчуванням: false
Суми та кількості
upercНацінка категорії

Точне числове значення «Націнка категорії» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається.

decimal · decimal-string · percent
необов’язковийПриклад: "100.00"За замовчуванням: "0"
k_discКоефіцієнт знижки

Точне числове значення «Коефіцієнт знижки» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається.

decimal · decimal-string · currency-of-operation
необов’язковийПриклад: "100.00"За замовчуванням: "0"
k_bonusКоефіцієнт бонусів

Точне числове значення «Коефіцієнт бонусів» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається.

decimal · decimal-string · currency-of-operation
необов’язковийПриклад: "100.00"За замовчуванням: "0"
Точна схема параметрів
{
    "name": {
        "type": "string",
        "required": true,
        "max": 512,
        "pattern": "/^[^\\x00-\\x1F\\x7F]{3,512}$/uD",
        "title": "Назва",
        "description": "Поле «Назва» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Основні",
        "example": "Тестовий товар"
    },
    "uin": {
        "type": "int",
        "required": true,
        "min": 1,
        "max": 2147483647,
        "title": "Ідентифікатор запису",
        "description": "Внутрішній числовий ідентифікатор запису, отриманий методом читання відповідного довідника.",
        "group": "Основні",
        "example": 1
    },
    "uktzed": {
        "type": "string",
        "max": 4096,
        "default": "",
        "title": "Код УКТ ЗЕД",
        "description": "Поле «Код УКТ ЗЕД» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": ""
    },
    "uperc": {
        "type": "decimal",
        "max": 32,
        "scale": 8,
        "default": "0",
        "title": "Націнка категорії",
        "description": "Точне числове значення «Націнка категорії» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається.",
        "group": "Суми та кількості",
        "format": "decimal-string",
        "unit": "percent",
        "example": "100.00"
    },
    "nocloud": {
        "type": "bool",
        "default": false,
        "title": "Не публікувати у хмарі",
        "description": "Визначає, чи застосовувати параметр «Не публікувати у хмарі». Передавайте JSON true або false.",
        "group": "Додаткові",
        "example": false
    },
    "nominus": {
        "type": "bool",
        "default": false,
        "title": "Заборонити від’ємний залишок",
        "description": "Визначає, чи застосовувати параметр «Заборонити від’ємний залишок». Передавайте JSON true або false.",
        "group": "Додаткові",
        "example": false
    },
    "k_disc": {
        "type": "decimal",
        "max": 32,
        "scale": 8,
        "default": "0",
        "title": "Коефіцієнт знижки",
        "description": "Точне числове значення «Коефіцієнт знижки» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається.",
        "group": "Суми та кількості",
        "format": "decimal-string",
        "unit": "currency-of-operation",
        "example": "100.00"
    },
    "k_bonus": {
        "type": "decimal",
        "max": 32,
        "scale": 8,
        "default": "0",
        "title": "Коефіцієнт бонусів",
        "description": "Точне числове значення «Коефіцієнт бонусів» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається.",
        "group": "Суми та кількості",
        "format": "decimal-string",
        "unit": "currency-of-operation",
        "example": "100.00"
    }
}

Результат

Форма відповіді: status
ПолеЗмістТипПриклад
category_idІдентифікатор категоріїПовернене значення «Ідентифікатор категорії» відповідного запису, документа або підсумку ARM20.string"Приклад"
Точна схема результату
{
    "mode": "status",
    "fields": [
        "category_id"
    ],
    "field_specs": {
        "category_id": {
            "title": "Ідентифікатор категорії",
            "description": "Повернене значення «Ідентифікатор категорії» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        }
    }
}

Приклад запиту

POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
Idempotency-Key: example-category-rename-0001

{
    "method": "category.rename",
    "params": {
        "name": "Тестовий товар",
        "uin": 1
    },
    "id": "example-category-rename"
}

Замініть демонстраційні значення даними зі своєї бази.

Приклад успішної відповіді

{
    "ok": true,
    "data": {
        "method": "category.rename",
        "result": {
            "upstream": {
                "name": "UPMAPI",
                "version": "1",
                "resource": "category"
            },
            "status": {
                "code": "OK",
                "operation": "rename",
                "category_id": "Приклад"
            },
            "rows": []
        },
        "id": "example-category-rename"
    },
    "request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
КодHTTPПричинаДія клієнта
INVALID_PARAMETER422Один із параметрів має неправильний тип, формат або значення.Виправити запит; автоматично не повторювати.
UPSTREAM_FAILURE502Сервер бізнес-операції недоступний або відхилив безпечний контракт.Не створювати новий Idempotency-Key; перевірити журнал і бізнес-об’єкт.
IDEMPOTENCY_KEY_REQUIRED422Для виконання запису не передано Idempotency-Key.Створити ключ для цієї бізнес-операції та повторити.
IDEMPOTENCY_RESULT_UNKNOWN409Результат попередньої спроби невідомий; gateway не виконав запис повторно.Звірити документ, чек або платіж; не створювати новий ключ автоматично.
category.wizard_apply_treeЗастосовує дерево категорій, сформоване майстром початкового налаштування. запис catalog.write з 0.4.0

Застосовує дерево категорій, сформоване майстром початкового налаштування.

Перевірити JSON JSON Schema
Стабільність: стабільний Scope: catalog.write Idempotency-Key: потрібен

Параметри params

ПолеЩо означаєТип і форматПравила
Додаткові
replaceЗамінити наявні дані

Визначає, чи застосовувати параметр «Замінити наявні дані». Передавайте JSON true або false.

bool
необов’язковийПриклад: falseЗа замовчуванням: false
nodesNodes

Список «Nodes». Структуру одного елемента, обов’язкові поля та межі кількості наведено нижче.

array<object>
обов’язковийПриклад: []
Точна схема параметрів
{
    "replace": {
        "type": "bool",
        "default": false,
        "title": "Замінити наявні дані",
        "description": "Визначає, чи застосовувати параметр «Замінити наявні дані». Передавайте JSON true або false.",
        "group": "Додаткові",
        "example": false
    },
    "nodes": {
        "type": "array",
        "required": true,
        "min_items": 1,
        "max_items": 300,
        "items": {
            "type": "object",
            "fields": {
                "depth": {
                    "type": "int",
                    "required": true,
                    "min": 0,
                    "max": 32,
                    "title": "Глибина вузла",
                    "description": "Поле «Глибина вузла» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
                    "group": "Додаткові",
                    "example": 1
                },
                "name": {
                    "type": "string",
                    "required": true,
                    "max": 512,
                    "pattern": "/^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]{3,512}$/uD",
                    "title": "Назва",
                    "description": "Поле «Назва» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
                    "group": "Основні",
                    "example": "Тестовий товар"
                }
            }
        },
        "title": "Nodes",
        "description": "Список «Nodes». Структуру одного елемента, обов’язкові поля та межі кількості наведено нижче.",
        "group": "Додаткові",
        "example": []
    }
}

Результат

Форма відповіді: status
ПолеЗмістТипПриклад
insertedInsertedПовернене значення «Inserted» відповідного запису, документа або підсумку ARM20.string"Приклад"
Точна схема результату
{
    "mode": "status",
    "fields": [
        "inserted"
    ],
    "field_specs": {
        "inserted": {
            "title": "Inserted",
            "description": "Повернене значення «Inserted» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        }
    }
}

Приклад запиту

POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
Idempotency-Key: example-category-wizard-apply-tree-0001

{
    "method": "category.wizard_apply_tree",
    "params": {
        "replace": false,
        "nodes": [
            {
                "depth": 0,
                "name": "Напої"
            },
            {
                "depth": 1,
                "name": "Вода"
            }
        ]
    },
    "id": "example-category-wizard-apply-tree"
}

Замініть демонстраційні значення даними зі своєї бази.

Приклад успішної відповіді

{
    "ok": true,
    "data": {
        "method": "category.wizard_apply_tree",
        "result": {
            "upstream": {
                "name": "UPMAPI",
                "version": "1",
                "resource": "category"
            },
            "status": {
                "code": "OK",
                "operation": "wizard_apply_tree",
                "inserted": "Приклад"
            },
            "rows": []
        },
        "id": "example-category-wizard-apply-tree"
    },
    "request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
КодHTTPПричинаДія клієнта
INVALID_PARAMETER422Один із параметрів має неправильний тип, формат або значення.Виправити запит; автоматично не повторювати.
UPSTREAM_FAILURE502Сервер бізнес-операції недоступний або відхилив безпечний контракт.Не створювати новий Idempotency-Key; перевірити журнал і бізнес-об’єкт.
IDEMPOTENCY_KEY_REQUIRED422Для виконання запису не передано Idempotency-Key.Створити ключ для цієї бізнес-операції та повторити.
IDEMPOTENCY_RESULT_UNKNOWN409Результат попередньої спроби невідомий; gateway не виконав запис повторно.Звірити документ, чек або платіж; не створювати новий ключ автоматично.
references

Переклади та колонки

2 методів
references.translate_kupmПовертає переклади елементів інтерфейсу програми. читання references.read з 0.4.0

Повертає переклади елементів інтерфейсу програми.

Перевірити JSON JSON Schema
Стабільність: стабільний Scope: references.read Idempotency-Key: не потрібен

Параметри params

Параметри не потрібні. Передайте порожній об’єкт {}.
Точна схема параметрів
{}

Результат

Форма відповіді: rows
ПолеЗмістТипПриклад
fieldПолеПовернене значення «Поле» відповідного запису, документа або підсумку ARM20.string"Приклад"
russianRussianПовернене значення «Russian» відповідного запису, документа або підсумку ARM20.string"Приклад"
ukrainianUkrainianПовернене значення «Ukrainian» відповідного запису, документа або підсумку ARM20.string"Приклад"
Точна схема результату
{
    "mode": "rows",
    "columns": [
        "field",
        "russian",
        "ukrainian"
    ],
    "field_specs": {
        "field": {
            "title": "Поле",
            "description": "Повернене значення «Поле» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        },
        "russian": {
            "title": "Russian",
            "description": "Повернене значення «Russian» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        },
        "ukrainian": {
            "title": "Ukrainian",
            "description": "Повернене значення «Ukrainian» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        }
    }
}

Приклад запиту

POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json

{
    "method": "references.translate_kupm",
    "params": [],
    "id": "example-references-translate-kupm"
}

Замініть демонстраційні значення даними зі своєї бази.

Приклад успішної відповіді

{
    "ok": true,
    "data": {
        "method": "references.translate_kupm",
        "result": {
            "upstream": {
                "name": "UPMAPI",
                "version": "1",
                "resource": "references"
            },
            "status": {
                "code": "OK",
                "operation": "translate_kupm",
                "value": "1"
            },
            "rows": [
                {
                    "field": "Приклад",
                    "russian": "Приклад",
                    "ukrainian": "Приклад"
                }
            ]
        },
        "id": "example-references-translate-kupm"
    },
    "request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
КодHTTPПричинаДія клієнта
INVALID_PARAMETER422Один із параметрів має неправильний тип, формат або значення.Виправити запит; автоматично не повторювати.
UPSTREAM_FAILURE502Сервер бізнес-операції недоступний або відхилив безпечний контракт.Дозволений повтор із backoff.
references.translate_zapПовертає підписи, ширини та вирівнювання колонок. читання references.read з 0.4.0

Повертає підписи, ширини та вирівнювання колонок.

Перевірити JSON JSON Schema
Стабільність: стабільний Scope: references.read Idempotency-Key: не потрібен

Параметри params

ПолеЩо означаєТип і форматПравила
Додаткові
langМова

Варіант «Мова». Використовуйте лише одне зі значень, розшифрованих нижче.

  • ru — російська
  • ua — українська
enum
необов’язковийПриклад: "ru"За замовчуванням: "ru"
Точна схема параметрів
{
    "lang": {
        "type": "enum",
        "values": [
            "ru",
            "ua"
        ],
        "default": "ru",
        "title": "Мова",
        "description": "Варіант «Мова». Використовуйте лише одне зі значень, розшифрованих нижче.",
        "group": "Додаткові",
        "example": "ru",
        "enum_labels": {
            "ru": "російська",
            "ua": "українська"
        }
    }
}

Результат

Форма відповіді: rows
ПолеЗмістТипПриклад
fieldПолеПовернене значення «Поле» відповідного запису, документа або підсумку ARM20.string"Приклад"
captionCaptionПовернене значення «Caption» відповідного запису, документа або підсумку ARM20.string"Приклад"
widthШирина колонкиПовернене значення «Ширина колонки» відповідного запису, документа або підсумку ARM20.string"Приклад"
alignAlignПовернене значення «Align» відповідного запису, документа або підсумку ARM20.string"Приклад"
Точна схема результату
{
    "mode": "rows",
    "columns": [
        "field",
        "caption",
        "width",
        "align"
    ],
    "field_specs": {
        "field": {
            "title": "Поле",
            "description": "Повернене значення «Поле» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        },
        "caption": {
            "title": "Caption",
            "description": "Повернене значення «Caption» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        },
        "width": {
            "title": "Ширина колонки",
            "description": "Повернене значення «Ширина колонки» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        },
        "align": {
            "title": "Align",
            "description": "Повернене значення «Align» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        }
    }
}

Приклад запиту

POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json

{
    "method": "references.translate_zap",
    "params": {
        "lang": "ua"
    },
    "id": "example-references-translate-zap"
}

Замініть демонстраційні значення даними зі своєї бази.

Приклад успішної відповіді

{
    "ok": true,
    "data": {
        "method": "references.translate_zap",
        "result": {
            "upstream": {
                "name": "UPMAPI",
                "version": "1",
                "resource": "references"
            },
            "status": {
                "code": "OK",
                "operation": "translate_zap",
                "value": "1"
            },
            "rows": [
                {
                    "field": "Приклад",
                    "caption": "Приклад",
                    "width": "Приклад",
                    "align": "Приклад"
                }
            ]
        },
        "id": "example-references-translate-zap"
    },
    "request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
КодHTTPПричинаДія клієнта
INVALID_PARAMETER422Один із параметрів має неправильний тип, формат або значення.Виправити запит; автоматично не повторювати.
UPSTREAM_FAILURE502Сервер бізнес-операції недоступний або відхилив безпечний контракт.Дозволений повтор із backoff.
settings

Користувацькі налаштування

4 методів
settings.delete_tpВидаляє торгову точку з користувацьких налаштувань. запис settings.write з 0.4.0

Видаляє торгову точку з користувацьких налаштувань.

Перевірити JSON JSON Schema
Стабільність: стабільний Scope: settings.write Idempotency-Key: потрібен

Параметри params

ПолеЩо означаєТип і форматПравила
Додаткові
indІдентифікатор рядка

Ідентифікатор «Ідентифікатор рядка», отриманий із результату відповідного методу читання цієї бази.

int
необов’язковийПриклад: 1За замовчуванням: 0
Точна схема параметрів
{
    "ind": {
        "type": "int",
        "min": -2147483648,
        "max": 2147483647,
        "default": 0,
        "title": "Ідентифікатор рядка",
        "description": "Ідентифікатор «Ідентифікатор рядка», отриманий із результату відповідного методу читання цієї бази.",
        "group": "Додаткові",
        "example": 1
    }
}

Результат

Форма відповіді: status
ПолеЗмістТипПриклад
affectedЗмінено записівКількість записів, які upstream фактично змінив.string"Приклад"
Точна схема результату
{
    "mode": "status",
    "fields": [
        "affected"
    ],
    "field_specs": {
        "affected": {
            "title": "Змінено записів",
            "description": "Кількість записів, які upstream фактично змінив.",
            "type": "string",
            "example": "Приклад"
        }
    }
}

Приклад запиту

POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
Idempotency-Key: example-settings-delete-tp-0001

{
    "method": "settings.delete_tp",
    "params": {
        "ind": 1
    },
    "id": "example-settings-delete-tp"
}

Замініть демонстраційні значення даними зі своєї бази.

Приклад успішної відповіді

{
    "ok": true,
    "data": {
        "method": "settings.delete_tp",
        "result": {
            "upstream": {
                "name": "UPMAPI",
                "version": "1",
                "resource": "settings"
            },
            "status": {
                "code": "OK",
                "operation": "delete_tp",
                "affected": "Приклад"
            },
            "rows": []
        },
        "id": "example-settings-delete-tp"
    },
    "request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
КодHTTPПричинаДія клієнта
INVALID_PARAMETER422Один із параметрів має неправильний тип, формат або значення.Виправити запит; автоматично не повторювати.
UPSTREAM_FAILURE502Сервер бізнес-операції недоступний або відхилив безпечний контракт.Не створювати новий Idempotency-Key; перевірити журнал і бізнес-об’єкт.
IDEMPOTENCY_KEY_REQUIRED422Для виконання запису не передано Idempotency-Key.Створити ключ для цієї бізнес-операції та повторити.
IDEMPOTENCY_RESULT_UNKNOWN409Результат попередньої спроби невідомий; gateway не виконав запис повторно.Звірити документ, чек або платіж; не створювати новий ключ автоматично.
settings.init_user_tpСтворює початкові налаштування торгової точки для користувача. запис settings.write з 0.4.0

Створює початкові налаштування торгової точки для користувача.

Перевірити JSON JSON Schema
Стабільність: стабільний Scope: settings.write Idempotency-Key: потрібен

Параметри params

ПолеЩо означаєТип і форматПравила
Додаткові
target_user_idЦільовий користувач

Ідентифікатор «Цільовий користувач», отриманий із результату відповідного методу читання цієї бази.

int
обов’язковийПриклад: 1
Точна схема параметрів
{
    "target_user_id": {
        "type": "int",
        "required": true,
        "min": 1,
        "max": 2147483647,
        "title": "Цільовий користувач",
        "description": "Ідентифікатор «Цільовий користувач», отриманий із результату відповідного методу читання цієї бази.",
        "group": "Додаткові",
        "example": 1
    }
}

Результат

Форма відповіді: status
ПолеЗмістТипПриклад
affectedЗмінено записівКількість записів, які upstream фактично змінив.string"Приклад"
Точна схема результату
{
    "mode": "status",
    "fields": [
        "affected"
    ],
    "field_specs": {
        "affected": {
            "title": "Змінено записів",
            "description": "Кількість записів, які upstream фактично змінив.",
            "type": "string",
            "example": "Приклад"
        }
    }
}

Приклад запиту

POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
Idempotency-Key: example-settings-init-user-tp-0001

{
    "method": "settings.init_user_tp",
    "params": {
        "target_user_id": 7
    },
    "id": "example-settings-init-user-tp"
}

Замініть демонстраційні значення даними зі своєї бази.

Приклад успішної відповіді

{
    "ok": true,
    "data": {
        "method": "settings.init_user_tp",
        "result": {
            "upstream": {
                "name": "UPMAPI",
                "version": "1",
                "resource": "settings"
            },
            "status": {
                "code": "OK",
                "operation": "init_user_tp",
                "affected": "Приклад"
            },
            "rows": []
        },
        "id": "example-settings-init-user-tp"
    },
    "request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
КодHTTPПричинаДія клієнта
INVALID_PARAMETER422Один із параметрів має неправильний тип, формат або значення.Виправити запит; автоматично не повторювати.
UPSTREAM_FAILURE502Сервер бізнес-операції недоступний або відхилив безпечний контракт.Не створювати новий Idempotency-Key; перевірити журнал і бізнес-об’єкт.
IDEMPOTENCY_KEY_REQUIRED422Для виконання запису не передано Idempotency-Key.Створити ключ для цієї бізнес-операції та повторити.
IDEMPOTENCY_RESULT_UNKNOWN409Результат попередньої спроби невідомий; gateway не виконав запис повторно.Звірити документ, чек або платіж; не створювати новий ключ автоматично.
settings.save_tpЗберігає налаштування торгової точки користувача. запис settings.write з 0.4.0

Зберігає налаштування торгової точки користувача.

Перевірити JSON JSON Schema
Стабільність: стабільний Scope: settings.write Idempotency-Key: потрібен

Параметри params

ПолеЩо означаєТип і форматПравила
Додаткові
dopinfДодаткова інформація

Поле «Додаткова інформація» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.

string
необов’язковийПриклад: ""За замовчуванням: ""
indІдентифікатор рядка

Ідентифікатор «Ідентифікатор рядка», отриманий із результату відповідного методу читання цієї бази.

int
обов’язковийПриклад: 1
Основні
modeРежим операції

Вибирає один із підтримуваних сценаріїв операції. Значення та їх зміст наведено у списку варіантів.

  • edit — редагувати наявний запис
enum
необов’язковийПриклад: "edit"За замовчуванням: "edit"
ntІм’я користувача

Поле «Ім’я користувача» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.

string
необов’язковийПриклад: "Тестовий товар"За замовчуванням: ""
Точна схема параметрів
{
    "dopinf": {
        "type": "string",
        "max": 4096,
        "default": "",
        "title": "Додаткова інформація",
        "description": "Поле «Додаткова інформація» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": ""
    },
    "ind": {
        "type": "int",
        "required": true,
        "min": 1,
        "max": 2147483647,
        "title": "Ідентифікатор рядка",
        "description": "Ідентифікатор «Ідентифікатор рядка», отриманий із результату відповідного методу читання цієї бази.",
        "group": "Додаткові",
        "example": 1
    },
    "mode": {
        "type": "enum",
        "values": [
            "edit"
        ],
        "default": "edit",
        "title": "Режим операції",
        "description": "Вибирає один із підтримуваних сценаріїв операції. Значення та їх зміст наведено у списку варіантів.",
        "group": "Основні",
        "example": "edit",
        "enum_labels": {
            "edit": "редагувати наявний запис"
        }
    },
    "nt": {
        "type": "string",
        "max": 512,
        "default": "",
        "title": "Ім’я користувача",
        "description": "Поле «Ім’я користувача» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Основні",
        "example": "Тестовий товар"
    }
}

Результат

Форма відповіді: status
ПолеЗмістТипПриклад
modeРежим операціїПовернене значення «Режим операції» відповідного запису, документа або підсумку ARM20.string"Приклад"
affectedЗмінено записівКількість записів, які upstream фактично змінив.string"Приклад"
Точна схема результату
{
    "mode": "status",
    "fields": [
        "mode",
        "affected"
    ],
    "field_specs": {
        "mode": {
            "title": "Режим операції",
            "description": "Повернене значення «Режим операції» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        },
        "affected": {
            "title": "Змінено записів",
            "description": "Кількість записів, які upstream фактично змінив.",
            "type": "string",
            "example": "Приклад"
        }
    }
}

Приклад запиту

POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
Idempotency-Key: example-settings-save-tp-0001

{
    "method": "settings.save_tp",
    "params": {
        "ind": 1
    },
    "id": "example-settings-save-tp"
}

Замініть демонстраційні значення даними зі своєї бази.

Приклад успішної відповіді

{
    "ok": true,
    "data": {
        "method": "settings.save_tp",
        "result": {
            "upstream": {
                "name": "UPMAPI",
                "version": "1",
                "resource": "settings"
            },
            "status": {
                "code": "OK",
                "operation": "save_tp",
                "mode": "Приклад",
                "affected": "Приклад"
            },
            "rows": []
        },
        "id": "example-settings-save-tp"
    },
    "request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
КодHTTPПричинаДія клієнта
INVALID_PARAMETER422Один із параметрів має неправильний тип, формат або значення.Виправити запит; автоматично не повторювати.
UPSTREAM_FAILURE502Сервер бізнес-операції недоступний або відхилив безпечний контракт.Не створювати новий Idempotency-Key; перевірити журнал і бізнес-об’єкт.
IDEMPOTENCY_KEY_REQUIRED422Для виконання запису не передано Idempotency-Key.Створити ключ для цієї бізнес-операції та повторити.
IDEMPOTENCY_RESULT_UNKNOWN409Результат попередньої спроби невідомий; gateway не виконав запис повторно.Звірити документ, чек або платіж; не створювати новий ключ автоматично.
settings.save_user_identityЗберігає ім’я та ідентифікатор поточного користувача. запис settings.write з 0.4.0

Зберігає ім’я та ідентифікатор поточного користувача.

Перевірити JSON JSON Schema
Стабільність: стабільний Scope: settings.write Idempotency-Key: потрібен

Параметри params

ПолеЩо означаєТип і форматПравила
Додаткові
cardНомер дисконтної картки

Поле «Номер дисконтної картки» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.

string
обов’язковийПриклад: "990000001"
target_user_idЦільовий користувач

Ідентифікатор «Цільовий користувач», отриманий із результату відповідного методу читання цієї бази.

int
обов’язковийПриклад: 1
typexТип запису

Поле «Тип запису» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.

string
необов’язковийПриклад: ""За замовчуванням: ""
Основні
ntІм’я користувача

Поле «Ім’я користувача» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.

string
обов’язковийПриклад: "Тестовий товар"
Точна схема параметрів
{
    "card": {
        "type": "string",
        "max": 512,
        "required": true,
        "title": "Номер дисконтної картки",
        "description": "Поле «Номер дисконтної картки» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": "990000001"
    },
    "nt": {
        "type": "string",
        "max": 512,
        "required": true,
        "title": "Ім’я користувача",
        "description": "Поле «Ім’я користувача» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Основні",
        "example": "Тестовий товар"
    },
    "target_user_id": {
        "type": "int",
        "required": true,
        "min": 1,
        "max": 2147483647,
        "title": "Цільовий користувач",
        "description": "Ідентифікатор «Цільовий користувач», отриманий із результату відповідного методу читання цієї бази.",
        "group": "Додаткові",
        "example": 1
    },
    "typex": {
        "type": "string",
        "max": 512,
        "default": "",
        "title": "Тип запису",
        "description": "Поле «Тип запису» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": ""
    }
}

Результат

Форма відповіді: status
ПолеЗмістТипПриклад
affectedЗмінено записівКількість записів, які upstream фактично змінив.string"Приклад"
Точна схема результату
{
    "mode": "status",
    "fields": [
        "affected"
    ],
    "field_specs": {
        "affected": {
            "title": "Змінено записів",
            "description": "Кількість записів, які upstream фактично змінив.",
            "type": "string",
            "example": "Приклад"
        }
    }
}

Приклад запиту

POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
Idempotency-Key: example-settings-save-user-identity-0001

{
    "method": "settings.save_user_identity",
    "params": {
        "card": "990000001",
        "nt": "Тестовий товар",
        "target_user_id": 7
    },
    "id": "example-settings-save-user-identity"
}

Замініть демонстраційні значення даними зі своєї бази.

Приклад успішної відповіді

{
    "ok": true,
    "data": {
        "method": "settings.save_user_identity",
        "result": {
            "upstream": {
                "name": "UPMAPI",
                "version": "1",
                "resource": "settings"
            },
            "status": {
                "code": "OK",
                "operation": "save_user_identity",
                "affected": "Приклад"
            },
            "rows": []
        },
        "id": "example-settings-save-user-identity"
    },
    "request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
КодHTTPПричинаДія клієнта
INVALID_PARAMETER422Один із параметрів має неправильний тип, формат або значення.Виправити запит; автоматично не повторювати.
UPSTREAM_FAILURE502Сервер бізнес-операції недоступний або відхилив безпечний контракт.Не створювати новий Idempotency-Key; перевірити журнал і бізнес-об’єкт.
IDEMPOTENCY_KEY_REQUIRED422Для виконання запису не передано Idempotency-Key.Створити ключ для цієї бізнес-операції та повторити.
IDEMPOTENCY_RESULT_UNKNOWN409Результат попередньої спроби невідомий; gateway не виконав запис повторно.Звірити документ, чек або платіж; не створювати новий ключ автоматично.