idosell 0.2.5 → 0.3.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (621) hide show
  1. package/README.md +20 -4
  2. package/changelog.md +43 -2
  3. package/dist/app.d.ts +83 -0
  4. package/dist/enums.d.ts +149 -0
  5. package/dist/enums.js +156 -0
  6. package/dist/gates.js +659 -657
  7. package/dist/gateways.d.ts +5102 -0
  8. package/dist/helpers.js +261 -265
  9. package/dist/index.js +11 -19
  10. package/dist/methods/deleteClients.js +5 -6
  11. package/dist/methods/deleteClientsDeliveryAddress.js +11 -11
  12. package/dist/methods/deleteClientsGiftcards.js +11 -11
  13. package/dist/methods/deleteClientsPayerAddress.js +11 -11
  14. package/dist/methods/deleteClientsPricelists.js +5 -6
  15. package/dist/methods/deleteClientsTags.js +12 -12
  16. package/dist/methods/deleteClientsTagsClear.js +5 -6
  17. package/dist/methods/deleteConfigVariables.js +5 -6
  18. package/dist/methods/deleteCouriersPickupPoints.js +11 -11
  19. package/dist/methods/deleteCpa.js +5 -6
  20. package/dist/methods/deleteCpaCampaign.js +5 -6
  21. package/dist/methods/deleteDiscountsGroups.js +5 -6
  22. package/dist/methods/deleteDiscountsGroupsProducts.js +6 -6
  23. package/dist/methods/deleteDiscountsRebatesCard.js +6 -7
  24. package/dist/methods/deleteDiscountsRebatesCode.js +6 -7
  25. package/dist/methods/deleteEntries.js +5 -6
  26. package/dist/methods/deleteMenu.js +12 -12
  27. package/dist/methods/deleteOrdersDocuments.js +11 -11
  28. package/dist/methods/deleteOrdersImages.js +11 -11
  29. package/dist/methods/deleteProducts.js +11 -11
  30. package/dist/methods/deleteProductsBrands.js +6 -6
  31. package/dist/methods/deleteProductsBundlesProducts.js +12 -12
  32. package/dist/methods/deleteProductsCollectionsProducts.js +12 -12
  33. package/dist/methods/deleteProductsImages.js +12 -12
  34. package/dist/methods/deleteProductsOpinions.js +5 -6
  35. package/dist/methods/deleteProductsParameters.js +6 -6
  36. package/dist/methods/deleteProductsProductsToFacebookCatalog.js +6 -6
  37. package/dist/methods/deleteProductsProductsToPromotion.js +6 -6
  38. package/dist/methods/deleteProductsSeries.js +6 -6
  39. package/dist/methods/deleteProductsSizes.js +12 -12
  40. package/dist/methods/deleteResponsibilityEntities.js +5 -6
  41. package/dist/methods/deleteSizecharts.js +6 -6
  42. package/dist/methods/deleteSnippets.js +5 -6
  43. package/dist/methods/deleteSnippetsCampaign.js +5 -6
  44. package/dist/methods/deleteSnippetsCookies.js +5 -6
  45. package/dist/methods/deleteVouchers.js +11 -11
  46. package/dist/methods/deleteWarranties.js +6 -6
  47. package/dist/methods/deleteWmsStocksdocumentsDocuments.js +5 -6
  48. package/dist/methods/deleteWmsStocksdocumentsProducts.js +11 -11
  49. package/dist/methods/deleteWmsSuppliers.js +6 -6
  50. package/dist/methods/getClients.js +11 -12
  51. package/dist/methods/getClientsBalance.js +10 -11
  52. package/dist/methods/getClientsDeliveryAddress.js +5 -6
  53. package/dist/methods/getClientsGiftcardsTypes.js +9 -10
  54. package/dist/methods/getClientsMembershipCards.js +5 -6
  55. package/dist/methods/getClientsPayerAddress.js +9 -10
  56. package/dist/methods/getClientsPricelists.js +9 -10
  57. package/dist/methods/getClientsPricelistsClients.js +5 -6
  58. package/dist/methods/getClientsPricelistsProducts.js +9 -10
  59. package/dist/methods/getClientsPricesActiveCard.js +5 -6
  60. package/dist/methods/getClientsPricesDiscountGroups.js +9 -10
  61. package/dist/methods/getClientsPricesDiscounts.js +10 -11
  62. package/dist/methods/getClientsProfitPoints.js +10 -11
  63. package/dist/methods/getClientsProvinceList.js +5 -6
  64. package/dist/methods/getClientsTags.js +5 -6
  65. package/dist/methods/getConfigVariables.js +9 -6
  66. package/dist/methods/getCouriers.js +9 -10
  67. package/dist/methods/getCouriersAssignedToShippingProfiles.js +5 -6
  68. package/dist/methods/getCouriersPickupPoints.js +9 -10
  69. package/dist/methods/getCpa.js +9 -10
  70. package/dist/methods/getCpaCampaign.js +9 -10
  71. package/dist/methods/getDeliveriesProfiles.js +9 -10
  72. package/dist/methods/getDeliveriesRegions.js +5 -6
  73. package/dist/methods/getDiscountsGroups.js +9 -10
  74. package/dist/methods/getDiscountsGroupsClients.js +5 -6
  75. package/dist/methods/getEntries.js +5 -6
  76. package/dist/methods/getEntriesPagesToDisplay.js +5 -6
  77. package/dist/methods/getEntriesSources.js +5 -6
  78. package/dist/methods/getMenu.js +5 -6
  79. package/dist/methods/getMenuFilter.js +5 -6
  80. package/dist/methods/getOrders.js +5 -6
  81. package/dist/methods/getOrdersAnalytics.js +5 -6
  82. package/dist/methods/getOrdersAuctionDetails.js +10 -11
  83. package/dist/methods/getOrdersDocuments.js +5 -6
  84. package/dist/methods/getOrdersExportdocumentsEPP.js +9 -10
  85. package/dist/methods/getOrdersExportdocumentsJPK.js +9 -10
  86. package/dist/methods/getOrdersHandler.js +5 -6
  87. package/dist/methods/getOrdersHistory.js +5 -6
  88. package/dist/methods/getOrdersImages.js +5 -6
  89. package/dist/methods/getOrdersLabels.js +5 -6
  90. package/dist/methods/getOrdersOpinionsRate.js +5 -6
  91. package/dist/methods/getOrdersPackages.js +5 -6
  92. package/dist/methods/getOrdersPrinterDocuments.js +5 -6
  93. package/dist/methods/getOrdersProfitability.js +5 -6
  94. package/dist/methods/getOrdersWarehouse.js +5 -6
  95. package/dist/methods/getPackagesLabels.js +10 -11
  96. package/dist/methods/getPayments.js +5 -6
  97. package/dist/methods/getPaymentsForms.js +5 -6
  98. package/dist/methods/getPaymentsProfiles.js +9 -10
  99. package/dist/methods/getProducts.js +5 -6
  100. package/dist/methods/getProductsAuctions.js +11 -12
  101. package/dist/methods/getProductsBrands.js +10 -11
  102. package/dist/methods/getProductsBrandsFilter.js +5 -6
  103. package/dist/methods/getProductsCategories.js +10 -11
  104. package/dist/methods/getProductsCodeExistence.js +9 -10
  105. package/dist/methods/getProductsDescriptions.js +5 -6
  106. package/dist/methods/getProductsIdBySizecode.js +5 -6
  107. package/dist/methods/getProductsMarketingAllFacebookCatalogIds.js +5 -6
  108. package/dist/methods/getProductsMarketingPromotion.js +5 -6
  109. package/dist/methods/getProductsMarketingZones.js +9 -10
  110. package/dist/methods/getProductsOmnibusPrices.js +9 -10
  111. package/dist/methods/getProductsOpinions.js +11 -12
  112. package/dist/methods/getProductsOpinionsRate.js +5 -6
  113. package/dist/methods/getProductsProductsToFacebookCatalog.js +5 -6
  114. package/dist/methods/getProductsQuestions.js +5 -6
  115. package/dist/methods/getProductsReservations.js +9 -10
  116. package/dist/methods/getProductsSKUbyBarcode.js +5 -6
  117. package/dist/methods/getProductsSeries.js +9 -10
  118. package/dist/methods/getProductsSeriesFilter.js +5 -6
  119. package/dist/methods/getProductsSizes.js +8 -9
  120. package/dist/methods/getProductsStocks.js +9 -10
  121. package/dist/methods/getProductsStrikethroughPrices.js +9 -10
  122. package/dist/methods/getRefundsGetPossibleAutoRefunds.js +5 -6
  123. package/dist/methods/getRefundsGetRefundStatus.js +5 -6
  124. package/dist/methods/getRefundsRetrieveRefundsList.js +9 -10
  125. package/dist/methods/getResponsibilityEntities.js +9 -10
  126. package/dist/methods/getReturns.js +11 -12
  127. package/dist/methods/getReturnsStatuses.js +5 -6
  128. package/dist/methods/getRma.js +12 -13
  129. package/dist/methods/getRmaStatuses.js +5 -6
  130. package/dist/methods/getShopsCurrencies.js +5 -6
  131. package/dist/methods/getShopsLanguages.js +5 -6
  132. package/dist/methods/getSizecharts.js +9 -10
  133. package/dist/methods/getSizes.js +5 -6
  134. package/dist/methods/getSnippets.js +9 -10
  135. package/dist/methods/getSnippetsCampaign.js +9 -10
  136. package/dist/methods/getSnippetsCookies.js +9 -10
  137. package/dist/methods/getSystemConfig.js +5 -6
  138. package/dist/methods/getSystemCurrencies.js +9 -10
  139. package/dist/methods/getSystemProcessesAutomation.js +5 -6
  140. package/dist/methods/getSystemServerLoad.js +5 -6
  141. package/dist/methods/getSystemServerTime.js +5 -6
  142. package/dist/methods/getSystemShopsData.js +5 -6
  143. package/dist/methods/getSystemUnits.js +5 -6
  144. package/dist/methods/getSystemUsers.js +5 -6
  145. package/dist/methods/getVouchers.js +14 -15
  146. package/dist/methods/getVouchersTypes.js +9 -10
  147. package/dist/methods/getWarranties.js +10 -11
  148. package/dist/methods/getWarrantiesCountTotal.js +5 -6
  149. package/dist/methods/getWmsLocations.js +9 -10
  150. package/dist/methods/getWmsStocksdocumentsDocuments.js +10 -11
  151. package/dist/methods/getWmsStocksdocumentsOpenedDocuments.js +10 -11
  152. package/dist/methods/getWmsStocksdocumentsProducts.js +10 -11
  153. package/dist/methods/getWmsSuppliers.js +9 -10
  154. package/dist/methods/postClients.js +11 -11
  155. package/dist/methods/postClientsBalance.js +9 -10
  156. package/dist/methods/postClientsDeliveryAddress.js +11 -11
  157. package/dist/methods/postClientsGiftcards.js +11 -11
  158. package/dist/methods/postClientsPayerAddress.js +11 -11
  159. package/dist/methods/postClientsPricelists.js +5 -6
  160. package/dist/methods/postClientsProfitPoints.js +5 -6
  161. package/dist/methods/postClientsTags.js +12 -12
  162. package/dist/methods/postCouriersPickupPoints.js +11 -11
  163. package/dist/methods/postCpa.js +11 -6
  164. package/dist/methods/postCpaCampaign.js +11 -6
  165. package/dist/methods/postDeliveriesRegions.js +5 -6
  166. package/dist/methods/postDiscountsGroups.js +5 -6
  167. package/dist/methods/postDiscountsRebatesCard.js +6 -7
  168. package/dist/methods/postDiscountsRebatesCode.js +6 -7
  169. package/dist/methods/postEntries.js +11 -11
  170. package/dist/methods/postMenu.js +12 -12
  171. package/dist/methods/postOrders.js +11 -11
  172. package/dist/methods/postOrdersDocuments.js +11 -11
  173. package/dist/methods/postOrdersDocumentsCreate.js +6 -6
  174. package/dist/methods/postOrdersImages.js +18 -18
  175. package/dist/methods/postOrdersPackages.js +11 -11
  176. package/dist/methods/postPackages.js +11 -11
  177. package/dist/methods/postPackagesLabels.js +11 -11
  178. package/dist/methods/postPayments.js +5 -6
  179. package/dist/methods/postPaymentsCancel.js +5 -6
  180. package/dist/methods/postPaymentsCashback.js +5 -6
  181. package/dist/methods/postPaymentsRepayment.js +5 -6
  182. package/dist/methods/postProducts.js +17 -17
  183. package/dist/methods/postProductsBrands.js +11 -11
  184. package/dist/methods/postProductsBundles.js +12 -12
  185. package/dist/methods/postProductsBundlesProducts.js +12 -12
  186. package/dist/methods/postProductsCollections.js +12 -12
  187. package/dist/methods/postProductsCollectionsProducts.js +12 -12
  188. package/dist/methods/postProductsMarketingPromotion.js +11 -11
  189. package/dist/methods/postProductsOpinions.js +11 -11
  190. package/dist/methods/postProductsProductsToFacebookCatalog.js +6 -6
  191. package/dist/methods/postProductsProductsToPromotion.js +6 -6
  192. package/dist/methods/postProductsRestore.js +6 -7
  193. package/dist/methods/postProductsSynchronizationFile.js +5 -6
  194. package/dist/methods/postRefundsAddAutomaticRefund.js +5 -6
  195. package/dist/methods/postRefundsAddAutomaticRefundForOrder.js +5 -6
  196. package/dist/methods/postRefundsAddManualRefund.js +5 -6
  197. package/dist/methods/postResponsibilityEntities.js +11 -11
  198. package/dist/methods/postReturns.js +11 -11
  199. package/dist/methods/postSnippets.js +11 -6
  200. package/dist/methods/postSnippetsCampaign.js +11 -6
  201. package/dist/methods/postSnippetsCookies.js +11 -6
  202. package/dist/methods/postSubscriptionsAddProduct.js +7 -7
  203. package/dist/methods/postSubscriptionsChangeDeliveryDates.js +7 -7
  204. package/dist/methods/postSubscriptionsChangePriceAutoUpdate.js +7 -7
  205. package/dist/methods/postSubscriptionsChangeStatus.js +7 -7
  206. package/dist/methods/postSubscriptionsDeleteProduct.js +7 -7
  207. package/dist/methods/postSubscriptionsEdit.js +7 -7
  208. package/dist/methods/postSubscriptionsEditProduct.js +7 -7
  209. package/dist/methods/postSubscriptionsItemsList.js +6 -7
  210. package/dist/methods/postSubscriptionsListViewFetchIds.js +7 -7
  211. package/dist/methods/postSubscriptionsListViewList.js +6 -7
  212. package/dist/methods/postSubscriptionsSetRebateCode.js +6 -7
  213. package/dist/methods/postSubscriptionsUnsetRebateCode.js +6 -7
  214. package/dist/methods/postVouchers.js +11 -11
  215. package/dist/methods/postWarranties.js +11 -11
  216. package/dist/methods/postWmsStocksdocumentsDocuments.js +5 -6
  217. package/dist/methods/postWmsStocksdocumentsProducts.js +11 -11
  218. package/dist/methods/putClients.js +11 -11
  219. package/dist/methods/putClientsDeliveryAddress.js +11 -11
  220. package/dist/methods/putClientsExternalCode.js +5 -6
  221. package/dist/methods/putClientsGiftcards.js +16 -16
  222. package/dist/methods/putClientsGiftcardsBlock.js +11 -11
  223. package/dist/methods/putClientsGiftcardsUnblock.js +11 -11
  224. package/dist/methods/putClientsMembershipCards.js +11 -11
  225. package/dist/methods/putClientsPayerAddress.js +11 -11
  226. package/dist/methods/putClientsPricelists.js +5 -6
  227. package/dist/methods/putClientsPricelistsClients.js +6 -6
  228. package/dist/methods/putClientsPricelistsProducts.js +6 -6
  229. package/dist/methods/putClientsPricelistsRename.js +5 -6
  230. package/dist/methods/putClientsPricesDiscounts.js +11 -11
  231. package/dist/methods/putClientsTags.js +11 -11
  232. package/dist/methods/putConfigVariables.js +11 -6
  233. package/dist/methods/putCouriersPickupPoints.js +11 -11
  234. package/dist/methods/putCpa.js +11 -6
  235. package/dist/methods/putCpaCampaign.js +11 -6
  236. package/dist/methods/putDeliveriesDefaultProfiles.js +5 -6
  237. package/dist/methods/putDiscountsGroups.js +5 -6
  238. package/dist/methods/putDiscountsGroupsProducts.js +6 -6
  239. package/dist/methods/putDiscountsRebatesBlockCard.js +6 -7
  240. package/dist/methods/putDiscountsRebatesUnblockCard.js +6 -7
  241. package/dist/methods/putEntries.js +6 -6
  242. package/dist/methods/putMenu.js +12 -12
  243. package/dist/methods/putMenuFilter.js +11 -11
  244. package/dist/methods/putMenuSort.js +12 -12
  245. package/dist/methods/putOrders.js +11 -11
  246. package/dist/methods/putOrdersClient.js +5 -6
  247. package/dist/methods/putOrdersCourier.js +5 -6
  248. package/dist/methods/putOrdersDeliveryAddress.js +5 -6
  249. package/dist/methods/putOrdersDevide.js +11 -11
  250. package/dist/methods/putOrdersHandler.js +5 -6
  251. package/dist/methods/putOrdersPackages.js +11 -11
  252. package/dist/methods/putOrdersPickupPoint.js +5 -6
  253. package/dist/methods/putOrdersProductsSerialNumbers.js +11 -11
  254. package/dist/methods/putOrdersProfitMargin.js +11 -11
  255. package/dist/methods/putOrdersShippingCosts.js +5 -6
  256. package/dist/methods/putOrdersWarehouse.js +5 -6
  257. package/dist/methods/putPackages.js +11 -11
  258. package/dist/methods/putPayments.js +5 -6
  259. package/dist/methods/putPaymentsConfirm.js +5 -6
  260. package/dist/methods/putProducts.js +28 -21
  261. package/dist/methods/putProductsAttachments.js +11 -11
  262. package/dist/methods/putProductsBrands.js +11 -11
  263. package/dist/methods/putProductsBrandsFilter.js +11 -11
  264. package/dist/methods/putProductsBundlesProductsQuantity.js +12 -12
  265. package/dist/methods/putProductsBundlesRenew.js +12 -12
  266. package/dist/methods/putProductsCategories.js +11 -11
  267. package/dist/methods/putProductsCollectionsProducts.js +12 -12
  268. package/dist/methods/putProductsCollectionsRenew.js +12 -12
  269. package/dist/methods/putProductsDescriptions.js +15 -15
  270. package/dist/methods/putProductsGroupsMainProduct.js +11 -11
  271. package/dist/methods/putProductsGroupsOrder.js +16 -14
  272. package/dist/methods/putProductsGroupsSettings.js +11 -11
  273. package/dist/methods/putProductsImages.js +24 -21
  274. package/dist/methods/putProductsMarketingPromotion.js +11 -11
  275. package/dist/methods/putProductsMarketingZones.js +11 -11
  276. package/dist/methods/putProductsOmnibusPrices.js +11 -11
  277. package/dist/methods/putProductsOpinions.js +5 -6
  278. package/dist/methods/putProductsParameters.js +12 -12
  279. package/dist/methods/putProductsQuestions.js +11 -11
  280. package/dist/methods/putProductsSeries.js +11 -11
  281. package/dist/methods/putProductsSeriesFilter.js +11 -11
  282. package/dist/methods/putProductsSizes.js +12 -12
  283. package/dist/methods/putProductsStockQuantity.js +11 -11
  284. package/dist/methods/putProductsStocks.js +11 -11
  285. package/dist/methods/putProductsStrikethroughPrices.js +11 -11
  286. package/dist/methods/putProductsSupplierCode.js +11 -11
  287. package/dist/methods/putProductsSupplierProductData.js +11 -11
  288. package/dist/methods/putProductsSynchronizationFinishUpload.js +5 -6
  289. package/dist/methods/putRefundsCancelRefund.js +5 -6
  290. package/dist/methods/putRefundsConfirmRefund.js +5 -6
  291. package/dist/methods/putRefundsUpdateRefund.js +5 -6
  292. package/dist/methods/putResponsibilityEntities.js +11 -11
  293. package/dist/methods/putReturns.js +11 -11
  294. package/dist/methods/putReturnsSerialNumber.js +11 -11
  295. package/dist/methods/putRma.js +11 -11
  296. package/dist/methods/putSizecharts.js +11 -11
  297. package/dist/methods/putSizes.js +11 -11
  298. package/dist/methods/putSnippets.js +11 -6
  299. package/dist/methods/putSnippetsCampaign.js +11 -6
  300. package/dist/methods/putSnippetsCookies.js +11 -6
  301. package/dist/methods/putSystemConfig.js +5 -6
  302. package/dist/methods/putSystemCurrencies.js +12 -12
  303. package/dist/methods/putSystemProcessesAutomation.js +5 -6
  304. package/dist/methods/putSystemUnits.js +11 -11
  305. package/dist/methods/putVouchers.js +11 -11
  306. package/dist/methods/putVouchersBlock.js +11 -11
  307. package/dist/methods/putVouchersUnblock.js +11 -11
  308. package/dist/methods/putWarranties.js +11 -11
  309. package/dist/methods/putWarrantiesLanguageData.js +11 -11
  310. package/dist/methods/putWmsStocksdocumentsAcceptMM.js +5 -6
  311. package/dist/methods/putWmsStocksdocumentsClose.js +5 -6
  312. package/dist/methods/putWmsStocksdocumentsDocuments.js +5 -6
  313. package/dist/methods/putWmsStocksdocumentsProducts.js +11 -11
  314. package/dist/methods/putWmsStocksdocumentsRejectMM.js +5 -6
  315. package/dist/methods/putWmsSuppliers.js +11 -11
  316. package/dist/methods/searchClientsCrm.js +13 -13
  317. package/dist/methods/searchClientsGiftcards.js +12 -12
  318. package/dist/methods/searchClientsNewsletterEmail.js +12 -12
  319. package/dist/methods/searchClientsNewsletterSms.js +12 -12
  320. package/dist/methods/searchOrders.js +26 -25
  321. package/dist/methods/searchOrdersOpinions.js +17 -17
  322. package/dist/methods/searchOrdersUnfinished.js +26 -25
  323. package/dist/methods/searchPackages.js +16 -16
  324. package/dist/methods/searchProducts.js +30 -25
  325. package/dist/methods/searchProductsCategoriesIdosell.js +11 -11
  326. package/dist/methods/searchProductsDeliveryTime.js +11 -11
  327. package/dist/methods/searchProductsParameters.js +10 -10
  328. package/dist/params.js +54 -41
  329. package/dist/request.js +122 -104
  330. package/dist/responses.d.ts +2928 -0
  331. package/package.json +2 -1
  332. package/tests/deleteClients.test.js +7 -0
  333. package/tests/deleteClientsDeliveryAddress.test.js +1 -1
  334. package/tests/deleteClientsGiftcards.test.js +1 -1
  335. package/tests/deleteClientsPayerAddress.test.js +1 -1
  336. package/tests/deleteClientsPricelists.test.js +1 -1
  337. package/tests/deleteClientsTags.test.js +1 -1
  338. package/tests/deleteClientsTagsClear.test.js +1 -1
  339. package/tests/deleteConfigVariables.test.js +7 -0
  340. package/tests/deleteCouriersPickupPoints.test.js +1 -1
  341. package/tests/deleteCpa.test.js +7 -0
  342. package/tests/deleteCpaCampaign.test.js +7 -0
  343. package/tests/deleteDiscountsGroups.test.js +1 -1
  344. package/tests/deleteDiscountsGroupsProducts.test.js +1 -1
  345. package/tests/deleteDiscountsRebatesCard.test.js +1 -1
  346. package/tests/deleteDiscountsRebatesCode.test.js +1 -1
  347. package/tests/deleteEntries.test.js +1 -1
  348. package/tests/deleteMenu.test.js +1 -1
  349. package/tests/deleteOrdersDocuments.test.js +1 -1
  350. package/tests/deleteOrdersImages.test.js +1 -1
  351. package/tests/deleteProducts.test.js +1 -1
  352. package/tests/deleteProductsBrands.test.js +1 -1
  353. package/tests/deleteProductsCollectionsProducts.test.js +1 -1
  354. package/tests/deleteProductsImages.test.js +1 -1
  355. package/tests/deleteProductsOpinions.test.js +1 -1
  356. package/tests/deleteProductsParameters.test.js +1 -1
  357. package/tests/deleteProductsProductsToFacebookCatalog.test.js +1 -1
  358. package/tests/deleteProductsProductsToPromotion.test.js +1 -1
  359. package/tests/deleteProductsSeries.test.js +1 -1
  360. package/tests/deleteProductsSizes.test.js +1 -1
  361. package/tests/deleteResponsibilityEntities.test.js +7 -0
  362. package/tests/deleteSizecharts.test.js +1 -1
  363. package/tests/deleteSnippets.test.js +7 -0
  364. package/tests/deleteSnippetsCampaign.test.js +7 -0
  365. package/tests/deleteSnippetsCookies.test.js +7 -0
  366. package/tests/deleteVouchers.test.js +1 -1
  367. package/tests/deleteWarranties.test.js +1 -1
  368. package/tests/deleteWmsStocksdocumentsDocuments.test.js +1 -1
  369. package/tests/deleteWmsStocksdocumentsProducts.test.js +1 -1
  370. package/tests/deleteWmsSuppliers.test.js +1 -1
  371. package/tests/getClients.test.js +1 -1
  372. package/tests/getClientsBalance.test.js +1 -1
  373. package/tests/getClientsDeliveryAddress.test.js +1 -1
  374. package/tests/getClientsGiftcardsTypes.test.js +1 -1
  375. package/tests/getClientsMembershipCards.test.js +1 -1
  376. package/tests/getClientsPayerAddress.test.js +1 -1
  377. package/tests/getClientsPricelists.test.js +1 -1
  378. package/tests/getClientsPricelistsClients.test.js +1 -1
  379. package/tests/getClientsPricelistsProducts.test.js +1 -1
  380. package/tests/getClientsPricesDiscountGroups.test.js +1 -1
  381. package/tests/getClientsPricesDiscounts.test.js +1 -1
  382. package/tests/getClientsProfitPoints.test.js +1 -1
  383. package/tests/getClientsProvinceList.test.js +1 -1
  384. package/tests/getClientsTags.test.js +1 -1
  385. package/tests/getConfigVariables.test.js +7 -0
  386. package/tests/getCouriers.test.js +1 -1
  387. package/tests/getCouriersPickupPoints.test.js +1 -1
  388. package/tests/getCpa.test.js +1 -1
  389. package/tests/getCpaCampaign.test.js +1 -1
  390. package/tests/getDeliveriesProfiles.test.js +1 -1
  391. package/tests/getDeliveriesRegions.test.js +1 -1
  392. package/tests/getDiscountsGroups.test.js +1 -1
  393. package/tests/getDiscountsGroupsClients.test.js +1 -1
  394. package/tests/getEntries.test.js +1 -1
  395. package/tests/getEntriesPagesToDisplay.test.js +1 -1
  396. package/tests/getEntriesSources.test.js +1 -1
  397. package/tests/getMenu.test.js +1 -1
  398. package/tests/getMenuFilter.test.js +1 -1
  399. package/tests/getOrders.test.js +1 -1
  400. package/tests/getOrdersAnalytics.test.js +1 -1
  401. package/tests/getOrdersAuctionDetails.test.js +1 -1
  402. package/tests/getOrdersDocuments.test.js +1 -1
  403. package/tests/getOrdersExportdocumentsEPP.test.js +1 -1
  404. package/tests/getOrdersExportdocumentsJPK.test.js +1 -1
  405. package/tests/getOrdersHandler.test.js +1 -1
  406. package/tests/getOrdersHistory.test.js +1 -1
  407. package/tests/getOrdersImages.test.js +1 -1
  408. package/tests/getOrdersLabels.test.js +1 -1
  409. package/tests/getOrdersOpinionsRate.test.js +1 -1
  410. package/tests/getOrdersPackages.test.js +1 -1
  411. package/tests/getOrdersProfitability.test.js +1 -1
  412. package/tests/getOrdersWarehouse.test.js +1 -1
  413. package/tests/getPackagesLabels.test.js +1 -1
  414. package/tests/getPayments.test.js +1 -1
  415. package/tests/getPaymentsForms.test.js +1 -1
  416. package/tests/getPaymentsProfiles.test.js +1 -1
  417. package/tests/getProducts.test.js +1 -1
  418. package/tests/getProductsAuctions.test.js +1 -1
  419. package/tests/getProductsBrands.test.js +1 -1
  420. package/tests/getProductsBrandsFilter.test.js +1 -1
  421. package/tests/getProductsCategories.test.js +1 -1
  422. package/tests/getProductsCodeExistence.test.js +1 -1
  423. package/tests/getProductsDescriptions.test.js +1 -1
  424. package/tests/getProductsIdBySizecode.test.js +1 -1
  425. package/tests/getProductsMarketingAllFacebookCatalogIds.test.js +1 -1
  426. package/tests/getProductsMarketingPromotion.test.js +1 -1
  427. package/tests/getProductsMarketingZones.test.js +1 -1
  428. package/tests/getProductsOmnibusPrices.test.js +1 -1
  429. package/tests/getProductsOpinions.test.js +1 -1
  430. package/tests/getProductsOpinionsRate.test.js +1 -1
  431. package/tests/getProductsProductsToFacebookCatalog.test.js +1 -1
  432. package/tests/getProductsQuestions.test.js +1 -1
  433. package/tests/getProductsReservations.test.js +1 -1
  434. package/tests/getProductsSKUbyBarcode.test.js +1 -1
  435. package/tests/getProductsSeries.test.js +1 -1
  436. package/tests/getProductsSeriesFilter.test.js +1 -1
  437. package/tests/getProductsSizes.test.js +1 -1
  438. package/tests/getProductsStocks.test.js +1 -1
  439. package/tests/getProductsStrikethroughPrices.test.js +1 -1
  440. package/tests/getRefundsGetPossibleAutoRefunds.test.js +1 -1
  441. package/tests/getRefundsGetRefundStatus.test.js +1 -1
  442. package/tests/getRefundsRetrieveRefundsList.test.js +1 -1
  443. package/tests/getResponsibilityEntities.test.js +7 -0
  444. package/tests/getReturns.test.js +1 -1
  445. package/tests/getRma.test.js +1 -1
  446. package/tests/getSizecharts.test.js +1 -1
  447. package/tests/getSizes.test.js +1 -1
  448. package/tests/getSnippets.test.js +7 -0
  449. package/tests/getSnippetsCampaign.test.js +7 -0
  450. package/tests/getSnippetsCookies.test.js +7 -0
  451. package/tests/getSystemCurrencies.test.js +1 -1
  452. package/tests/getSystemProcessesAutomation.test.js +1 -1
  453. package/tests/getSystemUnits.test.js +1 -1
  454. package/tests/getSystemUsers.test.js +1 -1
  455. package/tests/getVouchers.test.js +1 -1
  456. package/tests/getVouchersTypes.test.js +1 -1
  457. package/tests/getWarranties.test.js +1 -1
  458. package/tests/getWarrantiesCountTotal.test.js +1 -1
  459. package/tests/getWmsLocations.test.js +1 -1
  460. package/tests/getWmsStocksdocumentsDocuments.test.js +1 -1
  461. package/tests/getWmsStocksdocumentsOpenedDocuments.test.js +1 -1
  462. package/tests/getWmsStocksdocumentsProducts.test.js +1 -1
  463. package/tests/getWmsSuppliers.test.js +1 -1
  464. package/tests/postClients.test.js +1 -1
  465. package/tests/postClientsBalance.test.js +1 -1
  466. package/tests/postClientsDeliveryAddress.test.js +1 -1
  467. package/tests/postClientsGiftcards.test.js +1 -1
  468. package/tests/postClientsPayerAddress.test.js +1 -1
  469. package/tests/postClientsPricelists.test.js +1 -1
  470. package/tests/postClientsProfitPoints.test.js +1 -1
  471. package/tests/postClientsTags.test.js +1 -1
  472. package/tests/postCouriersPickupPoints.test.js +1 -1
  473. package/tests/postCpa.test.js +7 -0
  474. package/tests/postCpaCampaign.test.js +7 -0
  475. package/tests/postDeliveriesRegions.test.js +1 -1
  476. package/tests/postDiscountsGroups.test.js +1 -1
  477. package/tests/postDiscountsRebatesCard.test.js +1 -1
  478. package/tests/postDiscountsRebatesCode.test.js +1 -1
  479. package/tests/postEntries.test.js +1 -1
  480. package/tests/postMenu.test.js +1 -1
  481. package/tests/postOrders.test.js +1 -1
  482. package/tests/postOrdersDocuments.test.js +1 -1
  483. package/tests/postOrdersDocumentsCreate.test.js +1 -1
  484. package/tests/postOrdersImages.test.js +2 -2
  485. package/tests/postOrdersPackages.test.js +1 -1
  486. package/tests/postPackages.test.js +1 -1
  487. package/tests/postPackagesLabels.test.js +1 -1
  488. package/tests/postPayments.test.js +1 -1
  489. package/tests/postPaymentsCancel.test.js +1 -1
  490. package/tests/postPaymentsCashback.test.js +1 -1
  491. package/tests/postPaymentsRepayment.test.js +1 -1
  492. package/tests/postProducts.test.js +1 -1
  493. package/tests/postProductsBrands.test.js +1 -1
  494. package/tests/postProductsCollections.test.js +1 -1
  495. package/tests/postProductsCollectionsProducts.test.js +1 -1
  496. package/tests/postProductsMarketingPromotion.test.js +1 -1
  497. package/tests/postProductsOpinions.test.js +1 -1
  498. package/tests/postProductsProductsToFacebookCatalog.test.js +1 -1
  499. package/tests/postProductsProductsToPromotion.test.js +1 -1
  500. package/tests/postProductsRestore.test.js +1 -1
  501. package/tests/postRefundsAddAutomaticRefund.test.js +1 -1
  502. package/tests/postRefundsAddAutomaticRefundForOrder.test.js +1 -1
  503. package/tests/postRefundsAddManualRefund.test.js +1 -1
  504. package/tests/postResponsibilityEntities.test.js +7 -0
  505. package/tests/postReturns.test.js +1 -1
  506. package/tests/postSnippets.test.js +7 -0
  507. package/tests/postSnippetsCampaign.test.js +7 -0
  508. package/tests/postSnippetsCookies.test.js +7 -0
  509. package/tests/postVouchers.test.js +1 -1
  510. package/tests/postWarranties.test.js +1 -1
  511. package/tests/postWmsStocksdocumentsDocuments.test.js +1 -1
  512. package/tests/postWmsStocksdocumentsProducts.test.js +1 -1
  513. package/tests/putClients.test.js +1 -1
  514. package/tests/putClientsDeliveryAddress.test.js +1 -1
  515. package/tests/putClientsExternalCode.test.js +1 -1
  516. package/tests/putClientsGiftcards.test.js +1 -1
  517. package/tests/putClientsGiftcardsBlock.test.js +1 -1
  518. package/tests/putClientsGiftcardsUnblock.test.js +1 -1
  519. package/tests/putClientsMembershipCards.test.js +1 -1
  520. package/tests/putClientsPayerAddress.test.js +1 -1
  521. package/tests/putClientsPricelists.test.js +1 -1
  522. package/tests/putClientsPricelistsClients.test.js +1 -1
  523. package/tests/putClientsPricelistsProducts.test.js +2 -2
  524. package/tests/putClientsPricelistsRename.test.js +1 -1
  525. package/tests/putClientsPricesDiscounts.test.js +1 -1
  526. package/tests/putClientsTags.test.js +1 -1
  527. package/tests/putConfigVariables.test.js +7 -0
  528. package/tests/putCouriersPickupPoints.test.js +1 -1
  529. package/tests/putCpa.test.js +7 -0
  530. package/tests/putCpaCampaign.test.js +7 -0
  531. package/tests/putDeliveriesDefaultProfiles.test.js +1 -1
  532. package/tests/putDiscountsGroups.test.js +1 -1
  533. package/tests/putDiscountsGroupsProducts.test.js +1 -1
  534. package/tests/putDiscountsRebatesBlockCard.test.js +1 -1
  535. package/tests/putDiscountsRebatesUnblockCard.test.js +1 -1
  536. package/tests/putEntries.test.js +1 -1
  537. package/tests/putMenu.test.js +1 -1
  538. package/tests/putMenuFilter.test.js +1 -1
  539. package/tests/putMenuSort.test.js +1 -1
  540. package/tests/putOrders.test.js +1 -1
  541. package/tests/putOrdersCourier.test.js +1 -1
  542. package/tests/putOrdersDeliveryAddress.test.js +1 -1
  543. package/tests/putOrdersDevide.test.js +1 -1
  544. package/tests/putOrdersHandler.test.js +1 -1
  545. package/tests/putOrdersPackages.test.js +1 -1
  546. package/tests/putOrdersPickupPoint.test.js +1 -1
  547. package/tests/putOrdersProductsSerialNumbers.test.js +1 -1
  548. package/tests/putOrdersProfitMargin.test.js +1 -1
  549. package/tests/putOrdersShippingCosts.test.js +1 -1
  550. package/tests/putOrdersWarehouse.test.js +1 -1
  551. package/tests/putPackages.test.js +1 -1
  552. package/tests/putPayments.test.js +1 -1
  553. package/tests/putPaymentsConfirm.test.js +1 -1
  554. package/tests/putProducts.test.js +1 -1
  555. package/tests/putProductsAttachments.test.js +1 -1
  556. package/tests/putProductsBrands.test.js +1 -1
  557. package/tests/putProductsBrandsFilter.test.js +1 -1
  558. package/tests/putProductsCategories.test.js +1 -1
  559. package/tests/putProductsCollectionsProducts.test.js +1 -1
  560. package/tests/putProductsCollectionsRenew.test.js +1 -1
  561. package/tests/putProductsDescriptions.test.js +1 -1
  562. package/tests/putProductsGroupsMainProduct.test.js +1 -1
  563. package/tests/putProductsGroupsOrder.test.js +1 -1
  564. package/tests/putProductsGroupsSettings.test.js +1 -1
  565. package/tests/putProductsImages.test.js +1 -1
  566. package/tests/putProductsMarketingPromotion.test.js +1 -1
  567. package/tests/putProductsMarketingZones.test.js +1 -1
  568. package/tests/putProductsOmnibusPrices.test.js +1 -1
  569. package/tests/putProductsOpinions.test.js +1 -1
  570. package/tests/putProductsParameters.test.js +1 -1
  571. package/tests/putProductsQuestions.test.js +1 -1
  572. package/tests/putProductsSeries.test.js +1 -1
  573. package/tests/putProductsSeriesFilter.test.js +1 -1
  574. package/tests/putProductsSizes.test.js +1 -1
  575. package/tests/putProductsStockQuantity.test.js +1 -1
  576. package/tests/putProductsStocks.test.js +1 -1
  577. package/tests/putProductsStrikethroughPrices.test.js +1 -1
  578. package/tests/putProductsSupplierCode.test.js +1 -1
  579. package/tests/putProductsSupplierProductData.test.js +1 -1
  580. package/tests/putRefundsCancelRefund.test.js +1 -1
  581. package/tests/putRefundsConfirmRefund.test.js +1 -1
  582. package/tests/putRefundsUpdateRefund.test.js +1 -1
  583. package/tests/putResponsibilityEntities.test.js +7 -0
  584. package/tests/putReturns.test.js +3 -3
  585. package/tests/putReturnsSerialNumber.test.js +1 -1
  586. package/tests/putRma.test.js +1 -1
  587. package/tests/putSizecharts.test.js +1 -1
  588. package/tests/putSizes.test.js +1 -1
  589. package/tests/putSnippets.test.js +7 -0
  590. package/tests/putSnippetsCampaign.test.js +7 -0
  591. package/tests/putSnippetsCookies.test.js +7 -0
  592. package/tests/putSystemConfig.test.js +1 -1
  593. package/tests/putSystemCurrencies.test.js +1 -1
  594. package/tests/putSystemProcessesAutomation.test.js +1 -1
  595. package/tests/putSystemUnits.test.js +1 -1
  596. package/tests/putVouchers.test.js +1 -1
  597. package/tests/putVouchersBlock.test.js +1 -1
  598. package/tests/putVouchersUnblock.test.js +1 -1
  599. package/tests/putWarranties.test.js +1 -1
  600. package/tests/putWarrantiesLanguageData.test.js +1 -1
  601. package/tests/putWmsStocksdocumentsAcceptMM.test.js +1 -1
  602. package/tests/putWmsStocksdocumentsClose.test.js +1 -1
  603. package/tests/putWmsStocksdocumentsDocuments.test.js +1 -1
  604. package/tests/putWmsStocksdocumentsProducts.test.js +1 -1
  605. package/tests/putWmsStocksdocumentsRejectMM.test.js +1 -1
  606. package/tests/putWmsSuppliers.test.js +1 -1
  607. package/tests/rootparams.test.js +1 -1
  608. package/tests/searchClientsCrm.test.js +1 -1
  609. package/tests/searchClientsGiftcards.test.js +1 -1
  610. package/tests/searchClientsNewsletterEmail.test.js +1 -1
  611. package/tests/searchClientsNewsletterSms.test.js +1 -1
  612. package/tests/searchOrders.test.js +1 -1
  613. package/tests/searchOrdersOpinions.test.js +13 -13
  614. package/tests/searchOrdersUnfinished.test.js +1 -1
  615. package/tests/searchPackages.test.js +1 -1
  616. package/tests/searchProducts.test.js +2 -2
  617. package/tests/searchProductsCategoriesIdosell.test.js +1 -1
  618. package/tests/searchProductsDeliveryTime.test.js +1 -1
  619. package/tests/searchProductsParameters.test.js +1 -1
  620. package/tests/url.test.js +1 -1
  621. package/dist/gates.def.js +0 -3986
