Бізнес-блок

Товари, коди та залишки

Картки товарів, ціни, штрихкоди, аналоги, склад, FIFO, зображення та масова обробка.

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

Перевірки

6 методів
checks.branch_product_existsПеревіряє, чи є товар у вибраній філії. читання inventory.read з 0.4.0

Перевіряє, чи є товар у вибраній філії.

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

Параметри params

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

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

string
обов’язковийПриклад: "1001"
Додаткові
branch_idІдентифікатор філії

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

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

Результат

Форма відповіді: scalar
ПолеЗмістТипПриклад
valueЗначенняПовернене значення «Значення» відповідного запису, документа або підсумку ARM20.string"Приклад"
Точна схема результату 
{
    "mode": "scalar",
    "value_type": "string",
    "value_spec": {
        "title": "Значення",
        "description": "Повернене значення «Значення» відповідного запису, документа або підсумку ARM20.",
        "type": "string",
        "example": "Приклад"
    }
}

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

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

{
    "method": "checks.branch_product_exists",
    "params": {
        "code": "1001",
        "branch_id": 1
    },
    "id": "example-checks-branch-product-exists"
}

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

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

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

Повертає поточний залишок вибраної каси.

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

Параметри params

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

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

string
обов’язковийПриклад: "Приклад"
Точна схема параметрів 
{
    "kas": {
        "type": "string",
        "required": true,
        "max": 190,
        "title": "Касовий рахунок",
        "description": "Поле «Касовий рахунок» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": "Приклад"
    }
}

Результат

Форма відповіді: scalar
ПолеЗмістТипПриклад
valueЗначенняПовернене значення «Значення» відповідного запису, документа або підсумку ARM20.string"Приклад"
Точна схема результату 
{
    "mode": "scalar",
    "value_type": "string",
    "value_spec": {
        "title": "Значення",
        "description": "Повернене значення «Значення» відповідного запису, документа або підсумку ARM20.",
        "type": "string",
        "example": "Приклад"
    }
}

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

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

{
    "method": "checks.cash_balance",
    "params": {
        "kas": "Касове місце N1"
    },
    "id": "example-checks-cash-balance"
}

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

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

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

Повертає поточний борг за дисконтною карткою.

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

Параметри params

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

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

string
обов’язковийПриклад: "1001"
Точна схема параметрів 
{
    "code": {
        "type": "string",
        "required": true,
        "max": 128,
        "title": "Номер дисконтної картки",
        "description": "Публічний код товару, картки або іншого запису, як він відображається у програмі.",
        "group": "Основні",
        "example": "1001"
    }
}

Результат

Форма відповіді: scalar
ПолеЗмістТипПриклад
valueЗначенняПовернене значення «Значення» відповідного запису, документа або підсумку ARM20.string"Приклад"
Точна схема результату 
{
    "mode": "scalar",
    "value_type": "string",
    "value_spec": {
        "title": "Значення",
        "description": "Повернене значення «Значення» відповідного запису, документа або підсумку ARM20.",
        "type": "string",
        "example": "Приклад"
    }
}

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

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

{
    "method": "checks.discount_debt",
    "params": {
        "code": "1001"
    },
    "id": "example-checks-discount-debt"
}

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

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

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

Повертає фіскальний оборот за поточний календарний рік.

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

Параметри params

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

Результат

Форма відповіді: scalar
ПолеЗмістТипПриклад
valueЗначенняПовернене значення «Значення» відповідного запису, документа або підсумку ARM20.string"Приклад"
Точна схема результату 
{
    "mode": "scalar",
    "value_type": "string",
    "value_spec": {
        "title": "Значення",
        "description": "Повернене значення «Значення» відповідного запису, документа або підсумку ARM20.",
        "type": "string",
        "example": "Приклад"
    }
}

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

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

{
    "method": "checks.fop_year_turnover",
    "params": [],
    "id": "example-checks-fop-year-turnover"
}

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

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

