{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api13.arm20.com/v1/schemas/nakl.scan_add_one.json","title":"nakl.scan_add_one","description":"Додає одну одиницю відсканованого товару до накладної.","type":"object","required":["request","response"],"additionalProperties":false,"properties":{"request":{"oneOf":[{"type":"object","required":["method","params"],"additionalProperties":false,"properties":{"method":{"const":"nakl.scan_add_one"},"params":{"type":"object","additionalProperties":false,"properties":{"allow_alpha":{"type":"boolean","default":false,"title":"Дозволити літерний код","example":false,"description":"Якщо true, пошук приймає коди, що містять літери.","x-api13-group":"Додаткові"},"code":{"type":"string","maxLength":512,"minLength":1,"title":"Код запису","example":"1001","description":"Публічний код товару, картки або іншого запису, як він відображається у програмі.","x-api13-group":"Основні"},"currency":{"type":"string","maxLength":4096,"default":"","title":"Валюта","example":"UAH","description":"Поле «Валюта» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","x-api13-group":"Додаткові"},"kurs":{"type":"string","maxLength":4096,"default":"0","title":"Курс валюти","format":"decimal-string","example":"100.00","description":"Курс валюти як десятковий рядок. Для гривні зазвичай передається 1.0000.","x-api13-group":"Суми та кількості","x-api13-unit":"ratio"},"nn":{"type":"string","maxLength":512,"minLength":1,"title":"Номер накладної","example":"ПН-1001","description":"Номер накладної у Windows Складі. Для створення нової накладної номер може згенерувати upstream.","x-api13-group":"Основні"},"pref_disc":{"type":"string","maxLength":4096,"default":"","title":"Префікс дисконтної картки","example":"","description":"Префікс, за яким відсканований код розпізнається як дисконтна картка.","x-api13-group":"Додаткові"},"pref_ves":{"type":"string","maxLength":4096,"default":"","title":"Префікс вагового штрихкоду","example":"","description":"Префікс, за яким штрихкод розпізнається як ваговий.","x-api13-group":"Додаткові"}},"required":["code","nn"]},"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":"nakl.scan_add_one"},"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","value"],"additionalProperties":false,"properties":{"code":{"const":"OK"},"operation":{"type":"string"},"value":{"type":"string"}}},"rows":{"type":"array","items":{"type":"object","required":["result","lookup_type","code","quantity_or_value","reason","replayed"],"additionalProperties":false,"properties":{"result":{"type":"string","title":"Result","description":"Повернене значення «Result» відповідного запису, документа або підсумку ARM20.","example":"Приклад"},"lookup_type":{"type":"string","title":"Lookup type","description":"Повернене значення «Lookup type» відповідного запису, документа або підсумку ARM20.","example":"Приклад"},"code":{"type":"string","title":"Код запису","description":"Повернене значення «Код запису» відповідного запису, документа або підсумку ARM20.","example":"1001"},"quantity_or_value":{"type":"string","title":"Quantity or value","description":"Точне повернене значення «Quantity or value» як десятковий рядок із крапкою.","format":"decimal-string","example":"100.00","x-api13-unit":"product-unit"},"reason":{"type":"string","title":"Причина операції","description":"Повернене значення «Причина операції» відповідного запису, документа або підсумку ARM20.","example":"Приклад"},"replayed":{"type":"string","title":"Replayed","description":"Повернене значення «Replayed» відповідного запису, документа або підсумку ARM20.","example":"Приклад"}}}}}},"id":{"type":["string","integer","null"]}}},"request_id":{"type":"string"}}}]}},"x-api13-operation":{"description":"Додає одну одиницю відсканованого товару до накладної.","scope":"inventory.write","params":{"allow_alpha":{"type":"bool","default":false,"title":"Дозволити літерний код","description":"Якщо true, пошук приймає коди, що містять літери.","group":"Додаткові","example":false},"code":{"type":"string","max":512,"required":true,"title":"Код запису","description":"Публічний код товару, картки або іншого запису, як він відображається у програмі.","group":"Основні","example":"1001"},"currency":{"type":"string","max":4096,"default":"","title":"Валюта","description":"Поле «Валюта» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","group":"Додаткові","example":"UAH"},"kurs":{"type":"string","max":4096,"default":"0","title":"Курс валюти","description":"Курс валюти як десятковий рядок. Для гривні зазвичай передається 1.0000.","group":"Суми та кількості","format":"decimal-string","unit":"ratio","example":"100.00"},"nn":{"type":"string","max":512,"required":true,"title":"Номер накладної","description":"Номер накладної у Windows Складі. Для створення нової накладної номер може згенерувати upstream.","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":""}},"result":{"mode":"rows","columns":["result","lookup_type","code","quantity_or_value","reason","replayed"],"field_specs":{"result":{"title":"Result","description":"Повернене значення «Result» відповідного запису, документа або підсумку ARM20.","type":"string","example":"Приклад"},"lookup_type":{"title":"Lookup type","description":"Повернене значення «Lookup type» відповідного запису, документа або підсумку ARM20.","type":"string","example":"Приклад"},"code":{"title":"Код запису","description":"Повернене значення «Код запису» відповідного запису, документа або підсумку ARM20.","type":"string","example":"1001"},"quantity_or_value":{"title":"Quantity or value","description":"Точне повернене значення «Quantity or value» як десятковий рядок із крапкою.","type":"string","format":"decimal-string","unit":"product-unit","example":"100.00"},"reason":{"title":"Причина операції","description":"Повернене значення «Причина операції» відповідного запису, документа або підсумку ARM20.","type":"string","example":"Приклад"},"replayed":{"title":"Replayed","description":"Повернене значення «Replayed» відповідного запису, документа або підсумку ARM20.","type":"string","example":"Приклад"}}},"mutating":true,"idempotency_required":true,"since":"0.4.0","stability":"stable","deprecated":false,"aliases":["nakl","scan add one","Додає одну одиницю відсканованого товару до накладної.","накладна","документ складу"],"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":[]}}