@@ -0,0 +1,2928 @@
1
+ type PagedResponse = {
2
+ /** @description Number of all results found */
3
+ resultsNumberAll: number;
4
+ /** @description Number of pages of results found */
5
+ resultsNumberPage: number;
6
+ /** @description Page with results number. Numeration starts from 0 */
7
+ resultsPage: number;
8
+ /** @description Number of results on page. Value from 1 to 100 */
9
+ resultsLimit: number;
10
+ }
11
+
12
+ type PagedSnakecaseResponse = {
13
+ /** @description Total number of found elements. */
14
+ results_number_all: number;
15
+ /** @description Number of pages of results found. */
16
+ results_number_page: number;
17
+ /** @description Page with results number. Numeration starts from 0. */
18
+ results_page: number;
19
+ /** @description Number of results on page. Value from 1 to 100. */
20
+ results_limit: number;
21
+ }
22
+
23
+ type FaultCodeString = {
24
+ /** @description Error code. */
25
+ faultCode: number;
26
+ /** @description Error description. */
27
+ faultString: string;
28
+ }
29
+
30
+ export type SearchOrdersResponse = {
31
+ Results: {
32
+ /** @description Order ID i.e. login-1 */
33
+ orderId: string;
34
+ /** @description Order note supported by IAI Bridge. */
35
+ orderBridgeNote: string;
36
+ /** @description Order serial number. i.e. 12345 */
37
+ orderSerialNumber: number;
38
+ /** @description Order type. List of values: "p" - wholesale order placed in panel, "t" - wholesale order placed in shop, "n" - retail order placed in shop, "r" - retail order placed in panel. */
39
+ orderType: "p" | "t" | "n" | "r";
40
+ /** @description Customer data. */
41
+ clientResult: {
42
+ /** @description Client's billing address' data. */
43
+ clientBillingAddress: {
44
+ /** @description Customer's first name. */
45
+ clientFirstName: string;
46
+ /** @description Customer's last name. */
47
+ clientLastName: string;
48
+ /** @description Customer Tax no. */
49
+ clientNip: string;
50
+ /** @description Customer's company name. */
51
+ clientFirm: string;
52
+ /** @description Product suggestion. */
53
+ clientAdditional: string;
54
+ /** @description Street and number. */
55
+ clientStreet: string;
56
+ /** @description Customer's postal code. */
57
+ clientZipCode: string;
58
+ /** @description Customer's city. */
59
+ clientCity: string;
60
+ /** @description Region name takes priority over clientCountryId. */
61
+ clientCountryName: string;
62
+ /** @description Country ID in accordance with ISO-3166. */
63
+ clientCountryId: string;
64
+ /** @description Cell phone. */
65
+ clientPhone1: string;
66
+ /** @description Land line. */
67
+ clientPhone2: string;
68
+ /** @description Administrative region code. */
69
+ clientProvinceId: string;
70
+ /** @description Administrative region. */
71
+ clientProvince: string;
72
+ };
73
+ /** @description Delivery address data. */
74
+ clientDeliveryAddress: {
75
+ /** @description Delivery address ID. */
76
+ clientDeliveryAddressId: string;
77
+ /** @description Recipient's first name. */
78
+ clientDeliveryAddressFirstName: string;
79
+ /** @description Recipient's last name. */
80
+ clientDeliveryAddressLastName: string;
81
+ /** @description Company name. */
82
+ clientDeliveryAddressFirm: string;
83
+ /** @description Recipient street and number. */
84
+ clientDeliveryAddressStreet: string;
85
+ /** @description Recipient's postal code. */
86
+ clientDeliveryAddressZipCode: string;
87
+ /** @description Recipient's city. */
88
+ clientDeliveryAddressCity: string;
89
+ /** @description Recipient's country. */
90
+ clientDeliveryAddressCountry: string;
91
+ /** @description Country code in ISO 3166-1 standard. */
92
+ clientDeliveryAddressCountryId: string;
93
+ /** @description Cell phone. */
94
+ clientDeliveryAddressPhone1: string;
95
+ /** @description Land line. */
96
+ clientDeliveryAddressPhone2: string;
97
+ /** @description Administrative region code. */
98
+ clientDeliveryAddressProvinceId: string;
99
+ /** @description Administrative region. */
100
+ clientDeliveryAddressProvince: string;
101
+ /** @description Type of delivery address resulting from the type of delivery e.g. collection point. Available values: "client" - Address provided by customer to which he/she wishes to receive the shipment, "pickupPoint"- The address of the pickup point selected by the customer from which the customer wishes to pick up the order, "warehouse" - The address of the warehouse selected by the customer from which the customer wishes to pick up the order. */
102
+ clientDeliveryAddressType: "client" | "pickupPoint" | "warehouse";
103
+ /** @description Internal Receiving Point Identifier. */
104
+ clientDeliveryAddressPickupPointInternalId: number;
105
+ };
106
+ clientPickupPointAddress: {
107
+ /** @description Collection point ID. */
108
+ pickupPointId: string;
109
+ /** @description Town / City. */
110
+ city: string;
111
+ /** @description Address. */
112
+ street: string;
113
+ /** @description ZIP / Post code. */
114
+ zipCode: string;
115
+ description: string;
116
+ /** @description Latitude. */
117
+ latitude: number;
118
+ /** @description Longitude. */
119
+ longitude: number;
120
+ /** @description Name. */
121
+ name: string;
122
+ };
123
+ /** @description Buyer's address data. */
124
+ payerAddress: {
125
+ /** @description Buyer's address id. */
126
+ payerAddressId: string;
127
+ /** @description Buyer's first name. */
128
+ payerAddressFirstName: string;
129
+ /** @description Buyer's last name. */
130
+ payerAddressLastName: string;
131
+ /** @description Company name. */
132
+ payerAddressFirm: string;
133
+ /** @description Customer VAT ID. */
134
+ payerAddressNip: string;
135
+ /** @description Buyer's street name and house number. */
136
+ payerAddressStreet: string;
137
+ /** @description Buyer's postal code. */
138
+ payerAddressZipCode: string;
139
+ /** @description Buyer's city. */
140
+ payerAddressCity: string;
141
+ /** @description Buyer's country. */
142
+ payerAddressCountry: string;
143
+ /** @description Country code in the ISO 3166-1 A2 standard. */
144
+ payerAddressCountryId: string;
145
+ /** @description Buyer's telephone number. */
146
+ payerAddressPhone: string;
147
+ };
148
+ /** @description Data of customer account in store. */
149
+ clientAccount: {
150
+ /** @description Unique client's number. */
151
+ clientId: number;
152
+ /** @description Customer's login. */
153
+ clientLogin: string;
154
+ /** @description E-mail address. */
155
+ clientEmail: string;
156
+ /** @description Cell phone. */
157
+ clientPhone1: string;
158
+ /** @description Land line. */
159
+ clientPhone2: string;
160
+ /** @description External system code. */
161
+ clientCodeExternal: string;
162
+ };
163
+ /** @description End customer details. */
164
+ endClientAccount: {
165
+ /** @description Unique client's number. */
166
+ clientId: number;
167
+ /** @description Customer's login. */
168
+ clientLogin: string;
169
+ /** @description E-mail address. */
170
+ clientEmail: string;
171
+ /** @description Cell phone. */
172
+ clientPhone1: string;
173
+ /** @description Land line. */
174
+ clientPhone2: string;
175
+ /** @description External system code. */
176
+ clientCodeExternal: string;
177
+ };
178
+ };
179
+ /** @description Order data. */
180
+ orderDetails: {
181
+ /** @description Flag informing on order registration or completion in external program through API. Allowed values. "none" - order was not registered in external program, "registered" - order was registered in external program, "realized" - order was completed in external program, "registered_pos" - order was registered in external program, "realized_pos" - order was completed in external program. */
182
+ apiFlag: "none" | "registered" | "realized" | "registered_pos" | "realized_pos" | "registration_fault";
183
+ /** @description Order status. Allowed values: "finished_ext" - order status: completed in FA application, "finished" - completed, "new" - not handled, "payment_waiting" - awaiting payment, "delivery_waiting" - awaiting delivery, "on_order" - in progress, "packed" - being picked, "packed_fulfillment" - being picked - fulfilment, "packed_ready" - packed, "ready" - ready, "wait_for_dispatch" - awaiting dispatch date, "suspended" - on hold, "joined" - merged, "missing" - missing, "lost" - lost, "false" - false, "canceled" - Customer canceled. */
184
+ orderStatus: string;
185
+ dropshippingOrderStatus: string;
186
+ /** @description Type of order confirmation. Confirmations listing: "none" - order unconfirmed , "email" - order confirmed by e-mail, "phone_client" - order confirmed by phone call made by client, "phone_service" - order confirmed by phone call made by staff, "postauction" - order confirmed by auction return page, "willingness" - confirmed by willingness to buy letter, "auctionfod" - confirmed by after-sales form Allegro. */
187
+ orderConfirmation: string;
188
+ /** @description Date of order placing in YYYY-MM-DD HH:MM:SS format. */
189
+ orderAddDate: string;
190
+ /** @description Date of order sending in YYYY-MM-DD HH:MM:SS format. */
191
+ orderDispatchDate: string;
192
+ receivedDate: string;
193
+ /** @description Order handling time in seconds. */
194
+ orderPrepareTime: string;
195
+ /** @description Customer comments on order. */
196
+ clientNoteToOrder: string;
197
+ /** @description Customer remarks for courier. */
198
+ clientNoteToCourier: string;
199
+ /** @description Order payment data. */
200
+ payments: {
201
+ /** @description Order payment method. Allowed values. "cash_on_delivery" - cash on delivery, "prepaid" - prepayment, "tradecredit" - Trade credit. */
202
+ orderPaymentType: string;
203
+ /** @description Number of days. */
204
+ orderPaymentDays: number;
205
+ /** @description Accrued discount. */
206
+ orderRebatePercent: number;
207
+ /** @description Information on order value in currency of order adding. */
208
+ orderCurrency: {
209
+ /** @description Currency ID */
210
+ currencyId: string;
211
+ /** @description Currency average rate set for order (by default, an average rate of order adding date, if it wasn't manually changed). */
212
+ orderCurrencyValue: number;
213
+ /** @description Currency scaler. */
214
+ orderCurrencyScale: number;
215
+ /** @description Panel billing currency exchange rate in relation to billing currency in the shop . */
216
+ billingCurrencyRate: number;
217
+ /** @description Products cost. */
218
+ orderProductsCost: number;
219
+ /** @description Shipping costs. */
220
+ orderDeliveryCost: number;
221
+ /** @description Additional charge for selected payment method. */
222
+ orderPayformCost: number;
223
+ /** @description Additional fee for insurance. */
224
+ orderInsuranceCost: number;
225
+ };
226
+ /** @description Information on order value in shop account currency. */
227
+ orderBaseCurrency: {
228
+ billingCurrency: string;
229
+ /** @description Products cost. */
230
+ orderProductsCost: number;
231
+ /** @description Shipping costs. */
232
+ orderDeliveryCost: number;
233
+ /** @description Delivery VAT. */
234
+ orderDeliveryVat: number;
235
+ /** @description Additional charge for selected payment method. */
236
+ orderPayformCost: number;
237
+ /** @description VAT for additional fee for the chosen form of payment. */
238
+ orderPayformVat: number;
239
+ /** @description Additional fee for insurance. */
240
+ orderInsuranceCost: number;
241
+ /** @description Insurance VAT rate (in percents). */
242
+ orderInsuranceVat: number;
243
+ };
244
+ /** @description Order currency squaring method. "gross" - calculated in gross prices, "net" - squared in net prices. */
245
+ orderWorthCalculateType: "gross" | "net";
246
+ /** @description Information if the VAT for the current order was calculated: "y" - yes, "n" - no. */
247
+ orderVatExists: string;
248
+ };
249
+ /** @description Information about prepayment for the order. */
250
+ prepaids: {
251
+ /** @description Order payment identifier. */
252
+ prepaidId: number;
253
+ /** @description Payment number for order. */
254
+ paymentOrdinalNumber: number;
255
+ /** @description Payment number - [order no.]-[payment no.], i.e. 1234-1. */
256
+ paymentNumber: string;
257
+ /** @description Date of payment addition. */
258
+ paymentAddDate: string;
259
+ /** @description Client's payment modification date. */
260
+ paymentModifiedDateByClient: string;
261
+ /** @description Payment modification date made by shop staff. */
262
+ paymentModifiedDateByShop: string;
263
+ /** @description Payment status. */
264
+ paymentStatus: string;
265
+ /** @description Transaction type: "payment" - payment, "advance" - advance payment, "repayment" - return, "fee" - handling fee. */
266
+ paymentType: "payment" | "advance" | "repayment" | "fee";
267
+ /** @description Form of payment ID. */
268
+ payformId: number;
269
+ /** @description Name of payment form. */
270
+ payformName: string;
271
+ /** @description Account. */
272
+ payformAccount: string;
273
+ /** @description Payment amount. */
274
+ paymentValue: number;
275
+ /** @description Currency ID */
276
+ currencyId: string;
277
+ /** @description Number of voucher used in a payment. */
278
+ voucherNumber: string;
279
+ /** @description Number of gift card used in a payment. */
280
+ giftCardNumber: string;
281
+ }[];
282
+ /** @description Order source data. */
283
+ orderSourceResults: {
284
+ /** @description order source type - possible values:. "self_added" - Orders from panel, "shop" - Orders from shop, "search_engine" - Orders from search engines, "auction" - Orders from auctions, "advertisement_campaign" - Advertisement campaigns, "price_comparer" - Price comparison sites, "affiliate_program" - Affiliate programme, "api" - Order from API, "eletronic_offer" - Order from ODT price lst, "cpa" - Order from CPA program, "refferer_site" - Order from reference sites, "pos" - Orders from POS, "marketplace" - Order from the Marketplace, "iai_ads" - Orders from IAI Ads */
285
+ orderSourceType: string;
286
+ /** @description Shop Id */
287
+ shopId: number;
288
+ /** @description Auction site order comes from. Auction sites listing: "allegro" - Allegro.pl, "testwebapi" - Allegro.pl test site, "ebay" - eBay. */
289
+ auctionsServiceName: string;
290
+ /** @description Detailed information on order source. */
291
+ orderSourceDetails: {
292
+ /** @description order source type - possible values:. "self_added" - Orders from panel, "shop" - Orders from shop, "search_engine" - Orders from search engines, "auction" - Orders from auctions, "advertisement_campaign" - Advertisement campaigns, "price_comparer" - Price comparison sites, "affiliate_program" - Affiliate programme, "api" - Order from API, "eletronic_offer" - Order from ODT price lst, "cpa" - Order from CPA program, "refferer_site" - Order from reference sites, "pos" - Orders from POS, "marketplace" - Order from the Marketplace, "iai_ads" - Orders from IAI Ads */
293
+ orderSourceType: string;
294
+ /** @description Exact source name. */
295
+ orderSourceName: string;
296
+ /** @description Numerical ID of order source type. */
297
+ orderSourceTypeId: number;
298
+ /** @description Numerical ID of order source. */
299
+ orderSourceId: number;
300
+ entryProductIdBeforeOrder: number;
301
+ sourcePageUrl: string;
302
+ /** @description The order ID of the external service */
303
+ orderExternalId: string;
304
+ /** @description Order from the InPost Fresh marketplace */
305
+ fresh: "y" | "n";
306
+ /** @description Order supported by InPost fulfillment */
307
+ fulfillment: "y" | "n";
308
+ };
309
+ preorderSourcesDetails: {
310
+ /** @description order source type - possible values:. "self_added" - Orders from panel, "shop" - Orders from shop, "search_engine" - Orders from search engines, "auction" - Orders from auctions, "advertisement_campaign" - Advertisement campaigns, "price_comparer" - Price comparison sites, "affiliate_program" - Affiliate programme, "api" - Order from API, "eletronic_offer" - Order from ODT price lst, "cpa" - Order from CPA program, "refferer_site" - Order from reference sites, "pos" - Orders from POS, "marketplace" - Order from the Marketplace, "iai_ads" - Orders from IAI Ads */
311
+ orderSourceType: string;
312
+ /** @description Exact source name. */
313
+ orderSourceName: string;
314
+ /** @description Numerical ID of order source type. */
315
+ orderSourceTypeId: number;
316
+ /** @description Numerical ID of order source. */
317
+ orderSourceId: number;
318
+ entryDate: string;
319
+ }[];
320
+ };
321
+ /** @description Data of auction, order comes from (only if it comes from auction). */
322
+ auctionInfo: {
323
+ /** @description Account ID on auction site. */
324
+ auctionClientId: string;
325
+ /** @description Account login on auction site. */
326
+ auctionClientLogin: string;
327
+ /** @description #!TablicaNumerowAukcjiDoZamowienia!#. */
328
+ auctionItemsIds: {
329
+ /** @description Auction number. */
330
+ auctionItemId: string;
331
+ }[];
332
+ /** @description The customer's email address at the auction service. */
333
+ auctionClientEmail: string;
334
+ };
335
+ /** @description Consignment data. */
336
+ dispatch: {
337
+ /** @description Courier ID. */
338
+ courierId: number;
339
+ /** @description Name of the supplier of the shipment. */
340
+ courierName: string;
341
+ /** @description Courier via webservice. */
342
+ courierWebserviceOnly: boolean;
343
+ /** @description Shipment ID. */
344
+ deliveryPackageId: string;
345
+ /** @description Selected delivery date. */
346
+ deliveryDate: string;
347
+ /** @description Additional information on delivery date. */
348
+ deliveryDateAdditional: string;
349
+ /** @description Estimated date of shipment of the order. */
350
+ estimatedDeliveryDate: string;
351
+ /** @description Parcel weight. */
352
+ deliveryWeight: number;
353
+ };
354
+ /** @description The list of products returned due to a gate call */
355
+ productsResults: {
356
+ /** @description Product IAI code */
357
+ productId: number;
358
+ /** @description Product name. */
359
+ productName: string;
360
+ /** @description External product system code */
361
+ productCode: string;
362
+ /** @description Name of the parameter value, e.g. orange, green, red */
363
+ versionName: string;
364
+ /** @description Size identifier */
365
+ sizeId: string;
366
+ /** @description Size name */
367
+ sizePanelName: string;
368
+ /** @description External product system code for size. */
369
+ productSizeCodeExternal: string;
370
+ /** @description Stock ID */
371
+ stockId: number;
372
+ /** @description Serial number of the product. */
373
+ productSerialNumber: string;
374
+ /** @description Product quantity. */
375
+ productQuantity: number;
376
+ /** @description Weight. */
377
+ productWeight: number;
378
+ /** @description Value of VAT */
379
+ productVat: number;
380
+ /** @description Is product VAT free Allowed values "y" - yes, "n" - no. */
381
+ productVatFree: string;
382
+ /** @description Gross price of the product in the currency of the administration panel. */
383
+ productPanelPrice: number;
384
+ /** @description Net price of the product in the currency of the administration panel. */
385
+ productPanelPriceNet: number;
386
+ /** @description Product gross price of order in order currency. */
387
+ productOrderPrice: number;
388
+ /** @description Product net price of order in order currency. */
389
+ productOrderPriceNet: number;
390
+ /** @description Product gross price of order in shop account currency. */
391
+ productOrderPriceBaseCurrency: number;
392
+ /** @description Product net price of order in shop account currency. */
393
+ productOrderPriceNetBaseCurrency: number;
394
+ /** @description List of product suggestions . */
395
+ orderAdditionalList: {
396
+ /** @description Product suggestion. */
397
+ orderAdditional: {
398
+ /** @description Name of suggestion. */
399
+ orderAdditionalName: string;
400
+ /** @description Value of suggestion. */
401
+ orderAdditionalValue: string;
402
+ };
403
+ };
404
+ /** @description Client's remarks on product. */
405
+ remarksToProduct: string;
406
+ /** @description Product selling mode. Available values: "money", "gift", "points". */
407
+ orderSalesMode: "money" | "gift" | "points";
408
+ /** @description A set's ID. */
409
+ bundleId: number;
410
+ /** @description Serial numbers. */
411
+ productSerialNumbers: string;
412
+ /** @description Additional information. */
413
+ productOrderAdditional: string;
414
+ /** @description Item in basket. */
415
+ basketPosition: number;
416
+ /** @description price information. */
417
+ productPriceLog: string;
418
+ /** @description Information about the selected parameters in the configurator. */
419
+ priceFormulaParameters: {
420
+ /** @description Parameter ID */
421
+ parameterId: string;
422
+ /** @description Parameter name. */
423
+ parameterName: string;
424
+ /** @description Parameter values */
425
+ parameterValues: {
426
+ valueId: string;
427
+ valueName: string;
428
+ }[];
429
+ }[];
430
+ }[];
431
+ /** @description Parameter determines if product has been removed from stock. List of values: "y" - removed from stock, "n" - put in stock. */
432
+ productRemovedInStock: "y" | "n";
433
+ /** @description Stock ID */
434
+ stockId: number;
435
+ /** @description Customer asked for invoice. List of parameters: "y" - yes (paper invoicing ), "e" - yes (electronic invoicing ), "n" - no. */
436
+ clientRequestInvoice: string;
437
+ /** @description Delivery address ID. */
438
+ clientDeliveryAddressId: number;
439
+ /** @description Note to the order. */
440
+ orderNote: string;
441
+ /** @description Information on used discount code. */
442
+ discountCode: {
443
+ /** @description Campaign ID. */
444
+ campaignId: string;
445
+ /** @description Name of code. */
446
+ discountCodeName: string;
447
+ /** @description Accrued discount */
448
+ discountCodeValue: string;
449
+ };
450
+ /** @description Discount card */
451
+ discountCard: {
452
+ /** @description Name of card */
453
+ discountCardName: string;
454
+ };
455
+ /** @description Order handler. */
456
+ orderOperatorLogin: string;
457
+ /** @description Order picker. */
458
+ orderPackingPersonLogin: string;
459
+ /** @description Sale date. ISO 8602 format. */
460
+ purchaseDate: string;
461
+ /** @description Modification date in YYYY-MM-DD HH:MM:SS format . */
462
+ orderChangeDate: string;
463
+ };
464
+ /** @description Information on error that occurred during gate call. */
465
+ errors: FaultCodeString[];
466
+ }[];
467
+ } & PagedResponse;
468
+
469
+ export type SearchProductsResponse = {
470
+ /** @description Object contains detailed information on result of operation. */
471
+ results: {
472
+ /** @description Product IAI code */
473
+ productId: number;
474
+ /** @description External product system code. */
475
+ productDisplayedCode?: string;
476
+ productIsDeleted?: string;
477
+ /** @description Annotation. */
478
+ productNote?: string;
479
+ /** @description PKWiU [PCPandS]. */
480
+ productTaxCode?: string;
481
+ /** @description Brand ID */
482
+ producerId?: number;
483
+ /** @description Brand name */
484
+ producerName?: string;
485
+ /** @description IdoSell Category ID */
486
+ categoryIdoSellId?: number;
487
+ /** @description IdoSell Category pathname */
488
+ categoryIdoSellPath?: string;
489
+ /** @description Category id */
490
+ categoryId?: number;
491
+ /** @description Category name */
492
+ categoryName?: string;
493
+ /** @description Currency ID */
494
+ currencyId?: string;
495
+ /** @description CN/TARIC */
496
+ cnTaricCode?: string;
497
+ /** @description Country of origin. Country code in the ISO 3166-1 A2 standard */
498
+ countryOfOrigin?: string;
499
+ /** @description Currency, in which product prices are stored. */
500
+ productCurrenciesShops?: {
501
+ /** @description Shop Id */
502
+ shopId: number;
503
+ /** @description Currency ID */
504
+ currencyId: string;
505
+ }[];
506
+ /** @description Product is bestseller. Available values: "n" - no, "y" - yes. */
507
+ productInBestseller?: string;
508
+ /** @description Gross price */
509
+ productRetailPrice?: number;
510
+ /** @description Gross price after promotion. The item is returned when the 'showPromotionsPrices' parameter is specified in the request */
511
+ productPromoRetailPrice?: number;
512
+ /** @description Wholesale price */
513
+ productWholesalePrice?: number;
514
+ /** @description Wholesale price after promotion. The item is returned when the 'showPromotionsPrices' parameter is specified in the request */
515
+ productPromoWholesalePrice?: number;
516
+ /** @description Minimal price */
517
+ productMinimalPrice?: number;
518
+ /** @description Price for automatic calculations */
519
+ productAutomaticCalculationPrice?: number;
520
+ /** @description price for POS. */
521
+ productPosPrice?: number;
522
+ /** @description Strikethrough gross retail price */
523
+ productStrikethroughRetailPrice?: number;
524
+ /** @description Strikethrough gross wholesale price */
525
+ productStrikethroughWholesalePrice?: number;
526
+ /** @description Average purchase price net. */
527
+ productPurchasePriceNetAverage?: number;
528
+ /** @description Last net purchase price */
529
+ productPurchasePriceNetLast?: number;
530
+ /** @description Average purchase price gross. */
531
+ productPurchasePriceGrossAverage?: number;
532
+ /** @description Last gross purchase price */
533
+ productPurchasePriceGrossLast?: number;
534
+ /** @description Value of VAT */
535
+ productVat?: number;
536
+ /** @description Is product VAT free Allowed values "y" - yes, "n" - no. */
537
+ productVatFree?: string;
538
+ /** @description Discount profile ID */
539
+ productRebate?: number;
540
+ /** @description Product is new. Available values: "y" - is new, "n" - is not new. */
541
+ productInNew?: string;
542
+ /** @description Settings of hotspots display. */
543
+ productHotspotsZones?: {
544
+ /** @description Is attribute set */
545
+ productHotspotIsEnabled: boolean;
546
+ /** @description Shop Id */
547
+ shopId: number;
548
+ /** @description Promotion for shop. */
549
+ productIsPromotion: boolean;
550
+ /** @description Discount for shop. */
551
+ productIsDiscount: boolean;
552
+ /** @description Distinguished product in store. */
553
+ productIsDistinguished: boolean;
554
+ /** @description Special product in store. */
555
+ productIsSpecial: boolean;
556
+ }[];
557
+ /** @description Product value in points. */
558
+ productProfitPoints?: {
559
+ /** @description Is attribute set */
560
+ productProfitPointsAreEnabled: boolean;
561
+ /** @description Shop Id */
562
+ shopId: number;
563
+ /** @description Point value required for purchase made by retail customers. */
564
+ productProfitPointsCostRetail: number;
565
+ /** @description Point value required for purchase made by wholesale customers. */
566
+ productProfitPointsCostWholesale: number;
567
+ /** @description Points granted for product purchase made by retail customers. */
568
+ productProfitPointsAwardRetail: number;
569
+ /** @description Points granted for product purchase made by wholesale customers. */
570
+ productProfitPointsAwardWholesale: number;
571
+ }[];
572
+ /** @description Weight. */
573
+ productWeight?: number;
574
+ /** @description Product visibility in export to price comparison and marketplaces. Available values: "y" - Visible, "selected" - Selected, "assign_selected" - Enable the visibility of the product in the export to price comparison sites passed in the priceComparisonSites node. Price comparison sites previously assigned to the commodity will be retained, "unassign_selected" - Disable product visibility in exports to price comparison sites passed in the priceComparisonSites node, "n" - invisible. */
575
+ productInExportToPriceComparisonSites?: string;
576
+ /** @description Visibility of an item in an export to Amazon Marketplace. Available values: "y" - Visible, "selected" - Visible on selected regional services, "n" - invisible. */
577
+ productInExportToAmazonMarketplace?: string;
578
+ /** @description Object determines if the product is available in POS sale Available values: "n" - no, "y" - yes. */
579
+ productEnableInPos?: string;
580
+ /** @description Complex rating Available values: "0" - no, "1" - yes. */
581
+ productComplexNotes?: number;
582
+ /** @description Availability profile ID. */
583
+ availableProfile?: number;
584
+ /** @description Availability profile name. */
585
+ availableProfileName?: string;
586
+ /** @description Product visibility in store Available values: "y" - Visible, "n" - Invisible. */
587
+ productIsVisible?: string;
588
+ /** @description Product visible even though out of stock Available values: "y" - visible even though out of stock, "n" - not visible when out of stock. */
589
+ productInPersistent?: string;
590
+ /** @description Priority. Allowed values from 1 to 10. */
591
+ productPriority?: number;
592
+ /** @description Bit mask of shop IDs. Mask for indicated store is calculated on basis of following formula: 2^(store_ID - 1). If the product should be available in more than one shop, the masks should be summed up. */
593
+ shopsMask?: number;
594
+ /** @description Product icon details. */
595
+ productIcon?: {
596
+ /** @description Determines whether icon has been set. Available values: "y" - icon is set, "n" - icon is not set (default icon is visible). */
597
+ productIconExists: string;
598
+ /** @description URL to large icon graphic file */
599
+ productIconLargeUrl: string;
600
+ /** @description Width of large icon */
601
+ productIconLargeWidth?: number;
602
+ /** @description Height of large icon */
603
+ productIconLargeHeight?: number;
604
+ /** @description Large icon size */
605
+ productIconLargeSize?: number;
606
+ /** @description URL to small icon graphic file */
607
+ productIconSmallUrl: string;
608
+ /** @description MD5 hash of large icon graphic file */
609
+ productIconHash?: string;
610
+ productIconLargeUrlSecond?: string;
611
+ productIconLargeSizeSecond?: number;
612
+ };
613
+ /** @description Information about the external listing icon */
614
+ productAuctionIcon?: {
615
+ /** @description Determines whether icon has been set. Available values: "y" - icon is set, "n" - icon is not set (default icon is visible). */
616
+ productAuctionIconExists: string;
617
+ /** @description URL to large icon graphic file */
618
+ productAuctionIconLargeUrl?: string;
619
+ /** @description Width of large icon */
620
+ productAuctionIconLargeWidth?: number;
621
+ /** @description Height of large icon */
622
+ productAuctionIconLargeHeight?: number;
623
+ /** @description Large icon size */
624
+ productAuctionIconLargeSize?: number;
625
+ /** @description URL to small icon graphic file */
626
+ productAuctionIconSmallUrl?: string;
627
+ /** @description MD5 hash of large icon graphic file */
628
+ productAuctionIconHash?: string;
629
+ productAuctionIconLargeUrlSecond?: string;
630
+ productAuctionIconLargeSizeSecond?: number;
631
+ productAuctionIconSmallUrlSecond?: string;
632
+ productAuctionIconSmallSizeSecond?: number;
633
+ };
634
+ /** @description Information about the product group icon */
635
+ productGroupIcon?: {
636
+ /** @description Determines whether icon has been set. Available values: "y" - icon is set, "n" - icon is not set (default icon is visible). */
637
+ productGroupIconExists: string;
638
+ /** @description URL to large icon graphic file */
639
+ productGroupIconLargeUrl?: string;
640
+ /** @description Width of large icon */
641
+ productGroupIconLargeWidth?: number;
642
+ /** @description Height of large icon */
643
+ productGroupIconLargeHeight?: number;
644
+ /** @description Large icon size */
645
+ productGroupIconLargeSize?: number;
646
+ /** @description URL to small icon graphic file */
647
+ productGroupIconSmallUrl?: string;
648
+ /** @description MD5 hash of large icon graphic file */
649
+ productGroupIconHash?: string;
650
+ productGroupIconLargeUrlSecond?: string;
651
+ productGroupIconLargeSizeSecond?: string;
652
+ productGroupIconSmallUrlSecond?: string;
653
+ productGroupIconSmallSize?: number;
654
+ productGroupIconSmallSizeSecond?: number;
655
+ };
656
+ /** @description Product photos details. */
657
+ productImages?: {
658
+ /** @description URL of a large graphics */
659
+ productImageLargeUrl?: string;
660
+ productImageLargeUrlSecond?: string;
661
+ productImageMediumUrlSecond?: string;
662
+ productImageSmallUrlSecond?: string;
663
+ /** @description URL of a medium graphics */
664
+ productImageMediumUrl?: string;
665
+ /** @description URL of a small graphics */
666
+ productImageSmallUrl?: string;
667
+ /** @description Id */
668
+ productImageId?: string;
669
+ /** @description Picture height */
670
+ productImageWidth?: number;
671
+ /** @description Picture width */
672
+ productImageHeight?: number;
673
+ /** @description Image size on disk */
674
+ productImageSize?: number;
675
+ /** @description Date Photo was added */
676
+ productImageDate?: string;
677
+ /** @description Picture priority */
678
+ productImagePriority?: number;
679
+ /** @description Picture hash */
680
+ productImageHash?: string;
681
+ }[];
682
+ /** @description Data of series, product belong to. */
683
+ productSeries?: {
684
+ /** @description ID of series, to which product belongs. */
685
+ seriesId: number;
686
+ /** @description Name of series, to which the product belongs, visible in panel. */
687
+ seriesPanelName: string;
688
+ /** @description Names of series in indicated language visible in shop. */
689
+ seriesDescriptionsLangData: {
690
+ /** @description Name of series in indicated language */
691
+ seriesName: string;
692
+ /** @description Language ID */
693
+ langId: string;
694
+ }[];
695
+ };
696
+ /** @description Product unit of measure data */
697
+ productUnit?: {
698
+ /** @description Product unit of measure ID. */
699
+ unitId: number;
700
+ /** @description Product unit of measure name. */
701
+ unitName: string;
702
+ /** @description Unit of measure precision. */
703
+ unitPrecision: number;
704
+ };
705
+ /** @description Number of items in package data */
706
+ productInWrapper?: number;
707
+ /** @description Sold at - for retailers. */
708
+ productSellByRetail?: number;
709
+ /** @description Sold at - for wholesalers. */
710
+ productSellByWholesale?: number;
711
+ /** @description Size group ID Change of one size group to another results in zeroing all stock quantities in all stocks. Change of size group can be made, if product is not present in any unhandled orders nor listed on auctions. */
712
+ sizesGroupId?: number;
713
+ /** @description Product creation time and date in YYYY-MM-DD HH:MM:SS format */
714
+ productAddingTime?: string;
715
+ /** @description Last product modification date and time in YYYY-MM-DD HH:MM:SS format */
716
+ productModificationTime?: string;
717
+ /** @description Last product price modification date and time in YYYY-MM-DD HH:MM:SS format */
718
+ productPriceChangedTime?: string;
719
+ /** @description Last product stock quantities modification date and time in YYYY-MM-DD HH:MM:SS format */
720
+ productQuantityChangedTime?: string;
721
+ /** @description Product warranty data. */
722
+ productWarranty?: {
723
+ /** @description Product warranty ID. */
724
+ warrantyId: number;
725
+ /** @description Name of warranty for indicated product. */
726
+ warrantyName: string;
727
+ };
728
+ /** @description Data on product groups (variants) */
729
+ productVersion?: {
730
+ /** @description ID of the main item (variant) in the group */
731
+ versionParentId: number;
732
+ /** @description Parameter value names */
733
+ versionNames: {
734
+ /** @description Array of languages, values are displayed in. */
735
+ versionNamesLangData: {
736
+ /** @description Language ID */
737
+ langId: string;
738
+ /** @description Name of the parameter value, e.g. orange, green, red */
739
+ versionName: string;
740
+ }[];
741
+ };
742
+ /** @description Parameter names */
743
+ versionGroupNames: {
744
+ /** @description Parameter name */
745
+ versionGroupNamesLangData: {
746
+ /** @description Language ID */
747
+ langId: string;
748
+ /** @description Parameter name, e.g. color, width */
749
+ versionGroupName: string;
750
+ }[];
751
+ };
752
+ /** @description Settings for groups of items (variants) */
753
+ versionSettings: {
754
+ /** @description Show in shop. Available values: "y" - all products from group, "n" - only the first product from group. */
755
+ versionDisplayAllInShop: string;
756
+ /** @description Show in panel. Available values: "y" - wszystkie towary z grupy, "n" - only the first product from group. */
757
+ versionDisplayAllInPanel: string;
758
+ /** @description Adding the canonical links to the site. Available values: "y" - on, "n" - Off. */
759
+ versionDisplayRelCanonicalInShop: string;
760
+ /** @description The same code. Available values: "y" - yes, "n" - no. */
761
+ versionCommonCode: string;
762
+ /** @description The same brand. Available values: "y" - yes, "n" - no. */
763
+ versionCommonProducer: string;
764
+ /** @description The same annotation. Available values: "y" - yes, "n" - no. */
765
+ versionCommonNote: string;
766
+ /** @description The same warranty. Available values: "y" - yes, "n" - no. */
767
+ versionCommonWarranty: string;
768
+ /** @description The same series. Available values: "y" - yes, "n" - no. */
769
+ versionCommonSeries: string;
770
+ /** @description The same category. Available values: "y" - yes, "n" - no. */
771
+ versionCommonCategory: string;
772
+ /** @description The same price. Available values: "y" - yes, "n" - no. */
773
+ versionCommonPrice: string;
774
+ /** @description Same price for auction services. Available values: "y" - yes, "n" - no. */
775
+ versionCommonPriceAuctions: string;
776
+ /** @description Same advance. Available values: "y" - yes, "n" - no. */
777
+ versionCommonAdvance: string;
778
+ /** @description Same quantity discount. Available values: "y" - yes, "n" - no. */
779
+ versionCommonRebate: string;
780
+ /** @description the same VAT rate. Available values: "y" - yes, "n" - no. */
781
+ versionCommonVat: string;
782
+ /** @description The same loyalty points. Available values: "y" - yes, "n" - no. */
783
+ versionCommonProfitPoints: string;
784
+ /** @description The same promotion. Available values: "y" - yes, "n" - no. */
785
+ versionCommonPromotion: string;
786
+ /** @description The same loyalty discount. Available values: "y" - yes, "n" - no. */
787
+ versionCommonDiscount: string;
788
+ /** @description The same privileged products. Available values: "y" - yes, "n" - no. */
789
+ versionCommonDistinguished: string;
790
+ /** @description The same for special. Available values: "y" - yes, "n" - no. */
791
+ versionCommonSpecial: string;
792
+ /** @description The same related product. Available values: "y" - yes, "n" - no. */
793
+ versionCommonAssociated: string;
794
+ /** @description The same visibility. Available values: "y" - yes, "n" - no. */
795
+ versionCommonVisibility: string;
796
+ /** @description Same display when not in stock. Available values: "y" - yes, "n" - no. */
797
+ versionCommonPersistent: string;
798
+ /** @description The same priority. Available values: "y" - yes, "n" - no. */
799
+ versionCommonPriority: string;
800
+ /** @description The same shops. Available values: "y" - yes, "n" - no. */
801
+ versionCommonShops: string;
802
+ /** @description The same sizes. Available values: "y" - yes, "n" - no. */
803
+ versionCommonSizes: string;
804
+ /** @description The same unit of measure. Available values: "y" - yes, "n" - no. */
805
+ versionCommonUnit: string;
806
+ /** @description The same weight. Available values: "y" - yes, "n" - no. */
807
+ versionCommonWeight: string;
808
+ /** @description The same parameters. possible values "y" - yes, "n" - no. */
809
+ versionCommonDictionary: string;
810
+ /** @description The same name. Available values: "y" - yes, "n" - no. */
811
+ versionCommonName: string;
812
+ /** @description The same short description. Available values: "y" - yes, "n" - no. */
813
+ versionCommonDescription: string;
814
+ /** @description The same long description. Available values: "y" - yes, "n" - no. */
815
+ versionCommonLongDescription: string;
816
+ /** @description The same icon. Available values: "y" - yes, "n" - no. */
817
+ versionCommonIcon: string;
818
+ /** @description The same large photos. Available values: "y" - yes, "n" - no. */
819
+ versionCommonPhotos: string;
820
+ /** @description The same availability profile. Available values: "y" - yes, "n" - no. */
821
+ versionCommonAvailableProfile: string;
822
+ /** @description The same complex rating. Available values: "y" - yes, "n" - no. */
823
+ versionCommonComplexNotes: string;
824
+ /** @description The same currency. Available values: "y" - yes, "n" - no. */
825
+ versionCommonCurrency: string;
826
+ /** @description The same supplier. Available values: "y" - yes, "n" - no. */
827
+ versionCommonDeliverer: string;
828
+ /** @description Do You wish to sum up the products in the basket as a one order? Available values: "y" - yes, "n" - no. */
829
+ versionCommonSumInBasket: string;
830
+ /** @description The same objects in menu Available values: "y" - yes, "n" - no. */
831
+ versionCommonMenuItems: string;
832
+ /** @description Same promotions Available values: "y" - yes, "n" - no. */
833
+ versionCommonPromotions: string;
834
+ };
835
+ /** @description List of product variants. */
836
+ versionProductsIds: number[];
837
+ };
838
+ /** @description Recommended products data. */
839
+ associatedProductsIds?: number[];
840
+ /** @description Data of advance payment required for order with this product. */
841
+ productAdvance?: {
842
+ /** @description Required advance payment in percents */
843
+ productAdvancePrice: number;
844
+ /** @description Percentage of product price, that is an advance payment. */
845
+ productAdvancePercent: number;
846
+ };
847
+ /** @description Data of stores product is assigned to. */
848
+ productShops?: {
849
+ /** @description Bit mask of shop IDs. Mask for indicated store is calculated on basis of following formula: 2^(store_ID - 1). If the product should be available in more than one shop, the masks should be summed up. */
850
+ shopsMask?: number;
851
+ /** @description Shop Id */
852
+ shopId: number;
853
+ }[];
854
+ /** @description Array of language-dependent elements. */
855
+ productDescriptionsLangData?: {
856
+ /** @description Language ID */
857
+ langId: string;
858
+ /** @description Product name. */
859
+ productName: string;
860
+ /** @description Product name for auction service. */
861
+ productAuctionName: string;
862
+ /** @description Product name on price comparison sites. */
863
+ productPriceComparisonSitesName: string;
864
+ /** @description Short product description. */
865
+ productDescription: string;
866
+ /** @description Long product description. */
867
+ productLongDescription: string;
868
+ /** @description DEPRECATED. This parameter is deprecated. Long product description for external listings. */
869
+ productAuctionLongDescription: string;
870
+ /** @description Product meta title. */
871
+ productMetaTitle: string;
872
+ /** @description Product meta description. */
873
+ productMetaDescription: string;
874
+ /** @description Product meta keywords. */
875
+ productMetaKeywords: string;
876
+ }[];
877
+ /** @description Product data for auction services */
878
+ productAuctionDescriptionsData?: {
879
+ /** @description Auction system ID */
880
+ productAuctionId: string;
881
+ /** @description Auction site ID */
882
+ productAuctionSiteId: string;
883
+ /** @description Product name for auction service. */
884
+ productAuctionName: string;
885
+ /** @description Subtitle for auction service */
886
+ productAuctionAdditionalName: string;
887
+ /** @description Product description for marketplaces */
888
+ productAuctionDescription: string;
889
+ }[];
890
+ /** @description Reduced price */
891
+ productPromotion?: {
892
+ /** @description Object determines if the promotion should be active.. Allowed values: "y" - active promotion, "n" - inactive promotion. */
893
+ promoteItemEnabled: string;
894
+ /** @description Strikethrough price */
895
+ promoteItemNormalPrice?: number;
896
+ /** @description Strikethrough wholesale price */
897
+ promoteItemWholesaleNormalPrice?: number;
898
+ /** @description Switching off date */
899
+ promoteItemEndingDate?: string;
900
+ };
901
+ /** @description Discount for shop. */
902
+ productDiscount?: {
903
+ /** @description Object determines if the promotion should be active.. Allowed values: "y" - active promotion, "n" - inactive promotion. */
904
+ promoteItemEnabled: string;
905
+ /** @description Strikethrough price */
906
+ promoteItemNormalPrice?: number;
907
+ /** @description Strikethrough wholesale price */
908
+ promoteItemWholesaleNormalPrice?: number;
909
+ /** @description Switching off date */
910
+ promoteItemEndingDate?: string;
911
+ };
912
+ /** @description Distinguished product in store. */
913
+ productDistinguished?: {
914
+ /** @description Object determines if the promotion should be active.. Allowed values: "y" - active promotion, "n" - inactive promotion. */
915
+ promoteItemEnabled: string;
916
+ /** @description Strikethrough price */
917
+ promoteItemNormalPrice?: number;
918
+ /** @description Strikethrough wholesale price */
919
+ promoteItemWholesaleNormalPrice?: number;
920
+ /** @description Switching off date */
921
+ promoteItemEndingDate?: string;
922
+ };
923
+ /** @description Special product in store. */
924
+ productSpecial?: {
925
+ /** @description Object determines if the promotion should be active.. Allowed values: "y" - active promotion, "n" - inactive promotion. */
926
+ promoteItemEnabled: string;
927
+ /** @description Strikethrough price */
928
+ promoteItemNormalPrice: number;
929
+ /** @description Strikethrough wholesale price */
930
+ promoteItemWholesaleNormalPrice: number;
931
+ /** @description Switching off date */
932
+ promoteItemEndingDate?: string;
933
+ };
934
+ /** @description Parameters (distinguished). */
935
+ productParametersDistinction?: {
936
+ /** @description Parameter ID */
937
+ parameterId: number;
938
+ /** @description Parameter name. */
939
+ parameterName: string;
940
+ /** @description Parameter value ID */
941
+ parameterValueId: number;
942
+ /** @description Attributes group name. */
943
+ parameterValueName: string;
944
+ }[];
945
+ /** @description Product stock quantity data. */
946
+ productStocksData?: {
947
+ /** @description Stocks data */
948
+ productStocksQuantities?: {
949
+ /** @description Stock ID */
950
+ stockId: number;
951
+ /** @description Size data */
952
+ productSizesData: {
953
+ /** @description Size identifier */
954
+ sizeId: string;
955
+ /** @description Size name */
956
+ sizePanelName: string;
957
+ /** @description External product system code for size. */
958
+ productSizeCodeExternal: string;
959
+ /** @description Product stock quantity */
960
+ productSizeQuantity: number;
961
+ /** @description Information of reservations */
962
+ productSizeReservations: {
963
+ /** @description Number of products reserved ad hoc. */
964
+ productSizeReservationAdhoc: number;
965
+ /** @description Number of products reserved for auctions. */
966
+ productSizeReservationAuction: number;
967
+ /** @description Customer's login */
968
+ productSizeReservationClient: number;
969
+ /** @description Number of products reserved for orders. */
970
+ productSizeReservationOrder: number;
971
+ /** @description Number of products reserved for retail sales. */
972
+ productSizeReservationRetail: number;
973
+ /** @description Number of products reserved for wholesale sales. */
974
+ productSizeReservationWholesale: number;
975
+ };
976
+ }[];
977
+ }[];
978
+ /** @description Information on auction sites */
979
+ productAuctionsQuantities?: {
980
+ /** @description Stock ID */
981
+ stockId: number;
982
+ /** @description Size data */
983
+ productSizesData: {
984
+ /** @description Size identifier */
985
+ sizeId: string;
986
+ /** @description Size name */
987
+ sizePanelName: string;
988
+ /** @description External product system code for size. */
989
+ productSizeCodeExternal: string;
990
+ /** @description Product stock quantity */
991
+ productSizeQuantity: number;
992
+ /** @description Information of reservations */
993
+ productSizeReservations: {
994
+ /** @description Number of products reserved ad hoc. */
995
+ productSizeReservationAdhoc: number;
996
+ /** @description Number of products reserved for auctions. */
997
+ productSizeReservationAuction: number;
998
+ /** @description Customer's login */
999
+ productSizeReservationClient: number;
1000
+ /** @description Number of products reserved for orders. */
1001
+ productSizeReservationOrder: number;
1002
+ /** @description Number of products reserved for retail sales. */
1003
+ productSizeReservationRetail: number;
1004
+ /** @description Number of products reserved for wholesale sales. */
1005
+ productSizeReservationWholesale: number;
1006
+ };
1007
+ }[];
1008
+ }[];
1009
+ /** @description Information on incomplete orders */
1010
+ productOrdersUnfinishedQuantities?: {
1011
+ /** @description Stock ID */
1012
+ stockId: number;
1013
+ /** @description Size data */
1014
+ productSizesData: {
1015
+ /** @description Size identifier */
1016
+ sizeId: string;
1017
+ /** @description Size name */
1018
+ sizePanelName: string;
1019
+ /** @description External product system code for size. */
1020
+ productSizeCodeExternal: string;
1021
+ /** @description Product stock quantity */
1022
+ productSizeQuantity: number;
1023
+ /** @description Information of reservations */
1024
+ productSizeReservations: {
1025
+ /** @description Number of products reserved ad hoc. */
1026
+ productSizeReservationAdhoc: number;
1027
+ /** @description Number of products reserved for auctions. */
1028
+ productSizeReservationAuction: number;
1029
+ /** @description Customer's login */
1030
+ productSizeReservationClient: number;
1031
+ /** @description Number of products reserved for orders. */
1032
+ productSizeReservationOrder: number;
1033
+ /** @description Number of products reserved for retail sales. */
1034
+ productSizeReservationRetail: number;
1035
+ /** @description Number of products reserved for wholesale sales. */
1036
+ productSizeReservationWholesale: number;
1037
+ };
1038
+ }[];
1039
+ }[];
1040
+ /** @description Available stock quantities data */
1041
+ productSizesDispositions?: {
1042
+ /** @description Available stock quantities for auctions */
1043
+ productSizesDispositionsInAuctions: {
1044
+ /** @description Size identifier */
1045
+ sizeId: string;
1046
+ /** @description Size name */
1047
+ sizePanelName: string;
1048
+ /** @description External product system code for size. */
1049
+ productSizeCodeExternal: string;
1050
+ /** @description Product stock quantity */
1051
+ productSizeQuantity: number;
1052
+ }[];
1053
+ /** @description Available stock quantity for order sales */
1054
+ productSizesDispositionsInSales: {
1055
+ /** @description Size identifier */
1056
+ sizeId: string;
1057
+ /** @description Size name */
1058
+ sizePanelName: string;
1059
+ /** @description External product system code for size. */
1060
+ productSizeCodeExternal: string;
1061
+ /** @description Available stock quantity of product from supplier stock. */
1062
+ productSizeQuantityOutsideStock: number;
1063
+ /** @description Available stock quantity of product from own stock. */
1064
+ productSizeQuantityOwnStock: number;
1065
+ /** @description Available stock quantity of product from all stocks. */
1066
+ productSizeQuantityAllStocks: number;
1067
+ /** @description Available product quantity in own stock from before 1 day . */
1068
+ productSizeDisposition1d: number;
1069
+ /** @description Available product quantity in own stock from before 2 Days. */
1070
+ productSizeDisposition2d: number;
1071
+ /** @description Available product quantity in own stock from before 3 Days. */
1072
+ productSizeDisposition3d: number;
1073
+ /** @description Available product quantity in own stock from before 4 Days. */
1074
+ productSizeDisposition4d: number;
1075
+ /** @description Available product quantity in own stock from before 5 Days. */
1076
+ productSizeDisposition5d: number;
1077
+ /** @description Available product quantity in own stock from before 6 Days. */
1078
+ productSizeDisposition6d: number;
1079
+ /** @description Available product quantity in own stock from before 7 Days. */
1080
+ productSizeDisposition7d: number;
1081
+ /** @description Available product quantity in own stock from before 1 week. */
1082
+ productSizeDisposition1w: number;
1083
+ /** @description Available product quantity in own stock from before 2 weeks. */
1084
+ productSizeDisposition2w: number;
1085
+ /** @description Available product quantity in own stock from before 3 weeks. */
1086
+ productSizeDisposition3w: number;
1087
+ /** @description Available product quantity in own stock from before 4 weeks. */
1088
+ productSizeDisposition4w: number;
1089
+ }[];
1090
+ };
1091
+ /** @description Delivery data */
1092
+ productSizesDeliveries: {
1093
+ /** @description Size identifier */
1094
+ sizeId: string;
1095
+ /** @description Size name */
1096
+ sizePanelName: string;
1097
+ /** @description Product stock quantity */
1098
+ productSizeQuantity: number;
1099
+ }[];
1100
+ /** @description Data of number of products added to GRN */
1101
+ productSizesGoodsReceivedNotes?: {
1102
+ /** @description Size identifier */
1103
+ sizeId: string;
1104
+ /** @description Size name */
1105
+ sizePanelName: string;
1106
+ /** @description Product stock quantity */
1107
+ productSizeQuantity: number;
1108
+ }[];
1109
+ /** @description Size data */
1110
+ productSizesStocksLocations: {
1111
+ /** @description Stock ID */
1112
+ stockId: number;
1113
+ productSizesLocation: {
1114
+ /** @description Size identifier */
1115
+ sizeId: string;
1116
+ /** @description Warehouse location ID */
1117
+ stockLocationId: number;
1118
+ /** @description Warehouse location full path */
1119
+ stockLocationTextId: string;
1120
+ /** @description Storage location code */
1121
+ stockLocationCode?: string;
1122
+ /** @description Additional locations */
1123
+ stockAdditionalLocations?: {
1124
+ /** @description Warehouse location ID */
1125
+ stockAdditionalLocationId: number;
1126
+ /** @description Warehouse location full path */
1127
+ stockAdditionalLocationTextId: string;
1128
+ /** @description Storage location code */
1129
+ stockAdditionalLocationCode: string;
1130
+ }[];
1131
+ }[];
1132
+ }[];
1133
+ };
1134
+ /** @description Data concerning attributes dependent on indicated product sizes. */
1135
+ productSizesAttributes?: {
1136
+ /** @description Size identifier */
1137
+ sizeId: string;
1138
+ /** @description Size name */
1139
+ sizePanelName?: string;
1140
+ /** @description External product system code for size. */
1141
+ productSizeCodeExternal?: string;
1142
+ /** @description Producer code for size. */
1143
+ productSizeCodeProducer?: string;
1144
+ /** @description Supplier code */
1145
+ productSizeCodeDeliverer?: string;
1146
+ /** @description Product visible even though out of stock Available values: "y" - visible even though out of stock, "n" - not visible when out of stock. */
1147
+ productInPersistent: string;
1148
+ /** @description Data of customers observing product. */
1149
+ productObservedByClients?: {
1150
+ /** @description Customer's login */
1151
+ productSizeObservedClientLogin: string;
1152
+ /** @description Shop Id */
1153
+ shopId: number;
1154
+ /** @description Observed from */
1155
+ productSizeObservedDate: string;
1156
+ }[];
1157
+ /** @description Gross price */
1158
+ productRetailPrice?: number;
1159
+ /** @description Gross price after promotion. The item is returned when the 'showPromotionsPrices' parameter is specified in the request */
1160
+ productPromoRetailPrice?: number;
1161
+ /** @description Wholesale price */
1162
+ productWholesalePrice?: number;
1163
+ /** @description Wholesale price after promotion. The item is returned when the 'showPromotionsPrices' parameter is specified in the request */
1164
+ productPromoWholesalePrice?: number;
1165
+ /** @description Minimal price */
1166
+ productMinimalPrice?: number;
1167
+ /** @description Price for automatic calculations */
1168
+ productAutomaticCalculationPrice?: number;
1169
+ /** @description price for POS. */
1170
+ productPosPrice?: number;
1171
+ /** @description Strikethrough gross retail price */
1172
+ productStrikethroughRetailPrice?: number;
1173
+ /** @description Strikethrough gross wholesale price */
1174
+ productStrikethroughWholesalePrice?: number;
1175
+ /** @description Weight */
1176
+ productSizeWeight: number;
1177
+ /** @description Weight without the packaging */
1178
+ productSizeWeightWithoutPackaging: number;
1179
+ }[];
1180
+ /** @description Data concerning attributes dependent on indicated stores with particular product assigned. */
1181
+ productShopsAttributes?: {
1182
+ /** @description Shop Id */
1183
+ shopId: number;
1184
+ /** @description Information on the prices dependent on shop. */
1185
+ productShopSizesAttributes?: {
1186
+ /** @description Size identifier */
1187
+ sizeId: string;
1188
+ /** @description Size name */
1189
+ sizePanelName: string;
1190
+ /** @description External product system code for size. */
1191
+ productSizeCodeExternal: string;
1192
+ /** @description Gross price */
1193
+ productRetailPrice: number;
1194
+ /** @description Gross price after promotion. The item is returned when the 'showPromotionsPrices' parameter is specified in the request */
1195
+ productPromoRetailPrice: number;
1196
+ /** @description Wholesale price */
1197
+ productWholesalePrice: number;
1198
+ /** @description Wholesale price after promotion. The item is returned when the 'showPromotionsPrices' parameter is specified in the request */
1199
+ productPromoWholesalePrice: number;
1200
+ /** @description Minimal price */
1201
+ productMinimalPrice: number;
1202
+ /** @description Price for automatic calculations */
1203
+ productAutomaticCalculationPrice: number;
1204
+ /** @description Recommended retail price */
1205
+ productSuggestedPrice: number;
1206
+ /** @description Strikethrough gross retail price */
1207
+ productStrikethroughRetailPrice: number;
1208
+ /** @description Strikethrough gross wholesale price */
1209
+ productStrikethroughWholesalePrice: number;
1210
+ }[];
1211
+ /** @description Information about prices for price comparison websites dependent on a shop */
1212
+ productShopPriceComparisonSitesPrices: {
1213
+ /** @description price comparison website ID */
1214
+ priceComparisonSiteId: number;
1215
+ /** @description Percentage difference between the price comparison website and the shop */
1216
+ productPriceComparisonSitePercentDiff: number;
1217
+ /** @description Price for a price comparison website in a shop */
1218
+ productPriceComparisonSitePrice: number;
1219
+ }[];
1220
+ /** @description Gross price */
1221
+ productRetailPrice: number;
1222
+ /** @description Gross price after promotion. The item is returned when the 'showPromotionsPrices' parameter is specified in the request */
1223
+ productPromoRetailPrice?: number;
1224
+ /** @description Wholesale price */
1225
+ productWholesalePrice: number;
1226
+ /** @description Wholesale price after promotion. The item is returned when the 'showPromotionsPrices' parameter is specified in the request */
1227
+ productPromoWholesalePrice?: number;
1228
+ /** @description Minimal price */
1229
+ productMinimalPrice: number;
1230
+ /** @description Price for automatic calculations */
1231
+ productAutomaticCalculationPrice: number;
1232
+ /** @description Price settings, possible values: "wholesale_equals_retail" - Wholesale price same as retail price, "wholesale_notequals_retail" - Wholesale price different than retail price, "all_prices_equals_zero" - All prices request a quote by phone, "retail_price_equals_zero" - Retail price on call, "default_prices" - default prices, "retail_equals_suggested" - Retail price is the same as recommended one, "automatically_calculated" - Price calculated automatically. */
1233
+ productPricesConfig: string;
1234
+ /** @description Currency ID */
1235
+ currencyId: string;
1236
+ /** @description Recommended retail price */
1237
+ productSuggestedPrice: number;
1238
+ /** @description Strikethrough gross retail price */
1239
+ productStrikethroughRetailPrice: number;
1240
+ /** @description Strikethrough gross wholesale price */
1241
+ productStrikethroughWholesalePrice: number;
1242
+ /** @description Configuration details for setting of parameter prices_config=default_prices. */
1243
+ productConfigPricesDefaultShop?: number;
1244
+ /** @description Average retail margin against average purchase price . */
1245
+ productMarginRetailFromAvaragePrices: number;
1246
+ /** @description Average wholesale margin against average purchase price. */
1247
+ productMarginWholesaleFromAvaragePrices: number;
1248
+ /** @description Configuration details for setting of parameter prices_config=automatically_calculated. */
1249
+ productPricesConfigAutomatonDetails?: {
1250
+ /** @description Price name, one of values: retail, wholsale, minimal. */
1251
+ priceAutomatonPriceName: string;
1252
+ /** @description Price setting, one of values: own, last_purchased, avarage_purchased, retail, wholsale, minimal */
1253
+ priceAutomatonPriceSettings: string;
1254
+ /** @description Price type, one of values: gross, net */
1255
+ priceAutomatonPriceType: string;
1256
+ /** @description Final amount */
1257
+ priceAutomatonPriceValue: number;
1258
+ /** @description Final amount currency */
1259
+ priceAutomatonPriceCurrencyId: string;
1260
+ /** @description shop ID from which price is retrieved */
1261
+ priceAutomatonPriceShop: number;
1262
+ /** @description Amount margin */
1263
+ priceAutomatonMarginCurrencyValue: number;
1264
+ /** @description Amount margin currency */
1265
+ priceAutomatonMarginCurrencyId: string;
1266
+ /** @description Percentage margin */
1267
+ priceAutomatonMarginPercentValue: number;
1268
+ /** @description Minimal value of percentage margin */
1269
+ priceAutomatonPricePercentMinimalValue: number;
1270
+ /** @description Minimal value of percentage margin currency */
1271
+ priceAutomatonPricePercentMinimalCurrencyId: string;
1272
+ /** @description Minimal amount with margins reflected */
1273
+ priceAutomatonPriceMinimalValue: number;
1274
+ /** @description Minimal amount currency */
1275
+ priceAutomatonPriceMinimalCurrencyId: string;
1276
+ /** @description Decimal complement should contain 0 to 2 digits. If it contains 0 digits, the system will calculate the amount with precision of up to 2 decimal places. If it contains 2 digits, the system will calculate the amount with precision of the total number and will add the value of this field as a decimal part of this amount */
1277
+ priceAutomatonDecimalRoundValue: number;
1278
+ }[];
1279
+ /** @description Prices for marketplaces */
1280
+ productAuctionsPrices?: {
1281
+ /** @description Auction site ID */
1282
+ auctionId: number;
1283
+ /** @description Auction site page ID */
1284
+ auctionSiteId: number;
1285
+ /** @description Size identifier */
1286
+ sizeId: string;
1287
+ /** @description "Buy It Now" price */
1288
+ auctionBuyNowPrice: number;
1289
+ /** @description Minimal price */
1290
+ auctionMinimalPrice: number;
1291
+ /** @description Auction starting price */
1292
+ auctionStartPrice: number;
1293
+ }[];
1294
+ /** @description Parameters set for auction sites */
1295
+ productAuctions?: {
1296
+ /** @description Auction site ID */
1297
+ auctionId: number;
1298
+ /** @description Auction site page ID */
1299
+ auctionSiteId: number;
1300
+ /** @description Price settings, possible values: "manual" - Price entered manually, "automatically_calculated" - Price calculated automatically. */
1301
+ auctionPricesConfig: string;
1302
+ /** @description Configuration details for setting of parameter prices_config=automatically_calculated */
1303
+ auctionPricesConfigAutomatonDetails: {
1304
+ /** @description Price name, one of values: retail, wholsale, minimal. */
1305
+ priceAutomatonPriceName: string;
1306
+ /** @description Price setting, one of values: own, last_purchased, avarage_purchased, retail, wholsale, minimal */
1307
+ priceAutomatonPriceSettings: string;
1308
+ /** @description Price type, one of values: gross, net */
1309
+ priceAutomatonPriceType: string;
1310
+ /** @description Final amount */
1311
+ priceAutomatonPriceValue: number;
1312
+ /** @description Final amount currency */
1313
+ priceAutomatonPriceCurrencyId: string;
1314
+ /** @description shop ID from which price is retrieved */
1315
+ priceAutomatonPriceShop: number;
1316
+ /** @description Amount margin */
1317
+ priceAutomatonMarginCurrencyValue: number;
1318
+ /** @description Amount margin currency */
1319
+ priceAutomatonMarginCurrencyId: string;
1320
+ /** @description Percentage margin */
1321
+ priceAutomatonMarginPercentValue: number;
1322
+ /** @description Minimal value of percentage margin */
1323
+ priceAutomatonPricePercentMinimalValue: number;
1324
+ /** @description Minimal value of percentage margin currency */
1325
+ priceAutomatonPricePercentMinimalCurrencyId: string;
1326
+ /** @description Minimal amount with margins reflected */
1327
+ priceAutomatonPriceMinimalValue: number;
1328
+ /** @description Minimal amount currency */
1329
+ priceAutomatonPriceMinimalCurrencyId: string;
1330
+ /** @description Decimal complement should contain 0 to 2 digits. If it contains 0 digits, the system will calculate the amount with precision of up to 2 decimal places. If it contains 2 digits, the system will calculate the amount with precision of the total number and will add the value of this field as a decimal part of this amount */
1331
+ priceAutomatonDecimalRoundValue: number;
1332
+ }[];
1333
+ /** @description Parameters for sizes */
1334
+ productAuctionsSizes: {
1335
+ /** @description Size identifier */
1336
+ sizeId: string;
1337
+ /** @description Configuration details for setting of parameter prices_config=automatically_calculated */
1338
+ auctionPricesConfigAutomatonDetails: {
1339
+ /** @description Price name, one of values: retail, wholsale, minimal. */
1340
+ priceAutomatonPriceName: string;
1341
+ /** @description Price setting, one of values: own, last_purchased, avarage_purchased, retail, wholsale, minimal */
1342
+ priceAutomatonPriceSettings: string;
1343
+ /** @description Price type, one of values: gross, net */
1344
+ priceAutomatonPriceType: string;
1345
+ /** @description Final amount */
1346
+ priceAutomatonPriceValue: number;
1347
+ /** @description Final amount currency */
1348
+ priceAutomatonPriceCurrencyId: string;
1349
+ /** @description shop ID from which price is retrieved */
1350
+ priceAutomatonPriceShop: number;
1351
+ /** @description Amount margin */
1352
+ priceAutomatonMarginCurrencyValue: number;
1353
+ /** @description Amount margin currency */
1354
+ priceAutomatonMarginCurrencyId: string;
1355
+ /** @description Percentage margin */
1356
+ priceAutomatonMarginPercentValue: number;
1357
+ /** @description Minimal value of percentage margin */
1358
+ priceAutomatonPricePercentMinimalValue: number;
1359
+ /** @description Minimal value of percentage margin currency */
1360
+ priceAutomatonPricePercentMinimalCurrencyId: string;
1361
+ /** @description Minimal amount with margins reflected */
1362
+ priceAutomatonPriceMinimalValue: number;
1363
+ /** @description Minimal amount currency */
1364
+ priceAutomatonPriceMinimalCurrencyId: string;
1365
+ /** @description Decimal complement should contain 0 to 2 digits. If it contains 0 digits, the system will calculate the amount with precision of up to 2 decimal places. If it contains 2 digits, the system will calculate the amount with precision of the total number and will add the value of this field as a decimal part of this amount */
1366
+ priceAutomatonDecimalRoundValue: number;
1367
+ }[];
1368
+ }[];
1369
+ }[];
1370
+ /** @description Parameters set for price comparison websites */
1371
+ productShopPriceComparisonSites: {
1372
+ /** @description price comparison website ID */
1373
+ priceComparisonSiteId: number;
1374
+ /** @description Whether the product is exported in the feed to the sales service */
1375
+ active: boolean;
1376
+ /** @description price comparison website name */
1377
+ priceComparisonSiteName: string;
1378
+ /** @description Price settings, possible values: "manual" - Price entered manually, "automatically_calculated" - Price calculated automatically. */
1379
+ priceComparisonSitePricesConfig?: string;
1380
+ /** @description Configuration details for setting of parameter prices_config=automatically_calculated */
1381
+ priceComparisonSitePriceConfigAutomatonDetails?: {
1382
+ /** @description Price setting, one of values: own, last_purchased, avarage_purchased, retail, wholsale, minimal */
1383
+ priceAutomatonPriceSettings: string;
1384
+ /** @description Price type, one of values: gross, net */
1385
+ priceAutomatonPriceType: string;
1386
+ /** @description Final amount */
1387
+ priceAutomatonPriceValue: number;
1388
+ /** @description Final amount currency */
1389
+ priceAutomatonPriceCurrencyId: string;
1390
+ /** @description shop ID from which price is retrieved */
1391
+ priceAutomatonPriceShop: number;
1392
+ /** @description Amount margin */
1393
+ priceAutomatonMarginCurrencyValue: number;
1394
+ /** @description Amount margin currency */
1395
+ priceAutomatonMarginCurrencyId: string;
1396
+ /** @description Percentage margin */
1397
+ priceAutomatonMarginPercentValue: number;
1398
+ /** @description Minimal value of percentage margin */
1399
+ priceAutomatonPricePercentMinimalValue: number;
1400
+ /** @description Minimal value of percentage margin currency */
1401
+ priceAutomatonPricePercentMinimalCurrencyId: string;
1402
+ /** @description Minimal amount with margins reflected */
1403
+ priceAutomatonPriceMinimalValue: number;
1404
+ /** @description Minimal amount currency */
1405
+ priceAutomatonPriceMinimalCurrencyId: string;
1406
+ /** @description Decimal complement should contain 0 to 2 digits. If it contains 0 digits, the system will calculate the amount with precision of up to 2 decimal places. If it contains 2 digits, the system will calculate the amount with precision of the total number and will add the value of this field as a decimal part of this amount */
1407
+ priceAutomatonDecimalRoundValue: number;
1408
+ };
1409
+ }[];
1410
+ }[];
1411
+ /** @description Supplier ID. */
1412
+ delivererId?: number;
1413
+ /** @description Supplier name. */
1414
+ delivererName?: string;
1415
+ /** @description Sizes available for products data. */
1416
+ productSizes?: {
1417
+ /** @description Size identifier */
1418
+ sizeId: string;
1419
+ /** @description Size name */
1420
+ sizePanelName: string;
1421
+ }[];
1422
+ /** @description Size chart ID */
1423
+ sizeChartId?: number;
1424
+ /** @description Size chart name */
1425
+ sizeChartName?: string;
1426
+ /** @description Number of photos assigned to product. */
1427
+ productImagesCount?: number;
1428
+ /** @description Product availability management method Available values: "stock" - by means of stock management tools, "manual" - manually. */
1429
+ productAvailabilityManagementType?: string;
1430
+ /** @description Do You wish to sum up the products in the basket as a one order? Available values: "y" - yes, "n" - no. */
1431
+ productSumInBasket?: string;
1432
+ /** @description Menu assignments */
1433
+ productMenu?: {
1434
+ /** @description ID of the menu node to which the product is to be assigned */
1435
+ menuItemId: number;
1436
+ /** @description Shop Id */
1437
+ shopId: number;
1438
+ /** @description ID of the menu zone displayed in the mask */
1439
+ menuId: number;
1440
+ /** @description Menu lang data. */
1441
+ menuItemDescriptionsLangData: {
1442
+ /** @description Language ID */
1443
+ langId: string;
1444
+ /** @description Menu item name. */
1445
+ menuItemName: string;
1446
+ /** @description Menu element text identifier. Example: "item1\item2\item3". */
1447
+ menuItemTextId: string;
1448
+ }[];
1449
+ }[];
1450
+ /** @description Product type. Allowed values: "product_item" - Goods, "product_packaging" - packaging, "product_bundle" - set. "product_collection" - collection. "product_service" - service. "product_virtual" - virtual product. "product_configurable" - configurable product. */
1451
+ productType?: string;
1452
+ /** @description List of components if a products is a set or collection. */
1453
+ productBundleItems?: {
1454
+ /** @description Product IAI code */
1455
+ productId: number;
1456
+ /** @description Product ID in a set or collection */
1457
+ bundledId: number;
1458
+ /** @description Number of products in a set or collection */
1459
+ bundleQuantity: number;
1460
+ /** @description If a collection or a set is displayed with this product in a shop. */
1461
+ isBundleShown: boolean;
1462
+ /** @description Available sizes of products in a set or collection for the shop */
1463
+ bundledAvailableSizes: {
1464
+ /** @description Size identifier */
1465
+ sizeId: string;
1466
+ /** @description Size name */
1467
+ sizePanelName: string;
1468
+ }[];
1469
+ /** @description All sizes of products in a set or collection. */
1470
+ bundledAllSizes: {
1471
+ /** @description Size identifier */
1472
+ sizeId: string;
1473
+ /** @description Size name */
1474
+ sizePanelName: string;
1475
+ }[];
1476
+ /** @description Available sizes of products in a set or collection for marketplaces */
1477
+ bundledAvailableSizesInAuctions: {
1478
+ /** @description Size identifier */
1479
+ sizeId: string;
1480
+ /** @description Size name */
1481
+ sizePanelName: string;
1482
+ }[];
1483
+ }[];
1484
+ /** @description Remember serial numbers of sold products : "required" - #!wymagane!#, "optional" - optional, "na" - not used */
1485
+ productSaveSerialNumbers?: string;
1486
+ /** @description Parameters. */
1487
+ productParameters?: {
1488
+ /** @description Parameter ID */
1489
+ parameterId: number;
1490
+ /** @description Parameter type * @enum {string} */
1491
+ parameterType: "section" | "parameter";
1492
+ /** @description Language data */
1493
+ parameterDescriptionsLangData: {
1494
+ /** @description Language ID */
1495
+ langId: string;
1496
+ /** @description Parameter name. */
1497
+ parameterName: string;
1498
+ /** @description Parameter description */
1499
+ parameterDescription: string;
1500
+ /** @description Parameter options for shops */
1501
+ parameterShopsData: {
1502
+ /** @description Shop Id */
1503
+ shopId: number;
1504
+ /** @description Link to icon on a product card */
1505
+ parameterIconCard: string;
1506
+ /** @description Link to icon on a product list */
1507
+ parameterIconProductsList: string;
1508
+ }[];
1509
+ }[];
1510
+ /** @description Parameter values */
1511
+ parameterValues: {
1512
+ /** @description Parameter value ID */
1513
+ parameterValueId: number;
1514
+ /** @description Language data */
1515
+ parameterValueDescriptionsLangData: {
1516
+ /** @description Language ID */
1517
+ langId: string;
1518
+ /** @description Attributes group name. */
1519
+ parameterValueName: string;
1520
+ /** @description Parameter description */
1521
+ parameterValueDescription: string;
1522
+ /** @description Parameter options for shops */
1523
+ parameterValueShopsData: {
1524
+ /** @description Shop Id */
1525
+ shopId: number;
1526
+ /** @description Link to icon on a product card */
1527
+ parameterValueIconCard: string;
1528
+ /** @description Link to icon on a product list */
1529
+ parameterValueIconProductsList: string;
1530
+ }[];
1531
+ }[];
1532
+ }[];
1533
+ }[];
1534
+ /** @description Standard producer code. Available values: "auto" - Choose automatically, "GTIN14" - GTIN-14 "GTIN13" - GTIN-13 (EAN-13) "ISBN13" - GTIN-13 (ISBN-13) "GTIN12" - GTIN-12 (UPC-A) "ISBN10" - ISBN-10 "GTIN8" - GTIN-8 (EAN-8) "UPCE" - UPC-E "MPN" - MPN "other" - Other */
1535
+ producerCodesStandard?: string;
1536
+ /** @description The JavaScript formula calculating prices */
1537
+ priceFormula?: {
1538
+ /** @description Formula identifier */
1539
+ priceFormulaId: number;
1540
+ /** @description Formula parameters for calculating price */
1541
+ priceFormulaParameters: string;
1542
+ /** @description Formula function for calculating price */
1543
+ priceFormulaFunction: string;
1544
+ };
1545
+ /** @description Identifiers of the sets, to which the goods are assigned */
1546
+ bundledIds?: number[];
1547
+ /** @description Data of individual descriptions for stores */
1548
+ productIndividualDescriptionsData?: {
1549
+ /** @description Shop Id */
1550
+ shopId: string;
1551
+ /** @description Language ID */
1552
+ langId: string;
1553
+ /** @description Product name. */
1554
+ productName: string;
1555
+ /** @description Short product description. */
1556
+ productDescription: string;
1557
+ /** @description Long product description. */
1558
+ productLongDescription: string;
1559
+ }[];
1560
+ /** @description #!DaneIndywidualnychAdresowURLDlaSklepow!# */
1561
+ productIndividualUrlsData?: {
1562
+ /** @description Shop Id */
1563
+ shopId: string;
1564
+ /** @description Language ID */
1565
+ langId: string;
1566
+ url: string;
1567
+ }[];
1568
+ /** @description Individual description data for external services */
1569
+ productServicesDescriptionsData?: {
1570
+ /** @description Shop Id */
1571
+ shopId: string;
1572
+ /** @description External service identifier */
1573
+ serviceId: string;
1574
+ /** @description Product name. */
1575
+ productName: string;
1576
+ /** @description Short product description. */
1577
+ productDescription: string;
1578
+ /** @description Long product description. */
1579
+ productLongDescription: string;
1580
+ }[];
1581
+ /** @description Shipping, returns and complaints settings */
1582
+ dispatchSettings?: {
1583
+ enabled: boolean;
1584
+ /** @description Shipping settings */
1585
+ shippingSettings?: {
1586
+ /** @description Disable cash on delivery orders */
1587
+ codDisabled: boolean;
1588
+ /** @description Only personal collection */
1589
+ dvpOnly: boolean;
1590
+ /** @description Insurance required */
1591
+ insuranceOnly: boolean;
1592
+ /** @description Oversized product */
1593
+ atypicalSize: boolean;
1594
+ /** @description Exclusion from the Smile service */
1595
+ excludeSmileService: boolean;
1596
+ /** @description List of courier services which cannot be used to ship this product */
1597
+ disallowedCouriers: number[];
1598
+ };
1599
+ /** @description Free shipping settings */
1600
+ freeShippingSettings?: {
1601
+ /** @description Edition mode * @enum {string} */
1602
+ mode: "no" | "onlyProduct" | "wholeBasket";
1603
+ /** @description Set free shipping for the payment method only . */
1604
+ availablePaymentForms: {
1605
+ /** @description prepayment */
1606
+ prepaid: boolean;
1607
+ /** @description Cash on delivery */
1608
+ cashOnDelivery: boolean;
1609
+ /** @description Trade credit */
1610
+ tradeCredit: boolean;
1611
+ };
1612
+ /** @description List of courier services for which shipping is free */
1613
+ availableCouriers: number[];
1614
+ /** @description List of courier services by which the products can be sent free of charge. IDs couriers */
1615
+ availableCouriersForSingleProduct: number[];
1616
+ /** @description List of regions with free shipment */
1617
+ availableRegions: number[];
1618
+ };
1619
+ /** @description Return and complaint settings */
1620
+ returnProductSettings: {
1621
+ /** @description Product can be returned */
1622
+ returnOptions: {
1623
+ enabled: boolean;
1624
+ /** @description yes - for companies */
1625
+ firm: boolean;
1626
+ /** @description yes - for wholesalers */
1627
+ hurt: boolean;
1628
+ /** @description yes - for retailers */
1629
+ detalist: boolean;
1630
+ };
1631
+ byOwnService: boolean;
1632
+ byInPostSzybkieZwrotyByIAI: boolean;
1633
+ };
1634
+ };
1635
+ /** @description Standard unit settings */
1636
+ standardUnit?: {
1637
+ /** @description Possible special contexts corresponding to standard units. Available values: "CONTEXT_STD_UNIT_WEIGHT" - Product weight in grams, "CONTEXT_STD_UNIT_WEIGHT_SI" - Product weight in kilograms, "CONTEXT_STD_UNIT_VOLUME" - A product's value in milliliters "CONTEXT_STD_UNIT_VOLUME_SI" - A product's value in liters "CONTEXT_STD_UNIT_LENGTH" - Length of product in meters "CONTEXT_STD_UNIT_AREA_M2" - Area of ​​product in square meters "CONTEXT_STD_UNIT_VOLUME_M3" - The volume of products in cubic meters "CONTEXT_STD_UNIT_QUANTITY_PACKAGE" - Number of pieces per pack for standard unit */
1638
+ contextValue: string;
1639
+ /** @description Total length/volume/area/weight of product */
1640
+ standardUnitValue: number;
1641
+ /** @description Price converter per unit. Available values: "0" - default (taken from the category), "1" - price per gram/milliliter/meter "10" - price per 10 grams/10 milliliters/10 meters "100" - price per 100 grams/100 milliliters/100 meters "1000" - price per liter/kilogram/kilometer */
1642
+ converterUnitValue: number;
1643
+ };
1644
+ /** @description Minimal number of products in an order */
1645
+ minQuantityPerOrder?: {
1646
+ /** @description Minimum number of products in a retail order */
1647
+ minQuantityPerOrderRetail: number;
1648
+ /** @description Minimum number of products in a wholesale order */
1649
+ minQuantityPerOrderWholesale: number;
1650
+ };
1651
+ /** @description The product is free of charge. Possible values: "y" - is free of charge, "n" - is not free of charge. */
1652
+ productIsGratis?: string;
1653
+ /** @description Dimensions and overall weight */
1654
+ productDimensions?: {
1655
+ /** @description The width of a product in centimeters */
1656
+ productWidth: number;
1657
+ /** @description Height of a product in centimeters */
1658
+ productHeight: number;
1659
+ /** @description The length of a product in centimeters */
1660
+ productLength: number;
1661
+ /** @description Overall weight in grams */
1662
+ productOverallWeight: number;
1663
+ };
1664
+ /** @description Responsible producer code */
1665
+ responsibleProducerCode?: string;
1666
+ /** @description Responsible person code */
1667
+ responsiblePersonCode?: string;
1668
+ }[];
1669
+ } & PagedResponse;
1670
+
1671
+ type ProductParameter = {
1672
+ /** @description Parameter ID */
1673
+ id: number;
1674
+ /** @description Names of section, parameter or value. */
1675
+ names: {
1676
+ /** @description Language ID */
1677
+ languageId: string;
1678
+ /** @description Description */
1679
+ value: string;
1680
+ }[];
1681
+ /** @description Descriptions of section, parameter or value. */
1682
+ descriptions: {
1683
+ /** @description Language ID */
1684
+ languageId: string;
1685
+ /** @description Description */
1686
+ value: string;
1687
+ }[];
1688
+ /** @description Search descriptions of parameter value. */
1689
+ searchDescription: {
1690
+ /** @description Language ID */
1691
+ languageId: string;
1692
+ /** @description Description */
1693
+ value: string;
1694
+ /** @description Shop Id */
1695
+ shopId: number;
1696
+ }[];
1697
+ /** @description Icons of section, parameter or value to display on the product card. */
1698
+ cardIcons: {
1699
+ /** @description Language ID */
1700
+ languageId: string;
1701
+ /** @description Description */
1702
+ value: string;
1703
+ /** @description Shop Id */
1704
+ shopId: number;
1705
+ /** @description Icon type */
1706
+ iconType: string;
1707
+ }[];
1708
+ /** @description Icons of section, parameter or value to display on the list of products. */
1709
+ linkIcons: {
1710
+ /** @description Language ID */
1711
+ languageId: string;
1712
+ /** @description Description */
1713
+ value: string;
1714
+ /** @description Shop Id */
1715
+ shopId: string;
1716
+ /** @description Icon type */
1717
+ iconType: string;
1718
+ }[];
1719
+ /** @description Parameter's additional feature. */
1720
+ contextId: string;
1721
+ /** @description value of additional feature. */
1722
+ contextValueId: string;
1723
+ /** @description Parameter type */
1724
+ type: string;
1725
+ /** @description Identifier of the parameter to which the value belongs */
1726
+ parameterId: string;
1727
+ /** @description List of parameter value identifiers */
1728
+ parameterValueIds: number[];
1729
+ }
1730
+
1731
+ export type SearchProductsParametersResponse = {
1732
+ parametersResult: Record<string, ProductParameter>;
1733
+ } & PagedResponse;
1734
+
1735
+ export type SearchClientsCrmResponse = {
1736
+ /** @description List of customers. */
1737
+ clientsResults: {
1738
+ /** @description Unique client's number. */
1739
+ clientId: number;
1740
+ /** @description Customer's login. */
1741
+ clientLogin: string;
1742
+ /** @description E-mail address. */
1743
+ clientEmail: string;
1744
+ /** @description Customer type, possible values:- person - if client sex is not determined,- person_male - when client is a male,- person_female - when a customer is a woman,- firm - when client is company. */
1745
+ clientType: "person" | "person_male" | "person_female" | "firm";
1746
+ /** @description Determines, whether client is a wholesaler. */
1747
+ clientIsWholesaler: "yes" | "no";
1748
+ /** @description Country ID in accordance with ISO-3166. */
1749
+ clientCountryId: string;
1750
+ /** @description Language ID */
1751
+ langId: string;
1752
+ /** @description Completed orders. */
1753
+ clientOrdersCompletedCount: number;
1754
+ /** @description Number of orders. */
1755
+ clientOrdersAllCount: number;
1756
+ /** @description Number of watched products. */
1757
+ clientObservedProductsCount: number;
1758
+ /** @description Number of purchased products. */
1759
+ clientPurchasedProductsCount: number;
1760
+ /** @description Total cash transaction value. */
1761
+ clientTotalOrdersValue: number;
1762
+ /** @description Total number of customer loyalty points. */
1763
+ clientLoyaltyPoints: number;
1764
+ /** @description Customer discount information */
1765
+ clientDiscount: {
1766
+ /** @description Discount type:- advanced,- simple,- none,- group. */
1767
+ clientDiscountType: "advanced" | "simple" | "none" | "group";
1768
+ /** @description percentage discount value. (No data is returned if rebate_type is not "simple"). */
1769
+ clientDiscountValue: number;
1770
+ };
1771
+ /** @description Date of last purchase. */
1772
+ clientLastPurchaseDate: string;
1773
+ /** @description Date of last customer login (YYYY-MM-DD) */
1774
+ clientLastLoginDate: string;
1775
+ /** @description List of shops the customer is active in */
1776
+ clientActiveInShops: {
1777
+ /** @description Shop Id */
1778
+ shopId: number;
1779
+ /** @description Store name. */
1780
+ shopName: string;
1781
+ }[];
1782
+ /** @description Information about the loyalty programpossible values:- yes_voucher - when customers are in a loyalty program and have only used vouchers,- yes_voucher_cash - when customers are in a loyalty program and have only used vouchers or cash deposits,- yes_clients,- yes_orders - when customers are in the loyalty program and have made at least one order,- no - when customers are in the loyalty program,- banned - when customers are blocked. */
1783
+ clientAffiliateProgram: {
1784
+ /** @description Does the customer participate in the loyalty program:- yes_voucher_cash,- yes_voucher,- no,- banned. */
1785
+ clientAffiliateProgramValue: "yes_voucher_cash" | "yes_voucher" | "no" | "banned";
1786
+ /** @description Data about loyalty program participant, omitted if active = no / banned. */
1787
+ affiliatePrograms: {
1788
+ /** @description Number of all orders. */
1789
+ clientAffiliateProgramTotalOrdersCount: number;
1790
+ /** @description Total cash transaction value. */
1791
+ clientAffiliateProgramTotalOrdersWorth: number;
1792
+ /** @description Partner name. */
1793
+ affiliateProgramName: string;
1794
+ }[];
1795
+ };
1796
+ /** @description List of observed products. If this parameter is returned, the maximum number of results was reached: 10. */
1797
+ clientObservedProductsData: {
1798
+ /** @description Product IAI code */
1799
+ productId: number;
1800
+ /** @description Size identifier */
1801
+ sizeId: string;
1802
+ }[];
1803
+ /** @description List of purchased products. If this parameter is returned, the maximum number of results was reached: 10. */
1804
+ clientPurchasedProductsData: {
1805
+ /** @description Product IAI code */
1806
+ productId: number;
1807
+ /** @description Size identifier */
1808
+ sizeId: string;
1809
+ }[];
1810
+ /** @description Order list. If this parameter is returned, the maximum number of results was reached: 10. */
1811
+ clientOrdersData: {
1812
+ /** @description Order ID. */
1813
+ orderId: string;
1814
+ /** @description Order serial number. */
1815
+ orderSerialNumber: number;
1816
+ }[];
1817
+ /** @description List of completed orders. If this parameter is returned, the maximum number of results was reached: 10. */
1818
+ clientOrdersCompletedData: {
1819
+ /** @description Order ID. */
1820
+ orderId: string;
1821
+ /** @description Order serial number. */
1822
+ orderSerialNumber: number;
1823
+ }[];
1824
+ /** @description Cell phone. */
1825
+ clientPhone1: string;
1826
+ /** @description Land line. */
1827
+ clientPhone2: string;
1828
+ /** @description Notes from customer. */
1829
+ clientNote: string;
1830
+ /** @description Number of opinions. */
1831
+ clientOpinionsCount: number;
1832
+ /** @description List of shops where a customer agreed or didn't agree to receive email newsletter. */
1833
+ newsletterEmailApprovalsData: {
1834
+ /** @description Permission to E-mail Newsletter. */
1835
+ inNewsletterEmailApproval: string;
1836
+ /** @description Shop Id */
1837
+ shopId: number;
1838
+ }[];
1839
+ /** @description List of shops where a customer agreed or didn't agree to receive sms newsletter. */
1840
+ newsletterSmsApprovalsData: {
1841
+ /** @description Permission to SMS Newsletter. */
1842
+ inNewsletterSmsApproval: string;
1843
+ /** @description Shop Id */
1844
+ shopId: number;
1845
+ }[];
1846
+ /** @description Information about customer balance. */
1847
+ clientBalances: {
1848
+ /** @description Balance value. */
1849
+ clientBalanceAmount: number;
1850
+ /** @description Currency ID */
1851
+ currencyId: string;
1852
+ }[];
1853
+ /** @description Customer orders statistics. */
1854
+ clientOrdersStatistic: {
1855
+ /** @description Retail turnover. */
1856
+ clientOrdersStatisticRetailValues: {
1857
+ /** @description Total net value. */
1858
+ orderRetailValueNet: number;
1859
+ /** @description Total gross value. */
1860
+ orderRetailValue: number;
1861
+ /** @description Currency ID */
1862
+ currencyId: string;
1863
+ }[];
1864
+ /** @description Wholesale turnover. */
1865
+ clientOrdersStatisticWholesaleValues: {
1866
+ /** @description Total net value. */
1867
+ orderWholesaleValueNet: number;
1868
+ /** @description Total gross value. */
1869
+ orderWholesaleValue: number;
1870
+ /** @description Currency ID */
1871
+ currencyId: string;
1872
+ }[];
1873
+ /** @description Turnover with the division to shops. */
1874
+ clientOrdersStatisticValuesByShops: {
1875
+ /** @description Shop Id */
1876
+ shopId: number;
1877
+ /** @description Turnover with the division to shops. */
1878
+ clientOrdersStatisticValues: {
1879
+ /** @description Total net value. */
1880
+ orderValueNet: number;
1881
+ /** @description Total gross value. */
1882
+ orderValue: number;
1883
+ /** @description Currency ID */
1884
+ currencyId: string;
1885
+ }[];
1886
+ }[];
1887
+ /** @description Profit margin. */
1888
+ clientProfitMargin: number;
1889
+ /** @description Average order value. */
1890
+ clientOrderValueAverage: number;
1891
+ /** @description Average amount of products in an order. */
1892
+ clientProductsCountAverage: number;
1893
+ };
1894
+ /** @description Number of returns. */
1895
+ clientRmaCount: number;
1896
+ /** @description Information about returns. */
1897
+ clientReturnsOrdersStatistic: {
1898
+ /** @description Number of returns. */
1899
+ clientReturnsOrdersCount: number;
1900
+ /** @description Number of returned products. */
1901
+ clientReturnsProductsCount: number;
1902
+ };
1903
+ clientLoyaltyCards: {
1904
+ /** @description Does the customer have a loyalty card.- yes_active,- yes_not_active,- no. */
1905
+ clientHasLoyaltyCard: "yes_active" | "yes_not_active" | "no";
1906
+ /** @description Customer loyalty card ID, omitted when has_loyalty_card = no. */
1907
+ clientLoyaltyCardId: number;
1908
+ /** @description Customer loyalty card number, omitted when has_loyalty_card = no. */
1909
+ clientLoyaltyCardNumber: string;
1910
+ }[];
1911
+ /** @description Customer's first name. */
1912
+ clientFirstName: string;
1913
+ /** @description Customer's last name. */
1914
+ clientLastName: string;
1915
+ /** @description Customer Tax no. */
1916
+ clientNip: string;
1917
+ /** @description Customer's company name. */
1918
+ clientFirm: string;
1919
+ /** @description External system code. */
1920
+ clientCodeExternal: string;
1921
+ }[];
1922
+ } & PagedResponse;
1923
+
1924
+ export type SearchPackagesResponse = {
1925
+ /** @description Object contains detailed information on result of operation. */
1926
+ results: {
1927
+ /** @description Information on error that occurred during gate call. */
1928
+ errors: FaultCodeString;
1929
+ /** @description Package details. */
1930
+ deliveryPackage: {
1931
+ /** @description Shipment ID. */
1932
+ deliveryPackageId: number;
1933
+ /** @description Package number. */
1934
+ deliveryPackageNumber: string;
1935
+ /** @description consignment number. */
1936
+ deliveryShippingNumber: string;
1937
+ /** @description Courier ID. */
1938
+ courierId: number;
1939
+ /** @description Name of the supplier of the shipment. */
1940
+ courierName: string;
1941
+ /** @description Selected delivery date. */
1942
+ deliveryDate: string;
1943
+ /** @description Additional information on delivery date. */
1944
+ deliveryDateAdditional: string;
1945
+ /** @description Estimated date of shipment of the order. */
1946
+ estimatedDeliveryDate: string;
1947
+ /** @description Date of receipt by the buyer,possible formats:"YYYY-MM-dd HH:mm:ss","YYYY-MM-dd", */
1948
+ receivedDate: string;
1949
+ /** @description Package parameters. */
1950
+ deliveryPackageParameters: {
1951
+ /* @description Cash on delivery. */
1952
+ cashOnDelivery: number;
1953
+ /** @description Postal cash on delivery currency. */
1954
+ cashOnDeliveryCurrency: string;
1955
+ /** @description Parcel weight. */
1956
+ deliveryWeight: number;
1957
+ /** @description Link to package tracing. */
1958
+ trackingUrl: string;
1959
+ /** @description Cost for shop. */
1960
+ shippingStoreCosts: {
1961
+ /* @description Package sending net cost. */
1962
+ shippingStoreCostNet: number;
1963
+ /* @description VAT rate for cost of package sending. */
1964
+ shippingStoreCostVat: number;
1965
+ /* @description Package sending gross cost. */
1966
+ shippingStoreCostGross: number;
1967
+ }[];
1968
+ /** @description Package cost. */
1969
+ shippingCosts: {
1970
+ /* @description Package sending net cost. */
1971
+ shippingCostNet: number;
1972
+ /* @description VAT rate for cost of package sending. */
1973
+ shippingCostVat: number;
1974
+ /* @description Package sending gross cost. */
1975
+ shippingCostGross: number;
1976
+ }[];
1977
+ /** @description Shipment configuration options available for a given courier */
1978
+ parcelParameters: {
1979
+ /** @description Key */
1980
+ key: string;
1981
+ /** @description Name */
1982
+ name: string;
1983
+ /** @description Type */
1984
+ type: "radio" | "text" | "select" | "checkbox";
1985
+ /** @description Default value for option */
1986
+ defaultValue: string;
1987
+ /** @description Available values ​​for the options */
1988
+ options: {
1989
+ /** @description Id */
1990
+ id: string;
1991
+ /** @description Name */
1992
+ name: string;
1993
+ }[];
1994
+ }[];
1995
+ /** @description Information on error that occurred during gate call. */
1996
+ errors: FaultCodeString;
1997
+ };
1998
+ };
1999
+ /** @description Type. */
2000
+ eventType: string;
2001
+ /** @description Id. */
2002
+ eventId: number;
2003
+ /** @description Parcel label encoded with base64 algorythm. */
2004
+ label?: string;
2005
+ }[];
2006
+ };
2007
+
2008
+ export type SearchCategoriesIdosellResponse = {
2009
+ /** @description List of IdoSell Categories */
2010
+ categoriesIdoSell: {
2011
+ /** @description IdoSell Category ID */
2012
+ categoryIdoSellId: number;
2013
+ /** @description Parent's identifier */
2014
+ categoryIdoSellParentId: number;
2015
+ /** @description Items quantity */
2016
+ productsCount: number;
2017
+ /** @description Information about IdoSell Category in a given language */
2018
+ categoryIdoSellLangsData: {
2019
+ /** @description Language ID (code in ISO 639-2). */
2020
+ languageId: string;
2021
+ /** @description IdoSell Category name */
2022
+ categoryIdoSellName: string;
2023
+ /** @description IdoSell Category pathname */
2024
+ categoryIdoSellPath: string;
2025
+ }[];
2026
+ }[];
2027
+ } & PagedResponse;
2028
+
2029
+ export type SearchOpinionsResponse = {
2030
+ /** @description Object contains detailed information on result of operation. */
2031
+ results: {
2032
+ id: number;
2033
+ content: string;
2034
+ createDate: string;
2035
+ points: "1" | "2" | "3" | "4" | "5";
2036
+ confirmed: boolean;
2037
+ rating: string;
2038
+ /** @description Customer language ID. */
2039
+ language: string;
2040
+ host: string;
2041
+ /** @description Shop Id */
2042
+ shopId: number;
2043
+ scorePositive: number;
2044
+ scoreNegative: number;
2045
+ picture: {
2046
+ large: {
2047
+ url: string;
2048
+ width: number;
2049
+ height: number;
2050
+ hash: string;
2051
+ };
2052
+ small: {
2053
+ url: string;
2054
+ width: number;
2055
+ height: number;
2056
+ hash: string;
2057
+ };
2058
+ };
2059
+ /** @description Opinion writer's data */
2060
+ client: {
2061
+ /** @description Customer's login. */
2062
+ login: string;
2063
+ id: number;
2064
+ };
2065
+ order: {
2066
+ serialNumber: number;
2067
+ };
2068
+ /** @description Reply to an opinion */
2069
+ answer: string;
2070
+ /** @description Date of reply to opinion in the YYYY-MM-DD HH:MM:SS format */
2071
+ answerDatetime: string;
2072
+ /** @description Opinion modification date */
2073
+ modificationDatetime: string;
2074
+ }[];
2075
+ } & PagedResponse;
2076
+
2077
+ export type SearchDeliveryTimeResponse = {
2078
+ /** @description Object contains detailed information on result of operation. */
2079
+ results: {
2080
+ /** @description Product IAI code */
2081
+ productId: number;
2082
+ /** @description Size identifier */
2083
+ sizeId: string;
2084
+ /** @description Size name */
2085
+ sizePanelName: string;
2086
+ /* @description Product stock quantity */
2087
+ productSizeQuantity: number;
2088
+ /** @description Producer code */
2089
+ productProducerCode: string;
2090
+ /** @description External product system code for size. */
2091
+ productSizeCodeExternal: string;
2092
+ /** @description Number of days required to prepare product for shipment */
2093
+ deliveryTimeDays: number;
2094
+ /** @description Number of hours required to prepare product for shipment */
2095
+ deliveryTimeHours: number;
2096
+ /** @description Error number */
2097
+ errno: number;
2098
+ /** @description Error information. */
2099
+ error: string;
2100
+ }[];
2101
+ };
2102
+
2103
+ export type SearchGiftcardsResponse = {
2104
+ result: ({
2105
+ /** @description Gift card data */
2106
+ giftCardData: {
2107
+ /** @description Card ID */
2108
+ id: number;
2109
+ /** @description Card number */
2110
+ number: string;
2111
+ /** @description Name of card */
2112
+ name: string;
2113
+ /** @description Card expiration date */
2114
+ expirationDate: string;
2115
+ /** @description Card balance */
2116
+ balance: {
2117
+ /* @description Available balance */
2118
+ amount: number;
2119
+ /** @description Currency. */
2120
+ currency: string;
2121
+ };
2122
+ /** @description List of shops the card is active in */
2123
+ shops: number[];
2124
+ /** @description note */
2125
+ note: string;
2126
+ /** @description Is active? */
2127
+ blocked: boolean;
2128
+ };
2129
+ } & FaultCodeString)[];
2130
+ } & PagedResponse;
2131
+
2132
+ type SearchNewsletterResponse<T> = {
2133
+ /** @description Customer data. */
2134
+ clients: ({
2135
+ /** @description Customer ID. */
2136
+ client_number: number;
2137
+ /** @description Customer's login. */
2138
+ login: string;
2139
+ /** @description Is registered. */
2140
+ registered: string;
2141
+ /** @description Customer language ID. */
2142
+ language: string;
2143
+ /** @description Customer e-mail address. */
2144
+ shops: {
2145
+ /** @description shop ID. */
2146
+ shop_id: number;
2147
+ /** @description Newsletter participant approval */
2148
+ approval: string;
2149
+ /** @description Last modification date. For noregister client - adding to newsletter, for registered - last modification participant in newsletter (add or remove from newsletter lists) */
2150
+ date_modification: string;
2151
+ }[];
2152
+ } & T)[];
2153
+ } & PagedSnakecaseResponse;
2154
+
2155
+ export type SearchNewsletterEmailResponse = SearchNewsletterResponse<{
2156
+ /** @description Customer e-mail address. */
2157
+ email: string;
2158
+ }>;
2159
+
2160
+ export type SearchNewsletterSmsResponse = SearchNewsletterResponse<{
2161
+ /** @description Cell phone. */
2162
+ phone_cellular: string;
2163
+ }>;
2164
+
2165
+ export type GetStocksdocumentsProductsResponse = {
2166
+ /** @description Products list. */
2167
+ products: {
2168
+ /** @description Stock keeping unit. */
2169
+ product: number;
2170
+ /** @description Product name. */
2171
+ name: string;
2172
+ /** @description Product size ID. */
2173
+ size: string;
2174
+ /** @description Size name */
2175
+ sizeName: string;
2176
+ quantity: number;
2177
+ ordersQuantity: {
2178
+ /** @description Order ID. If the products are not required for the order (they are collected to stock), 0 is returned. */
2179
+ orderSerialNumber: number;
2180
+ /* @description Product quantity. */
2181
+ productQuantity: number;
2182
+ }[];
2183
+ /* @description Gross purchase price */
2184
+ productPurchasePriceGross: number;
2185
+ /* @description Net purchase price */
2186
+ productPurchasePriceNet: number;
2187
+ /* @description Value of VAT */
2188
+ productVat: number;
2189
+ /** @description Currency ID */
2190
+ currencyId: string;
2191
+ /** @description External system code. */
2192
+ sizeCodeExternal: string;
2193
+ /** @description Producer code. */
2194
+ sizeCodeProducer: string;
2195
+ /** @description Product type on the document. */
2196
+ typeOnDocument: "temporaryProduct" | "existingProduct";
2197
+ /** @description Warehouse location ID. The list of available warehouse locations can be downloaded via the method <a href = "pl/shop/api/?action=method&function=locations&method=get">#get</a> in gateway <a href = "en/shop/api/?action=documentation&function=locations">Locations</a> . */
2198
+ locationId: number;
2199
+ /** @description Storage location code */
2200
+ locationCode: string;
2201
+ /** @description Warehouse location full path. The list of available warehouse locations can be downloaded via the method <a href = "pl/shop/api/?action=method&function=locations&method=get">#get</a> in gateway <a href = "en/shop/api/?action=documentation&function=locations">Locations</a> . */
2202
+ locationPath: string;
2203
+ }[];
2204
+ } & PagedSnakecaseResponse;
2205
+
2206
+ export type GetStocksdocumentsDocumentsResponse = {
2207
+ /** @description List of documents. */
2208
+ stocksDocuments: {
2209
+ /** @description Document identifier. */
2210
+ stockDocumentId: number;
2211
+ /** @description Document number. */
2212
+ stockDocumentNumber: string;
2213
+ /** @description Document type. */
2214
+ stockDocumentType: "pz" | "pw" | "px" | "rx" | "rw" | "wz" | "mm" | "zw";
2215
+ /** @description Document status. */
2216
+ stockDocumentStatus: "open" | "on_the_way" | "close" | "close_delivered" | "close_returned";
2217
+ /** @description Note to document. */
2218
+ stockDocumentNote: string;
2219
+ /** @description Stock ID */
2220
+ stockId: number;
2221
+ /** @description Source warehouse ID */
2222
+ stockSourceId: number;
2223
+ /** @description Document issue date in the YYYY-MM-DD HH:MM:SS format */
2224
+ openDate: string;
2225
+ /** @description User who issued the document */
2226
+ openUser: string;
2227
+ /** @description Document closing date in the YYYY-MM-DD HH:MM:SS format */
2228
+ closeDate: string;
2229
+ /** @description The user who closed the document */
2230
+ closeUser: string;
2231
+ /** @description Document modification date in the YYYY-MM-DD HH:MM:SS format */
2232
+ modificationDate: string;
2233
+ /** @description The user who modified the document */
2234
+ modificationUser: string;
2235
+ /** @description Change in stock date in the YYYY-MM-DD HH:MM:SS format */
2236
+ stockOperationDate: string;
2237
+ /** @description The user who caused the change in stock */
2238
+ stockOperationUser: string;
2239
+ /** @description Delivery on the way. */
2240
+ deliveryOnTheWay: boolean;
2241
+ /** @description Planned date of acceptance of delivery. */
2242
+ plannedDeliveryDate: string;
2243
+ /** @description Products available in presales. */
2244
+ productsInPreorder: string;
2245
+ /** @description Supplier ID. */
2246
+ delivererId: number;
2247
+ /** @description Purchase document */
2248
+ purchaseDocument: {
2249
+ /** @description Type of purchase document */
2250
+ type: "national_VAT_invoice" | "other_purchase_document" | "invoice_without_VAT" | "imports_from_outside_the_EU";
2251
+ /** @description Number of purchase document */
2252
+ number: string;
2253
+ };
2254
+ /** @description Order serial number. */
2255
+ orderNumber: number;
2256
+ /** @description Supplier name. */
2257
+ delivererName: string;
2258
+ /** @description Issue date of purchase document */
2259
+ saleDocumentCreationDate: string;
2260
+ /** @description settled at */
2261
+ priceType: string;
2262
+ }[];
2263
+ } & PagedResponse;
2264
+
2265
+ export type GetClientsResponse = {
2266
+ /** @description Number of all results found */
2267
+ resultsNumberAll: number;
2268
+ /** @description Number of pages of results found */
2269
+ resultsNumberPage: number;
2270
+ /** @description Page with results number. Numeration starts from 0 */
2271
+ resultsPage: number;
2272
+ /** @description Number of results on page. Value from 1 to 100 */
2273
+ resultsLimit: number;
2274
+ /** @description Object contains detailed information on result of operation. */
2275
+ results: {
2276
+ /** @description Unique client's number. */
2277
+ clientId: number;
2278
+ /** @description Last modification date. */
2279
+ clientsLastModificationDate: string;
2280
+ /** @description Customer's login. */
2281
+ clientLogin: string;
2282
+ /** @description External system code. */
2283
+ clientCodeExternal: string;
2284
+ /** @description E-mail address. */
2285
+ clientEmail: string;
2286
+ /** @description Customer type, possible values:- private - if client sex is not determined,- male - when client is a male,- female - when a customer is a woman,- firm - when client is company. */
2287
+ clientType: string;
2288
+ /** @description Display as partner on the page:n - No,y - Yes. */
2289
+ showClientAsPartner: "y" | "n";
2290
+ operator: {
2291
+ /** @description Customer's login. */
2292
+ login: string;
2293
+ /** @description Name. */
2294
+ name: string;
2295
+ };
2296
+ /** @description Is client without registration */
2297
+ isUnregistered: "y" | "n";
2298
+ /** @description Block assigning of discount groups automatically based on order history */
2299
+ blockAutomaticallyAssigningGroupDiscount: "y" | "n";
2300
+ /** @description Client's billing address' data. */
2301
+ clientBillingAddress: {
2302
+ /** @description Customer's first name. */
2303
+ clientFirstName: string;
2304
+ /** @description Customer's last name. */
2305
+ clientLastName: string;
2306
+ /** @description Customer Tax no. */
2307
+ clientNip: string;
2308
+ /** @description Customer's company name. */
2309
+ clientFirm: string;
2310
+ /** @description Street and number. */
2311
+ clientStreet: string;
2312
+ /** @description Customer's postal code. */
2313
+ clientZipCode: string;
2314
+ /** @description Customer's city. */
2315
+ clientCity: string;
2316
+ /** @description Country ID in accordance with ISO-3166. */
2317
+ clientCountryId: string;
2318
+ /** @description Administrative region code. */
2319
+ clientRegionId: string;
2320
+ /** @description Administrative region code. */
2321
+ clientProvinceId: string;
2322
+ /** @description Cell phone. */
2323
+ clientPhone1: string;
2324
+ /** @description Land line. */
2325
+ clientPhone2: string;
2326
+ };
2327
+ /** @description Personal information about customer. */
2328
+ clientPersonalData: {
2329
+ /** @description Date of birth. */
2330
+ clientBirthDate: string;
2331
+ };
2332
+ /** @description Customer preferences. */
2333
+ clientPreferences: {
2334
+ /** @description Language ID */
2335
+ langId: string;
2336
+ /** @description Currency ID */
2337
+ currencyId: string;
2338
+ /** @description Determines, whether client is a wholesaler. */
2339
+ clientIsWholesaler: "yes" | "no";
2340
+ /** @description Is the customer VAT registered:always - always,never - never,neverconfirm - no, this requires confirmation,bycountry - settings as per country. */
2341
+ clientVatPreferences: "always" | "never" | "neverconfirm" | "bycountry";
2342
+ /** @description Discount group ID. */
2343
+ clientGroupDiscountNumber: number;
2344
+ /** @description Customer group name. */
2345
+ clientGroupDiscountName: string;
2346
+ };
2347
+ /** @description List of shops where a customer agreed or didn't agree to receive email newsletter. */
2348
+ newsletterEmailApprovalsData: {
2349
+ /** @description Date from which a customer agreed to receive the newsletter. */
2350
+ newsletterEmailApprovalDate: string;
2351
+ /** @description Shop Id */
2352
+ shopId: number;
2353
+ }[];
2354
+ /** @description List of shops where a customer agreed or didn't agree to receive sms newsletter. */
2355
+ newsletterSmsApprovalsData: {
2356
+ /** @description Date from which a customer agreed to receive the newsletter. */
2357
+ newsletterSmsApprovalDate: string;
2358
+ /** @description Shop Id */
2359
+ shopId: number;
2360
+ }[];
2361
+ /** @description Information about customer balance. */
2362
+ clientBalances: {
2363
+ /* @description Balance value. */
2364
+ clientBalanceAmount: number;
2365
+ /** @description Currency ID */
2366
+ currencyId: string;
2367
+ }[];
2368
+ /** @description Customer trade credit information. */
2369
+ clientTradeCredit: {
2370
+ /* @description Granted credit limit. */
2371
+ clientTradeCreditLimit: number;
2372
+ /** @description Currency ID */
2373
+ currencyId: string;
2374
+ /* @description Used credit limit. */
2375
+ clientTradeCreditUsed: number;
2376
+ };
2377
+ /** @description The parameter stores information about who acquired the customer */
2378
+ affiliateLogin: string;
2379
+ /** @description ID of a partner who acquired a given customer. */
2380
+ affiliateId: number;
2381
+ /* Format: date
2382
+ * @description Client registration date */
2383
+ clientRegistrationDate: string;
2384
+ /** @description List of shops the customer is active in */
2385
+ clientActiveInShops: {
2386
+ /** @description Shop Id */
2387
+ shopId: number;
2388
+ /** @description Store name. */
2389
+ shopName: string;
2390
+ }[];
2391
+ }[];
2392
+ } & PagedResponse;
2393
+
2394
+ export type GetReturnsResponse = {
2395
+ /** @description Element that contains the list of found returns. */
2396
+ returns: {
2397
+ /** @description Merchandise identifier. */
2398
+ id: number;
2399
+ /** @description Order serial number */
2400
+ order_sn: number;
2401
+ /** @description Status label. */
2402
+ status: string;
2403
+ /** @description Identifier of the status label. */
2404
+ status_numeric: number;
2405
+ /** @description Status label in the user language. */
2406
+ statusNameInUserLanguage: string;
2407
+ /** @description Status. */
2408
+ parentStatus: string;
2409
+ /** @description Status identifier. */
2410
+ parentStatusNumeric: number;
2411
+ /** @description Status name in the user language. */
2412
+ parentStatusNameInUserLanguage: string;
2413
+ /** @description Stock to accept returned products. */
2414
+ stock_id: number;
2415
+ /** @description Products list. */
2416
+ products: {
2417
+ /** @description Merchandise identifier. */
2418
+ id: number;
2419
+ /** @description Size identifier. */
2420
+ size: string;
2421
+ /** @description Code of outside system for product. */
2422
+ product_sizecode: string;
2423
+ /* @description Product quantity. */
2424
+ quantity: number;
2425
+ /* @description Price. */
2426
+ price: number;
2427
+ /* @description Net price. */
2428
+ price_net: number;
2429
+ /* @description Order value. */
2430
+ order_price: number;
2431
+ /* @description Net order worth. */
2432
+ order_price_net: number;
2433
+ /** @description Client's remarks on product. */
2434
+ remarks: string;
2435
+ /* @description Loyalty points. */
2436
+ points: number;
2437
+ /* @description Accrued loyalty points. */
2438
+ points_awarded: number;
2439
+ /** @description Product type. */
2440
+ product_type: string;
2441
+ serial_numbers: string[];
2442
+ /** @description Additional information. */
2443
+ product_order_additional: string;
2444
+ }[];
2445
+ /** @description Added on. */
2446
+ date_add: string;
2447
+ /** @description Ending date */
2448
+ date_end: string;
2449
+ /** @description Consignment number assigned to return. */
2450
+ package_number: string;
2451
+ /** @description Last modification date. */
2452
+ date_last_edit: string;
2453
+ /** @description Currency. */
2454
+ currency: string;
2455
+ /** @description Note to return used by IAI Bridge. */
2456
+ bridge_note: string;
2457
+ /** @description Shipping fee will be refunded to customer? */
2458
+ include_shipping_cost: string;
2459
+ /** @description Refund additional fee for the payment?. */
2460
+ additional_payment_cost: string;
2461
+ /* @description Cost for shop. */
2462
+ shop_shipping_cost: number;
2463
+ /** @description Return shipping number sent by the customer to the seller */
2464
+ incomingShippingNumber: string;
2465
+ /* @description Cost for shop - VAT rate */
2466
+ shop_shipping_cost_vat: number;
2467
+ /** @description Product return method. */
2468
+ return_method: string;
2469
+ /** @description Customer bank account number. */
2470
+ account_number: string;
2471
+ /** */
2472
+ preferedPaymentType: "customerBalance" | "bankTransfer" | "postal" | "cash";
2473
+ /** @description Return note. */
2474
+ userNote: string;
2475
+ /** @description Notes from customer. */
2476
+ clientNote: string;
2477
+ /** @description Information about prepayment for the order. */
2478
+ prepaids: {
2479
+ /** @description Order payment identifier. */
2480
+ prepaidId: number;
2481
+ /** @description Payment number for order. */
2482
+ paymentOrdinalNumber: number;
2483
+ /** @description Payment number - [order no.]-[payment no.], i.e. 1234-1. */
2484
+ paymentNumber: string;
2485
+ /** @description Date of payment addition. */
2486
+ paymentAddDate: string;
2487
+ /** @description Client's payment modification date. */
2488
+ paymentModifiedDateByClient: string;
2489
+ /** @description Payment modification date made by shop staff. */
2490
+ paymentModifiedDateByShop: string;
2491
+ /** @description Payment status. */
2492
+ paymentStatus: "pending" | "processed" | "cancelled";
2493
+ /** @description Preferred refund method. Types: `payment` - refund to customer for returned products, `repayment` - correction of refunded money */
2494
+ paymentType: "payment" | "advance" | "repayment" | "fee";
2495
+ /** @description Form of payment ID. */
2496
+ payformId: number;
2497
+ /** @description Name of payment form. */
2498
+ payformName: string;
2499
+ /** @description Account. */
2500
+ payformAccount: string;
2501
+ /* @description Payment amount. */
2502
+ paymentValue: number;
2503
+ /** @description Currency ID */
2504
+ currencyId: string;
2505
+ /** @description Number of voucher used in a payment. */
2506
+ voucherNumber: string;
2507
+ /** @description Number of gift card used in a payment. */
2508
+ giftCardNumber: string;
2509
+ }[];
2510
+ /** @description Shipping cost of the order */
2511
+ shippingCost: {
2512
+ /* @description Gross value. */
2513
+ gross: number;
2514
+ /* @description Net value. */
2515
+ net: number;
2516
+ /* @description VAT rate. */
2517
+ vat: number;
2518
+ };
2519
+ /** @description Additional costs for the payment of the order */
2520
+ additionalPaymentCostValue: {
2521
+ /* @description Gross value. */
2522
+ gross: number;
2523
+ /* @description Net value. */
2524
+ net: number;
2525
+ /* @description VAT rate. */
2526
+ vat: number;
2527
+ };
2528
+ }[];
2529
+ } & PagedSnakecaseResponse;
2530
+
2531
+ export type GetRmaResponse = {
2532
+ /** @description Complaints. */
2533
+ rmas: {
2534
+ /** @description Complaint id. */
2535
+ rmaId: number;
2536
+ /** @description Customer's login. */
2537
+ clientLogin: string;
2538
+ /** @description Customer ID */
2539
+ clientNumber: number;
2540
+ /** @description ID of the product which the complaint concers */
2541
+ productId: string;
2542
+ /** @description Product name. */
2543
+ productName: string;
2544
+ /** @description Current complaint status */
2545
+ rmaStatus: string;
2546
+ /** @description Complaint creation date in the YYYY-MM-DD format */
2547
+ creationDate: string;
2548
+ /** @description Complaint modification date in the YYYY-MM-DD format */
2549
+ modificationDate: string;
2550
+ /** @description Complaint closing date in the YYYY-MM-DD format */
2551
+ endDate: string;
2552
+ /** @description Reimbursement method */
2553
+ paymentReturnMethod: string;
2554
+ /** @description Bank account number or customer address used for reimbursement */
2555
+ paymentReturnDetails: string;
2556
+ /** @description Order source data. */
2557
+ orderSource: string;
2558
+ /** @description Message displayed for the customer */
2559
+ comments: string;
2560
+ /** @description Stock ID */
2561
+ stockId: number;
2562
+ /** @description Login of the user handling the complaint */
2563
+ operatorLogin: string;
2564
+ /** @description External auction number connected to the order which the complaint concerns */
2565
+ orderAuctionNumber: string;
2566
+ /** @description Order ID. */
2567
+ orderId: string;
2568
+ /** @description Place of making the order which the complaint concerns */
2569
+ orderPlace: string;
2570
+ /** @description Serial number of the product. */
2571
+ productSerialNumber: string;
2572
+ /** @description Description of the defect. New RMA module enables downloading a complaint description from chat. Parameter: rmaChat */
2573
+ rmaDescription: string;
2574
+ /** @description List of products */
2575
+ products: {
2576
+ /** @description Product id */
2577
+ id: number;
2578
+ /** @description Product size */
2579
+ size: string;
2580
+ /** @description Size code */
2581
+ productSizecode: string;
2582
+ /* @description Product quantity */
2583
+ quantity: number;
2584
+ /* @description Product price */
2585
+ price: number;
2586
+ /* @description Product net price */
2587
+ priceNet: number;
2588
+ /* @description Order price */
2589
+ orderPrice: number;
2590
+ /* @description Order price net */
2591
+ orderPriceNet: number;
2592
+ /* @description Points */
2593
+ points: number;
2594
+ /* @description Awarded points */
2595
+ pointsAwarded: number;
2596
+ /** @description Product types: `product_item` - single or multi variant product, `product_free` - free product, `product_packaging` - packaging, `product_bundle` - bundle, `product_collection` - collection, `product_service` - service, `product_virtual` - virtual, `product_configurable` - product with configurator */
2597
+ productType: string;
2598
+ /** @description Product serial numbers"1","2"] */
2599
+ serial_numbers: string[];
2600
+ /** @description Additional information */
2601
+ productOrderAdditional: string;
2602
+ /** @description List of attachments"1","2"] */
2603
+ attachments: string[];
2604
+ }[];
2605
+ /** @description Customer correspondence */
2606
+ rmaChat: {
2607
+ /** @description Message sender type. Available values: client - shop customer, panel - administration panel handling */
2608
+ messageAuthor: string;
2609
+ /** @description Message sender login */
2610
+ messageAuthorLogin: string;
2611
+ /** @description Message content */
2612
+ message: string;
2613
+ /** @description Date of adding a message in the YYYY-MM-DD hh:mm:ss format */
2614
+ messageAddTime: string;
2615
+ }[];
2616
+ /** @description Information on error that occurred during gate call. */
2617
+ errors: FaultCodeString
2618
+ }[];
2619
+ /** @description Flag marking errors in the result. */
2620
+ isErrors: boolean;
2621
+ } & PagedResponse;
2622
+
2623
+ export type GetConfigResponse = {
2624
+ /** @description Customers ID */
2625
+ client_id: number;
2626
+ /** @description Dedicated server. */
2627
+ dedicated_server: boolean;
2628
+ shop_owner_data: {
2629
+ /** @description Full company name. */
2630
+ company_name: string;
2631
+ /** @description Company short name. */
2632
+ company_short_name: string;
2633
+ /** @description NIP [TIN]. */
2634
+ nip: string;
2635
+ /** @description CRN. */
2636
+ regon: string;
2637
+ /** @description no of entry to NCR. */
2638
+ krs: string;
2639
+ /** @description Address. */
2640
+ address: string;
2641
+ /** @description Customer's postal code. */
2642
+ zipcode: string;
2643
+ /** @description Town / City. */
2644
+ city: string;
2645
+ /** @description region. */
2646
+ country: string;
2647
+ /** @description VAT registered. */
2648
+ VATRegistered: boolean;
2649
+ };
2650
+ /** @description List of languages configured in the administration panel. */
2651
+ languages: {
2652
+ /** @description Language code. Codes are compliant with ISO-639-3 standard. */
2653
+ lang_id: string;
2654
+ /** @description Language name. */
2655
+ lang_name: string;
2656
+ }[];
2657
+ /** @description Code of default panel language in ISO-639-3 standard. */
2658
+ panel_lang_id_default: string;
2659
+ /** @description Panel base currency ID. */
2660
+ panel_basecurrency_id: string;
2661
+ panel_settings: {
2662
+ /** @description Default panel language. */
2663
+ default_lang_id: string;
2664
+ /** @description Panel base currency. */
2665
+ basecurrency_id: string;
2666
+ /** @description Manual stock quantity modification restriction. */
2667
+ stocks_change_disabled: string;
2668
+ /** */
2669
+ stock_state_config: "uncontrolled" | "bridge" | "outside";
2670
+ /** */
2671
+ main_stock_system: "other" | "iai";
2672
+ search_by_code: {
2673
+ /** @description IAI code. */
2674
+ code_iai: boolean;
2675
+ /** @description External system code. */
2676
+ code_extern: boolean;
2677
+ /** @description Producer code. */
2678
+ code_producer: boolean;
2679
+ };
2680
+ /** @description Fiscal and settlement settings */
2681
+ taxSettings: {
2682
+ /** @description Sales date settings on sales documents for prepaid orders */
2683
+ saleDatePrepaid: "saleDateFromOrder" | "saleDateFromPayment" | "saleDateFromDocument";
2684
+ /** @description Sales date settings on sales documents for orders paid with cash on delivery */
2685
+ saleDateCashOnDelivery: "saleDateFromOrder" | "saleDateFromPayment" | "saleDateFromDocument";
2686
+ /** @description Sales date settings on sales documents for orders paid with trade credit */
2687
+ saleDateTradeCredit: "saleDateFromOrder" | "saleDateFromPayment" | "saleDateFromDocument";
2688
+ /** @description Configuration of default currency rate for orders */
2689
+ currencyRate: "currentDay" | "previousDay";
2690
+ };
2691
+ };
2692
+ panel_literals: {
2693
+ /** @description "Reduced price" - name in the panel. */
2694
+ promotion: string;
2695
+ /** @description "Sale" - name in panel. */
2696
+ discount: string;
2697
+ /** @description "Distinguished product" - name in panel. */
2698
+ distinguished: string;
2699
+ /** @description "Warranty" - name in shop. */
2700
+ warranty: string;
2701
+ };
2702
+ /** @description List of warehouses. */
2703
+ stocks: {
2704
+ /** @description Stock ID. */
2705
+ stock_id: number;
2706
+ /** @description Stock name. */
2707
+ stock_name: string;
2708
+ }[];
2709
+ /** @description List of stores. */
2710
+ shops: {
2711
+ /** @description Shop Id */
2712
+ shop_id: number;
2713
+ /** @description Store name. */
2714
+ shop_name: string;
2715
+ /** @description Default shop language ID in ISO-639-3 standard. */
2716
+ shop_lang_id_default: string;
2717
+ /** @description Determines whether loyalty program is active. */
2718
+ shop_loyalty_active: boolean;
2719
+ active_price_comparers: {
2720
+ /** @description Id */
2721
+ id: number;
2722
+ /* @description Default price difference. */
2723
+ default_price_percent_diff: number;
2724
+ }[];
2725
+ /** @description Url to default product icon. */
2726
+ default_icon_url: string;
2727
+ branch_document_data: {
2728
+ /** @description Full company name. */
2729
+ company_name: string;
2730
+ /** @description Company short name. */
2731
+ company_short_name: string;
2732
+ /** @description NIP [TIN]. */
2733
+ nip: string;
2734
+ /** @description CRN. */
2735
+ regon: string;
2736
+ /** @description no of entry to NCR. */
2737
+ krs: string;
2738
+ /** @description Address. */
2739
+ address: string;
2740
+ /** @description Customer's postal code. */
2741
+ zipcode: string;
2742
+ /** @description Town / City. */
2743
+ city: string;
2744
+ /** @description region. */
2745
+ country: string;
2746
+ };
2747
+ active_client_order_edit_status: string[];
2748
+ /** @description Auction site currency ID. */
2749
+ currency_id: string;
2750
+ client_edit_require_fields: {
2751
+ /** @description Is providing a value required for the field. */
2752
+ lastname: boolean;
2753
+ /** @description Is providing a value required for the field. */
2754
+ email: boolean;
2755
+ /** @description Is providing a value required for the field. */
2756
+ phone: boolean;
2757
+ /** @description Is providing a value required for the field. */
2758
+ vat_number: boolean;
2759
+ };
2760
+ /** @description Defines how to include complimentary products on VAT invoices and receipts. */
2761
+ product_free_invoices: string;
2762
+ /** @description Does the store have active vouchers?. */
2763
+ vouchers: {
2764
+ /** @description Information about whether price comparison service is active. */
2765
+ active: boolean;
2766
+ };
2767
+ /** @description Does the store have active gift cards?. */
2768
+ giftCards: {
2769
+ /** @description Information about whether price comparison service is active. */
2770
+ active: boolean;
2771
+ };
2772
+ defaultConfigReturns: {
2773
+ /** @description Refund a shipping fee? */
2774
+ defaultIncludeShippingCost: string;
2775
+ /** @description How to proceed with a refund.Available values:"fullOnFirstReturn" - refund all at the first refund,"proportionalToProductQuantity" - refund proportionally to a number of products in an original order,"fullOnAllProductsReturn" - refund at the return of a whole order. */
2776
+ methodReturnShippingCost: "fullOnFirstReturn" | "proportionalToProductQuantity" | "fullOnAllProductsReturn";
2777
+ /** @description Refund.Available values:"shipping" - delivery cost calculated for a primary order,"positive_min_shipping" - the lowest amount of delivery costs available at the moment of placing an order for the selected delivery method (more than zero but less than actual cost charged),"min_shipping" - absolute the lowest delivery cost available at the moment of placing an order for the selected delivery method (for free shipping it is zero). */
2778
+ defaultIncludeShippingCostValue: "shipping" | "positive_min_shipping" | "min_shipping";
2779
+ /** @description Refund a surcharge for a payment method used in an order? */
2780
+ defaultAdditionalPaymentCost: string;
2781
+ };
2782
+ /** @description Sales documents in third party application. */
2783
+ salesDocumentsAreCreatedByClient: boolean;
2784
+ }[];
2785
+ /** @description List of size units. */
2786
+ units: {
2787
+ /** @description Unit of measure ID. */
2788
+ unit_id: number;
2789
+ /** @description Unit of measure name in panel. */
2790
+ unit_name: string;
2791
+ /** @description Accuracy (number of places after comma). */
2792
+ unit_precision: number;
2793
+ /** @description Object determines unit visibility in panel.List of values:"y" - unit visible in panel,"n" - unit invisible in panel. */
2794
+ unit_visible: string;
2795
+ lang_data: {
2796
+ /** @description Language code. Codes are compliant with ISO-639-3 standard. */
2797
+ lang_id: string;
2798
+ /** @description Name (singular). */
2799
+ singular_name: string;
2800
+ /** @description Name (plural). */
2801
+ plural_name: string;
2802
+ /** @description Name (by fractions). */
2803
+ fraction_name: string;
2804
+ }[];
2805
+ }[];
2806
+ /** @description List of warranties. */
2807
+ warranties: {
2808
+ /** @description Id */
2809
+ id: number;
2810
+ /** @description Name */
2811
+ name: string;
2812
+ }[];
2813
+ /** @description List of parcel delivery companies. */
2814
+ deliverers: {
2815
+ /** @description Id */
2816
+ id: number;
2817
+ /** @description Name */
2818
+ name: string;
2819
+ }[];
2820
+ product_deliverers: {
2821
+ /** @description Id */
2822
+ id: number;
2823
+ /** @description Name */
2824
+ name: string;
2825
+ }[];
2826
+ vat_rates: {
2827
+ /** @description Id */
2828
+ id: number;
2829
+ /* @description VAT rate value. */
2830
+ value: number;
2831
+ }[];
2832
+ auction_systems: {
2833
+ /** @description Auction system ID. */
2834
+ auction_id: number;
2835
+ /** @description Auction site ID. */
2836
+ site_id: number;
2837
+ /** @description Auction site currency ID. */
2838
+ currency_id: string;
2839
+ /** @description Auction site description. */
2840
+ description: string;
2841
+ }[];
2842
+ availability_profiles: {
2843
+ /** @description Id */
2844
+ id: number;
2845
+ /** @description Name */
2846
+ name: string;
2847
+ }[];
2848
+ rebate_profiles: {
2849
+ /** @description Id */
2850
+ id: number;
2851
+ /** @description Name */
2852
+ name: string;
2853
+ }[];
2854
+ pictures_settings: {
2855
+ /** @description Object determines if the product icon should be scaled.List of values:"y" - icon is scaled,"n" - icon is unscaled. */
2856
+ icon_resize: string;
2857
+ /** @description Graphic quality in percent (0-100). ."0" - the worst quality,"100" - the best quality (no compression). */
2858
+ icon_quality: number;
2859
+ /** @description Large icon width in pixels. */
2860
+ icon_large_width: number;
2861
+ /** @description Large icon height in pixels. */
2862
+ icon_large_height: number;
2863
+ /** @description Small icon width in pixels. */
2864
+ icon_small_width: number;
2865
+ /** @description Small icon height in pixels. */
2866
+ icon_small_height: number;
2867
+ /** @description Width of an icon on the marketplaces. */
2868
+ auction_icon_height: number;
2869
+ /** @description Hight of an icon on the marketplaces. */
2870
+ auction_icon_width: number;
2871
+ /** @description Group icon width in pixels. */
2872
+ group_icon_height: number;
2873
+ /** @description Group icon height in pixels. */
2874
+ group_icon_width: number;
2875
+ /** @description Photo quality in percents (0-100)."0" - the worst quality,"100" - the best quality (no compression). */
2876
+ picture_quality: number;
2877
+ /** @description Large photo width in pixels. */
2878
+ picture_large_width: number;
2879
+ /** @description Large photo height in pixels. */
2880
+ picture_large_height: number;
2881
+ /** @description Medium photo width in pixels. */
2882
+ picture_medium_width: number;
2883
+ /** @description Medium photo height in pixels. */
2884
+ picture_medium_height: number;
2885
+ /** @description Small photo width in pixels. */
2886
+ picture_small_width: number;
2887
+ /** @description Small photo height in pixels. */
2888
+ picture_small_height: number;
2889
+ };
2890
+ price_comparers: {
2891
+ /** @description Id */
2892
+ id: number;
2893
+ /** @description key */
2894
+ key: string;
2895
+ /** @description Name */
2896
+ name: string;
2897
+ /** @description Information about whether price comparison service is active. */
2898
+ active: string;
2899
+ }[];
2900
+ /** @description Content of the column "Product or service name" on sales documents. */
2901
+ inv_prod_name_templace: string;
2902
+ /** @description List of document printers. */
2903
+ printers: {
2904
+ /** @description Id */
2905
+ id: number;
2906
+ /** @description Name */
2907
+ name: string;
2908
+ /** @description Address. */
2909
+ address: string;
2910
+ /** @description key */
2911
+ key: string;
2912
+ }[];
2913
+ /** @description List of fiscal printers. */
2914
+ fiscal_printers: {
2915
+ /** @description Id */
2916
+ id: number;
2917
+ /** @description Name */
2918
+ name: string;
2919
+ /** @description Address. */
2920
+ address: string;
2921
+ /** @description key */
2922
+ key: string;
2923
+ }[];
2924
+ /** @description Monitoring address protocol from the main Printer window. */
2925
+ typeOfPrinterProtocolAdress: string;
2926
+ };
2927
+
2928
+ export { }