{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api13.arm20.com/v1/schemas/pos.search_products.json","title":"pos.search_products","description":"Шукає товари за кодом, штрихкодом або частиною назви.","type":"object","required":["request","response"],"additionalProperties":false,"properties":{"request":{"oneOf":[{"type":"object","required":["method"],"additionalProperties":false,"properties":{"method":{"const":"pos.search_products"},"params":{"type":"object","additionalProperties":false,"properties":{"limit":{"type":"integer","minimum":1,"maximum":1001,"default":1001,"title":"Максимальна кількість рядків","example":1,"description":"Максимальна кількість рядків, яку потрібно повернути. Менше значення зменшує відповідь.","x-api13-group":"Додаткові"},"mode":{"type":"string","enum":["abc","num"],"default":"abc","title":"Режим операції","example":"abc","description":"Вибирає один із підтримуваних сценаріїв операції. Значення та їх зміст наведено у списку варіантів.","x-api13-group":"Основні","x-enumDescriptions":["сортувати за назвою","сортувати за номером"],"x-api13-enum-labels":{"abc":"сортувати за назвою","num":"сортувати за номером"}},"search":{"type":"string","maxLength":512,"default":"","title":"Пошуковий запит","example":"","description":"Поле «Пошуковий запит» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","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.search_products"},"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","maxItems":0},{"type":"array","items":{"type":"array","prefixItems":[{"type":"string","title":"code"},{"type":"string","title":"name"},{"type":"string","title":"price"},{"type":"string","title":"quantity"}],"items":false,"minItems":4,"maxItems":4},"minItems":1,"maxItems":1001},{"type":"array","items":{"type":"array","prefixItems":[{"type":"string","title":"code"},{"type":"string","title":"name"},{"type":"string","title":"price"},{"type":"string","title":"extra_value_1"},{"type":"string","title":"quantity"}],"items":false,"minItems":5,"maxItems":5},"minItems":1,"maxItems":1001},{"type":"array","items":{"type":"array","prefixItems":[{"type":"string","title":"code"},{"type":"string","title":"name"},{"type":"string","title":"price"},{"type":"string","title":"extra_value_1"},{"type":"string","title":"extra_value_2"},{"type":"string","title":"quantity"}],"items":false,"minItems":6,"maxItems":6},"minItems":1,"maxItems":1001},{"type":"array","items":{"type":"array","prefixItems":[{"type":"string","title":"code"},{"type":"string","title":"name"},{"type":"string","title":"price"},{"type":"string","title":"extra_value_1"},{"type":"string","title":"extra_value_2"},{"type":"string","title":"extra_value_3"},{"type":"string","title":"quantity"}],"items":false,"minItems":7,"maxItems":7},"minItems":1,"maxItems":1001},{"type":"array","items":{"type":"array","prefixItems":[{"type":"string","title":"code"},{"type":"string","title":"name"},{"type":"string","title":"price"},{"type":"string","title":"extra_value_1"},{"type":"string","title":"extra_value_2"},{"type":"string","title":"extra_value_3"},{"type":"string","title":"extra_value_4"},{"type":"string","title":"quantity"}],"items":false,"minItems":8,"maxItems":8},"minItems":1,"maxItems":1001},{"type":"array","items":{"type":"array","prefixItems":[{"type":"string","title":"code"},{"type":"string","title":"name"},{"type":"string","title":"price"},{"type":"string","title":"extra_value_1"},{"type":"string","title":"extra_value_2"},{"type":"string","title":"extra_value_3"},{"type":"string","title":"extra_value_4"},{"type":"string","title":"extra_value_5"},{"type":"string","title":"quantity"}],"items":false,"minItems":9,"maxItems":9},"minItems":1,"maxItems":1001},{"type":"array","items":{"type":"array","prefixItems":[{"type":"string","title":"code"},{"type":"string","title":"name"},{"type":"string","title":"price"},{"type":"string","title":"extra_value_1"},{"type":"string","title":"extra_value_2"},{"type":"string","title":"extra_value_3"},{"type":"string","title":"extra_value_4"},{"type":"string","title":"extra_value_5"},{"type":"string","title":"extra_value_6"},{"type":"string","title":"quantity"}],"items":false,"minItems":10,"maxItems":10},"minItems":1,"maxItems":1001},{"type":"array","items":{"type":"array","prefixItems":[{"type":"string","title":"code"},{"type":"string","title":"name"},{"type":"string","title":"price"},{"type":"string","title":"extra_value_1"},{"type":"string","title":"extra_value_2"},{"type":"string","title":"extra_value_3"},{"type":"string","title":"extra_value_4"},{"type":"string","title":"extra_value_5"},{"type":"string","title":"extra_value_6"},{"type":"string","title":"extra_value_7"},{"type":"string","title":"quantity"}],"items":false,"minItems":11,"maxItems":11},"minItems":1,"maxItems":1001},{"type":"array","items":{"type":"array","prefixItems":[{"type":"string","title":"code"},{"type":"string","title":"name"},{"type":"string","title":"price"},{"type":"string","title":"extra_value_1"},{"type":"string","title":"extra_value_2"},{"type":"string","title":"extra_value_3"},{"type":"string","title":"extra_value_4"},{"type":"string","title":"extra_value_5"},{"type":"string","title":"extra_value_6"},{"type":"string","title":"extra_value_7"},{"type":"string","title":"extra_value_8"},{"type":"string","title":"quantity"}],"items":false,"minItems":12,"maxItems":12},"minItems":1,"maxItems":1001},{"type":"array","items":{"type":"array","prefixItems":[{"type":"string","title":"code"},{"type":"string","title":"name"},{"type":"string","title":"price"},{"type":"string","title":"extra_value_1"},{"type":"string","title":"extra_value_2"},{"type":"string","title":"extra_value_3"},{"type":"string","title":"extra_value_4"},{"type":"string","title":"extra_value_5"},{"type":"string","title":"extra_value_6"},{"type":"string","title":"extra_value_7"},{"type":"string","title":"extra_value_8"},{"type":"string","title":"extra_value_9"},{"type":"string","title":"quantity"}],"items":false,"minItems":13,"maxItems":13},"minItems":1,"maxItems":1001},{"type":"array","items":{"type":"array","prefixItems":[{"type":"string","title":"code"},{"type":"string","title":"name"},{"type":"string","title":"price"},{"type":"string","title":"extra_value_1"},{"type":"string","title":"extra_value_2"},{"type":"string","title":"extra_value_3"},{"type":"string","title":"extra_value_4"},{"type":"string","title":"extra_value_5"},{"type":"string","title":"extra_value_6"},{"type":"string","title":"extra_value_7"},{"type":"string","title":"extra_value_8"},{"type":"string","title":"extra_value_9"},{"type":"string","title":"extra_value_10"},{"type":"string","title":"quantity"}],"items":false,"minItems":14,"maxItems":14},"minItems":1,"maxItems":1001},{"type":"array","items":{"type":"array","prefixItems":[{"type":"string","title":"code"},{"type":"string","title":"name"},{"type":"string","title":"price"},{"type":"string","title":"extra_value_1"},{"type":"string","title":"extra_value_2"},{"type":"string","title":"extra_value_3"},{"type":"string","title":"extra_value_4"},{"type":"string","title":"extra_value_5"},{"type":"string","title":"extra_value_6"},{"type":"string","title":"extra_value_7"},{"type":"string","title":"extra_value_8"},{"type":"string","title":"extra_value_9"},{"type":"string","title":"extra_value_10"},{"type":"string","title":"extra_value_11"},{"type":"string","title":"quantity"}],"items":false,"minItems":15,"maxItems":15},"minItems":1,"maxItems":1001},{"type":"array","items":{"type":"array","prefixItems":[{"type":"string","title":"code"},{"type":"string","title":"name"},{"type":"string","title":"price"},{"type":"string","title":"extra_value_1"},{"type":"string","title":"extra_value_2"},{"type":"string","title":"extra_value_3"},{"type":"string","title":"extra_value_4"},{"type":"string","title":"extra_value_5"},{"type":"string","title":"extra_value_6"},{"type":"string","title":"extra_value_7"},{"type":"string","title":"extra_value_8"},{"type":"string","title":"extra_value_9"},{"type":"string","title":"extra_value_10"},{"type":"string","title":"extra_value_11"},{"type":"string","title":"extra_value_12"},{"type":"string","title":"quantity"}],"items":false,"minItems":16,"maxItems":16},"minItems":1,"maxItems":1001},{"type":"array","items":{"type":"array","prefixItems":[{"type":"string","title":"code"},{"type":"string","title":"name"},{"type":"string","title":"price"},{"type":"string","title":"extra_value_1"},{"type":"string","title":"extra_value_2"},{"type":"string","title":"extra_value_3"},{"type":"string","title":"extra_value_4"},{"type":"string","title":"extra_value_5"},{"type":"string","title":"extra_value_6"},{"type":"string","title":"extra_value_7"},{"type":"string","title":"extra_value_8"},{"type":"string","title":"extra_value_9"},{"type":"string","title":"extra_value_10"},{"type":"string","title":"extra_value_11"},{"type":"string","title":"extra_value_12"},{"type":"string","title":"extra_value_13"},{"type":"string","title":"quantity"}],"items":false,"minItems":17,"maxItems":17},"minItems":1,"maxItems":1001},{"type":"array","items":{"type":"array","prefixItems":[{"type":"string","title":"code"},{"type":"string","title":"name"},{"type":"string","title":"price"},{"type":"string","title":"extra_value_1"},{"type":"string","title":"extra_value_2"},{"type":"string","title":"extra_value_3"},{"type":"string","title":"extra_value_4"},{"type":"string","title":"extra_value_5"},{"type":"string","title":"extra_value_6"},{"type":"string","title":"extra_value_7"},{"type":"string","title":"extra_value_8"},{"type":"string","title":"extra_value_9"},{"type":"string","title":"extra_value_10"},{"type":"string","title":"extra_value_11"},{"type":"string","title":"extra_value_12"},{"type":"string","title":"extra_value_13"},{"type":"string","title":"extra_value_14"},{"type":"string","title":"quantity"}],"items":false,"minItems":18,"maxItems":18},"minItems":1,"maxItems":1001},{"type":"array","items":{"type":"array","prefixItems":[{"type":"string","title":"code"},{"type":"string","title":"name"},{"type":"string","title":"price"},{"type":"string","title":"extra_value_1"},{"type":"string","title":"extra_value_2"},{"type":"string","title":"extra_value_3"},{"type":"string","title":"extra_value_4"},{"type":"string","title":"extra_value_5"},{"type":"string","title":"extra_value_6"},{"type":"string","title":"extra_value_7"},{"type":"string","title":"extra_value_8"},{"type":"string","title":"extra_value_9"},{"type":"string","title":"extra_value_10"},{"type":"string","title":"extra_value_11"},{"type":"string","title":"extra_value_12"},{"type":"string","title":"extra_value_13"},{"type":"string","title":"extra_value_14"},{"type":"string","title":"extra_value_15"},{"type":"string","title":"quantity"}],"items":false,"minItems":19,"maxItems":19},"minItems":1,"maxItems":1001},{"type":"array","items":{"type":"array","prefixItems":[{"type":"string","title":"code"},{"type":"string","title":"name"},{"type":"string","title":"price"},{"type":"string","title":"extra_value_1"},{"type":"string","title":"extra_value_2"},{"type":"string","title":"extra_value_3"},{"type":"string","title":"extra_value_4"},{"type":"string","title":"extra_value_5"},{"type":"string","title":"extra_value_6"},{"type":"string","title":"extra_value_7"},{"type":"string","title":"extra_value_8"},{"type":"string","title":"extra_value_9"},{"type":"string","title":"extra_value_10"},{"type":"string","title":"extra_value_11"},{"type":"string","title":"extra_value_12"},{"type":"string","title":"extra_value_13"},{"type":"string","title":"extra_value_14"},{"type":"string","title":"extra_value_15"},{"type":"string","title":"extra_value_16"},{"type":"string","title":"quantity"}],"items":false,"minItems":20,"maxItems":20},"minItems":1,"maxItems":1001},{"type":"array","items":{"type":"array","prefixItems":[{"type":"string","title":"code"},{"type":"string","title":"name"},{"type":"string","title":"price"},{"type":"string","title":"extra_value_1"},{"type":"string","title":"extra_value_2"},{"type":"string","title":"extra_value_3"},{"type":"string","title":"extra_value_4"},{"type":"string","title":"extra_value_5"},{"type":"string","title":"extra_value_6"},{"type":"string","title":"extra_value_7"},{"type":"string","title":"extra_value_8"},{"type":"string","title":"extra_value_9"},{"type":"string","title":"extra_value_10"},{"type":"string","title":"extra_value_11"},{"type":"string","title":"extra_value_12"},{"type":"string","title":"extra_value_13"},{"type":"string","title":"extra_value_14"},{"type":"string","title":"extra_value_15"},{"type":"string","title":"extra_value_16"},{"type":"string","title":"extra_value_17"},{"type":"string","title":"quantity"}],"items":false,"minItems":21,"maxItems":21},"minItems":1,"maxItems":1001},{"type":"array","items":{"type":"array","prefixItems":[{"type":"string","title":"code"},{"type":"string","title":"name"},{"type":"string","title":"price"},{"type":"string","title":"extra_value_1"},{"type":"string","title":"extra_value_2"},{"type":"string","title":"extra_value_3"},{"type":"string","title":"extra_value_4"},{"type":"string","title":"extra_value_5"},{"type":"string","title":"extra_value_6"},{"type":"string","title":"extra_value_7"},{"type":"string","title":"extra_value_8"},{"type":"string","title":"extra_value_9"},{"type":"string","title":"extra_value_10"},{"type":"string","title":"extra_value_11"},{"type":"string","title":"extra_value_12"},{"type":"string","title":"extra_value_13"},{"type":"string","title":"extra_value_14"},{"type":"string","title":"extra_value_15"},{"type":"string","title":"extra_value_16"},{"type":"string","title":"extra_value_17"},{"type":"string","title":"extra_value_18"},{"type":"string","title":"quantity"}],"items":false,"minItems":22,"maxItems":22},"minItems":1,"maxItems":1001},{"type":"array","items":{"type":"array","prefixItems":[{"type":"string","title":"code"},{"type":"string","title":"name"},{"type":"string","title":"price"},{"type":"string","title":"extra_value_1"},{"type":"string","title":"extra_value_2"},{"type":"string","title":"extra_value_3"},{"type":"string","title":"extra_value_4"},{"type":"string","title":"extra_value_5"},{"type":"string","title":"extra_value_6"},{"type":"string","title":"extra_value_7"},{"type":"string","title":"extra_value_8"},{"type":"string","title":"extra_value_9"},{"type":"string","title":"extra_value_10"},{"type":"string","title":"extra_value_11"},{"type":"string","title":"extra_value_12"},{"type":"string","title":"extra_value_13"},{"type":"string","title":"extra_value_14"},{"type":"string","title":"extra_value_15"},{"type":"string","title":"extra_value_16"},{"type":"string","title":"extra_value_17"},{"type":"string","title":"extra_value_18"},{"type":"string","title":"extra_value_19"},{"type":"string","title":"quantity"}],"items":false,"minItems":23,"maxItems":23},"minItems":1,"maxItems":1001},{"type":"array","items":{"type":"array","prefixItems":[{"type":"string","title":"code"},{"type":"string","title":"name"},{"type":"string","title":"price"},{"type":"string","title":"extra_value_1"},{"type":"string","title":"extra_value_2"},{"type":"string","title":"extra_value_3"},{"type":"string","title":"extra_value_4"},{"type":"string","title":"extra_value_5"},{"type":"string","title":"extra_value_6"},{"type":"string","title":"extra_value_7"},{"type":"string","title":"extra_value_8"},{"type":"string","title":"extra_value_9"},{"type":"string","title":"extra_value_10"},{"type":"string","title":"extra_value_11"},{"type":"string","title":"extra_value_12"},{"type":"string","title":"extra_value_13"},{"type":"string","title":"extra_value_14"},{"type":"string","title":"extra_value_15"},{"type":"string","title":"extra_value_16"},{"type":"string","title":"extra_value_17"},{"type":"string","title":"extra_value_18"},{"type":"string","title":"extra_value_19"},{"type":"string","title":"extra_value_20"},{"type":"string","title":"quantity"}],"items":false,"minItems":24,"maxItems":24},"minItems":1,"maxItems":1001}],"description":"At most 1001 product rows; all have one exact shared width and from zero to twenty extra values."}}},"id":{"type":["string","integer","null"]}}},"request_id":{"type":"string"}}}]}},"x-api13-operation":{"description":"Шукає товари за кодом, штрихкодом або частиною назви.","scope":"pos.read","params":{"limit":{"type":"int","min":1,"max":1001,"default":1001,"title":"Максимальна кількість рядків","description":"Максимальна кількість рядків, яку потрібно повернути. Менше значення зменшує відповідь.","group":"Додаткові","example":1},"mode":{"type":"enum","values":["abc","num"],"default":"abc","title":"Режим операції","description":"Вибирає один із підтримуваних сценаріїв операції. Значення та їх зміст наведено у списку варіантів.","group":"Основні","example":"abc","enum_labels":{"abc":"сортувати за назвою","num":"сортувати за номером"}},"search":{"type":"string","max":512,"default":"","title":"Пошуковий запит","description":"Поле «Пошуковий запит» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","group":"Додаткові","example":""},"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_search_products","row_shapes":{"product":["code","name","price","extra_values","quantity"]},"constraints":["Не більше 1001 рядка; усі мають однакову ширину та від нуля до двадцяти додаткових значень."],"field_specs":{"code":{"title":"Код товару","description":"Повернене значення «Код товару» відповідного запису, документа або підсумку ARM20.","type":"string","example":"1001"},"name":{"title":"Назва","description":"Повернене значення «Назва» відповідного запису, документа або підсумку ARM20.","type":"string","example":"Тестовий товар"},"price":{"title":"Ціна","description":"Точне повернене значення «Ціна» як десятковий рядок із крапкою.","type":"string","format":"decimal-string","unit":"currency-of-operation","example":"100.00"},"extra_values":{"title":"Extra values","description":"Повернене значення «Extra values» відповідного запису, документа або підсумку ARM20.","type":"string","example":"Приклад"},"quantity":{"title":"Кількість","description":"Точне повернене значення «Кількість» як десятковий рядок із крапкою.","type":"string","format":"decimal-string","unit":"product-unit","example":"1.000"}}},"mutating":false,"idempotency_required":false,"since":"0.4.0","stability":"stable","deprecated":false,"aliases":["pos","search products","Шукає товари за кодом, штрихкодом або частиною назви.","Windows Каса"],"errors":[{"code":"INVALID_PARAMETER","http":422,"description":"Один із параметрів має неправильний тип, формат або значення.","retry":"Виправити запит; автоматично не повторювати."},{"code":"UPSTREAM_FAILURE","http":502,"description":"Сервер бізнес-операції недоступний або відхилив безпечний контракт.","retry":"Дозволений повтор із backoff."}],"related_methods":[]}}