{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api13.arm20.com/v1/schemas/category.rename.json","title":"category.rename","description":"Перейменовує категорію товарів і зберігає її параметри.","type":"object","required":["request","response"],"additionalProperties":false,"properties":{"request":{"oneOf":[{"type":"object","required":["method","params"],"additionalProperties":false,"properties":{"method":{"const":"category.rename"},"params":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","maxLength":512,"minLength":1,"pattern":"^[^\\x00-\\x1F\\x7F]{3,512}$","title":"Назва","example":"Тестовий товар","description":"Поле «Назва» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","x-api13-group":"Основні"},"uin":{"type":"integer","minimum":1,"maximum":2147483647,"title":"Ідентифікатор запису","example":1,"description":"Внутрішній числовий ідентифікатор запису, отриманий методом читання відповідного довідника.","x-api13-group":"Основні"},"uktzed":{"type":"string","maxLength":4096,"default":"","title":"Код УКТ ЗЕД","example":"","description":"Поле «Код УКТ ЗЕД» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","x-api13-group":"Додаткові"},"uperc":{"type":"string","maxLength":32,"pattern":"^(?:(?:(?:0|[1-9][0-9]*)(?:\\.[0-9]{1,8})?|-(?:[1-9][0-9]*(?:\\.[0-9]{1,8})?|0\\.(?=[0-9]{0,7}[1-9])[0-9]{1,8})))?$","x-api13-scale":8,"description":"Точне числове значення «Націнка категорії» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається. Decimal encoded as a JSON string; at most 8 fractional digits.","default":"0","title":"Націнка категорії","format":"decimal-string","example":"100.00","x-api13-group":"Суми та кількості","x-api13-unit":"percent"},"nocloud":{"type":"boolean","default":false,"title":"Не публікувати у хмарі","example":false,"description":"Визначає, чи застосовувати параметр «Не публікувати у хмарі». Передавайте JSON true або false.","x-api13-group":"Додаткові"},"nominus":{"type":"boolean","default":false,"title":"Заборонити від’ємний залишок","example":false,"description":"Визначає, чи застосовувати параметр «Заборонити від’ємний залишок». Передавайте JSON true або false.","x-api13-group":"Додаткові"},"k_disc":{"type":"string","maxLength":32,"pattern":"^(?:(?:(?:0|[1-9][0-9]*)(?:\\.[0-9]{1,8})?|-(?:[1-9][0-9]*(?:\\.[0-9]{1,8})?|0\\.(?=[0-9]{0,7}[1-9])[0-9]{1,8})))?$","x-api13-scale":8,"description":"Точне числове значення «Коефіцієнт знижки» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається. Decimal encoded as a JSON string; at most 8 fractional digits.","default":"0","title":"Коефіцієнт знижки","format":"decimal-string","example":"100.00","x-api13-group":"Суми та кількості","x-api13-unit":"currency-of-operation"},"k_bonus":{"type":"string","maxLength":32,"pattern":"^(?:(?:(?:0|[1-9][0-9]*)(?:\\.[0-9]{1,8})?|-(?:[1-9][0-9]*(?:\\.[0-9]{1,8})?|0\\.(?=[0-9]{0,7}[1-9])[0-9]{1,8})))?$","x-api13-scale":8,"description":"Точне числове значення «Коефіцієнт бонусів» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається. Decimal encoded as a JSON string; at most 8 fractional digits.","default":"0","title":"Коефіцієнт бонусів","format":"decimal-string","example":"100.00","x-api13-group":"Суми та кількості","x-api13-unit":"currency-of-operation"}},"required":["name","uin"]},"id":{"type":["string","integer","null"]}}}]},"response":{"oneOf":[{"type":"object","required":["ok","data","request_id"],"additionalProperties":false,"properties":{"ok":{"const":true},"data":{"type":"object","required":["method","result","id"],"additionalProperties":false,"properties":{"method":{"const":"category.rename"},"result":{"type":"object","required":["upstream","status","rows"],"additionalProperties":false,"properties":{"upstream":{"type":"object","required":["name","version","resource"],"additionalProperties":false,"properties":{"name":{"const":"UPMAPI"},"version":{"type":"string"},"resource":{"type":"string"}}},"status":{"type":"object","required":["code","operation","category_id"],"additionalProperties":false,"properties":{"code":{"const":"OK"},"operation":{"type":"string"},"category_id":{"type":"string","title":"Ідентифікатор категорії","description":"Повернене значення «Ідентифікатор категорії» відповідного запису, документа або підсумку ARM20.","example":"Приклад"}}},"rows":{"type":"array","items":{},"maxItems":0}}},"id":{"type":["string","integer","null"]}}},"request_id":{"type":"string"}}}]}},"x-api13-operation":{"description":"Перейменовує категорію товарів і зберігає її параметри.","scope":"catalog.write","params":{"name":{"type":"string","required":true,"max":512,"pattern":"/^[^\\x00-\\x1F\\x7F]{3,512}$/uD","title":"Назва","description":"Поле «Назва» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","group":"Основні","example":"Тестовий товар"},"uin":{"type":"int","required":true,"min":1,"max":2147483647,"title":"Ідентифікатор запису","description":"Внутрішній числовий ідентифікатор запису, отриманий методом читання відповідного довідника.","group":"Основні","example":1},"uktzed":{"type":"string","max":4096,"default":"","title":"Код УКТ ЗЕД","description":"Поле «Код УКТ ЗЕД» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","group":"Додаткові","example":""},"uperc":{"type":"decimal","max":32,"scale":8,"default":"0","title":"Націнка категорії","description":"Точне числове значення «Націнка категорії» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається.","group":"Суми та кількості","format":"decimal-string","unit":"percent","example":"100.00"},"nocloud":{"type":"bool","default":false,"title":"Не публікувати у хмарі","description":"Визначає, чи застосовувати параметр «Не публікувати у хмарі». Передавайте JSON true або false.","group":"Додаткові","example":false},"nominus":{"type":"bool","default":false,"title":"Заборонити від’ємний залишок","description":"Визначає, чи застосовувати параметр «Заборонити від’ємний залишок». Передавайте JSON true або false.","group":"Додаткові","example":false},"k_disc":{"type":"decimal","max":32,"scale":8,"default":"0","title":"Коефіцієнт знижки","description":"Точне числове значення «Коефіцієнт знижки» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається.","group":"Суми та кількості","format":"decimal-string","unit":"currency-of-operation","example":"100.00"},"k_bonus":{"type":"decimal","max":32,"scale":8,"default":"0","title":"Коефіцієнт бонусів","description":"Точне числове значення «Коефіцієнт бонусів» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається.","group":"Суми та кількості","format":"decimal-string","unit":"currency-of-operation","example":"100.00"}},"result":{"mode":"status","fields":["category_id"],"field_specs":{"category_id":{"title":"Ідентифікатор категорії","description":"Повернене значення «Ідентифікатор категорії» відповідного запису, документа або підсумку ARM20.","type":"string","example":"Приклад"}}},"mutating":true,"idempotency_required":true,"since":"0.4.0","stability":"stable","deprecated":false,"aliases":["category","rename","Перейменовує категорію товарів і зберігає її параметри."],"errors":[{"code":"INVALID_PARAMETER","http":422,"description":"Один із параметрів має неправильний тип, формат або значення.","retry":"Виправити запит; автоматично не повторювати."},{"code":"UPSTREAM_FAILURE","http":502,"description":"Сервер бізнес-операції недоступний або відхилив безпечний контракт.","retry":"Не створювати новий Idempotency-Key; перевірити журнал і бізнес-об’єкт."},{"code":"IDEMPOTENCY_KEY_REQUIRED","http":422,"description":"Для виконання запису не передано Idempotency-Key.","retry":"Створити ключ для цієї бізнес-операції та повторити."},{"code":"IDEMPOTENCY_RESULT_UNKNOWN","http":409,"description":"Результат попередньої спроби невідомий; gateway не виконав запис повторно.","retry":"Звірити документ, чек або платіж; не створювати новий ключ автоматично."}],"related_methods":[]}}