idosell 0.2.4 → 0.3.5

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