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