{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api13.arm20.com/v1/schemas/pos.scan_product_info.json","title":"pos.scan_product_info","description":"Повертає дані відсканованого товару для додавання до чека.","type":"object","required":["request","response"],"additionalProperties":false,"properties":{"request":{"oneOf":[{"type":"object","required":["method"],"additionalProperties":false,"properties":{"method":{"const":"pos.scan_product_info"},"params":{"type":"object","additionalProperties":false,"properties":{"code":{"type":"string","maxLength":512,"default":"","title":"Код товару","example":"1001","description":"Публічний код товару, картки або іншого запису, як він відображається у програмі.","x-api13-group":"Основні"},"sk":{"type":"integer","minimum":-2147483648,"maximum":2147483647,"default":0,"title":"Номер складу або філії","example":1,"description":"Номер складу/філії відповідно до налаштувань бази; 0 зазвичай означає основний склад.","x-api13-group":"Додаткові"},"storage":{"type":"string","enum":["main","branch"],"default":"main","title":"Склад","example":"main","description":"Логічний склад: main — основний, branch — філіальний.","x-api13-group":"Основні","x-enumDescriptions":["основний склад","філіальний склад"],"x-api13-enum-labels":{"main":"основний склад","branch":"філіальний склад"}}}},"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":"pos.scan_product_info"},"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":{"oneOf":[{"type":"array","items":{"type":"array","prefixItems":[{"const":"EXTRA","title":"tag"},{"type":"string","title":"field_id"},{"type":"string","title":"field_name"}],"items":false,"minItems":3,"maxItems":3},"maxItems":248},{"type":"array","prefixItems":[{"type":"array","prefixItems":[{"const":"PRODUCT","title":"tag"},{"type":"string","title":"code"},{"type":"string","title":"name"},{"type":"string","title":"unit_type"},{"type":"string","title":"price"},{"type":"string","title":"no_discount"},{"type":"string","title":"quantity"},{"type":"string","title":"description"}],"items":{"type":"string","title":"extra_value"},"minItems":8,"maxItems":256}],"items":{"type":"array","prefixItems":[{"const":"EXTRA","title":"tag"},{"type":"string","title":"field_id"},{"type":"string","title":"field_name"}],"items":false,"minItems":3,"maxItems":3},"minItems":1,"maxItems":249}],"description":"When PRODUCT is present it is first, and its trailing values correspond one-to-one with the following EXTRA rows."}}},"id":{"type":["string","integer","null"]}}},"request_id":{"type":"string"}}}]}},"x-api13-operation":{"description":"Повертає дані відсканованого товару для додавання до чека.","scope":"pos.read","params":{"code":{"type":"string","max":512,"default":"","title":"Код товару","description":"Публічний код товару, картки або іншого запису, як він відображається у програмі.","group":"Основні","example":"1001"},"sk":{"type":"int","min":-2147483648,"max":2147483647,"default":0,"title":"Номер складу або філії","description":"Номер складу/філії відповідно до налаштувань бази; 0 зазвичай означає основний склад.","group":"Додаткові","example":1},"storage":{"type":"enum","values":["main","branch"],"default":"main","title":"Склад","description":"Логічний склад: main — основний, branch — філіальний.","group":"Основні","example":"main","enum_labels":{"main":"основний склад","branch":"філіальний склад"}}},"result":{"mode":"variable_rows","contract":"pos_scan_product_info","row_shapes":{"product":["tag","code","name","unit_type","price","no_discount","quantity","description","extra_values"],"extra":["tag","field_id","field_name"]},"constraints":["Необов’язковий рядок товару завжди перший.","Його додаткові значення відповідають наступним рядкам додаткових полів один до одного."],"field_specs":{"tag":{"title":"Tag","description":"Повернене значення «Tag» відповідного запису, документа або підсумку ARM20.","type":"string","example":"Приклад"},"code":{"title":"Код товару","description":"Повернене значення «Код товару» відповідного запису, документа або підсумку ARM20.","type":"string","example":"1001"},"name":{"title":"Назва","description":"Повернене значення «Назва» відповідного запису, документа або підсумку ARM20.","type":"string","example":"Тестовий товар"},"unit_type":{"title":"Одиниця виміру","description":"Повернене значення «Одиниця виміру» відповідного запису, документа або підсумку ARM20.","type":"string","example":"Приклад"},"price":{"title":"Ціна","description":"Точне повернене значення «Ціна» як десятковий рядок із крапкою.","type":"string","format":"decimal-string","unit":"currency-of-operation","example":"100.00"},"no_discount":{"title":"Заборонити знижку","description":"Повернене значення «Заборонити знижку» відповідного запису, документа або підсумку ARM20.","type":"string","example":"Приклад"},"quantity":{"title":"Кількість","description":"Точне повернене значення «Кількість» як десятковий рядок із крапкою.","type":"string","format":"decimal-string","unit":"product-unit","example":"1.000"},"description":{"title":"Опис","description":"Повернене значення «Опис» відповідного запису, документа або підсумку ARM20.","type":"string","example":"Приклад"},"extra_values":{"title":"Extra values","description":"Повернене значення «Extra values» відповідного запису, документа або підсумку ARM20.","type":"string","example":"Приклад"},"field_id":{"title":"Field id","description":"Повернене значення «Field id» відповідного запису, документа або підсумку ARM20.","type":"string","example":"Приклад"},"field_name":{"title":"Назва поля","description":"Повернене значення «Назва поля» відповідного запису, документа або підсумку ARM20.","type":"string","example":"Приклад"}}},"mutating":false,"idempotency_required":false,"since":"0.4.0","stability":"stable","deprecated":false,"aliases":["pos","scan product info","Повертає дані відсканованого товару для додавання до чека.","Windows Каса"],"errors":[{"code":"INVALID_PARAMETER","http":422,"description":"Один із параметрів має неправильний тип, формат або значення.","retry":"Виправити запит; автоматично не повторювати."},{"code":"UPSTREAM_FAILURE","http":502,"description":"Сервер бізнес-операції недоступний або відхилив безпечний контракт.","retry":"Дозволений повтор із backoff."}],"related_methods":["pos.scan_analogs","pos.scan_picture"]}}