idosell 0.0.1

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 (536) hide show
  1. package/dist/gates.def.js +3520 -0
  2. package/dist/gates.js +553 -0
  3. package/dist/helpers.js +204 -0
  4. package/dist/index.js +17 -0
  5. package/dist/methods/deleteClientsDeliveryAddress.js +11 -0
  6. package/dist/methods/deleteClientsGiftcards.js +11 -0
  7. package/dist/methods/deleteClientsPayerAddress.js +11 -0
  8. package/dist/methods/deleteClientsPricelists.js +6 -0
  9. package/dist/methods/deleteClientsTags.js +12 -0
  10. package/dist/methods/deleteClientsTagsClear.js +6 -0
  11. package/dist/methods/deleteCouriersPickupPoints.js +11 -0
  12. package/dist/methods/deleteDiscountsGroups.js +6 -0
  13. package/dist/methods/deleteDiscountsGroupsProducts.js +6 -0
  14. package/dist/methods/deleteDiscountsRebatesCard.js +7 -0
  15. package/dist/methods/deleteDiscountsRebatesCode.js +7 -0
  16. package/dist/methods/deleteEntries.js +6 -0
  17. package/dist/methods/deleteMenu.js +12 -0
  18. package/dist/methods/deleteOrdersDocuments.js +11 -0
  19. package/dist/methods/deleteOrdersImages.js +11 -0
  20. package/dist/methods/deleteProducts.js +11 -0
  21. package/dist/methods/deleteProductsBrands.js +6 -0
  22. package/dist/methods/deleteProductsBundlesProducts.js +12 -0
  23. package/dist/methods/deleteProductsCollectionsProducts.js +12 -0
  24. package/dist/methods/deleteProductsImages.js +12 -0
  25. package/dist/methods/deleteProductsOpinions.js +6 -0
  26. package/dist/methods/deleteProductsOpinionsOpinions.js +6 -0
  27. package/dist/methods/deleteProductsParameters.js +6 -0
  28. package/dist/methods/deleteProductsProductsToFacebookCatalog.js +6 -0
  29. package/dist/methods/deleteProductsProductsToPromotion.js +6 -0
  30. package/dist/methods/deleteProductsSeries.js +6 -0
  31. package/dist/methods/deleteProductsSizes.js +12 -0
  32. package/dist/methods/deleteSizecharts.js +6 -0
  33. package/dist/methods/deleteVouchers.js +11 -0
  34. package/dist/methods/deleteWarranties.js +6 -0
  35. package/dist/methods/deleteWmsStocksdocumentsDocuments.js +6 -0
  36. package/dist/methods/deleteWmsStocksdocumentsProducts.js +11 -0
  37. package/dist/methods/deleteWmsSuppliers.js +6 -0
  38. package/dist/methods/deleteWmsSuppliersSuppliers.js +6 -0
  39. package/dist/methods/getClients.js +12 -0
  40. package/dist/methods/getClientsBalance.js +12 -0
  41. package/dist/methods/getClientsCrm.js +13 -0
  42. package/dist/methods/getClientsDeliveryAddress.js +6 -0
  43. package/dist/methods/getClientsGiftcards.js +12 -0
  44. package/dist/methods/getClientsGiftcardsTypes.js +10 -0
  45. package/dist/methods/getClientsMembershipCards.js +6 -0
  46. package/dist/methods/getClientsNewsletterEmailSMS.js +12 -0
  47. package/dist/methods/getClientsNewsletterEmailShops.js +12 -0
  48. package/dist/methods/getClientsPayerAddress.js +10 -0
  49. package/dist/methods/getClientsPricelists.js +10 -0
  50. package/dist/methods/getClientsPricelistsClients.js +6 -0
  51. package/dist/methods/getClientsPricelistsProducts.js +10 -0
  52. package/dist/methods/getClientsPricesActiveCard.js +6 -0
  53. package/dist/methods/getClientsPricesDiscountGroups.js +10 -0
  54. package/dist/methods/getClientsPricesDiscounts.js +11 -0
  55. package/dist/methods/getClientsProfitPoints.js +11 -0
  56. package/dist/methods/getClientsProvinceList.js +6 -0
  57. package/dist/methods/getClientsTags.js +6 -0
  58. package/dist/methods/getCouriers.js +10 -0
  59. package/dist/methods/getCouriersAssignedToShippingProfiles.js +6 -0
  60. package/dist/methods/getCouriersPickupPoints.js +10 -0
  61. package/dist/methods/getDeliveriesProfiles.js +10 -0
  62. package/dist/methods/getDeliveriesRegions.js +6 -0
  63. package/dist/methods/getDiscountsGroups.js +11 -0
  64. package/dist/methods/getDiscountsGroupsClients.js +6 -0
  65. package/dist/methods/getEntries.js +6 -0
  66. package/dist/methods/getEntriesPagesToDisplay.js +6 -0
  67. package/dist/methods/getMenu.js +6 -0
  68. package/dist/methods/getMenuFilter.js +6 -0
  69. package/dist/methods/getOrders.js +6 -0
  70. package/dist/methods/getOrdersAnalytics.js +10 -0
  71. package/dist/methods/getOrdersAuctionDetails.js +11 -0
  72. package/dist/methods/getOrdersDocuments.js +6 -0
  73. package/dist/methods/getOrdersExportdocumentsEPP.js +10 -0
  74. package/dist/methods/getOrdersExportdocumentsJPK.js +10 -0
  75. package/dist/methods/getOrdersHandler.js +6 -0
  76. package/dist/methods/getOrdersHistory.js +6 -0
  77. package/dist/methods/getOrdersImages.js +6 -0
  78. package/dist/methods/getOrdersLabels.js +6 -0
  79. package/dist/methods/getOrdersOpinions.js +17 -0
  80. package/dist/methods/getOrdersOpinionsRate.js +6 -0
  81. package/dist/methods/getOrdersPackages.js +6 -0
  82. package/dist/methods/getOrdersPrinterDocuments.js +6 -0
  83. package/dist/methods/getOrdersProfitability.js +6 -0
  84. package/dist/methods/getOrdersWarehouse.js +6 -0
  85. package/dist/methods/getPackages.js +11 -0
  86. package/dist/methods/getPackagesLabels.js +6 -0
  87. package/dist/methods/getPayments.js +6 -0
  88. package/dist/methods/getPaymentsForms.js +6 -0
  89. package/dist/methods/getPaymentsProfiles.js +10 -0
  90. package/dist/methods/getProducts.js +6 -0
  91. package/dist/methods/getProductsAuctions.js +11 -0
  92. package/dist/methods/getProductsBrands.js +11 -0
  93. package/dist/methods/getProductsBrandsFilter.js +6 -0
  94. package/dist/methods/getProductsCategories.js +11 -0
  95. package/dist/methods/getProductsCategoriesIdosell.js +11 -0
  96. package/dist/methods/getProductsCodeExistence.js +13 -0
  97. package/dist/methods/getProductsDeliveryTime.js +6 -0
  98. package/dist/methods/getProductsDescriptions.js +6 -0
  99. package/dist/methods/getProductsIdBySizecode.js +6 -0
  100. package/dist/methods/getProductsMarketingAllFacebookCatalogIds.js +6 -0
  101. package/dist/methods/getProductsMarketingPromotion.js +6 -0
  102. package/dist/methods/getProductsMarketingZones.js +12 -0
  103. package/dist/methods/getProductsOmnibusPrices.js +12 -0
  104. package/dist/methods/getProductsOpinions.js +12 -0
  105. package/dist/methods/getProductsOpinionsOpinions.js +6 -0
  106. package/dist/methods/getProductsOpinionsRate.js +6 -0
  107. package/dist/methods/getProductsParameters.js +10 -0
  108. package/dist/methods/getProductsProductsToFacebookCatalog.js +6 -0
  109. package/dist/methods/getProductsQuestions.js +6 -0
  110. package/dist/methods/getProductsReservations.js +12 -0
  111. package/dist/methods/getProductsSKUbyBarcode.js +6 -0
  112. package/dist/methods/getProductsSeries.js +10 -0
  113. package/dist/methods/getProductsSeriesFilter.js +6 -0
  114. package/dist/methods/getProductsSizes.js +9 -0
  115. package/dist/methods/getProductsStocks.js +12 -0
  116. package/dist/methods/getProductsStrikethroughPrices.js +12 -0
  117. package/dist/methods/getRefundsGetPossibleAutoRefunds.js +6 -0
  118. package/dist/methods/getRefundsGetRefundStatus.js +6 -0
  119. package/dist/methods/getRefundsRetrieveRefundsList.js +10 -0
  120. package/dist/methods/getReturns.js +12 -0
  121. package/dist/methods/getReturnsStatuses.js +6 -0
  122. package/dist/methods/getRma.js +13 -0
  123. package/dist/methods/getRmaStatuses.js +6 -0
  124. package/dist/methods/getSizecharts.js +10 -0
  125. package/dist/methods/getSizes.js +6 -0
  126. package/dist/methods/getSystemConfig.js +6 -0
  127. package/dist/methods/getSystemCurrencies.js +10 -0
  128. package/dist/methods/getSystemProcessesAutomation.js +6 -0
  129. package/dist/methods/getSystemServerLoad.js +6 -0
  130. package/dist/methods/getSystemServerTime.js +6 -0
  131. package/dist/methods/getSystemShopsData.js +6 -0
  132. package/dist/methods/getSystemUnits.js +6 -0
  133. package/dist/methods/getSystemUsers.js +6 -0
  134. package/dist/methods/getVouchers.js +15 -0
  135. package/dist/methods/getVouchersTypes.js +10 -0
  136. package/dist/methods/getWarranties.js +11 -0
  137. package/dist/methods/getWarrantiesCountTotal.js +6 -0
  138. package/dist/methods/getWmsLocations.js +10 -0
  139. package/dist/methods/getWmsStocksdocumentsDocuments.js +11 -0
  140. package/dist/methods/getWmsStocksdocumentsOpenedDocuments.js +11 -0
  141. package/dist/methods/getWmsStocksdocumentsProducts.js +11 -0
  142. package/dist/methods/getWmsSuppliers.js +10 -0
  143. package/dist/methods/getWmsSuppliersSuppliers.js +6 -0
  144. package/dist/methods/listOrders.js +22 -0
  145. package/dist/methods/listOrdersUnfinished.js +17 -0
  146. package/dist/methods/listProducts.js +25 -0
  147. package/dist/methods/postClients.js +11 -0
  148. package/dist/methods/postClientsBalance.js +10 -0
  149. package/dist/methods/postClientsDeliveryAddress.js +11 -0
  150. package/dist/methods/postClientsGiftcards.js +11 -0
  151. package/dist/methods/postClientsPayerAddress.js +11 -0
  152. package/dist/methods/postClientsPricelists.js +6 -0
  153. package/dist/methods/postClientsProfitPoints.js +6 -0
  154. package/dist/methods/postClientsTags.js +12 -0
  155. package/dist/methods/postCouriersPickupPoints.js +11 -0
  156. package/dist/methods/postDeliveriesRegions.js +6 -0
  157. package/dist/methods/postDiscountsGroups.js +6 -0
  158. package/dist/methods/postDiscountsRebatesCard.js +7 -0
  159. package/dist/methods/postDiscountsRebatesCode.js +7 -0
  160. package/dist/methods/postEntries.js +11 -0
  161. package/dist/methods/postMenu.js +12 -0
  162. package/dist/methods/postOrders.js +11 -0
  163. package/dist/methods/postOrdersDocuments.js +11 -0
  164. package/dist/methods/postOrdersImages.js +11 -0
  165. package/dist/methods/postOrdersPackages.js +11 -0
  166. package/dist/methods/postPackages.js +11 -0
  167. package/dist/methods/postPackagesLabels.js +11 -0
  168. package/dist/methods/postPayments.js +6 -0
  169. package/dist/methods/postPaymentsCancel.js +6 -0
  170. package/dist/methods/postPaymentsCashback.js +6 -0
  171. package/dist/methods/postPaymentsRepayment.js +6 -0
  172. package/dist/methods/postProducts.js +11 -0
  173. package/dist/methods/postProductsBrands.js +11 -0
  174. package/dist/methods/postProductsBundles.js +12 -0
  175. package/dist/methods/postProductsBundlesBundles.js +6 -0
  176. package/dist/methods/postProductsBundlesProducts.js +12 -0
  177. package/dist/methods/postProductsCollections.js +12 -0
  178. package/dist/methods/postProductsCollectionsProducts.js +12 -0
  179. package/dist/methods/postProductsMarketingPromotion.js +11 -0
  180. package/dist/methods/postProductsOpinions.js +11 -0
  181. package/dist/methods/postProductsOpinionsOpinions.js +6 -0
  182. package/dist/methods/postProductsProductsToFacebookCatalog.js +6 -0
  183. package/dist/methods/postProductsProductsToPromotion.js +6 -0
  184. package/dist/methods/postProductsRestore.js +7 -0
  185. package/dist/methods/postProductsSynchronizationFile.js +6 -0
  186. package/dist/methods/postRefundsAddAutomaticRefund.js +6 -0
  187. package/dist/methods/postRefundsAddAutomaticRefundForOrder.js +6 -0
  188. package/dist/methods/postRefundsAddManualRefund.js +6 -0
  189. package/dist/methods/postVouchers.js +11 -0
  190. package/dist/methods/postWarranties.js +11 -0
  191. package/dist/methods/postWmsStocksdocumentsDocuments.js +6 -0
  192. package/dist/methods/postWmsStocksdocumentsProducts.js +11 -0
  193. package/dist/methods/putClients.js +11 -0
  194. package/dist/methods/putClientsDeliveryAddress.js +11 -0
  195. package/dist/methods/putClientsExternalCode.js +6 -0
  196. package/dist/methods/putClientsGiftcards.js +11 -0
  197. package/dist/methods/putClientsGiftcardsBlock.js +11 -0
  198. package/dist/methods/putClientsGiftcardsUnblock.js +11 -0
  199. package/dist/methods/putClientsMembershipCards.js +11 -0
  200. package/dist/methods/putClientsPayerAddress.js +11 -0
  201. package/dist/methods/putClientsPricelists.js +6 -0
  202. package/dist/methods/putClientsPricelistsClients.js +6 -0
  203. package/dist/methods/putClientsPricelistsProducts.js +6 -0
  204. package/dist/methods/putClientsPricelistsRename.js +6 -0
  205. package/dist/methods/putClientsPricesDiscounts.js +11 -0
  206. package/dist/methods/putClientsTags.js +11 -0
  207. package/dist/methods/putCouriersPickupPoints.js +11 -0
  208. package/dist/methods/putDeliveriesDefaultProfiles.js +6 -0
  209. package/dist/methods/putDiscountsGroups.js +6 -0
  210. package/dist/methods/putDiscountsGroupsProducts.js +6 -0
  211. package/dist/methods/putDiscountsRebatesBlockCard.js +7 -0
  212. package/dist/methods/putDiscountsRebatesUnblockCard.js +7 -0
  213. package/dist/methods/putEntries.js +6 -0
  214. package/dist/methods/putMenu.js +12 -0
  215. package/dist/methods/putMenuFilter.js +11 -0
  216. package/dist/methods/putMenuSort.js +12 -0
  217. package/dist/methods/putOrders.js +11 -0
  218. package/dist/methods/putOrdersClient.js +6 -0
  219. package/dist/methods/putOrdersCourier.js +6 -0
  220. package/dist/methods/putOrdersDeliveryAddress.js +6 -0
  221. package/dist/methods/putOrdersDevide.js +11 -0
  222. package/dist/methods/putOrdersHandler.js +6 -0
  223. package/dist/methods/putOrdersPackages.js +11 -0
  224. package/dist/methods/putOrdersPickupPoint.js +6 -0
  225. package/dist/methods/putOrdersProductsSerialNumbers.js +11 -0
  226. package/dist/methods/putOrdersProfitMargin.js +11 -0
  227. package/dist/methods/putOrdersShippingCosts.js +6 -0
  228. package/dist/methods/putOrdersWarehouse.js +6 -0
  229. package/dist/methods/putPackages.js +11 -0
  230. package/dist/methods/putPayments.js +6 -0
  231. package/dist/methods/putPaymentsConfirm.js +6 -0
  232. package/dist/methods/putProducts.js +15 -0
  233. package/dist/methods/putProductsAttachments.js +11 -0
  234. package/dist/methods/putProductsBrands.js +11 -0
  235. package/dist/methods/putProductsBrandsFilter.js +11 -0
  236. package/dist/methods/putProductsBundlesProductsQuantity.js +12 -0
  237. package/dist/methods/putProductsBundlesRenew.js +12 -0
  238. package/dist/methods/putProductsCategories.js +11 -0
  239. package/dist/methods/putProductsCollectionsProducts.js +12 -0
  240. package/dist/methods/putProductsCollectionsRenew.js +12 -0
  241. package/dist/methods/putProductsDescriptions.js +11 -0
  242. package/dist/methods/putProductsGroupsMainProduct.js +11 -0
  243. package/dist/methods/putProductsGroupsOrder.js +11 -0
  244. package/dist/methods/putProductsGroupsSettings.js +11 -0
  245. package/dist/methods/putProductsImages.js +11 -0
  246. package/dist/methods/putProductsMarketingPromotion.js +11 -0
  247. package/dist/methods/putProductsMarketingZones.js +11 -0
  248. package/dist/methods/putProductsOmnibusPrices.js +11 -0
  249. package/dist/methods/putProductsOpinions.js +6 -0
  250. package/dist/methods/putProductsOpinionsOpinions.js +6 -0
  251. package/dist/methods/putProductsParameters.js +12 -0
  252. package/dist/methods/putProductsQuestions.js +11 -0
  253. package/dist/methods/putProductsSeries.js +11 -0
  254. package/dist/methods/putProductsSeriesFilter.js +11 -0
  255. package/dist/methods/putProductsSizes.js +12 -0
  256. package/dist/methods/putProductsStockQuantity.js +11 -0
  257. package/dist/methods/putProductsStocks.js +11 -0
  258. package/dist/methods/putProductsStrikethroughPrices.js +11 -0
  259. package/dist/methods/putProductsSupplierCode.js +11 -0
  260. package/dist/methods/putProductsSupplierProductData.js +11 -0
  261. package/dist/methods/putProductsSynchronizationFinishUpload.js +6 -0
  262. package/dist/methods/putRefundsCancelRefund.js +6 -0
  263. package/dist/methods/putRefundsConfirmRefund.js +6 -0
  264. package/dist/methods/putRefundsUpdateRefund.js +6 -0
  265. package/dist/methods/putReturns.js +11 -0
  266. package/dist/methods/putReturnsSerialNumber.js +11 -0
  267. package/dist/methods/putRma.js +11 -0
  268. package/dist/methods/putSizecharts.js +11 -0
  269. package/dist/methods/putSizes.js +11 -0
  270. package/dist/methods/putSystemConfig.js +6 -0
  271. package/dist/methods/putSystemCurrencies.js +12 -0
  272. package/dist/methods/putSystemProcessesAutomation.js +6 -0
  273. package/dist/methods/putSystemUnits.js +11 -0
  274. package/dist/methods/putVouchers.js +11 -0
  275. package/dist/methods/putVouchersBlock.js +11 -0
  276. package/dist/methods/putVouchersUnblock.js +11 -0
  277. package/dist/methods/putWarranties.js +11 -0
  278. package/dist/methods/putWarrantiesLanguageData.js +11 -0
  279. package/dist/methods/putWmsStocksdocumentsAcceptMM.js +6 -0
  280. package/dist/methods/putWmsStocksdocumentsClose.js +6 -0
  281. package/dist/methods/putWmsStocksdocumentsDocuments.js +6 -0
  282. package/dist/methods/putWmsStocksdocumentsProducts.js +11 -0
  283. package/dist/methods/putWmsStocksdocumentsRejectMM.js +6 -0
  284. package/dist/methods/putWmsSuppliers.js +11 -0
  285. package/dist/methods/putWmsSuppliersSuppliers.js +6 -0
  286. package/dist/params.js +42 -0
  287. package/dist/request.js +68 -0
  288. package/package.json +28 -0
  289. package/readme.md +314 -0
  290. package/tests/deleteClientsDeliveryAddress.test.js +7 -0
  291. package/tests/deleteClientsGiftcards.test.js +7 -0
  292. package/tests/deleteClientsPayerAddress.test.js +7 -0
  293. package/tests/deleteClientsPricelists.test.js +7 -0
  294. package/tests/deleteClientsTags.test.js +7 -0
  295. package/tests/deleteClientsTagsClear.test.js +7 -0
  296. package/tests/deleteCouriersPickupPoints.test.js +7 -0
  297. package/tests/deleteDiscountsGroups.test.js +7 -0
  298. package/tests/deleteDiscountsGroupsProducts.test.js +7 -0
  299. package/tests/deleteDiscountsRebatesCard.test.js +7 -0
  300. package/tests/deleteDiscountsRebatesCode.test.js +7 -0
  301. package/tests/deleteEntries.test.js +7 -0
  302. package/tests/deleteMenu.test.js +7 -0
  303. package/tests/deleteOrdersDocuments.test.js +7 -0
  304. package/tests/deleteOrdersImages.test.js +7 -0
  305. package/tests/deleteProducts.test.js +7 -0
  306. package/tests/deleteProductsBrands.test.js +7 -0
  307. package/tests/deleteProductsCollectionsProducts.test.js +7 -0
  308. package/tests/deleteProductsImages.test.js +7 -0
  309. package/tests/deleteProductsOpinions.test.js +7 -0
  310. package/tests/deleteProductsParameters.test.js +7 -0
  311. package/tests/deleteProductsProductsToFacebookCatalog.test.js +7 -0
  312. package/tests/deleteProductsProductsToPromotion.test.js +7 -0
  313. package/tests/deleteProductsSeries.test.js +7 -0
  314. package/tests/deleteProductsSizes.test.js +7 -0
  315. package/tests/deleteSizecharts.test.js +7 -0
  316. package/tests/deleteVouchers.test.js +7 -0
  317. package/tests/deleteWarranties.test.js +7 -0
  318. package/tests/deleteWmsStocksdocumentsDocuments.test.js +7 -0
  319. package/tests/deleteWmsStocksdocumentsProducts.test.js +12 -0
  320. package/tests/deleteWmsSuppliers.test.js +7 -0
  321. package/tests/getClients.test.js +22 -0
  322. package/tests/getClientsBalance.test.js +22 -0
  323. package/tests/getClientsCrm.test.js +22 -0
  324. package/tests/getClientsDeliveryAddress.test.js +7 -0
  325. package/tests/getClientsGiftcards.test.js +7 -0
  326. package/tests/getClientsGiftcardsTypes.test.js +7 -0
  327. package/tests/getClientsMembershipCards.test.js +7 -0
  328. package/tests/getClientsNewsletterEmailSMS.test.js +17 -0
  329. package/tests/getClientsNewsletterEmailShops.test.js +12 -0
  330. package/tests/getClientsPayerAddress.test.js +12 -0
  331. package/tests/getClientsPricelists.test.js +12 -0
  332. package/tests/getClientsPricelistsClients.test.js +7 -0
  333. package/tests/getClientsPricelistsProducts.test.js +12 -0
  334. package/tests/getClientsPricesDiscountGroups.test.js +12 -0
  335. package/tests/getClientsPricesDiscounts.test.js +27 -0
  336. package/tests/getClientsProfitPoints.test.js +17 -0
  337. package/tests/getClientsProvinceList.test.js +7 -0
  338. package/tests/getClientsTags.test.js +7 -0
  339. package/tests/getCouriers.test.js +12 -0
  340. package/tests/getCouriersPickupPoints.test.js +17 -0
  341. package/tests/getDeliveriesProfiles.test.js +7 -0
  342. package/tests/getDeliveriesRegions.test.js +7 -0
  343. package/tests/getDiscountsGroups.test.js +12 -0
  344. package/tests/getDiscountsGroupsClients.test.js +7 -0
  345. package/tests/getEntries.test.js +12 -0
  346. package/tests/getEntriesPagesToDisplay.test.js +7 -0
  347. package/tests/getMenu.test.js +7 -0
  348. package/tests/getMenuFilter.test.js +7 -0
  349. package/tests/getOrders.test.js +7 -0
  350. package/tests/getOrdersAnalytics.test.js +7 -0
  351. package/tests/getOrdersAuctionDetails.test.js +7 -0
  352. package/tests/getOrdersDocuments.test.js +7 -0
  353. package/tests/getOrdersExportdocumentsEPP.test.js +22 -0
  354. package/tests/getOrdersExportdocumentsJPK.test.js +17 -0
  355. package/tests/getOrdersHandler.test.js +7 -0
  356. package/tests/getOrdersHistory.test.js +7 -0
  357. package/tests/getOrdersImages.test.js +7 -0
  358. package/tests/getOrdersLabels.test.js +7 -0
  359. package/tests/getOrdersOpinions.test.js +32 -0
  360. package/tests/getOrdersOpinionsRate.test.js +7 -0
  361. package/tests/getOrdersPackages.test.js +17 -0
  362. package/tests/getOrdersProfitability.test.js +7 -0
  363. package/tests/getOrdersWarehouse.test.js +7 -0
  364. package/tests/getPayments.test.js +12 -0
  365. package/tests/getPaymentsForms.test.js +7 -0
  366. package/tests/getPaymentsProfiles.test.js +7 -0
  367. package/tests/getProducts.test.js +7 -0
  368. package/tests/getProductsAuctions.test.js +7 -0
  369. package/tests/getProductsBrands.test.js +7 -0
  370. package/tests/getProductsBrandsFilter.test.js +7 -0
  371. package/tests/getProductsCategories.test.js +17 -0
  372. package/tests/getProductsCategoriesIdosell.test.js +7 -0
  373. package/tests/getProductsDescriptions.test.js +7 -0
  374. package/tests/getProductsIdBySizecode.test.js +7 -0
  375. package/tests/getProductsMarketingAllFacebookCatalogIds.test.js +7 -0
  376. package/tests/getProductsMarketingPromotion.test.js +12 -0
  377. package/tests/getProductsOpinions.test.js +17 -0
  378. package/tests/getProductsOpinionsRate.test.js +7 -0
  379. package/tests/getProductsParameters.test.js +17 -0
  380. package/tests/getProductsProductsToFacebookCatalog.test.js +7 -0
  381. package/tests/getProductsQuestions.test.js +12 -0
  382. package/tests/getProductsSKUbyBarcode.test.js +7 -0
  383. package/tests/getProductsSeries.test.js +22 -0
  384. package/tests/getProductsSeriesFilter.test.js +7 -0
  385. package/tests/getProductsSizes.test.js +7 -0
  386. package/tests/getRefundsGetPossibleAutoRefunds.test.js +7 -0
  387. package/tests/getRefundsGetRefundStatus.test.js +7 -0
  388. package/tests/getRefundsRetrieveRefundsList.test.js +7 -0
  389. package/tests/getReturns.test.js +27 -0
  390. package/tests/getRma.test.js +17 -0
  391. package/tests/getSizecharts.test.js +17 -0
  392. package/tests/getSizes.test.js +7 -0
  393. package/tests/getSystemCurrencies.test.js +12 -0
  394. package/tests/getSystemProcessesAutomation.test.js +7 -0
  395. package/tests/getSystemUnits.test.js +7 -0
  396. package/tests/getSystemUsers.test.js +7 -0
  397. package/tests/getVouchers.test.js +27 -0
  398. package/tests/getVouchersTypes.test.js +7 -0
  399. package/tests/getWarranties.test.js +12 -0
  400. package/tests/getWarrantiesCountTotal.test.js +7 -0
  401. package/tests/getWmsLocations.test.js +12 -0
  402. package/tests/getWmsStocksdocumentsDocuments.test.js +22 -0
  403. package/tests/getWmsStocksdocumentsOpenedDocuments.test.js +22 -0
  404. package/tests/getWmsStocksdocumentsProducts.test.js +12 -0
  405. package/tests/getWmsSuppliers.test.js +17 -0
  406. package/tests/listOrders.test.js +57 -0
  407. package/tests/listOrdersUnfinished.test.js +32 -0
  408. package/tests/listProducts.test.js +82 -0
  409. package/tests/postClients.test.js +7 -0
  410. package/tests/postClientsBalance.test.js +17 -0
  411. package/tests/postClientsDeliveryAddress.test.js +7 -0
  412. package/tests/postClientsGiftcards.test.js +7 -0
  413. package/tests/postClientsPayerAddress.test.js +7 -0
  414. package/tests/postClientsPricelists.test.js +12 -0
  415. package/tests/postClientsProfitPoints.test.js +7 -0
  416. package/tests/postClientsTags.test.js +7 -0
  417. package/tests/postCouriersPickupPoints.test.js +7 -0
  418. package/tests/postDeliveriesRegions.test.js +7 -0
  419. package/tests/postDiscountsGroups.test.js +7 -0
  420. package/tests/postDiscountsRebatesCard.test.js +7 -0
  421. package/tests/postDiscountsRebatesCode.test.js +7 -0
  422. package/tests/postEntries.test.js +7 -0
  423. package/tests/postMenu.test.js +7 -0
  424. package/tests/postOrders.test.js +12 -0
  425. package/tests/postOrdersDocuments.test.js +7 -0
  426. package/tests/postOrdersImages.test.js +7 -0
  427. package/tests/postOrdersPackages.test.js +7 -0
  428. package/tests/postPackages.test.js +7 -0
  429. package/tests/postPackagesLabels.test.js +7 -0
  430. package/tests/postPayments.test.js +7 -0
  431. package/tests/postPaymentsCancel.test.js +7 -0
  432. package/tests/postPaymentsCashback.test.js +7 -0
  433. package/tests/postPaymentsRepayment.test.js +7 -0
  434. package/tests/postProducts.test.js +12 -0
  435. package/tests/postProductsBrands.test.js +7 -0
  436. package/tests/postProductsCollections.test.js +7 -0
  437. package/tests/postProductsCollectionsProducts.test.js +7 -0
  438. package/tests/postProductsMarketingPromotion.test.js +7 -0
  439. package/tests/postProductsOpinions.test.js +7 -0
  440. package/tests/postProductsProductsToFacebookCatalog.test.js +7 -0
  441. package/tests/postProductsProductsToPromotion.test.js +7 -0
  442. package/tests/postProductsRestore.test.js +7 -0
  443. package/tests/postRefundsAddAutomaticRefund.test.js +7 -0
  444. package/tests/postRefundsAddAutomaticRefundForOrder.test.js +7 -0
  445. package/tests/postRefundsAddManualRefund.test.js +7 -0
  446. package/tests/postVouchers.test.js +7 -0
  447. package/tests/postWarranties.test.js +7 -0
  448. package/tests/postWmsStocksdocumentsDocuments.test.js +7 -0
  449. package/tests/postWmsStocksdocumentsProducts.test.js +7 -0
  450. package/tests/putClients.test.js +12 -0
  451. package/tests/putClientsDeliveryAddress.test.js +7 -0
  452. package/tests/putClientsExternalCode.test.js +7 -0
  453. package/tests/putClientsGiftcards.test.js +7 -0
  454. package/tests/putClientsGiftcardsBlock.test.js +7 -0
  455. package/tests/putClientsGiftcardsUnblock.test.js +7 -0
  456. package/tests/putClientsMembershipCards.test.js +7 -0
  457. package/tests/putClientsPayerAddress.test.js +7 -0
  458. package/tests/putClientsPricelists.test.js +7 -0
  459. package/tests/putClientsPricelistsClients.test.js +7 -0
  460. package/tests/putClientsPricelistsProducts.test.js +7 -0
  461. package/tests/putClientsPricelistsRename.test.js +7 -0
  462. package/tests/putClientsPricesDiscounts.test.js +7 -0
  463. package/tests/putClientsTags.test.js +7 -0
  464. package/tests/putCouriersPickupPoints.test.js +7 -0
  465. package/tests/putDeliveriesDefaultProfiles.test.js +7 -0
  466. package/tests/putDiscountsGroups.test.js +7 -0
  467. package/tests/putDiscountsGroupsProducts.test.js +7 -0
  468. package/tests/putDiscountsRebatesBlockCard.test.js +7 -0
  469. package/tests/putDiscountsRebatesUnblockCard.test.js +7 -0
  470. package/tests/putEntries.test.js +7 -0
  471. package/tests/putMenu.test.js +7 -0
  472. package/tests/putMenuFilter.test.js +12 -0
  473. package/tests/putMenuSort.test.js +7 -0
  474. package/tests/putOrders.test.js +7 -0
  475. package/tests/putOrdersCourier.test.js +7 -0
  476. package/tests/putOrdersDeliveryAddress.test.js +7 -0
  477. package/tests/putOrdersDevide.test.js +7 -0
  478. package/tests/putOrdersHandler.test.js +7 -0
  479. package/tests/putOrdersPackages.test.js +7 -0
  480. package/tests/putOrdersPickupPoint.test.js +7 -0
  481. package/tests/putOrdersProductsSerialNumbers.test.js +7 -0
  482. package/tests/putOrdersProfitMargin.test.js +7 -0
  483. package/tests/putOrdersShippingCosts.test.js +7 -0
  484. package/tests/putOrdersWarehouse.test.js +7 -0
  485. package/tests/putPackages.test.js +7 -0
  486. package/tests/putPayments.test.js +7 -0
  487. package/tests/putPaymentsConfirm.test.js +7 -0
  488. package/tests/putProducts.test.js +7 -0
  489. package/tests/putProductsAttachments.test.js +7 -0
  490. package/tests/putProductsBrands.test.js +7 -0
  491. package/tests/putProductsBrandsFilter.test.js +7 -0
  492. package/tests/putProductsCategories.test.js +7 -0
  493. package/tests/putProductsCollectionsProducts.test.js +7 -0
  494. package/tests/putProductsCollectionsRenew.test.js +7 -0
  495. package/tests/putProductsDescriptions.test.js +7 -0
  496. package/tests/putProductsGroupsMainProduct.test.js +7 -0
  497. package/tests/putProductsGroupsOrder.test.js +7 -0
  498. package/tests/putProductsGroupsSettings.test.js +7 -0
  499. package/tests/putProductsImages.test.js +7 -0
  500. package/tests/putProductsMarketingPromotion.test.js +7 -0
  501. package/tests/putProductsMarketingZones.test.js +7 -0
  502. package/tests/putProductsOmnibusPrices.test.js +7 -0
  503. package/tests/putProductsOpinions.test.js +7 -0
  504. package/tests/putProductsParameters.test.js +7 -0
  505. package/tests/putProductsQuestions.test.js +7 -0
  506. package/tests/putProductsSeries.test.js +7 -0
  507. package/tests/putProductsSeriesFilter.test.js +12 -0
  508. package/tests/putProductsSizes.test.js +7 -0
  509. package/tests/putProductsStockQuantity.test.js +7 -0
  510. package/tests/putProductsStocks.test.js +7 -0
  511. package/tests/putProductsStrikethroughPrices.test.js +7 -0
  512. package/tests/putProductsSupplierCode.test.js +7 -0
  513. package/tests/putProductsSupplierProductData.test.js +7 -0
  514. package/tests/putRefundsCancelRefund.test.js +7 -0
  515. package/tests/putRefundsConfirmRefund.test.js +7 -0
  516. package/tests/putRefundsUpdateRefund.test.js +7 -0
  517. package/tests/putReturnsSerialNumber.test.js +7 -0
  518. package/tests/putRma.test.js +7 -0
  519. package/tests/putSizecharts.test.js +7 -0
  520. package/tests/putSizes.test.js +12 -0
  521. package/tests/putSystemConfig.test.js +7 -0
  522. package/tests/putSystemCurrencies.test.js +7 -0
  523. package/tests/putSystemProcessesAutomation.test.js +7 -0
  524. package/tests/putSystemUnits.test.js +7 -0
  525. package/tests/putVouchers.test.js +7 -0
  526. package/tests/putVouchersBlock.test.js +7 -0
  527. package/tests/putVouchersUnblock.test.js +7 -0
  528. package/tests/putWarranties.test.js +7 -0
  529. package/tests/putWarrantiesLanguageData.test.js +7 -0
  530. package/tests/putWmsStocksdocumentsAcceptMM.test.js +7 -0
  531. package/tests/putWmsStocksdocumentsClose.test.js +7 -0
  532. package/tests/putWmsStocksdocumentsDocuments.test.js +7 -0
  533. package/tests/putWmsStocksdocumentsProducts.test.js +7 -0
  534. package/tests/putWmsStocksdocumentsRejectMM.test.js +7 -0
  535. package/tests/putWmsSuppliers.test.js +7 -0
  536. package/tests/rootparams.test.js +25 -0
@@ -0,0 +1,3520 @@
1
+ /**
2
+ * @typedef {Object} GetClientsBalanceRequest
3
+ * @property {(client_numbers: Array<Integer>) => GetClientsBalanceRequest} client_numbers Customer Id
4
+ * @property {(text_search: String) => GetClientsBalanceRequest} text_search Text search through customer data.
5
+ * @property {(active: 'yes'|'no') => GetClientsBalanceRequest} active
6
+ * @property {(has_trade_credit: 'nonzero'|'positive'|'negative'|'zero') => GetClientsBalanceRequest} has_trade_credit
7
+ * @property {(last_purchase_date: Object) => GetClientsBalanceRequest} last_purchase_date Start and end date (YYYY-MM-DD).
8
+ * @property {(return_elements: Array<String>) => GetClientsBalanceRequest} return_elements Elements to be returned by the endpoint. By default all elements are returned
9
+ * @property {(results_page: Integer) => GetClientsBalanceRequest} results_page Results page number. Numbering begins at 0. Default value: 0.
10
+ * @property {(results_limit: Integer) => GetClientsBalanceRequest} results_limit Maximum number of results on a single page. Default is 100.
11
+ * @property {(dateFrom: DateLike, dateTo: DateLike) => GetClientsBalanceRequest} lastPurchase Type of date according to the index results
12
+ * @property {(page: Integer, limit: Integer) => GetClientsBalanceRequest} page Define page number and maximum results per page
13
+ * @property {() => Integer} count Returns total numer of results
14
+ * @property {function} exec Excecute request
15
+ */
16
+
17
+ /**
18
+ * @typedef {Object} PostClientsBalanceRequest
19
+ * @property {(clientId: Integer) => PostClientsBalanceRequest} clientId Unique client's number.
20
+ * @property {(operation: String) => PostClientsBalanceRequest} operation Operation: - add, - remove.
21
+ * @property {(balance: Number) => PostClientsBalanceRequest} balance Value to add or remove from balance.
22
+ * @property {(currency: String) => PostClientsBalanceRequest} currency Currency of operation.
23
+ * @property {(note: String) => PostClientsBalanceRequest} note Note.
24
+ * @property {(prepaidId: Integer) => PostClientsBalanceRequest} prepaidId Order payment identifier.
25
+ * @property {(balance: Number, currency: String) => PostClientsBalanceRequest} add Adds value to client balance
26
+ * @property {(balance: Number, currency: String) => PostClientsBalanceRequest} remove Subtracts value to client balance
27
+ * @property {function} exec Excecute request
28
+ */
29
+
30
+ /**
31
+ * @typedef {Object} GetClientsRequest
32
+ * @property {(clientsIds: Array<Integer>) => GetClientsRequest} clientsIds Customer numbers.
33
+ * @property {(clientCodesExternal: Array<String>) => GetClientsRequest} clientCodesExternal External system codes list
34
+ * @property {(clientTextSearch: String) => GetClientsRequest} clientTextSearch Text search through customer data.
35
+ * @property {(clientIsActive: 'yes'|'no') => GetClientsRequest} clientIsActive Active
36
+ * @property {(clientHasTradeCredit: 'nonzero'|'positive'|'negative'|'zero') => GetClientsRequest} clientHasTradeCredit Trade credit: - positive or negative, - only positive, - only negative, - only zero.
37
+ * @property {(clientLastPurchaseDate: Object) => GetClientsRequest} clientLastPurchaseDate Date of last purchase.
38
+ * @property {(clientsLastModificationDate: Object) => GetClientsRequest} clientsLastModificationDate Last modification date.
39
+ * @property {(returnElements: Array<String>) => GetClientsRequest} returnElements Elements to be returned by the endpoint. By default all elements are returned
40
+ * @property {(resultsPage: Integer) => GetClientsRequest} resultsPage Page with results number. Numeration starts from 0
41
+ * @property {(resultsLimit: Integer) => GetClientsRequest} resultsLimit Number of results on page. Value from 1 to 100
42
+ * @property {(dateFrom: DateLike, dateTo: DateLike) => GetClientsRequest} lastPurchase Type of date according to the index results
43
+ * @property {(dateFrom: DateLike, dateTo: DateLike) => GetClientsRequest} lastModified Type of date according to the index results
44
+ * @property {(page: Integer, limit: Integer) => GetClientsRequest} page Define page number and maximum results per page
45
+ * @property {() => Integer} count Returns total numer of results
46
+ * @property {function} exec Excecute request
47
+ */
48
+
49
+ /**
50
+ * @typedef {Object} PostClientsRequest
51
+ * @property {(clients: Array<Object>) => PostClientsRequest} clients Customer data.
52
+ * @property {(login: String) => PostClientsRequest} login Customer's login.
53
+ * @property {(code_extern: String) => PostClientsRequest} code_extern External system code.
54
+ * @property {(email: String) => PostClientsRequest} email Customer e-mail address.
55
+ * @property {(firstname: String) => PostClientsRequest} firstname Customer's first name.
56
+ * @property {(lastname: String) => PostClientsRequest} lastname Customer's last name.
57
+ * @property {(street: String) => PostClientsRequest} street Address.
58
+ * @property {(zipcode: String) => PostClientsRequest} zipcode Customer's postal code.
59
+ * @property {(city: String) => PostClientsRequest} city Customer's city.
60
+ * @property {(country_code: String) => PostClientsRequest} country_code Customer country (ISO 3166-1 alfa-2 code).
61
+ * @property {(province_code: String) => PostClientsRequest} province_code Administrative region code.
62
+ * @property {(password: String) => PostClientsRequest} password Customer password (min. 8 characters).
63
+ * @property {(birth_date: String) => PostClientsRequest} birth_date Date of birth.
64
+ * @property {(phone: String) => PostClientsRequest} phone Customer phone number.
65
+ * @property {(company: String) => PostClientsRequest} company
66
+ * @property {(vat_number: String) => PostClientsRequest} vat_number Customer Tax no.
67
+ * @property {(wholesaler: Boolean) => PostClientsRequest} wholesaler Determines, whether client is a wholesaler.
68
+ * @property {(client_type: 'person'|'person_male'|'person_female'|'firm') => PostClientsRequest} client_type 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.
69
+ * @property {(language: String) => PostClientsRequest} language Customer language ID.
70
+ * @property {(shops: Array<Integer>) => PostClientsRequest} shops Determines, in which store account should be active.
71
+ * @property {(block_autosigning_to_shops: Boolean) => PostClientsRequest} block_autosigning_to_shops Defines availability of log in to other pages than the ones given in the element: shops .
72
+ * @property {(currency: String) => PostClientsRequest} currency Customer default currency (ISO 4217 code).
73
+ * @property {(delivery_dates: Array<String>) => PostClientsRequest} delivery_dates
74
+ * @property {(external_balance_value: Number) => PostClientsRequest} external_balance_value Customer account balance in external system.
75
+ * @property {(external_trade_credit_limit_value: Number) => PostClientsRequest} external_trade_credit_limit_value Debt limit.
76
+ * @property {(email_newsletter: Boolean) => PostClientsRequest} email_newsletter Have customer agreed to a newsletter. List of allowed parameters: "y" - yes, "n" - no. The value will be set in all shops in which the customer account is active.
77
+ * @property {(sms_newsletter: Boolean) => PostClientsRequest} sms_newsletter Have customer agreed to a newsletter. List of allowed parameters: "y" - yes, "n" - no. The value will be set in all shops in which the customer account is active.
78
+ * @property {(client_group: Integer) => PostClientsRequest} client_group Discount group ID.
79
+ * @property {(request_reference: String) => PostClientsRequest} request_reference Field used for identifying request-response pairs for the endpoint.
80
+ * @property {(newsletter_email_approvals: Array<Object>) => PostClientsRequest} newsletter_email_approvals List of shops where a customer agreed or didn't agree to receive email newsletter.
81
+ * @property {(newsletter_sms_approvals: Array<Object>) => PostClientsRequest} newsletter_sms_approvals List of shops where a customer agreed or didn't agree to receive sms newsletter.
82
+ * @property {(block_group_auto_assignment: Boolean) => PostClientsRequest} block_group_auto_assignment Block assigning of discount groups automatically based on order history
83
+ * @property {function} append Append current data to array and start modifying next row
84
+ * @property {function} exec Excecute request
85
+ */
86
+
87
+ /**
88
+ * @typedef {Object} PutClientsRequest
89
+ * @property {(clients: Array<Object>) => PutClientsRequest} clients Customer data.
90
+ * @property {(clientLogin: String) => PutClientsRequest} clientLogin Customer's login.
91
+ * @property {(clientEmail: String) => PutClientsRequest} clientEmail E-mail address.
92
+ * @property {(clientFirstName: String) => PutClientsRequest} clientFirstName Customer's first name.
93
+ * @property {(clientLastName: String) => PutClientsRequest} clientLastName Customer's last name.
94
+ * @property {(clientStreet: String) => PutClientsRequest} clientStreet Street and number.
95
+ * @property {(clientZipCode: String) => PutClientsRequest} clientZipCode Customer's postal code.
96
+ * @property {(clientCity: String) => PutClientsRequest} clientCity Customer's city.
97
+ * @property {(clientCountryId: String) => PutClientsRequest} clientCountryId Country ID in accordance with ISO-3166.
98
+ * @property {(clientProvinceId: String) => PutClientsRequest} clientProvinceId Administrative region code.
99
+ * @property {(clientPassword: String) => PutClientsRequest} clientPassword Customer password (min. 8 characters).
100
+ * @property {(clientBirthDate: String) => PutClientsRequest} clientBirthDate Date of birth.
101
+ * @property {(clientPhone1: String) => PutClientsRequest} clientPhone1 Cell phone.
102
+ * @property {(clientFirm: String) => PutClientsRequest} clientFirm Customer's company name.
103
+ * @property {(clientNip: String) => PutClientsRequest} clientNip Customer Tax no.
104
+ * @property {(clientIsWholesaler: Boolean) => PutClientsRequest} clientIsWholesaler Determines, whether client is a wholesaler.
105
+ * @property {(clientType: 'person'|'person_male'|'person_female'|'firm') => PutClientsRequest} clientType 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.
106
+ * @property {(langId: String) => PutClientsRequest} langId Language ID
107
+ * @property {(blockLoginToOtherShops: Boolean) => PutClientsRequest} blockLoginToOtherShops Defines availability of log in to other pages than the ones given in the element: shops .
108
+ * @property {(shopsIds: Array<Integer>) => PutClientsRequest} shopsIds List of stores IDs When mask is determined, this parameter is omitted.
109
+ * @property {(currencyId: String) => PutClientsRequest} currencyId Currency ID
110
+ * @property {(clientCodeExternal: String) => PutClientsRequest} clientCodeExternal External system code.
111
+ * @property {(deliveryDates: Array<Object>) => PutClientsRequest} deliveryDates List with delivery dates and times
112
+ * @property {(clientBalanceAmountExternal: Number) => PutClientsRequest} clientBalanceAmountExternal Customer account balance in external system.
113
+ * @property {(clientTradeCreditLimitExternal: Number) => PutClientsRequest} clientTradeCreditLimitExternal Debt limit.
114
+ * @property {(newsletterEmailApproval: Boolean) => PutClientsRequest} newsletterEmailApproval Permission to E-mail Newsletter.
115
+ * @property {(newsletterSmsApproval: Boolean) => PutClientsRequest} newsletterSmsApproval Permission to SMS Newsletter.
116
+ * @property {(clientGroupDiscountNumber: Integer) => PutClientsRequest} clientGroupDiscountNumber Discount group ID.
117
+ * @property {(requestReference: String) => PutClientsRequest} requestReference Field used for identifying request-response pairs for the endpoint.
118
+ * @property {(newsletterEmailApprovalsData: Array<Object>) => PutClientsRequest} newsletterEmailApprovalsData List of shops where a customer agreed or didn't agree to receive email newsletter.
119
+ * @property {(newsletterSmsApprovalsData: Array<Object>) => PutClientsRequest} newsletterSmsApprovalsData List of shops where a customer agreed or didn't agree to receive sms newsletter.
120
+ * @property {(clientActive: Boolean) => PutClientsRequest} clientActive Is the customer active
121
+ * @property {(numberOfDaysToPay: Integer) => PutClientsRequest} numberOfDaysToPay Number of days to pay for invoice
122
+ * @property {(affiliateLogin: String) => PutClientsRequest} affiliateLogin The parameter stores information about who acquired the customer
123
+ * @property {(affiliateId: Integer) => PutClientsRequest} affiliateId ID of a partner who acquired a given customer.
124
+ * @property {(clientNote: String) => PutClientsRequest} clientNote Notes from customer.
125
+ * @property {function} append Append current data to array and start modifying next row
126
+ * @property {function} exec Excecute request
127
+ */
128
+
129
+ /**
130
+ * @typedef {Object} GetClientsCrmRequest
131
+ * @property {(clientLogin: String) => GetClientsCrmRequest} clientLogin Customer's login.
132
+ * @property {(clientIsWholesaler: 'yes'|'no') => GetClientsCrmRequest} clientIsWholesaler Determines, whether client is a wholesaler.
133
+ * @property {(clientCountryId: String) => GetClientsCrmRequest} clientCountryId Country ID in accordance with ISO-3166.
134
+ * @property {(langId: String) => GetClientsCrmRequest} langId Language ID
135
+ * @property {(clientCustomerServiceRepresentativeLogin: String) => GetClientsCrmRequest} clientCustomerServiceRepresentativeLogin Customer service representative.
136
+ * @property {(clientDiscountGroupNumber: Integer) => GetClientsCrmRequest} clientDiscountGroupNumber Customer group number
137
+ * @property {(clientRegistrationDate: Object) => GetClientsCrmRequest} clientRegistrationDate Date range of customer registrations
138
+ * @property {(clientLastLoginDate: Object) => GetClientsCrmRequest} clientLastLoginDate Date of last customer login (YYYY-MM-DD)
139
+ * @property {(clientType: 'person'|'person_male'|'person_female'|'firm') => GetClientsCrmRequest} clientType 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.
140
+ * @property {(clientAffiliateProgram: Array<Object>) => GetClientsCrmRequest} clientAffiliateProgram Information about the loyalty program possible 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.
141
+ * @property {(newsletterEmailApproval: String) => GetClientsCrmRequest} newsletterEmailApproval Permission to E-mail Newsletter.
142
+ * @property {(newsletterSmsApproval: String) => GetClientsCrmRequest} newsletterSmsApproval Permission to SMS Newsletter.
143
+ * @property {(searchByShops: Object) => GetClientsCrmRequest} searchByShops Shops
144
+ * @property {(clientLoyaltyCard: Object) => GetClientsCrmRequest} clientLoyaltyCard Loyalty cards:
145
+ * @property {(clientCodeExternal: String) => GetClientsCrmRequest} clientCodeExternal External system code.
146
+ * @property {(clientCodesExternal: Array<String>) => GetClientsCrmRequest} clientCodesExternal External system codes list.
147
+ * @property {(clientFirstName: String) => GetClientsCrmRequest} clientFirstName Customer's first name.
148
+ * @property {(clientLastName: String) => GetClientsCrmRequest} clientLastName Customer's last name.
149
+ * @property {(clientNip: String) => GetClientsCrmRequest} clientNip Customer Tax no.
150
+ * @property {(clientFirm: String) => GetClientsCrmRequest} clientFirm Customer's company name.
151
+ * @property {(clientEmail: String) => GetClientsCrmRequest} clientEmail E-mail address.
152
+ * @property {(newsletterEmailApprovalsData: Array<Object>) => GetClientsCrmRequest} newsletterEmailApprovalsData List of shops where a customer agreed or didn't agree to receive email newsletter.
153
+ * @property {(newsletterSmsApprovalsData: Array<Object>) => GetClientsCrmRequest} newsletterSmsApprovalsData List of shops where a customer agreed or didn't agree to receive sms newsletter.
154
+ * @property {(clientLoyaltyCardNumber: String) => GetClientsCrmRequest} clientLoyaltyCardNumber Customer loyalty card number, omitted when has_loyalty_card = no.
155
+ * @property {(orders: Object) => GetClientsCrmRequest} orders Orders.
156
+ * @property {(returnElements: Array<String>) => GetClientsCrmRequest} returnElements Elements to be returned by the endpoint. By default all elements are returned
157
+ * @property {(resultsPage: Integer) => GetClientsCrmRequest} resultsPage Page with results number. Numeration starts from 0
158
+ * @property {(resultsLimit: Integer) => GetClientsCrmRequest} resultsLimit Number of results on page. Value from 1 to 100
159
+ * @property {(settingsExactSearch: Boolean) => GetClientsCrmRequest} settingsExactSearch Determines, if data - that will be returned - will be exactly as entered values, or values should be fragment of customer data.
160
+ * @property {(dateFrom: DateLike, dateTo: DateLike) => GetClientsCrmRequest} registered Type of date according to the index results
161
+ * @property {(dateFrom: DateLike, dateTo: DateLike) => GetClientsCrmRequest} lastLoggedIn Type of date according to the index results
162
+ * @property {(dateFrom: DateLike, dateTo: DateLike) => GetClientsCrmRequest} ordered Type of date according to the index results
163
+ * @property {(page: Integer, limit: Integer) => GetClientsCrmRequest} page Define page number and maximum results per page
164
+ * @property {() => Integer} count Returns total numer of results
165
+ * @property {function} exec Excecute request
166
+ */
167
+
168
+ /**
169
+ * @typedef {Object} DeleteClientsDeliveryAddressRequest
170
+ * @property {(clients: Array<Object>) => DeleteClientsDeliveryAddressRequest} clients Customer data.
171
+ * @property {(clientLogin: String) => DeleteClientsDeliveryAddressRequest} clientLogin Customer's login.
172
+ * @property {(clientCodeExternal: String) => DeleteClientsDeliveryAddressRequest} clientCodeExternal External system code.
173
+ * @property {(clientDeliveryAddressId: Integer) => DeleteClientsDeliveryAddressRequest} clientDeliveryAddressId Delivery address ID.
174
+ * @property {function} append Append current data to array and start modifying next row
175
+ * @property {function} exec Excecute request
176
+ */
177
+
178
+ /**
179
+ * @typedef {Object} GetClientsDeliveryAddressRequest
180
+ * @property {(clientCodesExternal: Array<String>) => GetClientsDeliveryAddressRequest} clientCodesExternal External system codes list.
181
+ * @property {(clientIds: Array<Integer>) => GetClientsDeliveryAddressRequest} clientIds Customer ID.
182
+ * @property {(clientLogins: Array<String>) => GetClientsDeliveryAddressRequest} clientLogins Customer's login.
183
+ * @property {function} exec Excecute request
184
+ */
185
+
186
+ /**
187
+ * @typedef {Object} PostClientsDeliveryAddressRequest
188
+ * @property {(clients: Array<Object>) => PostClientsDeliveryAddressRequest} clients Customer data.
189
+ * @property {(clientLogin: String) => PostClientsDeliveryAddressRequest} clientLogin Customer's login.
190
+ * @property {(clientCodeExternal: String) => PostClientsDeliveryAddressRequest} clientCodeExternal External system code.
191
+ * @property {(shopsIds: Array<Integer>) => PostClientsDeliveryAddressRequest} shopsIds List of stores IDs When mask is determined, this parameter is omitted.
192
+ * @property {(currencyId: String) => PostClientsDeliveryAddressRequest} currencyId Currency ID
193
+ * @property {(clientDeliveryAddressFirstName: String) => PostClientsDeliveryAddressRequest} clientDeliveryAddressFirstName Recipient's first name.
194
+ * @property {(clientDeliveryAddressLastName: String) => PostClientsDeliveryAddressRequest} clientDeliveryAddressLastName Recipient's last name.
195
+ * @property {(clientDeliveryAddressAdditional: String) => PostClientsDeliveryAddressRequest} clientDeliveryAddressAdditional Additional information.
196
+ * @property {(clientDeliveryAddressPhone1: String) => PostClientsDeliveryAddressRequest} clientDeliveryAddressPhone1 Cell phone.
197
+ * @property {(clientDeliveryAddressCity: String) => PostClientsDeliveryAddressRequest} clientDeliveryAddressCity Recipient's city.
198
+ * @property {(clientDeliveryAddressStreet: String) => PostClientsDeliveryAddressRequest} clientDeliveryAddressStreet Recipient street and number.
199
+ * @property {(clientDeliveryAddressRegionId: String) => PostClientsDeliveryAddressRequest} clientDeliveryAddressRegionId Administrative region code.
200
+ * @property {(clientDeliveryAddressProvinceId: String) => PostClientsDeliveryAddressRequest} clientDeliveryAddressProvinceId Administrative region code.
201
+ * @property {(clientDeliveryAddressZipCode: String) => PostClientsDeliveryAddressRequest} clientDeliveryAddressZipCode Recipient's postal code.
202
+ * @property {(clientDeliveryAddressCountry: String) => PostClientsDeliveryAddressRequest} clientDeliveryAddressCountry Recipient's country.
203
+ * @property {function} append Append current data to array and start modifying next row
204
+ * @property {function} exec Excecute request
205
+ */
206
+
207
+ /**
208
+ * @typedef {Object} PutClientsDeliveryAddressRequest
209
+ * @property {(clients: Array<Object>) => PutClientsDeliveryAddressRequest} clients Customer data.
210
+ * @property {(clientLogin: String) => PutClientsDeliveryAddressRequest} clientLogin Customer's login.
211
+ * @property {(clientCodeExternal: String) => PutClientsDeliveryAddressRequest} clientCodeExternal External system code.
212
+ * @property {(clientDeliveryAddressId: String) => PutClientsDeliveryAddressRequest} clientDeliveryAddressId Delivery address ID.
213
+ * @property {(shopsIds: Array<Integer>) => PutClientsDeliveryAddressRequest} shopsIds List of stores IDs When mask is determined, this parameter is omitted.
214
+ * @property {(currencyId: String) => PutClientsDeliveryAddressRequest} currencyId Currency ID
215
+ * @property {(clientDeliveryAddressFirstName: String) => PutClientsDeliveryAddressRequest} clientDeliveryAddressFirstName Recipient's first name.
216
+ * @property {(clientDeliveryAddressLastName: String) => PutClientsDeliveryAddressRequest} clientDeliveryAddressLastName Recipient's last name.
217
+ * @property {(clientDeliveryAddressAdditional: String) => PutClientsDeliveryAddressRequest} clientDeliveryAddressAdditional Additional information.
218
+ * @property {(clientDeliveryAddressPhone1: String) => PutClientsDeliveryAddressRequest} clientDeliveryAddressPhone1 Cell phone.
219
+ * @property {(clientDeliveryAddressCity: String) => PutClientsDeliveryAddressRequest} clientDeliveryAddressCity Recipient's city.
220
+ * @property {(clientDeliveryAddressStreet: String) => PutClientsDeliveryAddressRequest} clientDeliveryAddressStreet Recipient street and number.
221
+ * @property {(clientDeliveryAddressRegionId: String) => PutClientsDeliveryAddressRequest} clientDeliveryAddressRegionId Administrative region code.
222
+ * @property {(clientDeliveryAddressProvinceId: String) => PutClientsDeliveryAddressRequest} clientDeliveryAddressProvinceId Administrative region code.
223
+ * @property {(clientDeliveryAddressZipCode: String) => PutClientsDeliveryAddressRequest} clientDeliveryAddressZipCode Recipient's postal code.
224
+ * @property {(clientDeliveryAddressCountry: String) => PutClientsDeliveryAddressRequest} clientDeliveryAddressCountry Recipient's country.
225
+ * @property {function} append Append current data to array and start modifying next row
226
+ * @property {function} exec Excecute request
227
+ */
228
+
229
+ /**
230
+ * @typedef {Object} PutClientsExternalCodeRequest
231
+ * @property {(client_id: Integer) => PutClientsExternalCodeRequest} client_id
232
+ * @property {(client_login: String) => PutClientsExternalCodeRequest} client_login Customer's login.
233
+ * @property {(code_extern: String) => PutClientsExternalCodeRequest} code_extern External system code.
234
+ * @property {function} exec Excecute request
235
+ */
236
+
237
+ /**
238
+ * @typedef {Object} PutClientsGiftcardsBlockRequest
239
+ * @property {(giftCards: Array<Object>) => PutClientsGiftcardsBlockRequest} giftCards List of gift cards
240
+ * @property {(id: Integer) => PutClientsGiftcardsBlockRequest} id Card ID
241
+ * @property {(number: String) => PutClientsGiftcardsBlockRequest} number Card number
242
+ * @property {function} append Append current data to array and start modifying next row
243
+ * @property {function} exec Excecute request
244
+ */
245
+
246
+ /**
247
+ * @typedef {Object} DeleteClientsGiftcardsRequest
248
+ * @property {(giftCards: Array<Object>) => DeleteClientsGiftcardsRequest} giftCards List of gift cards
249
+ * @property {(id: Integer) => DeleteClientsGiftcardsRequest} id Card ID
250
+ * @property {(number: String) => DeleteClientsGiftcardsRequest} number Card number
251
+ * @property {function} append Append current data to array and start modifying next row
252
+ * @property {function} exec Excecute request
253
+ */
254
+
255
+ /**
256
+ * @typedef {Object} GetClientsGiftcardsRequest
257
+ * @property {(giftCards: Array<Object>) => GetClientsGiftcardsRequest} giftCards List of gift cards
258
+ * @property {(searchGiftCards: Object) => GetClientsGiftcardsRequest} searchGiftCards element is an element array of type searchGiftCards
259
+ * @property {(ids: Array<Integer>) => GetClientsGiftcardsRequest} ids Define giftCards by passing array of values
260
+ * @property {(number: Array<Integer>) => GetClientsGiftcardsRequest} number Define giftCards by passing array of values
261
+ * @property {(pins: Array<Integer>) => GetClientsGiftcardsRequest} pins Define giftCards by passing array of values
262
+ * @property {function} exec Excecute request
263
+ */
264
+
265
+ /**
266
+ * @typedef {Object} PostClientsGiftcardsRequest
267
+ * @property {(giftCards: Array<Object>) => PostClientsGiftcardsRequest} giftCards List of cards to add
268
+ * @property {(typeId: Integer) => PostClientsGiftcardsRequest} typeId Gift card type id
269
+ * @property {(number: String) => PostClientsGiftcardsRequest} number Card number
270
+ * @property {(pin: String) => PostClientsGiftcardsRequest} pin Card PIN
271
+ * @property {(name: String) => PostClientsGiftcardsRequest} name Name of card
272
+ * @property {(expirationDate: String) => PostClientsGiftcardsRequest} expirationDate Card expiration date
273
+ * @property {(balance: Object) => PostClientsGiftcardsRequest} balance Card balance
274
+ * @property {(shops: Array<Integer>) => PostClientsGiftcardsRequest} shops List of shops the card is active in
275
+ * @property {(note: String) => PostClientsGiftcardsRequest} note
276
+ * @property {function} append Append current data to array and start modifying next row
277
+ * @property {function} exec Excecute request
278
+ */
279
+
280
+ /**
281
+ * @typedef {Object} PutClientsGiftcardsRequest
282
+ * @property {(giftCards: Array<Object>) => PutClientsGiftcardsRequest} giftCards List of cards to edit
283
+ * @property {(id: Integer) => PutClientsGiftcardsRequest} id Card ID
284
+ * @property {(number: String) => PutClientsGiftcardsRequest} number Card number
285
+ * @property {(pin: String) => PutClientsGiftcardsRequest} pin Card PIN
286
+ * @property {(name: String) => PutClientsGiftcardsRequest} name Name of card
287
+ * @property {(expirationDate: String) => PutClientsGiftcardsRequest} expirationDate Card expiration date
288
+ * @property {(balanceOperationType: 'set'|'add'|'subtract') => PutClientsGiftcardsRequest} balanceOperationType Balance operation type, possible values: - set - balance positioning of funds, - add - add funds to balance, - subtract - subtract funds from balance.
289
+ * @property {(balance: Object) => PutClientsGiftcardsRequest} balance Card balance
290
+ * @property {(shops: Array<Integer>) => PutClientsGiftcardsRequest} shops List of shops the card is active in
291
+ * @property {(note: String) => PutClientsGiftcardsRequest} note
292
+ * @property {function} append Append current data to array and start modifying next row
293
+ * @property {function} exec Excecute request
294
+ */
295
+
296
+ /**
297
+ * @typedef {Object} GetClientsGiftcardsTypesRequest
298
+ * @property {(resultsPage: Integer) => GetClientsGiftcardsTypesRequest} resultsPage Page with results number. Numeration starts from 0
299
+ * @property {(resultsLimit: Integer) => GetClientsGiftcardsTypesRequest} resultsLimit Number of results on page. Value from 1 to 100
300
+ * @property {(page: Integer, limit: Integer) => GetClientsGiftcardsTypesRequest} page Define page number and maximum results per page
301
+ * @property {() => Integer} count Returns total numer of results
302
+ * @property {function} exec Excecute request
303
+ */
304
+
305
+ /**
306
+ * @typedef {Object} PutClientsGiftcardsUnblockRequest
307
+ * @property {(giftCards: Array<Object>) => PutClientsGiftcardsUnblockRequest} giftCards List of gift cards
308
+ * @property {(id: Integer) => PutClientsGiftcardsUnblockRequest} id Card ID
309
+ * @property {(number: String) => PutClientsGiftcardsUnblockRequest} number Card number
310
+ * @property {function} append Append current data to array and start modifying next row
311
+ * @property {function} exec Excecute request
312
+ */
313
+
314
+ /**
315
+ * @typedef {Object} GetClientsMembershipCardsRequest
316
+ * @property {(id: Integer) => GetClientsMembershipCardsRequest} id Customer ID.
317
+ * @property {(login: String) => GetClientsMembershipCardsRequest} login Customer's login.
318
+ * @property {function} exec Excecute request
319
+ */
320
+
321
+ /**
322
+ * @typedef {Object} PutClientsMembershipCardsRequest
323
+ * @property {(id: Integer) => PutClientsMembershipCardsRequest} id Customer ID.
324
+ * @property {(login: String) => PutClientsMembershipCardsRequest} login Customer's login.
325
+ * @property {(membership_cards: Array<Object>) => PutClientsMembershipCardsRequest} membership_cards
326
+ * @property {(ordinal_number: Integer) => PutClientsMembershipCardsRequest} ordinal_number Card ID entered by customer.
327
+ * @property {(card_type: Integer) => PutClientsMembershipCardsRequest} card_type Card ID.
328
+ * @property {(number: String) => PutClientsMembershipCardsRequest} number Loyalty card number.
329
+ * @property {(pin: Integer) => PutClientsMembershipCardsRequest} pin Card PIN.
330
+ * @property {(creation_date: String) => PutClientsMembershipCardsRequest} creation_date Issue date.
331
+ * @property {(deactivate: Boolean) => PutClientsMembershipCardsRequest} deactivate Determines whether a card should be deactivated.
332
+ * @property {(set_rebate_group: Boolean) => PutClientsMembershipCardsRequest} set_rebate_group Flag that determines whether a discount group should be set.
333
+ * @property {(errors: Object) => PutClientsMembershipCardsRequest} errors Information on error that occurred during gate call.
334
+ * @property {function} append Append current data to array and start modifying next row
335
+ * @property {function} exec Excecute request
336
+ */
337
+
338
+ /**
339
+ * @typedef {Object} GetClientsNewsletterEmailSMSRequest
340
+ * @property {(shops: Array<Object>) => GetClientsNewsletterEmailSMSRequest} shops
341
+ * @property {(language: String) => GetClientsNewsletterEmailSMSRequest} language Customer language ID.
342
+ * @property {(date: Object) => GetClientsNewsletterEmailSMSRequest} date
343
+ * @property {(return_elements: Array<String>) => GetClientsNewsletterEmailSMSRequest} return_elements Elements to be returned by the endpoint. By default all elements are returned
344
+ * @property {(results_page: Integer) => GetClientsNewsletterEmailSMSRequest} results_page Results page number. Numbering begins at 0. Default value: 0.
345
+ * @property {(results_limit: Integer) => GetClientsNewsletterEmailSMSRequest} results_limit Maximum number of results on a single page. Default is 100.
346
+ * @property {(dateFrom: DateLike, dateTo: DateLike) => GetClientsNewsletterEmailSMSRequest} dates Type of date according to the index results
347
+ * @property {(page: Integer, limit: Integer) => GetClientsNewsletterEmailSMSRequest} page Define page number and maximum results per page
348
+ * @property {() => Integer} count Returns total numer of results
349
+ * @property {function} exec Excecute request
350
+ */
351
+
352
+ /**
353
+ * @typedef {Object} GetClientsNewsletterEmailShopsRequest
354
+ * @property {(shops: Array<Object>) => GetClientsNewsletterEmailShopsRequest} shops
355
+ * @property {(language: String) => GetClientsNewsletterEmailShopsRequest} language Customer language ID.
356
+ * @property {(date: Object) => GetClientsNewsletterEmailShopsRequest} date
357
+ * @property {(return_elements: Array<String>) => GetClientsNewsletterEmailShopsRequest} return_elements Elements to be returned by the endpoint. By default all elements are returned
358
+ * @property {(results_page: Integer) => GetClientsNewsletterEmailShopsRequest} results_page Results page number. Numbering begins at 0. Default value: 0.
359
+ * @property {(results_limit: Integer) => GetClientsNewsletterEmailShopsRequest} results_limit Maximum number of results on a single page. Default is 100.
360
+ * @property {(dateFrom: DateLike, dateTo: DateLike) => GetClientsNewsletterEmailShopsRequest} dates Type of date according to the index results
361
+ * @property {(page: Integer, limit: Integer) => GetClientsNewsletterEmailShopsRequest} page Define page number and maximum results per page
362
+ * @property {() => Integer} count Returns total numer of results
363
+ * @property {function} exec Excecute request
364
+ */
365
+
366
+ /**
367
+ * @typedef {Object} DeleteClientsPayerAddressRequest
368
+ * @property {(payers: Array<Object>) => DeleteClientsPayerAddressRequest} payers
369
+ * @property {(clientId: Integer) => DeleteClientsPayerAddressRequest} clientId Unique client's number.
370
+ * @property {(payerAddressId: Integer) => DeleteClientsPayerAddressRequest} payerAddressId Buyer's address id.
371
+ * @property {function} append Append current data to array and start modifying next row
372
+ * @property {function} exec Excecute request
373
+ */
374
+
375
+ /**
376
+ * @typedef {Object} GetClientsPayerAddressRequest
377
+ * @property {(clientId: String) => GetClientsPayerAddressRequest} clientId Unique client's number.
378
+ * @property {(resultsPage: Integer) => GetClientsPayerAddressRequest} resultsPage Page with results number. Numeration starts from 0
379
+ * @property {(resultsLimit: Integer) => GetClientsPayerAddressRequest} resultsLimit Number of results on page. Value from 1 to 100
380
+ * @property {(page: Integer, limit: Integer) => GetClientsPayerAddressRequest} page Define page number and maximum results per page
381
+ * @property {() => Integer} count Returns total numer of results
382
+ * @property {function} exec Excecute request
383
+ */
384
+
385
+ /**
386
+ * @typedef {Object} PostClientsPayerAddressRequest
387
+ * @property {(payers: Array<Object>) => PostClientsPayerAddressRequest} payers
388
+ * @property {(clientId: Integer) => PostClientsPayerAddressRequest} clientId Unique client's number.
389
+ * @property {(payerAddressFirstName: String) => PostClientsPayerAddressRequest} payerAddressFirstName Buyer's first name.
390
+ * @property {(payerAddressLastName: String) => PostClientsPayerAddressRequest} payerAddressLastName Buyer's last name.
391
+ * @property {(payerAddressFirm: String) => PostClientsPayerAddressRequest} payerAddressFirm Company name.
392
+ * @property {(payerAddressNip: String) => PostClientsPayerAddressRequest} payerAddressNip Customer VAT ID.
393
+ * @property {(payerAddressStreet: String) => PostClientsPayerAddressRequest} payerAddressStreet Buyer's street name and house number.
394
+ * @property {(payerAddressZipCode: String) => PostClientsPayerAddressRequest} payerAddressZipCode Buyer's postal code.
395
+ * @property {(payerAddressCity: String) => PostClientsPayerAddressRequest} payerAddressCity Buyer's city.
396
+ * @property {(payerAddressCountryId: String) => PostClientsPayerAddressRequest} payerAddressCountryId Country code in the ISO 3166-1 A2 standard.
397
+ * @property {(payerAddressPhone: String) => PostClientsPayerAddressRequest} payerAddressPhone Buyer's telephone number.
398
+ * @property {function} append Append current data to array and start modifying next row
399
+ * @property {function} exec Excecute request
400
+ */
401
+
402
+ /**
403
+ * @typedef {Object} PutClientsPayerAddressRequest
404
+ * @property {(payers: Array<Object>) => PutClientsPayerAddressRequest} payers
405
+ * @property {(clientId: String) => PutClientsPayerAddressRequest} clientId Unique client's number.
406
+ * @property {(payerAddressId: String) => PutClientsPayerAddressRequest} payerAddressId Buyer's address id.
407
+ * @property {(payerAddressFirstName: String) => PutClientsPayerAddressRequest} payerAddressFirstName Buyer's first name.
408
+ * @property {(payerAddressLastName: String) => PutClientsPayerAddressRequest} payerAddressLastName Buyer's last name.
409
+ * @property {(payerAddressFirm: String) => PutClientsPayerAddressRequest} payerAddressFirm Company name.
410
+ * @property {(payerAddressNip: String) => PutClientsPayerAddressRequest} payerAddressNip Customer VAT ID.
411
+ * @property {(payerAddressStreet: String) => PutClientsPayerAddressRequest} payerAddressStreet Buyer's street name and house number.
412
+ * @property {(payerAddressZipCode: String) => PutClientsPayerAddressRequest} payerAddressZipCode Buyer's postal code.
413
+ * @property {(payerAddressCity: String) => PutClientsPayerAddressRequest} payerAddressCity Buyer's city.
414
+ * @property {(payerAddressCountryId: String) => PutClientsPayerAddressRequest} payerAddressCountryId Country code in the ISO 3166-1 A2 standard.
415
+ * @property {(payerAddressPhone: String) => PutClientsPayerAddressRequest} payerAddressPhone Buyer's telephone number.
416
+ * @property {function} append Append current data to array and start modifying next row
417
+ * @property {function} exec Excecute request
418
+ */
419
+
420
+ /**
421
+ * @typedef {Object} GetClientsPricelistsClientsRequest
422
+ * @property {(priceListId: Integer) => GetClientsPricelistsClientsRequest} priceListId Individual price list ID.
423
+ * @property {function} exec Excecute request
424
+ */
425
+
426
+ /**
427
+ * @typedef {Object} PutClientsPricelistsClientsRequest
428
+ * @property {(priceListId: Integer) => PutClientsPricelistsClientsRequest} priceListId Individual price list ID.
429
+ * @property {(clientsIds: Array<Integer>) => PutClientsPricelistsClientsRequest} clientsIds Customer numbers.
430
+ * @property {function} exec Excecute request
431
+ */
432
+
433
+ /**
434
+ * @typedef {Object} DeleteClientsPricelistsRequest
435
+ * @property {(priceListId: Integer) => DeleteClientsPricelistsRequest} priceListId Individual price list ID.
436
+ * @property {function} exec Excecute request
437
+ */
438
+
439
+ /**
440
+ * @typedef {Object} GetClientsPricelistsRequest
441
+ * @property {(priceListIds: Array<Integer>) => GetClientsPricelistsRequest} priceListIds List of individual price lists.
442
+ * @property {(returnElements: Array<String>) => GetClientsPricelistsRequest} returnElements Elements to be returned by the endpoint. By default all elements are returned
443
+ * @property {(resultsPage: Integer) => GetClientsPricelistsRequest} resultsPage Page with results number. Numeration starts from 0
444
+ * @property {(resultsLimit: Integer) => GetClientsPricelistsRequest} resultsLimit Number of results on page. Value from 1 to 100
445
+ * @property {(page: Integer, limit: Integer) => GetClientsPricelistsRequest} page Define page number and maximum results per page
446
+ * @property {() => Integer} count Returns total numer of results
447
+ * @property {function} exec Excecute request
448
+ */
449
+
450
+ /**
451
+ * @typedef {Object} PostClientsPricelistsRequest
452
+ * @property {(priceListName: String) => PostClientsPricelistsRequest} priceListName Name of individual price list.
453
+ * @property {(onlyOrderProductsWithManuallySetPrices: 'yes'|'no') => PostClientsPricelistsRequest} onlyOrderProductsWithManuallySetPrices Restrict visibility to products listed in price list (other products will remain hidden) - yes - no
454
+ * @property {(onlySeeProductsWithManuallySetPrices: 'yes'|'no') => PostClientsPricelistsRequest} onlySeeProductsWithManuallySetPrices Restrict products visibility to products listed in price list, remaining products will be seen as "Call for price" - yes - no
455
+ * @property {function} exec Excecute request
456
+ */
457
+
458
+ /**
459
+ * @typedef {Object} PutClientsPricelistsRequest
460
+ * @property {(priceListId: Integer) => PutClientsPricelistsRequest} priceListId Individual price list ID.
461
+ * @property {(priceListName: String) => PutClientsPricelistsRequest} priceListName Name of individual price list.
462
+ * @property {(onlyOrderProductsWithManuallySetPrices: 'yes'|'no') => PutClientsPricelistsRequest} onlyOrderProductsWithManuallySetPrices Restrict visibility to products listed in price list (other products will remain hidden) - yes - no
463
+ * @property {(onlySeeProductsWithManuallySetPrices: 'yes'|'no') => PutClientsPricelistsRequest} onlySeeProductsWithManuallySetPrices Restrict products visibility to products listed in price list, remaining products will be seen as "Call for price" - yes - no
464
+ * @property {function} exec Excecute request
465
+ */
466
+
467
+ /**
468
+ * @typedef {Object} GetClientsPricelistsProductsRequest
469
+ * @property {(priceListId: Integer) => GetClientsPricelistsProductsRequest} priceListId Individual price list ID.
470
+ * @property {(resultsPage: Integer) => GetClientsPricelistsProductsRequest} resultsPage Page with results number. Numeration starts from 0
471
+ * @property {(resultsLimit: Integer) => GetClientsPricelistsProductsRequest} resultsLimit Number of results per page. Value from 1 to 500.
472
+ * @property {(page: Integer, limit: Integer) => GetClientsPricelistsProductsRequest} page Define page number and maximum results per page
473
+ * @property {() => Integer} count Returns total numer of results
474
+ * @property {function} exec Excecute request
475
+ */
476
+
477
+ /**
478
+ * @typedef {Object} PutClientsPricelistsProductsRequest
479
+ * @property {(priceListId: Integer) => PutClientsPricelistsProductsRequest} priceListId Individual price list ID.
480
+ * @property {(products: Array<Object>) => PutClientsPricelistsProductsRequest} products Products list.
481
+ * @property {(producers: Array<Object>) => PutClientsPricelistsProductsRequest} producers List of manufacturers assigned to sought products.
482
+ * @property {(series: Array<Object>) => PutClientsPricelistsProductsRequest} series Series list.
483
+ * @property {(categories: Array<Object>) => PutClientsPricelistsProductsRequest} categories List of categories in which sought products are present.
484
+ * @property {(menuItems: Array<Object>) => PutClientsPricelistsProductsRequest} menuItems
485
+ * @property {function} exec Excecute request
486
+ */
487
+
488
+ /**
489
+ * @typedef {Object} PutClientsPricelistsRenameRequest
490
+ * @property {(priceListName: String) => PutClientsPricelistsRenameRequest} priceListName Name of individual price list.
491
+ * @property {(priceListId: Integer) => PutClientsPricelistsRenameRequest} priceListId Individual price list ID.
492
+ * @property {function} exec Excecute request
493
+ */
494
+
495
+ /**
496
+ * @typedef {Object} GetClientsPricesActiveCardRequest
497
+ * @property {function} exec Excecute request
498
+ */
499
+
500
+ /**
501
+ * @typedef {Object} GetClientsPricesDiscountGroupsRequest
502
+ * @property {(clientDiscountGroupsNumbers: Array<Integer>) => GetClientsPricesDiscountGroupsRequest} clientDiscountGroupsNumbers Customer groups.
503
+ * @property {(returnElements: Array<String>) => GetClientsPricesDiscountGroupsRequest} returnElements Elements to be returned by the endpoint. By default all elements are returned
504
+ * @property {(resultsPage: Integer) => GetClientsPricesDiscountGroupsRequest} resultsPage Page with results number. Numeration starts from 0
505
+ * @property {(resultsLimit: Integer) => GetClientsPricesDiscountGroupsRequest} resultsLimit Number of results on page. Value from 1 to 100
506
+ * @property {(page: Integer, limit: Integer) => GetClientsPricesDiscountGroupsRequest} page Define page number and maximum results per page
507
+ * @property {() => Integer} count Returns total numer of results
508
+ * @property {function} exec Excecute request
509
+ */
510
+
511
+ /**
512
+ * @typedef {Object} GetClientsPricesDiscountsRequest
513
+ * @property {(clientsIds: Array<Integer>) => GetClientsPricesDiscountsRequest} clientsIds Customer numbers.
514
+ * @property {(clientTextSearch: String) => GetClientsPricesDiscountsRequest} clientTextSearch Text search through customer data.
515
+ * @property {(clientIsActive: 'yes'|'no') => GetClientsPricesDiscountsRequest} clientIsActive Active
516
+ * @property {(clientHasTradeCredit: 'nonzero'|'positive'|'negative'|'zero') => GetClientsPricesDiscountsRequest} clientHasTradeCredit Trade credit: - positive or negative, - only positive, - only negative, - only zero.
517
+ * @property {(clientLastPurchaseDate: Object) => GetClientsPricesDiscountsRequest} clientLastPurchaseDate Date of last purchase.
518
+ * @property {(returnElements: Array<String>) => GetClientsPricesDiscountsRequest} returnElements Elements to be returned by the endpoint. By default all elements are returned
519
+ * @property {(resultsPage: Integer) => GetClientsPricesDiscountsRequest} resultsPage Page with results number. Numeration starts from 0
520
+ * @property {(resultsLimit: Integer) => GetClientsPricesDiscountsRequest} resultsLimit Number of results on page. Value from 1 to 100
521
+ * @property {(dateFrom: DateLike, dateTo: DateLike) => GetClientsPricesDiscountsRequest} lastPurchased Type of date according to the index results
522
+ * @property {(page: Integer, limit: Integer) => GetClientsPricesDiscountsRequest} page Define page number and maximum results per page
523
+ * @property {() => Integer} count Returns total numer of results
524
+ * @property {function} exec Excecute request
525
+ */
526
+
527
+ /**
528
+ * @typedef {Object} PutClientsPricesDiscountsRequest
529
+ * @property {(customers: Object) => PutClientsPricesDiscountsRequest} customers
530
+ * @property {(discount_type: String) => PutClientsPricesDiscountsRequest} discount_type Discount type, possible values: - simple
531
+ * @property {(discount_operating: String) => PutClientsPricesDiscountsRequest} discount_operating Action, possible values: - sum_with_other_discounts_to_orders - sum with other discounts assigned to orders, - use_only_if_greater_than_the_sum_of_other_discounts - use only if greater than the sum of other discounts
532
+ * @property {(discount_parameters: Array<Object>) => PutClientsPricesDiscountsRequest} discount_parameters
533
+ * @property {(parameter_type: String) => PutClientsPricesDiscountsRequest} parameter_type Parameter type. - DEPRECATED
534
+ * @property {(parameter_value: String) => PutClientsPricesDiscountsRequest} parameter_value Parameter text ID. - DEPRECATED
535
+ * @property {(discount_value: Number) => PutClientsPricesDiscountsRequest} discount_value Size of discount.
536
+ * @property {function} append Append current data to array and start modifying next row
537
+ * @property {function} exec Excecute request
538
+ */
539
+
540
+ /**
541
+ * @typedef {Object} GetClientsProfitPointsRequest
542
+ * @property {(clientsIds: Array<Integer>) => GetClientsProfitPointsRequest} clientsIds Customer numbers.
543
+ * @property {(clientTextSearch: String) => GetClientsProfitPointsRequest} clientTextSearch Text search through customer data.
544
+ * @property {(clientIsActive: 'yes'|'no') => GetClientsProfitPointsRequest} clientIsActive Active
545
+ * @property {(clientHasTradeCredit: 'nonzero'|'positive'|'negative'|'zero') => GetClientsProfitPointsRequest} clientHasTradeCredit Trade credit: - positive or negative, - only positive, - only negative, - only zero.
546
+ * @property {(clientLastPurchaseDate: Object) => GetClientsProfitPointsRequest} clientLastPurchaseDate Date of last purchase.
547
+ * @property {(returnElements: Array<String>) => GetClientsProfitPointsRequest} returnElements Elements to be returned by the endpoint. By default all elements are returned
548
+ * @property {(resultsPage: Integer) => GetClientsProfitPointsRequest} resultsPage Page with results number. Numeration starts from 0
549
+ * @property {(resultsLimit: Integer) => GetClientsProfitPointsRequest} resultsLimit Number of results on page. Value from 1 to 100
550
+ * @property {(dateFrom: DateLike, dateTo: DateLike) => GetClientsProfitPointsRequest} lastPurchased Type of date according to the index results
551
+ * @property {(page: Integer, limit: Integer) => GetClientsProfitPointsRequest} page Define page number and maximum results per page
552
+ * @property {() => Integer} count Returns total numer of results
553
+ * @property {function} exec Excecute request
554
+ */
555
+
556
+ /**
557
+ * @typedef {Object} PostClientsProfitPointsRequest
558
+ * @property {(client_id: Integer) => PostClientsProfitPointsRequest} client_id
559
+ * @property {(operation: String) => PostClientsProfitPointsRequest} operation Operation: - add, - remove.
560
+ * @property {(score: Number) => PostClientsProfitPointsRequest} score Amount of points to add or subtract.
561
+ * @property {(note: String) => PostClientsProfitPointsRequest} note
562
+ * @property {(order_number: Integer) => PostClientsProfitPointsRequest} order_number Prepayment ID.
563
+ * @property {function} exec Excecute request
564
+ */
565
+
566
+ /**
567
+ * @typedef {Object} GetClientsProvinceListRequest
568
+ * @property {(country_code: String) => GetClientsProvinceListRequest} country_code Country code in ISO 3166-1 standard.
569
+ * @property {function} exec Excecute request
570
+ */
571
+
572
+ /**
573
+ * @typedef {Object} DeleteClientsTagsClearRequest
574
+ * @property {(clientId: Integer) => DeleteClientsTagsClearRequest} clientId Unique client's number.
575
+ * @property {function} exec Excecute request
576
+ */
577
+
578
+ /**
579
+ * @typedef {Object} DeleteClientsTagsRequest
580
+ * @property {(params: Array<Object>) => DeleteClientsTagsRequest} params Parameters transmitted to method
581
+ * @property {(clientId: Integer) => DeleteClientsTagsRequest} clientId Unique client's number.
582
+ * @property {(tagId: Integer) => DeleteClientsTagsRequest} tagId Tag ID.
583
+ * @property {function} append Append current data to array and start modifying next row
584
+ * @property {function} exec Excecute request
585
+ */
586
+
587
+ /**
588
+ * @typedef {Object} GetClientsTagsRequest
589
+ * @property {(clientId: Integer) => GetClientsTagsRequest} clientId Unique client's number.
590
+ * @property {function} exec Excecute request
591
+ */
592
+
593
+ /**
594
+ * @typedef {Object} PostClientsTagsRequest
595
+ * @property {(params: Array<Object>) => PostClientsTagsRequest} params Parameters transmitted to method
596
+ * @property {(clientId: Integer) => PostClientsTagsRequest} clientId Unique client's number.
597
+ * @property {(tagName: String) => PostClientsTagsRequest} tagName Tag name.
598
+ * @property {(tagValue: Integer) => PostClientsTagsRequest} tagValue Tag value.
599
+ * @property {function} append Append current data to array and start modifying next row
600
+ * @property {function} exec Excecute request
601
+ */
602
+
603
+ /**
604
+ * @typedef {Object} PutClientsTagsRequest
605
+ * @property {(clientId: Integer) => PutClientsTagsRequest} clientId Unique client's number.
606
+ * @property {(clientTags: Array<Object>) => PutClientsTagsRequest} clientTags
607
+ * @property {(tagId: Integer) => PutClientsTagsRequest} tagId Tag ID.
608
+ * @property {(operation: 'add'|'set'|'subtract') => PutClientsTagsRequest} operation
609
+ * @property {(tagValue: Integer) => PutClientsTagsRequest} tagValue Tag value.
610
+ * @property {function} append Append current data to array and start modifying next row
611
+ * @property {function} exec Excecute request
612
+ */
613
+
614
+ /**
615
+ * @typedef {Object} GetCouriersAssignedToShippingProfilesRequest
616
+ * @property {function} exec Excecute request
617
+ */
618
+
619
+ /**
620
+ * @typedef {Object} GetCouriersRequest
621
+ * @property {(countryCode: String) => GetCouriersRequest} countryCode Country code in ISO 3166-1 standard.
622
+ * @property {(resultsPage: Integer) => GetCouriersRequest} resultsPage Page with results number. Numeration starts from 0
623
+ * @property {(resultsLimit: Integer) => GetCouriersRequest} resultsLimit Number of results on page. Value from 1 to 100
624
+ * @property {(page: Integer, limit: Integer) => GetCouriersRequest} page Define page number and maximum results per page
625
+ * @property {() => Integer} count Returns total numer of results
626
+ * @property {function} exec Excecute request
627
+ */
628
+
629
+ /**
630
+ * @typedef {Object} DeleteCouriersPickupPointsRequest
631
+ * @property {(pickupPointDeleteRequests: Array<Object>) => DeleteCouriersPickupPointsRequest} pickupPointDeleteRequests
632
+ * @property {(pickupPointId: String) => DeleteCouriersPickupPointsRequest} pickupPointId Collection point ID.
633
+ * @property {(pickupPointExternalId: String) => DeleteCouriersPickupPointsRequest} pickupPointExternalId external system code.
634
+ * @property {(courierId: Integer) => DeleteCouriersPickupPointsRequest} courierId Courier ID.
635
+ * @property {function} append Append current data to array and start modifying next row
636
+ * @property {function} exec Excecute request
637
+ */
638
+
639
+ /**
640
+ * @typedef {Object} GetCouriersPickupPointsRequest
641
+ * @property {(courierId: Integer) => GetCouriersPickupPointsRequest} courierId Courier ID.
642
+ * @property {(pickupPointId: String) => GetCouriersPickupPointsRequest} pickupPointId Collection point ID.
643
+ * @property {(pickupPointExternalId: String) => GetCouriersPickupPointsRequest} pickupPointExternalId External system code.
644
+ * @property {(resultsPage: Integer) => GetCouriersPickupPointsRequest} resultsPage Page with results number. Numeration starts from 0
645
+ * @property {(resultsLimit: Integer) => GetCouriersPickupPointsRequest} resultsLimit Number of results on page. Value from 1 to 100
646
+ * @property {(page: Integer, limit: Integer) => GetCouriersPickupPointsRequest} page Define page number and maximum results per page
647
+ * @property {() => Integer} count Returns total numer of results
648
+ * @property {function} exec Excecute request
649
+ */
650
+
651
+ /**
652
+ * @typedef {Object} PostCouriersPickupPointsRequest
653
+ * @property {(pickupPoints: Array<Object>) => PostCouriersPickupPointsRequest} pickupPoints
654
+ * @property {(pickupPointExternalId: String) => PostCouriersPickupPointsRequest} pickupPointExternalId external system code.
655
+ * @property {(courierId: Integer) => PostCouriersPickupPointsRequest} courierId Courier ID.
656
+ * @property {(descriptions: Array<Object>) => PostCouriersPickupPointsRequest} descriptions collection point details.
657
+ * @property {(paymentForms: Array<Object>) => PostCouriersPickupPointsRequest} paymentForms Accepted payment types.
658
+ * @property {(serviceStatus: 'out_of_service'|'available') => PostCouriersPickupPointsRequest} serviceStatus Collection point activity. Available values: available, outOfService .
659
+ * @property {(address: Object) => PostCouriersPickupPointsRequest} address Pickup point address.
660
+ * @property {(coordinates: Object) => PostCouriersPickupPointsRequest} coordinates Geographic coordinates.
661
+ * @property {(operatingDays: Array<Object>) => PostCouriersPickupPointsRequest} operatingDays Personal collection point work hours.
662
+ * @property {function} append Append current data to array and start modifying next row
663
+ * @property {function} exec Excecute request
664
+ */
665
+
666
+ /**
667
+ * @typedef {Object} PutCouriersPickupPointsRequest
668
+ * @property {(pickupPoints: Array<Object>) => PutCouriersPickupPointsRequest} pickupPoints
669
+ * @property {(pickupPointId: String) => PutCouriersPickupPointsRequest} pickupPointId Collection point ID.
670
+ * @property {(pickupPointExternalId: String) => PutCouriersPickupPointsRequest} pickupPointExternalId external system code.
671
+ * @property {(courierId: Integer) => PutCouriersPickupPointsRequest} courierId Courier ID.
672
+ * @property {(descriptions: Array<Object>) => PutCouriersPickupPointsRequest} descriptions collection point details.
673
+ * @property {(paymentForms: Array<Object>) => PutCouriersPickupPointsRequest} paymentForms Accepted payment types.
674
+ * @property {(serviceStatus: 'out_of_service'|'available') => PutCouriersPickupPointsRequest} serviceStatus Collection point activity. Available values: available, outOfService .
675
+ * @property {(address: Object) => PutCouriersPickupPointsRequest} address Pickup point address.
676
+ * @property {(coordinates: Object) => PutCouriersPickupPointsRequest} coordinates Geographic coordinates.
677
+ * @property {(operatingDays: Array<Object>) => PutCouriersPickupPointsRequest} operatingDays Personal collection point work hours.
678
+ * @property {function} append Append current data to array and start modifying next row
679
+ * @property {function} exec Excecute request
680
+ */
681
+
682
+ /**
683
+ * @typedef {Object} PutDeliveriesDefaultProfilesRequest
684
+ * @property {(regionId: Integer) => PutDeliveriesDefaultProfilesRequest} regionId Country ID
685
+ * @property {(shopId: Integer) => PutDeliveriesDefaultProfilesRequest} shopId Shop Id
686
+ * @property {(retailProfileId: Integer) => PutDeliveriesDefaultProfilesRequest} retailProfileId ID of delivery profile for retail sales
687
+ * @property {(wholesaleProfileId: Integer) => PutDeliveriesDefaultProfilesRequest} wholesaleProfileId ID of delivery profile for wholesale sales
688
+ * @property {function} exec Excecute request
689
+ */
690
+
691
+ /**
692
+ * @typedef {Object} GetDeliveriesProfilesRequest
693
+ * @property {(resultsPage: Integer) => GetDeliveriesProfilesRequest} resultsPage Page with results number. Numeration starts from 0
694
+ * @property {(resultsLimit: Integer) => GetDeliveriesProfilesRequest} resultsLimit Number of results on page. Value from 1 to 100
695
+ * @property {(page: Integer, limit: Integer) => GetDeliveriesProfilesRequest} page Define page number and maximum results per page
696
+ * @property {() => Integer} count Returns total numer of results
697
+ * @property {function} exec Excecute request
698
+ */
699
+
700
+ /**
701
+ * @typedef {Object} GetDeliveriesRegionsRequest
702
+ * @property {(shopId: Integer) => GetDeliveriesRegionsRequest} shopId Shop Id
703
+ * @property {function} exec Excecute request
704
+ */
705
+
706
+ /**
707
+ * @typedef {Object} PostDeliveriesRegionsRequest
708
+ * @property {(regionName: String) => PostDeliveriesRegionsRequest} regionName Name of the region in the panel
709
+ * @property {(shopId: Integer) => PostDeliveriesRegionsRequest} shopId Shop Id
710
+ * @property {(postCodeFrom: String) => PostDeliveriesRegionsRequest} postCodeFrom The range of postal codes from %s
711
+ * @property {(postCodeTo: String) => PostDeliveriesRegionsRequest} postCodeTo The range of postal codes to %s
712
+ * @property {(parentRegionId: Integer) => PostDeliveriesRegionsRequest} parentRegionId ID of the country for which the region is being added
713
+ * @property {function} exec Excecute request
714
+ */
715
+
716
+ /**
717
+ * @typedef {Object} GetDiscountsGroupsClientsRequest
718
+ * @property {(discountGroupId: Integer) => GetDiscountsGroupsClientsRequest} discountGroupId Discount group ID
719
+ * @property {function} exec Excecute request
720
+ */
721
+
722
+ /**
723
+ * @typedef {Object} DeleteDiscountsGroupsRequest
724
+ * @property {(discountGroupId: Integer) => DeleteDiscountsGroupsRequest} discountGroupId Discount group ID
725
+ * @property {function} exec Excecute request
726
+ */
727
+
728
+ /**
729
+ * @typedef {Object} GetDiscountsGroupsRequest
730
+ * @property {(group_numbers: Array<Integer>) => GetDiscountsGroupsRequest} group_numbers
731
+ * @property {(return_elements: Array<String>) => GetDiscountsGroupsRequest} return_elements Elements to be returned by the endpoint. By default all elements are returned
732
+ * @property {(results_page: Integer) => GetDiscountsGroupsRequest} results_page Results page number. Numbering begins at 0. Default value: 0.
733
+ * @property {(results_limit: Integer) => GetDiscountsGroupsRequest} results_limit Maximum number of results on a single page. Default is 100.
734
+ * @property {(page: Integer, limit: Integer) => GetDiscountsGroupsRequest} page Define page number and maximum results per page
735
+ * @property {() => Integer} count Returns total numer of results
736
+ * @property {function} exec Excecute request
737
+ */
738
+
739
+ /**
740
+ * @typedef {Object} PostDiscountsGroupsRequest
741
+ * @property {(discountGroupName: String) => PostDiscountsGroupsRequest} discountGroupName Discount group name
742
+ * @property {function} exec Excecute request
743
+ */
744
+
745
+ /**
746
+ * @typedef {Object} PutDiscountsGroupsRequest
747
+ * @property {(discountGroupId: Integer) => PutDiscountsGroupsRequest} discountGroupId Discount group ID
748
+ * @property {(discountGroupName: String) => PutDiscountsGroupsRequest} discountGroupName Discount group name
749
+ * @property {function} exec Excecute request
750
+ */
751
+
752
+ /**
753
+ * @typedef {Object} DeleteDiscountsGroupsProductsRequest
754
+ * @property {(discountGroupId: Integer) => DeleteDiscountsGroupsProductsRequest} discountGroupId Discount group ID
755
+ * @property {(products: Array<Integer>) => DeleteDiscountsGroupsProductsRequest} products Products list.
756
+ * @property {(producers: Array<Integer>) => DeleteDiscountsGroupsProductsRequest} producers Brands
757
+ * @property {(series: Array<Integer>) => DeleteDiscountsGroupsProductsRequest} series Series
758
+ * @property {(categories: Array<Integer>) => DeleteDiscountsGroupsProductsRequest} categories List of categories in which sought products are present.
759
+ * @property {(menuItems: Array<Integer>) => DeleteDiscountsGroupsProductsRequest} menuItems Menu elements
760
+ * @property {function} exec Excecute request
761
+ */
762
+
763
+ /**
764
+ * @typedef {Object} PutDiscountsGroupsProductsRequest
765
+ * @property {(discountGroupId: Integer) => PutDiscountsGroupsProductsRequest} discountGroupId Discount group ID
766
+ * @property {(products: Array<Object>) => PutDiscountsGroupsProductsRequest} products Products list.
767
+ * @property {(producers: Array<Object>) => PutDiscountsGroupsProductsRequest} producers Brands
768
+ * @property {(series: Array<Object>) => PutDiscountsGroupsProductsRequest} series Series
769
+ * @property {(categories: Array<Object>) => PutDiscountsGroupsProductsRequest} categories List of categories in which sought products are present.
770
+ * @property {(menuItems: Array<Object>) => PutDiscountsGroupsProductsRequest} menuItems Menu elements
771
+ * @property {function} exec Excecute request
772
+ */
773
+
774
+ /**
775
+ * @typedef {Object} PutDiscountsRebatesBlockCardRequest
776
+ * @property {(card_number: String) => PutDiscountsRebatesBlockCardRequest} card_number Card number
777
+ * @property {function} exec Excecute request
778
+ */
779
+
780
+ /**
781
+ * @typedef {Object} DeleteDiscountsRebatesCardRequest
782
+ * @property {(campaign_id: Integer) => DeleteDiscountsRebatesCardRequest} campaign_id Discount card type
783
+ * @property {function} exec Excecute request
784
+ */
785
+
786
+ /**
787
+ * @typedef {Object} PostDiscountsRebatesCardRequest
788
+ * @property {(campaign_id: Integer) => PostDiscountsRebatesCardRequest} campaign_id Discount card type
789
+ * @property {(card_number: String) => PostDiscountsRebatesCardRequest} card_number Card number
790
+ * @property {function} exec Excecute request
791
+ */
792
+
793
+ /**
794
+ * @typedef {Object} DeleteDiscountsRebatesCodeRequest
795
+ * @property {(campaign_id: Integer) => DeleteDiscountsRebatesCodeRequest} campaign_id Campaign ID
796
+ * @property {function} exec Excecute request
797
+ */
798
+
799
+ /**
800
+ * @typedef {Object} PostDiscountsRebatesCodeRequest
801
+ * @property {(campaign_id: Integer) => PostDiscountsRebatesCodeRequest} campaign_id Campaign ID
802
+ * @property {(code_number: String) => PostDiscountsRebatesCodeRequest} code_number Code
803
+ * @property {function} exec Excecute request
804
+ */
805
+
806
+ /**
807
+ * @typedef {Object} PutDiscountsRebatesUnblockCardRequest
808
+ * @property {(card_number: String) => PutDiscountsRebatesUnblockCardRequest} card_number Card number
809
+ * @property {function} exec Excecute request
810
+ */
811
+
812
+ /**
813
+ * @typedef {Object} DeleteEntriesRequest
814
+ * @property {(entryId: Integer) => DeleteEntriesRequest} entryId Entry ID
815
+ * @property {function} exec Excecute request
816
+ */
817
+
818
+ /**
819
+ * @typedef {Object} GetEntriesRequest
820
+ * @property {(entryId: Integer) => GetEntriesRequest} entryId Entry ID
821
+ * @property {(langId: String) => GetEntriesRequest} langId Language ID
822
+ * @property {function} exec Excecute request
823
+ */
824
+
825
+ /**
826
+ * @typedef {Object} PostEntriesRequest
827
+ * @property {(shopId: Integer) => PostEntriesRequest} shopId Shop Id
828
+ * @property {(date: String) => PostEntriesRequest} date Date of creating an entry
829
+ * @property {(visible: 'y'|'n') => PostEntriesRequest} visible Entry visibility
830
+ * @property {(visibleOnSitesList: Array<Object>) => PostEntriesRequest} visibleOnSitesList List of pages on which the entry is to be published
831
+ * @property {(products: Array<Object>) => PostEntriesRequest} products Products list.
832
+ * @property {(pictureData: Object) => PostEntriesRequest} pictureData Photo
833
+ * @property {(langs: Array<Object>) => PostEntriesRequest} langs Element including entry content in selected languages
834
+ * @property {(titleLinkType: 'fullContentLink'|'givenUrlLink'|'noLink') => PostEntriesRequest} titleLinkType Type of title and shortcut linking: fullContentLink - link to the subpage with full content, givenUrlLink - link to the given URL, noLink - static element
835
+ * @property {(link: String) => PostEntriesRequest} link Provided URL (for link to specified URL option)
836
+ * @property {(langId: String) => PostEntriesRequest} langId Language ID
837
+ * @property {(title: String) => PostEntriesRequest} title Name on the page
838
+ * @property {(shortDescription: String) => PostEntriesRequest} shortDescription short description
839
+ * @property {(longDescription: String) => PostEntriesRequest} longDescription Long description
840
+ * @property {(blogUrl: String) => PostEntriesRequest} blogUrl Blog post URL
841
+ * @property {(newsUrl: String) => PostEntriesRequest} newsUrl News item URL
842
+ * @property {function} append Append current data to array and start modifying next row
843
+ * @property {function} exec Excecute request
844
+ */
845
+
846
+ /**
847
+ * @typedef {Object} PutEntriesRequest
848
+ * @property {(entryId: Integer) => PutEntriesRequest} entryId Entry ID
849
+ * @property {(shopId: Integer) => PutEntriesRequest} shopId Shop Id
850
+ * @property {(date: String) => PutEntriesRequest} date Date of creating an entry
851
+ * @property {(visible: 'y'|'n') => PutEntriesRequest} visible Entry visibility
852
+ * @property {(visibleOnSitesList: Array<Object>) => PutEntriesRequest} visibleOnSitesList List of pages on which the entry is to be published
853
+ * @property {(products: Array<Object>) => PutEntriesRequest} products Products list.
854
+ * @property {(pictureData: Object) => PutEntriesRequest} pictureData Photo
855
+ * @property {(deletePicture: 'y'|'n') => PutEntriesRequest} deletePicture Determines whether to delete an entry photo
856
+ * @property {(langs: Array<Object>) => PutEntriesRequest} langs Element including entry content in selected languages
857
+ * @property {(titleLinkType: 'fullContentLink'|'givenUrlLink'|'noLink') => PutEntriesRequest} titleLinkType Type of title and shortcut linking: fullContentLink - link to the subpage with full content, givenUrlLink - link to the given URL, noLink - static element
858
+ * @property {(link: String) => PutEntriesRequest} link Provided URL (for link to specified URL option)
859
+ * @property {function} exec Excecute request
860
+ */
861
+
862
+ /**
863
+ * @typedef {Object} GetEntriesPagesToDisplayRequest
864
+ * @property {(langId: String) => GetEntriesPagesToDisplayRequest} langId Language ID
865
+ * @property {function} exec Excecute request
866
+ */
867
+
868
+ /**
869
+ * @typedef {Object} GetMenuFilterRequest
870
+ * @property {(shopId: Integer) => GetMenuFilterRequest} shopId Shop Id
871
+ * @property {(languageId: String) => GetMenuFilterRequest} languageId Language ID (code in ISO 639-2).
872
+ * @property {(productMenuTreeId: Integer) => GetMenuFilterRequest} productMenuTreeId Tree menu ID.
873
+ * @property {(productMenuNodeId: Integer) => GetMenuFilterRequest} productMenuNodeId Menu element ID.
874
+ * @property {function} exec Excecute request
875
+ */
876
+
877
+ /**
878
+ * @typedef {Object} PutMenuFilterRequest
879
+ * @property {(shopId: Integer) => PutMenuFilterRequest} shopId Shop Id
880
+ * @property {(languageId: String) => PutMenuFilterRequest} languageId Language ID (code in ISO 639-2).
881
+ * @property {(productMenuTreeId: Integer) => PutMenuFilterRequest} productMenuTreeId Tree menu ID.
882
+ * @property {(productMenuNodeId: Integer) => PutMenuFilterRequest} productMenuNodeId Menu element ID.
883
+ * @property {(filterForMenuNodeIsDefault: 'y'|'n') => PutMenuFilterRequest} filterForMenuNodeIsDefault Default filter settings.
884
+ * @property {(menuFiltersActive: Array<Object>) => PutMenuFilterRequest} menuFiltersActive Active filters.
885
+ * @property {(menuFilterId: String) => PutMenuFilterRequest} menuFilterId Menu filter ID.
886
+ * @property {(menuFilterName: String) => PutMenuFilterRequest} menuFilterName Filter name on page.
887
+ * @property {(menuFilterDisplay: 'name'|'gfx'|'namegfx') => PutMenuFilterRequest} menuFilterDisplay Display as: "name" - text, "gfx" - graphics, "namegfx" - text and graphics.
888
+ * @property {(menuFilterValueSort: 'y'|'n'|'priority') => PutMenuFilterRequest} menuFilterValueSort Sort by: "y" - alfabetically, "n" - by frequency and order of occurrence of indicated parameter value in found products, "priority" - according to value sequence in parameter.
889
+ * @property {(menuFilterDefaultEnabled: 'y'|'n') => PutMenuFilterRequest} menuFilterDefaultEnabled Enabled by default .
890
+ * @property {function} append Append current data to array and start modifying next row
891
+ * @property {function} exec Excecute request
892
+ */
893
+
894
+ /**
895
+ * @typedef {Object} DeleteMenuRequest
896
+ * @property {(menu_list: Array<Object>) => DeleteMenuRequest} menu_list
897
+ * @property {(settings: Object) => DeleteMenuRequest} settings Settings.
898
+ * @property {(shop_id: Integer) => DeleteMenuRequest} shop_id Shop Id.
899
+ * @property {(menu_id: Integer) => DeleteMenuRequest} menu_id Menu ID.
900
+ * @property {(item_id: Integer) => DeleteMenuRequest} item_id Menu element ID.
901
+ * @property {(item_textid: String) => DeleteMenuRequest} item_textid Menu element text identifier. Example: "item1\item2\item3".
902
+ * @property {function} append Append current data to array and start modifying next row
903
+ * @property {function} exec Excecute request
904
+ */
905
+
906
+ /**
907
+ * @typedef {Object} GetMenuRequest
908
+ * @property {(shop_id: Integer) => GetMenuRequest} shop_id Shop Id.
909
+ * @property {(menu_id: Integer) => GetMenuRequest} menu_id Tree menu ID.
910
+ * @property {(lang_id: String) => GetMenuRequest} lang_id Language ID.
911
+ * @property {(node_id: Integer) => GetMenuRequest} node_id Menu node ID.
912
+ * @property {(level: Integer) => GetMenuRequest} level Number of levels.
913
+ * @property {(settings::textid_separator: String) => GetMenuRequest} settings::textid_separator Default: "\".
914
+ * @property {function} exec Excecute request
915
+ */
916
+
917
+ /**
918
+ * @typedef {Object} PostMenuRequest
919
+ * @property {(menu_list: Array<Object>) => PostMenuRequest} menu_list
920
+ * @property {(settings: Object) => PostMenuRequest} settings Settings
921
+ * @property {(shop_id: Integer) => PostMenuRequest} shop_id Shop Id.
922
+ * @property {(menu_id: Integer) => PostMenuRequest} menu_id Menu ID.
923
+ * @property {(parent_id: String) => PostMenuRequest} parent_id Parent menu element ID.
924
+ * @property {(parent_textid: String) => PostMenuRequest} parent_textid Menu element text identifier. Example: "item1\item2".
925
+ * @property {(lang_data: Array<Object>) => PostMenuRequest} lang_data
926
+ * @property {function} append Append current data to array and start modifying next row
927
+ * @property {function} exec Excecute request
928
+ */
929
+
930
+ /**
931
+ * @typedef {Object} PutMenuRequest
932
+ * @property {(menu_list: Array<Object>) => PutMenuRequest} menu_list
933
+ * @property {(settings: Object) => PutMenuRequest} settings Settings.
934
+ * @property {(shop_id: Integer) => PutMenuRequest} shop_id Shop Id.
935
+ * @property {(menu_id: Integer) => PutMenuRequest} menu_id Menu ID.
936
+ * @property {(item_id: String) => PutMenuRequest} item_id Menu element ID.
937
+ * @property {(item_textid: String) => PutMenuRequest} item_textid Menu element text identifier. Example: "item1\item2\item3".
938
+ * @property {(lang_data: Array<Object>) => PutMenuRequest} lang_data
939
+ * @property {function} append Append current data to array and start modifying next row
940
+ * @property {function} exec Excecute request
941
+ */
942
+
943
+ /**
944
+ * @typedef {Object} PutMenuSortRequest
945
+ * @property {(menu_list: Array<Object>) => PutMenuSortRequest} menu_list
946
+ * @property {(settings: Object) => PutMenuSortRequest} settings Settings
947
+ * @property {(shop_id: Integer) => PutMenuSortRequest} shop_id Shop Id.
948
+ * @property {(menu_id: Integer) => PutMenuSortRequest} menu_id Menu ID.
949
+ * @property {(lang_id: String) => PutMenuSortRequest} lang_id Language ID.
950
+ * @property {(parent_id: Integer) => PutMenuSortRequest} parent_id Menu element text identifier.
951
+ * @property {(parent_textid: String) => PutMenuSortRequest} parent_textid Menu element text identifier. Example: "item1\item2\item3".
952
+ * @property {(recursive: 'y'|'n') => PutMenuSortRequest} recursive Recurring: y/n!
953
+ * @property {function} append Append current data to array and start modifying next row
954
+ * @property {function} exec Excecute request
955
+ */
956
+
957
+ /**
958
+ * @typedef {Object} GetOrdersAnalyticsRequest
959
+ * @property {(orders: Array<Object>) => GetOrdersAnalyticsRequest} orders Orders.
960
+ * @property {(serialNumbers: Array<Integer>) => GetOrdersAnalyticsRequest} serialNumbers Define orders by passing array of values
961
+ * @property {function} exec Excecute request
962
+ */
963
+
964
+ /**
965
+ * @typedef {Object} GetOrdersAuctionDetailsRequest
966
+ * @property {(orders: Array<Object>) => GetOrdersAuctionDetailsRequest} orders Orders.
967
+ * @property {(ids: Array<String>) => GetOrdersAuctionDetailsRequest} ids Define orders by passing array of values
968
+ * @property {(serialNumbers: Array<Integer>) => GetOrdersAuctionDetailsRequest} serialNumbers Define orders by passing array of values
969
+ * @property {function} exec Excecute request
970
+ */
971
+
972
+ /**
973
+ * @typedef {Object} PutOrdersClientRequest
974
+ * @property {(orderSerialNumber: Integer) => PutOrdersClientRequest} orderSerialNumber Order serial number.
975
+ * @property {(clientId: Integer) => PutOrdersClientRequest} clientId Unique client's number.
976
+ * @property {function} exec Excecute request
977
+ */
978
+
979
+ /**
980
+ * @typedef {Object} PutOrdersCourierRequest
981
+ * @property {(orderSerialNumber: Integer) => PutOrdersCourierRequest} orderSerialNumber Order serial number.
982
+ * @property {(courierId: Integer) => PutOrdersCourierRequest} courierId Courier ID.
983
+ * @property {(pickupPointId: String) => PutOrdersCourierRequest} pickupPointId Collection point ID.
984
+ * @property {function} exec Excecute request
985
+ */
986
+
987
+ /**
988
+ * @typedef {Object} PutOrdersDeliveryAddressRequest
989
+ * @property {(orderSerialNumber: Integer) => PutOrdersDeliveryAddressRequest} orderSerialNumber Order serial number.
990
+ * @property {(clientDeliveryAddressId: Integer) => PutOrdersDeliveryAddressRequest} clientDeliveryAddressId Delivery address ID.
991
+ * @property {(clientLogin: String) => PutOrdersDeliveryAddressRequest} clientLogin Customer's login.
992
+ * @property {function} exec Excecute request
993
+ */
994
+
995
+ /**
996
+ * @typedef {Object} PutOrdersDevideRequest
997
+ * @property {(orderSerialNumber: Integer) => PutOrdersDevideRequest} orderSerialNumber Order serial number.
998
+ * @property {(products: Array<Object>) => PutOrdersDevideRequest} products Products list.
999
+ * @property {(splitPayments: Boolean) => PutOrdersDevideRequest} splitPayments Whether to split payments
1000
+ * @property {(basketPosition: Integer) => PutOrdersDevideRequest} basketPosition Item in basket.
1001
+ * @property {(quantity: Number) => PutOrdersDevideRequest} quantity Quantity
1002
+ * @property {function} append Append current data to array and start modifying next row
1003
+ * @property {function} exec Excecute request
1004
+ */
1005
+
1006
+ /**
1007
+ * @typedef {Object} DeleteOrdersDocumentsRequest
1008
+ * @property {(documents: Array<Object>) => DeleteOrdersDocumentsRequest} documents List of documents.
1009
+ * @property {(orderSerialNumber: Integer) => DeleteOrdersDocumentsRequest} orderSerialNumber Order serial number.
1010
+ * @property {(id: Integer) => DeleteOrdersDocumentsRequest} id Document identifier.
1011
+ * @property {function} append Append current data to array and start modifying next row
1012
+ * @property {function} exec Excecute request
1013
+ */
1014
+
1015
+ /**
1016
+ * @typedef {Object} GetOrdersDocumentsRequest
1017
+ * @property {(orderSerialNumber: Array<String>) => GetOrdersDocumentsRequest} orderSerialNumber Order serial number.
1018
+ * @property {(documentType: 'sales_confirmation'|'vat_invoice'|'corrective_vat_invoice'|'advance_vat_invoice'|'final_advance_vat_invoice'|'pro_forma_invoice'|'advance_pro_forma_invoice'|'final_advance_pro_forma_invoice'|'delivery_note'|'fiscal_receipt'|'fiscal_invoice'|'other') => GetOrdersDocumentsRequest} documentType Document type
1019
+ * @property {function} exec Excecute request
1020
+ */
1021
+
1022
+ /**
1023
+ * @typedef {Object} PostOrdersDocumentsRequest
1024
+ * @property {(documents: Array<Object>) => PostOrdersDocumentsRequest} documents List of documents.
1025
+ * @property {(orderSerialNumber: Integer) => PostOrdersDocumentsRequest} orderSerialNumber Order serial number.
1026
+ * @property {(name: String) => PostOrdersDocumentsRequest} name File name.
1027
+ * @property {(pdfBase64: String) => PostOrdersDocumentsRequest} pdfBase64 BMP, PNG, JPG, JPEG, GIF or PDF files in Base64 encoding algorithm.
1028
+ * @property {(type: 'vat_invoice'|'corrective_vat_invoice'|'other') => PostOrdersDocumentsRequest} type Document type.
1029
+ * @property {(returnedInOrderDetails: 'y'|'n') => PostOrdersDocumentsRequest} returnedInOrderDetails Is it to be shown to the customer in the order view.
1030
+ * @property {(additionalData: Object) => PostOrdersDocumentsRequest} additionalData Additional information.
1031
+ * @property {function} append Append current data to array and start modifying next row
1032
+ * @property {function} exec Excecute request
1033
+ */
1034
+
1035
+ /**
1036
+ * @typedef {Object} GetOrdersExportdocumentsEPPRequest
1037
+ * @property {(dateBegin: String) => GetOrdersExportdocumentsEPPRequest} dateBegin Beginning date in YYYY-MM-DD HH:MM:SS format.
1038
+ * @property {(dateEnd: String) => GetOrdersExportdocumentsEPPRequest} dateEnd Ending date in YYYY-MM-DD HH:MM:SS format.
1039
+ * @property {(applicationType: 'SubiektGT'|'Rachmistrz'|'wFirma') => GetOrdersExportdocumentsEPPRequest} applicationType
1040
+ * @property {(stocks: Array<Integer>) => GetOrdersExportdocumentsEPPRequest} stocks Stock ID (required only when selecting particular stocks).
1041
+ * @property {(documentType: 'all'|'stocks'|'invoice'|'payments') => GetOrdersExportdocumentsEPPRequest} documentType Document type
1042
+ * @property {(invoiceFirstGeneratedDate: Integer) => GetOrdersExportdocumentsEPPRequest} invoiceFirstGeneratedDate Date the document was first generated.
1043
+ * @property {(dateFrom: DateLike, dateTo: DateLike) => GetOrdersExportdocumentsEPPRequest} dates Type of date according to the index results
1044
+ * @property {function} exec Excecute request
1045
+ */
1046
+
1047
+ /**
1048
+ * @typedef {Object} GetOrdersExportdocumentsJPKRequest
1049
+ * @property {(documentType: 'JPK_FA'|'JPK_MAG'|'JPK_VAT') => GetOrdersExportdocumentsJPKRequest} documentType Document type
1050
+ * @property {(fileId: Integer) => GetOrdersExportdocumentsJPKRequest} fileId JPK file identifier to download.
1051
+ * @property {(documentVersion: Integer) => GetOrdersExportdocumentsJPKRequest} documentVersion JPK format version. If empty, takes the latest version number.
1052
+ * @property {(schemaVersion: String) => GetOrdersExportdocumentsJPKRequest} schemaVersion Schema version
1053
+ * @property {(dateBegin: String) => GetOrdersExportdocumentsJPKRequest} dateBegin Beginning date in YYYY-MM-DD HH:MM:SS format. (JPK_FA, JPK_MAG)
1054
+ * @property {(dateEnd: String) => GetOrdersExportdocumentsJPKRequest} dateEnd Ending date in YYYY-MM-DD HH:MM:SS format. (JPK_FA, JPK_MAG)
1055
+ * @property {(month: Integer) => GetOrdersExportdocumentsJPKRequest} month Billing month for which to generate the document. (JPK_VAT)
1056
+ * @property {(year: Integer) => GetOrdersExportdocumentsJPKRequest} year Billing year for which to generate the document. (JPK_VAT)
1057
+ * @property {(currency: String) => GetOrdersExportdocumentsJPKRequest} currency Currency symbol in ISO 4217 format.
1058
+ * @property {(shop: Array<Integer>) => GetOrdersExportdocumentsJPKRequest} shop Store ID only required if a specific store is selected.
1059
+ * @property {(stockId: Array<Integer>) => GetOrdersExportdocumentsJPKRequest} stockId Stock ID
1060
+ * @property {(forceBackgroundGenerate: Boolean) => GetOrdersExportdocumentsJPKRequest} forceBackgroundGenerate Forces the file to be generated by background tasks. The file will be generated later. Then, after it is generated, you will be able to download the given file using the returned ID. The file will be available 24h after the task is completed.
1061
+ * @property {(dateFrom: DateLike, dateTo: DateLike) => GetOrdersExportdocumentsJPKRequest} dates Type of date according to the index results
1062
+ * @property {function} exec Excecute request
1063
+ */
1064
+
1065
+ /**
1066
+ * @typedef {Object} GetOrdersHandlerRequest
1067
+ * @property {(orderSerialNumber: Integer) => GetOrdersHandlerRequest} orderSerialNumber Order serial number.
1068
+ * @property {function} exec Excecute request
1069
+ */
1070
+
1071
+ /**
1072
+ * @typedef {Object} PutOrdersHandlerRequest
1073
+ * @property {(orderSerialNumber: Integer) => PutOrdersHandlerRequest} orderSerialNumber Order serial number.
1074
+ * @property {(orderOperatorLogin: String) => PutOrdersHandlerRequest} orderOperatorLogin Order handler.
1075
+ * @property {function} exec Excecute request
1076
+ */
1077
+
1078
+ /**
1079
+ * @typedef {Object} GetOrdersHistoryRequest
1080
+ * @property {(orderSerialNumber: Integer) => GetOrdersHistoryRequest} orderSerialNumber Order serial number.
1081
+ * @property {function} exec Excecute request
1082
+ */
1083
+
1084
+ /**
1085
+ * @typedef {Object} DeleteOrdersImagesRequest
1086
+ * @property {(order: Object) => DeleteOrdersImagesRequest} order
1087
+ * @property {(images: Array<Object>) => DeleteOrdersImagesRequest} images List of attachment IDs to be removed from the details of the selected order
1088
+ * @property {(id: Integer) => DeleteOrdersImagesRequest} id Attachment ID
1089
+ * @property {function} append Append current data to array and start modifying next row
1090
+ * @property {function} exec Excecute request
1091
+ */
1092
+
1093
+ /**
1094
+ * @typedef {Object} GetOrdersImagesRequest
1095
+ * @property {(imageId: Integer) => GetOrdersImagesRequest} imageId Attachment ID (Photos)
1096
+ * @property {(orderSerialNumber: Integer) => GetOrdersImagesRequest} orderSerialNumber Order serial number
1097
+ * @property {function} exec Excecute request
1098
+ */
1099
+
1100
+ /**
1101
+ * @typedef {Object} PostOrdersImagesRequest
1102
+ * @property {(userName: String) => PostOrdersImagesRequest} userName Login
1103
+ * @property {(settings: Object) => PostOrdersImagesRequest} settings
1104
+ * @property {(order: Object) => PostOrdersImagesRequest} order
1105
+ * @property {(images: Array<Object>) => PostOrdersImagesRequest} images List of image attachments
1106
+ * @property {(type: 'product'|'package') => PostOrdersImagesRequest} type Type. Available values: product - Product photo, package - Package photo
1107
+ * @property {(source: String) => PostOrdersImagesRequest} source Attachment source data, depending on the source type selected in the settings. BMP, PNG, JPG, JPEG, GIF or PDF files in Base64 encoding algorithm.
1108
+ * @property {(name: String) => PostOrdersImagesRequest} name Name
1109
+ * @property {function} append Append current data to array and start modifying next row
1110
+ * @property {function} exec Excecute request
1111
+ */
1112
+
1113
+ /**
1114
+ * @typedef {Object} GetOrdersLabelsRequest
1115
+ * @property {(orderSerialNumber: Integer) => GetOrdersLabelsRequest} orderSerialNumber Order serial number.
1116
+ * @property {function} exec Excecute request
1117
+ */
1118
+
1119
+ /**
1120
+ * @typedef {Object} GetOrdersOpinionsRequest
1121
+ * @property {(opinion: Object) => GetOrdersOpinionsRequest} opinion Review identification
1122
+ * @property {(orders: Object) => GetOrdersOpinionsRequest} orders Orders.
1123
+ * @property {(clients: Object) => GetOrdersOpinionsRequest} clients Customer data.
1124
+ * @property {(dateRange: Object) => GetOrdersOpinionsRequest} dateRange Date range
1125
+ * @property {(resultsPage: Integer) => GetOrdersOpinionsRequest} resultsPage Page with results number. Numeration starts from 0
1126
+ * @property {(resultsLimit: Integer) => GetOrdersOpinionsRequest} resultsLimit Number of results on page. Value from 1 to 100
1127
+ * @property {(ordersBy: Array<Object>) => GetOrdersOpinionsRequest} ordersBy Possibility of sorting returned list
1128
+ * @property {(orderId: String) => GetOrdersOpinionsRequest} orderId Define value value nested inside orders
1129
+ * @property {(orderSerialNumber: String) => GetOrdersOpinionsRequest} orderSerialNumber Define value value nested inside orders
1130
+ * @property {(clientId: String) => GetOrdersOpinionsRequest} clientId Define value value nested inside clients
1131
+ * @property {(clientLogin: String) => GetOrdersOpinionsRequest} clientLogin Define value value nested inside clients
1132
+ * @property {(clientCode: String) => GetOrdersOpinionsRequest} clientCode Define value value nested inside clients
1133
+ * @property {(dateFrom: DateLike, dateTo: DateLike) => GetOrdersOpinionsRequest} dates Type of date according to the index results
1134
+ * @property {(elementName: "date"|"rating"|"scorePositive"|"scoreNegative"|"modificationDatetime", descending: Boolean) => GetOrdersOpinionsRequest} orderBy Define sorting by element and direction
1135
+ * @property {(page: Integer, limit: Integer) => GetOrdersOpinionsRequest} page Define page number and maximum results per page
1136
+ * @property {() => Integer} count Returns total numer of results
1137
+ * @property {function} exec Excecute request
1138
+ */
1139
+
1140
+ /**
1141
+ * @typedef {Object} GetOrdersOpinionsRateRequest
1142
+ * @property {(id: Integer) => GetOrdersOpinionsRateRequest} id
1143
+ * @property {(operation: 'positive'|'negative') => GetOrdersOpinionsRateRequest} operation
1144
+ * @property {function} exec Excecute request
1145
+ */
1146
+
1147
+ /**
1148
+ * @typedef {Object} ListOrdersRequest
1149
+ * @property {(orderPrepaidStatus: String) => ListOrdersRequest} orderPrepaidStatus Prepayment status. Status list: "unpaid" - not paid, "restored" - returned, "waiting" - not registered.
1150
+ * @property {(ordersStatuses: Array<String>) => ListOrdersRequest} ordersStatuses Order status. Status list: "new" - not handled, "finished" - completed, "false" - false, "lost" - lost, "on_order" - in progress, "packed" - being picked, "ready" - ready, "returned" - return, "canceled" - canceled by customer, "complainted" - complaint, "payment_waiting" - awaiting payment, "delivery_waiting" - awaiting delivery, "suspended" - on hold, "joined" - merged, "finished_ext" - handled in FA application.
1151
+ * @property {(shippmentStatus: 'all'|'received'|'non-received') => ListOrdersRequest} shippmentStatus
1152
+ * @property {(couriersName: Array<String>) => ListOrdersRequest} couriersName Shipping companies (packages deliverers).
1153
+ * @property {(couriersId: Array<Integer>) => ListOrdersRequest} couriersId Courier service identifiers
1154
+ * @property {(orderPaymentType: String) => ListOrdersRequest} orderPaymentType Order payment method. Allowed values. "cash_on_delivery" - cash on delivery, "prepaid" - prepayment, "tradecredit" - Trade credit.
1155
+ * @property {(withMissingSalesDocuments: Array<String>) => ListOrdersRequest} withMissingSalesDocuments
1156
+ * @property {(orderType: 'wholesale'|'retail'|'dropshipping'|'deliverer') => ListOrdersRequest} orderType Order type. Allowed values. "retail" - retail order, "wholesale" - wholesale order (can be added only by customer with wholesale account registered). Default value:: "retail"
1157
+ * @property {(dropshippingOrderStatus: 'all'|'finished'|'canceled'|'notCanceled') => ListOrdersRequest} dropshippingOrderStatus
1158
+ * @property {(ordersIds: Array<String>) => ListOrdersRequest} ordersIds Orders IDs.
1159
+ * @property {(ordersSerialNumbers: Array<Integer>) => ListOrdersRequest} ordersSerialNumbers Order serial numbers.
1160
+ * @property {(clients: Array<Object>) => ListOrdersRequest} clients Customer data.
1161
+ * @property {(ordersRange: Object) => ListOrdersRequest} ordersRange Ranges of dates or serial numbers.
1162
+ * @property {(orderSource: Object) => ListOrdersRequest} orderSource Order source data.
1163
+ * @property {(products: Array<Object>) => ListOrdersRequest} products Products list.
1164
+ * @property {(resultsPage: Integer) => ListOrdersRequest} resultsPage Page with results number. Numeration starts from 0
1165
+ * @property {(resultsLimit: Integer) => ListOrdersRequest} resultsLimit Number of results on page. Value from 1 to 100
1166
+ * @property {(clientRequestInvoice: String) => ListOrdersRequest} clientRequestInvoice Customer asked for invoice. List of parameters: "y" - yes (paper invoicing ), "e" - yes (electronic invoicing ), "n" - no.
1167
+ * @property {(packages: Object) => ListOrdersRequest} packages Information on consignments.
1168
+ * @property {(stocks: Array<Object>) => ListOrdersRequest} stocks Stock quantities data.
1169
+ * @property {(campaign: Object) => ListOrdersRequest} campaign Used discount codes data.
1170
+ * @property {(loyaltyPointsMode: 'all'|'given'|'taken'|'given_or_taken'|'given_and_taken'|'not_given_nor_taken') => ListOrdersRequest} loyaltyPointsMode Loyalty points.
1171
+ * @property {(orderOperatorLogin: String) => ListOrdersRequest} orderOperatorLogin Order handler.
1172
+ * @property {(orderPackingPersonLogin: String) => ListOrdersRequest} orderPackingPersonLogin Order picker.
1173
+ * @property {(ordersBy: Array<Object>) => ListOrdersRequest} ordersBy Possibility of sorting returned list
1174
+ * @property {(searchingOperatorTypeMatch: 'no_assignment'|'no_empty'|'empty') => ListOrdersRequest} searchingOperatorTypeMatch Method of searching orders by handler.
1175
+ * @property {(ordersDelayed: 'y'|'n') => ListOrdersRequest} ordersDelayed Orders with the exceeded date of shipment.
1176
+ * @property {(showBundles: Boolean) => ListOrdersRequest} showBundles Combine the components of the set into one item
1177
+ * @property {(orderExternalId: String) => ListOrdersRequest} orderExternalId The order ID of the external service
1178
+ * @property {(shopIds: Array<Integer>) => ListOrdersRequest} shopIds Define shopsIds value nested inside orderSource
1179
+ * @property {(byPackageNumbers: Array<String>) => ListOrdersRequest} byPackageNumbers Define packagesNumbers value nested inside packages
1180
+ * @property {(dateFrom: DateLike, dateTo: DateLike, dateType: "add"|"modified"|"dispatch"|"payment"|"last_payments_operation"|"declared_payments") => ListOrdersRequest} dates Type of date according to the index results. Possible type values: add, modified, dispatch, payment, last_payments_operation, declared_payments
1181
+ * @property {(elementName: "id"|"sn"|"order_time"|"status"|"order_source"|"order_cost"|"discount_code"|"ready_to_send_date", descending: Boolean) => ListOrdersRequest} orderBy Define sorting by element and direction
1182
+ * @property {(logins: Array<String>) => ListOrdersRequest} logins Define clients by passing array of values
1183
+ * @property {(clientIds: Array<String>) => ListOrdersRequest} clientIds Define clients by passing array of values
1184
+ * @property {(productIds: Array<Integer>) => ListOrdersRequest} productIds Define products by passing array of values
1185
+ * @property {(stockIds: Array<Integer>) => ListOrdersRequest} stockIds Define stocks by passing array of values
1186
+ * @property {(campaignIds: Array<Integer>) => ListOrdersRequest} campaignIds Define campaign by passing array of values
1187
+ * @property {(discountCodes: Array<String>) => ListOrdersRequest} discountCodes Define campaign by passing array of values
1188
+ * @property {(productId: Integer, sizeId: String|null) => ListProductsRequest} hasProduct Filter by product ID and optionally product size
1189
+ * @property {(orderHasPackage: Boolean) => ListProductsRequest} hasPackage Filter by orders that have any package number
1190
+ * @property {(page: Integer, limit: Integer) => ListOrdersRequest} page Define page number and maximum results per page
1191
+ * @property {() => Integer} count Returns total numer of results
1192
+ * @property {function} exec Excecute request
1193
+ */
1194
+
1195
+ /**
1196
+ * @typedef {Object} GetOrdersRequest
1197
+ * @property {(ordersIds: Array<String>) => GetOrdersRequest} ordersIds Orders IDs.
1198
+ * @property {(ordersSerialNumbers: Array<Integer>) => GetOrdersRequest} ordersSerialNumbers Order serial numbers. You can transfer a maximum of 100 items.
1199
+ * @property {(orderExternalId: String) => GetOrdersRequest} orderExternalId The order ID of the external service. You can transfer a maximum of 100 items in one request.
1200
+ * @property {function} exec Excecute request
1201
+ */
1202
+
1203
+ /**
1204
+ * @typedef {Object} PostOrdersRequest
1205
+ * @property {(orders: Array<Object>) => PostOrdersRequest} orders Orders.
1206
+ * @property {(orderType: String) => PostOrdersRequest} orderType Order type. Allowed values. "retail" - retail order, "wholesale" - wholesale order (can be added only by customer with wholesale account registered). Default value:: "retail"
1207
+ * @property {(shopId: Integer) => PostOrdersRequest} shopId Shop Id
1208
+ * @property {(stockId: Integer) => PostOrdersRequest} stockId Stock ID
1209
+ * @property {(orderPaymentType: 'cash_on_delivery'|'prepaid'|'tradecredit') => PostOrdersRequest} orderPaymentType Order payment method. Allowed values. "cash_on_delivery" - cash on delivery, "prepaid" - prepayment, "tradecredit" - Trade credit.
1210
+ * @property {(currencyId: String) => PostOrdersRequest} currencyId Currency ID
1211
+ * @property {(clientWithoutAccount: String) => PostOrdersRequest} clientWithoutAccount Determines if customer unregistered. Allowed values. "y" - casual client, "n" - registered customer. Default value:: "y". If customer is unregistered, enter customer details in element: "clientWithoutAccountData". For client with account - existing login should be stored in: "clientLogin".
1212
+ * @property {(clientWithoutAccountData: Object) => PostOrdersRequest} clientWithoutAccountData Balance data for casual client. Object is necessary for casual clients (in case of client_once has y value).
1213
+ * @property {(clientLogin: String) => PostOrdersRequest} clientLogin Customer's login.
1214
+ * @property {(clientNoteToOrder: String) => PostOrdersRequest} clientNoteToOrder Customer comments on order.
1215
+ * @property {(clientNoteToCourier: String) => PostOrdersRequest} clientNoteToCourier Customer remarks for courier.
1216
+ * @property {(affiliateId: Integer) => PostOrdersRequest} affiliateId ID of a partner who acquired a given customer.
1217
+ * @property {(courierId: Integer) => PostOrdersRequest} courierId Courier ID.
1218
+ * @property {(pickupPointId: String) => PostOrdersRequest} pickupPointId Collection point ID.
1219
+ * @property {(deliveryCost: Number) => PostOrdersRequest} deliveryCost Delivery cost.
1220
+ * @property {(clientDeliveryAddress: Object) => PostOrdersRequest} clientDeliveryAddress Delivery address data.
1221
+ * @property {(payerAddress: Object) => PostOrdersRequest} payerAddress Buyer's address data.
1222
+ * @property {(products: Array<Object>) => PostOrdersRequest} products Products list.
1223
+ * @property {(orderRebateValue: Number) => PostOrdersRequest} orderRebateValue Discount value.
1224
+ * @property {(orderOperatorLogin: String) => PostOrdersRequest} orderOperatorLogin Order handler.
1225
+ * @property {(ignoreBridge: Boolean) => PostOrdersRequest} ignoreBridge Omits collecting orders via IAI Bridge.
1226
+ * @property {(settings: Object) => PostOrdersRequest} settings Settings
1227
+ * @property {(orderSettledAtPrice: 'gross'|'net'|'net_without_VAT') => PostOrdersRequest} orderSettledAtPrice Settlement by prices. "gross" - gross, "net" - net, "net_without_VAT" - net without VAT.
1228
+ * @property {(clientRequestInvoice: String) => PostOrdersRequest} clientRequestInvoice Customer asked for invoice. List of parameters: "y" - yes (paper invoicing ), "e" - yes (electronic invoicing ), "n" - no.
1229
+ * @property {(billingCurrency: String) => PostOrdersRequest} billingCurrency Order settlement currency.
1230
+ * @property {(billingCurrencyRate: Number) => PostOrdersRequest} billingCurrencyRate Panel billing currency exchange rate in relation to billing currency in the shop .
1231
+ * @property {(purchaseDate: String) => PostOrdersRequest} purchaseDate Sale date. ISO 8602 format.
1232
+ * @property {function} append Append current data to array and start modifying next row
1233
+ * @property {function} exec Excecute request
1234
+ */
1235
+
1236
+ /**
1237
+ * @typedef {Object} PutOrdersRequest
1238
+ * @property {(orders: Array<Object>) => PutOrdersRequest} orders Orders.
1239
+ * @property {(orderId: String) => PutOrdersRequest} orderId Order ID.
1240
+ * @property {(orderSerialNumber: Integer) => PutOrdersRequest} orderSerialNumber Order serial number.
1241
+ * @property {(orderStatus: String) => PutOrdersRequest} orderStatus Order status. Allowed values: "finished_ext" - order status: completed in FA application, "finished" - completed, "new" - not handled, "complainted" - complaint, "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, "returned" - return, "wait_for_dispatch" - awaiting dispatch date, "suspended" - on hold, "joined" - merged, "missing" - missing, "lost" - lost, "false" - false, "canceled" - Customer canceled.
1242
+ * @property {(apiFlag: 'none'|'registered'|'realized'|'registered_pos'|'realized_pos'|'registration_fault') => PutOrdersRequest} apiFlag 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.
1243
+ * @property {(apiNoteToOrder: String) => PutOrdersRequest} apiNoteToOrder API note added to order.
1244
+ * @property {(clientNoteToOrder: String) => PutOrdersRequest} clientNoteToOrder Customer comments on order.
1245
+ * @property {(clientNoteToCourier: String) => PutOrdersRequest} clientNoteToCourier Customer remarks for courier.
1246
+ * @property {(orderNote: String) => PutOrdersRequest} orderNote Note to the order.
1247
+ * @property {(products: Array<Object>) => PutOrdersRequest} products Products list.
1248
+ * @property {(orderPaymentType: 'cash_on_delivery'|'prepaid'|'tradecredit') => PutOrdersRequest} orderPaymentType Order payment method. Allowed values. "cash_on_delivery" - cash on delivery, "prepaid" - prepayment, "tradecredit" - Trade credit.
1249
+ * @property {(orderSettledAtPrice: 'gross'|'net'|'net_without_VAT') => PutOrdersRequest} orderSettledAtPrice Settlement by prices. "gross" - gross, "net" - net, "net_without_VAT" - net without VAT.
1250
+ * @property {(ignoreBridge: Boolean) => PutOrdersRequest} ignoreBridge Omits collecting orders via IAI Bridge.
1251
+ * @property {(settings: Object) => PutOrdersRequest} settings Settings
1252
+ * @property {(emailProcessingConsent: 'yes'|'no'|'disabled') => PutOrdersRequest} emailProcessingConsent Consent to send data to cooperating services
1253
+ * @property {(clientRequestInvoice: String) => PutOrdersRequest} clientRequestInvoice Customer asked for invoice. List of parameters: "y" - yes (paper invoicing ), "e" - yes (electronic invoicing ), "n" - no.
1254
+ * @property {(billingCurrency: String) => PutOrdersRequest} billingCurrency Order settlement currency.
1255
+ * @property {(billingCurrencyRate: Number) => PutOrdersRequest} billingCurrencyRate Panel billing currency exchange rate in relation to billing currency in the shop .
1256
+ * @property {(purchaseDate: String) => PutOrdersRequest} purchaseDate Sale date. ISO 8602 format.
1257
+ * @property {(estimatedDeliveryDate: String) => PutOrdersRequest} estimatedDeliveryDate Estimated date of shipment of the order.
1258
+ * @property {function} append Append current data to array and start modifying next row
1259
+ * @property {function} exec Excecute request
1260
+ */
1261
+
1262
+ /**
1263
+ * @typedef {Object} GetOrdersPackagesRequest
1264
+ * @property {(deliveryPackageNumbers: Array<String>) => GetOrdersPackagesRequest} deliveryPackageNumbers Consignments numbers.
1265
+ * @property {(orderNumbers: Array<Integer>) => GetOrdersPackagesRequest} orderNumbers Order serial numbers.
1266
+ * @property {(returnNumbers: Array<Integer>) => GetOrdersPackagesRequest} returnNumbers Returns numbers.
1267
+ * @property {(rmaNumbers: Array<Integer>) => GetOrdersPackagesRequest} rmaNumbers RMA numbers.
1268
+ * @property {(returnLabels: Boolean) => GetOrdersPackagesRequest} returnLabels Return parcel labels.
1269
+ * @property {function} exec Excecute request
1270
+ */
1271
+
1272
+ /**
1273
+ * @typedef {Object} PostOrdersPackagesRequest
1274
+ * @property {(orderPackages: Array<Object>) => PostOrdersPackagesRequest} orderPackages List of parcels assigned to the order Maximum default number: 100 parcels.
1275
+ * @property {(eventId: String) => PostOrdersPackagesRequest} eventId Id.
1276
+ * @property {(eventType: 'order'|'rma'|'return') => PostOrdersPackagesRequest} eventType Type.
1277
+ * @property {(packages: Array<Object>) => PostOrdersPackagesRequest} packages Information on consignments.
1278
+ * @property {function} append Append current data to array and start modifying next row
1279
+ * @property {function} exec Excecute request
1280
+ */
1281
+
1282
+ /**
1283
+ * @typedef {Object} PutOrdersPackagesRequest
1284
+ * @property {(orderPackages: Array<Object>) => PutOrdersPackagesRequest} orderPackages List of parcels assigned to the order Maximum default number: 100 parcels.
1285
+ * @property {(eventId: String) => PutOrdersPackagesRequest} eventId Id.
1286
+ * @property {(eventType: 'order'|'rma'|'return') => PutOrdersPackagesRequest} eventType Type.
1287
+ * @property {(packages: Array<Object>) => PutOrdersPackagesRequest} packages Information on consignments.
1288
+ * @property {function} append Append current data to array and start modifying next row
1289
+ * @property {function} exec Excecute request
1290
+ */
1291
+
1292
+ /**
1293
+ * @typedef {Object} PutOrdersPickupPointRequest
1294
+ * @property {(orderSerialNumber: Integer) => PutOrdersPickupPointRequest} orderSerialNumber Order serial number.
1295
+ * @property {(pickupPointId: String) => PutOrdersPickupPointRequest} pickupPointId Collection point ID.
1296
+ * @property {function} exec Excecute request
1297
+ */
1298
+
1299
+ /**
1300
+ * @typedef {Object} GetOrdersPrinterDocumentsRequest
1301
+ * @property {(user: String) => GetOrdersPrinterDocumentsRequest} user
1302
+ * @property {(printScenarioAction: String) => GetOrdersPrinterDocumentsRequest} printScenarioAction
1303
+ * @property {(objectNumber: String) => GetOrdersPrinterDocumentsRequest} objectNumber
1304
+ * @property {(objectType: String) => GetOrdersPrinterDocumentsRequest} objectType
1305
+ * @property {(printerAccessKey: String) => GetOrdersPrinterDocumentsRequest} printerAccessKey
1306
+ * @property {(skipNotGeneratedDocument: Boolean) => GetOrdersPrinterDocumentsRequest} skipNotGeneratedDocument
1307
+ * @property {function} exec Excecute request
1308
+ */
1309
+
1310
+ /**
1311
+ * @typedef {Object} PutOrdersProductsSerialNumbersRequest
1312
+ * @property {(orders: Array<Object>) => PutOrdersProductsSerialNumbersRequest} orders Orders.
1313
+ * @property {(orderSerialNumber: Integer) => PutOrdersProductsSerialNumbersRequest} orderSerialNumber Order serial number.
1314
+ * @property {(orderProducts: Array<Object>) => PutOrdersProductsSerialNumbersRequest} orderProducts Products list.
1315
+ * @property {function} append Append current data to array and start modifying next row
1316
+ * @property {function} exec Excecute request
1317
+ */
1318
+
1319
+ /**
1320
+ * @typedef {Object} PutOrdersProfitMarginRequest
1321
+ * @property {(orders: Array<Object>) => PutOrdersProfitMarginRequest} orders Orders.
1322
+ * @property {(orderSerialNumber: Integer) => PutOrdersProfitMarginRequest} orderSerialNumber Order serial number.
1323
+ * @property {(products: Array<Object>) => PutOrdersProfitMarginRequest} products Products list.
1324
+ * @property {(errors: Object) => PutOrdersProfitMarginRequest} errors Information on error that occurred during gate call.
1325
+ * @property {(isProductsErrors: Boolean) => PutOrdersProfitMarginRequest} isProductsErrors Flag marking errors in the result.
1326
+ * @property {function} append Append current data to array and start modifying next row
1327
+ * @property {function} exec Excecute request
1328
+ */
1329
+
1330
+ /**
1331
+ * @typedef {Object} GetOrdersProfitabilityRequest
1332
+ * @property {(orderSerialNumber: Integer) => GetOrdersProfitabilityRequest} orderSerialNumber Order serial number.
1333
+ * @property {function} exec Excecute request
1334
+ */
1335
+
1336
+ /**
1337
+ * @typedef {Object} PutOrdersShippingCostsRequest
1338
+ * @property {(orderSerialNumber: Integer) => PutOrdersShippingCostsRequest} orderSerialNumber Order serial number.
1339
+ * @property {(deliveryCost: Number) => PutOrdersShippingCostsRequest} deliveryCost Delivery cost.
1340
+ * @property {(orderDeliveryVat: Number) => PutOrdersShippingCostsRequest} orderDeliveryVat Delivery VAT.
1341
+ * @property {function} exec Excecute request
1342
+ */
1343
+
1344
+ /**
1345
+ * @typedef {Object} ListOrdersUnfinishedRequest
1346
+ * @property {(orderPrepaidStatus: String) => ListOrdersUnfinishedRequest} orderPrepaidStatus Prepayment status. Status list: "unpaid" - not paid, "restored" - returned, "waiting" - not registered.
1347
+ * @property {(ordersStatuses: Array<String>) => ListOrdersUnfinishedRequest} ordersStatuses Order status. Status list: "new" - not handled, "on_order" - in progress, "packed" - being picked, "packed_fulfillment" - being picked - fulfilment, "packed_ready" - packed, "ready" - ready, "payment_waiting" - awaiting payment, "delivery_waiting" - awaiting delivery, "wait_for_dispatch" - awaiting dispatch date, "suspended" - on hold, "finished_ext" - handled in FA application.
1348
+ * @property {(couriersName: Array<String>) => ListOrdersUnfinishedRequest} couriersName Shipping companies (packages deliverers).
1349
+ * @property {(orderPaymentType: String) => ListOrdersUnfinishedRequest} orderPaymentType Order payment method. Allowed values. "cash_on_delivery" - cash on delivery, "prepaid" - prepayment, "tradecredit" - Trade credit.
1350
+ * @property {(orderType: 'wholesale'|'retail'|'dropshipping'|'deliverer') => ListOrdersUnfinishedRequest} orderType Order type. Allowed values: "retail" - retail order, "wholesale" - whiolesale order , "dropshipping" - order to be handled, "deliverer" - order sent to the supplier.
1351
+ * @property {(dropshippingOrderStatus: 'all'|'finished'|'canceled'|'notCanceled') => ListOrdersUnfinishedRequest} dropshippingOrderStatus Dropshipping order status in the supplier's system. Allowed values: "all" - all, "finished" - sent, "canceled" - canceled, "notCanceled" - failed to cancel.
1352
+ * @property {(ordersIds: Array<String>) => ListOrdersUnfinishedRequest} ordersIds Orders IDs.
1353
+ * @property {(ordersSerialNumbers: Array<Integer>) => ListOrdersUnfinishedRequest} ordersSerialNumbers Order serial numbers.
1354
+ * @property {(clients: Array<Object>) => ListOrdersUnfinishedRequest} clients Customer data.
1355
+ * @property {(ordersRange: Object) => ListOrdersUnfinishedRequest} ordersRange Ranges of dates or serial numbers.
1356
+ * @property {(orderSource: Object) => ListOrdersUnfinishedRequest} orderSource Order source data.
1357
+ * @property {(products: Array<Object>) => ListOrdersUnfinishedRequest} products Products list.
1358
+ * @property {(resultsPage: Integer) => ListOrdersUnfinishedRequest} resultsPage Page with results number. Numeration starts from 0
1359
+ * @property {(resultsLimit: Integer) => ListOrdersUnfinishedRequest} resultsLimit Number of results on page. Value from 1 to 100
1360
+ * @property {(clientRequestInvoice: String) => ListOrdersUnfinishedRequest} clientRequestInvoice Customer asked for invoice. List of parameters: "invoice" - yes (paper invoicing ), "e_invoice" - yes (electronic invoicing ), "n" - no.
1361
+ * @property {(packages: Object) => ListOrdersUnfinishedRequest} packages Information on consignments.
1362
+ * @property {(stocks: Array<Object>) => ListOrdersUnfinishedRequest} stocks Stock quantities data.
1363
+ * @property {(campaign: Object) => ListOrdersUnfinishedRequest} campaign Used discount codes data.
1364
+ * @property {(loyaltyPointsMode: 'all'|'given'|'taken'|'given_or_taken'|'given_and_taken'|'not_given_nor_taken') => ListOrdersUnfinishedRequest} loyaltyPointsMode Loyalty points.
1365
+ * @property {(orderOperatorLogin: String) => ListOrdersUnfinishedRequest} orderOperatorLogin Order handler.
1366
+ * @property {(orderPackingPersonLogin: String) => ListOrdersUnfinishedRequest} orderPackingPersonLogin Order picker.
1367
+ * @property {(ordersBy: Array<Object>) => ListOrdersUnfinishedRequest} ordersBy Possibility of sorting returned list
1368
+ * @property {(searchingOperatorTypeMatch: 'no_assignment'|'no_empty'|'empty') => ListOrdersUnfinishedRequest} searchingOperatorTypeMatch Method of searching orders by handler.
1369
+ * @property {(ordersDelayed: 'y'|'n') => ListOrdersUnfinishedRequest} ordersDelayed Orders with the exceeded date of shipment.
1370
+ * @property {(elementName: "id"|"sn"|"order_time"|"status"|"order_source"|"order_cost"|"discount_code"|"ready_to_send_date", descending: Boolean) => ListOrdersUnfinishedRequest} orderBy Define sorting by element and direction
1371
+ * @property {(logins: Array<String>) => ListOrdersUnfinishedRequest} logins Define clients by passing array of values
1372
+ * @property {(clientIds: Array<String>) => ListOrdersUnfinishedRequest} clientIds Define clients by passing array of values
1373
+ * @property {(productIds: Array<Integer>) => ListOrdersUnfinishedRequest} productIds Define products by passing array of values
1374
+ * @property {(stockIds: Array<Integer>) => ListOrdersUnfinishedRequest} stockIds Define stocks by passing array of values
1375
+ * @property {(campaignIds: Array<Integer>) => ListOrdersUnfinishedRequest} campaignIds Define campaign by passing array of values
1376
+ * @property {(discountCodes: Array<String>) => ListOrdersUnfinishedRequest} discountCodes Define campaign by passing array of values
1377
+ * @property {(page: Integer, limit: Integer) => ListOrdersUnfinishedRequest} page Define page number and maximum results per page
1378
+ * @property {() => Integer} count Returns total numer of results
1379
+ * @property {function} exec Excecute request
1380
+ */
1381
+
1382
+ /**
1383
+ * @typedef {Object} GetOrdersWarehouseRequest
1384
+ * @property {(orderSerialNumber: Integer) => GetOrdersWarehouseRequest} orderSerialNumber Order serial number.
1385
+ * @property {function} exec Excecute request
1386
+ */
1387
+
1388
+ /**
1389
+ * @typedef {Object} PutOrdersWarehouseRequest
1390
+ * @property {(orderSerialNumber: Integer) => PutOrdersWarehouseRequest} orderSerialNumber Order serial number.
1391
+ * @property {(stockId: Integer) => PutOrdersWarehouseRequest} stockId Stock ID
1392
+ * @property {(orderOperatorLogin: String) => PutOrdersWarehouseRequest} orderOperatorLogin Order handler.
1393
+ * @property {(externalStockId: 'amazonde'|'amazones'|'amazonfr'|'amazonit'|'amazoncouk'|'amazonnl'|'amazonse'|'amazoncomtr'|'amazonae'|'amazonus'|'amazonpl') => PutOrdersWarehouseRequest} externalStockId External warehouse ID (if required)
1394
+ * @property {function} exec Excecute request
1395
+ */
1396
+
1397
+ /**
1398
+ * @typedef {Object} GetPackagesLabelsRequest
1399
+ * @property {(eventId: Integer) => GetPackagesLabelsRequest} eventId Id.
1400
+ * @property {(eventType: 'order'|'rma'|'return') => GetPackagesLabelsRequest} eventType Event type
1401
+ * @property {function} exec Excecute request
1402
+ */
1403
+
1404
+ /**
1405
+ * @typedef {Object} PostPackagesLabelsRequest
1406
+ * @property {(eventId: Integer) => PostPackagesLabelsRequest} eventId Id.
1407
+ * @property {(eventType: 'order'|'rma'|'return') => PostPackagesLabelsRequest} eventType Type.
1408
+ * @property {(parcelParameters: Array<Object>) => PostPackagesLabelsRequest} parcelParameters Shipment configuration options available for a given courier
1409
+ * @property {(parcelParametersByPackages: Array<Object>) => PostPackagesLabelsRequest} parcelParametersByPackages Shipment configuration options available for Inpost Smile courier
1410
+ * @property {(packageId: String) => PostPackagesLabelsRequest} packageId Package ID in system.
1411
+ * @property {(parcelParameters: Array<Object>) => PostPackagesLabelsRequest} parcelParameters Shipment configuration options available for a given courier
1412
+ * @property {function} append Append current data to array and start modifying next row
1413
+ * @property {function} exec Excecute request
1414
+ */
1415
+
1416
+ /**
1417
+ * @typedef {Object} GetPackagesRequest
1418
+ * @property {(deliveryPackageNumbers: Array<String>) => GetPackagesRequest} deliveryPackageNumbers Consignments numbers.
1419
+ * @property {(events: Array<Object>) => GetPackagesRequest} events Element, package is assigned to
1420
+ * @property {(returnLabels: Boolean) => GetPackagesRequest} returnLabels Return parcel labels.
1421
+ * @property {function} exec Excecute request
1422
+ */
1423
+
1424
+ /**
1425
+ * @typedef {Object} PostPackagesRequest
1426
+ * @property {(orderPackages: Array<Object>) => PostPackagesRequest} orderPackages List of parcels assigned to the order Maximum default number: 100 parcels.
1427
+ * @property {(orderId: String) => PostPackagesRequest} orderId Order ID.
1428
+ * @property {(orderType: 'order'|'rma'|'return') => PostPackagesRequest} orderType Order type. Allowed values. "retail" - retail order, "wholesale" - wholesale order (can be added only by customer with wholesale account registered). Default value:: "retail"
1429
+ * @property {(packages: Array<Object>) => PostPackagesRequest} packages Information on consignments.
1430
+ * @property {function} append Append current data to array and start modifying next row
1431
+ * @property {function} exec Excecute request
1432
+ */
1433
+
1434
+ /**
1435
+ * @typedef {Object} PutPackagesRequest
1436
+ * @property {(orderPackages: Array<Object>) => PutPackagesRequest} orderPackages List of parcels assigned to the order Maximum default number: 100 parcels.
1437
+ * @property {(orderId: String) => PutPackagesRequest} orderId Order ID.
1438
+ * @property {(orderType: 'order'|'rma'|'return') => PutPackagesRequest} orderType Order type. Allowed values. "retail" - retail order, "wholesale" - wholesale order (can be added only by customer with wholesale account registered). Default value:: "retail"
1439
+ * @property {(packages: Array<Object>) => PutPackagesRequest} packages Information on consignments.
1440
+ * @property {function} append Append current data to array and start modifying next row
1441
+ * @property {function} exec Excecute request
1442
+ */
1443
+
1444
+ /**
1445
+ * @typedef {Object} PostPaymentsCancelRequest
1446
+ * @property {(sourceType: 'order'|'return'|'rma') => PostPaymentsCancelRequest} sourceType Defines payment category. For the payments regarding returns, enter 'return'.
1447
+ * @property {(paymentNumber: String) => PostPaymentsCancelRequest} paymentNumber Payment number - [order no.]-[payment no.], i.e. 1234-1.
1448
+ * @property {function} exec Excecute request
1449
+ */
1450
+
1451
+ /**
1452
+ * @typedef {Object} PostPaymentsCashbackRequest
1453
+ * @property {(sourceType: 'order'|'return') => PostPaymentsCashbackRequest} sourceType
1454
+ * @property {(paymentNumber: String) => PostPaymentsCashbackRequest} paymentNumber Payment number - [order no.]-[payment no.], i.e. 1234-1.
1455
+ * @property {(value: Number) => PostPaymentsCashbackRequest} value Refund value.
1456
+ * @property {function} exec Excecute request
1457
+ */
1458
+
1459
+ /**
1460
+ * @typedef {Object} PutPaymentsConfirmRequest
1461
+ * @property {(sourceType: 'order'|'return'|'rma') => PutPaymentsConfirmRequest} sourceType Defines payment category. For the payments regarding returns, enter 'return'.
1462
+ * @property {(paymentNumber: String) => PutPaymentsConfirmRequest} paymentNumber Payment number - [order no.]-[payment no.], i.e. 1234-1.
1463
+ * @property {(accountingDate: String) => PutPaymentsConfirmRequest} accountingDate Registering date
1464
+ * @property {function} exec Excecute request
1465
+ */
1466
+
1467
+ /**
1468
+ * @typedef {Object} GetPaymentsFormsRequest
1469
+ * @property {(activeOnly: 'yes'|'no') => GetPaymentsFormsRequest} activeOnly Return only active forms of payment.
1470
+ * @property {function} exec Excecute request
1471
+ */
1472
+
1473
+ /**
1474
+ * @typedef {Object} GetPaymentsRequest
1475
+ * @property {(paymentNumber: String) => GetPaymentsRequest} paymentNumber Payment number consists of: source ID (order / return ID) and the payment ordinal number, e.g. 1234-1.
1476
+ * @property {(sourceType: 'order'|'return'|'rma') => GetPaymentsRequest} sourceType Source type.
1477
+ * @property {function} exec Excecute request
1478
+ */
1479
+
1480
+ /**
1481
+ * @typedef {Object} PostPaymentsRequest
1482
+ * @property {(sourceId: Integer) => PostPaymentsRequest} sourceId Source ID.
1483
+ * @property {(sourceType: 'order'|'return'|'rma') => PostPaymentsRequest} sourceType Source type.
1484
+ * @property {(value: Number) => PostPaymentsRequest} value Payment amount.
1485
+ * @property {(account: String) => PostPaymentsRequest} account Number of a bank account to which a payment is sent.
1486
+ * @property {(type: 'payment'|'advance'|'repayment'|'fee') => PostPaymentsRequest} type
1487
+ * @property {(paymentFormId: Integer) => PostPaymentsRequest} paymentFormId Form of payment ID.
1488
+ * @property {(paymentVoucherKey: String) => PostPaymentsRequest} paymentVoucherKey Gift card or voucher number
1489
+ * @property {(giftCardPIN: Integer) => PostPaymentsRequest} giftCardPIN Gift card PIN.
1490
+ * @property {(externalPaymentId: String) => PostPaymentsRequest} externalPaymentId Transaction ID in external service
1491
+ * @property {function} exec Excecute request
1492
+ */
1493
+
1494
+ /**
1495
+ * @typedef {Object} PutPaymentsRequest
1496
+ * @property {(sourceType: 'order'|'return'|'rma') => PutPaymentsRequest} sourceType Defines payment category. For the payments regarding returns, enter 'return'.
1497
+ * @property {(paymentNumber: String) => PutPaymentsRequest} paymentNumber Payment number - [order no.]-[payment no.], i.e. 1234-1.
1498
+ * @property {(paymentFormId: Integer) => PutPaymentsRequest} paymentFormId Payment method ID. Check getPaymentForms.
1499
+ * @property {(value: Number) => PutPaymentsRequest} value Refund value.
1500
+ * @property {(accountingDate: String) => PutPaymentsRequest} accountingDate Registering date.
1501
+ * @property {(account: String) => PutPaymentsRequest} account Number of a bank account to which a payment is sent.
1502
+ * @property {(clientAccount: String) => PutPaymentsRequest} clientAccount Data of customer account in store.
1503
+ * @property {(other: Object) => PutPaymentsRequest} other
1504
+ * @property {(externalPaymentId: String) => PutPaymentsRequest} externalPaymentId Transaction ID in external service
1505
+ * @property {function} exec Excecute request
1506
+ */
1507
+
1508
+ /**
1509
+ * @typedef {Object} GetPaymentsProfilesRequest
1510
+ * @property {(resultsPage: Integer) => GetPaymentsProfilesRequest} resultsPage Page with results number. Numeration starts from 0
1511
+ * @property {(resultsLimit: Integer) => GetPaymentsProfilesRequest} resultsLimit Number of results on page. Value from 1 to 100
1512
+ * @property {(page: Integer, limit: Integer) => GetPaymentsProfilesRequest} page Define page number and maximum results per page
1513
+ * @property {() => Integer} count Returns total numer of results
1514
+ * @property {function} exec Excecute request
1515
+ */
1516
+
1517
+ /**
1518
+ * @typedef {Object} PostPaymentsRepaymentRequest
1519
+ * @property {(source_id: Integer) => PostPaymentsRepaymentRequest} source_id Returns ID.
1520
+ * @property {(source_type: String) => PostPaymentsRepaymentRequest} source_type Defines payment category. For the payments regarding returns, enter 'return'.
1521
+ * @property {(value: Number) => PostPaymentsRepaymentRequest} value Refund value.
1522
+ * @property {(payment_form_id: Integer) => PostPaymentsRepaymentRequest} payment_form_id Payment method ID. Check getPaymentForms.
1523
+ * @property {(account: String) => PostPaymentsRepaymentRequest} account Number of a bank account to which a payment is sent.
1524
+ * @property {(client_account: String) => PostPaymentsRepaymentRequest} client_account Customer account.
1525
+ * @property {(other: Object) => PostPaymentsRepaymentRequest} other Other.
1526
+ * @property {function} exec Excecute request
1527
+ */
1528
+
1529
+ /**
1530
+ * @typedef {Object} GetProductsSKUbyBarcodeRequest
1531
+ * @property {(productIndices: Array<String>) => GetProductsSKUbyBarcodeRequest} productIndices List of sought products by indexes.
1532
+ * @property {(searchOnlyInCodeIai: Boolean) => GetProductsSKUbyBarcodeRequest} searchOnlyInCodeIai Search for products only by IAI code
1533
+ * @property {function} exec Excecute request
1534
+ */
1535
+
1536
+ /**
1537
+ * @typedef {Object} PutProductsAttachmentsRequest
1538
+ * @property {(productsAttachments: Array<Object>) => PutProductsAttachmentsRequest} productsAttachments
1539
+ * @property {(productIdent: Object) => PutProductsAttachmentsRequest} productIdent Stock keeping unit.
1540
+ * @property {(attachments: Array<Object>) => PutProductsAttachmentsRequest} attachments Product attachments list.
1541
+ * @property {(virtualAttachments: Array<Object>) => PutProductsAttachmentsRequest} virtualAttachments List of product's virtual attachments.
1542
+ * @property {(errors: Object) => PutProductsAttachmentsRequest} errors Information on error that occurred during gate call.
1543
+ * @property {(attachmentsErrorsOccurred: Boolean) => PutProductsAttachmentsRequest} attachmentsErrorsOccurred Flag indicating if there are errors in results of attachments settings.
1544
+ * @property {(virtualAttachmentsErrorsOccurred: Boolean) => PutProductsAttachmentsRequest} virtualAttachmentsErrorsOccurred Flag indicating if there are errors in results of virtual attachments settings.
1545
+ * @property {function} append Append current data to array and start modifying next row
1546
+ * @property {function} exec Excecute request
1547
+ */
1548
+
1549
+ /**
1550
+ * @typedef {Object} GetProductsAuctionsRequest
1551
+ * @property {(products: Array<Object>) => GetProductsAuctionsRequest} products Products list.
1552
+ * @property {(auctionSites: Array<String>) => GetProductsAuctionsRequest} auctionSites Array of auction site IDs
1553
+ * @property {(resultsPage: Integer) => GetProductsAuctionsRequest} resultsPage Page with results number. Numeration starts from 0
1554
+ * @property {(resultsLimit: Integer) => GetProductsAuctionsRequest} resultsLimit Number of results on page. Value from 1 to 100
1555
+ * @property {(ids: Array<Integer>) => GetProductsAuctionsRequest} ids Define products by passing array of values
1556
+ * @property {(page: Integer, limit: Integer) => GetProductsAuctionsRequest} page Define page number and maximum results per page
1557
+ * @property {() => Integer} count Returns total numer of results
1558
+ * @property {function} exec Excecute request
1559
+ */
1560
+
1561
+ /**
1562
+ * @typedef {Object} DeleteProductsBrandsRequest
1563
+ * @property {(ids: Array<Integer>) => DeleteProductsBrandsRequest} ids #!IdentyfikatoryProducentow!#
1564
+ * @property {function} exec Excecute request
1565
+ */
1566
+
1567
+ /**
1568
+ * @typedef {Object} GetProductsBrandsRequest
1569
+ * @property {(results_page: Integer) => GetProductsBrandsRequest} results_page Result page number.
1570
+ * @property {(results_limit: Integer) => GetProductsBrandsRequest} results_limit Number of results on page.
1571
+ * @property {(languagesIds: Array<String>) => GetProductsBrandsRequest} languagesIds List of languages
1572
+ * @property {(page: Integer, limit: Integer) => GetProductsBrandsRequest} page Define page number and maximum results per page
1573
+ * @property {() => Integer} count Returns total numer of results
1574
+ * @property {function} exec Excecute request
1575
+ */
1576
+
1577
+ /**
1578
+ * @typedef {Object} PostProductsBrandsRequest
1579
+ * @property {(producers: Array<Object>) => PostProductsBrandsRequest} producers List of manufacturers assigned to sought products.
1580
+ * @property {(nameInPanel: String) => PostProductsBrandsRequest} nameInPanel Name in panel
1581
+ * @property {(languagesConfigurations: Array<Object>) => PostProductsBrandsRequest} languagesConfigurations
1582
+ * @property {function} append Append current data to array and start modifying next row
1583
+ * @property {function} exec Excecute request
1584
+ */
1585
+
1586
+ /**
1587
+ * @typedef {Object} PutProductsBrandsRequest
1588
+ * @property {(producers: Array<Object>) => PutProductsBrandsRequest} producers List of manufacturers assigned to sought products.
1589
+ * @property {(id: Integer) => PutProductsBrandsRequest} id Id
1590
+ * @property {(nameInPanel: String) => PutProductsBrandsRequest} nameInPanel Name in panel
1591
+ * @property {(languagesConfigurations: Array<Object>) => PutProductsBrandsRequest} languagesConfigurations
1592
+ * @property {function} append Append current data to array and start modifying next row
1593
+ * @property {function} exec Excecute request
1594
+ */
1595
+
1596
+ /**
1597
+ * @typedef {Object} GetProductsBrandsFilterRequest
1598
+ * @property {(shopId: Integer) => GetProductsBrandsFilterRequest} shopId Shop Id
1599
+ * @property {(languageId: String) => GetProductsBrandsFilterRequest} languageId Language ID (code in ISO 639-2).
1600
+ * @property {(producerId: Integer) => GetProductsBrandsFilterRequest} producerId Brand ID
1601
+ * @property {function} exec Excecute request
1602
+ */
1603
+
1604
+ /**
1605
+ * @typedef {Object} PutProductsBrandsFilterRequest
1606
+ * @property {(shopId: Integer) => PutProductsBrandsFilterRequest} shopId Shop Id
1607
+ * @property {(languageId: String) => PutProductsBrandsFilterRequest} languageId Language ID (code in ISO 639-2).
1608
+ * @property {(producerId: Integer) => PutProductsBrandsFilterRequest} producerId Brand ID
1609
+ * @property {(filterForNodeIsDefault: 'y'|'n') => PutProductsBrandsFilterRequest} filterForNodeIsDefault
1610
+ * @property {(filtersActive: Array<Object>) => PutProductsBrandsFilterRequest} filtersActive Active filters.
1611
+ * @property {(filterId: String) => PutProductsBrandsFilterRequest} filterId Menu filter ID.
1612
+ * @property {(filterName: String) => PutProductsBrandsFilterRequest} filterName Filter name on page.
1613
+ * @property {(filterDisplay: 'name'|'gfx'|'namegfx') => PutProductsBrandsFilterRequest} filterDisplay Display as: "name" - text, "gfx" - graphics, "namegfx" - text and graphics.
1614
+ * @property {(filterValueSort: 'y'|'n'|'priority') => PutProductsBrandsFilterRequest} filterValueSort Sort by: "y" - alfabetically, "n" - by frequency and order of occurrence of indicated parameter value in found products, "priority" - according to value sequence in parameter.
1615
+ * @property {(filterDefaultEnabled: 'y'|'n') => PutProductsBrandsFilterRequest} filterDefaultEnabled Enabled by default .
1616
+ * @property {function} append Append current data to array and start modifying next row
1617
+ * @property {function} exec Excecute request
1618
+ */
1619
+
1620
+ /**
1621
+ * @typedef {Object} PostProductsBundlesRequest
1622
+ * @property {(params: Array<Object>) => PostProductsBundlesRequest} params Parameters transmitted to method
1623
+ * @property {(products: Array<Object>) => PostProductsBundlesRequest} products Products list.
1624
+ * @property {function} append Append current data to array and start modifying next row
1625
+ * @property {function} exec Excecute request
1626
+ */
1627
+
1628
+ /**
1629
+ * @typedef {Object} DeleteProductsBundlesProductsRequest
1630
+ * @property {(params: Array<Object>) => DeleteProductsBundlesProductsRequest} params Parameters transmitted to method
1631
+ * @property {(products: Array<Object>) => DeleteProductsBundlesProductsRequest} products Products list.
1632
+ * @property {(bundleIdent: Object) => DeleteProductsBundlesProductsRequest} bundleIdent
1633
+ * @property {function} append Append current data to array and start modifying next row
1634
+ * @property {function} exec Excecute request
1635
+ */
1636
+
1637
+ /**
1638
+ * @typedef {Object} PostProductsBundlesProductsRequest
1639
+ * @property {(params: Array<Object>) => PostProductsBundlesProductsRequest} params Parameters transmitted to method
1640
+ * @property {(products: Array<Object>) => PostProductsBundlesProductsRequest} products Products list.
1641
+ * @property {(bundleIdent: Object) => PostProductsBundlesProductsRequest} bundleIdent
1642
+ * @property {function} append Append current data to array and start modifying next row
1643
+ * @property {function} exec Excecute request
1644
+ */
1645
+
1646
+ /**
1647
+ * @typedef {Object} PutProductsBundlesProductsQuantityRequest
1648
+ * @property {(params: Array<Object>) => PutProductsBundlesProductsQuantityRequest} params Parameters transmitted to method
1649
+ * @property {(products: Array<Object>) => PutProductsBundlesProductsQuantityRequest} products Products list.
1650
+ * @property {(bundleIdent: Object) => PutProductsBundlesProductsQuantityRequest} bundleIdent
1651
+ * @property {function} append Append current data to array and start modifying next row
1652
+ * @property {function} exec Excecute request
1653
+ */
1654
+
1655
+ /**
1656
+ * @typedef {Object} PutProductsBundlesRenewRequest
1657
+ * @property {(params: Array<Object>) => PutProductsBundlesRenewRequest} params Parameters transmitted to method
1658
+ * @property {(products: Array<Object>) => PutProductsBundlesRenewRequest} products Products list.
1659
+ * @property {(bundleIdent: Object) => PutProductsBundlesRenewRequest} bundleIdent ID of a set being modified.
1660
+ * @property {function} append Append current data to array and start modifying next row
1661
+ * @property {function} exec Excecute request
1662
+ */
1663
+
1664
+ /**
1665
+ * @typedef {Object} GetProductsCategoriesRequest
1666
+ * @property {(ids: Array<Integer>) => GetProductsCategoriesRequest} ids List of product category identifiers in the panel
1667
+ * @property {(languages: Array<String>) => GetProductsCategoriesRequest} languages Array of languages categories names should be returned in. "Defaults" value returns categories names in store default language. Not using languages parameter causes a situation, that categories names are returned in all available languages.
1668
+ * @property {(results_page: Integer) => GetProductsCategoriesRequest} results_page Result page number.
1669
+ * @property {(results_limit: Integer) => GetProductsCategoriesRequest} results_limit Number of results on page.
1670
+ * @property {(return_last_changed_time: String) => GetProductsCategoriesRequest} return_last_changed_time Returns the date of last modification (YYYY-MM-DD HH-MM-SS).
1671
+ * @property {(page: Integer, limit: Integer) => GetProductsCategoriesRequest} page Define page number and maximum results per page
1672
+ * @property {() => Integer} count Returns total numer of results
1673
+ * @property {function} exec Excecute request
1674
+ */
1675
+
1676
+ /**
1677
+ * @typedef {Object} PutProductsCategoriesRequest
1678
+ * @property {(categories: Array<Object>) => PutProductsCategoriesRequest} categories List of categories in which sought products are present.
1679
+ * @property {(id: Integer) => PutProductsCategoriesRequest} id Category id.
1680
+ * @property {(parent_id: Integer) => PutProductsCategoriesRequest} parent_id Parent category ID.
1681
+ * @property {(priority: Integer) => PutProductsCategoriesRequest} priority Category priority. Value from 1 to 19.
1682
+ * @property {(operation: String) => PutProductsCategoriesRequest} operation Operation code. Allowed values. "add" - adds new category, "edit" - edits existing category, "del" - deletes existing category.
1683
+ * @property {(lang_data: Array<Object>) => PutProductsCategoriesRequest} lang_data
1684
+ * @property {function} append Append current data to array and start modifying next row
1685
+ * @property {function} exec Excecute request
1686
+ */
1687
+
1688
+ /**
1689
+ * @typedef {Object} GetProductsCategoriesIdosellRequest
1690
+ * @property {(languagesIds: Array<Object>) => GetProductsCategoriesIdosellRequest} languagesIds List of languages
1691
+ * @property {(categoriesIdoSellIds: Array<String>) => GetProductsCategoriesIdosellRequest} categoriesIdoSellIds Number of IdoSell Categories identifiers
1692
+ * @property {(categoriesIdoSellNames: Array<String>) => GetProductsCategoriesIdosellRequest} categoriesIdoSellNames IdoSell Categories name list
1693
+ * @property {(categoriesIdoSellPaths: Array<String>) => GetProductsCategoriesIdosellRequest} categoriesIdoSellPaths IdoSell Categories path list
1694
+ * @property {(resultsPage: Integer) => GetProductsCategoriesIdosellRequest} resultsPage Page with results number. Numeration starts from 0
1695
+ * @property {(resultsLimit: Integer) => GetProductsCategoriesIdosellRequest} resultsLimit Number of results on page. Value from 1 to 100
1696
+ * @property {(languages: Array<Integer>) => GetProductsCategoriesIdosellRequest} languages Define languagesIds by passing array of values
1697
+ * @property {(page: Integer, limit: Integer) => GetProductsCategoriesIdosellRequest} page Define page number and maximum results per page
1698
+ * @property {() => Integer} count Returns total numer of results
1699
+ * @property {function} exec Excecute request
1700
+ */
1701
+
1702
+ /**
1703
+ * @typedef {Object} GetProductsCodeExistenceRequest
1704
+ * @property {(products: Array<Object>) => GetProductsCodeExistenceRequest} products Products list.
1705
+ * @property {(ids: Array<Integer>) => GetProductsCodeExistenceRequest} ids Define products by passing array of values
1706
+ * @property {(externalCodes: Array<String>) => GetProductsCodeExistenceRequest} externalCodes Define products by passing array of values
1707
+ * @property {(producerCodes: Array<String>) => GetProductsCodeExistenceRequest} producerCodes Define products by passing array of values
1708
+ * @property {(deliverers: Array<Integer>) => GetProductsCodeExistenceRequest} deliverers Define products by passing array of values
1709
+ * @property {function} exec Excecute request
1710
+ */
1711
+
1712
+ /**
1713
+ * @typedef {Object} PostProductsCollectionsRequest
1714
+ * @property {(params: Array<Object>) => PostProductsCollectionsRequest} params Parameters transmitted to method
1715
+ * @property {(products: Array<Object>) => PostProductsCollectionsRequest} products Products list.
1716
+ * @property {function} append Append current data to array and start modifying next row
1717
+ * @property {function} exec Excecute request
1718
+ */
1719
+
1720
+ /**
1721
+ * @typedef {Object} DeleteProductsCollectionsProductsRequest
1722
+ * @property {(params: Array<Object>) => DeleteProductsCollectionsProductsRequest} params Parameters transmitted to method
1723
+ * @property {(products: Array<Object>) => DeleteProductsCollectionsProductsRequest} products Products list.
1724
+ * @property {(collectionId: Integer) => DeleteProductsCollectionsProductsRequest} collectionId ID of a collection being modified
1725
+ * @property {function} append Append current data to array and start modifying next row
1726
+ * @property {function} exec Excecute request
1727
+ */
1728
+
1729
+ /**
1730
+ * @typedef {Object} PostProductsCollectionsProductsRequest
1731
+ * @property {(params: Array<Object>) => PostProductsCollectionsProductsRequest} params Parameters transmitted to method
1732
+ * @property {(products: Array<Object>) => PostProductsCollectionsProductsRequest} products Products list.
1733
+ * @property {(collectionId: Integer) => PostProductsCollectionsProductsRequest} collectionId ID of a collection being modified
1734
+ * @property {function} append Append current data to array and start modifying next row
1735
+ * @property {function} exec Excecute request
1736
+ */
1737
+
1738
+ /**
1739
+ * @typedef {Object} PutProductsCollectionsProductsRequest
1740
+ * @property {(params: Array<Object>) => PutProductsCollectionsProductsRequest} params Parameters transmitted to method
1741
+ * @property {(products: Array<Object>) => PutProductsCollectionsProductsRequest} products Products list.
1742
+ * @property {(collectionId: Integer) => PutProductsCollectionsProductsRequest} collectionId ID of a collection being modified.
1743
+ * @property {function} append Append current data to array and start modifying next row
1744
+ * @property {function} exec Excecute request
1745
+ */
1746
+
1747
+ /**
1748
+ * @typedef {Object} PutProductsCollectionsRenewRequest
1749
+ * @property {(params: Array<Object>) => PutProductsCollectionsRenewRequest} params Parameters transmitted to method
1750
+ * @property {(products: Array<Object>) => PutProductsCollectionsRenewRequest} products Products list.
1751
+ * @property {(collectionIdent: Object) => PutProductsCollectionsRenewRequest} collectionIdent ID of a collection being modified.
1752
+ * @property {function} append Append current data to array and start modifying next row
1753
+ * @property {function} exec Excecute request
1754
+ */
1755
+
1756
+ /**
1757
+ * @typedef {Object} GetProductsDeliveryTimeRequest
1758
+ * @property {(stockId: Integer) => GetProductsDeliveryTimeRequest} stockId Stock ID
1759
+ * @property {(isCollectionInPerson: Boolean) => GetProductsDeliveryTimeRequest} isCollectionInPerson Should products be prepared for personal collection?
1760
+ * @property {function} exec Excecute request
1761
+ */
1762
+
1763
+ /**
1764
+ * @typedef {Object} GetProductsDescriptionsRequest
1765
+ * @property {(type: 'id'|'index'|'codeExtern'|'codeProducer') => GetProductsDescriptionsRequest} type Identifier type.
1766
+ * @property {(ids: Array<Integer>) => GetProductsDescriptionsRequest} ids ID value.
1767
+ * @property {(shopId: Integer) => GetProductsDescriptionsRequest} shopId Shop Id
1768
+ * @property {function} exec Excecute request
1769
+ */
1770
+
1771
+ /**
1772
+ * @typedef {Object} PutProductsDescriptionsRequest
1773
+ * @property {(products: Array<Object>) => PutProductsDescriptionsRequest} products Products list.
1774
+ * @property {(productIdent: Object) => PutProductsDescriptionsRequest} productIdent
1775
+ * @property {(productDescriptionsLangData: Array<Object>) => PutProductsDescriptionsRequest} productDescriptionsLangData Array of language-dependent elements.
1776
+ * @property {(productAuctionDescriptionsData: Array<Object>) => PutProductsDescriptionsRequest} productAuctionDescriptionsData Product data for auction services
1777
+ * @property {function} append Append current data to array and start modifying next row
1778
+ * @property {function} exec Excecute request
1779
+ */
1780
+
1781
+ /**
1782
+ * @typedef {Object} PutProductsGroupsMainProductRequest
1783
+ * @property {(groups: Array<Object>) => PutProductsGroupsMainProductRequest} groups
1784
+ * @property {(productIdent: Object) => PutProductsGroupsMainProductRequest} productIdent
1785
+ * @property {function} append Append current data to array and start modifying next row
1786
+ * @property {function} exec Excecute request
1787
+ */
1788
+
1789
+ /**
1790
+ * @typedef {Object} PutProductsGroupsOrderRequest
1791
+ * @property {(groups: Array<Object>) => PutProductsGroupsOrderRequest} groups
1792
+ * @property {(productsInOrder: Array<Object>) => PutProductsGroupsOrderRequest} productsInOrder
1793
+ * @property {function} append Append current data to array and start modifying next row
1794
+ * @property {function} exec Excecute request
1795
+ */
1796
+
1797
+ /**
1798
+ * @typedef {Object} PutProductsGroupsSettingsRequest
1799
+ * @property {(groups: Array<Object>) => PutProductsGroupsSettingsRequest} groups
1800
+ * @property {(productIdent: Object) => PutProductsGroupsSettingsRequest} productIdent
1801
+ * @property {(displayInPanel: 'firstAvailable'|'all') => PutProductsGroupsSettingsRequest} displayInPanel Display on the product list in the panel.
1802
+ * @property {(displayOnPage: 'firstAvailable'|'all'|'specified') => PutProductsGroupsSettingsRequest} displayOnPage Display on a product list on the page.
1803
+ * @property {(specifiedProductIdent: Object) => PutProductsGroupsSettingsRequest} specifiedProductIdent Selected product in the group.
1804
+ * @property {function} append Append current data to array and start modifying next row
1805
+ * @property {function} exec Excecute request
1806
+ */
1807
+
1808
+ /**
1809
+ * @typedef {Object} GetProductsIdBySizecodeRequest
1810
+ * @property {(codes: Array<String>) => GetProductsIdBySizecodeRequest} codes Search codes.
1811
+ * @property {(type: String) => GetProductsIdBySizecodeRequest} type Type of codes. Acceptable values: "external" (default value) - external system code, "producer" - producer code, and "all" - any of the above codes
1812
+ * @property {function} exec Excecute request
1813
+ */
1814
+
1815
+ /**
1816
+ * @typedef {Object} DeleteProductsImagesRequest
1817
+ * @property {(params: Array<Object>) => DeleteProductsImagesRequest} params Parameters transmitted to method
1818
+ * @property {(deleteAll: Boolean) => DeleteProductsImagesRequest} deleteAll Delete all images
1819
+ * @property {(productId: Integer) => DeleteProductsImagesRequest} productId Product IAI code
1820
+ * @property {(shopId: Integer) => DeleteProductsImagesRequest} shopId Shop Id
1821
+ * @property {(productImagesId: Array<String>) => DeleteProductsImagesRequest} productImagesId
1822
+ * @property {function} append Append current data to array and start modifying next row
1823
+ * @property {function} exec Excecute request
1824
+ */
1825
+
1826
+ /**
1827
+ * @typedef {Object} PutProductsImagesRequest
1828
+ * @property {(productsImagesSettings: Object) => PutProductsImagesRequest} productsImagesSettings
1829
+ * @property {(productsImages: Array<Object>) => PutProductsImagesRequest} productsImages Information on product images
1830
+ * @property {(productIdent: Object) => PutProductsImagesRequest} productIdent
1831
+ * @property {(shopId: Integer) => PutProductsImagesRequest} shopId Shop Id
1832
+ * @property {(productImages: Array<Object>) => PutProductsImagesRequest} productImages Product photos details.
1833
+ * @property {(productIcons: Array<Object>) => PutProductsImagesRequest} productIcons Product icons list.
1834
+ * @property {(productImagesSettings: Object) => PutProductsImagesRequest} productImagesSettings Product settings.
1835
+ * @property {function} append Append current data to array and start modifying next row
1836
+ * @property {function} exec Excecute request
1837
+ */
1838
+
1839
+ /**
1840
+ * @typedef {Object} GetProductsMarketingAllFacebookCatalogIdsRequest
1841
+ * @property {(shopId: Integer) => GetProductsMarketingAllFacebookCatalogIdsRequest} shopId Shop Id
1842
+ * @property {function} exec Excecute request
1843
+ */
1844
+
1845
+ /**
1846
+ * @typedef {Object} GetProductsMarketingPromotionRequest
1847
+ * @property {(shopId: Integer) => GetProductsMarketingPromotionRequest} shopId Shop Id
1848
+ * @property {(products: Array<Integer>) => GetProductsMarketingPromotionRequest} products Products list.
1849
+ * @property {function} exec Excecute request
1850
+ */
1851
+
1852
+ /**
1853
+ * @typedef {Object} PostProductsMarketingPromotionRequest
1854
+ * @property {(promotionName: String) => PostProductsMarketingPromotionRequest} promotionName Promotion name
1855
+ * @property {(shopsIds: Array<Integer>) => PostProductsMarketingPromotionRequest} shopsIds List of stores IDs When mask is determined, this parameter is omitted.
1856
+ * @property {(marketingZones: Object) => PostProductsMarketingPromotionRequest} marketingZones Special zones
1857
+ * @property {(newPriceSettings: Object) => PostProductsMarketingPromotionRequest} newPriceSettings #!KonfiguracjaCenyPromocyjnej!#
1858
+ * @property {(startDate: String) => PostProductsMarketingPromotionRequest} startDate #!DataRozpoczeciaWFormacieYMDHIS!#
1859
+ * @property {(endDate: String) => PostProductsMarketingPromotionRequest} endDate #!DataZakonczeniaWFormacieYMDHIS!#
1860
+ * @property {(changeProductsToVisibleWhileStarting: 'y'|'n') => PostProductsMarketingPromotionRequest} changeProductsToVisibleWhileStarting Change the status of hidden products to visible while starting the special offer
1861
+ * @property {(removeProductsAfterStockLevelRunsDown: 'y'|'n') => PostProductsMarketingPromotionRequest} removeProductsAfterStockLevelRunsDown After running out of stock, automatically remove from the promotion products added separately (does not apply to series, producers, categories and menu)
1862
+ * @property {(reduceBasingPrice: 'net'|'gross') => PostProductsMarketingPromotionRequest} reduceBasingPrice #!ObnizNaPodstawieCenyNettoBrutto!#
1863
+ * @property {(calculationMethod: 'sum'|'chooseAdvantageous') => PostProductsMarketingPromotionRequest} calculationMethod Price reduction calculation method
1864
+ * @property {(promotionElements: Array<Object>) => PostProductsMarketingPromotionRequest} promotionElements #!ElementyNaJakieMaDzialacPromocja!#
1865
+ * @property {(elementType: 'product'|'series'|'producer'|'category'|'menu') => PostProductsMarketingPromotionRequest} elementType
1866
+ * @property {(elementId: String) => PostProductsMarketingPromotionRequest} elementId #!IdentyfikatorElementuNaJakiOddzialujePromocja!#
1867
+ * @property {function} append Append current data to array and start modifying next row
1868
+ * @property {function} exec Excecute request
1869
+ */
1870
+
1871
+ /**
1872
+ * @typedef {Object} PutProductsMarketingPromotionRequest
1873
+ * @property {(promotionId: String) => PutProductsMarketingPromotionRequest} promotionId Special offer ID
1874
+ * @property {(promotionName: String) => PutProductsMarketingPromotionRequest} promotionName Promotion name
1875
+ * @property {(shopsIds: Array<Integer>) => PutProductsMarketingPromotionRequest} shopsIds List of stores IDs When mask is determined, this parameter is omitted.
1876
+ * @property {(marketingZones: Object) => PutProductsMarketingPromotionRequest} marketingZones Special zones
1877
+ * @property {(newPriceSettings: Object) => PutProductsMarketingPromotionRequest} newPriceSettings #!KonfiguracjaCenyPromocyjnej!#
1878
+ * @property {(startDate: String) => PutProductsMarketingPromotionRequest} startDate #!DataRozpoczeciaWFormacieYMDHIS!#
1879
+ * @property {(endDate: String) => PutProductsMarketingPromotionRequest} endDate #!DataZakonczeniaWFormacieYMDHIS!#
1880
+ * @property {(changeProductsToVisibleWhileStarting: 'y'|'n') => PutProductsMarketingPromotionRequest} changeProductsToVisibleWhileStarting Change the status of hidden products to visible while starting the special offer
1881
+ * @property {(removeProductsAfterStockLevelRunsDown: 'y'|'n') => PutProductsMarketingPromotionRequest} removeProductsAfterStockLevelRunsDown After running out of stock, automatically remove from the promotion products added separately (does not apply to series, producers, categories and menu)
1882
+ * @property {(reduceBasingPrice: 'net'|'gross') => PutProductsMarketingPromotionRequest} reduceBasingPrice #!ObnizNaPodstawieCenyNettoBrutto!#
1883
+ * @property {(calculationMethod: 'sum'|'chooseAdvantageous') => PutProductsMarketingPromotionRequest} calculationMethod Price reduction calculation method
1884
+ * @property {(removeAllPromotionElements: 'y'|'n') => PutProductsMarketingPromotionRequest} removeAllPromotionElements #!OkreslaCzyUsunacWszystkieDotychczasoweElementyPromocji!#
1885
+ * @property {(promotionElements: Array<Object>) => PutProductsMarketingPromotionRequest} promotionElements #!ElementyNaJakieMaDzialacPromocja!#
1886
+ * @property {(elementType: 'product'|'series'|'producer'|'category'|'menu') => PutProductsMarketingPromotionRequest} elementType
1887
+ * @property {(elementId: String) => PutProductsMarketingPromotionRequest} elementId #!IdentyfikatorElementuNaJakiOddzialujePromocja!#
1888
+ * @property {function} append Append current data to array and start modifying next row
1889
+ * @property {function} exec Excecute request
1890
+ */
1891
+
1892
+ /**
1893
+ * @typedef {Object} GetProductsMarketingZonesRequest
1894
+ * @property {(products: Array<Object>) => GetProductsMarketingZonesRequest} products Products list.
1895
+ * @property {(ids: Array<Integer>) => GetProductsMarketingZonesRequest} ids Define products by passing array of values
1896
+ * @property {(externalCodes: Array<String>) => GetProductsMarketingZonesRequest} externalCodes Define products by passing array of values
1897
+ * @property {(producerCodes: Array<String>) => GetProductsMarketingZonesRequest} producerCodes Define products by passing array of values
1898
+ * @property {function} exec Excecute request
1899
+ */
1900
+
1901
+ /**
1902
+ * @typedef {Object} PutProductsMarketingZonesRequest
1903
+ * @property {(products: Array<Object>) => PutProductsMarketingZonesRequest} products Products list.
1904
+ * @property {(assignment_mode: 'auto'|'manual') => PutProductsMarketingZonesRequest} assignment_mode
1905
+ * @property {(marketing_zones: Object) => PutProductsMarketingZonesRequest} marketing_zones
1906
+ * @property {(shops: Array<Object>) => PutProductsMarketingZonesRequest} shops Marketing hotspots in shops
1907
+ * @property {(ident: Object) => PutProductsMarketingZonesRequest} ident Identifier type.
1908
+ * @property {(assignment_mode: 'auto'|'manual') => PutProductsMarketingZonesRequest} assignment_mode
1909
+ * @property {(marketing_zones: Object) => PutProductsMarketingZonesRequest} marketing_zones
1910
+ * @property {(shops: Array<Object>) => PutProductsMarketingZonesRequest} shops Marketing hotspots in shops
1911
+ * @property {function} append Append current data to array and start modifying next row
1912
+ * @property {function} exec Excecute request
1913
+ */
1914
+
1915
+ /**
1916
+ * @typedef {Object} GetProductsOmnibusPricesRequest
1917
+ * @property {(products: Array<Object>) => GetProductsOmnibusPricesRequest} products Products list.
1918
+ * @property {(ids: Array<[object Object]>) => GetProductsOmnibusPricesRequest} ids Define products by passing array of values
1919
+ * @property {(externalCodes: Array<String>) => GetProductsOmnibusPricesRequest} externalCodes Define products by passing array of values
1920
+ * @property {(producerCodes: Array<String>) => GetProductsOmnibusPricesRequest} producerCodes Define products by passing array of values
1921
+ * @property {function} exec Excecute request
1922
+ */
1923
+
1924
+ /**
1925
+ * @typedef {Object} PutProductsOmnibusPricesRequest
1926
+ * @property {(products: Array<Object>) => PutProductsOmnibusPricesRequest} products Products list.
1927
+ * @property {(ident: Object) => PutProductsOmnibusPricesRequest} ident Identifier type.
1928
+ * @property {(sizes: Array<Object>) => PutProductsOmnibusPricesRequest} sizes List of sizes
1929
+ * @property {(omnibusPrices: Object) => PutProductsOmnibusPricesRequest} omnibusPrices Strikethrough price settings.
1930
+ * @property {(shops: Array<Object>) => PutProductsOmnibusPricesRequest} shops Strikethrough price settings for the page.
1931
+ * @property {function} append Append current data to array and start modifying next row
1932
+ * @property {function} exec Excecute request
1933
+ */
1934
+
1935
+ /**
1936
+ * @typedef {Object} DeleteProductsOpinionsRequest
1937
+ * @property {(id: Integer) => DeleteProductsOpinionsRequest} id
1938
+ * @property {function} exec Excecute request
1939
+ */
1940
+
1941
+ /**
1942
+ * @typedef {Object} GetProductsOpinionsRequest
1943
+ * @property {(opinion: Object) => GetProductsOpinionsRequest} opinion Review identification
1944
+ * @property {(products: Object) => GetProductsOpinionsRequest} products Products list.
1945
+ * @property {(clients: Object) => GetProductsOpinionsRequest} clients Customer data.
1946
+ * @property {(dateRange: Object) => GetProductsOpinionsRequest} dateRange Date range
1947
+ * @property {(resultsPage: Integer) => GetProductsOpinionsRequest} resultsPage Page with results number. Numeration starts from 0
1948
+ * @property {(resultsLimit: Integer) => GetProductsOpinionsRequest} resultsLimit Number of results on page. Value from 1 to 100
1949
+ * @property {(ordersBy: Array<Object>) => GetProductsOpinionsRequest} ordersBy Possibility of sorting returned list
1950
+ * @property {(dateFrom: DateLike, dateTo: DateLike) => GetProductsOpinionsRequest} dates Type of date according to the index results
1951
+ * @property {(elementName: "date"|"rating"|"scorePositive"|"scoreNegative"|"modificationDatetime", descending: Boolean) => GetProductsOpinionsRequest} orderBy Define sorting by element and direction
1952
+ * @property {(page: Integer, limit: Integer) => GetProductsOpinionsRequest} page Define page number and maximum results per page
1953
+ * @property {() => Integer} count Returns total numer of results
1954
+ * @property {function} exec Excecute request
1955
+ */
1956
+
1957
+ /**
1958
+ * @typedef {Object} PostProductsOpinionsRequest
1959
+ * @property {(opinions: Array<Object>) => PostProductsOpinionsRequest} opinions List of reviews
1960
+ * @property {(createDate: String) => PostProductsOpinionsRequest} createDate
1961
+ * @property {(confirmed: Boolean) => PostProductsOpinionsRequest} confirmed
1962
+ * @property {(rating: String) => PostProductsOpinionsRequest} rating
1963
+ * @property {(content: String) => PostProductsOpinionsRequest} content
1964
+ * @property {(language: String) => PostProductsOpinionsRequest} language Customer language ID.
1965
+ * @property {(picture: String) => PostProductsOpinionsRequest} picture
1966
+ * @property {(shopId: Integer) => PostProductsOpinionsRequest} shopId Shop Id
1967
+ * @property {(host: String) => PostProductsOpinionsRequest} host
1968
+ * @property {(clients: Object) => PostProductsOpinionsRequest} clients Customer data.
1969
+ * @property {(scorePositive: Integer) => PostProductsOpinionsRequest} scorePositive
1970
+ * @property {(scoreNegative: Integer) => PostProductsOpinionsRequest} scoreNegative
1971
+ * @property {(products: Object) => PostProductsOpinionsRequest} products Products list.
1972
+ * @property {(orderSerialNumber: Integer) => PostProductsOpinionsRequest} orderSerialNumber Order serial number.
1973
+ * @property {(shopAnswer: String) => PostProductsOpinionsRequest} shopAnswer Reply to an opinion
1974
+ * @property {(opinionConfirmedByPurchase: Boolean) => PostProductsOpinionsRequest} opinionConfirmedByPurchase Opinion confirmed with purchase
1975
+ * @property {function} append Append current data to array and start modifying next row
1976
+ * @property {function} exec Excecute request
1977
+ */
1978
+
1979
+ /**
1980
+ * @typedef {Object} PutProductsOpinionsRequest
1981
+ * @property {(id: Integer) => PutProductsOpinionsRequest} id
1982
+ * @property {(confirmed: 'y'|'n') => PutProductsOpinionsRequest} confirmed
1983
+ * @property {(rating: '1'|'2'|'3'|'4'|'5') => PutProductsOpinionsRequest} rating
1984
+ * @property {(content: String) => PutProductsOpinionsRequest} content
1985
+ * @property {(language: String) => PutProductsOpinionsRequest} language Customer language ID.
1986
+ * @property {(shopAnswer: String) => PutProductsOpinionsRequest} shopAnswer Reply to an opinion
1987
+ * @property {(picture: String) => PutProductsOpinionsRequest} picture
1988
+ * @property {(opinionConfirmedByPurchase: Boolean) => PutProductsOpinionsRequest} opinionConfirmedByPurchase Opinion confirmed with purchase
1989
+ * @property {function} exec Excecute request
1990
+ */
1991
+
1992
+ /**
1993
+ * @typedef {Object} GetProductsOpinionsRateRequest
1994
+ * @property {(id: Integer) => GetProductsOpinionsRateRequest} id
1995
+ * @property {(operation: 'positive'|'negative') => GetProductsOpinionsRateRequest} operation
1996
+ * @property {function} exec Excecute request
1997
+ */
1998
+
1999
+ /**
2000
+ * @typedef {Object} DeleteProductsParametersRequest
2001
+ * @property {(ids: Array<Integer>) => DeleteProductsParametersRequest} ids Parameter identifiers
2002
+ * @property {function} exec Excecute request
2003
+ */
2004
+
2005
+ /**
2006
+ * @typedef {Object} GetProductsParametersRequest
2007
+ * @property {(ids: Array<Integer>) => GetProductsParametersRequest} ids List of identifiers
2008
+ * @property {(textIds: Array<Object>) => GetProductsParametersRequest} textIds Element text ID - can be entered instead of "id".
2009
+ * @property {(languagesIds: Array<String>) => GetProductsParametersRequest} languagesIds List of languages
2010
+ * @property {(resultsPage: Integer) => GetProductsParametersRequest} resultsPage Page with results number. Numeration starts from 0
2011
+ * @property {(resultsLimit: Integer) => GetProductsParametersRequest} resultsLimit Number of results on page. Value from 1 to 100
2012
+ * @property {(page: Integer, limit: Integer) => GetProductsParametersRequest} page Define page number and maximum results per page
2013
+ * @property {() => Integer} count Returns total numer of results
2014
+ * @property {function} exec Excecute request
2015
+ */
2016
+
2017
+ /**
2018
+ * @typedef {Object} PutProductsParametersRequest
2019
+ * @property {(items: Array<Object>) => PutProductsParametersRequest} items Sections, parameters or valued to add or edit.
2020
+ * @property {(settings: Object) => PutProductsParametersRequest} settings Settings
2021
+ * @property {(id: Integer) => PutProductsParametersRequest} id Parameter ID.
2022
+ * @property {(item_text_ids: Array<Object>) => PutProductsParametersRequest} item_text_ids Element text ID - can be entered instead of "id". Recognized save format: "section" (without backslash), "parameter\" (parameter without assigned value).
2023
+ * @property {(names: Array<Object>) => PutProductsParametersRequest} names Names of section, parameter or value.
2024
+ * @property {(descriptions: Array<Object>) => PutProductsParametersRequest} descriptions Descriptions of section, parameter or value.
2025
+ * @property {(card_icons: Array<Object>) => PutProductsParametersRequest} card_icons Icons of section, parameter or value to display on the product card.
2026
+ * @property {(link_icons: Array<Object>) => PutProductsParametersRequest} link_icons Icons of section, parameter or value to display on the list of products.
2027
+ * @property {(context_id: String) => PutProductsParametersRequest} context_id Parameter's additional feature. 1. Status: context_id = "CONTEXT_STATE" Takes values context_value_id: - CONTEXT_STATE_NEW - New, - CONTEXT_STATE_USED - Used, - CONTEXT_STATE_REFURBISHED_BY_PRODUCER - Renewed by a manufacturer, - CONTEXT_STATE_REFURBISHED_BY_SELLER - Renewed by a seller, - CONTEXT_STATE_FOR_PARTS_OR_BROKEN - In parts or damaged. 2. Product weight in grams: context_id = "CONTEXT_STD_UNIT_WEIGHT" Takes values context_value_id: - Value of additional feature is set automatically basing on the parameter's value. 3. A product's value in milliliters: context_id = "CONTEXT_STD_UNIT_VOLUME" Takes values context_value_id: - Value of additional feature is set automatically basing on the parameter's value. 4. Sex: context_id = "CONTEXT_SEX" Takes values context_value_id: - CONTEXT_SEX_MAN - Man, - CONTEXT_SEX_WOMAN - Woman, - CONTEXT_SEX_UNISEX - Unisex. 5. Age group: context_id = "CONTEXT_AGE_GROUP" Takes values context_value_id: - CONTEXT_AGE_GROUP_ADULT - Adults, - CONTEXT_AGE_GROUP_MINOR - Children. 6. Maximum number of products in an order: context_id = "CONTEXT_MAX_QUANTITY_PER_RETAIL_ORDER" Takes values context_value_id: - Value of additional feature is set automatically basing on the parameter's value. 7. Maximum number of products in a wholesale order: context_id = "CONTEXT_MAX_QUANTITY_PER_WHOLESALE_ORDER" Takes values context_value_id: - Value of additional feature is set automatically basing on the parameter's value. 8. Minimal number of products in an order: context_id = "CONTEXT_MIN_QUANTITY_PER_RETAIL_ORDER" Takes values context_value_id: - Value of additional feature is set automatically basing on the parameter's value. 9. Minimum number of products in a wholesale order: context_id = "CONTEXT_MIN_QUANTITY_PER_WHOLESALE_ORDER" Takes values context_value_id: - Value of additional feature is set automatically basing on the parameter's value. 10. Maximal number of a single size in an order: context_id = "CONTEXT_MAX_SIZE_QUANTITY_PER_RETAIL_ORDER" Takes values context_value_id: - Value of additional feature is set automatically basing on the parameter's value. 11. Maximal number of a single size in a wholesale order: context_id = "CONTEXT_MAX_SIZE_QUANTITY_PER_WHOLESALE_ORDER" Takes values context_value_id: - Value of additional feature is set automatically basing on the parameter's value. 12. Minimal number of a single size in an order: context_id = "CONTEXT_MIN_SIZE_QUANTITY_PER_RETAIL_ORDER" Takes values context_value_id: - Value of additional feature is set automatically basing on the parameter's value. 13. Minimal number of a single size in a wholesale order: context_id = "CONTEXT_MIN_SIZE_QUANTITY_PER_WHOLESALE_ORDER" Takes values context_value_id: - Value of additional feature is set automatically basing on the parameter's value. 14. Net weight: context_id = "CONTEXT_WEIGHT_NET" Takes values context_value_id: - Value of additional feature is set automatically basing on the parameter's value. 15. Color: context_id = "CONTEXT_COLOR" Takes values context_value_id: - Value of additional feature is set automatically basing on the parameter's value. 16. #!TylkoDlaDoroslych!#: context_id = "CONTEXT_ONLY_ADULTS" Takes values context_value_id: - CONTEXT_ONLY_ADULTS_YES - yes, - CONTEXT_ONLY_ADULTS_NO - no. 17. Prescription drug: context_id = "CONTEXT_PRESCRIPTION_MEDICINE" Takes values context_value_id: - CONTEXT_PRESCRIPTION_MEDICINE_YES - yes, - CONTEXT_PRESCRIPTION_MEDICINE_NO - no. 18. Season Rate: context_id = "CONTEXT_SEASON" Takes values context_value_id: - CONTEXT_SEASON_SPRING - Spring, - CONTEXT_SEASON_SUMMER - Summer, - CONTEXT_SEASON_FALL - Autumn, - CONTEXT_SEASON_WINTER - Winter, - CONTEXT_SEASON_SPRING_SUMMER - Spring/Summer, - CONTEXT_SEASON_FALL_WINTER - Autumn/Winter.
2028
+ * @property {(context_value_id: String) => PutProductsParametersRequest} context_value_id value of additional feature - Values described in context_id.
2029
+ * @property {function} append Append current data to array and start modifying next row
2030
+ * @property {function} exec Excecute request
2031
+ */
2032
+
2033
+ /**
2034
+ * @typedef {Object} DeleteProductsRequest
2035
+ * @property {(products: Array<Object>) => DeleteProductsRequest} products Products list.
2036
+ * @property {(productId: Integer) => DeleteProductsRequest} productId Product IAI code
2037
+ * @property {(productSizeCodeExternal: String) => DeleteProductsRequest} productSizeCodeExternal External product system code for size.
2038
+ * @property {function} append Append current data to array and start modifying next row
2039
+ * @property {function} exec Excecute request
2040
+ */
2041
+
2042
+ /**
2043
+ * @typedef {Object} ListProductsRequest
2044
+ * @property {(dispatchSettings: Object) => ListProductsRequest} dispatchSettings
2045
+ * @property {(returnProducts: String) => ListProductsRequest} returnProducts Element determines which products should be returned by the gate. Undeleted products are returned by default. Available values: "active" - undeleted products, "deleted" - deleted products. "in_trash" - products in the trash.
2046
+ * @property {(returnElements: Array<String>) => ListProductsRequest} returnElements Elements to be returned by the endpoint. By default all elements are returned Available values: * lang_data * adding_time, * deleted, * code, * note, * taxcode, * inwrapper, * sellby_retail, * sellby_wholesale, * producer_id, * producer_name, * iaiCategoryId, * iaiCategoryName, * iaiCategoryPath, * category_id, * category_name, * size_group_id, * modification_time, * currency, * currency_shop, * bestseller, * new_product, * retail_price, * wholesale_price, * minimal_price, * automatic_calculation_price, * pos_price, * strikethrough_retail_price, * strikethrough_wholesale_price, * last_purchase_price, * purchase_price_net_average, * purchase_price_net_last, * purchase_price_gross_average, * purchase_price_gross_last, * vat, * vat_free, * rebate, * hotspots_zones, * profit_points, * points, * weight, * export_to_pricecomparers, * export_to_amazon_marketplace, * enable_in_pos, * complex_notes, * available_profile, * traits, * parameters, * version_data, * advance, * promotion, * discount, * distinguished, * special, * visible, * persistent, * priority, * shops_mask, * icon, * icon_for_auctions, * icon_for_group, * pictures, * unit, * warranty, * series, * products_associated, * shops, * quantities, * sizes_attributes, * shops_attributes, * auction_prices, * price_comparers_prices, * deliverer, * sizes, * size_group_name, * pictures_count, * product_type, * price_changed_time, * quantity_changed_time, * deliverer_name, * available_profile_name, * availability_management_type, * sum_in_basket, * menu, * auction_settings, * bundle, * sizeschart_id, * sizeschart_name, * serialnumbers, * producer_codes_standard, * javaScriptInTheItemCard, * productAuctionDescriptionsData, * priceFormula, * productIndividualDescriptionsData, * productIndividualUrlsData, * productServicesDescriptionsData, * cnTaricCode, * productIsGratis, * dimensions
2047
+ * @property {(productIsAvailable: String) => ListProductsRequest} productIsAvailable Product availability. Available values: "y" - available, "n" - unavailable.
2048
+ * @property {(productIsVisible: String) => ListProductsRequest} productIsVisible Product visibility in store Available values: "y" - Visible, "n" - Invisible.
2049
+ * @property {(productVersionId: Integer) => ListProductsRequest} productVersionId Product group ID
2050
+ * @property {(productInPromotion: String) => ListProductsRequest} productInPromotion Promoted product. Available values: "y" - promoted, "n" - not promoted.
2051
+ * @property {(productInDiscount: String) => ListProductsRequest} productInDiscount Product on sale. Available values: "y" - on sale, "n" - not on sale.
2052
+ * @property {(productInDistinguished: String) => ListProductsRequest} productInDistinguished Distinguished product. Available values: "y" - distinguished, "n" - not distinguished.
2053
+ * @property {(productInSpecial: String) => ListProductsRequest} productInSpecial Special product. Available values: "y" - #!specjalny!#, "n" - not special.
2054
+ * @property {(productInForPointsSelling: String) => ListProductsRequest} productInForPointsSelling Product available for points. Available values: "y" - Available for points, "n" - Unavailable for points.
2055
+ * @property {(productIsObservedByClients: String) => ListProductsRequest} productIsObservedByClients Observed product. Available values: "Y" - observed, "n" - not observed.
2056
+ * @property {(skipDefaultProduct: String) => ListProductsRequest} skipDefaultProduct Element determines if default product (with 0 ID, contains settings of newly added products) should be omitted Available values: "y" - omits default product, "n" - allows to download default product.
2057
+ * @property {(showPromotionsPrices: String) => ListProductsRequest} showPromotionsPrices The item specifies whether promotional prices are to be shown in price nodes. Available values: "y" - show promotional prices, "n" - do not show promotional prices. (default value)
2058
+ * @property {(categories: Array<Object>) => ListProductsRequest} categories List of categories in which sought products are present.
2059
+ * @property {(producers: Array<Object>) => ListProductsRequest} producers List of manufacturers assigned to sought products.
2060
+ * @property {(productParams: Array<Object>) => ListProductsRequest} productParams List of sought products. This parameter can be used, when there have been no other parameter entered productIndexes.
2061
+ * @property {(productIndexes: Array<Object>) => ListProductsRequest} productIndexes List of sought products by indexes.
2062
+ * @property {(productShops: Array<Object>) => ListProductsRequest} productShops Data of stores product is assigned to.
2063
+ * @property {(productPromotionsIds: Array<Integer>) => ListProductsRequest} productPromotionsIds List of special offers, sought products are assigned to.
2064
+ * @property {(productDate: Object) => ListProductsRequest} productDate Settings concerning narrowing list of products found by date.
2065
+ * @property {(productParametersParams: Array<Object>) => ListProductsRequest} productParametersParams Parameters
2066
+ * @property {(productSeriesParams: Array<Object>) => ListProductsRequest} productSeriesParams Series, sought products are assigned to.
2067
+ * @property {(productUnits: Array<Object>) => ListProductsRequest} productUnits List of units of measure assigned to sought products.
2068
+ * @property {(productWarranties: Array<Object>) => ListProductsRequest} productWarranties Narrowing list of products by set warranties.
2069
+ * @property {(deliverersIds: Array<Integer>) => ListProductsRequest} deliverersIds Suppliers, sought products are assigned to.
2070
+ * @property {(containsText: String) => ListProductsRequest} containsText Product contains text (searches in short and long description).
2071
+ * @property {(containsCodePart: String) => ListProductsRequest} containsCodePart Product code or it's part (based on producer's code, external product system code and code that is visible on a product card). Search is accesible only with available products.
2072
+ * @property {(productAvailableInStocks: Object) => ListProductsRequest} productAvailableInStocks Product availability in stocks
2073
+ * @property {(productAvailableInAuctions: Object) => ListProductsRequest} productAvailableInAuctions Product availability on auctions
2074
+ * @property {(resultsPage: Integer) => ListProductsRequest} resultsPage Page with results number. Numeration starts from 0
2075
+ * @property {(resultsLimit: Integer) => ListProductsRequest} resultsLimit Number of results on page. Value from 1 to 100
2076
+ * @property {(ordersBy: Array<Object>) => ListProductsRequest} ordersBy Possibility of sorting returned list
2077
+ * @property {(productSearchingLangId: String) => ListProductsRequest} productSearchingLangId Language ID that allows to search and return data in chosen language. This parameter is optional. If it's lacking, she search process unfolds in all available languages.
2078
+ * @property {(productSearchingCurrencyId: String) => ListProductsRequest} productSearchingCurrencyId Currency ID allowing to search and browse products in given currency. This parameter is optional, when it's lacking, the search process unfolds in all available currencies.
2079
+ * @property {(returnPricesCurrency: String) => ListProductsRequest} returnPricesCurrency Currency ID allowing for returning all product prices in an indicated currency
2080
+ * @property {(productHasNote: String) => ListProductsRequest} productHasNote Annotation contains text.
2081
+ * @property {(productInExportToPriceComparisonSites: String) => ListProductsRequest} productInExportToPriceComparisonSites 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.
2082
+ * @property {(productInExportToAmazonMarketplace: String) => ListProductsRequest} productInExportToAmazonMarketplace Visibility of an item in an export to Amazon Marketplace. Available values: "y" - Visible, "selected" - Visible on selected regional services, "n" - invisible.
2083
+ * @property {(selectedAmazonMarketplacesList: Array<String>) => ListProductsRequest} selectedAmazonMarketplacesList List of Amazon regional sites to which the product is exported (only in case of "selected" option)
2084
+ * @property {(productInBestseller: String) => ListProductsRequest} productInBestseller Product is bestseller. Available values: "n" - no, "y" - yes.
2085
+ * @property {(productInNew: String) => ListProductsRequest} productInNew Product is new. Available values: "y" - is new, "n" - is not new.
2086
+ * @property {(searchByShops: Object) => ListProductsRequest} searchByShops Shops
2087
+ * @property {(productSearchPriceRange: Object) => ListProductsRequest} productSearchPriceRange Price range for sought products.
2088
+ * @property {(productVatRates: Array<Number>) => ListProductsRequest} productVatRates VAT value for sought products
2089
+ * @property {(productIsVatFree: String) => ListProductsRequest} productIsVatFree Is product VAT-free Allowed values "y" - yes, "n" - no.
2090
+ * @property {(productHasWholesalePrice: String) => ListProductsRequest} productHasWholesalePrice Product has defined wholesale price. Available values: "y" - has wholesale price, "n" - does not have wholesale price.
2091
+ * @property {(productInPersistent: String) => ListProductsRequest} productInPersistent Product visible even though out of stock Available values: "y" - visible even though out of stock, "n" - not visible when out of stock.
2092
+ * @property {(returnProductsVersions: String) => ListProductsRequest} returnProductsVersions Settings of products returned with variants All products with variants are returned by default Available values: version_all - returns all variants, version_main - returns only main variant.
2093
+ * @property {(productInSumInBasket: String) => ListProductsRequest} productInSumInBasket Do You wish to sum up the products in the basket as a one order? Available values: "y" - yes, "n" - no.
2094
+ * @property {(productType: Object) => ListProductsRequest} productType 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.
2095
+ * @property {(productMenuItems: Object) => ListProductsRequest} productMenuItems An array of menu elements
2096
+ * @property {(productLocationId: Integer) => ListProductsRequest} productLocationId Warehouse location ID
2097
+ * @property {(productLocationTextId: String) => ListProductsRequest} productLocationTextId Warehouse location full path Use a backslash (\) as a separator, for example: M1\Section name\Location name If location_id parameter is provided, the full warehouse location path will not be taken into account
2098
+ * @property {(alwaysReturnProductShopSizesAttributes: Boolean) => ListProductsRequest} alwaysReturnProductShopSizesAttributes Return all size attributes regardless of whether product prices are the same as the base price or if they differ from it. Available values: 1 - all size attributes will be returned; 0 - only attributes of those sizes, where the prices will be different from the base price (default value) will be returned.
2099
+ * @property {(returnEmptyStocksWithReservation: Boolean) => ListProductsRequest} returnEmptyStocksWithReservation Returns reservation information regardless of inventory levels
2100
+ * @property {(picturesData: Object) => ListProductsRequest} picturesData Data for operations on individual photos
2101
+ * @property {(byMenus: Array<Integer>) => ListProductsRequest} byMenus Define menuItemsIds value nested inside productMenuItems
2102
+ * @property {(byShops: Array<Integer>) => ListProductsRequest} byShops Define shopsIds value nested inside searchByShops
2103
+ * @property {(dateFrom: DateLike, dateTo: DateLike, dateType: "added"|"finished"|"resumed"|"modified"|"quantity_changed"|"price_changed"|"modified_and_quantity_changed") => ListProductsRequest} dates Type of date according to the index results. Possible type values: added, finished, resumed, modified, quantity_changed, price_changed, modified_and_quantity_changed
2104
+ * @property {(elementName: "id"|"name"|"code"|"product_sizecode"|"code_producer"|"retail_price"|"pos_price"|"vat"|"wholesale_price"|"minimal_price"|"pictures_count"|"auction_name"|"pricecomparer_name"|"version_name"|"series_name"|"category_name"|"deliverer_name"|"adding_time"|"modification_time"|"price_changed_time"|"quantity_changed_time"|"currency"|"currency_shop"|"taxcode"|"meta_title"|"meta_description"|"meta_keywords"|"suggested_price"|"observed_clients"|"observed_time"|"wishes_clients"|"wishes_time", descending: Boolean) => ListProductsRequest} orderBy Define sorting by element and direction
2105
+ * @property {(shops: Array<Integer>) => ListProductsRequest} shops Define productShops by passing array of values
2106
+ * @property {(ids: Array<Integer>) => ListProductsRequest} ids Define productParams by passing array of values
2107
+ * @property {(byProducers: Array<Integer>) => ListProductsRequest} byProducers Define producers by passing array of values
2108
+ * @property {(byCategories: Array<Integer>) => ListProductsRequest} byCategories Define categories by passing array of values
2109
+ * @property {(byUnits: Array<Integer>) => ListProductsRequest} byUnits Define productUnits by passing array of values
2110
+ * @property {(bySeries: Array<Integer>) => ListProductsRequest} bySeries Define productSeriesParams by passing array of values
2111
+ * @property {(byWarranties: Array<Integer>) => ListProductsRequest} byWarranties Define productWarranties by passing array of values
2112
+ * @property {(byIndexes: Array<Integer>) => ListProductsRequest} byIndexes Define productIndexes by passing array of values
2113
+ * @property {(onlyMain: Boolean) => ListProductsRequest} onlyMainVersion Toogle to return only main versions
2114
+ * @property {(minPrice: Number, maxPrice: Number, priceType: "retail_price"|"wholesale_price"|"minimal_price"|"pos_price"|"last_purchase_price") => ListProductsRequest} byPrice Filter by minimum and maximym price
2115
+ * @property {(stockIds: Boolean|Array<Integer>) => ListProductsRequest} inStock Filter by availibility on any stock or selected stocks
2116
+ * @property {(page: Integer, limit: Integer) => ListProductsRequest} page Define page number and maximum results per page
2117
+ * @property {() => Integer} count Returns total numer of results
2118
+ * @property {function} exec Excecute request
2119
+ */
2120
+
2121
+ /**
2122
+ * @typedef {Object} GetProductsRequest
2123
+ * @property {(productIds: Array<String>) => GetProductsRequest} productIds List of the unique, indexed product codes (IAI code / External system code / Producer code). You can transfer a maximum of 100 products IDs in one request.
2124
+ * @property {function} exec Excecute request
2125
+ */
2126
+
2127
+ /**
2128
+ * @typedef {Object} PostProductsRequest
2129
+ * @property {(settings: Object) => PostProductsRequest} settings Settings
2130
+ * @property {(picturesSettings: Object) => PostProductsRequest} picturesSettings Icon and photos settings
2131
+ * @property {(products: Array<Object>) => PostProductsRequest} products Products list.
2132
+ * @property {(productId: Integer) => PostProductsRequest} productId Product IAI code
2133
+ * @property {(productSizeCodeExternal: String) => PostProductsRequest} productSizeCodeExternal External product system code for size.
2134
+ * @property {(productDisplayedCode: String) => PostProductsRequest} productDisplayedCode External product system code.
2135
+ * @property {(productTaxCode: String) => PostProductsRequest} productTaxCode PKWiU [PCPandS].
2136
+ * @property {(productInWrapper: Integer) => PostProductsRequest} productInWrapper Number of items in package data
2137
+ * @property {(productSellByRetail: Number) => PostProductsRequest} productSellByRetail Sold at - for retailers.
2138
+ * @property {(productSellByWholesale: Number) => PostProductsRequest} productSellByWholesale Sold at - for wholesalers.
2139
+ * @property {(categoryIdoSellId: Integer) => PostProductsRequest} categoryIdoSellId IdoSell Category ID
2140
+ * @property {(categoryIdoSellPath: String) => PostProductsRequest} categoryIdoSellPath IdoSell Category pathname
2141
+ * @property {(categoryId: Integer) => PostProductsRequest} categoryId Category id
2142
+ * @property {(categoryName: String) => PostProductsRequest} categoryName Category name
2143
+ * @property {(producerId: Integer) => PostProductsRequest} producerId Brand ID
2144
+ * @property {(producerName: String) => PostProductsRequest} producerName Brand name
2145
+ * @property {(cnTaricCode: String) => PostProductsRequest} cnTaricCode CN/TARIC
2146
+ * @property {(countryOfOrigin: String) => PostProductsRequest} countryOfOrigin Country of origin. Country code in the ISO 3166-1 A2 standard
2147
+ * @property {(unitId: Integer) => PostProductsRequest} unitId Product unit of measure ID.
2148
+ * @property {(seriesId: Integer) => PostProductsRequest} seriesId ID of series, to which product belongs.
2149
+ * @property {(seriesPanelName: String) => PostProductsRequest} seriesPanelName Name of series, to which the product belongs, visible in panel.
2150
+ * @property {(sizesGroupId: Integer) => PostProductsRequest} sizesGroupId 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.
2151
+ * @property {(priceChangeMode: String) => PostProductsRequest} priceChangeMode Optional element, that determines prices edition mode. Default value is "amount_set", when indicated element is omitted in API gate call.. Allowed values "amount_set" - sets product prices to desired value (default mode), "amount_diff" - sets sum difference between prices set (adds or subtracts entered sum from the current price), "percent_diff" - sets percentage difference between prices set (adds or subtracts entered percent from the current price).
2152
+ * @property {(priceFormula: Object) => PostProductsRequest} priceFormula The JavaScript formula calculating prices
2153
+ * @property {(productRetailPrice: Number) => PostProductsRequest} productRetailPrice Gross price
2154
+ * @property {(productWholesalePrice: Number) => PostProductsRequest} productWholesalePrice Wholesale price
2155
+ * @property {(productMinimalPrice: Number) => PostProductsRequest} productMinimalPrice Minimal price
2156
+ * @property {(productAutomaticCalculationPrice: Number) => PostProductsRequest} productAutomaticCalculationPrice Price for automatic calculations
2157
+ * @property {(productPosPrice: Number) => PostProductsRequest} productPosPrice price for POS.
2158
+ * @property {(productVat: Number) => PostProductsRequest} productVat Value of VAT
2159
+ * @property {(productVatFree: String) => PostProductsRequest} productVatFree Is product VAT free Allowed values "y" - yes, "n" - no.
2160
+ * @property {(productPriceComparisonSitesPrices: Array<Object>) => PostProductsRequest} productPriceComparisonSitesPrices Different prices for price comparison websites.
2161
+ * @property {(productEnableInPos: String) => PostProductsRequest} productEnableInPos Object determines if the product is available in POS sale Available values: "n" - no, "y" - yes.
2162
+ * @property {(productAdvancePrice: Number) => PostProductsRequest} productAdvancePrice Required advance payment in percents
2163
+ * @property {(productNote: String) => PostProductsRequest} productNote Annotation.
2164
+ * @property {(productProfitPoints: Number) => PostProductsRequest} productProfitPoints Product value in points.
2165
+ * @property {(productWeight: Integer) => PostProductsRequest} productWeight Weight.
2166
+ * @property {(productInVisible: String) => PostProductsRequest} productInVisible Product visibility. Allowed values "y" - product visible, "n" - product not visible.
2167
+ * @property {(productInPersistent: String) => PostProductsRequest} productInPersistent Product visible even though out of stock Available values: "y" - visible even though out of stock, "n" - not visible when out of stock.
2168
+ * @property {(shopsMask: Integer) => PostProductsRequest} shopsMask 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.
2169
+ * @property {(productComplexNotes: Integer) => PostProductsRequest} productComplexNotes Complex rating Available values: "0" - no, "1" - yes.
2170
+ * @property {(productInExportToPriceComparisonSites: String) => PostProductsRequest} productInExportToPriceComparisonSites Product visibility in export to price comparison and marketplaces. Available values: "y" - Visible, "selected" - yes (selected), "n" - invisible.
2171
+ * @property {(priceComparisonSites: Array<Object>) => PostProductsRequest} priceComparisonSites Selection of comparison sites for which the product visibility will be changed
2172
+ * @property {(productInExportToAmazonMarketplace: String) => PostProductsRequest} productInExportToAmazonMarketplace Visibility of an item in an export to Amazon Marketplace. Available values: "y" - Visible, "selected" - Visible on selected regional services, "n" - invisible.
2173
+ * @property {(availableProfile: Integer) => PostProductsRequest} availableProfile Availability profile ID.
2174
+ * @property {(productRebate: Integer) => PostProductsRequest} productRebate Discount profile ID
2175
+ * @property {(warrantyId: Integer) => PostProductsRequest} warrantyId Product warranty ID.
2176
+ * @property {(productPriority: Integer) => PostProductsRequest} productPriority Priority. Allowed values from 1 to 10.
2177
+ * @property {(productIcon: String) => PostProductsRequest} productIcon Product icon details.
2178
+ * @property {(productWatermarkId: Integer) => PostProductsRequest} productWatermarkId Watermark ID
2179
+ * @property {(productWatermarkUrl: String) => PostProductsRequest} productWatermarkUrl Link to watermark
2180
+ * @property {(productPictures: Array<String>) => PostProductsRequest} productPictures List of product photos
2181
+ * @property {(productDescriptionPictures: Array<String>) => PostProductsRequest} productDescriptionPictures List of photos descriptions
2182
+ * @property {(productPromotion: Object) => PostProductsRequest} productPromotion Reduced price
2183
+ * @property {(productDiscount: Object) => PostProductsRequest} productDiscount Discount for shop.
2184
+ * @property {(productDistinguished: Object) => PostProductsRequest} productDistinguished Distinguished product in store.
2185
+ * @property {(productSpecial: Object) => PostProductsRequest} productSpecial Special product in store.
2186
+ * @property {(productParametersDistinction: Array<Object>) => PostProductsRequest} productParametersDistinction Parameters (distinguished).
2187
+ * @property {(associatedProducts: Array<Object>) => PostProductsRequest} associatedProducts List of products recommended with this product
2188
+ * @property {(productSizes: Array<Object>) => PostProductsRequest} productSizes Sizes available for products data.
2189
+ * @property {(productShopsAttributes: Array<Object>) => PostProductsRequest} productShopsAttributes Data concerning attributes dependent on indicated stores with particular product assigned.
2190
+ * @property {(productNames: Object) => PostProductsRequest} productNames Product name.
2191
+ * @property {(productDescriptions: Object) => PostProductsRequest} productDescriptions
2192
+ * @property {(productLongDescriptions: Object) => PostProductsRequest} productLongDescriptions Long product description
2193
+ * @property {(productAuctionDescriptionsData: Array<Object>) => PostProductsRequest} productAuctionDescriptionsData Product data for auction services
2194
+ * @property {(productMetaTitles: Object) => PostProductsRequest} productMetaTitles Product meta title
2195
+ * @property {(productMetaDescriptions: Object) => PostProductsRequest} productMetaDescriptions Product meta description
2196
+ * @property {(productMetaKeywords: Object) => PostProductsRequest} productMetaKeywords Product meta keywords.
2197
+ * @property {(productUrl: Object) => PostProductsRequest} productUrl #!AdresURLDlaTowaru!#.
2198
+ * @property {(productVersion: Object) => PostProductsRequest} productVersion Data on product groups (variants)
2199
+ * @property {(currencyId: String) => PostProductsRequest} currencyId Currency ID
2200
+ * @property {(delivererId: Integer) => PostProductsRequest} delivererId Supplier ID.
2201
+ * @property {(productParametersDistinctionChangeMode: 'add'|'delete'|'delete_group'|'replace') => PostProductsRequest} productParametersDistinctionChangeMode This parameter is optional and it determines properties edition mode. Default value is "replace". Allowed values: "add" - adds properties to already existent ones, "delete" - removes properties of already existent ones, "delete_group" - removes properties from selected group, "replace" - overwrites properties already existent with new ones (default mode).
2202
+ * @property {(productDeliveryTime: Object) => PostProductsRequest} productDeliveryTime Product delivery time from the producer to the shop
2203
+ * @property {(productSumInBasket: String) => PostProductsRequest} productSumInBasket Do You wish to sum up the products in the basket as a one order? Available values: "y" - yes, "n" - no.
2204
+ * @property {(dispatchSettings: Object) => PostProductsRequest} dispatchSettings Shipping, returns and complaints settings
2205
+ * @property {(standardUnit: Object) => PostProductsRequest} standardUnit Standard unit settings
2206
+ * @property {(minQuantityPerOrder: Object) => PostProductsRequest} minQuantityPerOrder Minimal number of products in an order
2207
+ * @property {(productDimensions: Object) => PostProductsRequest} productDimensions Dimensions and overall weight
2208
+ * @property {function} append Append current data to array and start modifying next row
2209
+ * @property {function} exec Excecute request
2210
+ */
2211
+
2212
+ /**
2213
+ * @typedef {Object} PutProductsRequest
2214
+ * @property {(settings: Object) => PutProductsRequest} settings Settings
2215
+ * @property {(picturesSettings: Object) => PutProductsRequest} picturesSettings Icon and photos settings
2216
+ * @property {(products: Array<Object>) => PutProductsRequest} products Products list.
2217
+ * @property {(productId: Integer) => PutProductsRequest} productId Product IAI code
2218
+ * @property {(productIndex: String) => PutProductsRequest} productIndex One of the unique, indexed product codes (IAI code / External system code / Producer code)
2219
+ * @property {(productSizeCodeExternal: String) => PutProductsRequest} productSizeCodeExternal External product system code for size.
2220
+ * @property {(productSizeCodeProducer: String) => PutProductsRequest} productSizeCodeProducer Producer code for size.
2221
+ * @property {(productDisplayedCode: String) => PutProductsRequest} productDisplayedCode External product system code.
2222
+ * @property {(productTaxCode: String) => PutProductsRequest} productTaxCode PKWiU [PCPandS].
2223
+ * @property {(productInWrapper: Integer) => PutProductsRequest} productInWrapper Number of items in package data
2224
+ * @property {(productSellByRetail: Number) => PutProductsRequest} productSellByRetail Sold at - for retailers.
2225
+ * @property {(productSellByWholesale: Number) => PutProductsRequest} productSellByWholesale Sold at - for wholesalers.
2226
+ * @property {(categoryIdoSellId: Integer) => PutProductsRequest} categoryIdoSellId IdoSell Category ID
2227
+ * @property {(categoryIdoSellPath: String) => PutProductsRequest} categoryIdoSellPath IdoSell Category pathname
2228
+ * @property {(categoryId: Integer) => PutProductsRequest} categoryId Category id
2229
+ * @property {(categoryName: String) => PutProductsRequest} categoryName Category name
2230
+ * @property {(producerId: Integer) => PutProductsRequest} producerId Brand ID
2231
+ * @property {(producerName: String) => PutProductsRequest} producerName Brand name
2232
+ * @property {(cnTaricCode: String) => PutProductsRequest} cnTaricCode CN/TARIC
2233
+ * @property {(countryOfOrigin: String) => PutProductsRequest} countryOfOrigin Country of origin. Country code in the ISO 3166-1 A2 standard
2234
+ * @property {(unitId: Integer) => PutProductsRequest} unitId Product unit of measure ID.
2235
+ * @property {(seriesId: Integer) => PutProductsRequest} seriesId ID of series, to which product belongs.
2236
+ * @property {(seriesPanelName: String) => PutProductsRequest} seriesPanelName Name of series, to which the product belongs, visible in panel.
2237
+ * @property {(sizesGroupId: Integer) => PutProductsRequest} sizesGroupId 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.
2238
+ * @property {(sizesGroupName: String) => PutProductsRequest} sizesGroupName Size group name.
2239
+ * @property {(priceChangeMode: String) => PutProductsRequest} priceChangeMode Optional element, that determines prices edition mode. Default value is "amount_set", when indicated element is omitted in API gate call.. Allowed values "amount_set" - sets product prices to desired value (default mode), "amount_diff" - sets sum difference between prices set (adds or subtracts entered sum from the current price), "percent_diff" - sets percentage difference between prices set (adds or subtracts entered percent from the current price).
2240
+ * @property {(productRetailPrice: Number) => PutProductsRequest} productRetailPrice Gross price
2241
+ * @property {(productRetailPriceNet: Number) => PutProductsRequest} productRetailPriceNet Net retail price for every shop.
2242
+ * @property {(productWholesalePrice: Number) => PutProductsRequest} productWholesalePrice Wholesale price
2243
+ * @property {(productWholesalePriceNet: Number) => PutProductsRequest} productWholesalePriceNet Net wholesale price for every shop.
2244
+ * @property {(productMinimalPrice: Number) => PutProductsRequest} productMinimalPrice Minimal price
2245
+ * @property {(productMinimalPriceNet: Number) => PutProductsRequest} productMinimalPriceNet Net minimum price for every shop.
2246
+ * @property {(productAutomaticCalculationPrice: Number) => PutProductsRequest} productAutomaticCalculationPrice Price for automatic calculations
2247
+ * @property {(productAutomaticCalculationPriceNet: Number) => PutProductsRequest} productAutomaticCalculationPriceNet #!CenaDoObliczenAutomatycznychNettoDlaKazdegoSklepu!#.
2248
+ * @property {(productPosPrice: Number) => PutProductsRequest} productPosPrice price for POS.
2249
+ * @property {(productPosPriceNet: Number) => PutProductsRequest} productPosPriceNet price for POS.
2250
+ * @property {(productSuggestedPrice: Number) => PutProductsRequest} productSuggestedPrice Recommended retail price
2251
+ * @property {(productSuggestedPriceNet: Number) => PutProductsRequest} productSuggestedPriceNet Suggested net commodity price.
2252
+ * @property {(productStrikethroughRetailPrice: Number) => PutProductsRequest} productStrikethroughRetailPrice Strikethrough gross retail price
2253
+ * @property {(productStrikethroughRetailPriceNet: Number) => PutProductsRequest} productStrikethroughRetailPriceNet Strikethrough net retail price
2254
+ * @property {(productStrikethroughWholesalePrice: Number) => PutProductsRequest} productStrikethroughWholesalePrice Strikethrough gross wholesale price
2255
+ * @property {(productStrikethroughWholesalePriceNet: Number) => PutProductsRequest} productStrikethroughWholesalePriceNet Strikethrough net wholesale price
2256
+ * @property {(productVat: Number) => PutProductsRequest} productVat Value of VAT
2257
+ * @property {(productVatFree: String) => PutProductsRequest} productVatFree Is product VAT free Allowed values "y" - yes, "n" - no.
2258
+ * @property {(productPriceComparisonSitesPrices: Array<Object>) => PutProductsRequest} productPriceComparisonSitesPrices Different prices for price comparison websites.
2259
+ * @property {(productEnableInPos: String) => PutProductsRequest} productEnableInPos Object determines if the product is available in POS sale Available values: "n" - no, "y" - yes.
2260
+ * @property {(productAdvancePrice: Number) => PutProductsRequest} productAdvancePrice Required advance payment in percents
2261
+ * @property {(productNote: String) => PutProductsRequest} productNote Annotation.
2262
+ * @property {(productHotspotsZones: Array<Object>) => PutProductsRequest} productHotspotsZones Settings of hotspots display.
2263
+ * @property {(priceInPoints: Object) => PutProductsRequest} priceInPoints Loyalty points.
2264
+ * @property {(loyaltyPoints: Array<Object>) => PutProductsRequest} loyaltyPoints Loyalty points.
2265
+ * @property {(productWeight: Integer) => PutProductsRequest} productWeight Weight.
2266
+ * @property {(productInVisible: String) => PutProductsRequest} productInVisible Product visibility. Allowed values "y" - product visible, "n" - product not visible.
2267
+ * @property {(shopsMask: Integer) => PutProductsRequest} shopsMask 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.
2268
+ * @property {(productComplexNotes: Integer) => PutProductsRequest} productComplexNotes Complex rating Available values: "0" - no, "1" - yes.
2269
+ * @property {(productInExportToPriceComparisonSites: 'y'|'selected'|'n') => PutProductsRequest} productInExportToPriceComparisonSites 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.
2270
+ * @property {(priceComparisonSites: Array<Object>) => PutProductsRequest} priceComparisonSites Selection of comparison sites for which the product visibility will be changed
2271
+ * @property {(productInExportToAmazonMarketplace: String) => PutProductsRequest} productInExportToAmazonMarketplace Visibility of an item in an export to Amazon Marketplace. Available values: "y" - Visible, "selected" - Visible on selected regional services, "n" - invisible.
2272
+ * @property {(exportToAmazonMarketplacesList: Array<String>) => PutProductsRequest} exportToAmazonMarketplacesList Array
2273
+ * @property {(exportToAmazonExportAllSizes: 'n'|'y') => PutProductsRequest} exportToAmazonExportAllSizes Export sizes to Amazon: Available values: "y" - all, "n" - leave without change.
2274
+ * @property {(exportAmazonUpdateStocks: 'n'|'y') => PutProductsRequest} exportAmazonUpdateStocks Update merchandise inventory, on the Amazon side
2275
+ * @property {(productInExportToStrefaMarekAllegro: String) => PutProductsRequest} productInExportToStrefaMarekAllegro Visibility of product during the import to Strefa Marek Allegro. Allowed values: "yes" - product visible in the export to Strefa Marek Allegro, "no" - product invisible in the export to Strefa Marek Allegro.
2276
+ * @property {(productInExportToSmaPreset: Integer) => PutProductsRequest} productInExportToSmaPreset Profile ID which should be used when sending products to Strefa Marek Allegro.
2277
+ * @property {(availableProfile: Integer) => PutProductsRequest} availableProfile Availability profile ID.
2278
+ * @property {(productRebate: Integer) => PutProductsRequest} productRebate Discount profile ID
2279
+ * @property {(warrantyId: Integer) => PutProductsRequest} warrantyId Product warranty ID.
2280
+ * @property {(warrantyName: String) => PutProductsRequest} warrantyName Name of warranty for indicated product.
2281
+ * @property {(priceFormula: Object) => PutProductsRequest} priceFormula The JavaScript formula calculating prices
2282
+ * @property {(sizeChartId: Integer) => PutProductsRequest} sizeChartId Size chart ID
2283
+ * @property {(sizeChartName: String) => PutProductsRequest} sizeChartName Size chart name
2284
+ * @property {(productPriority: Integer) => PutProductsRequest} productPriority Priority. Allowed values from 1 to 10.
2285
+ * @property {(productPriorityInMenuNodes: Array<Object>) => PutProductsRequest} productPriorityInMenuNodes Product priority in menu node.
2286
+ * @property {(productIconLink: String) => PutProductsRequest} productIconLink Product icon link.
2287
+ * @property {(productAuctionIconLink: String) => PutProductsRequest} productAuctionIconLink Photo without background.
2288
+ * @property {(productGroupIconLink: String) => PutProductsRequest} productGroupIconLink Icon for a product group.
2289
+ * @property {(productPictures: Array<Object>) => PutProductsRequest} productPictures List of product photos
2290
+ * @property {(productPicturesReplace: Array<Object>) => PutProductsRequest} productPicturesReplace List of a product's photos with indication of a particular number of the photo.
2291
+ * @property {(productPromotion: Object) => PutProductsRequest} productPromotion Reduced price
2292
+ * @property {(productDiscount: Object) => PutProductsRequest} productDiscount Discount for shop.
2293
+ * @property {(productDistinguished: Object) => PutProductsRequest} productDistinguished Distinguished product in store.
2294
+ * @property {(productSpecial: Object) => PutProductsRequest} productSpecial Special product in store.
2295
+ * @property {(productParametersDistinction: Array<Object>) => PutProductsRequest} productParametersDistinction Parameters (distinguished).
2296
+ * @property {(parametersConfigurable: Array<Object>) => PutProductsRequest} parametersConfigurable Configuration parameters
2297
+ * @property {(associatedProducts: Array<Object>) => PutProductsRequest} associatedProducts List of products recommended with this product
2298
+ * @property {(productSizes: Array<Object>) => PutProductsRequest} productSizes Sizes available for products data.
2299
+ * @property {(attachments: Array<Object>) => PutProductsRequest} attachments Product attachments list.
2300
+ * @property {(removeAttachments: Array<Object>) => PutProductsRequest} removeAttachments The list of attachments to be deleted.
2301
+ * @property {(virtualAttachmentsToRemove: Boolean) => PutProductsRequest} virtualAttachmentsToRemove Do you want to delete attachments for digital files.
2302
+ * @property {(virtualAttachments: Array<Object>) => PutProductsRequest} virtualAttachments List of product's virtual attachments.
2303
+ * @property {(attachmentOperationValues: 'edit'|'add'|'remove') => PutProductsRequest} attachmentOperationValues Operation, that will be performed on attachments to product.
2304
+ * @property {(productShopsAttributes: Array<Object>) => PutProductsRequest} productShopsAttributes Data concerning attributes dependent on indicated stores with particular product assigned.
2305
+ * @property {(productNames: Object) => PutProductsRequest} productNames Product name.
2306
+ * @property {(productNamesInAuction: Object) => PutProductsRequest} productNamesInAuction DEPRECATED. This parameter is deprecated. Product name for online auctions.
2307
+ * @property {(productNamesInPriceComparer: Object) => PutProductsRequest} productNamesInPriceComparer Product name for price comparison websites.
2308
+ * @property {(productParamDescriptions: Object) => PutProductsRequest} productParamDescriptions Product short description
2309
+ * @property {(productLongDescriptions: Object) => PutProductsRequest} productLongDescriptions Long product description
2310
+ * @property {(productLongDescriptionsInAuction: Object) => PutProductsRequest} productLongDescriptionsInAuction DEPRECATED. This parameter is deprecated. Product description for marketplaces.
2311
+ * @property {(productAuctionDescriptionsData: Array<Object>) => PutProductsRequest} productAuctionDescriptionsData Product data for auction services
2312
+ * @property {(productMetaTitles: Object) => PutProductsRequest} productMetaTitles Product meta title
2313
+ * @property {(productMetaDescriptions: Object) => PutProductsRequest} productMetaDescriptions Product meta description
2314
+ * @property {(productMetaKeywords: Object) => PutProductsRequest} productMetaKeywords Product meta keywords.
2315
+ * @property {(productUrl: Object) => PutProductsRequest} productUrl #!AdresURLDlaTowaru!#.
2316
+ * @property {(productVersion: Object) => PutProductsRequest} productVersion Data on product groups (variants)
2317
+ * @property {(currencyId: String) => PutProductsRequest} currencyId Currency ID
2318
+ * @property {(productCurrenciesShops: Array<Object>) => PutProductsRequest} productCurrenciesShops Currency, in which product prices are stored.
2319
+ * @property {(delivererId: Integer) => PutProductsRequest} delivererId Supplier ID.
2320
+ * @property {(delivererName: String) => PutProductsRequest} delivererName Supplier name.
2321
+ * @property {(productParametersDistinctionChangeMode: 'add'|'delete'|'delete_group'|'replace') => PutProductsRequest} productParametersDistinctionChangeMode This parameter is optional and it determines properties edition mode. Default value is "replace". Allowed values: "add" - adds properties to already existent ones, "delete" - removes properties of already existent ones, "delete_group" - removes properties from selected group, "replace" - overwrites properties already existent with new ones (default mode).
2322
+ * @property {(productDeliveryTime: Object) => PutProductsRequest} productDeliveryTime Product delivery time from the producer to the shop
2323
+ * @property {(productParameters: Array<Object>) => PutProductsRequest} productParameters Parameters.
2324
+ * @property {(clearProductParameters: Boolean) => PutProductsRequest} clearProductParameters
2325
+ * @property {(changeParametersDistinction: Array<Object>) => PutProductsRequest} changeParametersDistinction Change parameter distinction.
2326
+ * @property {(productPriceVatChangeMode: 'change_net'|'change_gross') => PutProductsRequest} productPriceVatChangeMode VAT rate change mode:. "change_gross" - changes the product gross price, leaving the net price unchanged, "change_net" - changes the net price, leaving the gross price unchanged (default mode).
2327
+ * @property {(productMenuItems: Array<Object>) => PutProductsRequest} productMenuItems An array of menu elements
2328
+ * @property {(removeAllProductsAssignedToMenu: Object) => PutProductsRequest} removeAllProductsAssignedToMenu #!UsuwaWszystkiePrzypisaneDoProduktuElementyWybranegoMenu!#.
2329
+ * @property {(productSumInBasket: String) => PutProductsRequest} productSumInBasket Do You wish to sum up the products in the basket as a one order? Available values: "y" - yes, "n" - no.
2330
+ * @property {(productShopsPricesConfig: 'same_prices'|'different_prices') => PutProductsRequest} productShopsPricesConfig Settings of prices for shop. Values allowed: "same_prices" - prices in each shop are the same, "different_prices" - prices in each shop are different.
2331
+ * @property {(productPosPricesConfig: 'pos_equals_retail'|'pos_notequals_retail'|'not_available_in_pos'|'sizes_pos_price_as_base_price') => PutProductsRequest} productPosPricesConfig Price settings for POS. Allowed values: "pos_equals_retail" - sets POS price the same as retail price. Possible to set only if the "shops_prices_config" parameter is set to jest same_prices or there is only one shop in panel, "pos_notequals_retail" - Price for POS different than retail price, "not_available_in_pos" - Product not available for POS sales. "sizes_pos_price_as_base_price" - Remove prices for sizes and set a sale price which equals a basic price.
2332
+ * @property {(productType: 'product_item'|'product_free'|'product_packaging'|'product_bundle'|'product_collection'|'product_virtual'|'product_service'|'product_configurable') => PutProductsRequest} productType Product type. Allowed values: "product_item" - Goods, "product_free" - Free product, "product_packaging" - packaging, "product_bundle" - set. "product_collection" - collection. "product_service" - service. "product_virtual" - virtual product. "product_configurable" - configurable product.
2333
+ * @property {(priceRoundMode: 'none'|'00'|'x0'|'99'|'x9') => PutProductsRequest} priceRoundMode Forced rounding up method.
2334
+ * @property {(productAvailabilityManagementType: 'manual'|'stock') => PutProductsRequest} productAvailabilityManagementType Product availability management method Available values: "stock" - by means of stock management tools, "manual" - manually.
2335
+ * @property {(removeChooseSizesValues: Array<String>) => PutProductsRequest} removeChooseSizesValues List of unused sizes in product to be deleted
2336
+ * @property {(removeAllUnusedProductSizes: Boolean) => PutProductsRequest} removeAllUnusedProductSizes Remove all unused sizes.
2337
+ * @property {(producerCodesStandard: 'auto'|'GTIN14'|'GTIN13'|'ISBN13'|'GTIN12'|'ISBN10'|'GTIN8'|'UPCE'|'MPN'|'other') => PutProductsRequest} producerCodesStandard 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
2338
+ * @property {(javaScriptInTheItemCard: Array<Object>) => PutProductsRequest} javaScriptInTheItemCard JavaScript code displayed in the product page of the IdoSell Shop
2339
+ * @property {(serialNumbersOption: 'na'|'optional'|'required') => PutProductsRequest} serialNumbersOption Saving serial numbers Available values: "na" - not used, "optional" - Optional, "required" - required.
2340
+ * @property {(dispatchSettings: Object) => PutProductsRequest} dispatchSettings Shipping, returns and complaints settings
2341
+ * @property {(standardUnit: Object) => PutProductsRequest} standardUnit Standard unit settings
2342
+ * @property {(minQuantityPerOrder: Object) => PutProductsRequest} minQuantityPerOrder Minimal number of products in an order
2343
+ * @property {(dynamicPricingEnabled: String) => PutProductsRequest} dynamicPricingEnabled
2344
+ * @property {(clearStockQuantities: Object) => PutProductsRequest} clearStockQuantities The setting allows you to reset the inventory to zero
2345
+ * @property {(productDimensions: Object) => PutProductsRequest} productDimensions Dimensions and overall weight
2346
+ * @property {function} append Append current data to array and start modifying next row
2347
+ * @property {(text: String, type: "name"|"short"|"long"|"metatitle"|"metadescription"|"metakeywords"|"acutionname"|"auctiondescription", language: String, shopId: Integer) => PutProductsRequest} setText Set various types of names or descriptions to the product
2348
+ * @property {function} exec Excecute request
2349
+ */
2350
+
2351
+ /**
2352
+ * @typedef {Object} DeleteProductsProductsToFacebookCatalogRequest
2353
+ * @property {(facebookCatalogId: Integer) => DeleteProductsProductsToFacebookCatalogRequest} facebookCatalogId You can read the Facebook Catalog ID in the Marketing & Integrations/Facebook/Facebook Product Catalog admin panel
2354
+ * @property {(shopId: Integer) => DeleteProductsProductsToFacebookCatalogRequest} shopId Shop Id
2355
+ * @property {(products: Array<Integer>) => DeleteProductsProductsToFacebookCatalogRequest} products Products list.
2356
+ * @property {function} exec Excecute request
2357
+ */
2358
+
2359
+ /**
2360
+ * @typedef {Object} GetProductsProductsToFacebookCatalogRequest
2361
+ * @property {(facebookCatalogId: Integer) => GetProductsProductsToFacebookCatalogRequest} facebookCatalogId You can read the Facebook Catalog ID in the Marketing & Integrations/Facebook/Facebook Product Catalog admin panel
2362
+ * @property {(shopId: Integer) => GetProductsProductsToFacebookCatalogRequest} shopId Shop Id
2363
+ * @property {function} exec Excecute request
2364
+ */
2365
+
2366
+ /**
2367
+ * @typedef {Object} PostProductsProductsToFacebookCatalogRequest
2368
+ * @property {(facebookCatalogId: Integer) => PostProductsProductsToFacebookCatalogRequest} facebookCatalogId You can read the Facebook Catalog ID in the Marketing & Integrations/Facebook/Facebook Product Catalog admin panel
2369
+ * @property {(shopId: Integer) => PostProductsProductsToFacebookCatalogRequest} shopId Shop Id
2370
+ * @property {(products: Array<Integer>) => PostProductsProductsToFacebookCatalogRequest} products Products list.
2371
+ * @property {function} exec Excecute request
2372
+ */
2373
+
2374
+ /**
2375
+ * @typedef {Object} DeleteProductsProductsToPromotionRequest
2376
+ * @property {(promotionId: Integer) => DeleteProductsProductsToPromotionRequest} promotionId Special offer ID
2377
+ * @property {(products: Array<Integer>) => DeleteProductsProductsToPromotionRequest} products Products list.
2378
+ * @property {function} exec Excecute request
2379
+ */
2380
+
2381
+ /**
2382
+ * @typedef {Object} PostProductsProductsToPromotionRequest
2383
+ * @property {(promotionId: Integer) => PostProductsProductsToPromotionRequest} promotionId Special offer ID
2384
+ * @property {(products: Array<Integer>) => PostProductsProductsToPromotionRequest} products Products list.
2385
+ * @property {function} exec Excecute request
2386
+ */
2387
+
2388
+ /**
2389
+ * @typedef {Object} GetProductsQuestionsRequest
2390
+ * @property {(id: Integer) => GetProductsQuestionsRequest} id Question ID.
2391
+ * @property {(productId: Integer) => GetProductsQuestionsRequest} productId Product IAI code
2392
+ * @property {function} exec Excecute request
2393
+ */
2394
+
2395
+ /**
2396
+ * @typedef {Object} PutProductsQuestionsRequest
2397
+ * @property {(questions: Array<Object>) => PutProductsQuestionsRequest} questions Question Board.
2398
+ * @property {(id: Integer) => PutProductsQuestionsRequest} id Question ID.
2399
+ * @property {(lang: String) => PutProductsQuestionsRequest} lang Language of the question e.g. 'pol', 'eng'.
2400
+ * @property {(question: String) => PutProductsQuestionsRequest} question Your question(base64).
2401
+ * @property {(answer: String) => PutProductsQuestionsRequest} answer Content of the answer(base64).
2402
+ * @property {(dateAdd: String) => PutProductsQuestionsRequest} dateAdd The date the question was created.
2403
+ * @property {(host: String) => PutProductsQuestionsRequest} host The name and address of the host from which the question was added.
2404
+ * @property {(author: String) => PutProductsQuestionsRequest} author Author.
2405
+ * @property {(productIdent: Object) => PutProductsQuestionsRequest} productIdent Stock keeping unit.
2406
+ * @property {(visible: 'n'|'y') => PutProductsQuestionsRequest} visible Visibility: "y" - yes, "n" - no
2407
+ * @property {(priority: Integer) => PutProductsQuestionsRequest} priority Priority.
2408
+ * @property {(confirmed: 'n'|'y') => PutProductsQuestionsRequest} confirmed Validate the question: "y" - yes, "n" - no
2409
+ * @property {(shopId: Integer) => PutProductsQuestionsRequest} shopId Shop Id
2410
+ * @property {(answerDate: String) => PutProductsQuestionsRequest} answerDate Date of response.
2411
+ * @property {(answerAuthor: String) => PutProductsQuestionsRequest} answerAuthor Response author.
2412
+ * @property {function} append Append current data to array and start modifying next row
2413
+ * @property {function} exec Excecute request
2414
+ */
2415
+
2416
+ /**
2417
+ * @typedef {Object} GetProductsReservationsRequest
2418
+ * @property {(productsIdents: Array<Object>) => GetProductsReservationsRequest} productsIdents Products list.
2419
+ * @property {(ids: Array<[object Object]>) => GetProductsReservationsRequest} ids Define productsIdents by passing array of values
2420
+ * @property {(externalCodes: Array<String>) => GetProductsReservationsRequest} externalCodes Define productsIdents by passing array of values
2421
+ * @property {(producerCodes: Array<String>) => GetProductsReservationsRequest} producerCodes Define productsIdents by passing array of values
2422
+ * @property {function} exec Excecute request
2423
+ */
2424
+
2425
+ /**
2426
+ * @typedef {Object} PostProductsRestoreRequest
2427
+ * @property {(productId: Integer) => PostProductsRestoreRequest} productId Product IAI code
2428
+ * @property {function} exec Excecute request
2429
+ */
2430
+
2431
+ /**
2432
+ * @typedef {Object} DeleteProductsSeriesRequest
2433
+ * @property {(ids: Array<Integer>) => DeleteProductsSeriesRequest} ids IDs
2434
+ * @property {function} exec Excecute request
2435
+ */
2436
+
2437
+ /**
2438
+ * @typedef {Object} GetProductsSeriesRequest
2439
+ * @property {(return_last_changed_time: String) => GetProductsSeriesRequest} return_last_changed_time With "y" value it returns the last series modification date in YYYY-MM-DD HH:MM:SS format.
2440
+ * @property {(ids: Array<Integer>) => GetProductsSeriesRequest} ids IDs
2441
+ * @property {(names: Array<String>) => GetProductsSeriesRequest} names Names
2442
+ * @property {(languagesIds: Array<String>) => GetProductsSeriesRequest} languagesIds List of languages
2443
+ * @property {(resultsPage: Integer) => GetProductsSeriesRequest} resultsPage Page with results number. Numeration starts from 0
2444
+ * @property {(resultsLimit: Integer) => GetProductsSeriesRequest} resultsLimit Number of results on page. Value from 1 to 100
2445
+ * @property {(page: Integer, limit: Integer) => GetProductsSeriesRequest} page Define page number and maximum results per page
2446
+ * @property {() => Integer} count Returns total numer of results
2447
+ * @property {function} exec Excecute request
2448
+ */
2449
+
2450
+ /**
2451
+ * @typedef {Object} PutProductsSeriesRequest
2452
+ * @property {(series: Array<Object>) => PutProductsSeriesRequest} series Series list.
2453
+ * @property {(id: Integer) => PutProductsSeriesRequest} id Id
2454
+ * @property {(nameInPanel: String) => PutProductsSeriesRequest} nameInPanel Name in panel
2455
+ * @property {(shopsConfigurations: Array<Object>) => PutProductsSeriesRequest} shopsConfigurations
2456
+ * @property {function} append Append current data to array and start modifying next row
2457
+ * @property {function} exec Excecute request
2458
+ */
2459
+
2460
+ /**
2461
+ * @typedef {Object} GetProductsSeriesFilterRequest
2462
+ * @property {(shopId: Integer) => GetProductsSeriesFilterRequest} shopId Shop Id
2463
+ * @property {(languageId: String) => GetProductsSeriesFilterRequest} languageId Language ID (code in ISO 639-2).
2464
+ * @property {(serieId: Integer) => GetProductsSeriesFilterRequest} serieId Series Id
2465
+ * @property {function} exec Excecute request
2466
+ */
2467
+
2468
+ /**
2469
+ * @typedef {Object} PutProductsSeriesFilterRequest
2470
+ * @property {(shopId: Integer) => PutProductsSeriesFilterRequest} shopId Shop Id
2471
+ * @property {(languageId: String) => PutProductsSeriesFilterRequest} languageId Language ID (code in ISO 639-2).
2472
+ * @property {(serieId: Integer) => PutProductsSeriesFilterRequest} serieId Series Id
2473
+ * @property {(filterForNodeIsDefault: 'y'|'n') => PutProductsSeriesFilterRequest} filterForNodeIsDefault
2474
+ * @property {(filtersActive: Array<Object>) => PutProductsSeriesFilterRequest} filtersActive Active filters.
2475
+ * @property {(filterId: String) => PutProductsSeriesFilterRequest} filterId Menu filter ID.
2476
+ * @property {(filterName: String) => PutProductsSeriesFilterRequest} filterName Filter name on page.
2477
+ * @property {(filterDisplay: 'name'|'gfx'|'namegfx') => PutProductsSeriesFilterRequest} filterDisplay Display as: "name" - text, "gfx" - graphics, "namegfx" - text and graphics.
2478
+ * @property {(filterValueSort: 'y'|'n'|'priority') => PutProductsSeriesFilterRequest} filterValueSort Sort by: "y" - alfabetically, "n" - by frequency and order of occurrence of indicated parameter value in found products, "priority" - according to value sequence in parameter.
2479
+ * @property {(filterDefaultEnabled: 'y'|'n') => PutProductsSeriesFilterRequest} filterDefaultEnabled Enabled by default .
2480
+ * @property {function} append Append current data to array and start modifying next row
2481
+ * @property {function} exec Excecute request
2482
+ */
2483
+
2484
+ /**
2485
+ * @typedef {Object} DeleteProductsSizesRequest
2486
+ * @property {(mode: 'delete_by_size'|'delete_all') => DeleteProductsSizesRequest} mode Edition mode
2487
+ * @property {(params: Array<Object>) => DeleteProductsSizesRequest} params Parameters transmitted to method
2488
+ * @property {(deleteSizesIndexesData: Array<String>) => DeleteProductsSizesRequest} deleteSizesIndexesData Product parameters recognized by index.
2489
+ * @property {(productId: Integer) => DeleteProductsSizesRequest} productId Product IAI code
2490
+ * @property {(sizes: Array<Object>) => DeleteProductsSizesRequest} sizes List of sizes
2491
+ * @property {function} append Append current data to array and start modifying next row
2492
+ * @property {function} exec Excecute request
2493
+ */
2494
+
2495
+ /**
2496
+ * @typedef {Object} GetProductsSizesRequest
2497
+ * @property {(result::page: Integer) => GetProductsSizesRequest} result::page Page with results number. Numeration starts from 0
2498
+ * @property {(result::pageNumber: Integer) => GetProductsSizesRequest} result::pageNumber Number of results on page. Value from 1 to 100
2499
+ * @property {(page: Integer, limit: Integer) => GetProductsSizesRequest} page Define page number and maximum results per page
2500
+ * @property {function} exec Excecute request
2501
+ */
2502
+
2503
+ /**
2504
+ * @typedef {Object} PutProductsSizesRequest
2505
+ * @property {(mode: 'edit'|'add'|'replace') => PutProductsSizesRequest} mode Edition mode
2506
+ * @property {(sizesProductsData: Array<Object>) => PutProductsSizesRequest} sizesProductsData Product parameters recognized by product ID or its sizes
2507
+ * @property {(indexesData: Array<Object>) => PutProductsSizesRequest} indexesData Product parameters recognized by index
2508
+ * @property {(productId: Integer) => PutProductsSizesRequest} productId Product IAI code
2509
+ * @property {(sizes: Array<Object>) => PutProductsSizesRequest} sizes List of sizes
2510
+ * @property {function} append Append current data to array and start modifying next row
2511
+ * @property {function} exec Excecute request
2512
+ */
2513
+
2514
+ /**
2515
+ * @typedef {Object} PutProductsStockQuantityRequest
2516
+ * @property {(products: Array<Object>) => PutProductsStockQuantityRequest} products Products list.
2517
+ * @property {(productSizeCodeExternal: String) => PutProductsStockQuantityRequest} productSizeCodeExternal External product system code for size.
2518
+ * @property {(stockId: Integer) => PutProductsStockQuantityRequest} stockId Stock ID
2519
+ * @property {(productSizeQuantity: Number) => PutProductsStockQuantityRequest} productSizeQuantity Product stock quantity
2520
+ * @property {(productPurchasePrice: Number) => PutProductsStockQuantityRequest} productPurchasePrice Cost price
2521
+ * @property {(productPurchasePriceNet: Number) => PutProductsStockQuantityRequest} productPurchasePriceNet Net purchase price
2522
+ * @property {function} append Append current data to array and start modifying next row
2523
+ * @property {function} exec Excecute request
2524
+ */
2525
+
2526
+ /**
2527
+ * @typedef {Object} GetProductsStocksRequest
2528
+ * @property {(products: Array<Object>) => GetProductsStocksRequest} products Products list.
2529
+ * @property {(ids: Array<[object Object]>) => GetProductsStocksRequest} ids Define products by passing array of values
2530
+ * @property {(externalCodes: Array<String>) => GetProductsStocksRequest} externalCodes Define products by passing array of values
2531
+ * @property {(producerCodes: Array<String>) => GetProductsStocksRequest} producerCodes Define products by passing array of values
2532
+ * @property {function} exec Excecute request
2533
+ */
2534
+
2535
+ /**
2536
+ * @typedef {Object} PutProductsStocksRequest
2537
+ * @property {(products: Array<Object>) => PutProductsStocksRequest} products Products list.
2538
+ * @property {(ident: Object) => PutProductsStocksRequest} ident
2539
+ * @property {(sizes: Array<Object>) => PutProductsStocksRequest} sizes List of sizes
2540
+ * @property {(settings: Object) => PutProductsStocksRequest} settings
2541
+ * @property {(error: Object) => PutProductsStocksRequest} error Error information.
2542
+ * @property {function} append Append current data to array and start modifying next row
2543
+ * @property {function} exec Excecute request
2544
+ */
2545
+
2546
+ /**
2547
+ * @typedef {Object} GetProductsStrikethroughPricesRequest
2548
+ * @property {(products: Array<Object>) => GetProductsStrikethroughPricesRequest} products Products list.
2549
+ * @property {(ids: Array<[object Object]>) => GetProductsStrikethroughPricesRequest} ids Define products by passing array of values
2550
+ * @property {(externalCodes: Array<String>) => GetProductsStrikethroughPricesRequest} externalCodes Define products by passing array of values
2551
+ * @property {(producerCodes: Array<String>) => GetProductsStrikethroughPricesRequest} producerCodes Define products by passing array of values
2552
+ * @property {function} exec Excecute request
2553
+ */
2554
+
2555
+ /**
2556
+ * @typedef {Object} PutProductsStrikethroughPricesRequest
2557
+ * @property {(products: Array<Object>) => PutProductsStrikethroughPricesRequest} products Products list.
2558
+ * @property {(ident: Object) => PutProductsStrikethroughPricesRequest} ident Identifier type.
2559
+ * @property {(sizes: Array<Object>) => PutProductsStrikethroughPricesRequest} sizes List of sizes
2560
+ * @property {(stp_settings: Object) => PutProductsStrikethroughPricesRequest} stp_settings
2561
+ * @property {(shops: Array<Object>) => PutProductsStrikethroughPricesRequest} shops Strikethrough price settings for the page.
2562
+ * @property {function} append Append current data to array and start modifying next row
2563
+ * @property {function} exec Excecute request
2564
+ */
2565
+
2566
+ /**
2567
+ * @typedef {Object} PutProductsSupplierCodeRequest
2568
+ * @property {(products: Array<Object>) => PutProductsSupplierCodeRequest} products Products list.
2569
+ * @property {(productId: Integer) => PutProductsSupplierCodeRequest} productId Product IAI code
2570
+ * @property {(productDeliverers: Array<Object>) => PutProductsSupplierCodeRequest} productDeliverers Suppliers data
2571
+ * @property {function} append Append current data to array and start modifying next row
2572
+ * @property {function} exec Excecute request
2573
+ */
2574
+
2575
+ /**
2576
+ * @typedef {Object} PutProductsSupplierProductDataRequest
2577
+ * @property {(products: Array<Object>) => PutProductsSupplierProductDataRequest} products Products list.
2578
+ * @property {(productId: Integer) => PutProductsSupplierProductDataRequest} productId Product IAI code
2579
+ * @property {(productDeliverers: Array<Object>) => PutProductsSupplierProductDataRequest} productDeliverers Suppliers data
2580
+ * @property {function} append Append current data to array and start modifying next row
2581
+ * @property {function} exec Excecute request
2582
+ */
2583
+
2584
+ /**
2585
+ * @typedef {Object} PostProductsSynchronizationFileRequest
2586
+ * @property {(synchronizationId: Integer) => PostProductsSynchronizationFileRequest} synchronizationId Synchronization ID.
2587
+ * @property {(packageId: Integer) => PostProductsSynchronizationFileRequest} packageId File package number. Leave blank for the first file in the package, and the API will return a generated number, which should then be transmitted and by which the API will recognize subsequent files for this package.
2588
+ * @property {(fileType: String) => PostProductsSynchronizationFileRequest} fileType File Type IOF30 (full/light/categories/sizes/series/guarantees/parameters).
2589
+ * @property {(md5Content: String) => PostProductsSynchronizationFileRequest} md5Content MD5 from the file avarage before base64 encoding.
2590
+ * @property {(fileContent: String) => PostProductsSynchronizationFileRequest} fileContent Offer file encoded with base64 algorithm.
2591
+ * @property {(offerName: String) => PostProductsSynchronizationFileRequest} offerName Unique offer name.
2592
+ * @property {function} exec Excecute request
2593
+ */
2594
+
2595
+ /**
2596
+ * @typedef {Object} PutProductsSynchronizationFinishUploadRequest
2597
+ * @property {(synchronizationId: Integer) => PutProductsSynchronizationFinishUploadRequest} synchronizationId Synchronization ID.
2598
+ * @property {(packageId: Integer) => PutProductsSynchronizationFinishUploadRequest} packageId File package number.
2599
+ * @property {(filesInPackage: Integer) => PutProductsSynchronizationFinishUploadRequest} filesInPackage Total number of files in the parcel.
2600
+ * @property {(verifyFiles: Boolean) => PutProductsSynchronizationFinishUploadRequest} verifyFiles Whether to verify the package by sparsifying files and preparing requests. It may take a few minutes to answer.
2601
+ * @property {function} exec Excecute request
2602
+ */
2603
+
2604
+ /**
2605
+ * @typedef {Object} PostRefundsAddAutomaticRefundRequest
2606
+ * @property {(sourceType: 'return'|'rma') => PostRefundsAddAutomaticRefundRequest} sourceType Source type.: "return" "rma".
2607
+ * @property {(sourceId: Integer) => PostRefundsAddAutomaticRefundRequest} sourceId Source ID.
2608
+ * @property {function} exec Excecute request
2609
+ */
2610
+
2611
+ /**
2612
+ * @typedef {Object} PostRefundsAddAutomaticRefundForOrderRequest
2613
+ * @property {(sourceId: Integer) => PostRefundsAddAutomaticRefundForOrderRequest} sourceId Source ID.
2614
+ * @property {(refundValue: Number) => PostRefundsAddAutomaticRefundForOrderRequest} refundValue Amount.
2615
+ * @property {(paymentId: Integer) => PostRefundsAddAutomaticRefundForOrderRequest} paymentId Payment ID.
2616
+ * @property {(refundCurrency: String) => PostRefundsAddAutomaticRefundForOrderRequest} refundCurrency Payment currency.
2617
+ * @property {function} exec Excecute request
2618
+ */
2619
+
2620
+ /**
2621
+ * @typedef {Object} PostRefundsAddManualRefundRequest
2622
+ * @property {(sourceType: 'order'|'return'|'rma') => PostRefundsAddManualRefundRequest} sourceType Source type.: "order" "return" "rma".
2623
+ * @property {(sourceId: Integer) => PostRefundsAddManualRefundRequest} sourceId Source ID.
2624
+ * @property {(refundValue: Number) => PostRefundsAddManualRefundRequest} refundValue Amount.
2625
+ * @property {(refundCurrency: String) => PostRefundsAddManualRefundRequest} refundCurrency Payment currency.
2626
+ * @property {(refundDetails: Object) => PostRefundsAddManualRefundRequest} refundDetails
2627
+ * @property {function} exec Excecute request
2628
+ */
2629
+
2630
+ /**
2631
+ * @typedef {Object} PutRefundsCancelRefundRequest
2632
+ * @property {(sourceType: 'order'|'return'|'rma') => PutRefundsCancelRefundRequest} sourceType Source type.: "order" "return" "rma".
2633
+ * @property {(sourceId: Integer) => PutRefundsCancelRefundRequest} sourceId Source ID.
2634
+ * @property {(paymentId: String) => PutRefundsCancelRefundRequest} paymentId Payment ID.
2635
+ * @property {function} exec Excecute request
2636
+ */
2637
+
2638
+ /**
2639
+ * @typedef {Object} PutRefundsConfirmRefundRequest
2640
+ * @property {(sourceType: 'order'|'return'|'rma') => PutRefundsConfirmRefundRequest} sourceType Source type.: "order" , "return" "rma".
2641
+ * @property {(sourceId: Integer) => PutRefundsConfirmRefundRequest} sourceId Source ID.
2642
+ * @property {(paymentId: Integer) => PutRefundsConfirmRefundRequest} paymentId Payment ID.
2643
+ * @property {function} exec Excecute request
2644
+ */
2645
+
2646
+ /**
2647
+ * @typedef {Object} GetRefundsGetPossibleAutoRefundsRequest
2648
+ * @property {(sourceId: Integer) => GetRefundsGetPossibleAutoRefundsRequest} sourceId Source ID
2649
+ * @property {(sourceType: 'order'|'return'|'rma') => GetRefundsGetPossibleAutoRefundsRequest} sourceType Source type.
2650
+ * @property {function} exec Excecute request
2651
+ */
2652
+
2653
+ /**
2654
+ * @typedef {Object} GetRefundsGetRefundStatusRequest
2655
+ * @property {(sourceId: Integer) => GetRefundsGetRefundStatusRequest} sourceId Source ID
2656
+ * @property {(paymentId: Integer) => GetRefundsGetRefundStatusRequest} paymentId Payment ID.
2657
+ * @property {(sourceType: 'order'|'return'|'rma') => GetRefundsGetRefundStatusRequest} sourceType Source type.
2658
+ * @property {function} exec Excecute request
2659
+ */
2660
+
2661
+ /**
2662
+ * @typedef {Object} GetRefundsRetrieveRefundsListRequest
2663
+ * @property {(sourceType: 'order'|'return'|'rma'|'all') => GetRefundsRetrieveRefundsListRequest} sourceType Source type.
2664
+ * @property {(resultsPage: Integer) => GetRefundsRetrieveRefundsListRequest} resultsPage Page number, first 1
2665
+ * @property {(resultsLimit: Integer) => GetRefundsRetrieveRefundsListRequest} resultsLimit Limit results, between 1 - 100
2666
+ * @property {(page: Integer, limit: Integer) => GetRefundsRetrieveRefundsListRequest} page Define page number and maximum results per page
2667
+ * @property {() => Integer} count Returns total numer of results
2668
+ * @property {function} exec Excecute request
2669
+ */
2670
+
2671
+ /**
2672
+ * @typedef {Object} PutRefundsUpdateRefundRequest
2673
+ * @property {(sourceType: 'order'|'return'|'rma') => PutRefundsUpdateRefundRequest} sourceType Source type.: "order" , "return" "rma".
2674
+ * @property {(sourceId: Integer) => PutRefundsUpdateRefundRequest} sourceId Source ID.
2675
+ * @property {(paymentId: String) => PutRefundsUpdateRefundRequest} paymentId Payment ID.
2676
+ * @property {(refundValue: Number) => PutRefundsUpdateRefundRequest} refundValue Amount.
2677
+ * @property {(refundCurrency: String) => PutRefundsUpdateRefundRequest} refundCurrency Payment currency.
2678
+ * @property {function} exec Excecute request
2679
+ */
2680
+
2681
+ /**
2682
+ * @typedef {Object} GetReturnsRequest
2683
+ * @property {(order_sn: Integer) => GetReturnsRequest} order_sn Search by the order serial number to which a return was added.
2684
+ * @property {(return_id: Integer) => GetReturnsRequest} return_id Search by return ID.
2685
+ * @property {(return_shipping_number: String) => GetReturnsRequest} return_shipping_number Search by a return shipment number from a customer to the shop .
2686
+ * @property {(range: Object) => GetReturnsRequest} range Date range.
2687
+ * @property {(results_limit: Integer) => GetReturnsRequest} results_limit Number of results on page.
2688
+ * @property {(results_page: Integer) => GetReturnsRequest} results_page Result page number.
2689
+ * @property {(status: Integer) => GetReturnsRequest} status 1 - Return not handled, 2 - Return accepted, 3 - Return not accepted, 13 - Return canceled by the customer, 14 - Return canceled, 15 - Resend the order, 16 - Abort resending order, 17 - A customer generated a return - it will be delivered personally, 18 - A customer generated a return - it will be sent by the customer.
2690
+ * @property {(return_ids: Array<Integer>) => GetReturnsRequest} return_ids Search by return ID.
2691
+ * @property {(stock_id: Integer) => GetReturnsRequest} stock_id Search by ID of a stock to which a return is sent.
2692
+ * @property {(bundleAsProducts: Boolean) => GetReturnsRequest} bundleAsProducts Return a set as its constituent products
2693
+ * @property {(dateFrom: DateLike, dateTo: DateLike, dateType: "date_add"|"date_end") => GetReturnsRequest} dates Type of date according to the index results. Possible type values: date_add, date_end
2694
+ * @property {(page: Integer, limit: Integer) => GetReturnsRequest} page Define page number and maximum results per page
2695
+ * @property {() => Integer} count Returns total numer of results
2696
+ * @property {function} exec Excecute request
2697
+ */
2698
+
2699
+ /**
2700
+ * @typedef {Object} PutReturnsRequest
2701
+ * @property {(returns: Array<Object>) => PutReturnsRequest} returns
2702
+ * @property {(id: Integer) => PutReturnsRequest} id Returns ID.
2703
+ * @property {(api_flag: Object) => PutReturnsRequest} api_flag
2704
+ * @property {function} append Append current data to array and start modifying next row
2705
+ * @property {function} exec Excecute request
2706
+ */
2707
+
2708
+ /**
2709
+ * @typedef {Object} PutReturnsSerialNumberRequest
2710
+ * @property {(return_id: Integer) => PutReturnsSerialNumberRequest} return_id Return number.
2711
+ * @property {(products: Array<Object>) => PutReturnsSerialNumberRequest} products Products list.
2712
+ * @property {(id: Integer) => PutReturnsSerialNumberRequest} id Product ID.
2713
+ * @property {(size: String) => PutReturnsSerialNumberRequest} size Size ID.
2714
+ * @property {(serialNumbers: Array<String>) => PutReturnsSerialNumberRequest} serialNumbers
2715
+ * @property {function} append Append current data to array and start modifying next row
2716
+ * @property {function} exec Excecute request
2717
+ */
2718
+
2719
+ /**
2720
+ * @typedef {Object} GetReturnsStatusesRequest
2721
+ * @property {function} exec Excecute request
2722
+ */
2723
+
2724
+ /**
2725
+ * @typedef {Object} GetRmaRequest
2726
+ * @property {(rmaIds: Array<Integer>) => GetRmaRequest} rmaIds
2727
+ * @property {(stockId: Integer) => GetRmaRequest} stockId Stock ID
2728
+ * @property {(operatorLogin: String) => GetRmaRequest} operatorLogin Login of the user handling the complaint
2729
+ * @property {(clientId: String) => GetRmaRequest} clientId Unique client's number.
2730
+ * @property {(creationDate: Object) => GetRmaRequest} creationDate Complaint creation date in the YYYY-MM-DD format
2731
+ * @property {(modificationDate: Object) => GetRmaRequest} modificationDate Complaint modification date in the YYYY-MM-DD format
2732
+ * @property {(endDate: Object) => GetRmaRequest} endDate Complaint closing date in the YYYY-MM-DD format
2733
+ * @property {(resultsPage: Integer) => GetRmaRequest} resultsPage Page with results number. Numeration starts from 0
2734
+ * @property {(resultsLimit: Integer) => GetRmaRequest} resultsLimit Number of results on page. Value from 1 to 100
2735
+ * @property {(dateFrom: DateLike, dateTo: DateLike) => GetRmaRequest} created Type of date according to the index results
2736
+ * @property {(dateFrom: DateLike, dateTo: DateLike) => GetRmaRequest} modified Type of date according to the index results
2737
+ * @property {(dateFrom: DateLike, dateTo: DateLike) => GetRmaRequest} ended Type of date according to the index results
2738
+ * @property {(page: Integer, limit: Integer) => GetRmaRequest} page Define page number and maximum results per page
2739
+ * @property {() => Integer} count Returns total numer of results
2740
+ * @property {function} exec Excecute request
2741
+ */
2742
+
2743
+ /**
2744
+ * @typedef {Object} PutRmaRequest
2745
+ * @property {(rmas: Array<Object>) => PutRmaRequest} rmas Complaints.
2746
+ * @property {(rmaId: Integer) => PutRmaRequest} rmaId Complaint id.
2747
+ * @property {(rmaStatusId: Integer) => PutRmaRequest} rmaStatusId Claim status. Available values: 15 - Complaint not confirmed by the shop service, 17 - The complaint has been cancelled, 18 - Complaint canceled by the customer, 14 - Complaint didn't arrive, 20 - Complaint not handled, 22 - Complaint rejected - no fault was found, 23 - Complaint rejected - the warranty period has expired, 24 - Complaint rejected - defect caused by improper use, 19 - Complaint confirmed, 28 - Complaint is being considered - repair completed, 5 - Complaint is being considered - Product sent to the producer , 4 - Complaint is being considered - Product was sent for testing, 6 - Complaint is being considered - Repair in progress, 29 - Complaint is being considered - the complaint requires additional information from the customer, 7 - Complaint adjusted negatively - no fault was found, 9 - Complaint adjusted negatively - the warranty period has expired, 30 - Complaint adjusted negatively - return shipment sent to the customer, 8 - Complaint adjusted negatively - defect caused by improper use, 25 - Complaint handled positively - return shipment sent to the customer, 12 - Complaint handled positively - replacement for a new product, 13 - Complaint handled positively - replacement for a different product, 26 - Complaint handled positively - a new item was shipped without waiting for the original one, 27 - Complaint handled positively - the recipient's data change on the sales document, 10 - Complaint handled positively - Refund - payment processing, 11 - Complaint handled positively - repair completed - payout made, 31 - Complaint handled positively - Awaiting correction invoice confirmation, 34 - Complaint handled positively - Refund - preparing correction invoice
2748
+ * @property {(rmaChat: Array<Object>) => PutRmaRequest} rmaChat Customer correspondence.
2749
+ * @property {function} append Append current data to array and start modifying next row
2750
+ * @property {function} exec Excecute request
2751
+ */
2752
+
2753
+ /**
2754
+ * @typedef {Object} GetRmaStatusesRequest
2755
+ * @property {function} exec Excecute request
2756
+ */
2757
+
2758
+ /**
2759
+ * @typedef {Object} DeleteSizechartsRequest
2760
+ * @property {(ids: Array<Integer>) => DeleteSizechartsRequest} ids #!identyfikatory!#
2761
+ * @property {function} exec Excecute request
2762
+ */
2763
+
2764
+ /**
2765
+ * @typedef {Object} GetSizechartsRequest
2766
+ * @property {(ids: Array<Integer>) => GetSizechartsRequest} ids IDs
2767
+ * @property {(names: Array<String>) => GetSizechartsRequest} names Names of size charts
2768
+ * @property {(languages: Array<String>) => GetSizechartsRequest} languages List of languages
2769
+ * @property {(resultsPage: Integer) => GetSizechartsRequest} resultsPage Page with results number. Numeration starts from 0
2770
+ * @property {(resultsLimit: Integer) => GetSizechartsRequest} resultsLimit Number of results on page. Value from 1 to 100
2771
+ * @property {(page: Integer, limit: Integer) => GetSizechartsRequest} page Define page number and maximum results per page
2772
+ * @property {() => Integer} count Returns total numer of results
2773
+ * @property {function} exec Excecute request
2774
+ */
2775
+
2776
+ /**
2777
+ * @typedef {Object} PutSizechartsRequest
2778
+ * @property {(sizeCharts: Array<Object>) => PutSizechartsRequest} sizeCharts
2779
+ * @property {(id: Integer) => PutSizechartsRequest} id Id
2780
+ * @property {(nameInPanel: String) => PutSizechartsRequest} nameInPanel Name in panel
2781
+ * @property {(displayMode: 'single'|'all') => PutSizechartsRequest} displayMode Display mode
2782
+ * @property {(languagesData: Array<Object>) => PutSizechartsRequest} languagesData
2783
+ * @property {function} append Append current data to array and start modifying next row
2784
+ * @property {function} exec Excecute request
2785
+ */
2786
+
2787
+ /**
2788
+ * @typedef {Object} GetSizesRequest
2789
+ * @property {(return_last_changed_time: String) => GetSizesRequest} return_last_changed_time When the value is 'y', the last size modification date is returned, formatted as YYYY-MM-DD HH-MM-SS.
2790
+ * @property {function} exec Excecute request
2791
+ */
2792
+
2793
+ /**
2794
+ * @typedef {Object} PutSizesRequest
2795
+ * @property {(sizes: Array<Object>) => PutSizesRequest} sizes Size table.
2796
+ * @property {(faultCode: Integer) => PutSizesRequest} faultCode Error code.
2797
+ * @property {(faultString: String) => PutSizesRequest} faultString Error description.
2798
+ * @property {(group_id: Integer) => PutSizesRequest} group_id Size group ID.
2799
+ * @property {(id: String) => PutSizesRequest} id Size identifier.
2800
+ * @property {(name: String) => PutSizesRequest} name Category plural name.
2801
+ * @property {(description: String) => PutSizesRequest} description Size description.
2802
+ * @property {(operation: String) => PutSizesRequest} operation Operation type: add, edit, del
2803
+ * @property {(lang_data: Array<Object>) => PutSizesRequest} lang_data
2804
+ * @property {function} append Append current data to array and start modifying next row
2805
+ * @property {function} exec Excecute request
2806
+ */
2807
+
2808
+ /**
2809
+ * @typedef {Object} GetSystemConfigRequest
2810
+ * @property {function} exec Excecute request
2811
+ */
2812
+
2813
+ /**
2814
+ * @typedef {Object} PutSystemConfigRequest
2815
+ * @property {(panelSettings: Object) => PutSystemConfigRequest} panelSettings Panel settings
2816
+ * @property {function} exec Excecute request
2817
+ */
2818
+
2819
+ /**
2820
+ * @typedef {Object} GetSystemCurrenciesRequest
2821
+ * @property {(symbol: String) => GetSystemCurrenciesRequest} symbol Currency symbol in ISO 4217 format.
2822
+ * @property {(date: String) => GetSystemCurrenciesRequest} date Date in format YYYY-MM-DD-HH MM:SS.
2823
+ * @property {function} exec Excecute request
2824
+ */
2825
+
2826
+ /**
2827
+ * @typedef {Object} PutSystemCurrenciesRequest
2828
+ * @property {(currencies: Array<Object>) => PutSystemCurrenciesRequest} currencies
2829
+ * @property {(id: String) => PutSystemCurrenciesRequest} id Currency code in ISO 4217 standard.
2830
+ * @property {(rate: Number) => PutSystemCurrenciesRequest} rate Currency exchange rate. Maximal value is 10000.
2831
+ * @property {(scale: Integer) => PutSystemCurrenciesRequest} scale Currency smaller unit.
2832
+ * @property {function} append Append current data to array and start modifying next row
2833
+ * @property {function} exec Excecute request
2834
+ */
2835
+
2836
+ /**
2837
+ * @typedef {Object} GetSystemProcessesAutomationRequest
2838
+ * @property {(shopId: Integer) => GetSystemProcessesAutomationRequest} shopId Shop Id
2839
+ * @property {function} exec Excecute request
2840
+ */
2841
+
2842
+ /**
2843
+ * @typedef {Object} PutSystemProcessesAutomationRequest
2844
+ * @property {(shopId: Integer) => PutSystemProcessesAutomationRequest} shopId Shop Id
2845
+ * @property {(orders: Object) => PutSystemProcessesAutomationRequest} orders Orders.
2846
+ * @property {function} exec Excecute request
2847
+ */
2848
+
2849
+ /**
2850
+ * @typedef {Object} GetSystemServerLoadRequest
2851
+ * @property {function} exec Excecute request
2852
+ */
2853
+
2854
+ /**
2855
+ * @typedef {Object} GetSystemServerTimeRequest
2856
+ * @property {function} exec Excecute request
2857
+ */
2858
+
2859
+ /**
2860
+ * @typedef {Object} GetSystemShopsDataRequest
2861
+ * @property {function} exec Excecute request
2862
+ */
2863
+
2864
+ /**
2865
+ * @typedef {Object} GetSystemUnitsRequest
2866
+ * @property {(languagesIds: Array<String>) => GetSystemUnitsRequest} languagesIds List of languages
2867
+ * @property {function} exec Excecute request
2868
+ */
2869
+
2870
+ /**
2871
+ * @typedef {Object} PutSystemUnitsRequest
2872
+ * @property {(units: Array<Object>) => PutSystemUnitsRequest} units
2873
+ * @property {(id: Integer) => PutSystemUnitsRequest} id #!IdentyfikatorJednostki!#
2874
+ * @property {(nameInPanel: String) => PutSystemUnitsRequest} nameInPanel Name in panel (limit of 30 characters)
2875
+ * @property {(precisionUnit: Integer) => PutSystemUnitsRequest} precisionUnit Accuracy (number of places after comma)
2876
+ * @property {(visible: Boolean) => PutSystemUnitsRequest} visible Visibility
2877
+ * @property {(descriptions: Array<Object>) => PutSystemUnitsRequest} descriptions Unit names
2878
+ * @property {function} append Append current data to array and start modifying next row
2879
+ * @property {function} exec Excecute request
2880
+ */
2881
+
2882
+ /**
2883
+ * @typedef {Object} GetSystemUsersRequest
2884
+ * @property {(userType: 'all'|'active') => GetSystemUsersRequest} userType User type. List of options "all" - All users, "active" - Only active users
2885
+ * @property {function} exec Excecute request
2886
+ */
2887
+
2888
+ /**
2889
+ * @typedef {Object} PutVouchersBlockRequest
2890
+ * @property {(vouchers: Array<Object>) => PutVouchersBlockRequest} vouchers
2891
+ * @property {(id: Integer) => PutVouchersBlockRequest} id Voucher ID
2892
+ * @property {(number: String) => PutVouchersBlockRequest} number Number.
2893
+ * @property {function} append Append current data to array and start modifying next row
2894
+ * @property {function} exec Excecute request
2895
+ */
2896
+
2897
+ /**
2898
+ * @typedef {Object} GetVouchersTypesRequest
2899
+ * @property {(resultsPage: Integer) => GetVouchersTypesRequest} resultsPage Page with results number. Numeration starts from 0
2900
+ * @property {(resultsLimit: Integer) => GetVouchersTypesRequest} resultsLimit Number of results on page. Value from 1 to 100
2901
+ * @property {(page: Integer, limit: Integer) => GetVouchersTypesRequest} page Define page number and maximum results per page
2902
+ * @property {() => Integer} count Returns total numer of results
2903
+ * @property {function} exec Excecute request
2904
+ */
2905
+
2906
+ /**
2907
+ * @typedef {Object} PutVouchersUnblockRequest
2908
+ * @property {(vouchers: Array<Object>) => PutVouchersUnblockRequest} vouchers
2909
+ * @property {(id: Integer) => PutVouchersUnblockRequest} id Voucher ID
2910
+ * @property {(number: String) => PutVouchersUnblockRequest} number Number.
2911
+ * @property {function} append Append current data to array and start modifying next row
2912
+ * @property {function} exec Excecute request
2913
+ */
2914
+
2915
+ /**
2916
+ * @typedef {Object} DeleteVouchersRequest
2917
+ * @property {(vouchers: Array<Object>) => DeleteVouchersRequest} vouchers
2918
+ * @property {(id: Integer) => DeleteVouchersRequest} id Voucher ID
2919
+ * @property {(number: String) => DeleteVouchersRequest} number Number.
2920
+ * @property {function} append Append current data to array and start modifying next row
2921
+ * @property {function} exec Excecute request
2922
+ */
2923
+
2924
+ /**
2925
+ * @typedef {Object} GetVouchersRequest
2926
+ * @property {(vouchers: Array<Object>) => GetVouchersRequest} vouchers
2927
+ * @property {(voucherTypeId: Integer) => GetVouchersRequest} voucherTypeId Discount code campaign ID
2928
+ * @property {(name: String) => GetVouchersRequest} name Name.
2929
+ * @property {(status: 'all'|'used'|'unused'|'unverified') => GetVouchersRequest} status Status
2930
+ * @property {(generetedFromAffiliateProgram: 'all'|'y'|'n') => GetVouchersRequest} generetedFromAffiliateProgram Generated in the affiliate program
2931
+ * @property {(noteContain: String) => GetVouchersRequest} noteContain Notes contain
2932
+ * @property {(balanceFrom: Number) => GetVouchersRequest} balanceFrom Value from
2933
+ * @property {(balanceTo: Number) => GetVouchersRequest} balanceTo Value to
2934
+ * @property {(expirationDateFrom: String) => GetVouchersRequest} expirationDateFrom Expiration date from
2935
+ * @property {(expirationDateTo: String) => GetVouchersRequest} expirationDateTo Expiration date to
2936
+ * @property {(issueDateFrom: String) => GetVouchersRequest} issueDateFrom Created from
2937
+ * @property {(issueDateTo: String) => GetVouchersRequest} issueDateTo Created to
2938
+ * @property {(usageDateFrom: String) => GetVouchersRequest} usageDateFrom To be used from
2939
+ * @property {(usageDateTo: String) => GetVouchersRequest} usageDateTo To be used to
2940
+ * @property {(resultsPage: Integer) => GetVouchersRequest} resultsPage Page with results number. Numeration starts from 0
2941
+ * @property {(resultsLimit: Integer) => GetVouchersRequest} resultsLimit Number of results on page. Value from 1 to 100
2942
+ * @property {(dateFrom: DateLike, dateTo: DateLike) => GetVouchersRequest} issued Type of date according to the index results
2943
+ * @property {(dateFrom: DateLike, dateTo: DateLike) => GetVouchersRequest} expires Type of date according to the index results
2944
+ * @property {(dateFrom: DateLike, dateTo: DateLike) => GetVouchersRequest} used Type of date according to the index results
2945
+ * @property {(ids: Array<Integer>) => GetVouchersRequest} ids Define vouchers by passing array of values
2946
+ * @property {(numbers: Array<Integer>) => GetVouchersRequest} numbers Define vouchers by passing array of values
2947
+ * @property {(page: Integer, limit: Integer) => GetVouchersRequest} page Define page number and maximum results per page
2948
+ * @property {() => Integer} count Returns total numer of results
2949
+ * @property {function} exec Excecute request
2950
+ */
2951
+
2952
+ /**
2953
+ * @typedef {Object} PostVouchersRequest
2954
+ * @property {(vouchers: Array<Object>) => PostVouchersRequest} vouchers List of vouchers to add
2955
+ * @property {(typeId: Integer) => PostVouchersRequest} typeId Gift voucher type id
2956
+ * @property {(number: String) => PostVouchersRequest} number Number.
2957
+ * @property {(name: String) => PostVouchersRequest} name Name.
2958
+ * @property {(expirationDate: String) => PostVouchersRequest} expirationDate Voucher expiration date
2959
+ * @property {(balance: Object) => PostVouchersRequest} balance Voucher balance
2960
+ * @property {(shops: Array<Integer>) => PostVouchersRequest} shops List of shops the voucher is active in
2961
+ * @property {(note: String) => PostVouchersRequest} note
2962
+ * @property {function} append Append current data to array and start modifying next row
2963
+ * @property {function} exec Excecute request
2964
+ */
2965
+
2966
+ /**
2967
+ * @typedef {Object} PutVouchersRequest
2968
+ * @property {(vouchers: Array<Object>) => PutVouchersRequest} vouchers List of vouchers to edit
2969
+ * @property {(id: Integer) => PutVouchersRequest} id Voucher ID
2970
+ * @property {(number: String) => PutVouchersRequest} number Number.
2971
+ * @property {(name: String) => PutVouchersRequest} name Name.
2972
+ * @property {(expirationDate: String) => PutVouchersRequest} expirationDate Voucher expiration date
2973
+ * @property {(balanceOperationType: 'set'|'add'|'subtract') => PutVouchersRequest} balanceOperationType Balance operation type, possible values: - set - balance positioning of funds, - add - add funds to balance, - subtract - subtract funds from balance.
2974
+ * @property {(balance: Object) => PutVouchersRequest} balance Voucher balance
2975
+ * @property {(shops: Array<Integer>) => PutVouchersRequest} shops List of shops the voucher is active in
2976
+ * @property {(note: String) => PutVouchersRequest} note
2977
+ * @property {(status: 'used'|'unused') => PutVouchersRequest} status Status, possible values: - used - used, - unused - unused,
2978
+ * @property {function} append Append current data to array and start modifying next row
2979
+ * @property {function} exec Excecute request
2980
+ */
2981
+
2982
+ /**
2983
+ * @typedef {Object} GetWarrantiesCountTotalRequest
2984
+ * @property {(warranty_ids: Array<String>) => GetWarrantiesCountTotalRequest} warranty_ids
2985
+ * @property {function} exec Excecute request
2986
+ */
2987
+
2988
+ /**
2989
+ * @typedef {Object} PutWarrantiesLanguageDataRequest
2990
+ * @property {(lang_data: Array<Object>) => PutWarrantiesLanguageDataRequest} lang_data
2991
+ * @property {(warranty_id: String) => PutWarrantiesLanguageDataRequest} warranty_id Warranty ID (numeric or text based).
2992
+ * @property {(lang: Array<Object>) => PutWarrantiesLanguageDataRequest} lang
2993
+ * @property {function} append Append current data to array and start modifying next row
2994
+ * @property {function} exec Excecute request
2995
+ */
2996
+
2997
+ /**
2998
+ * @typedef {Object} DeleteWarrantiesRequest
2999
+ * @property {(warranty_ids: Array<String>) => DeleteWarrantiesRequest} warranty_ids
3000
+ * @property {function} exec Excecute request
3001
+ */
3002
+
3003
+ /**
3004
+ * @typedef {Object} GetWarrantiesRequest
3005
+ * @property {(warranty_ids: Array<String>) => GetWarrantiesRequest} warranty_ids
3006
+ * @property {(results_limit: Integer) => GetWarrantiesRequest} results_limit Number of results on page.
3007
+ * @property {(results_page: Integer) => GetWarrantiesRequest} results_page Result page number.
3008
+ * @property {(results_order: Object) => GetWarrantiesRequest} results_order
3009
+ * @property {(page: Integer, limit: Integer) => GetWarrantiesRequest} page Define page number and maximum results per page
3010
+ * @property {() => Integer} count Returns total numer of results
3011
+ * @property {function} exec Excecute request
3012
+ */
3013
+
3014
+ /**
3015
+ * @typedef {Object} PostWarrantiesRequest
3016
+ * @property {(warranties: Array<Object>) => PostWarrantiesRequest} warranties
3017
+ * @property {(name: String) => PostWarrantiesRequest} name Name.
3018
+ * @property {(type: 'seller'|'producer') => PostWarrantiesRequest} type
3019
+ * @property {(period: Integer) => PostWarrantiesRequest} period Warranty time. Default value 12.
3020
+ * @property {(shopname: Object) => PostWarrantiesRequest} shopname Name of warranty.
3021
+ * @property {(description: Object) => PostWarrantiesRequest} description Warranty description.
3022
+ * @property {function} append Append current data to array and start modifying next row
3023
+ * @property {function} exec Excecute request
3024
+ */
3025
+
3026
+ /**
3027
+ * @typedef {Object} PutWarrantiesRequest
3028
+ * @property {(warranties: Array<Object>) => PutWarrantiesRequest} warranties
3029
+ * @property {(id: String) => PutWarrantiesRequest} id Warranty ID (numeric or text based).
3030
+ * @property {(name: String) => PutWarrantiesRequest} name Name.
3031
+ * @property {(type: 'seller'|'producer') => PutWarrantiesRequest} type
3032
+ * @property {(period: Integer) => PutWarrantiesRequest} period Warranty time. Default value 12.
3033
+ * @property {function} append Append current data to array and start modifying next row
3034
+ * @property {function} exec Excecute request
3035
+ */
3036
+
3037
+ /**
3038
+ * @typedef {Object} GetWmsLocationsRequest
3039
+ * @property {(locationId: Integer) => GetWmsLocationsRequest} locationId Warehouse location ID
3040
+ * @property {(locationCode: String) => GetWmsLocationsRequest} locationCode Storage location code
3041
+ * @property {(stockId: Integer) => GetWmsLocationsRequest} stockId Stock ID
3042
+ * @property {(returnElements: Array<String>) => GetWmsLocationsRequest} returnElements Elements to be returned by the endpoint. By default all elements are returned. Available values: locationName, locationPath, locationCode, stockId, products
3043
+ * @property {(resultsPage: Integer) => GetWmsLocationsRequest} resultsPage Page with results number. Numeration starts from 0
3044
+ * @property {(resultsLimit: Integer) => GetWmsLocationsRequest} resultsLimit Number of results on page. Value from 1 to 100
3045
+ * @property {(page: Integer, limit: Integer) => GetWmsLocationsRequest} page Define page number and maximum results per page
3046
+ * @property {() => Integer} count Returns total numer of results
3047
+ * @property {function} exec Excecute request
3048
+ */
3049
+
3050
+ /**
3051
+ * @typedef {Object} PutWmsStocksdocumentsAcceptMMRequest
3052
+ * @property {(id: Integer) => PutWmsStocksdocumentsAcceptMMRequest} id Document identifier.
3053
+ * @property {function} exec Excecute request
3054
+ */
3055
+
3056
+ /**
3057
+ * @typedef {Object} PutWmsStocksdocumentsCloseRequest
3058
+ * @property {(type: 'pz'|'pw'|'px'|'rx'|'rw'|'mm') => PutWmsStocksdocumentsCloseRequest} type
3059
+ * @property {(id: Integer) => PutWmsStocksdocumentsCloseRequest} id Document identifier.
3060
+ * @property {function} exec Excecute request
3061
+ */
3062
+
3063
+ /**
3064
+ * @typedef {Object} DeleteWmsStocksdocumentsDocumentsRequest
3065
+ * @property {(type: 'pz'|'pw'|'px'|'rx'|'rw'|'mm') => DeleteWmsStocksdocumentsDocumentsRequest} type
3066
+ * @property {(id: Integer) => DeleteWmsStocksdocumentsDocumentsRequest} id Document identifier.
3067
+ * @property {function} exec Excecute request
3068
+ */
3069
+
3070
+ /**
3071
+ * @typedef {Object} GetWmsStocksdocumentsDocumentsRequest
3072
+ * @property {(stockDocumentType: 'pz'|'pw'|'px'|'rx'|'rw'|'wz'|'mm'|'wz'|'zw') => GetWmsStocksdocumentsDocumentsRequest} stockDocumentType Document type.
3073
+ * @property {(stockDocumentStatus: 'open'|'on_the_way'|'close') => GetWmsStocksdocumentsDocumentsRequest} stockDocumentStatus Document status.
3074
+ * @property {(stockDocumentsIds: Array<Integer>) => GetWmsStocksdocumentsDocumentsRequest} stockDocumentsIds Document identifier.
3075
+ * @property {(stockDocumentsNumbers: Array<String>) => GetWmsStocksdocumentsDocumentsRequest} stockDocumentsNumbers Document number.
3076
+ * @property {(productsInPreorder: 'y'|'n') => GetWmsStocksdocumentsDocumentsRequest} productsInPreorder Products available in presales.
3077
+ * @property {(dateRange: Object) => GetWmsStocksdocumentsDocumentsRequest} dateRange Date range
3078
+ * @property {(resultsPage: Integer) => GetWmsStocksdocumentsDocumentsRequest} resultsPage Page with results number. Numeration starts from 0
3079
+ * @property {(resultsLimit: Integer) => GetWmsStocksdocumentsDocumentsRequest} resultsLimit Number of results on page. Value from 1 to 100
3080
+ * @property {(dateFrom: DateLike, dateTo: DateLike, dateType: "open"|"modify"|"close"|"stockOperation") => GetWmsStocksdocumentsDocumentsRequest} dates Type of date according to the index results. Possible type values: open, modify, close, stockOperation
3081
+ * @property {(page: Integer, limit: Integer) => GetWmsStocksdocumentsDocumentsRequest} page Define page number and maximum results per page
3082
+ * @property {() => Integer} count Returns total numer of results
3083
+ * @property {function} exec Excecute request
3084
+ */
3085
+
3086
+ /**
3087
+ * @typedef {Object} PostWmsStocksdocumentsDocumentsRequest
3088
+ * @property {(type: 'pz'|'pw'|'px'|'rx'|'rw'|'mm') => PostWmsStocksdocumentsDocumentsRequest} type
3089
+ * @property {(stockId: Integer) => PostWmsStocksdocumentsDocumentsRequest} stockId Target warehouse ID. The list of available warehouses can be downloaded via the method <a href = "en/shop/api/?action=method&function=systemconfig&method=get">#get</a> in gateway <a href = "en/shop/api/?action=documentation&function=systemconfig">SystemConfig</a>.
3090
+ * @property {(stockDocumentNumber: String) => PostWmsStocksdocumentsDocumentsRequest} stockDocumentNumber Document number.
3091
+ * @property {(stockSourceId: Integer) => PostWmsStocksdocumentsDocumentsRequest} stockSourceId Source warehouse ID. The list of available warehouses can be downloaded via the method <a href = "en/shop/api/?action=method&function=systemconfig&method=get">#get</a> in gateway <a href = "en/shop/api/?action=documentation&function=systemconfig">SystemConfig</a>.
3092
+ * @property {(note: String) => PostWmsStocksdocumentsDocumentsRequest} note
3093
+ * @property {(productsInPreorder: 'y'|'n') => PostWmsStocksdocumentsDocumentsRequest} productsInPreorder Products available in presales. Available values: "y" - yes, "n" - no.
3094
+ * @property {(delivererId: Integer) => PostWmsStocksdocumentsDocumentsRequest} delivererId Supplier ID.
3095
+ * @property {(wnt: 'national_VAT_invoice'|'other_purchase_document'|'invoice_without_VAT'|'imports_from_outside_the_EU') => PostWmsStocksdocumentsDocumentsRequest} wnt Type of purchase document. Available values: "national_VAT_invoice" - National VAT invoice, "other_purchase_document" - Other purchase document, "invoice_without_VAT" - Invoice without VAT (EU), "imports_from_outside_the_EU" - Import from outside EU.
3096
+ * @property {(saleDocumentCreationDate: String) => PostWmsStocksdocumentsDocumentsRequest} saleDocumentCreationDate Issue date of purchase document. Correct format is yyyy-mm-dd, e.g. 2007-12-31..
3097
+ * @property {(deliveryOnTheWayPlannedDeliveryDate: String) => PostWmsStocksdocumentsDocumentsRequest} deliveryOnTheWayPlannedDeliveryDate Planned date of acceptance of delivery. Correct format is yyyy-mm-dd, e.g. 2007-12-31. Requires parameter: "confirmed=on_the_way".
3098
+ * @property {(confirmed: 'open'|'on_the_way') => PostWmsStocksdocumentsDocumentsRequest} confirmed Document status. Available values: "open" - open, "on_the_way" - on the way.
3099
+ * @property {(currencyForPurchasePrice: String) => PostWmsStocksdocumentsDocumentsRequest} currencyForPurchasePrice Purchase price currency, e.g. PLN, USD, GBP
3100
+ * @property {(priceType: 'brutto'|'netto') => PostWmsStocksdocumentsDocumentsRequest} priceType Settlement by prices. Available values: "brutto" - Gross value, "netto" - Net value
3101
+ * @property {(queueType: 'fifo'|'lifo') => PostWmsStocksdocumentsDocumentsRequest} queueType Methods of stock level correction. Available values: "fifo" - first-in, first-out (FIFO), "lifo" - last-in, first-out (LIFO)
3102
+ * @property {function} exec Excecute request
3103
+ */
3104
+
3105
+ /**
3106
+ * @typedef {Object} PutWmsStocksdocumentsDocumentsRequest
3107
+ * @property {(stockDocumentId: Integer) => PutWmsStocksdocumentsDocumentsRequest} stockDocumentId Document identifier.
3108
+ * @property {(stockDocumentType: 'pz'|'pw'|'px'|'rx'|'rw'|'mm') => PutWmsStocksdocumentsDocumentsRequest} stockDocumentType Document type. Available values: "pz" - goods received note (GRN), "pw" - internal delivery note (IDN), "px" - goods received correction note (GRX), "rx" - goods despatch note (GRN) , "rw" - goods issued note (GIN), "mm" - inter-warehouse transfer.
3109
+ * @property {(stockDocumentNumber: String) => PutWmsStocksdocumentsDocumentsRequest} stockDocumentNumber Number of purchase document
3110
+ * @property {(stockId: Integer) => PutWmsStocksdocumentsDocumentsRequest} stockId Target warehouse ID. The list of available warehouses can be downloaded via the method <a href = "en/shop/api/?action=method&function=systemconfig&method=get">#get</a> in gateway <a href = "en/shop/api/?action=documentation&function=systemconfig">SystemConfig</a>.
3111
+ * @property {(stockSourceId: Integer) => PutWmsStocksdocumentsDocumentsRequest} stockSourceId Source warehouse ID. The list of available warehouses can be downloaded via the method <a href = "en/shop/api/?action=method&function=systemconfig&method=get">#get</a> in gateway <a href = "en/shop/api/?action=documentation&function=systemconfig">SystemConfig</a>.
3112
+ * @property {(note: String) => PutWmsStocksdocumentsDocumentsRequest} note
3113
+ * @property {(productsInPreorder: 'y'|'n') => PutWmsStocksdocumentsDocumentsRequest} productsInPreorder Products available in presales. Available values: "y" - yes, "n" - no.
3114
+ * @property {(delivererId: Integer) => PutWmsStocksdocumentsDocumentsRequest} delivererId Supplier ID.
3115
+ * @property {(wnt: 'national_VAT_invoice'|'other_purchase_document'|'invoice_without_VAT'|'imports_from_outside_the_EU') => PutWmsStocksdocumentsDocumentsRequest} wnt Type of purchase document. Available values: "national_VAT_invoice" - National VAT invoice, "other_purchase_document" - Other purchase document, "invoice_without_VAT" - Invoice without VAT (EU), "imports_from_outside_the_EU" - Import from outside EU.
3116
+ * @property {(saleDocumentCreationDate: String) => PutWmsStocksdocumentsDocumentsRequest} saleDocumentCreationDate Issue date of purchase document. Correct format is yyyy-mm-dd, e.g. 2007-12-31..
3117
+ * @property {(deliveryOnTheWayPlannedDeliveryDate: String) => PutWmsStocksdocumentsDocumentsRequest} deliveryOnTheWayPlannedDeliveryDate Planned date of acceptance of delivery. Correct format is yyyy-mm-dd, e.g. 2007-12-31. Requires parameter: "confirmed=on_the_way".
3118
+ * @property {(confirmed: 'open'|'on_the_way') => PutWmsStocksdocumentsDocumentsRequest} confirmed Document status. Available values: "open" - open, "on_the_way" - on the way.
3119
+ * @property {(currencyForPurchasePrice: String) => PutWmsStocksdocumentsDocumentsRequest} currencyForPurchasePrice Purchase price currency, e.g. PLN, USD, GBP
3120
+ * @property {(currencyForPurchasePriceRate: Number) => PutWmsStocksdocumentsDocumentsRequest} currencyForPurchasePriceRate Currency exchange rate (Currency conversion)
3121
+ * @property {(currencyForPurchasePriceRateType: 'custom'|'currentDay'|'customDay'|'previousDay') => PutWmsStocksdocumentsDocumentsRequest} currencyForPurchasePriceRateType Type of currency rate. Available values: "custom" - not typical, "currentDay" - the currency rate from the day of issuing a stock document, "customDay" - on a selected day, "previousDay" - the currency rate of a working day preceding the date of the stock document issue.
3122
+ * @property {(currencyForPurchasePriceRateDate: String) => PutWmsStocksdocumentsDocumentsRequest} currencyForPurchasePriceRateDate Currency rate of the day. Correct format is yyyy-mm-dd, e.g. 2007-12-31..
3123
+ * @property {(priceType: 'brutto'|'netto') => PutWmsStocksdocumentsDocumentsRequest} priceType Settlement by prices. Available values: "brutto" - Gross value, "netto" - Net value.
3124
+ * @property {(queueType: 'fifo'|'lifo') => PutWmsStocksdocumentsDocumentsRequest} queueType Methods of stock level correction. Available values: "fifo" - first-in, first-out (FIFO), "lifo" - last-in, first-out (LIFO).
3125
+ * @property {(verificationDate: String) => PutWmsStocksdocumentsDocumentsRequest} verificationDate Verification date
3126
+ * @property {(verificationUser: String) => PutWmsStocksdocumentsDocumentsRequest} verificationUser Users verification
3127
+ * @property {function} exec Excecute request
3128
+ */
3129
+
3130
+ /**
3131
+ * @typedef {Object} GetWmsStocksdocumentsOpenedDocumentsRequest
3132
+ * @property {(type: 'pz'|'pw'|'px'|'rx'|'rw'|'mm') => GetWmsStocksdocumentsOpenedDocumentsRequest} type
3133
+ * @property {(status: 'open'|'on_the_way'|'all') => GetWmsStocksdocumentsOpenedDocumentsRequest} status
3134
+ * @property {(stockId: Integer) => GetWmsStocksdocumentsOpenedDocumentsRequest} stockId Target warehouse ID. The list of available warehouses can be downloaded via the method <a href = "en/shop/api/?action=method&function=systemconfig&method=get">#get</a> in gateway <a href = "en/shop/api/?action=documentation&function=systemconfig">SystemConfig</a>.
3135
+ * @property {(stockSourceId: Integer) => GetWmsStocksdocumentsOpenedDocumentsRequest} stockSourceId Source warehouse ID. The list of available warehouses can be downloaded via the method <a href = "en/shop/api/?action=method&function=systemconfig&method=get">#get</a> in gateway <a href = "en/shop/api/?action=documentation&function=systemconfig">SystemConfig</a>.
3136
+ * @property {(dateRange: Object) => GetWmsStocksdocumentsOpenedDocumentsRequest} dateRange Date range
3137
+ * @property {(resultsPage: Integer) => GetWmsStocksdocumentsOpenedDocumentsRequest} resultsPage Page with results number. Numeration starts from 0
3138
+ * @property {(resultsLimit: Integer) => GetWmsStocksdocumentsOpenedDocumentsRequest} resultsLimit Number of results on page. Value from 1 to 100
3139
+ * @property {(dateFrom: DateLike, dateTo: DateLike, dateType: "open"|"modify") => GetWmsStocksdocumentsOpenedDocumentsRequest} dates Type of date according to the index results. Possible type values: open, modify
3140
+ * @property {(page: Integer, limit: Integer) => GetWmsStocksdocumentsOpenedDocumentsRequest} page Define page number and maximum results per page
3141
+ * @property {() => Integer} count Returns total numer of results
3142
+ * @property {function} exec Excecute request
3143
+ */
3144
+
3145
+ /**
3146
+ * @typedef {Object} DeleteWmsStocksdocumentsProductsRequest
3147
+ * @property {(products: Array<Object>) => DeleteWmsStocksdocumentsProductsRequest} products Products list.
3148
+ * @property {(type: 'pz'|'pw'|'px'|'rx'|'rw'|'mm') => DeleteWmsStocksdocumentsProductsRequest} type
3149
+ * @property {(id: Integer) => DeleteWmsStocksdocumentsProductsRequest} id Document identifier.
3150
+ * @property {(product: Integer) => DeleteWmsStocksdocumentsProductsRequest} product Stock keeping unit.
3151
+ * @property {(size: String) => DeleteWmsStocksdocumentsProductsRequest} size Product size ID.
3152
+ * @property {function} append Append current data to array and start modifying next row
3153
+ * @property {function} exec Excecute request
3154
+ */
3155
+
3156
+ /**
3157
+ * @typedef {Object} GetWmsStocksdocumentsProductsRequest
3158
+ * @property {(type: 'pz'|'pw'|'px'|'rx'|'rw'|'mm'|'wz'|'zw') => GetWmsStocksdocumentsProductsRequest} type
3159
+ * @property {(id: Integer) => GetWmsStocksdocumentsProductsRequest} id Document identifier.
3160
+ * @property {(results_page: Integer) => GetWmsStocksdocumentsProductsRequest} results_page Result page number.
3161
+ * @property {(results_limit: Integer) => GetWmsStocksdocumentsProductsRequest} results_limit Number of results on page.
3162
+ * @property {(page: Integer, limit: Integer) => GetWmsStocksdocumentsProductsRequest} page Define page number and maximum results per page
3163
+ * @property {() => Integer} count Returns total numer of results
3164
+ * @property {function} exec Excecute request
3165
+ */
3166
+
3167
+ /**
3168
+ * @typedef {Object} PostWmsStocksdocumentsProductsRequest
3169
+ * @property {(products: Array<Object>) => PostWmsStocksdocumentsProductsRequest} products Products list.
3170
+ * @property {(type: 'pz'|'pw'|'px'|'rx'|'rw'|'mm') => PostWmsStocksdocumentsProductsRequest} type
3171
+ * @property {(id: Integer) => PostWmsStocksdocumentsProductsRequest} id Document identifier.
3172
+ * @property {(product: Integer) => PostWmsStocksdocumentsProductsRequest} product Stock keeping unit.
3173
+ * @property {(size: String) => PostWmsStocksdocumentsProductsRequest} size Product size ID.
3174
+ * @property {(quantity: Integer) => PostWmsStocksdocumentsProductsRequest} quantity Product quantity.
3175
+ * @property {(productPurchasePrice: Number) => PostWmsStocksdocumentsProductsRequest} productPurchasePrice Cost price
3176
+ * @property {(locationId: Integer) => PostWmsStocksdocumentsProductsRequest} locationId 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> .
3177
+ * @property {(locationCode: String) => PostWmsStocksdocumentsProductsRequest} locationCode Storage location code
3178
+ * @property {(locationTextId: String) => PostWmsStocksdocumentsProductsRequest} locationTextId Warehouse location full path. Use a backslash (\) as a separator, for example: M1\Section name\Location name. 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> .
3179
+ * @property {function} append Append current data to array and start modifying next row
3180
+ * @property {function} exec Excecute request
3181
+ */
3182
+
3183
+ /**
3184
+ * @typedef {Object} PutWmsStocksdocumentsProductsRequest
3185
+ * @property {(products: Array<Object>) => PutWmsStocksdocumentsProductsRequest} products Products list.
3186
+ * @property {(type: 'pz'|'pw'|'px'|'rx'|'rw'|'mm') => PutWmsStocksdocumentsProductsRequest} type
3187
+ * @property {(id: Integer) => PutWmsStocksdocumentsProductsRequest} id Document identifier.
3188
+ * @property {(product: Integer) => PutWmsStocksdocumentsProductsRequest} product Stock keeping unit.
3189
+ * @property {(size: String) => PutWmsStocksdocumentsProductsRequest} size Product size ID.
3190
+ * @property {(quantity: Integer) => PutWmsStocksdocumentsProductsRequest} quantity Product quantity.
3191
+ * @property {(productPurchasePrice: Number) => PutWmsStocksdocumentsProductsRequest} productPurchasePrice Cost price
3192
+ * @property {(locationId: Integer) => PutWmsStocksdocumentsProductsRequest} locationId 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> .
3193
+ * @property {(locationCode: String) => PutWmsStocksdocumentsProductsRequest} locationCode Storage location code
3194
+ * @property {(locationTextId: String) => PutWmsStocksdocumentsProductsRequest} locationTextId Warehouse location full path. Use a backslash (\) as a separator, for example: M1\Section name\Location name. 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> .
3195
+ * @property {function} append Append current data to array and start modifying next row
3196
+ * @property {function} exec Excecute request
3197
+ */
3198
+
3199
+ /**
3200
+ * @typedef {Object} PutWmsStocksdocumentsRejectMMRequest
3201
+ * @property {(id: Integer) => PutWmsStocksdocumentsRejectMMRequest} id Document identifier.
3202
+ * @property {function} exec Excecute request
3203
+ */
3204
+
3205
+ /**
3206
+ * @typedef {Object} DeleteWmsSuppliersRequest
3207
+ * @property {(ids: Array<Integer>) => DeleteWmsSuppliersRequest} ids Id
3208
+ * @property {function} exec Excecute request
3209
+ */
3210
+
3211
+ /**
3212
+ * @typedef {Object} GetWmsSuppliersRequest
3213
+ * @property {(resultsPage: Integer) => GetWmsSuppliersRequest} resultsPage Page with results number. Numeration starts from 0
3214
+ * @property {(resultsLimit: Integer) => GetWmsSuppliersRequest} resultsLimit Number of results on page. Value from 1 to 100
3215
+ * @property {(returnProductsCount: Boolean) => GetWmsSuppliersRequest} returnProductsCount Return quantity of products assigned to supplier
3216
+ * @property {(names: Array<String>) => GetWmsSuppliersRequest} names Names
3217
+ * @property {(ids: Array<Integer>) => GetWmsSuppliersRequest} ids IDs
3218
+ * @property {(page: Integer, limit: Integer) => GetWmsSuppliersRequest} page Define page number and maximum results per page
3219
+ * @property {() => Integer} count Returns total numer of results
3220
+ * @property {function} exec Excecute request
3221
+ */
3222
+
3223
+ /**
3224
+ * @typedef {Object} PutWmsSuppliersRequest
3225
+ * @property {(suppliers: Array<Object>) => PutWmsSuppliersRequest} suppliers
3226
+ * @property {(id: Integer) => PutWmsSuppliersRequest} id Id
3227
+ * @property {(name: String) => PutWmsSuppliersRequest} name Name.
3228
+ * @property {(email: String) => PutWmsSuppliersRequest} email e-mail address. (limit of 50 characters)
3229
+ * @property {(phone: String) => PutWmsSuppliersRequest} phone Phone number. (limit of 20 characters)
3230
+ * @property {(fax: String) => PutWmsSuppliersRequest} fax Fax. (limit of 20 characters)
3231
+ * @property {(street: String) => PutWmsSuppliersRequest} street Address. (limit of 50 characters)
3232
+ * @property {(zipCode: String) => PutWmsSuppliersRequest} zipCode ZIP / Post code. (limit of 6 characters)
3233
+ * @property {(city: String) => PutWmsSuppliersRequest} city Town / City. (limit of 50 characters)
3234
+ * @property {(country: Integer) => PutWmsSuppliersRequest} country Region ID
3235
+ * @property {(taxCode: String) => PutWmsSuppliersRequest} taxCode VAT no.. (limit of 13 characters)
3236
+ * @property {(averageDeliveryTime: Object) => PutWmsSuppliersRequest} averageDeliveryTime Average delivery time
3237
+ * @property {(description: String) => PutWmsSuppliersRequest} description Description. (limit of 255 characters)
3238
+ * @property {(orderCompletionTime: Object) => PutWmsSuppliersRequest} orderCompletionTime Order preparation time for shipment
3239
+ * @property {(workDays: Array<Object>) => PutWmsSuppliersRequest} workDays Supplier working hours
3240
+ * @property {function} append Append current data to array and start modifying next row
3241
+ * @property {function} exec Excecute request
3242
+ *//**
3243
+ * Idosell Gateways.
3244
+ * @typedef {Object} Gateways
3245
+ * @property {GetClientsBalanceRequest} getClientsBalance Method that enables extracting customer balance information from existing customer accounts.
3246
+ * @property {PostClientsBalanceRequest} postClientsBalance Method that allows for customer account balance operations.
3247
+ * @property {GetClientsRequest} getClients Method that enables extracting customer account details.
3248
+ * @property {PostClientsRequest} postClients Method that enables adding new customer accounts to the IdoSell Shop administration panel.
3249
+ * @property {PutClientsRequest} putClients Method enables modifying existing customer account data.
3250
+ * @property {GetClientsCrmRequest} getClientsCrm The method allows to download information about customers from the CRM module assigned to stores to which the user has rights.
3251
+ * @property {DeleteClientsDeliveryAddressRequest} deleteClientsDeliveryAddress The method allows you to delete unused delivery addresses for customer accounts in the IdoSell Shop administration panel
3252
+ * @property {GetClientsDeliveryAddressRequest} getClientsDeliveryAddress Method that enables extracting information about delivery addresses assigned to existing customer accounts.
3253
+ * @property {PostClientsDeliveryAddressRequest} postClientsDeliveryAddress Method that enables adding delivery address details to existing customer accounts.
3254
+ * @property {PutClientsDeliveryAddressRequest} putClientsDeliveryAddress Method that enables editing the delivery address details for existing customer accounts.
3255
+ * @property {PutClientsExternalCodeRequest} putClientsExternalCode Method that enables setting external system codes for existing customer accounts.
3256
+ * @property {PutClientsGiftcardsBlockRequest} putClientsGiftcardsBlock Enables gift card blocking
3257
+ * @property {DeleteClientsGiftcardsRequest} deleteClientsGiftcards Enables deleting a single or a list of gift cards
3258
+ * @property {GetClientsGiftcardsRequest} getClientsGiftcards Enables searching for gift cards and retrieving information about indicated gift cards
3259
+ * @property {PostClientsGiftcardsRequest} postClientsGiftcards Enables adding new gift cards with the selected card type
3260
+ * @property {PutClientsGiftcardsRequest} putClientsGiftcards Enables editing gift parameters, e.g. changing its balance, validity date, number or PIN
3261
+ * @property {GetClientsGiftcardsTypesRequest} getClientsGiftcardsTypes Allows for downloading all types of gift cards defined in the administration panel
3262
+ * @property {PutClientsGiftcardsUnblockRequest} putClientsGiftcardsUnblock Enables gift card unblocking
3263
+ * @property {GetClientsMembershipCardsRequest} getClientsMembershipCards Method that enables extracting information about loyalty cards available in the administration panel.
3264
+ * @property {PutClientsMembershipCardsRequest} putClientsMembershipCards Method that enables assigning loyalty cards to customer accounts.
3265
+ * @property {GetClientsNewsletterEmailSMSRequest} getClientsNewsletterEmailSMS Method that enables extracting a list of customer accounts that agreed / did not agree to receiving text message newsletters.
3266
+ * @property {GetClientsNewsletterEmailShopsRequest} getClientsNewsletterEmailShops Method that enables extracting a list of customer accounts that agreed / did not agree to receiving email newsletters.
3267
+ * @property {DeleteClientsPayerAddressRequest} deleteClientsPayerAddress The method allows you to delete unused buyer addresses for customer accounts in the IdoSell Shop administration panel
3268
+ * @property {GetClientsPayerAddressRequest} getClientsPayerAddress The method allows to retrieve buyer's addresses from sales documents, for existing customer accounts in the IdoSell administration panel.
3269
+ * @property {PostClientsPayerAddressRequest} postClientsPayerAddress The method allows to add buyer's addresses to sales documents, for existing customer accounts in the IdoSell administration panel.
3270
+ * @property {PutClientsPayerAddressRequest} putClientsPayerAddress The method allows to modify buyer's addresses in sales documents, for existing customer accounts in the IdoSell administration panel.
3271
+ * @property {GetClientsPricelistsClientsRequest} getClientsPricelistsClients The getClients method returns a list of customer IDs assigned to an individual price list
3272
+ * @property {PutClientsPricelistsClientsRequest} putClientsPricelistsClients The setClients method allows you to assign customers to an individual price list
3273
+ * @property {DeleteClientsPricelistsRequest} deleteClientsPricelists The delete method enables to delete an individual pricelist. The pricelist must not be associated with any customer. In order to check the clients related to the given group, the getClients method shall be used.
3274
+ * @property {GetClientsPricelistsRequest} getClientsPricelists The get method allows you to download individual price lists available in the administration panel
3275
+ * @property {PostClientsPricelistsRequest} postClientsPricelists The insert method enables you to add a new individual price list to the administration panel
3276
+ * @property {PutClientsPricelistsRequest} putClientsPricelists The update method allows you to change the individual price list.
3277
+ * @property {GetClientsPricelistsProductsRequest} getClientsPricelistsProducts The getProducts method enables the retrieval of products from an individual price list together with the price
3278
+ * @property {PutClientsPricelistsProductsRequest} putClientsPricelistsProducts The setProducts method allows you to add goods to an individual price list and specify their price
3279
+ * @property {PutClientsPricelistsRenameRequest} putClientsPricelistsRename The rename method enables changing the name of an individual price list
3280
+ * @property {GetClientsPricesActiveCardRequest} getClientsPricesActiveCard Method that enables getting information about active customer loyalty cards assigned to customer accounts in the administration panel.
3281
+ * @property {GetClientsPricesDiscountGroupsRequest} getClientsPricesDiscountGroups Method that enables extracting information about discount groups configured in the administration panel.
3282
+ * @property {GetClientsPricesDiscountsRequest} getClientsPricesDiscounts Method that allows for extracting information about individual discounts assigned to customer accounts.
3283
+ * @property {PutClientsPricesDiscountsRequest} putClientsPricesDiscounts Method that enables assigning individual discount to existing customer accounts.
3284
+ * @property {GetClientsProfitPointsRequest} getClientsProfitPoints Method that enables extracting information about the amount of loyalty points collected by customers in a loyalty program.
3285
+ * @property {PostClientsProfitPointsRequest} postClientsProfitPoints Method that allows for adding loyalty points to the balances of existing customer accounts.
3286
+ * @property {GetClientsProvinceListRequest} getClientsProvinceList The method allows to retrieve the list of administrative regions available in the IdoSell administration panel.
3287
+ * @property {DeleteClientsTagsClearRequest} deleteClientsTagsClear Use this method to delete all tags assigned to a customer
3288
+ * @property {DeleteClientsTagsRequest} deleteClientsTags Use this method to delete selected tags assigned to a customer
3289
+ * @property {GetClientsTagsRequest} getClientsTags Use this method to retrieve all tags assigned to a client
3290
+ * @property {PostClientsTagsRequest} postClientsTags Use this method to add new tags and their associated values to the client
3291
+ * @property {PutClientsTagsRequest} putClientsTags The method is used to update the value of the tags assigned to the client. A tag with value 0 is detached from the client
3292
+ * @property {GetCouriersAssignedToShippingProfilesRequest} getCouriersAssignedToShippingProfiles Retrieves information about assigned couriers to delivery profiles
3293
+ * @property {GetCouriersRequest} getCouriers Method that returns all couriers available for a given country. It also returns information whether the courier service handles personal collections.
3294
+ * @property {DeleteCouriersPickupPointsRequest} deleteCouriersPickupPoints The method enables cancelling personal collection points within your own collection points chain. It does not allow for modifying integrated couriers collection points.
3295
+ * @property {GetCouriersPickupPointsRequest} getCouriersPickupPoints The method returns personal collection points within its own network of collection points and for integrated couriers.
3296
+ * @property {PostCouriersPickupPointsRequest} postCouriersPickupPoints The method enables adding personal collection points within your own collection points chain. It does not allow for modifying integrated couriers collection points.
3297
+ * @property {PutCouriersPickupPointsRequest} putCouriersPickupPoints The method enables updating personal collection points within your own collection points chain. It does not allow for modifying integrated couriers collection points.
3298
+ * @property {PutDeliveriesDefaultProfilesRequest} putDeliveriesDefaultProfiles The method allows to set the default delivery profile for the given region.
3299
+ * @property {GetDeliveriesProfilesRequest} getDeliveriesProfiles Allows to download all of the delivery profiles defined in the administration panel
3300
+ * @property {GetDeliveriesRegionsRequest} getDeliveriesRegions The method allows to download a list of regions supporting deliveries.
3301
+ * @property {PostDeliveriesRegionsRequest} postDeliveriesRegions Allows you to add a region to the indicated country
3302
+ * @property {GetDiscountsGroupsClientsRequest} getDiscountsGroupsClients Returns the list of customer IDs assigned to an indicated discount group. In order to assign a discount group, use setClients method in API Clients.
3303
+ * @property {DeleteDiscountsGroupsRequest} deleteDiscountsGroups Allows to remove a discount group. The condition for conducting this process is no customers assigned to the indicated group. In order to check the assigned customers use getClientsAssignedToDiscountGroup method.
3304
+ * @property {GetDiscountsGroupsRequest} getDiscountsGroups Method that enables extracting information about discount groups configured in the administration panel.
3305
+ * @property {PostDiscountsGroupsRequest} postDiscountsGroups Allows to add a new discount group in the administration panel. The discount group is added by default with the setting "Discount for products - yes, but different for indicated groups".
3306
+ * @property {PutDiscountsGroupsRequest} putDiscountsGroups Allows to change a discount group name
3307
+ * @property {DeleteDiscountsGroupsProductsRequest} deleteDiscountsGroupsProducts The method allows the removal of products from a discount group
3308
+ * @property {PutDiscountsGroupsProductsRequest} putDiscountsGroupsProducts The method allows products to be added to a discount group and their price to be specified in the discount group
3309
+ * @property {PutDiscountsRebatesBlockCardRequest} putDiscountsRebatesBlockCard Allows to block an indicated discount card, eg. when it is assumed that its number has been made available publicly. The blocked card can be unblocked with the method unblockRebateCard.
3310
+ * @property {DeleteDiscountsRebatesCardRequest} deleteDiscountsRebatesCard Method allows to quickly delete all the discount codes, which have never been used by customers, from an indicated rebate campaign. Codes which have been used at least once, will not be deleted.
3311
+ * @property {PostDiscountsRebatesCardRequest} postDiscountsRebatesCard Allows to upload new card numbers to already existing discount card types in the administration panel. Cards uploaded such way retrieve settings, regarding the discount amount, from the type of cards to which they are uploaded. Every card can also have individual, independent discount settings which can be set in the administration panel..
3312
+ * @property {DeleteDiscountsRebatesCodeRequest} deleteDiscountsRebatesCode Allows to quickly delete all the discount codes, which have never been used by customers, from an indicated rebate campaign. Codes which have been used at least once, will not be deleted.
3313
+ * @property {PostDiscountsRebatesCodeRequest} postDiscountsRebatesCode Allows to upload new code numbers to already existing rebate campaigns in the administration panel. The codes uploaded in such way retrieve settings, regarding the discount amount, from a campaign to which they are uploaded. Each discount code can also have individual, independent discount settings which can be set in the administration panel.
3314
+ * @property {PutDiscountsRebatesUnblockCardRequest} putDiscountsRebatesUnblockCard unblockRebateCard method - allows to unblock discount cards. Block cards with the blockRebateCard method.
3315
+ * @property {DeleteEntriesRequest} deleteEntries Enables deleting blog or news entry
3316
+ * @property {GetEntriesRequest} getEntries Enables downloading blog or news entry data
3317
+ * @property {PostEntriesRequest} postEntries Enables adding blog or news entry
3318
+ * @property {PutEntriesRequest} putEntries Enables changing blog or news entry in the shop
3319
+ * @property {GetEntriesPagesToDisplayRequest} getEntriesPagesToDisplay Allows you to download a list of sites on which a blog entry or a news item can be published.
3320
+ * @property {GetMenuFilterRequest} getMenuFilter The method returns information about filter settings in menu nodes.
3321
+ * @property {PutMenuFilterRequest} putMenuFilter The method allows you to manage filter settings in menu nodes.
3322
+ * @property {DeleteMenuRequest} deleteMenu Method that enables deleting existing menu elements.
3323
+ * @property {GetMenuRequest} getMenu Method that returns information about menus and menu elements.
3324
+ * @property {PostMenuRequest} postMenu Method that enables adding new menu elements.
3325
+ * @property {PutMenuRequest} putMenu Method that enables editing existing menu elements.
3326
+ * @property {PutMenuSortRequest} putMenuSort Method that enables sorting of menu elements.
3327
+ * @property {GetOrdersAnalyticsRequest} getOrdersAnalytics The method is used to retrieve information about the margins of the goods of the order.
3328
+ * @property {GetOrdersAuctionDetailsRequest} getOrdersAuctionDetails Method that enables getting information about external listings assigned to orders in the administration panel.
3329
+ * @property {PutOrdersClientRequest} putOrdersClient
3330
+ * @property {PutOrdersCourierRequest} putOrdersCourier Method that enables changing the courier handling the shipment for an order.
3331
+ * @property {PutOrdersDeliveryAddressRequest} putOrdersDeliveryAddress Method that enables editing the delivery address details for an order in the administration panel.
3332
+ * @property {PutOrdersDevideRequest} putOrdersDevide Method for division order
3333
+ * @property {DeleteOrdersDocumentsRequest} deleteOrdersDocuments The method allows to delete documents added to the order in the IdoSell administration panel.
3334
+ * @property {GetOrdersDocumentsRequest} getOrdersDocuments Method that enables extracting information about documents issued for orders in the administration panel.
3335
+ * @property {PostOrdersDocumentsRequest} postOrdersDocuments The method allows to add TIFF, BMP, PNG, JPG, JPEG, GIF or PDF documents to the order in the IdoSell Shop administration panel.
3336
+ * @property {GetOrdersExportdocumentsEPPRequest} getOrdersExportdocumentsEPP This method returns sales and warehouse documents in the universal EDI (Electronic Data Interchange) format.
3337
+ * @property {GetOrdersExportdocumentsJPKRequest} getOrdersExportdocumentsJPK Method returns sales and warehouse documents in universal JPK format.
3338
+ * @property {GetOrdersHandlerRequest} getOrdersHandler Method that enables getting information about the handler currently assigned to an order.
3339
+ * @property {PutOrdersHandlerRequest} putOrdersHandler Method that enabled assigning a handler to an order.
3340
+ * @property {GetOrdersHistoryRequest} getOrdersHistory Method allows to retrieve orders history from the IdoSell Shop panel
3341
+ * @property {DeleteOrdersImagesRequest} deleteOrdersImages Method allows to remove image attachments from the details of the specified order.
3342
+ * @property {GetOrdersImagesRequest} getOrdersImages Method allows downloading image attachment data from the details of the specified order.
3343
+ * @property {PostOrdersImagesRequest} postOrdersImages Method allows to add image attachments to the details of the specified order.
3344
+ * @property {GetOrdersLabelsRequest} getOrdersLabels The method is used to generate parcels and printouts for a courier.
3345
+ * @property {GetOrdersOpinionsRequest} getOrdersOpinions The method allows for downloading information about reviews issued for orders available in the IdoSell Shop administration panel.
3346
+ * @property {GetOrdersOpinionsRateRequest} getOrdersOpinionsRate Evaluation of the usefulness of opinions issued for orders.
3347
+ * @property {ListOrdersRequest} listOrders Method that enables extracting information about orders present in the IdoSell Shop administration panel.
3348
+ * @property {GetOrdersRequest} getOrders Method that enables extracting information about orders present in the IdoSell Shop administration panel.
3349
+ * @property {PostOrdersRequest} postOrders Method that is used for adding new retail or wholesale orders to a shop in the administration panel.
3350
+ * @property {PutOrdersRequest} putOrders Method that enables editing an order in the administration panel. It allows, for example, to change the products included in the order or change its status.
3351
+ * @property {GetOrdersPackagesRequest} getOrdersPackages Method that enables getting a list of parcels assigned to an order.
3352
+ * @property {PostOrdersPackagesRequest} postOrdersPackages Method that enables editing parcels already assigned to an order.
3353
+ * @property {PutOrdersPackagesRequest} putOrdersPackages Method that enables editing parcels already assigned to an order.
3354
+ * @property {PutOrdersPickupPointRequest} putOrdersPickupPoint The method allows to change the collection point in the order.
3355
+ * @property {GetOrdersPrinterDocumentsRequest} getOrdersPrinterDocuments Method that enables getting a VAT invoice issued for an order added to the administration panel by the IAI POS application.
3356
+ * @property {PutOrdersProductsSerialNumbersRequest} putOrdersProductsSerialNumbers Method that enables adding serial numbers to products in an order.
3357
+ * @property {PutOrdersProfitMarginRequest} putOrdersProfitMargin Method that enables setting price margins for products in an order.
3358
+ * @property {GetOrdersProfitabilityRequest} getOrdersProfitability The method is used to retrieve information about the profitability of an order
3359
+ * @property {PutOrdersShippingCostsRequest} putOrdersShippingCosts Method that enables editing the delivery costs for an order in the administration panel.
3360
+ * @property {ListOrdersUnfinishedRequest} listOrdersUnfinished It allows you to download information about unclosed orders located in the store's administration panel. Orders with a status of false and lost are considered closed. Orders with a status of false and lost are considered closed.
3361
+ * @property {GetOrdersWarehouseRequest} getOrdersWarehouse Method that enables getting information about which warehouse an order is being handled from.
3362
+ * @property {PutOrdersWarehouseRequest} putOrdersWarehouse Method that enables setting which warehouse an order is handled from.
3363
+ * @property {GetPackagesLabelsRequest} getPackagesLabels The method allows you to download labels for the courier from orders, complaints and returns.
3364
+ * @property {PostPackagesLabelsRequest} postPackagesLabels The method is used to generate shipments and printouts for the courier in orders, complaints and returns. When generating a label with a default courier configuration, it is not necessary to complete the shipment configuration options. To generate a custom label, you must additionally forward the shipment configuration options available to the courier in a given event (parcelParameters node). Completable configuration options can be checked using the getPackages method.
3365
+ * @property {GetPackagesRequest} getPackages Method that enables getting a list of parcels assigned to an order.
3366
+ * @property {PostPackagesRequest} postPackages Method that enables adding parcels to an order.
3367
+ * @property {PutPackagesRequest} putPackages Method that enables editing parcels already assigned to an order.
3368
+ * @property {PostPaymentsCancelRequest} postPaymentsCancel Method that enables cancelling payments for orders in the administration panel.
3369
+ * @property {PostPaymentsCashbackRequest} postPaymentsCashback The method allows to send refund requests (so called cashback) for payments managed by external payment systems which have such option available..
3370
+ * @property {PutPaymentsConfirmRequest} putPaymentsConfirm Method that enables accepting payments for orders in the administration panel.
3371
+ * @property {GetPaymentsFormsRequest} getPaymentsForms Method that enables getting information about payment methods available in the administration panel.
3372
+ * @property {GetPaymentsRequest} getPayments Method that enables getting information about payments for orders in the administration panel.
3373
+ * @property {PostPaymentsRequest} postPayments Method that enables adding payments to orders in the administration panel.
3374
+ * @property {PutPaymentsRequest} putPayments Method that enables editing payments for orders in the administration panel.
3375
+ * @property {GetPaymentsProfilesRequest} getPaymentsProfiles Allows to download all of the payment profiles defined in the administration panel
3376
+ * @property {PostPaymentsRepaymentRequest} postPaymentsRepayment Method that enables adding withdrawals for orders in the administration panel.
3377
+ * @property {GetProductsSKUbyBarcodeRequest} getProductsSKUbyBarcode The method allows to download, among others, information on identifiers, names and size codes, their available stock quantity and locations in the warehouse based on scanned bar codes.
3378
+ * @property {PutProductsAttachmentsRequest} putProductsAttachments Method that enables adding and editing product attachments.
3379
+ * @property {GetProductsAuctionsRequest} getProductsAuctions Allows for downloading information about auctions and auction categories to which the product has been assigned (for a maximum of 100 products in one request)
3380
+ * @property {DeleteProductsBrandsRequest} deleteProductsBrands The method allows you to remove brands from the administration panel.
3381
+ * @property {GetProductsBrandsRequest} getProductsBrands Method that returns information about brands available in the IdoSell Shop administration panel.
3382
+ * @property {PostProductsBrandsRequest} postProductsBrands The method allows you to update brands information available in the administration panel.
3383
+ * @property {PutProductsBrandsRequest} putProductsBrands The method allows you to update brands information available in the administration panel.
3384
+ * @property {GetProductsBrandsFilterRequest} getProductsBrandsFilter The method allows you to download a list of filters for brands (manufacturers) available in the IdoSell administration panel.
3385
+ * @property {PutProductsBrandsFilterRequest} putProductsBrandsFilter The method allows you to manage filter settings for brands (manufacturers).
3386
+ * @property {PostProductsBundlesRequest} postProductsBundles createBundle method allows to create a new product with a type: set and to assign existing products as a set components. Products added via this gate are hidden from the shop customer by default. To change the visibility of created products use the gate setProducts or set it on a product card in the shop administration panel
3387
+ * @property {DeleteProductsBundlesProductsRequest} deleteProductsBundlesProducts removeProductsFromBundle method allows to remove indicated set components
3388
+ * @property {PostProductsBundlesProductsRequest} postProductsBundlesProducts addProductsToBundle method allows to add components to existing sets in the administration panel
3389
+ * @property {PutProductsBundlesProductsQuantityRequest} putProductsBundlesProductsQuantity setProductsQuantityInBundle method allows to indicate quantity of a set component
3390
+ * @property {PutProductsBundlesRenewRequest} putProductsBundlesRenew the renewProductsInBundle method allows you to rebuild components of Sets existing in the administration panel
3391
+ * @property {GetProductsCategoriesRequest} getProductsCategories Method that returns information about categories configured in the administration panel.
3392
+ * @property {PutProductsCategoriesRequest} putProductsCategories Method that enables adding new categories to the administration panel as well editing and deleting of existing categories.
3393
+ * @property {GetProductsCategoriesIdosellRequest} getProductsCategoriesIdosell Method returns information about IdoSell Categories available in store.
3394
+ * @property {GetProductsCodeExistenceRequest} getProductsCodeExistence The method allows to check if a product with the given identification code (panel ID, IAI code, manufacturer code, external system code) exists in the panel.
3395
+ * @property {PostProductsCollectionsRequest} postProductsCollections createCollection method allows to create a new product with a type: collection and to assign existing products as a collection components. Products added via this gate are hidden from the shop customer by default. To change the visibility of created products use the gate setProducts or set it on a product card in the shop administration panel
3396
+ * @property {DeleteProductsCollectionsProductsRequest} deleteProductsCollectionsProducts removeProductsFromCollection method allows to remove indicated collection components
3397
+ * @property {PostProductsCollectionsProductsRequest} postProductsCollectionsProducts addProductsToCollection method allows to add components to existing collections in the administration panel
3398
+ * @property {PutProductsCollectionsProductsRequest} putProductsCollectionsProducts setProductsQuantityInCollection method allows to indicate quantity of a collection component
3399
+ * @property {PutProductsCollectionsRenewRequest} putProductsCollectionsRenew the renewProductsInCollection method allows you to rebuild existing components of Collections in the administration panel
3400
+ * @property {GetProductsDeliveryTimeRequest} getProductsDeliveryTime The method returns the time needed to prepare the product for shipment
3401
+ * @property {GetProductsDescriptionsRequest} getProductsDescriptions Method that returns text elements for a given product, e.g. product name, long and short description, metadata.
3402
+ * @property {PutProductsDescriptionsRequest} putProductsDescriptions The method allows for setting text elements for a given product, e.g. product name, long and short description, metadata.
3403
+ * @property {PutProductsGroupsMainProductRequest} putProductsGroupsMainProduct The method allows you to change the main product in a group of products.
3404
+ * @property {PutProductsGroupsOrderRequest} putProductsGroupsOrder The method allows you to change the order of products in a group of products.
3405
+ * @property {PutProductsGroupsSettingsRequest} putProductsGroupsSettings The method allows you to change the settings for displaying products to a group of products .
3406
+ * @property {GetProductsIdBySizecodeRequest} getProductsIdBySizecode Method that returns information about product IDs, as well as size IDs and names, based on the provided product external system codes.
3407
+ * @property {DeleteProductsImagesRequest} deleteProductsImages This method is used to delete images of products
3408
+ * @property {PutProductsImagesRequest} putProductsImages Method used for adding and editing product pictures.
3409
+ * @property {GetProductsMarketingAllFacebookCatalogIdsRequest} getProductsMarketingAllFacebookCatalogIds The method allows you to download available Facebook catalogs in a given store.
3410
+ * @property {GetProductsMarketingPromotionRequest} getProductsMarketingPromotion The method allows to download a list of active special offers for the given store.
3411
+ * @property {PostProductsMarketingPromotionRequest} postProductsMarketingPromotion The method allows you to add promotions from a new module with elements.
3412
+ * @property {PutProductsMarketingPromotionRequest} putProductsMarketingPromotion The method allows you to edit the promotion from the new module with the elements.
3413
+ * @property {GetProductsMarketingZonesRequest} getProductsMarketingZones Allows for getting information about products assigned to marketing hot spots
3414
+ * @property {PutProductsMarketingZonesRequest} putProductsMarketingZones Allows for assigning products to marketing hot spots
3415
+ * @property {GetProductsOmnibusPricesRequest} getProductsOmnibusPrices Allows you to download information about the lowest prices before promotions
3416
+ * @property {PutProductsOmnibusPricesRequest} putProductsOmnibusPrices Allows for editing product strikethrough price settings
3417
+ * @property {DeleteProductsOpinionsRequest} deleteProductsOpinions The method allows to delete the feedback about the commodity from the panel.
3418
+ * @property {GetProductsOpinionsRequest} getProductsOpinions The method allows for downloading information about reviews issued for products available in the IdoSell Shop administration panel.
3419
+ * @property {PostProductsOpinionsRequest} postProductsOpinions The method allows for adding reviews of products available in the IdoSell Shop administration panel.
3420
+ * @property {PutProductsOpinionsRequest} putProductsOpinions The method allows to edit opinions about goods available in the IdoSell Shop administration panel.
3421
+ * @property {GetProductsOpinionsRateRequest} getProductsOpinionsRate Evaluation of the usefulness of opinions issued for products.
3422
+ * @property {DeleteProductsParametersRequest} deleteProductsParameters The method allows you to delete parameters and their values (for parameters that are not pinned to any product)..
3423
+ * @property {GetProductsParametersRequest} getProductsParameters Method that enables adding and editing of sections and parameters, modifying their values and setting their order.
3424
+ * @property {PutProductsParametersRequest} putProductsParameters Method that enables adding and editing of sections and parameters, modifying their values and setting their order.
3425
+ * @property {DeleteProductsRequest} deleteProducts Method used for deleting products from the IdoSell Shop administration panel.
3426
+ * @property {ListProductsRequest} listProducts Method that enables extracting information about non-deleted products available in the administration panel
3427
+ * @property {GetProductsRequest} getProducts Method that enables extracting information about non-deleted products available in the administration panel.
3428
+ * @property {PostProductsRequest} postProducts The method is used to add products
3429
+ * @property {PutProductsRequest} putProducts Method that enables editing and adding new products to the administration panel.
3430
+ * @property {DeleteProductsProductsToFacebookCatalogRequest} deleteProductsProductsToFacebookCatalog The method allows you to add products to the Facebook catalog.
3431
+ * @property {GetProductsProductsToFacebookCatalogRequest} getProductsProductsToFacebookCatalog The method allows you to retrieve products assigned to the Facebook catalog.
3432
+ * @property {PostProductsProductsToFacebookCatalogRequest} postProductsProductsToFacebookCatalog The method allows you to add products to the Facebook catalog.
3433
+ * @property {DeleteProductsProductsToPromotionRequest} deleteProductsProductsToPromotion The method allows to remove the products from the promotion.
3434
+ * @property {PostProductsProductsToPromotionRequest} postProductsProductsToPromotion The method allows to add products to an existing special offer.
3435
+ * @property {GetProductsQuestionsRequest} getProductsQuestions The method allows you to download a list of questions to products available in the IdoSell Shop administration panel.
3436
+ * @property {PutProductsQuestionsRequest} putProductsQuestions The method allows you to add and edit questions to products available in the IdoSell Shop administration panel.
3437
+ * @property {GetProductsReservationsRequest} getProductsReservations It allows to download information about product reservations in orders (for up to 100 products in one request).
3438
+ * @property {PostProductsRestoreRequest} postProductsRestore The method is used to restore deleted products
3439
+ * @property {DeleteProductsSeriesRequest} deleteProductsSeries Method allows you to delete a series of products available in the IdoSell administration panel.
3440
+ * @property {GetProductsSeriesRequest} getProductsSeries Method returns information about the product series available in the IdoSell administration panel.
3441
+ * @property {PutProductsSeriesRequest} putProductsSeries Method allows you to update information about product series available in the IdoSell administration panel.
3442
+ * @property {GetProductsSeriesFilterRequest} getProductsSeriesFilter Method allows you to retrieve a list of filters for a series of products available in the IdoSell administration panel..
3443
+ * @property {PutProductsSeriesFilterRequest} putProductsSeriesFilter The method allows you to manage the filter settings for the series..
3444
+ * @property {DeleteProductsSizesRequest} deleteProductsSizes The method is used to remove sizes
3445
+ * @property {GetProductsSizesRequest} getProductsSizes Method that returns information about product sizes configured in the administration panel
3446
+ * @property {PutProductsSizesRequest} putProductsSizes This method allows you to edit the size-dependent data
3447
+ * @property {PutProductsStockQuantityRequest} putProductsStockQuantity MetodaPozwalaNaEdycjeDanychDotyczacychIlosci
3448
+ * @property {GetProductsStocksRequest} getProductsStocks Method that enables getting information about product stock levels and warehouse locations.
3449
+ * @property {PutProductsStocksRequest} putProductsStocks Method that enables setting product stock levels and warehouse locations.
3450
+ * @property {GetProductsStrikethroughPricesRequest} getProductsStrikethroughPrices Allows for getting information about product strikethrough price settings
3451
+ * @property {PutProductsStrikethroughPricesRequest} putProductsStrikethroughPrices Allows for editing product strikethrough price settings
3452
+ * @property {PutProductsSupplierCodeRequest} putProductsSupplierCode The method allows to edit supplier data in the IdoSell Shop administration panel.
3453
+ * @property {PutProductsSupplierProductDataRequest} putProductsSupplierProductData The method allows you to edit the commodity data related to its suppliers.
3454
+ * @property {PostProductsSynchronizationFileRequest} postProductsSynchronizationFile The method allows you to upload to the goods synchronization module, the offer in a file in IOF 3.0 format.
3455
+ * @property {PutProductsSynchronizationFinishUploadRequest} putProductsSynchronizationFinishUpload Method informs commodity synchronization module that uploading of files is complete.
3456
+ * @property {PostRefundsAddAutomaticRefundRequest} postRefundsAddAutomaticRefund Method allows you to add automatic refund of payments for returns and rma.
3457
+ * @property {PostRefundsAddAutomaticRefundForOrderRequest} postRefundsAddAutomaticRefundForOrder Method allows you to add automatic refund for order.
3458
+ * @property {PostRefundsAddManualRefundRequest} postRefundsAddManualRefund Method allows you to add manual refund for return and rma.
3459
+ * @property {PutRefundsCancelRefundRequest} putRefundsCancelRefund Method allows you to cancel refund.
3460
+ * @property {PutRefundsConfirmRefundRequest} putRefundsConfirmRefund Method allows you to confirm refund.
3461
+ * @property {GetRefundsGetPossibleAutoRefundsRequest} getRefundsGetPossibleAutoRefunds Method returns Automatic refunds possible.
3462
+ * @property {GetRefundsGetRefundStatusRequest} getRefundsGetRefundStatus Method returns refund status.
3463
+ * @property {GetRefundsRetrieveRefundsListRequest} getRefundsRetrieveRefundsList Method returns a list of incomplete refunds.
3464
+ * @property {PutRefundsUpdateRefundRequest} putRefundsUpdateRefund Method allows you to update refund.
3465
+ * @property {GetReturnsRequest} getReturns Method that enables getting information about returns issued for orders in the administration panel.
3466
+ * @property {PutReturnsRequest} putReturns Method that enables editing returns issued for orders in the administration panel.
3467
+ * @property {PutReturnsSerialNumberRequest} putReturnsSerialNumber Method that enables setting serial numbers for products included in returns issued for orders in the administration panel.
3468
+ * @property {GetReturnsStatusesRequest} getReturnsStatuses Allows to download all configurable return statuses
3469
+ * @property {GetRmaRequest} getRma This get method allows you to retrieve data about existing claims
3470
+ * @property {PutRmaRequest} putRma This update method allows to update the data in existing complaints
3471
+ * @property {GetRmaStatusesRequest} getRmaStatuses Allows to download all possible complaint statuses
3472
+ * @property {DeleteSizechartsRequest} deleteSizecharts The method allows the removal of size charts.
3473
+ * @property {GetSizechartsRequest} getSizecharts The method allows size charts to be downloaded.
3474
+ * @property {PutSizechartsRequest} putSizecharts The method allows the size charts settings to be updated.
3475
+ * @property {GetSizesRequest} getSizes Method that returns information about product sizes configured in the administration panel. List of size groups (with sizes that belong to particular group) is returned as a result.
3476
+ * @property {PutSizesRequest} putSizes Method that enables creating, deleting and editing product sizes in the administration panel.
3477
+ * @property {GetSystemConfigRequest} getSystemConfig Method is used for extracting information about a shop and its most important configuration settings.
3478
+ * @property {PutSystemConfigRequest} putSystemConfig The method is used to manage the most important settings in the store and in the panel. It enables, among others, configuration of tax and billing settings and configuration of warehouse management.
3479
+ * @property {GetSystemCurrenciesRequest} getSystemCurrencies This method returns the current exchange rate in relation to the currency set in the administration panel.
3480
+ * @property {PutSystemCurrenciesRequest} putSystemCurrencies Method that allows for setting currency exchange rates in relation to the currency set in the administration panel.
3481
+ * @property {GetSystemProcessesAutomationRequest} getSystemProcessesAutomation It allows you to download the current automation processes configuration .
3482
+ * @property {PutSystemProcessesAutomationRequest} putSystemProcessesAutomation The method is used for edit of processes automation settings .
3483
+ * @property {GetSystemServerLoadRequest} getSystemServerLoad This method returns server status information which is useful in determining whether the server is currently overloaded.
3484
+ * @property {GetSystemServerTimeRequest} getSystemServerTime Method that returns the current server time, which is essential for authentication.
3485
+ * @property {GetSystemShopsDataRequest} getSystemShopsData Method is used for extracting information about a shop and its most important configuration settings.
3486
+ * @property {GetSystemUnitsRequest} getSystemUnits The method allows units of measurement to be downloaded from the IdoSell administration panel.
3487
+ * @property {PutSystemUnitsRequest} putSystemUnits The method allows existing units of measurement to be updated to the IdoSell administration panel.
3488
+ * @property {GetSystemUsersRequest} getSystemUsers Method that returns information about IdoSell Shop administration panel users.
3489
+ * @property {PutVouchersBlockRequest} putVouchersBlock Enables gift voucer blocking
3490
+ * @property {GetVouchersTypesRequest} getVouchersTypes Allows for downloading all discount code campaigns defined in the administration panel
3491
+ * @property {PutVouchersUnblockRequest} putVouchersUnblock Enables gift vouchers unblocking
3492
+ * @property {DeleteVouchersRequest} deleteVouchers Enables deleting a single or a list of gift vouchers
3493
+ * @property {GetVouchersRequest} getVouchers Enables searching for vouchers and retrieving information about indicated vouchers
3494
+ * @property {PostVouchersRequest} postVouchers Enables adding new gift vouchers with the selected voucher type
3495
+ * @property {PutVouchersRequest} putVouchers Enables editing gift voucher, e.g. changing its balance, validity date or number (only for unused vouchers)
3496
+ * @property {GetWarrantiesCountTotalRequest} getWarrantiesCountTotal Method that enables getting the number of product guarantees available in the administration panel.
3497
+ * @property {PutWarrantiesLanguageDataRequest} putWarrantiesLanguageData Method that enables editing product warranty language settings.
3498
+ * @property {DeleteWarrantiesRequest} deleteWarranties Method that enables deleting product warranties from the administration panel.
3499
+ * @property {GetWarrantiesRequest} getWarranties Method that enables getting a list of product warranties available in the administration panel.
3500
+ * @property {PostWarrantiesRequest} postWarranties Method that enables adding product warranties to the administration panel.
3501
+ * @property {PutWarrantiesRequest} putWarranties Method that enables editing product warranties available in the administration panel.
3502
+ * @property {GetWmsLocationsRequest} getWmsLocations The method allows to download information about a selected location or all locations in a given warehouse together with a list of product IDs located in these locations.
3503
+ * @property {PutWmsStocksdocumentsAcceptMMRequest} putWmsStocksdocumentsAcceptMM The method enables the MM document to be received at the target warehouse.
3504
+ * @property {PutWmsStocksdocumentsCloseRequest} putWmsStocksdocumentsClose Method that enables closing warehouse documents.
3505
+ * @property {DeleteWmsStocksdocumentsDocumentsRequest} deleteWmsStocksdocumentsDocuments Method that enables deleting open warehouse documents.
3506
+ * @property {GetWmsStocksdocumentsDocumentsRequest} getWmsStocksdocumentsDocuments The method allows for downloading a list of warehouse documents.
3507
+ * @property {PostWmsStocksdocumentsDocumentsRequest} postWmsStocksdocumentsDocuments Method that enables warehouse document creation.
3508
+ * @property {PutWmsStocksdocumentsDocumentsRequest} putWmsStocksdocumentsDocuments The method allows for warehouse documents edit .
3509
+ * @property {GetWmsStocksdocumentsOpenedDocumentsRequest} getWmsStocksdocumentsOpenedDocuments Method that enables getting a list of open warehouse documents.
3510
+ * @property {DeleteWmsStocksdocumentsProductsRequest} deleteWmsStocksdocumentsProducts Method that enables deleting products from warehouse documents.
3511
+ * @property {GetWmsStocksdocumentsProductsRequest} getWmsStocksdocumentsProducts Method that enables getting a list of products present on a warehouse document.
3512
+ * @property {PostWmsStocksdocumentsProductsRequest} postWmsStocksdocumentsProducts Method that enables adding products to warehouse documents.
3513
+ * @property {PutWmsStocksdocumentsProductsRequest} putWmsStocksdocumentsProducts Method that enables, amongst others, editing the quantity of a given product on a warehouse document.
3514
+ * @property {PutWmsStocksdocumentsRejectMMRequest} putWmsStocksdocumentsRejectMM The method allows to withdraw the MM document to the source warehouse.
3515
+ * @property {DeleteWmsSuppliersRequest} deleteWmsSuppliers The method allows for the removal of suppliers..
3516
+ * @property {GetWmsSuppliersRequest} getWmsSuppliers The method allows to download a list of suppliers along with information about the number of products assigned to them.
3517
+ * @property {PutWmsSuppliersRequest} putWmsSuppliers The method allows information about suppliers to be updated, including address details, description, order preparation time or supplier working hours..
3518
+ */
3519
+
3520
+ export const DEFAULT_VERSION = 1;