{"openapi":"3.0.3","info":{"version":"","title":"HELIOS Kernel eShop API","description":"## Úvod\n\n**REST API** je rozšířený standard programového rozhranní pro integraci aplikací. Umožňuje srozumitelně a přehledně vystavit externím vývojářům funkcionalitu systému unifikovaným způsobem, který všichni znají. Má podporu ve vývojových nástrojích a jeho součástí je **standardní strukturovaná dokumentace**, která může být i interaktivní a umožňovat práci s konkrétními daty. \nFunkcionalitu vystavenou pomocí REST API pak dokáže externí vývojář využít pro snadnější vývoj integrací s externími systémy, bez větší potřeby komunikace s konzultantem nebo analytikem.\n\nObchodní firmy již standardně používají **automatizované zpracování elektronických objednávek**. Především e-shopy automaticky vystavují faktury, obesílají zákazníky informačními zprávami atp. Díky API umožníme e-shopům a dalším externím systémům snadnější propojení se s ERP.\n\nZákazník svou cestu e-shopem zakončuje vytvořením objednávky, kterou je nutné přenést do a zpracovat v HELIOSu. Díky API je objednávka **automaticky založena** a navazuje její zpracování.\n\nVystavené endpointy jsou určeny primárně pro dodavatele e-shopových řešení. Očekává se, že se e-shopy napojí na námi vystavené REST API a zvolí nejvhodnější periodicitu dotazování se na zdroje dle vlastního uvážení.\n\n## Vymezení\nNávrh řešení **postihuje**:\n\n### Potřeby pro E-shopy B2C\n\n - Registrace zákazníka (fyzické a právnické osoby) na eshopu\n\t - Včetně aktualizace údajů o zákazníkovi\n - Vytvoření objednávky z eshopu\n\t - Změna stavu platby objednávky na eshopu\n\t - Změna stavu platby objednávky v ERP\n - Uplatnění zákaznické slevy v objednávce\n - Nastavení zákaznických slev\n - Samostatnou aktualizaci stavu skladů, objednávek, cen\n### Potřeby pro E-shopy B2B\n - Registrace zákazníka (právnické osoby) na eshopu\n\t - Včetně aktualizace údajů o firmě\n- Vytvoření objednávky z eshopu\n\t- Změna stavu platby objednávky na eshopu\n\t- Změna stavu platby objednávky v ERP\n- Uplatnění zákaznické slevy v objednávce\n- Nastavení zákaznických slev\n- Nastavení ceníku pro konkrétního zákazníka\n- Samostatnou aktualizaci stavu skladů, objednávek, cen\n\nNávrh řešení **nepostihuje**:\n\n - Synchronizaci fakturace (fakturu firma vystavuje/tiskne v Heliosu, nikoliv v e-shopu)\n - Reklamace, storna objednávky\n - Jazykové mutace webu\n \n## Architektura\n![image info](./Architektura.jpg)\n\nE-shop komunikuje s vybraným Heliosem pomocí REST API.\n\nE-shop se dotazuje na zdroje dle svých potřeb (např. načtení produktů v nabídce, kterou zobrazuje zákazníkovi nebo stav existující objednávky atp.). \nE-shop API na základě dotazu na resource komunikuje s Heliosem, získá od něj zdrojová data, která předává ve formě odpovědi na dotaz e-shopu. \nE-shop API komunikuje s Heliosem, získá od něj zdrojová data, která předává ve formě REST API odpovědi na dotaz e-shopu.\n\n## Procesy\nVýčet hlavních procesů, které REST API řeší:\n\n- **Registrace zákazníka na eshopu** (POST/organizations)\n- **Aktualizace údajů o firmě** (PUT/organizations)\n- **Vytvoření objednávky z eshopu** (POST/orders)\n- **Změna stavu platby objednávky na eshopu** (PUT/orders)\n- **Změna stavu platby objednávky v ERP** (GET/orders)\n- **Načtení individuálních slev zákazníka** (GET/discounts)\n- **Načtení slev produktů z ERP** (GET/discounts)\n- **Načtení produktových dat z ERP** (GET/products)\n- **Načtení kategorií produktů** (GET/categories)\n- **Načtení organizací** (GET/organizations)\n- **Načtení ceníků** (GET/pricelists)\n- **Načtení stavu skladů** (GET/inventories)\n\n\n## Pořebná práva k přehledům\nAby API mohlo fungovat, je nutné, aby měl uživatel nastaven přístup k těmto přehledům:\n\n\n- Došlé objednávky (959)\n- Položky - došlé objednávky (962)\n- Organizace (1)\n- Kontaktní osoby (115)\n- Sortiment (776)\n- Kmenové karty výrobních čísel (1978)\n- Stav výrobních čísel (75)\n\n\n- Customers (2209)\n- Addresses (2210)\n- Contacts (2211)\n- Products (2213)\n- Images (2214)\n- Inventories (2217)\n- Categories (2218)\n- Orders (2219)\n- Order items (2220)\n- Variants (2224)\n- Price list (2226)\n- Price list products (2227)\n- Discounts (2228)\n\n"},"externalDocs":{"url":"https://public.helios.eu/inuvio/doc/cs/index.php?title=Kategorie:HELIOS_iNuvio_Server#Syst.C3.A9mov.C3.A9_API","description":"Dokumentace na wiki HELIOS iNuvio Server."},"servers":[],"paths":{"/api/v2/eshop/pricelists/{dbName}":{"get":{"tags":["Products"],"summary":"Pricelists","description":"Reads data about one pricelist.","parameters":[{"$ref":"#/components/parameters/dbNameParam"},{"$ref":"#/components/parameters/filterQParam"},{"$ref":"#/components/parameters/orderbyQParam"},{"$ref":"#/components/parameters/topQParam"},{"$ref":"#/components/parameters/skipQParam"}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/pricelistsResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResult"}}}},"500":{"description":"Server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResult"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResult"}}}}},"security":[{"OAUTHpassword":[]},{"accessToken":[]}]}},"/api/v2/eshop/orders/{dbName}/{orderId}":{"get":{"tags":["Orders"],"summary":"Order","description":"Reads data of one order.","parameters":[{"$ref":"#/components/parameters/dbNameParam"},{"in":"path","name":"orderId","description":"Order's ID.","required":true,"schema":{"type":"integer","format":"int32","nullable":false}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ordersResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResult"}}}},"500":{"description":"Server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResult"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResult"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResult"}}}}},"security":[{"OAUTHpassword":[]},{"accessToken":[]}]},"put":{"tags":["Orders"],"summary":"Update order","description":"Updates an order.","requestBody":{"description":"Attributes of order.","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ordersBodyPUT"}}}},"parameters":[{"$ref":"#/components/parameters/dbNameParam"},{"in":"path","name":"orderId","description":"Order's ID.","required":true,"schema":{"type":"integer","format":"int32","nullable":false}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ordersBodyPOSTPUTResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResult"}}}},"500":{"description":"Server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResult"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResult"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResult"}}}}},"security":[{"OAUTHpassword":[]},{"accessToken":[]}]},"delete":{"tags":["Orders"],"summary":"Delete order","description":"Deletes an order.","parameters":[{"$ref":"#/components/parameters/dbNameParam"},{"in":"path","name":"orderId","description":"Order's ID.","required":true,"schema":{"type":"integer","format":"int32","nullable":false}}],"responses":{"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResult"}}}},"500":{"description":"Server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResult"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResult"}}}},"204":{"description":"No result","content":{"application/json":{"schema":{"type":"object","format":"none","nullable":false}}}}},"security":[{"OAUTHpassword":[]},{"accessToken":[]}]}},"/api/v2/eshop/inventories/{dbName}/{inventoryId}":{"get":{"tags":["Products"],"summary":"Inventories","description":"Reads data about one inventory.","parameters":[{"$ref":"#/components/parameters/dbNameParam"},{"in":"path","name":"inventoryId","description":"Inventory's ID.","required":true,"schema":{"type":"integer","format":"int32","nullable":false}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/inventoriesResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResult"}}}},"500":{"description":"Server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResult"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResult"}}}}},"security":[{"OAUTHpassword":[]},{"accessToken":[]}]}},"/api/v2/eshop/categories/{dbName}/{categoryId}":{"get":{"tags":["Products"],"summary":"Category","description":"Reads data of one category.","parameters":[{"$ref":"#/components/parameters/dbNameParam"},{"in":"path","name":"categoryId","description":"Category's ID.","required":true,"schema":{"type":"integer","format":"int32","nullable":false}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/categoriesResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResult"}}}},"500":{"description":"Server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResult"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResult"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResult"}}}}},"security":[{"OAUTHpassword":[]},{"accessToken":[]}]}},"/api/v2/eshop/products/{dbName}":{"get":{"tags":["Products"],"summary":"Products","description":"Reads data about all products.","parameters":[{"$ref":"#/components/parameters/dbNameParam"},{"$ref":"#/components/parameters/filterQParam"},{"$ref":"#/components/parameters/orderbyQParam"},{"$ref":"#/components/parameters/topQParam"},{"$ref":"#/components/parameters/skipQParam"}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/productsResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResult"}}}},"500":{"description":"Server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResult"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResult"}}}}},"security":[{"OAUTHpassword":[]},{"accessToken":[]}]}},"/api/v2/eshop/customers/{dbName}/{customerId}":{"get":{"tags":["Customers"],"summary":"Customer","description":"Reads data of one customer.","parameters":[{"$ref":"#/components/parameters/dbNameParam"},{"in":"path","name":"customerId","description":"Customer's ID.","required":true,"schema":{"type":"integer","format":"int32","nullable":false}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/customerResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResult"}}}},"500":{"description":"Server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResult"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResult"}}}}},"security":[{"OAUTHpassword":[]},{"accessToken":[]}]},"put":{"tags":["Customers"],"summary":"Update customer","description":"Updates data of one customer.","requestBody":{"description":"Attributes of customer.","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customerBodyPUT"}}}},"parameters":[{"$ref":"#/components/parameters/dbNameParam"},{"in":"path","name":"customerId","description":"Customer's ID.","required":true,"schema":{"type":"integer","format":"int32","nullable":false}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/customerBodyPOSTPUTResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResult"}}}},"500":{"description":"Server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResult"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResult"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResult"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResult"}}}}},"security":[{"OAUTHpassword":[]},{"accessToken":[]}]}},"/api/v2/eshop/categories/{dbName}":{"get":{"tags":["Products"],"summary":"Categories","description":"Reads data about all categories.","parameters":[{"$ref":"#/components/parameters/dbNameParam"},{"$ref":"#/components/parameters/filterQParam"},{"$ref":"#/components/parameters/orderbyQParam"},{"$ref":"#/components/parameters/topQParam"},{"$ref":"#/components/parameters/skipQParam"}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/categoriesResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResult"}}}},"500":{"description":"Server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResult"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResult"}}}}},"security":[{"OAUTHpassword":[]},{"accessToken":[]}]}},"/api/v2/eshop/orders/{dbName}":{"get":{"tags":["Orders"],"summary":"Orders","description":"Reads data about all orders.","parameters":[{"$ref":"#/components/parameters/dbNameParam"},{"$ref":"#/components/parameters/filterQParam"},{"$ref":"#/components/parameters/orderbyQParam"},{"$ref":"#/components/parameters/topQParam"},{"$ref":"#/components/parameters/skipQParam"}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ordersResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResult"}}}},"500":{"description":"Server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResult"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResult"}}}}},"security":[{"OAUTHpassword":[]},{"accessToken":[]}]},"post":{"tags":["Orders"],"summary":"Create order","description":"Creates an order.","requestBody":{"description":"Attributes of order.","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ordersBodyPOST"}}}},"parameters":[{"$ref":"#/components/parameters/dbNameParam"}],"responses":{"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResult"}}}},"500":{"description":"Server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResult"}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ordersBodyPOSTPUTResult"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResult"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResult"}}}}},"security":[{"OAUTHpassword":[]},{"accessToken":[]}]}},"/api/v2/eshop/orders/{dbName}/{orderId}/items/{itemId}":{"delete":{"tags":["Orders"],"summary":"Delete order's item","description":"Deletes an order's item.","parameters":[{"$ref":"#/components/parameters/dbNameParam"},{"in":"path","name":"orderId","description":"Order's ID.","required":true,"schema":{"type":"integer","format":"int32","nullable":false}},{"in":"path","name":"itemId","description":"Order's item ID.","required":true,"schema":{"type":"number","format":"none","nullable":false}}],"responses":{"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResult"}}}},"500":{"description":"Server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResult"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResult"}}}},"204":{"description":"No result","content":{"application/json":{"schema":{"type":"object","format":"none","nullable":false}}}}},"security":[{"OAUTHpassword":[]},{"accessToken":[]}]}},"/api/v2/eshop/discounts/{dbName}/{discountId}":{"get":{"tags":["Products"],"summary":"Discount","description":"Reads data of one discount.","parameters":[{"$ref":"#/components/parameters/dbNameParam"},{"in":"path","name":"discountId","description":"Discount's ID.","required":true,"schema":{"type":"number","format":"none","nullable":false}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/discountsResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResult"}}}},"500":{"description":"Server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResult"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResult"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResult"}}}}},"security":[{"OAUTHpassword":[]},{"accessToken":[]}]}},"/api/v2/eshop/inventories/{dbName}":{"get":{"tags":["Products"],"summary":"Inventories","description":"Reads data about all inventories.","parameters":[{"$ref":"#/components/parameters/dbNameParam"},{"$ref":"#/components/parameters/filterQParam"},{"$ref":"#/components/parameters/orderbyQParam"},{"$ref":"#/components/parameters/topQParam"},{"$ref":"#/components/parameters/skipQParam"}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/inventoriesResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResult"}}}},"500":{"description":"Server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResult"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResult"}}}}},"security":[{"OAUTHpassword":[]},{"accessToken":[]}]}},"/api/v2/eshop/discounts/{dbName}":{"get":{"tags":["Products"],"summary":"Discounts","description":"Reads data about all discounts.","parameters":[{"$ref":"#/components/parameters/dbNameParam"},{"$ref":"#/components/parameters/filterQParam"},{"$ref":"#/components/parameters/orderbyQParam"},{"$ref":"#/components/parameters/topQParam"},{"$ref":"#/components/parameters/skipQParam"}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/discountsResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResult"}}}},"500":{"description":"Server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResult"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResult"}}}}},"security":[{"OAUTHpassword":[]},{"accessToken":[]}]}},"/api/v2/eshop/customers/{dbName}":{"get":{"tags":["Customers"],"summary":"Customers","description":"Reads data about all customers.","parameters":[{"$ref":"#/components/parameters/dbNameParam"},{"$ref":"#/components/parameters/filterQParam"},{"$ref":"#/components/parameters/orderbyQParam"},{"$ref":"#/components/parameters/topQParam"},{"$ref":"#/components/parameters/skipQParam"}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/customersResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResult"}}}},"500":{"description":"Server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResult"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResult"}}}}},"security":[{"OAUTHpassword":[]},{"accessToken":[]}]},"post":{"tags":["Customers"],"summary":"Create customer","description":"Creates a registered customer.","requestBody":{"description":"Attributes of customer.","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customerBodyPOST"}}}},"parameters":[{"$ref":"#/components/parameters/dbNameParam"}],"responses":{"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResult"}}}},"500":{"description":"Server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResult"}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/customerBodyPOSTPUTResult"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResult"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResult"}}}}},"security":[{"OAUTHpassword":[]},{"accessToken":[]}]}},"/api/v2/eshop/products/{dbName}/{productId}":{"get":{"tags":["Products"],"summary":"Product","description":"Reads data of one product.","parameters":[{"$ref":"#/components/parameters/dbNameParam"},{"in":"path","name":"productId","description":"Product's ID.","required":true,"schema":{"type":"integer","format":"int32","nullable":false}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/productsResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResult"}}}},"500":{"description":"Server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResult"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResult"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResult"}}}}},"security":[{"OAUTHpassword":[]},{"accessToken":[]}]}},"/api/v2/eshop/pricelists/{dbName}/{pricelistId}":{"get":{"tags":["Products"],"summary":"Pricelists","description":"Reads data about all pricelists.","parameters":[{"$ref":"#/components/parameters/dbNameParam"},{"in":"path","name":"pricelistId","description":"Pricelist's ID.","required":true,"schema":{"type":"integer","format":"int32","nullable":false}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/pricelistsResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResult"}}}},"500":{"description":"Server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResult"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResult"}}}}},"security":[{"OAUTHpassword":[]},{"accessToken":[]}]}},"/api/v2/eshop/transportMethods/{dbName}":{"get":{"tags":["Products"],"summary":"Transport Methods","description":"Reads data about all transport methods.","parameters":[{"$ref":"#/components/parameters/dbNameParam"},{"$ref":"#/components/parameters/filterQParam"},{"$ref":"#/components/parameters/orderbyQParam"},{"$ref":"#/components/parameters/topQParam"},{"$ref":"#/components/parameters/skipQParam"}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/transportMethodsResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResult"}}}},"500":{"description":"Server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResult"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResult"}}}}},"security":[{"OAUTHpassword":[]},{"accessToken":[]}]}},"/api/v2/eshop/transportMethods/{dbName}/{transportMethodId}":{"get":{"tags":["Products"],"summary":"Transport Method","description":"Reads data of one transport method.","parameters":[{"$ref":"#/components/parameters/dbNameParam"},{"in":"path","name":"transportMethodId","description":"Transport Method's ID.","required":true,"schema":{"type":"integer","format":"int32","nullable":false}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/transportMethodsResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResult"}}}},"500":{"description":"Server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResult"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResult"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResult"}}}}},"security":[{"OAUTHpassword":[]},{"accessToken":[]}]}}},"components":{"schemas":{"customerResult":{"type":"object","nullable":false,"properties":{"id":{"type":"integer","format":"int32","description":"Unique identifier of the customer.","nullable":false},"referenceId":{"type":"string","description":"Unique reference identifier of the customer used by users.","nullable":false},"createdOn":{"type":"string","format":"date-time","description":"Date and time when the record was created.","nullable":false},"modifiedOn":{"type":"string","format":"date-time","description":"Date and time when the record was modified.","nullable":false},"addresses":{"type":"array","description":"List of adresses associated with the order. Expexted is either one address (servin both as billing and shipping address) or two adresses (one billing address, the other shipping address.","nullable":false,"items":{"type":"object","nullable":false,"properties":{"id":{"type":"integer","format":"int32","description":"Unique identifier of the address.","nullable":false},"referenceId":{"type":"string","description":"Unique reference identifier of the address used by users.","nullable":false},"createdOn":{"type":"string","format":"date-time","description":"Date and time when the record was created.","nullable":false},"modifiedOn":{"type":"string","format":"date-time","description":"Date and time when the record was modified.","nullable":false},"name":{"type":"string","description":"Name of th address.","nullable":false},"typeCode":{"type":"string","description":"ID of address types for this address. E. g. Billing, primary, shipping etc. - in case of an eshop order there should be at least one address (both billing and shipping) or two addresses (one billing address, one shipping address).","nullable":false,"enum":["billing","shipping"]},"street":{"type":"string","description":"Street.","nullable":false},"houseNumber":{"type":"string","description":"House number.","nullable":false},"streetNumber":{"type":"string","description":"Street number.","nullable":false},"district":{"type":"string","description":"District.","nullable":false},"city":{"type":"string","description":"City.","nullable":false},"stateOrProvice":{"type":"string","description":"State or Province (required only for specific states).","nullable":false},"postalCode":{"type":"string","description":"Postal code.","nullable":false},"countryCode":{"type":"string","description":"Country code.","nullable":false},"shippingPhone":{"type":"string","description":"Phone associated with the shipping address.","nullable":false}}}},"contacts":{"type":"array","description":"List of contacts associated with this order. Expected only one contact (who created the order).","nullable":false,"items":{"type":"object","nullable":false,"properties":{"id":{"type":"integer","format":"int32","description":"Unique identifier of the contact.","nullable":false},"referenceId":{"type":"string","description":"Unique reference identifier of the contact used by users.","nullable":false},"createdOn":{"type":"string","format":"date-time","description":"Date and time when the record was created.","nullable":false},"modifiedOn":{"type":"string","format":"date-time","description":"Date and time when the record was modified.","nullable":false},"contactName":{"type":"string","description":"Name of contact.","nullable":false},"firstName":{"type":"string","description":"First name of the contact person.","nullable":false},"lastName":{"type":"string","description":"Last name of the contact person.","nullable":false},"emailAddress":{"type":"string","description":"Email of the contact person.","nullable":false},"telephone":{"type":"string","description":"Contact phone of the person.","nullable":false},"mobilePhone":{"type":"string","description":"Mobile phone number of the person.","nullable":false}}}},"cin":{"type":"string","description":"Company identification number.","nullable":false},"tin":{"type":"string","description":"Tax identification number.","nullable":false},"name":{"type":"string","description":"Name of the customer.","nullable":false},"legalFormCode":{"type":"string","description":"Legal form of the customer.","nullable":false,"enum":["privatePerson","legalEntity"]},"generalPhone":{"type":"string","description":"General telephone number of the company.","nullable":false},"generalEmail":{"type":"string","description":"General e-mail of the company.","nullable":false}}},"customerBodyPOST":{"type":"object","nullable":false,"properties":{"addresses":{"type":"array","description":"List of adresses associated with the order. Expexted is either one address (servin both as billing and shipping address) or two adresses (one billing address, the other shipping address.","nullable":false,"items":{"type":"object","nullable":false,"properties":{"transferId":{"type":"string","description":"Transaction transfer Id.","nullable":false},"name":{"type":"string","description":"Name of th address.","nullable":false},"typeCode":{"type":"string","description":"ID of address types for this address. E. g. Billing, primary, shipping etc. - in case of an eshop order there should be at least one address (both billing and shipping) or two addresses (one billing address, one shipping address).","nullable":false,"enum":["billing","shipping"]},"street":{"type":"string","description":"Street.","nullable":false},"houseNumber":{"type":"string","description":"House number.","nullable":false},"streetNumber":{"type":"string","description":"Street number.","nullable":false},"district":{"type":"string","description":"District.","nullable":false},"city":{"type":"string","description":"City.","nullable":false},"stateOrProvice":{"type":"string","description":"State or Province (required only for specific states).","nullable":false},"postalCode":{"type":"string","description":"Postal code.","nullable":false},"countryCode":{"type":"string","description":"Country code.","nullable":false},"shippingPhone":{"type":"string","description":"Phone associated with the shipping address.","nullable":false}}}},"contacts":{"type":"array","description":"List of contacts associated with this order. Expected only one contact (who created the order).","nullable":false,"items":{"type":"object","nullable":false,"properties":{"transferId":{"type":"string","description":"Transaction transfer Id.","nullable":false},"contactName":{"type":"string","description":"Name of contact.","nullable":false},"firstName":{"type":"string","description":"First name of the contact person.","nullable":false},"lastName":{"type":"string","description":"Last name of the contact person.","nullable":false},"emailAddress":{"type":"string","description":"Email of the contact person.","nullable":false},"telephone":{"type":"string","description":"Contact phone of the person.","nullable":false},"mobilePhone":{"type":"string","description":"Mobile phone number of the person.","nullable":false}}}},"cin":{"type":"string","description":"Company identification number.","nullable":false},"tin":{"type":"string","description":"Tax identification number.","nullable":false},"name":{"type":"string","description":"Name of the customer.","nullable":false},"legalFormCode":{"type":"string","description":"Legal form of the customer.","nullable":false,"enum":["privatePerson","legalEntity"]},"generalPhone":{"type":"string","description":"General telephone number of the company.","nullable":false},"generalEmail":{"type":"string","description":"General e-mail of the company.","nullable":false}}},"customerBodyPOSTPUTResult":{"type":"object","nullable":false,"properties":{"addresses":{"type":"array","description":"Array of unique identifiers of the addresses.","nullable":false,"items":{"type":"object","nullable":false,"properties":{"createdOn":{"type":"string","format":"date-time","description":"Date and time when the record was created.","nullable":false},"modifiedOn":{"type":"string","format":"date-time","description":"Date and time when the record was modified.","nullable":false},"referenceId":{"type":"string","description":"Unique reference identifier of the record.","nullable":false},"id":{"type":"integer","format":"int32","description":"Unique identifier of the record.","nullable":false},"transferId":{"type":"string","description":"Transaction transfer Id.","nullable":false}}}},"contacts":{"type":"array","description":"Array of unique identifiers of the contacts.","nullable":false,"items":{"type":"object","nullable":false,"properties":{"createdOn":{"type":"string","format":"date-time","description":"Date and time when the record was created.","nullable":false},"modifiedOn":{"type":"string","format":"date-time","description":"Date and time when the record was modified.","nullable":false},"referenceId":{"type":"string","description":"Unique reference identifier of the record.","nullable":false},"id":{"type":"integer","format":"int32","description":"Unique identifier of the record.","nullable":false},"transferId":{"type":"string","description":"Transaction transfer Id.","nullable":false}}}},"id":{"type":"integer","format":"int32","description":"Unique identifier of the customer.","nullable":false},"referenceId":{"type":"string","description":"Unique reference identifier of the record.","nullable":false},"createdOn":{"type":"string","format":"date-time","description":"Date and time when the record was created.","nullable":false},"modifiedOn":{"type":"string","format":"date-time","description":"Date and time when the record was modified.","nullable":false}}},"customerBodyPUT":{"type":"object","nullable":false,"properties":{"addresses":{"type":"array","description":"List of adresses associated with the order. Expexted is either one address (servin both as billing and shipping address) or two adresses (one billing address, the other shipping address.","nullable":false,"items":{"type":"object","nullable":false,"properties":{"id":{"type":"integer","format":"int32","description":"Unique identifier of the address.","nullable":false},"transferId":{"type":"string","description":"Transaction transfer Id.","nullable":false},"name":{"type":"string","description":"Name of th address.","nullable":false},"typeCode":{"type":"string","description":"ID of address types for this address. E. g. Billing, primary, shipping etc. - in case of an eshop order there should be at least one address (both billing and shipping) or two addresses (one billing address, one shipping address).","nullable":false,"enum":["billing","shipping"]},"street":{"type":"string","description":"Street.","nullable":false},"houseNumber":{"type":"string","description":"House number.","nullable":false},"streetNumber":{"type":"string","description":"Street number.","nullable":false},"district":{"type":"string","description":"District.","nullable":false},"city":{"type":"string","description":"City.","nullable":false},"stateOrProvice":{"type":"string","description":"State or Province (required only for specific states).","nullable":false},"postalCode":{"type":"string","description":"Postal code.","nullable":false},"countryCode":{"type":"string","description":"Country code.","nullable":false},"shippingPhone":{"type":"string","description":"Phone associated with the shipping address.","nullable":false}}}},"contacts":{"type":"array","description":"List of contacts associated with this order. Expected only one contact (who created the order).","nullable":false,"items":{"type":"object","nullable":false,"properties":{"id":{"type":"integer","format":"int32","description":"Unique identifier of the contact.","nullable":false},"transferId":{"type":"string","description":"Transaction transfer Id.","nullable":false},"contactName":{"type":"string","description":"Name of contact.","nullable":false},"firstName":{"type":"string","description":"First name of the contact person.","nullable":false},"lastName":{"type":"string","description":"Last name of the contact person.","nullable":false},"emailAddress":{"type":"string","description":"Email of the contact person.","nullable":false},"telephone":{"type":"string","description":"Contact phone of the person.","nullable":false},"mobilePhone":{"type":"string","description":"Mobile phone number of the person.","nullable":false}}}},"cin":{"type":"string","description":"Company identification number.","nullable":false},"tin":{"type":"string","description":"Tax identification number.","nullable":false},"name":{"type":"string","description":"Name of the customer.","nullable":false},"legalFormCode":{"type":"string","description":"Legal form of the customer.","nullable":false,"enum":["privatePerson","legalEntity"]},"generalPhone":{"type":"string","description":"General telephone number of the company.","nullable":false},"generalEmail":{"type":"string","description":"General e-mail of the company.","nullable":false}}},"customersResult":{"type":"object","nullable":false,"properties":{"customers":{"type":"array","nullable":false,"items":{"type":"object","nullable":false,"properties":{"id":{"type":"integer","format":"int32","description":"Unique identifier of the customer.","nullable":false},"referenceId":{"type":"string","description":"Unique reference identifier of the customer used by users.","nullable":false},"createdOn":{"type":"string","format":"date-time","description":"Date and time when the record was created.","nullable":false},"modifiedOn":{"type":"string","format":"date-time","description":"Date and time when the record was modified.","nullable":false},"addresses":{"type":"array","description":"List of adresses associated with the order. Expexted is either one address (servin both as billing and shipping address) or two adresses (one billing address, the other shipping address.","nullable":false,"items":{"type":"object","nullable":false,"properties":{"id":{"type":"integer","format":"int32","description":"Unique identifier of the address.","nullable":false},"referenceId":{"type":"string","description":"Unique reference identifier of the address used by users.","nullable":false},"createdOn":{"type":"string","format":"date-time","description":"Date and time when the record was created.","nullable":false},"modifiedOn":{"type":"string","format":"date-time","description":"Date and time when the record was modified.","nullable":false},"name":{"type":"string","description":"Name of th address.","nullable":false},"typeCode":{"type":"string","description":"ID of address types for this address. E. g. Billing, primary, shipping etc. - in case of an eshop order there should be at least one address (both billing and shipping) or two addresses (one billing address, one shipping address).","nullable":false,"enum":["billing","shipping"]},"street":{"type":"string","description":"Street.","nullable":false},"houseNumber":{"type":"string","description":"House number.","nullable":false},"streetNumber":{"type":"string","description":"Street number.","nullable":false},"district":{"type":"string","description":"District.","nullable":false},"city":{"type":"string","description":"City.","nullable":false},"stateOrProvice":{"type":"string","description":"State or Province (required only for specific states).","nullable":false},"postalCode":{"type":"string","description":"Postal code.","nullable":false},"countryCode":{"type":"string","description":"Country code.","nullable":false},"shippingPhone":{"type":"string","description":"Phone associated with the shipping address.","nullable":false}}}},"contacts":{"type":"array","description":"List of contacts associated with this order. Expected only one contact (who created the order).","nullable":false,"items":{"type":"object","nullable":false,"properties":{"id":{"type":"integer","format":"int32","description":"Unique identifier of the contact.","nullable":false},"referenceId":{"type":"string","description":"Unique reference identifier of the contact used by users.","nullable":false},"createdOn":{"type":"string","format":"date-time","description":"Date and time when the record was created.","nullable":false},"modifiedOn":{"type":"string","format":"date-time","description":"Date and time when the record was modified.","nullable":false},"contactName":{"type":"string","description":"Name of contact.","nullable":false},"firstName":{"type":"string","description":"First name of the contact person.","nullable":false},"lastName":{"type":"string","description":"Last name of the contact person.","nullable":false},"emailAddress":{"type":"string","description":"Email of the contact person.","nullable":false},"telephone":{"type":"string","description":"Contact phone of the person.","nullable":false},"mobilePhone":{"type":"string","description":"Mobile phone number of the person.","nullable":false}}}},"cin":{"type":"string","description":"Company identification number.","nullable":false},"tin":{"type":"string","description":"Tax identification number.","nullable":false},"name":{"type":"string","description":"Name of the customer.","nullable":false},"legalFormCode":{"type":"string","description":"Legal form of the customer.","nullable":false,"enum":["privatePerson","legalEntity"]},"generalPhone":{"type":"string","description":"General telephone number of the company.","nullable":false},"generalEmail":{"type":"string","description":"General e-mail of the company.","nullable":false}}}}}},"productsResult":{"type":"object","nullable":false,"properties":{"products":{"type":"array","nullable":false,"items":{"type":"object","nullable":false,"properties":{"id":{"type":"integer","format":"int32","description":"Unique identifier of the product.","nullable":false},"referenceId":{"type":"string","description":"Unique reference identifier of the product used by users.","nullable":false},"createdOn":{"type":"string","format":"date-time","description":"Date and time when the record was created.","nullable":false},"modifiedOn":{"type":"string","format":"date-time","description":"Date and time when the record was modified.","nullable":false},"barcode":{"type":"string","description":"The barcode, UPC, or ISBN number for the product.","nullable":false},"name":{"type":"string","description":"Name of the product.","nullable":false},"typeCode":{"type":"string","description":"Type of the product.","nullable":false,"enum":["product","shipping","packing","assembly","insurance"]},"description":{"type":"string","description":"Description of the product.","nullable":false},"measureUnit":{"type":"string","description":"Measure units for the product.","nullable":false},"statusCode":{"type":"string","description":"The status of the product.","nullable":false,"enum":["active","archived","draft"]},"vendorId":{"type":"integer","format":"int32","description":"Unique identifier of vendor supplying the product.","nullable":false},"vendorReferenceId":{"type":"string","description":"The reference ID of vendor supplying the product.","nullable":false},"vendorName":{"type":"string","description":"Name of the product vendor.","nullable":false},"manufacturerId":{"type":"integer","format":"int32","description":"Unique identifier of manufacturer producing the product.","nullable":false},"manufacturerReferenceId":{"type":"string","description":"The reference ID of manufacturer producing the product.","nullable":false},"manufacturerName":{"type":"string","description":"Name of the product manufacturer.","nullable":false},"images":{"type":"array","description":"List of images associated with the product.","nullable":false,"items":{"type":"object","nullable":false,"properties":{"id":{"type":"integer","format":"int32","description":"Unique identifier of the image.","nullable":false},"referenceId":{"type":"string","description":"Unique reference identifier of the image used by users.","nullable":false},"content":{"type":"string","description":"Binary data of image.","nullable":false},"fileName":{"type":"string","description":"Image name.","nullable":false},"description":{"type":"string","description":"Image description.","nullable":false},"position":{"type":"integer","format":"int32","description":"The order of the product image in the list. The first product image is at position 1 and is the \"main\" image for the product.","nullable":false},"createdOn":{"type":"string","format":"date-time","description":"The date and time when the product image was created.","nullable":false},"modifiedOn":{"type":"string","format":"date-time","description":"The date and time when the product image was last modified.","nullable":false}}}},"categories":{"type":"array","description":"A categorization for the product used for filtering and searching products.","nullable":false,"items":{"type":"object","nullable":false,"properties":{"id":{"type":"integer","format":"int32","nullable":false},"referenceId":{"type":"string","nullable":false},"name":{"type":"string","nullable":false}}}}}}}}},"categoriesResult":{"type":"object","nullable":false,"properties":{"categories":{"type":"array","nullable":false,"items":{"type":"object","nullable":false,"properties":{"id":{"type":"integer","format":"int32","description":"Unique identifier of the category.","nullable":false},"referenceId":{"type":"string","description":"Unique reference identifier of the category used by users.","nullable":false},"createdOn":{"type":"string","format":"date-time","description":"Date and time when the record was created.","nullable":false},"modifiedOn":{"type":"string","format":"date-time","description":"Date and time when the record was modified.","nullable":false},"name":{"type":"string","description":"Name of the category.","nullable":false},"superiorCategoryId":{"type":"integer","format":"int32","description":"Unique identifier of the superior category.","nullable":false},"position":{"type":"integer","format":"int32","description":"Position of the category.","nullable":false}}}}}},"transportMethodsResult":{"type":"object","nullable":false,"properties":{"transportMethods":{"type":"array","nullable":false,"items":{"type":"object","nullable":false,"properties":{"id":{"type":"integer","format":"int32","description":"Unique identifier of the transport method.","nullable":false},"name":{"type":"string","description":"Name of the transport method.","nullable":false},"createdOn":{"type":"string","format":"date-time","description":"Date and time when the record was created.","nullable":false},"modifiedOn":{"type":"string","format":"date-time","description":"Date and time when the record was modified.","nullable":false}}}}}},"ordersResult":{"type":"object","nullable":false,"properties":{"orders":{"type":"array","nullable":false,"items":{"type":"object","nullable":false,"properties":{"id":{"type":"integer","format":"int32","description":"Unique identifier of the order.","nullable":false},"referenceId":{"type":"string","description":"Unique reference identifier of the order used by users.","nullable":false},"createdOn":{"type":"string","format":"date-time","description":"Date and time when the record was created.","nullable":false},"modifiedOn":{"type":"string","format":"date-time","description":"Date and time when the record was modified.","nullable":false},"name":{"type":"string","description":"Name of the order.","nullable":false},"noteText":{"type":"string","description":"Note associated with the order.","nullable":false},"warehouseId":{"type":"integer","format":"int32","description":"Unique identifier of the warehouse.","nullable":false},"warehouseReferenceId":{"type":"string","description":"Unique reference identifier of the warehouse used by users.","nullable":false},"transactionCurrencyCode":{"type":"string","description":"Currency of the order.","nullable":false},"exchangeRate":{"type":"number","format":"double","description":"Exchange rate of the price of the order.","nullable":false},"totalPrice":{"type":"number","format":"double","description":"Total price of the order.","nullable":false},"discountCode":{"type":"string","description":"Code of the discount.","nullable":false},"discountAmount":{"type":"number","format":"double","description":"Amount of the discount.","nullable":false},"vatCountryCode":{"type":"string","description":"Country code of VAT country.","nullable":false},"stateCode":{"type":"string","description":"State code of the order.","nullable":false,"enum":["waitingForPayment","processing","shipped","partiallyShipped"]},"externalReferenceId":{"type":"string","description":"Sales order external reference Id.","nullable":false},"transportMethodId":{"type":"integer","format":"int32","description":"Transport Method Id.","nullable":true},"deliveringDescription":{"type":"string","description":"Delivering description.","nullable":false},"items":{"type":"array","description":"Items of the order.","nullable":false,"items":{"type":"object","nullable":false,"properties":{"id":{"type":"integer","format":"int32","description":"Unique identifier of the order item.","nullable":false},"referenceId":{"type":"string","description":"Unique reference identifier of the order item used by users.","nullable":false},"createdOn":{"type":"string","format":"date-time","description":"Date and time when the record was created.","nullable":false},"modifiedOn":{"type":"string","format":"date-time","description":"Date and time when the record was modified.","nullable":false},"productId":{"type":"integer","format":"int32","nullable":false},"productReferenceId":{"type":"string","nullable":false},"typeCode":{"type":"string","nullable":false,"enum":["product","shipping","packing","assembly","insurance"]},"productName":{"type":"string","nullable":false},"productDescription":{"type":"string","nullable":false},"warehouseId":{"type":"integer","format":"int32","nullable":false},"warehouseReferenceId":{"type":"string","nullable":false},"warehouseName":{"type":"string","nullable":false},"variantId":{"type":"integer","format":"int32","nullable":false},"variantReferenceId":{"type":"string","nullable":false},"variantName":{"type":"string","nullable":false},"quantity":{"type":"number","format":"double","nullable":false},"measureUnit":{"type":"string","nullable":false},"pricePerUnit":{"type":"number","format":"double","nullable":false},"pricePerUnitBase":{"type":"number","format":"double","nullable":false},"totalPrice":{"type":"number","format":"double","nullable":false},"discountUnitAmount":{"type":"number","format":"double","nullable":false},"blockedQuantity":{"type":"number","format":"double","nullable":false},"vatRate":{"type":"number","format":"double","nullable":true},"options":{"type":"array","nullable":false,"items":{"type":"object","nullable":false,"properties":{"id":{"type":"integer","format":"int32","nullable":false},"variantOptionId":{"type":"integer","format":"int32","nullable":false},"name":{"type":"string","nullable":false},"value":{"type":"string","nullable":false}}}}}}},"customer":{"type":"object","description":"Customer and addresses.","nullable":false,"properties":{"id":{"type":"integer","format":"int32","description":"Unique identifier of the customer.","nullable":false},"referenceId":{"type":"string","description":"Unique reference identifier of the customer used by users.","nullable":false},"createdOn":{"type":"string","format":"date-time","description":"Date and time when the record was created.","nullable":false},"modifiedOn":{"type":"string","format":"date-time","description":"Date and time when the record was modified.","nullable":false},"addresses":{"type":"array","description":"List of adresses associated with the order. Expexted is either one address (servin both as billing and shipping address) or two adresses (one billing address, the other shipping address.","nullable":false,"items":{"type":"object","nullable":false,"properties":{"id":{"type":"integer","format":"int32","description":"Unique identifier of the address.","nullable":false},"referenceId":{"type":"string","description":"Unique reference identifier of the address used by users.","nullable":false},"createdOn":{"type":"string","format":"date-time","description":"Date and time when the record was created.","nullable":false},"modifiedOn":{"type":"string","format":"date-time","description":"Date and time when the record was modified.","nullable":false},"name":{"type":"string","description":"Name of th address.","nullable":false},"typeCode":{"type":"string","description":"ID of address types for this address. E. g. Billing, primary, shipping etc. - in case of an eshop order there should be at least one address (both billing and shipping) or two addresses (one billing address, one shipping address).","nullable":false,"enum":["billing","shipping"]},"street":{"type":"string","description":"Street.","nullable":false},"houseNumber":{"type":"string","description":"House number.","nullable":false},"streetNumber":{"type":"string","description":"Street number.","nullable":false},"district":{"type":"string","description":"District.","nullable":false},"city":{"type":"string","description":"City.","nullable":false},"stateOrProvice":{"type":"string","description":"State or Province (required only for specific states).","nullable":false},"postalCode":{"type":"string","description":"Postal code.","nullable":false},"countryCode":{"type":"string","description":"Country code.","nullable":false},"shippingPhone":{"type":"string","description":"Phone associated with the shipping address.","nullable":false}}}},"contacts":{"type":"array","description":"List of contacts associated with this order. Expected only one contact (who created the order).","nullable":false,"items":{"type":"object","nullable":false,"properties":{"id":{"type":"integer","format":"int32","description":"Unique identifier of the contact.","nullable":false},"referenceId":{"type":"string","description":"Unique reference identifier of the contact used by users.","nullable":false},"createdOn":{"type":"string","format":"date-time","description":"Date and time when the record was created.","nullable":false},"modifiedOn":{"type":"string","format":"date-time","description":"Date and time when the record was modified.","nullable":false},"contactName":{"type":"string","description":"Name of contact.","nullable":false},"firstName":{"type":"string","description":"First name of the contact person.","nullable":false},"lastName":{"type":"string","description":"Last name of the contact person.","nullable":false},"emailAddress":{"type":"string","description":"Email of the contact person.","nullable":false},"telephone":{"type":"string","description":"Contact phone of the person.","nullable":false},"mobilePhone":{"type":"string","description":"Mobile phone number of the person.","nullable":false}}}},"cin":{"type":"string","description":"Company identification number.","nullable":false},"tin":{"type":"string","description":"Tax identification number.","nullable":false},"name":{"type":"string","description":"Name of the customer.","nullable":false},"legalFormCode":{"type":"string","description":"Legal form of the customer.","nullable":false,"enum":["privatePerson","legalEntity"]},"generalPhone":{"type":"string","description":"General telephone number of the company.","nullable":false},"generalEmail":{"type":"string","description":"General e-mail of the company.","nullable":false}}},"payments":{"type":"array","description":"Order payments.","nullable":false,"items":{"type":"object","nullable":false,"properties":{"id":{"type":"integer","format":"int32","nullable":false},"paymentMethodCode":{"type":"string","nullable":false,"enum":["onlinePayment","cashOnDelivery","bankTransfer","cash"]},"paymentStatusCode":{"type":"string","nullable":false,"enum":["waitingForPayment","paid","cancelled"]},"paymentDate":{"type":"string","format":"date-time","nullable":false},"paymentTransactionIdentification":{"type":"string","nullable":false},"paymentGateway":{"type":"string","nullable":false}}}}}}}}},"ordersBodyPOST":{"type":"object","nullable":false,"properties":{"items":{"type":"array","nullable":false,"items":{"type":"object","nullable":false,"properties":{"options":{"type":"array","nullable":false,"items":{"type":"object","nullable":false,"properties":{"variantOptionId":{"type":"integer","format":"int32","nullable":false},"transferId":{"type":"string","description":"Transaction transfer Id.","nullable":false},"value":{"type":"string","nullable":false}}}},"transferId":{"type":"string","description":"Transaction transfer Id.","nullable":false},"productId":{"type":"integer","format":"int32","nullable":false},"warehouseId":{"type":"integer","format":"int32","nullable":false},"variantId":{"type":"integer","format":"int32","nullable":false},"quantity":{"type":"number","format":"double","nullable":false},"measureUnit":{"type":"string","nullable":false},"totalPrice":{"type":"number","format":"double","nullable":false},"discountUnitAmount":{"type":"number","format":"double","nullable":false},"productDescription":{"type":"string","nullable":false},"vatRate":{"type":"number","format":"double","nullable":true}}}},"payments":{"type":"array","nullable":false,"items":{"type":"object","nullable":false,"properties":{"transferId":{"type":"string","nullable":false},"paymentMethodCode":{"type":"string","nullable":false,"enum":["onlinePayment","cashOnDelivery","bankTransfer","cash"]},"paymentStatusCode":{"type":"string","nullable":false,"enum":["waitingForPayment","paid","cancelled"]},"paymentDate":{"type":"string","format":"variant","nullable":false},"paymentTransactionIdentification":{"type":"string","nullable":false},"paymentGateway":{"type":"string","nullable":false}}}},"customer":{"type":"object","nullable":false,"properties":{"id":{"type":"integer","format":"int32","description":"Unique identifier of the customer.","nullable":false},"transferId":{"type":"string","description":"Transaction transfer Id.","nullable":false},"addresses":{"type":"array","description":"List of adresses associated with the order. Expexted is either one address (servin both as billing and shipping address) or two adresses (one billing address, the other shipping address.","nullable":false,"items":{"type":"object","nullable":false,"properties":{"id":{"type":"integer","format":"int32","description":"Unique identifier of the address.","nullable":false},"transferId":{"type":"string","description":"Transaction transfer Id.","nullable":false},"name":{"type":"string","description":"Name of th address.","nullable":false},"typeCode":{"type":"string","description":"ID of address types for this address. E. g. Billing, primary, shipping etc. - in case of an eshop order there should be at least one address (both billing and shipping) or two addresses (one billing address, one shipping address).","nullable":false,"enum":["billing","shipping"]},"street":{"type":"string","description":"Street.","nullable":false},"houseNumber":{"type":"string","description":"House number.","nullable":false},"streetNumber":{"type":"string","description":"Street number.","nullable":false},"district":{"type":"string","description":"District.","nullable":false},"city":{"type":"string","description":"City.","nullable":false},"stateOrProvice":{"type":"string","description":"State or Province (required only for specific states).","nullable":false},"postalCode":{"type":"string","description":"Postal code.","nullable":false},"countryCode":{"type":"string","description":"Country code.","nullable":false},"shippingPhone":{"type":"string","description":"Phone associated with the shipping address.","nullable":false}}}},"contacts":{"type":"array","description":"List of contacts associated with this order. Expected only one contact (who created the order).","nullable":false,"items":{"type":"object","nullable":false,"properties":{"id":{"type":"integer","format":"int32","description":"Unique identifier of the contact.","nullable":false},"transferId":{"type":"string","description":"Transaction transfer Id.","nullable":false},"contactName":{"type":"string","description":"Name of contact.","nullable":false},"firstName":{"type":"string","description":"First name of the contact person.","nullable":false},"lastName":{"type":"string","description":"Last name of the contact person.","nullable":false},"emailAddress":{"type":"string","description":"Email of the contact person.","nullable":false},"telephone":{"type":"string","description":"Contact phone of the person.","nullable":false},"mobilePhone":{"type":"string","description":"Mobile phone number of the person.","nullable":false}}}},"cin":{"type":"string","description":"Company identification number.","nullable":false},"tin":{"type":"string","description":"Tax identification number.","nullable":false},"name":{"type":"string","description":"Name of the customer.","nullable":false},"legalFormCode":{"type":"string","description":"Legal form of the customer.","nullable":false,"enum":["privatePerson","legalEntity"]},"generalPhone":{"type":"string","description":"General telephone number of the company.","nullable":false},"generalEmail":{"type":"string","description":"General e-mail of the company.","nullable":false}}},"noteText":{"type":"string","nullable":false},"warehouseId":{"type":"integer","format":"int32","nullable":false},"transactionCurrencyCode":{"type":"string","nullable":false},"exchangeRate":{"type":"number","format":"double","nullable":false},"totalPrice":{"type":"number","format":"double","nullable":false},"discountCode":{"type":"string","nullable":false},"discountAmount":{"type":"number","format":"double","nullable":false},"vatCountryCode":{"type":"string","nullable":false},"externalReferenceId":{"type":"string","nullable":false},"transportMethodId":{"type":"integer","format":"int32","nullable":false},"deliveringDescription":{"type":"string","nullable":false}}},"ordersBodyPOSTPUTResult":{"type":"object","nullable":false,"properties":{"addresses":{"type":"array","description":"Array of unique identifiers of the addresses.","nullable":false,"items":{"type":"object","nullable":false,"properties":{"createdOn":{"type":"string","format":"date-time","description":"Date and time when the record was created.","nullable":false},"modifiedOn":{"type":"string","format":"date-time","description":"Date and time when the record was modified.","nullable":false},"referenceId":{"type":"string","description":"Unique reference identifier of the record.","nullable":false},"id":{"type":"integer","format":"int32","description":"Unique identifier of the record.","nullable":false},"transferId":{"type":"string","description":"Transaction transfer Id.","nullable":false}}}},"contacts":{"type":"array","description":"Array of unique identifiers of the contacts.","nullable":false,"items":{"type":"object","nullable":false,"properties":{"createdOn":{"type":"string","format":"date-time","description":"Date and time when the record was created.","nullable":false},"modifiedOn":{"type":"string","format":"date-time","description":"Date and time when the record was modified.","nullable":false},"referenceId":{"type":"string","description":"Unique reference identifier of the record.","nullable":false},"id":{"type":"integer","format":"int32","description":"Unique identifier of the record.","nullable":false},"transferId":{"type":"string","description":"Transaction transfer Id.","nullable":false}}}},"createdOn":{"type":"string","format":"date-time","description":"Date and time when the record was created.","nullable":false},"modifiedOn":{"type":"string","format":"date-time","description":"Date and time when the record was modified.","nullable":false},"referenceId":{"type":"string","description":"Unique reference identifier of the record.","nullable":false},"id":{"type":"integer","format":"int32","description":"Unique identifier of the record.","nullable":false},"transferId":{"type":"string","description":"Transaction transfer Id.","nullable":false}}},"ordersBodyPUT":{"type":"object","nullable":false,"properties":{"items":{"type":"array","nullable":false,"items":{"type":"object","nullable":false,"properties":{"id":{"type":"integer","format":"int32","description":"Unique identifier of the order item.","nullable":false},"options":{"type":"array","nullable":false,"items":{"type":"object","nullable":false,"properties":{"id":{"type":"integer","format":"int32","description":"Unique identifier of the option.","nullable":false},"variantOptionId":{"type":"integer","format":"int32","nullable":false},"transferId":{"type":"string","description":"Transaction transfer Id.","nullable":false},"value":{"type":"string","nullable":false}}}},"transferId":{"type":"string","description":"Transaction transfer Id.","nullable":false},"productId":{"type":"integer","format":"int32","nullable":false},"warehouseId":{"type":"integer","format":"int32","nullable":false},"variantId":{"type":"integer","format":"int32","nullable":false},"quantity":{"type":"number","format":"double","nullable":false},"measureUnit":{"type":"string","nullable":false},"totalPrice":{"type":"number","format":"double","nullable":false},"discountUnitAmount":{"type":"number","format":"double","nullable":false},"productDescription":{"type":"string","nullable":false},"vatRate":{"type":"number","format":"double","nullable":true}}}},"payments":{"type":"array","nullable":false,"items":{"type":"object","nullable":false,"properties":{"idIsFilled":{"type":"boolean","nullable":false},"id":{"type":"integer","format":"int32","nullable":false},"transferId":{"type":"string","nullable":false},"paymentMethodCode":{"type":"string","nullable":false,"enum":["onlinePayment","cashOnDelivery","bankTransfer","cash"]},"paymentStatusCode":{"type":"string","nullable":false,"enum":["waitingForPayment","paid","cancelled"]},"paymentDate":{"type":"string","format":"variant","nullable":false},"paymentTransactionIdentification":{"type":"string","nullable":false},"paymentGateway":{"type":"string","nullable":false}}}},"customer":{"type":"object","nullable":false,"properties":{"id":{"type":"integer","format":"int32","description":"Unique identifier of the customer.","nullable":false},"transferId":{"type":"string","description":"Transaction transfer Id.","nullable":false},"addresses":{"type":"array","description":"List of adresses associated with the order. Expexted is either one address (servin both as billing and shipping address) or two adresses (one billing address, the other shipping address.","nullable":false,"items":{"type":"object","nullable":false,"properties":{"id":{"type":"integer","format":"int32","description":"Unique identifier of the address.","nullable":false},"transferId":{"type":"string","description":"Transaction transfer Id.","nullable":false},"name":{"type":"string","description":"Name of th address.","nullable":false},"typeCode":{"type":"string","description":"ID of address types for this address. E. g. Billing, primary, shipping etc. - in case of an eshop order there should be at least one address (both billing and shipping) or two addresses (one billing address, one shipping address).","nullable":false,"enum":["billing","shipping"]},"street":{"type":"string","description":"Street.","nullable":false},"houseNumber":{"type":"string","description":"House number.","nullable":false},"streetNumber":{"type":"string","description":"Street number.","nullable":false},"district":{"type":"string","description":"District.","nullable":false},"city":{"type":"string","description":"City.","nullable":false},"stateOrProvice":{"type":"string","description":"State or Province (required only for specific states).","nullable":false},"postalCode":{"type":"string","description":"Postal code.","nullable":false},"countryCode":{"type":"string","description":"Country code.","nullable":false},"shippingPhone":{"type":"string","description":"Phone associated with the shipping address.","nullable":false}}}},"contacts":{"type":"array","description":"List of contacts associated with this order. Expected only one contact (who created the order).","nullable":false,"items":{"type":"object","nullable":false,"properties":{"id":{"type":"integer","format":"int32","description":"Unique identifier of the contact.","nullable":false},"transferId":{"type":"string","description":"Transaction transfer Id.","nullable":false},"contactName":{"type":"string","description":"Name of contact.","nullable":false},"firstName":{"type":"string","description":"First name of the contact person.","nullable":false},"lastName":{"type":"string","description":"Last name of the contact person.","nullable":false},"emailAddress":{"type":"string","description":"Email of the contact person.","nullable":false},"telephone":{"type":"string","description":"Contact phone of the person.","nullable":false},"mobilePhone":{"type":"string","description":"Mobile phone number of the person.","nullable":false}}}},"cin":{"type":"string","description":"Company identification number.","nullable":false},"tin":{"type":"string","description":"Tax identification number.","nullable":false},"name":{"type":"string","description":"Name of the customer.","nullable":false},"legalFormCode":{"type":"string","description":"Legal form of the customer.","nullable":false,"enum":["privatePerson","legalEntity"]},"generalPhone":{"type":"string","description":"General telephone number of the company.","nullable":false},"generalEmail":{"type":"string","description":"General e-mail of the company.","nullable":false}}},"noteText":{"type":"string","nullable":false},"warehouseId":{"type":"integer","format":"int32","nullable":false},"transactionCurrencyCode":{"type":"string","nullable":false},"exchangeRate":{"type":"number","format":"double","nullable":false},"totalPrice":{"type":"number","format":"double","nullable":false},"discountCode":{"type":"string","nullable":false},"discountAmount":{"type":"number","format":"double","nullable":false},"vatCountryCode":{"type":"string","nullable":false},"externalReferenceId":{"type":"string","nullable":false},"transportMethodId":{"type":"integer","format":"int32","nullable":false},"deliveringDescription":{"type":"string","nullable":false}}},"inventoriesResult":{"type":"object","nullable":false,"properties":{"inventories":{"type":"array","nullable":false,"items":{"type":"object","nullable":false,"properties":{"id":{"type":"integer","format":"int32","description":"Unique identifier of the product.","nullable":false},"referenceId":{"type":"string","description":"Unique reference identifier of the product used by users.","nullable":false},"createdOn":{"type":"string","format":"date-time","description":"Date and time when the record was created.","nullable":false},"modifiedOn":{"type":"string","format":"date-time","description":"Date and time when the record was modified.","nullable":false},"name":{"type":"string","description":"Name of the product.","nullable":false},"available":{"type":"number","format":"double","description":"Product quantity available.","nullable":false},"options":{"type":"array","description":"Product options.","nullable":false,"items":{"type":"object","nullable":false,"properties":{"id":{"type":"integer","format":"int32","description":"Unique identifier of the option.","nullable":false},"referenceId":{"type":"string","description":"Unique reference identifier of the option used by users.","nullable":false},"createdOn":{"type":"string","format":"date-time","description":"Date and time when the record was created.","nullable":false},"modifiedOn":{"type":"string","format":"date-time","description":"Date and time when the record was modified.","nullable":false},"name":{"type":"string","description":"Name of the option.","nullable":false},"values":{"type":"string","description":"Value of the option.","nullable":false}}}},"variants":{"type":"array","description":"Product variants.","nullable":false,"items":{"type":"object","nullable":false,"properties":{"id":{"type":"integer","format":"int32","description":"Unique identifier of the warehouse card.","nullable":false},"referenceId":{"type":"string","description":"Unique reference identifier of the warehouse card used by users.","nullable":false},"createdOn":{"type":"string","format":"date-time","description":"Date and time when the record was created.","nullable":false},"modifiedOn":{"type":"string","format":"date-time","description":"Date and time when the record was modified.","nullable":false},"name":{"type":"string","description":"Name of the warehouse card.","nullable":false},"measureUnit":{"type":"string","description":"Measure units for the product.","nullable":false},"available":{"type":"number","format":"double","description":"Inventory quantity available.","nullable":false},"warehouseId":{"type":"integer","format":"int32","description":"Unique identifier of the warehouse.","nullable":false},"warehouseReferenceId":{"type":"string","description":"Unique reference identifier of the warehouse used by users.","nullable":false},"warehouseName":{"type":"string","description":"Warehouse name.","nullable":false},"options":{"type":"array","description":"Variant options.","nullable":false,"items":{"type":"object","nullable":false,"properties":{"id":{"type":"integer","format":"int32","description":"Unique identifier of the option.","nullable":false},"name":{"type":"string","description":"Name of the option.","nullable":false},"value":{"type":"string","description":"Value of the option.","nullable":false},"available":{"type":"number","format":"double","description":"Quantity available.","nullable":false}}}}}}}}}}}},"pricelistsResult":{"type":"object","nullable":false,"properties":{"priceLists":{"type":"array","nullable":false,"items":{"type":"object","nullable":false,"properties":{"id":{"type":"integer","format":"int32","description":"Unique identifier of the price list.","nullable":false},"referenceId":{"type":"string","description":"Unique reference identifier of the price list used by users.","nullable":false},"createdOn":{"type":"string","format":"date-time","description":"Date and time when the record was created.","nullable":false},"modifiedOn":{"type":"string","format":"date-time","description":"Date and time when the record was modified.","nullable":false},"name":{"type":"string","description":"Name of the price list.","nullable":false},"typeCode":{"type":"string","description":"Type of the price list.","nullable":false,"enum":["priceList","offer"]},"customers":{"type":"array","description":"Customers.","nullable":false,"items":{"type":"object","nullable":false,"properties":{"id":{"type":"integer","format":"int32","description":"Unique identifier of the customer.","nullable":false},"referenceId":{"type":"string","description":"Unique reference identifier of the customer used by users.","nullable":false}}}},"products":{"type":"array","description":"Prices of products.","nullable":false,"items":{"type":"object","nullable":false,"properties":{"productId":{"type":"integer","format":"int32","nullable":false},"referenceId":{"type":"string","nullable":false},"name":{"type":"string","nullable":false},"variantId":{"type":"integer","format":"int32","nullable":false},"measureUnit":{"type":"string","nullable":false},"transactionCurrencyCode":{"type":"string","nullable":false},"pricePerUnit":{"type":"number","format":"double","nullable":false},"tax":{"type":"number","format":"double","nullable":false},"priceWithOrWithoutTax":{"type":"string","nullable":false,"enum":["taxFree","exciseTax","tax"]},"validFrom":{"type":"string","format":"date-time","nullable":false},"validTo":{"type":"string","format":"date-time","nullable":false}}}}}}}}},"discountsResult":{"type":"object","nullable":false,"properties":{"discounts":{"type":"array","nullable":false,"items":{"type":"object","nullable":false,"properties":{"id":{"type":"integer","format":"int32","description":"Unique identifier of the discount.","nullable":false},"referenceId":{"type":"string","description":"Unique reference identifier of the discount used by users.","nullable":false},"createdOn":{"type":"string","format":"date-time","description":"Date and time when the record was created.","nullable":false},"modifiedOn":{"type":"string","format":"date-time","description":"Date and time when the record was modified.","nullable":false},"name":{"type":"string","description":"Name of the discount.","nullable":false},"typeCode":{"type":"string","description":"Type of the discount.","nullable":false,"enum":["amount","percentage"]},"amount":{"type":"number","format":"double","description":"Amount of the discount.","nullable":false},"percentage":{"type":"number","format":"double","description":"Percentage of the discount.","nullable":false},"transactionCurrencyCode":{"type":"string","description":"Currency of the discount.","nullable":false},"lowQuantity":{"type":"number","format":"double","description":"Limit value.","nullable":false},"validFrom":{"type":"string","format":"date-time","description":"Date from when the discount can be applied.","nullable":false},"validTo":{"type":"string","format":"date-time","description":"Date until when the discount can be applied.","nullable":false}}}}}},"errorResult":{"type":"object","nullable":false,"properties":{"errors":{"type":"object","nullable":false,"additionalProperties":{"type":"array","nullable":false,"items":{"type":"string","nullable":false}}},"type":{"type":"string","nullable":false},"title":{"type":"string","nullable":false},"status":{"type":"integer","format":"int32","nullable":false},"traceId":{"type":"string","nullable":false}}}},"parameters":{"topQParam":{"in":"query","name":"top","description":"Stránkování - počet vrácených záznamů (pokud je jich tolik k dispozici, jinak méně).","required":false,"schema":{"type":"integer","format":"none","nullable":false}},"dbNameParam":{"in":"path","name":"dbName","description":"Systémový název databáze.","required":true,"example":"HeO3_Beta","schema":{"type":"string","format":"none","nullable":false}},"skipQParam":{"in":"query","name":"skip","description":"Stránkování - počet přeskočených záznamů.","required":false,"schema":{"type":"integer","format":"none","nullable":false}},"selectQParam":{"in":"query","name":"select","description":"Seznam sloupců, které chci získat.","required":false,"schema":{"type":"string","format":"none","nullable":false}},"filterQParam":{"in":"query","name":"filter","description":"Podmínka pro výběr dat.","required":false,"schema":{"type":"string","format":"none","nullable":false}},"orderbyQParam":{"in":"query","name":"orderby","description":"Seznam sloupců, podle kterých chci třídit.","required":false,"schema":{"type":"string","format":"none","nullable":false}}},"securitySchemes":{"OAUTHpassword":{"type":"oauth2","flows":{"password":{"tokenUrl":"/oauth/token","scopes":{}}}},"accessToken":{"type":"http","description":"iNuvio's access token.","scheme":"bearer"}}}}