{
    "ok": true,
    "data": {
        "method": "checks.fop_year_turnover",
        "result": {
            "upstream": {
                "name": "UPMAPI",
                "version": "1",
                "resource": "checks"
            },
            "status": {
                "code": "OK",
                "operation": "fop_year_turnover",
                "value": "Приклад"
            },
            "rows": []
        },
        "id": "example-checks-fop-year-turnover"
    },
    "request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
КодHTTPПричинаДія клієнта
INVALID_PARAMETER422Один із параметрів має неправильний тип, формат або значення.Виправити запит; автоматично не повторювати.
UPSTREAM_FAILURE502Сервер бізнес-операції недоступний або відхилив безпечний контракт.Дозволений повтор із backoff.
checks.menu_countПовертає кількість товарів, доступних у меню кафе. читання catalog.lookup з 0.4.0

Повертає кількість товарів, доступних у меню кафе.

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

Параметри params

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

Результат

Форма відповіді: scalar
ПолеЗмістТипПриклад
valueЗначенняПовернене значення «Значення» відповідного запису, документа або підсумку ARM20.string"Приклад"
Точна схема результату 
{
    "mode": "scalar",
    "value_type": "string",
    "value_spec": {
        "title": "Значення",
        "description": "Повернене значення «Значення» відповідного запису, документа або підсумку ARM20.",
        "type": "string",
        "example": "Приклад"
    }
}

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

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

{
    "method": "checks.menu_count",
    "params": [],
    "id": "example-checks-menu-count"
}

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

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

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

Перевіряє, чи є товар в основному складі.

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

Параметри params

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

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

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

Результат

Форма відповіді: scalar
ПолеЗмістТипПриклад
valueЗначенняПовернене значення «Значення» відповідного запису, документа або підсумку ARM20.string"Приклад"
Точна схема результату 
{
    "mode": "scalar",
    "value_type": "string",
    "value_spec": {
        "title": "Значення",
        "description": "Повернене значення «Значення» відповідного запису, документа або підсумку ARM20.",
        "type": "string",
        "example": "Приклад"
    }
}

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

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

{
    "method": "checks.product_exists",
    "params": {
        "code": "1001"
    },
    "id": "example-checks-product-exists"
}

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

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

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

Генератори кодів

3 методів
generators.make_artЗнаходить наступний вільний тризначний артикул. читання catalog.details.read з 0.4.0

Знаходить наступний вільний тризначний артикул.

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

Параметри params

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

Результат

Форма відповіді: scalar
ПолеЗмістТипПриклад
valueЗначенняПовернене значення «Значення» відповідного запису, документа або підсумку ARM20.string"Приклад"
Точна схема результату 
{
    "mode": "scalar",
    "value_type": "string",
    "value_spec": {
        "title": "Значення",
        "description": "Повернене значення «Значення» відповідного запису, документа або підсумку ARM20.",
        "type": "string",
        "example": "Приклад"
    }
}

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

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

{
    "method": "generators.make_art",
    "params": [],
    "id": "example-generators-make-art"
}

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

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

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

Пов’язані методи

generators.make_ownФормує наступний вільний внутрішній код EAN-13 для заданого префікса. читання catalog.details.read з 0.4.0

Формує наступний вільний внутрішній код EAN-13 для заданого префікса.

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

Параметри params

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

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

string
обов’язковийПриклад: "Приклад"
Точна схема параметрів 
{
    "pref": {
        "type": "string",
        "required": true,
        "max": 3,
        "pattern": "/^[0-9]{1,3}$/",
        "title": "Префікс коду",
        "description": "Поле «Префікс коду» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": "Приклад"
    }
}

Результат

Форма відповіді: scalar
ПолеЗмістТипПриклад
valueЗначенняПовернене значення «Значення» відповідного запису, документа або підсумку ARM20.string"Приклад"
Точна схема результату 
{
    "mode": "scalar",
    "value_type": "string",
    "value_spec": {
        "title": "Значення",
        "description": "Повернене значення «Значення» відповідного запису, документа або підсумку ARM20.",
        "type": "string",
        "example": "Приклад"
    }
}

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

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

{
    "method": "generators.make_own",
    "params": {
        "pref": "21"
    },
    "id": "example-generators-make-own"
}

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

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

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

Пов’язані методи

generators.make_weightЗнаходить наступний вільний чотиризначний ваговий код. читання catalog.details.read з 0.4.0

Знаходить наступний вільний чотиризначний ваговий код.

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

Параметри params

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

Результат

Форма відповіді: scalar
ПолеЗмістТипПриклад
valueЗначенняПовернене значення «Значення» відповідного запису, документа або підсумку ARM20.string"Приклад"
Точна схема результату 
{
    "mode": "scalar",
    "value_type": "string",
    "value_spec": {
        "title": "Значення",
        "description": "Повернене значення «Значення» відповідного запису, документа або підсумку ARM20.",
        "type": "string",
        "example": "Приклад"
    }
}

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

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

{
    "method": "generators.make_weight",
    "params": [],
    "id": "example-generators-make-weight"
}

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

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

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

Пов’язані методи

goods

Картки товарів і залишки

38 методів
goods.add_analogДодає товар до списку аналогів іншого товару. запис catalog.write з 0.4.0

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

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

Параметри params

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

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

string
обов’язковийПриклад: "Приклад"
Основні
codeКод товару

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

string
обов’язковийПриклад: "1001"
Точна схема параметрів 
{
    "analog_code": {
        "type": "string",
        "max": 512,
        "required": true,
        "title": "Код аналога",
        "description": "Поле «Код аналога» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": "Приклад"
    },
    "code": {
        "type": "string",
        "max": 512,
        "required": true,
        "title": "Код товару",
        "description": "Публічний код товару, картки або іншого запису, як він відображається у програмі.",
        "group": "Основні",
        "example": "1001"
    }
}

Результат

Форма відповіді: 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-goods-add-analog-0001

{
    "method": "goods.add_analog",
    "params": {
        "analog_code": "Приклад",
        "code": "1001"
    },
    "id": "example-goods-add-analog"
}

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

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

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

Пов’язані методи

goods.add_extra_codeДодає товару додатковий штрихкод. запис catalog.write з 0.4.0

Додає товару додатковий штрихкод.

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

Параметри params

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

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

string
обов’язковийПриклад: "1001"
Додаткові
extra_codeДодатковий штрихкод

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

string
обов’язковийПриклад: "1001"
Точна схема параметрів 
{
    "code": {
        "type": "string",
        "max": 512,
        "required": true,
        "title": "Код товару",
        "description": "Публічний код товару, картки або іншого запису, як він відображається у програмі.",
        "group": "Основні",
        "example": "1001"
    },
    "extra_code": {
        "type": "string",
        "required": true,
        "max": 190,
        "pattern": "/^[0-9]+$/D",
        "title": "Додатковий штрихкод",
        "description": "Поле «Додатковий штрихкод» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": "1001"
    }
}

Результат

Форма відповіді: 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-goods-add-extra-code-0001

{
    "method": "goods.add_extra_code",
    "params": {
        "code": "1001",
        "extra_code": "1001"
    },
    "id": "example-goods-add-extra-code"
}

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

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

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

Пов’язані методи

goods.add_extra_nameСтворює нове додаткове поле для карток товарів. запис catalog.write з 0.4.0

Створює нове додаткове поле для карток товарів.

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

Параметри params

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

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

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

Результат

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

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

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

{
    "method": "goods.add_extra_name",
    "params": {
        "name": "Тестовий товар"
    },
    "id": "example-goods-add-extra-name"
}

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

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

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

Пов’язані методи

goods.analog_rowsПовертає список аналогів вибраного товару. читання catalog.details.read з 0.4.0

Повертає список аналогів вибраного товару.

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

Параметри params

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

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

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

Результат

Форма відповіді: rows
ПолеЗмістТипПриклад
codeКод товаруПовернене значення «Код товару» відповідного запису, документа або підсумку ARM20.string"1001"
nameНазваПовернене значення «Назва» відповідного запису, документа або підсумку ARM20.string"Тестовий товар"
costСобівартістьТочне повернене значення «Собівартість» як десятковий рядок із крапкою.string · decimal-string · currency-of-operation"100.00"
markupНацінкаТочне повернене значення «Націнка» як десятковий рядок із крапкою.string · decimal-string · percent"100.00"
priceЦінаТочне повернене значення «Ціна» як десятковий рядок із крапкою.string · decimal-string · currency-of-operation"100.00"
unit_typeОдиниця виміруПовернене значення «Одиниця виміру» відповідного запису, документа або підсумку ARM20.string"Приклад"
Точна схема результату 
{
    "mode": "rows",
    "columns": [
        "code",
        "name",
        "cost",
        "markup",
        "price",
        "unit_type"
    ],
    "field_specs": {
        "code": {
            "title": "Код товару",
            "description": "Повернене значення «Код товару» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "1001"
        },
        "name": {
            "title": "Назва",
            "description": "Повернене значення «Назва» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Тестовий товар"
        },
        "cost": {
            "title": "Собівартість",
            "description": "Точне повернене значення «Собівартість» як десятковий рядок із крапкою.",
            "type": "string",
            "format": "decimal-string",
            "unit": "currency-of-operation",
            "example": "100.00"
        },
        "markup": {
            "title": "Націнка",
            "description": "Точне повернене значення «Націнка» як десятковий рядок із крапкою.",
            "type": "string",
            "format": "decimal-string",
            "unit": "percent",
            "example": "100.00"
        },
        "price": {
            "title": "Ціна",
            "description": "Точне повернене значення «Ціна» як десятковий рядок із крапкою.",
            "type": "string",
            "format": "decimal-string",
            "unit": "currency-of-operation",
            "example": "100.00"
        },
        "unit_type": {
            "title": "Одиниця виміру",
            "description": "Повернене значення «Одиниця виміру» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        }
    }
}

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

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

{
    "method": "goods.analog_rows",
    "params": {
        "code": "1001"
    },
    "id": "example-goods-analog-rows"
}

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

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

{
    "ok": true,
    "data": {
        "method": "goods.analog_rows",
        "result": {
            "upstream": {
                "name": "UPMAPI",
                "version": "1",
                "resource": "goods"
            },
            "status": {
                "code": "OK",
                "operation": "analog_rows",
                "value": "1"
            },
            "rows": [
                {
                    "code": "1001",
                    "name": "Тестовий товар",
                    "cost": "100.00",
                    "markup": "100.00",
                    "price": "100.00",
                    "unit_type": "Приклад"
                }
            ]
        },
        "id": "example-goods-analog-rows"
    },
    "request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
КодHTTPПричинаДія клієнта
INVALID_PARAMETER422Один із параметрів має неправильний тип, формат або значення.Виправити запит; автоматично не повторювати.
UPSTREAM_FAILURE502Сервер бізнес-операції недоступний або відхилив безпечний контракт.Дозволений повтор із backoff.

Пов’язані методи

goods.card_descПовертає опис товару та налаштування кухонного принтера. читання catalog.details.read з 0.4.0

Повертає опис товару та налаштування кухонного принтера.

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

Параметри params

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

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

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

Результат

Форма відповіді: rows
ПолеЗмістТипПриклад
descriptionОписПовернене значення «Опис» відповідного запису, документа або підсумку ARM20.string"Приклад"
kitchen_printerKitchen printerПовернене значення «Kitchen printer» відповідного запису, документа або підсумку ARM20.string"Приклад"
Точна схема результату 
{
    "mode": "rows",
    "columns": [
        "description",
        "kitchen_printer"
    ],
    "field_specs": {
        "description": {
            "title": "Опис",
            "description": "Повернене значення «Опис» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        },
        "kitchen_printer": {
            "title": "Kitchen printer",
            "description": "Повернене значення «Kitchen printer» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        }
    }
}

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

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

{
    "method": "goods.card_desc",
    "params": {
        "code": "1001"
    },
    "id": "example-goods-card-desc"
}

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

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

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

Пов’язані методи

goods.card_mainПовертає основні реквізити, ціни та залишок із картки товару. читання inventory.cost.read з 0.4.0

Повертає основні реквізити, ціни та залишок із картки товару.

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

Параметри params

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

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

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

Результат

Форма відповіді: rows
ПолеЗмістТипПриклад
codeКод товаруПовернене значення «Код товару» відповідного запису, документа або підсумку ARM20.string"1001"
nameНазваПовернене значення «Назва» відповідного запису, документа або підсумку ARM20.string"Тестовий товар"
costСобівартістьТочне повернене значення «Собівартість» як десятковий рядок із крапкою.string · decimal-string · currency-of-operation"100.00"
markupНацінкаТочне повернене значення «Націнка» як десятковий рядок із крапкою.string · decimal-string · percent"100.00"
priceЦінаТочне повернене значення «Ціна» як десятковий рядок із крапкою.string · decimal-string · currency-of-operation"100.00"
unit_typeОдиниця виміруПовернене значення «Одиниця виміру» відповідного запису, документа або підсумку ARM20.string"Приклад"
quantityКількістьТочне повернене значення «Кількість» як десятковий рядок із крапкою.string · decimal-string · product-unit"1.000"
date_addedДата додаванняПовернена дата «Дата додавання» у форматі YYYY-MM-DD.string · date"2026-07-23"
no_discountЗаборонити знижкуПовернене значення «Заборонити знижку» відповідного запису, документа або підсумку ARM20.string"Приклад"
critical_quantityКритичний залишокТочне повернене значення «Критичний залишок» як десятковий рядок із крапкою.string · decimal-string · product-unit"100.00"
supplierПостачальникПовернене значення «Постачальник» відповідного запису, документа або підсумку ARM20.string"Приклад"
categoryКатегорія товаруПовернене значення «Категорія товару» відповідного запису, документа або підсумку ARM20.string"Приклад"
parent_categoryБатьківська категоріяПовернене значення «Батьківська категорія» відповідного запису, документа або підсумку ARM20.string"Приклад"
shelf_life_daysСтрок придатності, днівПовернене значення «Строк придатності, днів» відповідного запису, документа або підсумку ARM20.string"Приклад"
c2C2Повернене значення «C2» відповідного запису, документа або підсумку ARM20.string"Приклад"
additional_infoДодаткова інформаціяПовернене значення «Додаткова інформація» відповідного запису, документа або підсумку ARM20.string"Приклад"
in_cloudIn cloudПовернене значення «In cloud» відповідного запису, документа або підсумку ARM20.string"Приклад"
Точна схема результату 
{
    "mode": "rows",
    "columns": [
        "code",
        "name",
        "cost",
        "markup",
        "price",
        "unit_type",
        "quantity",
        "date_added",
        "no_discount",
        "critical_quantity",
        "supplier",
        "category",
        "parent_category",
        "shelf_life_days",
        "c2",
        "additional_info",
        "in_cloud"
    ],
    "field_specs": {
        "code": {
            "title": "Код товару",
            "description": "Повернене значення «Код товару» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "1001"
        },
        "name": {
            "title": "Назва",
            "description": "Повернене значення «Назва» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Тестовий товар"
        },
        "cost": {
            "title": "Собівартість",
            "description": "Точне повернене значення «Собівартість» як десятковий рядок із крапкою.",
            "type": "string",
            "format": "decimal-string",
            "unit": "currency-of-operation",
            "example": "100.00"
        },
        "markup": {
            "title": "Націнка",
            "description": "Точне повернене значення «Націнка» як десятковий рядок із крапкою.",
            "type": "string",
            "format": "decimal-string",
            "unit": "percent",
            "example": "100.00"
        },
        "price": {
            "title": "Ціна",
            "description": "Точне повернене значення «Ціна» як десятковий рядок із крапкою.",
            "type": "string",
            "format": "decimal-string",
            "unit": "currency-of-operation",
            "example": "100.00"
        },
        "unit_type": {
            "title": "Одиниця виміру",
            "description": "Повернене значення «Одиниця виміру» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        },
        "quantity": {
            "title": "Кількість",
            "description": "Точне повернене значення «Кількість» як десятковий рядок із крапкою.",
            "type": "string",
            "format": "decimal-string",
            "unit": "product-unit",
            "example": "1.000"
        },
        "date_added": {
            "title": "Дата додавання",
            "description": "Повернена дата «Дата додавання» у форматі YYYY-MM-DD.",
            "type": "string",
            "format": "date",
            "example": "2026-07-23"
        },
        "no_discount": {
            "title": "Заборонити знижку",
            "description": "Повернене значення «Заборонити знижку» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        },
        "critical_quantity": {
            "title": "Критичний залишок",
            "description": "Точне повернене значення «Критичний залишок» як десятковий рядок із крапкою.",
            "type": "string",
            "format": "decimal-string",
            "unit": "product-unit",
            "example": "100.00"
        },
        "supplier": {
            "title": "Постачальник",
            "description": "Повернене значення «Постачальник» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        },
        "category": {
            "title": "Категорія товару",
            "description": "Повернене значення «Категорія товару» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        },
        "parent_category": {
            "title": "Батьківська категорія",
            "description": "Повернене значення «Батьківська категорія» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        },
        "shelf_life_days": {
            "title": "Строк придатності, днів",
            "description": "Повернене значення «Строк придатності, днів» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        },
        "c2": {
            "title": "C2",
            "description": "Повернене значення «C2» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        },
        "additional_info": {
            "title": "Додаткова інформація",
            "description": "Повернене значення «Додаткова інформація» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        },
        "in_cloud": {
            "title": "In cloud",
            "description": "Повернене значення «In cloud» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        }
    }
}

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

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

{
    "method": "goods.card_main",
    "params": {
        "code": "1001"
    },
    "id": "example-goods-card-main"
}

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

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

{
    "ok": true,
    "data": {
        "method": "goods.card_main",
        "result": {
            "upstream": {
                "name": "UPMAPI",
                "version": "1",
                "resource": "goods"
            },
            "status": {
                "code": "OK",
                "operation": "card_main",
                "value": "1"
            },
            "rows": [
                {
                    "code": "1001",
                    "name": "Тестовий товар",
                    "cost": "100.00",
                    "markup": "100.00",
                    "price": "100.00",
                    "unit_type": "Приклад",
                    "quantity": "1.000",
                    "date_added": "2026-07-23",
                    "no_discount": "Приклад",
                    "critical_quantity": "100.00",
                    "supplier": "Приклад",
                    "category": "Приклад",
                    "parent_category": "Приклад",
                    "shelf_life_days": "Приклад",
                    "c2": "Приклад",
                    "additional_info": "Приклад",
                    "in_cloud": "Приклад"
                }
            ]
        },
        "id": "example-goods-card-main"
    },
    "request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
КодHTTPПричинаДія клієнта
INVALID_PARAMETER422Один із параметрів має неправильний тип, формат або значення.Виправити запит; автоматично не повторювати.
UPSTREAM_FAILURE502Сервер бізнес-операції недоступний або відхилив безпечний контракт.Дозволений повтор із backoff.

Пов’язані методи

goods.card_openПовертає повну картку товару одним запитом. читання inventory.cost.read з 0.4.0

Повертає повну картку товару одним запитом.

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

Параметри params

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

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

string
обов’язковийПриклад: "1001"
Додаткові
skНомер складу або філії

Номер складу/філії відповідно до налаштувань бази; 0 зазвичай означає основний склад.

int
необов’язковийПриклад: 1За замовчуванням: 0
Точна схема параметрів 
{
    "code": {
        "type": "string",
        "required": true,
        "max": 128,
        "title": "Код товару",
        "description": "Публічний код товару, картки або іншого запису, як він відображається у програмі.",
        "group": "Основні",
        "example": "1001"
    },
    "sk": {
        "type": "int",
        "min": 0,
        "max": 2,
        "default": 0,
        "title": "Номер складу або філії",
        "description": "Номер складу/філії відповідно до налаштувань бази; 0 зазвичай означає основний склад.",
        "group": "Додаткові",
        "example": 1
    }
}

Результат

Форма відповіді: tagged_rows
ПолеЗмістТипПриклад
tagTagПовернене значення «Tag» відповідного запису, документа або підсумку ARM20.string"Приклад"
foundFoundПовернене значення «Found» відповідного запису, документа або підсумку ARM20.string"Приклад"
codeКод товаруПовернене значення «Код товару» відповідного запису, документа або підсумку ARM20.string"1001"
nameНазваПовернене значення «Назва» відповідного запису, документа або підсумку ARM20.string"Тестовий товар"
costСобівартістьТочне повернене значення «Собівартість» як десятковий рядок із крапкою.string · decimal-string · currency-of-operation"100.00"
markupНацінкаТочне повернене значення «Націнка» як десятковий рядок із крапкою.string · decimal-string · percent"100.00"
priceЦінаТочне повернене значення «Ціна» як десятковий рядок із крапкою.string · decimal-string · currency-of-operation"100.00"
unit_typeОдиниця виміруПовернене значення «Одиниця виміру» відповідного запису, документа або підсумку ARM20.string"Приклад"
quantityКількістьТочне повернене значення «Кількість» як десятковий рядок із крапкою.string · decimal-string · product-unit"1.000"
date_addedДата додаванняПовернена дата «Дата додавання» у форматі YYYY-MM-DD.string · date"2026-07-23"
no_discountЗаборонити знижкуПовернене значення «Заборонити знижку» відповідного запису, документа або підсумку ARM20.string"Приклад"
critical_quantityКритичний залишокТочне повернене значення «Критичний залишок» як десятковий рядок із крапкою.string · decimal-string · product-unit"100.00"
supplierПостачальникПовернене значення «Постачальник» відповідного запису, документа або підсумку ARM20.string"Приклад"
categoryКатегорія товаруПовернене значення «Категорія товару» відповідного запису, документа або підсумку ARM20.string"Приклад"
parent_categoryБатьківська категоріяПовернене значення «Батьківська категорія» відповідного запису, документа або підсумку ARM20.string"Приклад"
shelf_life_daysСтрок придатності, днівПовернене значення «Строк придатності, днів» відповідного запису, документа або підсумку ARM20.string"Приклад"
c2C2Повернене значення «C2» відповідного запису, документа або підсумку ARM20.string"Приклад"
additional_infoДодаткова інформаціяПовернене значення «Додаткова інформація» відповідного запису, документа або підсумку ARM20.string"Приклад"
in_cloudIn cloudПовернене значення «In cloud» відповідного запису, документа або підсумку ARM20.string"Приклад"
descriptionОписПовернене значення «Опис» відповідного запису, документа або підсумку ARM20.string"Приклад"
kitchen_printerKitchen printerПовернене значення «Kitchen printer» відповідного запису, документа або підсумку ARM20.string"Приклад"
uktzedКод УКТ ЗЕДПовернене значення «Код УКТ ЗЕД» відповідного запису, документа або підсумку ARM20.string"Приклад"
excise_inputExcise inputПовернене значення «Excise input» відповідного запису, документа або підсумку ARM20.string"Приклад"
field_nameНазва поляПовернене значення «Назва поля» відповідного запису, документа або підсумку ARM20.string"Приклад"
valueЗначенняПовернене значення «Значення» відповідного запису, документа або підсумку ARM20.string"Приклад"
document_numberНомер документаНомер документа у базі поточного клієнта.string"ПН-1001"
dateДатаПовернена дата «Дата» у форматі YYYY-MM-DD.string · date"2026-07-23"
fiscalФіскальна ознакаПовернене значення «Фіскальна ознака» відповідного запису, документа або підсумку ARM20.string"Приклад"
folderFolderПовернене значення «Folder» відповідного запису, документа або підсумку ARM20.string"Приклад"
picturePictureПовернене значення «Picture» відповідного запису, документа або підсумку ARM20.string"Приклад"
summarySummaryПовернене значення «Summary» відповідного запису, документа або підсумку ARM20.string"Приклад"
owner_codeOwner codeПовернене значення «Owner code» відповідного запису, документа або підсумку ARM20.string"Приклад"
owner_nameOwner nameПовернене значення «Owner name» відповідного запису, документа або підсумку ARM20.string"Приклад"
Точна схема результату 
{
    "mode": "tagged_rows",
    "row_shapes": {
        "STATE": [
            "tag",
            "found"
        ],
        "MAIN": [
            "tag",
            "code",
            "name",
            "cost",
            "markup",
            "price",
            "unit_type",
            "quantity",
            "date_added",
            "no_discount",
            "critical_quantity",
            "supplier",
            "category",
            "parent_category",
            "shelf_life_days",
            "c2",
            "additional_info",
            "in_cloud"
        ],
        "DESC": [
            "tag",
            "description",
            "kitchen_printer"
        ],
        "UKT": [
            "tag",
            "uktzed",
            "excise_input"
        ],
        "EXTRA_CODE": [
            "tag",
            "code"
        ],
        "EXTRA_VALUE": [
            "tag",
            "field_name",
            "value"
        ],
        "FIFO": [
            "tag",
            "document_number",
            "cost",
            "quantity",
            "date",
            "fiscal"
        ],
        "SOSTAV": [
            "tag",
            "code",
            "name",
            "cost",
            "price",
            "unit_type",
            "quantity"
        ],
        "PICTURE": [
            "tag",
            "folder",
            "picture"
        ],
        "SIZE_SUMMARY": [
            "tag",
            "summary"
        ],
        "DUP_OWNER": [
            "tag",
            "owner_code",
            "owner_name"
        ]
    },
    "shape_field_specs": {
        "STATE": {
            "tag": {
                "title": "Tag",
                "description": "Повернене значення «Tag» відповідного запису, документа або підсумку ARM20.",
                "type": "string",
                "example": "Приклад"
            },
            "found": {
                "title": "Found",
                "description": "Повернене значення «Found» відповідного запису, документа або підсумку ARM20.",
                "type": "string",
                "example": "Приклад"
            }
        },
        "MAIN": {
            "tag": {
                "title": "Tag",
                "description": "Повернене значення «Tag» відповідного запису, документа або підсумку ARM20.",
                "type": "string",
                "example": "Приклад"
            },
            "code": {
                "title": "Код товару",
                "description": "Повернене значення «Код товару» відповідного запису, документа або підсумку ARM20.",
                "type": "string",
                "example": "1001"
            },
            "name": {
                "title": "Назва",
                "description": "Повернене значення «Назва» відповідного запису, документа або підсумку ARM20.",
                "type": "string",
                "example": "Тестовий товар"
            },
            "cost": {
                "title": "Собівартість",
                "description": "Точне повернене значення «Собівартість» як десятковий рядок із крапкою.",
                "type": "string",
                "format": "decimal-string",
                "unit": "currency-of-operation",
                "example": "100.00"
            },
            "markup": {
                "title": "Націнка",
                "description": "Точне повернене значення «Націнка» як десятковий рядок із крапкою.",
                "type": "string",
                "format": "decimal-string",
                "unit": "percent",
                "example": "100.00"
            },
            "price": {
                "title": "Ціна",
                "description": "Точне повернене значення «Ціна» як десятковий рядок із крапкою.",
                "type": "string",
                "format": "decimal-string",
                "unit": "currency-of-operation",
                "example": "100.00"
            },
            "unit_type": {
                "title": "Одиниця виміру",
                "description": "Повернене значення «Одиниця виміру» відповідного запису, документа або підсумку ARM20.",
                "type": "string",
                "example": "Приклад"
            },
            "quantity": {
                "title": "Кількість",
                "description": "Точне повернене значення «Кількість» як десятковий рядок із крапкою.",
                "type": "string",
                "format": "decimal-string",
                "unit": "product-unit",
                "example": "1.000"
            },
            "date_added": {
                "title": "Дата додавання",
                "description": "Повернена дата «Дата додавання» у форматі YYYY-MM-DD.",
                "type": "string",
                "format": "date",
                "example": "2026-07-23"
            },
            "no_discount": {
                "title": "Заборонити знижку",
                "description": "Повернене значення «Заборонити знижку» відповідного запису, документа або підсумку ARM20.",
                "type": "string",
                "example": "Приклад"
            },
            "critical_quantity": {
                "title": "Критичний залишок",
                "description": "Точне повернене значення «Критичний залишок» як десятковий рядок із крапкою.",
                "type": "string",
                "format": "decimal-string",
                "unit": "product-unit",
                "example": "100.00"
            },
            "supplier": {
                "title": "Постачальник",
                "description": "Повернене значення «Постачальник» відповідного запису, документа або підсумку ARM20.",
                "type": "string",
                "example": "Приклад"
            },
            "category": {
                "title": "Категорія товару",
                "description": "Повернене значення «Категорія товару» відповідного запису, документа або підсумку ARM20.",
                "type": "string",
                "example": "Приклад"
            },
            "parent_category": {
                "title": "Батьківська категорія",
                "description": "Повернене значення «Батьківська категорія» відповідного запису, документа або підсумку ARM20.",
                "type": "string",
                "example": "Приклад"
            },
            "shelf_life_days": {
                "title": "Строк придатності, днів",
                "description": "Повернене значення «Строк придатності, днів» відповідного запису, документа або підсумку ARM20.",
                "type": "string",
                "example": "Приклад"
            },
            "c2": {
                "title": "C2",
                "description": "Повернене значення «C2» відповідного запису, документа або підсумку ARM20.",
                "type": "string",
                "example": "Приклад"
            },
            "additional_info": {
                "title": "Додаткова інформація",
                "description": "Повернене значення «Додаткова інформація» відповідного запису, документа або підсумку ARM20.",
                "type": "string",
                "example": "Приклад"
            },
            "in_cloud": {
                "title": "In cloud",
                "description": "Повернене значення «In cloud» відповідного запису, документа або підсумку ARM20.",
                "type": "string",
                "example": "Приклад"
            }
        },
        "DESC": {
            "tag": {
                "title": "Tag",
                "description": "Повернене значення «Tag» відповідного запису, документа або підсумку ARM20.",
                "type": "string",
                "example": "Приклад"
            },
            "description": {
                "title": "Опис",
                "description": "Повернене значення «Опис» відповідного запису, документа або підсумку ARM20.",
                "type": "string",
                "example": "Приклад"
            },
            "kitchen_printer": {
                "title": "Kitchen printer",
                "description": "Повернене значення «Kitchen printer» відповідного запису, документа або підсумку ARM20.",
                "type": "string",
                "example": "Приклад"
            }
        },
        "UKT": {
            "tag": {
                "title": "Tag",
                "description": "Повернене значення «Tag» відповідного запису, документа або підсумку ARM20.",
                "type": "string",
                "example": "Приклад"
            },
            "uktzed": {
                "title": "Код УКТ ЗЕД",
                "description": "Повернене значення «Код УКТ ЗЕД» відповідного запису, документа або підсумку ARM20.",
                "type": "string",
                "example": "Приклад"
            },
            "excise_input": {
                "title": "Excise input",
                "description": "Повернене значення «Excise input» відповідного запису, документа або підсумку ARM20.",
                "type": "string",
                "example": "Приклад"
            }
        },
        "EXTRA_CODE": {
            "tag": {
                "title": "Tag",
                "description": "Повернене значення «Tag» відповідного запису, документа або підсумку ARM20.",
                "type": "string",
                "example": "Приклад"
            },
            "code": {
                "title": "Код товару",
                "description": "Повернене значення «Код товару» відповідного запису, документа або підсумку ARM20.",
                "type": "string",
                "example": "1001"
            }
        },
        "EXTRA_VALUE": {
            "tag": {
                "title": "Tag",
                "description": "Повернене значення «Tag» відповідного запису, документа або підсумку ARM20.",
                "type": "string",
                "example": "Приклад"
            },
            "field_name": {
                "title": "Назва поля",
                "description": "Повернене значення «Назва поля» відповідного запису, документа або підсумку ARM20.",
                "type": "string",
                "example": "Приклад"
            },
            "value": {
                "title": "Значення",
                "description": "Повернене значення «Значення» відповідного запису, документа або підсумку ARM20.",
                "type": "string",
                "example": "Приклад"
            }
        },
        "FIFO": {
            "tag": {
                "title": "Tag",
                "description": "Повернене значення «Tag» відповідного запису, документа або підсумку ARM20.",
                "type": "string",
                "example": "Приклад"
            },
            "document_number": {
                "title": "Номер документа",
                "description": "Номер документа у базі поточного клієнта.",
                "type": "string",
                "example": "ПН-1001"
            },
            "cost": {
                "title": "Собівартість",
                "description": "Точне повернене значення «Собівартість» як десятковий рядок із крапкою.",
                "type": "string",
                "format": "decimal-string",
                "unit": "currency-of-operation",
                "example": "100.00"
            },
            "quantity": {
                "title": "Кількість",
                "description": "Точне повернене значення «Кількість» як десятковий рядок із крапкою.",
                "type": "string",
                "format": "decimal-string",
                "unit": "product-unit",
                "example": "1.000"
            },
            "date": {
                "title": "Дата",
                "description": "Повернена дата «Дата» у форматі YYYY-MM-DD.",
                "type": "string",
                "format": "date",
                "example": "2026-07-23"
            },
            "fiscal": {
                "title": "Фіскальна ознака",
                "description": "Повернене значення «Фіскальна ознака» відповідного запису, документа або підсумку ARM20.",
                "type": "string",
                "example": "Приклад"
            }
        },
        "SOSTAV": {
            "tag": {
                "title": "Tag",
                "description": "Повернене значення «Tag» відповідного запису, документа або підсумку ARM20.",
                "type": "string",
                "example": "Приклад"
            },
            "code": {
                "title": "Код товару",
                "description": "Повернене значення «Код товару» відповідного запису, документа або підсумку ARM20.",
                "type": "string",
                "example": "1001"
            },
            "name": {
                "title": "Назва",
                "description": "Повернене значення «Назва» відповідного запису, документа або підсумку ARM20.",
                "type": "string",
                "example": "Тестовий товар"
            },
            "cost": {
                "title": "Собівартість",
                "description": "Точне повернене значення «Собівартість» як десятковий рядок із крапкою.",
                "type": "string",
                "format": "decimal-string",
                "unit": "currency-of-operation",
                "example": "100.00"
            },
            "price": {
                "title": "Ціна",
                "description": "Точне повернене значення «Ціна» як десятковий рядок із крапкою.",
                "type": "string",
                "format": "decimal-string",
                "unit": "currency-of-operation",
                "example": "100.00"
            },
            "unit_type": {
                "title": "Одиниця виміру",
                "description": "Повернене значення «Одиниця виміру» відповідного запису, документа або підсумку ARM20.",
                "type": "string",
                "example": "Приклад"
            },
            "quantity": {
                "title": "Кількість",
                "description": "Точне повернене значення «Кількість» як десятковий рядок із крапкою.",
                "type": "string",
                "format": "decimal-string",
                "unit": "product-unit",
                "example": "1.000"
            }
        },
        "PICTURE": {
            "tag": {
                "title": "Tag",
                "description": "Повернене значення «Tag» відповідного запису, документа або підсумку ARM20.",
                "type": "string",
                "example": "Приклад"
            },
            "folder": {
                "title": "Folder",
                "description": "Повернене значення «Folder» відповідного запису, документа або підсумку ARM20.",
                "type": "string",
                "example": "Приклад"
            },
            "picture": {
                "title": "Picture",
                "description": "Повернене значення «Picture» відповідного запису, документа або підсумку ARM20.",
                "type": "string",
                "example": "Приклад"
            }
        },
        "SIZE_SUMMARY": {
            "tag": {
                "title": "Tag",
                "description": "Повернене значення «Tag» відповідного запису, документа або підсумку ARM20.",
                "type": "string",
                "example": "Приклад"
            },
            "summary": {
                "title": "Summary",
                "description": "Повернене значення «Summary» відповідного запису, документа або підсумку ARM20.",
                "type": "string",
                "example": "Приклад"
            }
        },
        "DUP_OWNER": {
            "tag": {
                "title": "Tag",
                "description": "Повернене значення «Tag» відповідного запису, документа або підсумку ARM20.",
                "type": "string",
                "example": "Приклад"
            },
            "owner_code": {
                "title": "Owner code",
                "description": "Повернене значення «Owner code» відповідного запису, документа або підсумку ARM20.",
                "type": "string",
                "example": "Приклад"
            },
            "owner_name": {
                "title": "Owner name",
                "description": "Повернене значення «Owner name» відповідного запису, документа або підсумку ARM20.",
                "type": "string",
                "example": "Приклад"
            }
        }
    }
}

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

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

{
    "method": "goods.card_open",
    "params": {
        "code": "1001"
    },
    "id": "example-goods-card-open"
}

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

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

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

Пов’язані методи

goods.card_refsПовертає довідкові значення, потрібні для редагування картки товару. читання catalog.read з 0.4.0

Повертає довідкові значення, потрібні для редагування картки товару.

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

Параметри params

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

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

string
необов’язковийПриклад: ""За замовчуванням: ""
Точна схема параметрів 
{
    "ui_user": {
        "type": "string",
        "max": 4096,
        "default": "",
        "title": "Користувач інтерфейсу",
        "description": "Поле «Користувач інтерфейсу» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": ""
    }
}

Результат

Форма відповіді: variable_rows
ПолеЗмістТипПриклад
tagTagПовернене значення «Tag» відповідного запису, документа або підсумку ARM20.string"Приклад"
kindТип записуПовернене значення «Тип запису» відповідного запису, документа або підсумку ARM20.string"Приклад"
valueЗначенняПовернене значення «Значення» відповідного запису, документа або підсумку ARM20.string"Приклад"
nameНазваПовернене значення «Назва» відповідного запису, документа або підсумку ARM20.string"Тестовий товар"
idІдентифікатор записуПовернене значення «Ідентифікатор запису» відповідного запису, документа або підсумку ARM20.string"Приклад"
parent_idParent idПовернене значення «Parent id» відповідного запису, документа або підсумку ARM20.string"Приклад"
levelРівень категоріїПовернене значення «Рівень категорії» відповідного запису, документа або підсумку ARM20.string"Приклад"
Точна схема результату 
{
    "mode": "variable_rows",
    "contract": "goods_card_refs",
    "row_shapes": {
        "round": [
            "tag",
            "kind",
            "value"
        ],
        "post": [
            "tag",
            "kind",
            "name"
        ],
        "category": [
            "tag",
            "kind",
            "id",
            "name",
            "parent_id",
            "level"
        ]
    },
    "constraints": [
        "Рядок округлення завжди перший і повертається рівно один раз.",
        "Рядки постачальників передують рядкам категорій."
    ],
    "field_specs": {
        "tag": {
            "title": "Tag",
            "description": "Повернене значення «Tag» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        },
        "kind": {
            "title": "Тип запису",
            "description": "Повернене значення «Тип запису» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        },
        "value": {
            "title": "Значення",
            "description": "Повернене значення «Значення» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        },
        "name": {
            "title": "Назва",
            "description": "Повернене значення «Назва» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Тестовий товар"
        },
        "id": {
            "title": "Ідентифікатор запису",
            "description": "Повернене значення «Ідентифікатор запису» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        },
        "parent_id": {
            "title": "Parent id",
            "description": "Повернене значення «Parent id» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        },
        "level": {
            "title": "Рівень категорії",
            "description": "Повернене значення «Рівень категорії» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        }
    }
}

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

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

{
    "method": "goods.card_refs",
    "params": {
        "ui_user": "Приклад"
    },
    "id": "example-goods-card-refs"
}

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

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

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

Пов’язані методи

goods.clear_pictureВидаляє зображення з картки товару. запис catalog.write з 0.4.0

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

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

Параметри params

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

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

string
обов’язковийПриклад: "1001"
Додаткові
pict_typeТип зображення

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

int
необов’язковийПриклад: 1За замовчуванням: 0
Точна схема параметрів 
{
    "code": {
        "type": "string",
        "max": 512,
        "required": true,
        "title": "Код товару",
        "description": "Публічний код товару, картки або іншого запису, як він відображається у програмі.",
        "group": "Основні",
        "example": "1001"
    },
    "pict_type": {
        "type": "int",
        "min": 0,
        "max": 1,
        "default": 0,
        "title": "Тип зображення",
        "description": "Поле «Тип зображення» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "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-goods-clear-picture-0001

{
    "method": "goods.clear_picture",
    "params": {
        "code": "1001"
    },
    "id": "example-goods-clear-picture"
}

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

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

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

Завершує перетворення товару на складений товар і очищає зайві залишки.

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

Параметри params

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

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

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

Результат

Форма відповіді: 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-goods-convert-to-sostav-cleanup-0001

{
    "method": "goods.convert_to_sostav_cleanup",
    "params": {
        "code": "1001"
    },
    "id": "example-goods-convert-to-sostav-cleanup"
}

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

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

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

Створює копію картки товару з новим кодом.

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

Параметри params

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

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

string
обов’язковийПриклад: "1001"
source_codeПочатковий код товару

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

string
обов’язковийПриклад: "1001"
Точна схема параметрів 
{
    "new_code": {
        "type": "string",
        "max": 512,
        "required": true,
        "title": "Новий код товару",
        "description": "Поле «Новий код товару» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": "1001"
    },
    "source_code": {
        "type": "string",
        "max": 512,
        "required": true,
        "title": "Початковий код товару",
        "description": "Поле «Початковий код товару» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": "1001"
    }
}

Результат

Форма відповіді: 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-goods-copy-product-0001

{
    "method": "goods.copy_product",
    "params": {
        "new_code": "1001",
        "source_code": "1001"
    },
    "id": "example-goods-copy-product"
}

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

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

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

Видаляє зв’язок між товаром та його аналогом.

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

Параметри params

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

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

string
обов’язковийПриклад: "Приклад"
Основні
codeКод товару

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

string
обов’язковийПриклад: "1001"
Точна схема параметрів 
{
    "analog_code": {
        "type": "string",
        "max": 512,
        "required": true,
        "title": "Код аналога",
        "description": "Поле «Код аналога» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": "Приклад"
    },
    "code": {
        "type": "string",
        "max": 512,
        "required": true,
        "title": "Код товару",
        "description": "Публічний код товару, картки або іншого запису, як він відображається у програмі.",
        "group": "Основні",
        "example": "1001"
    }
}

Результат

Форма відповіді: 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-goods-delete-analog-0001

{
    "method": "goods.delete_analog",
    "params": {
        "analog_code": "Приклад",
        "code": "1001"
    },
    "id": "example-goods-delete-analog"
}

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

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

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

Пов’язані методи

goods.delete_extra_codeВидаляє додатковий штрихкод товару. запис catalog.write з 0.4.0

Видаляє додатковий штрихкод товару.

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

Параметри params

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

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

string
обов’язковийПриклад: "1001"
Додаткові
extra_codeДодатковий штрихкод

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

string
обов’язковийПриклад: "1001"
Точна схема параметрів 
{
    "code": {
        "type": "string",
        "max": 512,
        "required": true,
        "title": "Код товару",
        "description": "Публічний код товару, картки або іншого запису, як він відображається у програмі.",
        "group": "Основні",
        "example": "1001"
    },
    "extra_code": {
        "type": "string",
        "max": 512,
        "required": true,
        "title": "Додатковий штрихкод",
        "description": "Поле «Додатковий штрихкод» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": "1001"
    }
}

Результат

Форма відповіді: 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-goods-delete-extra-code-0001

{
    "method": "goods.delete_extra_code",
    "params": {
        "code": "1001",
        "extra_code": "1001"
    },
    "id": "example-goods-delete-extra-code"
}

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

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

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

Пов’язані методи

goods.delete_extra_nameВидаляє додаткове поле з довідника полів товару. запис catalog.write з 0.4.0

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

Перевірити JSON JSON Schema
Стабільність: стабільний Scope: catalog.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-goods-delete-extra-name-0001

{
    "method": "goods.delete_extra_name",
    "params": {
        "ind": 1
    },
    "id": "example-goods-delete-extra-name"
}

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

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

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

Пов’язані методи

goods.delete_extra_valueВидаляє значення додаткового поля з картки товару. запис catalog.write з 0.4.0

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

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

Параметри params

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

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

string
обов’язковийПриклад: "1001"
Додаткові
field_nameНазва поля

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

string
необов’язковийПриклад: ""За замовчуванням: ""
Точна схема параметрів 
{
    "code": {
        "type": "string",
        "max": 512,
        "required": true,
        "title": "Код товару",
        "description": "Публічний код товару, картки або іншого запису, як він відображається у програмі.",
        "group": "Основні",
        "example": "1001"
    },
    "field_name": {
        "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-goods-delete-extra-value-0001

{
    "method": "goods.delete_extra_value",
    "params": {
        "code": "1001"
    },
    "id": "example-goods-delete-extra-value"
}

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

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

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

Пов’язані методи

goods.delete_productПереміщує товар до списку видалених. запис catalog.write з 0.4.0

Переміщує товар до списку видалених.

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

Параметри params

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

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

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

Результат

Форма відповіді: 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-goods-delete-product-0001

{
    "method": "goods.delete_product",
    "params": {
        "code": "1001"
    },
    "id": "example-goods-delete-product"
}

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

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

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

Пов’язані методи

goods.extra_code_ownerЗнаходить товар, якому належить додатковий штрихкод. читання catalog.details.read з 0.4.0

Знаходить товар, якому належить додатковий штрихкод.

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

Параметри params

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

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

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

Результат

Форма відповіді: rows
ПолеЗмістТипПриклад
owner_codeOwner codeПовернене значення «Owner code» відповідного запису, документа або підсумку ARM20.string"Приклад"
owner_nameOwner nameПовернене значення «Owner name» відповідного запису, документа або підсумку ARM20.string"Приклад"
Точна схема результату 
{
    "mode": "rows",
    "columns": [
        "owner_code",
        "owner_name"
    ],
    "field_specs": {
        "owner_code": {
            "title": "Owner code",
            "description": "Повернене значення «Owner code» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        },
        "owner_name": {
            "title": "Owner name",
            "description": "Повернене значення «Owner name» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        }
    }
}

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

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

{
    "method": "goods.extra_code_owner",
    "params": {
        "code": "1001"
    },
    "id": "example-goods-extra-code-owner"
}

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

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

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

Пов’язані методи

goods.extra_codesПовертає додаткові штрихкоди товару. читання catalog.details.read з 0.4.0

Повертає додаткові штрихкоди товару.

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

Параметри params

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

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

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

Результат

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

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

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

{
    "method": "goods.extra_codes",
    "params": {
        "code": "1001"
    },
    "id": "example-goods-extra-codes"
}

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

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

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

Пов’язані методи

goods.extra_distinct_valuesПовертає унікальні значення вибраного додаткового поля товарів. читання catalog.details.read з 0.4.0

Повертає унікальні значення вибраного додаткового поля товарів.

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

Параметри params

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

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

string
обов’язковийПриклад: "Приклад"
Точна схема параметрів 
{
    "field_name": {
        "type": "string",
        "required": true,
        "max": 190,
        "title": "Назва поля",
        "description": "Поле «Назва поля» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": "Приклад"
    }
}

Результат

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

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

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

{
    "method": "goods.extra_distinct_values",
    "params": {
        "field_name": "Опис"
    },
    "id": "example-goods-extra-distinct-values"
}

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

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

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

Пов’язані методи

goods.extra_namesПовертає довідник додаткових полів картки товару. читання catalog.details.read з 0.4.0

Повертає довідник додаткових полів картки товару.

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

Параметри params

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

Результат

Форма відповіді: rows
ПолеЗмістТипПриклад
idІдентифікатор записуПовернене значення «Ідентифікатор запису» відповідного запису, документа або підсумку ARM20.string"Приклад"
nameНазваПовернене значення «Назва» відповідного запису, документа або підсумку ARM20.string"Тестовий товар"
is_mainIs mainПовернене значення «Is main» відповідного запису, документа або підсумку ARM20.string"Приклад"
Точна схема результату 
{
    "mode": "rows",
    "columns": [
        "id",
        "name",
        "is_main"
    ],
    "field_specs": {
        "id": {
            "title": "Ідентифікатор запису",
            "description": "Повернене значення «Ідентифікатор запису» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        },
        "name": {
            "title": "Назва",
            "description": "Повернене значення «Назва» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Тестовий товар"
        },
        "is_main": {
            "title": "Is main",
            "description": "Повернене значення «Is main» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        }
    }
}

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

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

{
    "method": "goods.extra_names",
    "params": [],
    "id": "example-goods-extra-names"
}

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

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

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

Пов’язані методи

goods.extra_valueПовертає одне додаткове значення з картки товару. читання catalog.details.read з 0.4.0

Повертає одне додаткове значення з картки товару.

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

Параметри params

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

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

string
обов’язковийПриклад: "1001"
Додаткові
field_nameНазва поля

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

string
обов’язковийПриклад: "Приклад"
Точна схема параметрів 
{
    "code": {
        "type": "string",
        "required": true,
        "max": 128,
        "title": "Код товару",
        "description": "Публічний код товару, картки або іншого запису, як він відображається у програмі.",
        "group": "Основні",
        "example": "1001"
    },
    "field_name": {
        "type": "string",
        "required": true,
        "max": 190,
        "title": "Назва поля",
        "description": "Поле «Назва поля» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": "Приклад"
    }
}

Результат

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

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

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

{
    "method": "goods.extra_value",
    "params": {
        "code": "1001",
        "field_name": "Опис"
    },
    "id": "example-goods-extra-value"
}

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

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

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

Пов’язані методи

goods.extra_valuesПовертає всі додаткові значення картки товару. читання catalog.details.read з 0.4.0

Повертає всі додаткові значення картки товару.

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

Параметри params

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

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

string
обов’язковийПриклад: "1001"
Додаткові
include_emptyВключити порожні значення

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

bool
необов’язковийПриклад: falseЗа замовчуванням: false
Точна схема параметрів 
{
    "code": {
        "type": "string",
        "required": true,
        "max": 128,
        "title": "Код товару",
        "description": "Публічний код товару, картки або іншого запису, як він відображається у програмі.",
        "group": "Основні",
        "example": "1001"
    },
    "include_empty": {
        "type": "bool",
        "default": false,
        "title": "Включити порожні значення",
        "description": "Визначає, чи застосовувати параметр «Включити порожні значення». Передавайте JSON true або false.",
        "group": "Додаткові",
        "example": false
    }
}

Результат

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

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

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

{
    "method": "goods.extra_values",
    "params": {
        "code": "1001"
    },
    "id": "example-goods-extra-values"
}

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

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

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

Пов’язані методи

goods.fifo_rowsПовертає партії та залишки товару за методом FIFO. читання inventory.cost.read з 0.4.0

Повертає партії та залишки товару за методом FIFO.

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

Параметри params

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

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

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

Результат

Форма відповіді: rows
ПолеЗмістТипПриклад
document_numberНомер документаНомер документа у базі поточного клієнта.string"ПН-1001"
costСобівартістьТочне повернене значення «Собівартість» як десятковий рядок із крапкою.string · decimal-string · currency-of-operation"100.00"
quantityКількістьТочне повернене значення «Кількість» як десятковий рядок із крапкою.string · decimal-string · product-unit"1.000"
dateДатаПовернена дата «Дата» у форматі YYYY-MM-DD.string · date"2026-07-23"
fiscalФіскальна ознакаПовернене значення «Фіскальна ознака» відповідного запису, документа або підсумку ARM20.string"Приклад"
Точна схема результату 
{
    "mode": "rows",
    "columns": [
        "document_number",
        "cost",
        "quantity",
        "date",
        "fiscal"
    ],
    "field_specs": {
        "document_number": {
            "title": "Номер документа",
            "description": "Номер документа у базі поточного клієнта.",
            "type": "string",
            "example": "ПН-1001"
        },
        "cost": {
            "title": "Собівартість",
            "description": "Точне повернене значення «Собівартість» як десятковий рядок із крапкою.",
            "type": "string",
            "format": "decimal-string",
            "unit": "currency-of-operation",
            "example": "100.00"
        },
        "quantity": {
            "title": "Кількість",
            "description": "Точне повернене значення «Кількість» як десятковий рядок із крапкою.",
            "type": "string",
            "format": "decimal-string",
            "unit": "product-unit",
            "example": "1.000"
        },
        "date": {
            "title": "Дата",
            "description": "Повернена дата «Дата» у форматі YYYY-MM-DD.",
            "type": "string",
            "format": "date",
            "example": "2026-07-23"
        },
        "fiscal": {
            "title": "Фіскальна ознака",
            "description": "Повернене значення «Фіскальна ознака» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        }
    }
}

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

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

{
    "method": "goods.fifo_rows",
    "params": {
        "code": "1001"
    },
    "id": "example-goods-fifo-rows"
}

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

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

{
    "ok": true,
    "data": {
        "method": "goods.fifo_rows",
        "result": {
            "upstream": {
                "name": "UPMAPI",
                "version": "1",
                "resource": "goods"
            },
            "status": {
                "code": "OK",
                "operation": "fifo_rows",
                "value": "1"
            },
            "rows": [
                {
                    "document_number": "ПН-1001",
                    "cost": "100.00",
                    "quantity": "1.000",
                    "date": "2026-07-23",
                    "fiscal": "Приклад"
                }
            ]
        },
        "id": "example-goods-fifo-rows"
    },
    "request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
КодHTTPПричинаДія клієнта
INVALID_PARAMETER422Один із параметрів має неправильний тип, формат або значення.Виправити запит; автоматично не повторювати.
UPSTREAM_FAILURE502Сервер бізнес-операції недоступний або відхилив безпечний контракт.Дозволений повтор із backoff.

Пов’язані методи

goods.fifo_sk_rowsПовертає партії та залишки товару за FIFO для вибраної філії. читання inventory.cost.read з 0.4.0

Повертає партії та залишки товару за FIFO для вибраної філії.

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

Параметри params

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

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

string
обов’язковийПриклад: "1001"
Додаткові
skНомер складу або філії

Номер складу/філії відповідно до налаштувань бази; 0 зазвичай означає основний склад.

int
обов’язковийПриклад: 1
Точна схема параметрів 
{
    "code": {
        "type": "string",
        "required": true,
        "max": 128,
        "title": "Код товару",
        "description": "Публічний код товару, картки або іншого запису, як він відображається у програмі.",
        "group": "Основні",
        "example": "1001"
    },
    "sk": {
        "type": "int",
        "required": true,
        "min": 1,
        "max": 2,
        "title": "Номер складу або філії",
        "description": "Номер складу/філії відповідно до налаштувань бази; 0 зазвичай означає основний склад.",
        "group": "Додаткові",
        "example": 1
    }
}

Результат

Форма відповіді: rows
ПолеЗмістТипПриклад
document_numberНомер документаНомер документа у базі поточного клієнта.string"ПН-1001"
costСобівартістьТочне повернене значення «Собівартість» як десятковий рядок із крапкою.string · decimal-string · currency-of-operation"100.00"
quantityКількістьТочне повернене значення «Кількість» як десятковий рядок із крапкою.string · decimal-string · product-unit"1.000"
dateДатаПовернена дата «Дата» у форматі YYYY-MM-DD.string · date"2026-07-23"
fiscalФіскальна ознакаПовернене значення «Фіскальна ознака» відповідного запису, документа або підсумку ARM20.string"Приклад"
Точна схема результату 
{
    "mode": "rows",
    "columns": [
        "document_number",
        "cost",
        "quantity",
        "date",
        "fiscal"
    ],
    "field_specs": {
        "document_number": {
            "title": "Номер документа",
            "description": "Номер документа у базі поточного клієнта.",
            "type": "string",
            "example": "ПН-1001"
        },
        "cost": {
            "title": "Собівартість",
            "description": "Точне повернене значення «Собівартість» як десятковий рядок із крапкою.",
            "type": "string",
            "format": "decimal-string",
            "unit": "currency-of-operation",
            "example": "100.00"
        },
        "quantity": {
            "title": "Кількість",
            "description": "Точне повернене значення «Кількість» як десятковий рядок із крапкою.",
            "type": "string",
            "format": "decimal-string",
            "unit": "product-unit",
            "example": "1.000"
        },
        "date": {
            "title": "Дата",
            "description": "Повернена дата «Дата» у форматі YYYY-MM-DD.",
            "type": "string",
            "format": "date",
            "example": "2026-07-23"
        },
        "fiscal": {
            "title": "Фіскальна ознака",
            "description": "Повернене значення «Фіскальна ознака» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        }
    }
}

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

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

{
    "method": "goods.fifo_sk_rows",
    "params": {
        "code": "1001",
        "sk": 1
    },
    "id": "example-goods-fifo-sk-rows"
}

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

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

{
    "ok": true,
    "data": {
        "method": "goods.fifo_sk_rows",
        "result": {
            "upstream": {
                "name": "UPMAPI",
                "version": "1",
                "resource": "goods"
            },
            "status": {
                "code": "OK",
                "operation": "fifo_sk_rows",
                "value": "1"
            },
            "rows": [
                {
                    "document_number": "ПН-1001",
                    "cost": "100.00",
                    "quantity": "1.000",
                    "date": "2026-07-23",
                    "fiscal": "Приклад"
                }
            ]
        },
        "id": "example-goods-fifo-sk-rows"
    },
    "request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
КодHTTPПричинаДія клієнта
INVALID_PARAMETER422Один із параметрів має неправильний тип, формат або значення.Виправити запит; автоматично не повторювати.
UPSTREAM_FAILURE502Сервер бізнес-операції недоступний або відхилив безпечний контракт.Дозволений повтор із backoff.

Пов’язані методи

goods.pictureПовертає дані зображення, прив’язаного до товару. читання catalog.details.read з 0.4.0

Повертає дані зображення, прив’язаного до товару.

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

Параметри params

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

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

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

Результат

Форма відповіді: rows
ПолеЗмістТипПриклад
folderFolderПовернене значення «Folder» відповідного запису, документа або підсумку ARM20.string"Приклад"
picturePictureПовернене значення «Picture» відповідного запису, документа або підсумку ARM20.string"Приклад"
Точна схема результату 
{
    "mode": "rows",
    "columns": [
        "folder",
        "picture"
    ],
    "field_specs": {
        "folder": {
            "title": "Folder",
            "description": "Повернене значення «Folder» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        },
        "picture": {
            "title": "Picture",
            "description": "Повернене значення «Picture» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        }
    }
}

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

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

{
    "method": "goods.picture",
    "params": {
        "code": "1001"
    },
    "id": "example-goods-picture"
}

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

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

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

Відновлює товар зі списку видалених.

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

Параметри params

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

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

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

Результат

Форма відповіді: 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-goods-restore-product-0001

{
    "method": "goods.restore_product",
    "params": {
        "code": "1001"
    },
    "id": "example-goods-restore-product"
}

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

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

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

Зберігає основні реквізити, ціни та параметри картки товару.

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

Параметри params

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

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

  • keep — залишити поточну категорію
  • set — встановити передану категорію
enum
необов’язковийПриклад: "keep"За замовчуванням: "keep"
has_dopinfЄ додаткова інформація

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

bool
необов’язковийПриклад: falseЗа замовчуванням: false
post_nameНазва постачальника

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

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

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

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

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

int
необов’язковийПриклад: 1За замовчуванням: 0
noskidЗаборонити знижку

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

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

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

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

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

int
необов’язковийПриклад: 1За замовчуванням: 0
c2C2

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

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

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

int
необов’язковийПриклад: 1За замовчуванням: 0
dopinfДодаткова інформація

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

int
необов’язковийПриклад: 1За замовчуванням: 0
Основні
codeКод товару

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

string
обов’язковийПриклад: "1001"
modeРежим операції

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

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

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

string
обов’язковийПриклад: "Тестовий товар"
Суми та кількості
ssСобівартість

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

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

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

decimal · decimal-string · percent
необов’язковийПриклад: "100.00"За замовчуванням: "0"
priceЦіна

Ціна за одиницю товару як десятковий рядок без символу валюти.

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

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

decimal · decimal-string · currency-of-operation
необов’язковийПриклад: "100.00"За замовчуванням: "0"
Точна схема параметрів 
{
    "cat_mode": {
        "type": "enum",
        "values": [
            "keep",
            "set"
        ],
        "default": "keep",
        "title": "Режим зміни категорії",
        "description": "Варіант «Режим зміни категорії». Використовуйте лише одне зі значень, розшифрованих нижче.",
        "group": "Додаткові",
        "example": "keep",
        "enum_labels": {
            "keep": "залишити поточну категорію",
            "set": "встановити передану категорію"
        }
    },
    "code": {
        "type": "string",
        "max": 512,
        "required": true,
        "title": "Код товару",
        "description": "Публічний код товару, картки або іншого запису, як він відображається у програмі.",
        "group": "Основні",
        "example": "1001"
    },
    "has_dopinf": {
        "type": "bool",
        "default": false,
        "title": "Є додаткова інформація",
        "description": "Визначає, чи застосовувати параметр «Є додаткова інформація». Передавайте JSON true або false.",
        "group": "Додаткові",
        "example": false
    },
    "mode": {
        "type": "enum",
        "values": [
            "add",
            "edit"
        ],
        "default": "edit",
        "title": "Режим операції",
        "description": "Вибирає один із підтримуваних сценаріїв операції. Значення та їх зміст наведено у списку варіантів.",
        "group": "Основні",
        "example": "add",
        "enum_labels": {
            "add": "додати новий запис",
            "edit": "редагувати наявний запис"
        }
    },
    "nt": {
        "type": "string",
        "max": 512,
        "required": true,
        "title": "Назва товару",
        "description": "Поле «Назва товару» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Основні",
        "example": "Тестовий товар"
    },
    "post_name": {
        "type": "string",
        "max": 512,
        "default": "",
        "title": "Назва постачальника",
        "description": "Поле «Назва постачальника» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": ""
    },
    "quant_reset": {
        "type": "bool",
        "default": false,
        "title": "Обнулити кількість",
        "description": "Визначає, чи застосовувати параметр «Обнулити кількість». Передавайте JSON true або false.",
        "group": "Додаткові",
        "example": false
    },
    "ss": {
        "type": "decimal",
        "max": 32,
        "scale": 8,
        "default": "0",
        "title": "Собівартість",
        "description": "Точне числове значення «Собівартість» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається.",
        "group": "Суми та кількості",
        "format": "decimal-string",
        "unit": "currency-of-operation",
        "example": "100.00"
    },
    "nac": {
        "type": "decimal",
        "max": 32,
        "scale": 8,
        "default": "0",
        "title": "Націнка",
        "description": "Точне числове значення «Націнка» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається.",
        "group": "Суми та кількості",
        "format": "decimal-string",
        "unit": "percent",
        "example": "100.00"
    },
    "price": {
        "type": "decimal",
        "max": 32,
        "scale": 8,
        "default": "0",
        "title": "Ціна",
        "description": "Ціна за одиницю товару як десятковий рядок без символу валюти.",
        "group": "Суми та кількості",
        "format": "decimal-string",
        "unit": "currency-of-operation",
        "example": "100.00"
    },
    "ei": {
        "type": "int",
        "min": 0,
        "max": 2147483647,
        "default": 0,
        "title": "Ознака вагового товару",
        "description": "Поле «Ознака вагового товару» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": 1
    },
    "noskid": {
        "type": "bool",
        "default": false,
        "title": "Заборонити знижку",
        "description": "Визначає, чи застосовувати параметр «Заборонити знижку». Передавайте JSON true або false.",
        "group": "Додаткові",
        "example": false
    },
    "incloud": {
        "type": "bool",
        "default": false,
        "title": "Публікувати у хмарі",
        "description": "Визначає, чи застосовувати параметр «Публікувати у хмарі». Передавайте JSON true або false.",
        "group": "Додаткові",
        "example": false
    },
    "crit": {
        "type": "decimal",
        "max": 32,
        "scale": 8,
        "default": "0",
        "title": "Критичний залишок",
        "description": "Точне числове значення «Критичний залишок» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається.",
        "group": "Суми та кількості",
        "format": "decimal-string",
        "unit": "currency-of-operation",
        "example": "100.00"
    },
    "sh": {
        "type": "int",
        "min": 0,
        "max": 36500,
        "default": 0,
        "title": "Ознака штучного товару",
        "description": "Поле «Ознака штучного товару» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": 1
    },
    "c2": {
        "type": "int",
        "min": 0,
        "max": 2147483647,
        "default": 0,
        "title": "C2",
        "description": "Поле «C2» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": 1
    },
    "cat": {
        "type": "int",
        "min": 0,
        "max": 2147483647,
        "default": 0,
        "title": "Категорія",
        "description": "Поле «Категорія» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": 1
    },
    "dopinf": {
        "type": "int",
        "min": 0,
        "max": 4,
        "default": 0,
        "title": "Додаткова інформація",
        "description": "Поле «Додаткова інформація» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": 1
    }
}

Результат

Форма відповіді: 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-goods-save-card-0001

{
    "method": "goods.save_card",
    "params": {
        "mode": "add",
        "code": "2002",
        "nt": "Тестовий товар",
        "ss": "10.25",
        "nac": "20.00",
        "price": "12.30",
        "ei": 0,
        "crit": "2.500"
    },
    "id": "example-goods-save-card"
}

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

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

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

Пов’язані методи

goods.save_descЗберігає опис товару та налаштування кухонного принтера. запис catalog.write з 0.4.0

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

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

Параметри params

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

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

string
обов’язковийПриклад: "1001"
Додаткові
descОпис

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

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

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

string
необов’язковийПриклад: "0"За замовчуванням: "0"
Точна схема параметрів 
{
    "code": {
        "type": "string",
        "max": 512,
        "required": true,
        "title": "Код товару",
        "description": "Публічний код товару, картки або іншого запису, як він відображається у програмі.",
        "group": "Основні",
        "example": "1001"
    },
    "desc": {
        "type": "string",
        "max": 4096,
        "default": "",
        "title": "Опис",
        "description": "Поле «Опис» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": ""
    },
    "printer": {
        "type": "string",
        "max": 512,
        "default": "0",
        "title": "Кухонний принтер",
        "description": "Поле «Кухонний принтер» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": "0"
    }
}

Результат

Форма відповіді: 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-goods-save-desc-0001

{
    "method": "goods.save_desc",
    "params": {
        "code": "1001"
    },
    "id": "example-goods-save-desc"
}

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

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

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

Пов’язані методи

goods.save_extra_valueСтворює або оновлює значення додаткового поля товару. запис catalog.write з 0.4.0

Створює або оновлює значення додаткового поля товару.

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

Параметри params

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

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

string
обов’язковийПриклад: "1001"
Додаткові
field_nameНазва поля

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

string
необов’язковийПриклад: ""За замовчуванням: ""
valueЗначення

Нове або шукане значення поля залежно від операції.

string
необов’язковийПриклад: ""За замовчуванням: ""
Точна схема параметрів 
{
    "code": {
        "type": "string",
        "max": 512,
        "required": true,
        "title": "Код товару",
        "description": "Публічний код товару, картки або іншого запису, як він відображається у програмі.",
        "group": "Основні",
        "example": "1001"
    },
    "field_name": {
        "type": "string",
        "max": 512,
        "default": "",
        "title": "Назва поля",
        "description": "Поле «Назва поля» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": ""
    },
    "value": {
        "type": "string",
        "max": 4096,
        "default": "",
        "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-goods-save-extra-value-0001

{
    "method": "goods.save_extra_value",
    "params": {
        "code": "1001"
    },
    "id": "example-goods-save-extra-value"
}

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

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

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

Пов’язані методи

goods.save_pictureПрив’язує завантажене зображення до картки товару. запис catalog.write з 0.4.0

Прив’язує завантажене зображення до картки товару.

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

Параметри params

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

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

string
обов’язковийПриклад: "1001"
Додаткові
foldПапка зображення

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

string
обов’язковийПриклад: "Приклад"
pictФайл зображення

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

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

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

int
необов’язковийПриклад: 1За замовчуванням: 0
Точна схема параметрів 
{
    "code": {
        "type": "string",
        "max": 512,
        "required": true,
        "title": "Код товару",
        "description": "Публічний код товару, картки або іншого запису, як він відображається у програмі.",
        "group": "Основні",
        "example": "1001"
    },
    "fold": {
        "type": "string",
        "max": 4096,
        "required": true,
        "title": "Папка зображення",
        "description": "Поле «Папка зображення» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": "Приклад"
    },
    "pict": {
        "type": "string",
        "max": 4096,
        "required": true,
        "title": "Файл зображення",
        "description": "Поле «Файл зображення» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": "Приклад"
    },
    "pict_type": {
        "type": "int",
        "min": 0,
        "max": 1,
        "default": 0,
        "title": "Тип зображення",
        "description": "Поле «Тип зображення» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "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-goods-save-picture-0001

{
    "method": "goods.save_picture",
    "params": {
        "code": "1001",
        "fold": "Приклад",
        "pict": "Приклад"
    },
    "id": "example-goods-save-picture"
}

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

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

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

Пов’язані методи

goods.save_size_selectionЗберігає вибрані розміри та варіанти розмірного товару. запис catalog.write з 0.4.0

Зберігає вибрані розміри та варіанти розмірного товару.

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

Параметри params

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

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

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

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

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

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

string
обов’язковийПриклад: "1001"
Точна схема параметрів 
{
    "canon": {
        "type": "string",
        "max": 4096,
        "default": "",
        "title": "Canon",
        "description": "Поле «Canon» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": ""
    },
    "code": {
        "type": "string",
        "max": 512,
        "required": true,
        "title": "Код товару",
        "description": "Публічний код товару, картки або іншого запису, як він відображається у програмі.",
        "group": "Основні",
        "example": "1001"
    },
    "type_code": {
        "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-goods-save-size-selection-0001

{
    "method": "goods.save_size_selection",
    "params": {
        "code": "1001"
    },
    "id": "example-goods-save-size-selection"
}

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

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

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

Пов’язані методи

goods.save_sostavЗберігає склад і кількість компонентів складеного товару. запис catalog.write з 0.4.0

Зберігає склад і кількість компонентів складеного товару.

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

Параметри params

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

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

string
обов’язковийПриклад: "1001"
Основні
codeКод товару

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

string
обов’язковийПриклад: "1001"
modeРежим операції

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

  • set — встановити значення
  • delete — видалити запис
  • add_replace — додати або замінити складову
  • add_quant — збільшити кількість складової
enum
необов’язковийПриклад: "set"За замовчуванням: "set"
Суми та кількості
quantКількість

Кількість товару як десятковий рядок; для вагового товару дозволена дробова частина.

decimal · decimal-string · product-unit
необов’язковийПриклад: "1.000"За замовчуванням: "0"
Точна схема параметрів 
{
    "child_code": {
        "type": "string",
        "max": 512,
        "required": true,
        "title": "Код складової",
        "description": "Поле «Код складової» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": "1001"
    },
    "code": {
        "type": "string",
        "max": 512,
        "required": true,
        "title": "Код товару",
        "description": "Публічний код товару, картки або іншого запису, як він відображається у програмі.",
        "group": "Основні",
        "example": "1001"
    },
    "mode": {
        "type": "enum",
        "values": [
            "set",
            "delete",
            "add_replace",
            "add_quant"
        ],
        "default": "set",
        "title": "Режим операції",
        "description": "Вибирає один із підтримуваних сценаріїв операції. Значення та їх зміст наведено у списку варіантів.",
        "group": "Основні",
        "example": "set",
        "enum_labels": {
            "set": "встановити значення",
            "delete": "видалити запис",
            "add_replace": "додати або замінити складову",
            "add_quant": "збільшити кількість складової"
        }
    },
    "quant": {
        "type": "decimal",
        "max": 32,
        "scale": 8,
        "default": "0",
        "title": "Кількість",
        "description": "Кількість товару як десятковий рядок; для вагового товару дозволена дробова частина.",
        "group": "Суми та кількості",
        "format": "decimal-string",
        "unit": "product-unit",
        "example": "1.000"
    }
}

Результат

Форма відповіді: 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-goods-save-sostav-0001

{
    "method": "goods.save_sostav",
    "params": {
        "code": "2002",
        "child_code": "1001",
        "mode": "add_replace",
        "quant": "0.250"
    },
    "id": "example-goods-save-sostav"
}

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

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

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

Пов’язані методи

goods.save_uktzed_etaxЗберігає код УКТ ЗЕД та ознаку вхідного акцизу товару. запис catalog.write з 0.4.0

Зберігає код УКТ ЗЕД та ознаку вхідного акцизу товару.

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

Параметри params

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

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

string
обов’язковийПриклад: "1001"
Додаткові
etaxОзнака вхідного акцизу

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

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

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

string
необов’язковийПриклад: ""За замовчуванням: ""
Точна схема параметрів 
{
    "code": {
        "type": "string",
        "max": 512,
        "required": true,
        "title": "Код товару",
        "description": "Публічний код товару, картки або іншого запису, як він відображається у програмі.",
        "group": "Основні",
        "example": "1001"
    },
    "etax": {
        "type": "bool",
        "default": false,
        "title": "Ознака вхідного акцизу",
        "description": "Визначає, чи застосовувати параметр «Ознака вхідного акцизу». Передавайте JSON true або false.",
        "group": "Додаткові",
        "example": false
    },
    "uktzed": {
        "type": "string",
        "max": 4096,
        "default": "",
        "title": "Код УКТ ЗЕД",
        "description": "Поле «Код УКТ ЗЕД» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": ""
    }
}

Результат

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

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

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

{
    "method": "goods.save_uktzed_etax",
    "params": {
        "code": "1001"
    },
    "id": "example-goods-save-uktzed-etax"
}

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

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

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

Пов’язані методи

goods.set_extra_names_visibleЗмінює перелік додаткових полів, видимих у картці товару. запис catalog.write з 0.4.0

Змінює перелік додаткових полів, видимих у картці товару.

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

Параметри params

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

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

bool
необов’язковийПриклад: falseЗа замовчуванням: false
Точна схема параметрів 
{
    "ismain": {
        "type": "bool",
        "default": false,
        "title": "Основне поле",
        "description": "Визначає, чи застосовувати параметр «Основне поле». Передавайте JSON true або false.",
        "group": "Додаткові",
        "example": false
    }
}

Результат

Форма відповіді: 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-goods-set-extra-names-visible-0001

{
    "method": "goods.set_extra_names_visible",
    "params": {
        "ismain": true
    },
    "id": "example-goods-set-extra-names-visible"
}

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

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

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

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

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

Параметри params

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

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

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

Результат

Форма відповіді: rows
ПолеЗмістТипПриклад
codeКод товаруПовернене значення «Код товару» відповідного запису, документа або підсумку ARM20.string"1001"
nameНазваПовернене значення «Назва» відповідного запису, документа або підсумку ARM20.string"Тестовий товар"
costСобівартістьТочне повернене значення «Собівартість» як десятковий рядок із крапкою.string · decimal-string · currency-of-operation"100.00"
priceЦінаТочне повернене значення «Ціна» як десятковий рядок із крапкою.string · decimal-string · currency-of-operation"100.00"
unit_typeОдиниця виміруПовернене значення «Одиниця виміру» відповідного запису, документа або підсумку ARM20.string"Приклад"
quantityКількістьТочне повернене значення «Кількість» як десятковий рядок із крапкою.string · decimal-string · product-unit"1.000"
Точна схема результату 
{
    "mode": "rows",
    "columns": [
        "code",
        "name",
        "cost",
        "price",
        "unit_type",
        "quantity"
    ],
    "field_specs": {
        "code": {
            "title": "Код товару",
            "description": "Повернене значення «Код товару» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "1001"
        },
        "name": {
            "title": "Назва",
            "description": "Повернене значення «Назва» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Тестовий товар"
        },
        "cost": {
            "title": "Собівартість",
            "description": "Точне повернене значення «Собівартість» як десятковий рядок із крапкою.",
            "type": "string",
            "format": "decimal-string",
            "unit": "currency-of-operation",
            "example": "100.00"
        },
        "price": {
            "title": "Ціна",
            "description": "Точне повернене значення «Ціна» як десятковий рядок із крапкою.",
            "type": "string",
            "format": "decimal-string",
            "unit": "currency-of-operation",
            "example": "100.00"
        },
        "unit_type": {
            "title": "Одиниця виміру",
            "description": "Повернене значення «Одиниця виміру» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        },
        "quantity": {
            "title": "Кількість",
            "description": "Точне повернене значення «Кількість» як десятковий рядок із крапкою.",
            "type": "string",
            "format": "decimal-string",
            "unit": "product-unit",
            "example": "1.000"
        }
    }
}

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

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

{
    "method": "goods.sostav_rows",
    "params": {
        "code": "1001"
    },
    "id": "example-goods-sostav-rows"
}

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

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

{
    "ok": true,
    "data": {
        "method": "goods.sostav_rows",
        "result": {
            "upstream": {
                "name": "UPMAPI",
                "version": "1",
                "resource": "goods"
            },
            "status": {
                "code": "OK",
                "operation": "sostav_rows",
                "value": "1"
            },
            "rows": [
                {
                    "code": "1001",
                    "name": "Тестовий товар",
                    "cost": "100.00",
                    "price": "100.00",
                    "unit_type": "Приклад",
                    "quantity": "1.000"
                }
            ]
        },
        "id": "example-goods-sostav-rows"
    },
    "request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
КодHTTPПричинаДія клієнта
INVALID_PARAMETER422Один із параметрів має неправильний тип, формат або значення.Виправити запит; автоматично не повторювати.
UPSTREAM_FAILURE502Сервер бізнес-операції недоступний або відхилив безпечний контракт.Дозволений повтор із backoff.
goods.uktzed_etaxПовертає код УКТ ЗЕД та ознаку вхідного акцизу товару. читання catalog.details.read з 0.4.0

Повертає код УКТ ЗЕД та ознаку вхідного акцизу товару.

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

Параметри params

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

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

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

Результат

Форма відповіді: rows
ПолеЗмістТипПриклад
uktzedКод УКТ ЗЕДПовернене значення «Код УКТ ЗЕД» відповідного запису, документа або підсумку ARM20.string"Приклад"
excise_inputExcise inputПовернене значення «Excise input» відповідного запису, документа або підсумку ARM20.string"Приклад"
Точна схема результату 
{
    "mode": "rows",
    "columns": [
        "uktzed",
        "excise_input"
    ],
    "field_specs": {
        "uktzed": {
            "title": "Код УКТ ЗЕД",
            "description": "Повернене значення «Код УКТ ЗЕД» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        },
        "excise_input": {
            "title": "Excise input",
            "description": "Повернене значення «Excise input» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        }
    }
}

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

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

{
    "method": "goods.uktzed_etax",
    "params": {
        "code": "1001"
    },
    "id": "example-goods-uktzed-etax"
}

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

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

{
    "ok": true,
    "data": {
        "method": "goods.uktzed_etax",
        "result": {
            "upstream": {
                "name": "UPMAPI",
                "version": "1",
                "resource": "goods"
            },
            "status": {
                "code": "OK",
                "operation": "uktzed_etax",
                "value": "1"
            },
            "rows": [
                {
                    "uktzed": "Приклад",
                    "excise_input": "Приклад"
                }
            ]
        },
        "id": "example-goods-uktzed-etax"
    },
    "request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
КодHTTPПричинаДія клієнта
INVALID_PARAMETER422Один із параметрів має неправильний тип, формат або значення.Виправити запит; автоматично не повторювати.
UPSTREAM_FAILURE502Сервер бізнес-операції недоступний або відхилив безпечний контракт.Дозволений повтор із backoff.
goods.update_extra_nameПерейменовує додаткове поле картки товару. запис catalog.write з 0.4.0

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

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

Параметри params

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

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

int
необов’язковийПриклад: 1За замовчуванням: 0
ismainОсновне поле

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

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

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

string
обов’язковийПриклад: "Тестовий товар"
Точна схема параметрів 
{
    "ind": {
        "type": "int",
        "min": -2147483648,
        "max": 2147483647,
        "default": 0,
        "title": "Ідентифікатор рядка",
        "description": "Ідентифікатор «Ідентифікатор рядка», отриманий із результату відповідного методу читання цієї бази.",
        "group": "Додаткові",
        "example": 1
    },
    "ismain": {
        "type": "bool",
        "default": false,
        "title": "Основне поле",
        "description": "Визначає, чи застосовувати параметр «Основне поле». Передавайте JSON true або false.",
        "group": "Додаткові",
        "example": false
    },
    "name": {
        "type": "string",
        "max": 512,
        "required": true,
        "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-goods-update-extra-name-0001

{
    "method": "goods.update_extra_name",
    "params": {
        "name": "Тестовий товар"
    },
    "id": "example-goods-update-extra-name"
}

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

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

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

Масова обробка товарів

12 методів
product_batch.add_to_tmpДодає вибрані товари до тимчасового списку масової обробки. запис catalog.write з 0.4.0

Додає вибрані товари до тимчасового списку масової обробки.

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

Параметри params

ПолеЩо означаєТип і форматПравила
Колекції
codesКоди товарів

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

array<string>
обов’язковийПриклад: []
Точна схема параметрів 
{
    "codes": {
        "type": "array",
        "required": true,
        "min_items": 1,
        "max_items": 300,
        "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
ПолеЗмістТипПриклад
affectedЗмінено записівКількість записів, які upstream фактично змінив.string"Приклад"
processedProcessedПовернене значення «Processed» відповідного запису, документа або підсумку ARM20.string"Приклад"
Точна схема результату 
{
    "mode": "status",
    "fields": [
        "affected",
        "processed"
    ],
    "field_specs": {
        "affected": {
            "title": "Змінено записів",
            "description": "Кількість записів, які upstream фактично змінив.",
            "type": "string",
            "example": "Приклад"
        },
        "processed": {
            "title": "Processed",
            "description": "Повернене значення «Processed» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        }
    }
}

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

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

{
    "method": "product_batch.add_to_tmp",
    "params": {
        "codes": [
            "Приклад"
        ]
    },
    "id": "example-product-batch-add-to-tmp"
}

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

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

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

Масово перераховує та зберігає ціни вибраних товарів.

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

Параметри params

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

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

string
необов’язковийПриклад: "Переоцінка"За замовчуванням: "Переоцінка"
update_main_skUpdate main sk

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

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

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

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

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

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

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

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

Визначає, чи застосовувати параметр «Write h nakl d». Передавайте JSON true або false.

bool
необов’язковийПриклад: falseЗа замовчуванням: false
Колекції
rowsРядки операції

Структурований масив рядків. Невідомі поля та порушення схеми відхиляються gateway.

array<object>
обов’язковийПриклад: []
Точна схема параметрів 
{
    "tact": {
        "type": "string",
        "max": 4096,
        "default": "Переоцінка",
        "title": "Тактовий номер",
        "description": "Поле «Тактовий номер» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": "Переоцінка"
    },
    "update_main_sk": {
        "type": "bool",
        "default": false,
        "title": "Update main sk",
        "description": "Визначає, чи застосовувати параметр «Update main sk». Передавайте JSON true або false.",
        "group": "Додаткові",
        "example": false
    },
    "update_nac": {
        "type": "bool",
        "default": false,
        "title": "Update nac",
        "description": "Визначає, чи застосовувати параметр «Update nac». Передавайте JSON true або false.",
        "group": "Додаткові",
        "example": false
    },
    "update_price": {
        "type": "bool",
        "default": true,
        "title": "Update price",
        "description": "Визначає, чи застосовувати параметр «Update price». Передавайте JSON true або false.",
        "group": "Додаткові",
        "example": false
    },
    "update_ss": {
        "type": "bool",
        "default": false,
        "title": "Update ss",
        "description": "Визначає, чи застосовувати параметр «Update ss». Передавайте JSON true або false.",
        "group": "Додаткові",
        "example": false
    },
    "write_h_nakl_d": {
        "type": "bool",
        "default": false,
        "title": "Write h nakl d",
        "description": "Визначає, чи застосовувати параметр «Write h nakl d». Передавайте JSON true або false.",
        "group": "Додаткові",
        "example": false
    },
    "rows": {
        "type": "array",
        "required": true,
        "min_items": 1,
        "max_items": 100,
        "items": {
            "type": "object",
            "fields": {
                "code": {
                    "type": "string",
                    "required": true,
                    "max": 190,
                    "pattern": "/^[^\\x00-\\x1F\\x7F]{1,190}$/uD",
                    "title": "Код товару",
                    "description": "Публічний код товару, картки або іншого запису, як він відображається у програмі.",
                    "group": "Основні",
                    "example": "1001"
                },
                "old_price": {
                    "type": "decimal",
                    "required": true,
                    "max": 32,
                    "scale": 8,
                    "title": "Попередня ціна",
                    "description": "Точне числове значення «Попередня ціна» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається.",
                    "group": "Суми та кількості",
                    "format": "decimal-string",
                    "unit": "currency-of-operation",
                    "example": "100.00"
                },
                "new_price": {
                    "type": "decimal",
                    "required": true,
                    "max": 32,
                    "scale": 8,
                    "title": "Нова ціна",
                    "description": "Точне числове значення «Нова ціна» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається.",
                    "group": "Суми та кількості",
                    "format": "decimal-string",
                    "unit": "currency-of-operation",
                    "example": "100.00"
                },
                "cost": {
                    "type": "decimal",
                    "max": 32,
                    "scale": 8,
                    "default": "0",
                    "title": "Собівартість",
                    "description": "Точне числове значення «Собівартість» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається.",
                    "group": "Суми та кількості",
                    "format": "decimal-string",
                    "unit": "currency-of-operation",
                    "example": "100.00"
                },
                "markup": {
                    "type": "decimal",
                    "max": 32,
                    "scale": 8,
                    "default": "0",
                    "title": "Націнка",
                    "description": "Точне числове значення «Націнка» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається.",
                    "group": "Суми та кількості",
                    "format": "decimal-string",
                    "unit": "percent",
                    "example": "100.00"
                },
                "currency_rate": {
                    "type": "decimal",
                    "max": 32,
                    "scale": 8,
                    "default": "",
                    "title": "Курс валюти",
                    "description": "Точне числове значення «Курс валюти» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається.",
                    "group": "Суми та кількості",
                    "format": "decimal-string",
                    "unit": "ratio",
                    "example": "100.00"
                },
                "document_number": {
                    "type": "string",
                    "max": 512,
                    "pattern": "/^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$/uD",
                    "default": "",
                    "title": "Номер документа",
                    "description": "Поле «Номер документа» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
                    "group": "Додаткові",
                    "example": "ПН-1001"
                },
                "currency": {
                    "type": "string",
                    "max": 64,
                    "pattern": "/^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$/uD",
                    "default": "",
                    "title": "Валюта",
                    "description": "Поле «Валюта» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
                    "group": "Додаткові",
                    "example": "UAH"
                }
            }
        },
        "title": "Рядки операції",
        "description": "Структурований масив рядків. Невідомі поля та порушення схеми відхиляються gateway.",
        "group": "Колекції",
        "example": []
    }
}

Результат

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

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

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

{
    "method": "product_batch.bulk_price_update",
    "params": {
        "rows": [
            {
                "code": "1001",
                "old_price": "10.00",
                "new_price": "12.00",
                "cost": "8.00",
                "markup": "50.00"
            }
        ]
    },
    "id": "example-product-batch-bulk-price-update"
}

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

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

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

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

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

Параметри params

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

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

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

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

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

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

bool
необов’язковийПриклад: falseЗа замовчуванням: false
Точна схема параметрів 
{
    "cleanup_bad_categories": {
        "type": "bool",
        "default": false,
        "title": "Cleanup bad categories",
        "description": "Визначає, чи застосовувати параметр «Cleanup bad categories». Передавайте JSON true або false.",
        "group": "Додаткові",
        "example": false
    },
    "cleanup_duplicate_categories": {
        "type": "bool",
        "default": false,
        "title": "Cleanup duplicate categories",
        "description": "Визначає, чи застосовувати параметр «Cleanup duplicate categories». Передавайте JSON true або false.",
        "group": "Додаткові",
        "example": false
    },
    "update_branch_prices": {
        "type": "bool",
        "default": false,
        "title": "Update branch prices",
        "description": "Визначає, чи застосовувати параметр «Update branch prices». Передавайте JSON true або false.",
        "group": "Додаткові",
        "example": false
    }
}

Результат

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

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

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

{
    "method": "product_batch.cleanup_after_import",
    "params": {
        "cleanup_bad_categories": true,
        "cleanup_duplicate_categories": true,
        "update_branch_prices": true
    },
    "id": "example-product-batch-cleanup-after-import"
}

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

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

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

Очищає весь тимчасовий список масової обробки товарів.

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

Параметри params

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

Результат

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

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

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

{
    "method": "product_batch.clear_tmp",
    "params": [],
    "id": "example-product-batch-clear-tmp"
}

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

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

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

Видаляє вибраний товар із тимчасового списку масової обробки.

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

Параметри params

ПолеЩо означаєТип і форматПравила
Колекції
codesКоди товарів

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

array<string>
обов’язковийПриклад: []
Точна схема параметрів 
{
    "codes": {
        "type": "array",
        "required": true,
        "min_items": 1,
        "max_items": 300,
        "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
ПолеЗмістТипПриклад
affectedЗмінено записівКількість записів, які upstream фактично змінив.string"Приклад"
processedProcessedПовернене значення «Processed» відповідного запису, документа або підсумку ARM20.string"Приклад"
Точна схема результату 
{
    "mode": "status",
    "fields": [
        "affected",
        "processed"
    ],
    "field_specs": {
        "affected": {
            "title": "Змінено записів",
            "description": "Кількість записів, які upstream фактично змінив.",
            "type": "string",
            "example": "Приклад"
        },
        "processed": {
            "title": "Processed",
            "description": "Повернене значення «Processed» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        }
    }
}

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

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

{
    "method": "product_batch.delete_from_tmp",
    "params": {
        "codes": [
            "Приклад"
        ]
    },
    "id": "example-product-batch-delete-from-tmp"
}

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

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

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

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

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

Параметри params

ПолеЩо означаєТип і форматПравила
Колекції
rowsРядки операції

Структурований масив рядків. Невідомі поля та порушення схеми відхиляються gateway.

array<object>
обов’язковийПриклад: []
extra_fieldsДодаткові поля

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

array<object>
необов’язковийПриклад: []
Точна схема параметрів 
{
    "rows": {
        "type": "array",
        "required": true,
        "min_items": 1,
        "max_items": 100,
        "items": {
            "type": "object",
            "fields": {
                "row_action": {
                    "type": "enum",
                    "required": true,
                    "values": [
                        "add",
                        "update",
                        "currency"
                    ],
                    "title": "Дія з товаром",
                    "description": "Варіант «Дія з товаром». Використовуйте лише одне зі значень, розшифрованих нижче.",
                    "group": "Додаткові",
                    "example": "add",
                    "enum_labels": {
                        "add": "додати товар",
                        "update": "оновити товар",
                        "currency": "оновити валютні дані"
                    }
                },
                "code": {
                    "type": "string",
                    "required": true,
                    "max": 190,
                    "pattern": "/^[^\\x00-\\x1F\\x7F]{1,190}$/uD",
                    "title": "Код товару",
                    "description": "Публічний код товару, картки або іншого запису, як він відображається у програмі.",
                    "group": "Основні",
                    "example": "1001"
                },
                "name": {
                    "type": "string",
                    "required": true,
                    "max": 512,
                    "pattern": "/^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]{1,512}$/uD",
                    "title": "Назва",
                    "description": "Поле «Назва» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
                    "group": "Основні",
                    "example": "Тестовий товар"
                },
                "cost": {
                    "type": "decimal",
                    "required": true,
                    "max": 32,
                    "scale": 8,
                    "title": "Собівартість",
                    "description": "Точне числове значення «Собівартість» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається.",
                    "group": "Суми та кількості",
                    "format": "decimal-string",
                    "unit": "currency-of-operation",
                    "example": "100.00"
                },
                "markup": {
                    "type": "decimal",
                    "required": true,
                    "max": 32,
                    "scale": 8,
                    "title": "Націнка",
                    "description": "Точне числове значення «Націнка» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається.",
                    "group": "Суми та кількості",
                    "format": "decimal-string",
                    "unit": "percent",
                    "example": "100.00"
                },
                "price": {
                    "type": "decimal",
                    "required": true,
                    "max": 32,
                    "scale": 8,
                    "title": "Ціна",
                    "description": "Ціна за одиницю товару як десятковий рядок без символу валюти.",
                    "group": "Суми та кількості",
                    "format": "decimal-string",
                    "unit": "currency-of-operation",
                    "example": "100.00"
                },
                "old_price": {
                    "type": "decimal",
                    "required": true,
                    "max": 32,
                    "scale": 8,
                    "title": "Попередня ціна",
                    "description": "Точне числове значення «Попередня ціна» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається.",
                    "group": "Суми та кількості",
                    "format": "decimal-string",
                    "unit": "currency-of-operation",
                    "example": "100.00"
                },
                "unit_type": {
                    "type": "int",
                    "min": 0,
                    "max": 2147483647,
                    "default": 0,
                    "title": "Одиниця виміру",
                    "description": "Поле «Одиниця виміру» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
                    "group": "Додаткові",
                    "example": 1
                },
                "supplier": {
                    "type": "string",
                    "max": 512,
                    "pattern": "/^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$/uD",
                    "default": "",
                    "title": "Постачальник",
                    "description": "Поле «Постачальник» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
                    "group": "Додаткові",
                    "example": ""
                },
                "category": {
                    "type": "string",
                    "max": 512,
                    "pattern": "/^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$/uD",
                    "default": "",
                    "title": "Категорія товару",
                    "description": "Поле «Категорія товару» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
                    "group": "Додаткові",
                    "example": ""
                },
                "currency_rate": {
                    "type": "decimal",
                    "max": 32,
                    "scale": 8,
                    "default": "",
                    "title": "Курс валюти",
                    "description": "Точне числове значення «Курс валюти» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається.",
                    "group": "Суми та кількості",
                    "format": "decimal-string",
                    "unit": "ratio",
                    "example": "100.00"
                }
            }
        },
        "title": "Рядки операції",
        "description": "Структурований масив рядків. Невідомі поля та порушення схеми відхиляються gateway.",
        "group": "Колекції",
        "example": []
    },
    "extra_fields": {
        "type": "array",
        "required": false,
        "min_items": 0,
        "max_items": 250,
        "items": {
            "type": "object",
            "fields": {
                "code": {
                    "type": "string",
                    "required": true,
                    "max": 190,
                    "pattern": "/^[^\\x00-\\x1F\\x7F]{1,190}$/uD",
                    "title": "Код товару",
                    "description": "Публічний код товару, картки або іншого запису, як він відображається у програмі.",
                    "group": "Основні",
                    "example": "1001"
                },
                "field_name": {
                    "type": "string",
                    "required": true,
                    "max": 190,
                    "pattern": "/^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]{1,190}$/uD",
                    "title": "Назва поля",
                    "description": "Поле «Назва поля» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
                    "group": "Додаткові",
                    "example": "Приклад"
                },
                "value": {
                    "type": "string",
                    "max": 4096,
                    "pattern": "/^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$/uD",
                    "default": "",
                    "title": "Значення",
                    "description": "Нове або шукане значення поля залежно від операції.",
                    "group": "Додаткові",
                    "example": ""
                }
            }
        },
        "title": "Додаткові поля",
        "description": "Список «Додаткові поля». Структуру одного елемента, обов’язкові поля та межі кількості наведено нижче.",
        "group": "Колекції",
        "example": []
    }
}

Результат

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

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

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

{
    "method": "product_batch.import_products",
    "params": {
        "rows": [
            {
                "row_action": "add",
                "code": "3003",
                "name": "Імпортований товар",
                "cost": "10.00",
                "markup": "20.00",
                "price": "12.00",
                "old_price": "11.00"
            }
        ],
        "extra_fields": [
            {
                "code": "3003",
                "field_name": "Опис",
                "value": "Демонстраційне значення"
            }
        ]
    },
    "id": "example-product-batch-import-products"
}

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

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

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

Перевіряє, які з імпортованих товарів уже є в довіднику.

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

Параметри params

ПолеЩо означаєТип і форматПравила
Колекції
codesКоди товарів

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

array<string>
обов’язковийПриклад: []
Точна схема параметрів 
{
    "codes": {
        "type": "array",
        "required": true,
        "min_items": 1,
        "max_items": 300,
        "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": []
    }
}

Результат

Форма відповіді: rows
ПолеЗмістТипПриклад
codeКод товаруПовернене значення «Код товару» відповідного запису, документа або підсумку ARM20.string"1001"
nameНазваПовернене значення «Назва» відповідного запису, документа або підсумку ARM20.string"Тестовий товар"
costСобівартістьТочне повернене значення «Собівартість» як десятковий рядок із крапкою.string · decimal-string · currency-of-operation"100.00"
priceЦінаТочне повернене значення «Ціна» як десятковий рядок із крапкою.string · decimal-string · currency-of-operation"100.00"
Точна схема результату 
{
    "mode": "rows",
    "columns": [
        "code",
        "name",
        "cost",
        "price"
    ],
    "field_specs": {
        "code": {
            "title": "Код товару",
            "description": "Повернене значення «Код товару» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "1001"
        },
        "name": {
            "title": "Назва",
            "description": "Повернене значення «Назва» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Тестовий товар"
        },
        "cost": {
            "title": "Собівартість",
            "description": "Точне повернене значення «Собівартість» як десятковий рядок із крапкою.",
            "type": "string",
            "format": "decimal-string",
            "unit": "currency-of-operation",
            "example": "100.00"
        },
        "price": {
            "title": "Ціна",
            "description": "Точне повернене значення «Ціна» як десятковий рядок із крапкою.",
            "type": "string",
            "format": "decimal-string",
            "unit": "currency-of-operation",
            "example": "100.00"
        }
    }
}

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

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

{
    "method": "product_batch.lookup_existing",
    "params": {
        "codes": [
            "Приклад"
        ]
    },
    "id": "example-product-batch-lookup-existing"
}

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

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

{
    "ok": true,
    "data": {
        "method": "product_batch.lookup_existing",
        "result": {
            "upstream": {
                "name": "UPMAPI",
                "version": "1",
                "resource": "product_batch"
            },
            "status": {
                "code": "OK",
                "operation": "lookup_existing",
                "value": "1"
            },
            "rows": [
                {
                    "code": "1001",
                    "name": "Тестовий товар",
                    "cost": "100.00",
                    "price": "100.00"
                }
            ]
        },
        "id": "example-product-batch-lookup-existing"
    },
    "request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
КодHTTPПричинаДія клієнта
INVALID_PARAMETER422Один із параметрів має неправильний тип, формат або значення.Виправити запит; автоматично не повторювати.
UPSTREAM_FAILURE502Сервер бізнес-операції недоступний або відхилив безпечний контракт.Дозволений повтор із backoff.
product_batch.mass_main_paramМасово змінює вибраний основний параметр карток товарів. запис catalog.write з 0.4.0

Масово змінює вибраний основний параметр карток товарів.

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

Параметри params

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

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

  • C2 — друге класифікаційне поле товару
  • Noskid — ознака заборони знижки
enum
обов’язковийПриклад: "C2"
valueЗначення

Нове або шукане значення поля залежно від операції.

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

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

array<string>
обов’язковийПриклад: []
Точна схема параметрів 
{
    "field": {
        "type": "enum",
        "values": [
            "C2",
            "Noskid"
        ],
        "required": true,
        "title": "Поле",
        "description": "Варіант «Поле». Використовуйте лише одне зі значень, розшифрованих нижче.",
        "group": "Додаткові",
        "example": "C2",
        "enum_labels": {
            "C2": "друге класифікаційне поле товару",
            "Noskid": "ознака заборони знижки"
        }
    },
    "value": {
        "type": "int",
        "required": true,
        "min": -2147483648,
        "max": 2147483647,
        "title": "Значення",
        "description": "Нове або шукане значення поля залежно від операції.",
        "group": "Додаткові",
        "example": 1
    },
    "codes": {
        "type": "array",
        "required": true,
        "min_items": 1,
        "max_items": 300,
        "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
ПолеЗмістТипПриклад
affectedЗмінено записівКількість записів, які upstream фактично змінив.string"Приклад"
processedProcessedПовернене значення «Processed» відповідного запису, документа або підсумку ARM20.string"Приклад"
Точна схема результату 
{
    "mode": "status",
    "fields": [
        "affected",
        "processed"
    ],
    "field_specs": {
        "affected": {
            "title": "Змінено записів",
            "description": "Кількість записів, які upstream фактично змінив.",
            "type": "string",
            "example": "Приклад"
        },
        "processed": {
            "title": "Processed",
            "description": "Повернене значення «Processed» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        }
    }
}

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

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

{
    "method": "product_batch.mass_main_param",
    "params": {
        "field": "C2",
        "value": 1,
        "codes": [
            "Приклад"
        ]
    },
    "id": "example-product-batch-mass-main-param"
}

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

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

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

Фіксує зміну ціни товару в історії.

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

Параметри params

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

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

string
обов’язковийПриклад: "1001"
Суми та кількості
new_priceНова ціна

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

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

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

string · decimal-string · currency-of-operation
необов’язковийПриклад: "100.00"За замовчуванням: "0"
Додаткові
tactТактовий номер

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

string
обов’язковийПриклад: "Приклад"
Точна схема параметрів 
{
    "code": {
        "type": "string",
        "max": 512,
        "required": true,
        "title": "Код товару",
        "description": "Публічний код товару, картки або іншого запису, як він відображається у програмі.",
        "group": "Основні",
        "example": "1001"
    },
    "new_price": {
        "type": "string",
        "max": 4096,
        "default": "0",
        "title": "Нова ціна",
        "description": "Точне числове значення «Нова ціна» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається.",
        "group": "Суми та кількості",
        "format": "decimal-string",
        "unit": "currency-of-operation",
        "example": "100.00"
    },
    "old_price": {
        "type": "string",
        "max": 4096,
        "default": "0",
        "title": "Попередня ціна",
        "description": "Точне числове значення «Попередня ціна» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається.",
        "group": "Суми та кількості",
        "format": "decimal-string",
        "unit": "currency-of-operation",
        "example": "100.00"
    },
    "tact": {
        "type": "string",
        "max": 4096,
        "required": true,
        "title": "Тактовий номер",
        "description": "Поле «Тактовий номер» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": "Приклад"
    }
}

Результат

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

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

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

{
    "method": "product_batch.record_price_change",
    "params": {
        "code": "1001",
        "tact": "Приклад"
    },
    "id": "example-product-batch-record-price-change"
}

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

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

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

Повертає валютні параметри вибраних товарів.

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

Параметри params

ПолеЩо означаєТип і форматПравила
Колекції
codesКоди товарів

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

array<string>
обов’язковийПриклад: []
Точна схема параметрів 
{
    "codes": {
        "type": "array",
        "required": true,
        "min_items": 1,
        "max_items": 300,
        "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": []
    }
}

Результат

Форма відповіді: rows
ПолеЗмістТипПриклад
codeКод товаруПовернене значення «Код товару» відповідного запису, документа або підсумку ARM20.string"1001"
nameНазваПовернене значення «Назва» відповідного запису, документа або підсумку ARM20.string"Тестовий товар"
costСобівартістьТочне повернене значення «Собівартість» як десятковий рядок із крапкою.string · decimal-string · currency-of-operation"100.00"
markupНацінкаТочне повернене значення «Націнка» як десятковий рядок із крапкою.string · decimal-string · percent"100.00"
priceЦінаТочне повернене значення «Ціна» як десятковий рядок із крапкою.string · decimal-string · currency-of-operation"100.00"
last_currency_rateLast currency rateТочне повернене значення «Last currency rate» як десятковий рядок із крапкою.string · decimal-string · ratio"100.00"
Точна схема результату 
{
    "mode": "rows",
    "columns": [
        "code",
        "name",
        "cost",
        "markup",
        "price",
        "last_currency_rate"
    ],
    "field_specs": {
        "code": {
            "title": "Код товару",
            "description": "Повернене значення «Код товару» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "1001"
        },
        "name": {
            "title": "Назва",
            "description": "Повернене значення «Назва» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Тестовий товар"
        },
        "cost": {
            "title": "Собівартість",
            "description": "Точне повернене значення «Собівартість» як десятковий рядок із крапкою.",
            "type": "string",
            "format": "decimal-string",
            "unit": "currency-of-operation",
            "example": "100.00"
        },
        "markup": {
            "title": "Націнка",
            "description": "Точне повернене значення «Націнка» як десятковий рядок із крапкою.",
            "type": "string",
            "format": "decimal-string",
            "unit": "percent",
            "example": "100.00"
        },
        "price": {
            "title": "Ціна",
            "description": "Точне повернене значення «Ціна» як десятковий рядок із крапкою.",
            "type": "string",
            "format": "decimal-string",
            "unit": "currency-of-operation",
            "example": "100.00"
        },
        "last_currency_rate": {
            "title": "Last currency rate",
            "description": "Точне повернене значення «Last currency rate» як десятковий рядок із крапкою.",
            "type": "string",
            "format": "decimal-string",
            "unit": "ratio",
            "example": "100.00"
        }
    }
}

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

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

{
    "method": "product_batch.selected_currency_rows",
    "params": {
        "codes": [
            "Приклад"
        ]
    },
    "id": "example-product-batch-selected-currency-rows"
}

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

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

{
    "ok": true,
    "data": {
        "method": "product_batch.selected_currency_rows",
        "result": {
            "upstream": {
                "name": "UPMAPI",
                "version": "1",
                "resource": "product_batch"
            },
            "status": {
                "code": "OK",
                "operation": "selected_currency_rows",
                "value": "1"
            },
            "rows": [
                {
                    "code": "1001",
                    "name": "Тестовий товар",
                    "cost": "100.00",
                    "markup": "100.00",
                    "price": "100.00",
                    "last_currency_rate": "100.00"
                }
            ]
        },
        "id": "example-product-batch-selected-currency-rows"
    },
    "request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
КодHTTPПричинаДія клієнта
INVALID_PARAMETER422Один із параметрів має неправильний тип, формат або значення.Виправити запит; автоматично не повторювати.
UPSTREAM_FAILURE502Сервер бізнес-операції недоступний або відхилив безпечний контракт.Дозволений повтор із backoff.

Пов’язані методи

product_batch.selected_price_rowsПовертає поточні ціни вибраних товарів. читання catalog.read з 0.4.0

Повертає поточні ціни вибраних товарів.

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

Параметри params

ПолеЩо означаєТип і форматПравила
Колекції
codesКоди товарів

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

array<string>
обов’язковийПриклад: []
Точна схема параметрів 
{
    "codes": {
        "type": "array",
        "required": true,
        "min_items": 1,
        "max_items": 300,
        "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": []
    }
}

Результат

Форма відповіді: rows
ПолеЗмістТипПриклад
codeКод товаруПовернене значення «Код товару» відповідного запису, документа або підсумку ARM20.string"1001"
nameНазваПовернене значення «Назва» відповідного запису, документа або підсумку ARM20.string"Тестовий товар"
costСобівартістьТочне повернене значення «Собівартість» як десятковий рядок із крапкою.string · decimal-string · currency-of-operation"100.00"
markupНацінкаТочне повернене значення «Націнка» як десятковий рядок із крапкою.string · decimal-string · percent"100.00"
priceЦінаТочне повернене значення «Ціна» як десятковий рядок із крапкою.string · decimal-string · currency-of-operation"100.00"
price_copyPrice copyТочне повернене значення «Price copy» як десятковий рядок із крапкою.string · decimal-string · currency-of-operation"100.00"
unit_typeОдиниця виміруПовернене значення «Одиниця виміру» відповідного запису, документа або підсумку ARM20.string"Приклад"
quantityКількістьТочне повернене значення «Кількість» як десятковий рядок із крапкою.string · decimal-string · product-unit"1.000"
price_sumPrice sumТочне повернене значення «Price sum» як десятковий рядок із крапкою.string · decimal-string · currency-of-operation"100.00"
Точна схема результату 
{
    "mode": "rows",
    "columns": [
        "code",
        "name",
        "cost",
        "markup",
        "price",
        "price_copy",
        "unit_type",
        "quantity",
        "price_sum"
    ],
    "field_specs": {
        "code": {
            "title": "Код товару",
            "description": "Повернене значення «Код товару» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "1001"
        },
        "name": {
            "title": "Назва",
            "description": "Повернене значення «Назва» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Тестовий товар"
        },
        "cost": {
            "title": "Собівартість",
            "description": "Точне повернене значення «Собівартість» як десятковий рядок із крапкою.",
            "type": "string",
            "format": "decimal-string",
            "unit": "currency-of-operation",
            "example": "100.00"
        },
        "markup": {
            "title": "Націнка",
            "description": "Точне повернене значення «Націнка» як десятковий рядок із крапкою.",
            "type": "string",
            "format": "decimal-string",
            "unit": "percent",
            "example": "100.00"
        },
        "price": {
            "title": "Ціна",
            "description": "Точне повернене значення «Ціна» як десятковий рядок із крапкою.",
            "type": "string",
            "format": "decimal-string",
            "unit": "currency-of-operation",
            "example": "100.00"
        },
        "price_copy": {
            "title": "Price copy",
            "description": "Точне повернене значення «Price copy» як десятковий рядок із крапкою.",
            "type": "string",
            "format": "decimal-string",
            "unit": "currency-of-operation",
            "example": "100.00"
        },
        "unit_type": {
            "title": "Одиниця виміру",
            "description": "Повернене значення «Одиниця виміру» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        },
        "quantity": {
            "title": "Кількість",
            "description": "Точне повернене значення «Кількість» як десятковий рядок із крапкою.",
            "type": "string",
            "format": "decimal-string",
            "unit": "product-unit",
            "example": "1.000"
        },
        "price_sum": {
            "title": "Price sum",
            "description": "Точне повернене значення «Price sum» як десятковий рядок із крапкою.",
            "type": "string",
            "format": "decimal-string",
            "unit": "currency-of-operation",
            "example": "100.00"
        }
    }
}

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

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

{
    "method": "product_batch.selected_price_rows",
    "params": {
        "codes": [
            "Приклад"
        ]
    },
    "id": "example-product-batch-selected-price-rows"
}

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

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

{
    "ok": true,
    "data": {
        "method": "product_batch.selected_price_rows",
        "result": {
            "upstream": {
                "name": "UPMAPI",
                "version": "1",
                "resource": "product_batch"
            },
            "status": {
                "code": "OK",
                "operation": "selected_price_rows",
                "value": "1"
            },
            "rows": [
                {
                    "code": "1001",
                    "name": "Тестовий товар",
                    "cost": "100.00",
                    "markup": "100.00",
                    "price": "100.00",
                    "price_copy": "100.00",
                    "unit_type": "Приклад",
                    "quantity": "1.000",
                    "price_sum": "100.00"
                }
            ]
        },
        "id": "example-product-batch-selected-price-rows"
    },
    "request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
КодHTTPПричинаДія клієнта
INVALID_PARAMETER422Один із параметрів має неправильний тип, формат або значення.Виправити запит; автоматично не повторювати.
UPSTREAM_FAILURE502Сервер бізнес-операції недоступний або відхилив безпечний контракт.Дозволений повтор із backoff.

Пов’язані методи

product_batch.update_h_nakl_pricesОновлює ціни в пов’язаних позиціях накладних після масової зміни. запис catalog.write з 0.4.0

Оновлює ціни в пов’язаних позиціях накладних після масової зміни.

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

Параметри params

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

Номер накладної у Windows Складі. Для створення нової накладної номер може згенерувати upstream.

string
обов’язковийПриклад: "ПН-1001"
Колекції
rowsРядки операції

Структурований масив рядків. Невідомі поля та порушення схеми відхиляються gateway.

array<object>
обов’язковийПриклад: []
Точна схема параметрів 
{
    "nn": {
        "type": "string",
        "max": 512,
        "required": true,
        "title": "Номер накладної",
        "description": "Номер накладної у Windows Складі. Для створення нової накладної номер може згенерувати upstream.",
        "group": "Основні",
        "example": "ПН-1001"
    },
    "rows": {
        "type": "array",
        "required": true,
        "min_items": 1,
        "max_items": 250,
        "items": {
            "type": "object",
            "fields": {
                "code": {
                    "type": "string",
                    "required": true,
                    "max": 190,
                    "pattern": "/^[^\\x00-\\x1F\\x7F]{1,190}$/uD",
                    "title": "Код товару",
                    "description": "Публічний код товару, картки або іншого запису, як він відображається у програмі.",
                    "group": "Основні",
                    "example": "1001"
                },
                "new_price": {
                    "type": "decimal",
                    "required": true,
                    "max": 32,
                    "scale": 8,
                    "title": "Нова ціна",
                    "description": "Точне числове значення «Нова ціна» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається.",
                    "group": "Суми та кількості",
                    "format": "decimal-string",
                    "unit": "currency-of-operation",
                    "example": "100.00"
                }
            }
        },
        "title": "Рядки операції",
        "description": "Структурований масив рядків. Невідомі поля та порушення схеми відхиляються gateway.",
        "group": "Колекції",
        "example": []
    }
}

Результат

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

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

POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
Idempotency-Key: example-product-batch-update-h-nakl-prices-0001

{
    "method": "product_batch.update_h_nakl_prices",
    "params": {
        "nn": "ПН-1001",
        "rows": [
            {
                "code": "1001",
                "new_price": "12.00"
            }
        ]
    },
    "id": "example-product-batch-update-h-nakl-prices"
}

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

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

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

Розпізнавання кодів

1 методів
product_lookup.find_codeРозпізнає товарний, ваговий, додатковий або дисконтний код. читання catalog.read з 0.4.0

Розпізнає товарний, ваговий, додатковий або дисконтний код.

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

Параметри params

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

Якщо true, пошук приймає коди, що містять літери.

bool
необов’язковийПриклад: falseЗа замовчуванням: false
pref_discПрефікс дисконтної картки

Префікс, за яким відсканований код розпізнається як дисконтна картка.

string
необов’язковийПриклад: ""За замовчуванням: ""
pref_vesПрефікс вагового штрихкоду

Префікс, за яким штрихкод розпізнається як ваговий.

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

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

string
необов’язковийПриклад: "1001"За замовчуванням: ""
Точна схема параметрів 
{
    "allow_alpha": {
        "type": "bool",
        "default": false,
        "title": "Дозволити літерний код",
        "description": "Якщо true, пошук приймає коди, що містять літери.",
        "group": "Додаткові",
        "example": false
    },
    "code": {
        "type": "string",
        "max": 512,
        "default": "",
        "title": "Код товару",
        "description": "Публічний код товару, картки або іншого запису, як він відображається у програмі.",
        "group": "Основні",
        "example": "1001"
    },
    "pref_disc": {
        "type": "string",
        "max": 4096,
        "default": "",
        "title": "Префікс дисконтної картки",
        "description": "Префікс, за яким відсканований код розпізнається як дисконтна картка.",
        "group": "Додаткові",
        "example": ""
    },
    "pref_ves": {
        "type": "string",
        "max": 4096,
        "default": "",
        "title": "Префікс вагового штрихкоду",
        "description": "Префікс, за яким штрихкод розпізнається як ваговий.",
        "group": "Додаткові",
        "example": ""
    }
}

Результат

Форма відповіді: rows
ПолеЗмістТипПриклад
typeТип операціїПовернене значення «Тип операції» відповідного запису, документа або підсумку ARM20.string"Приклад"
ei_flagОзнака одиниці виміруПовернене значення «Ознака одиниці виміру» відповідного запису, документа або підсумку ARM20.string"Приклад"
codeКод товаруПовернене значення «Код товару» відповідного запису, документа або підсумку ARM20.string"1001"
quantityКількістьТочне повернене значення «Кількість» як десятковий рядок із крапкою.string · decimal-string · product-unit"1.000"
Точна схема результату 
{
    "mode": "rows",
    "columns": [
        "type",
        "ei_flag",
        "code",
        "quantity"
    ],
    "field_specs": {
        "type": {
            "title": "Тип операції",
            "description": "Повернене значення «Тип операції» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        },
        "ei_flag": {
            "title": "Ознака одиниці виміру",
            "description": "Повернене значення «Ознака одиниці виміру» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        },
        "code": {
            "title": "Код товару",
            "description": "Повернене значення «Код товару» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "1001"
        },
        "quantity": {
            "title": "Кількість",
            "description": "Точне повернене значення «Кількість» як десятковий рядок із крапкою.",
            "type": "string",
            "format": "decimal-string",
            "unit": "product-unit",
            "example": "1.000"
        }
    }
}

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

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

{
    "method": "product_lookup.find_code",
    "params": {
        "code": "1001",
        "pref_ves": "20",
        "pref_disc": "99"
    },
    "id": "example-product-lookup-find-code"
}

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

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

{
    "ok": true,
    "data": {
        "method": "product_lookup.find_code",
        "result": {
            "upstream": {
                "name": "UPMAPI",
                "version": "1",
                "resource": "product_lookup"
            },
            "status": {
                "code": "OK",
                "operation": "find_code",
                "value": "1"
            },
            "rows": [
                {
                    "type": "Приклад",
                    "ei_flag": "Приклад",
                    "code": "1001",
                    "quantity": "1.000"
                }
            ]
        },
        "id": "example-product-lookup-find-code"
    },
    "request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
КодHTTPПричинаДія клієнта
INVALID_PARAMETER422Один із параметрів має неправильний тип, формат або значення.Виправити запит; автоматично не повторювати.
UPSTREAM_FAILURE502Сервер бізнес-операції недоступний або відхилив безпечний контракт.Дозволений повтор із backoff.
products

Пошук товарів

1 методів
products.find_codeРозпізнає товарний, ваговий, додатковий або дисконтний код. читання catalog.lookup з 0.4.0

Розпізнає товарний, ваговий, додатковий або дисконтний код.

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

Параметри params

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

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

string
обов’язковийПриклад: "1001"
Додаткові
pref_vesПрефікс вагового штрихкоду

Префікс, за яким штрихкод розпізнається як ваговий.

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

Префікс, за яким відсканований код розпізнається як дисконтна картка.

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

Якщо true, пошук приймає коди, що містять літери.

bool
необов’язковийПриклад: falseЗа замовчуванням: false
Точна схема параметрів 
{
    "code": {
        "type": "string",
        "required": true,
        "max": 128,
        "title": "Код товару",
        "description": "Публічний код товару, картки або іншого запису, як він відображається у програмі.",
        "group": "Основні",
        "example": "1001"
    },
    "pref_ves": {
        "type": "string",
        "max": 8,
        "default": "",
        "title": "Префікс вагового штрихкоду",
        "description": "Префікс, за яким штрихкод розпізнається як ваговий.",
        "group": "Додаткові",
        "example": ""
    },
    "pref_disc": {
        "type": "string",
        "max": 8,
        "default": "",
        "title": "Префікс дисконтної картки",
        "description": "Префікс, за яким відсканований код розпізнається як дисконтна картка.",
        "group": "Додаткові",
        "example": ""
    },
    "allow_alpha": {
        "type": "bool",
        "default": false,
        "title": "Дозволити літерний код",
        "description": "Якщо true, пошук приймає коди, що містять літери.",
        "group": "Додаткові",
        "example": false
    }
}

Результат

Форма відповіді: rows
ПолеЗмістТипПриклад
typeТип операціїПовернене значення «Тип операції» відповідного запису, документа або підсумку ARM20.string"Приклад"
ei_flagОзнака одиниці виміруПовернене значення «Ознака одиниці виміру» відповідного запису, документа або підсумку ARM20.string"Приклад"
codeКод товаруПовернене значення «Код товару» відповідного запису, документа або підсумку ARM20.string"1001"
quantityКількістьТочне повернене значення «Кількість» як десятковий рядок із крапкою.string · decimal-string · product-unit"1.000"
Точна схема результату 
{
    "mode": "rows",
    "columns": [
        "type",
        "ei_flag",
        "code",
        "quantity"
    ],
    "field_specs": {
        "type": {
            "title": "Тип операції",
            "description": "Повернене значення «Тип операції» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        },
        "ei_flag": {
            "title": "Ознака одиниці виміру",
            "description": "Повернене значення «Ознака одиниці виміру» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        },
        "code": {
            "title": "Код товару",
            "description": "Повернене значення «Код товару» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "1001"
        },
        "quantity": {
            "title": "Кількість",
            "description": "Точне повернене значення «Кількість» як десятковий рядок із крапкою.",
            "type": "string",
            "format": "decimal-string",
            "unit": "product-unit",
            "example": "1.000"
        }
    }
}

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

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

{
    "method": "products.find_code",
    "params": {
        "code": "1001",
        "pref_ves": "20",
        "pref_disc": "99"
    },
    "id": "example-products-find-code"
}

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

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

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