idosell 0.1.15 → 0.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (70) hide show
  1. package/changelog.md +34 -0
  2. package/dist/gates.def.js +465 -363
  3. package/dist/gates.js +56 -26
  4. package/dist/helpers.js +8 -0
  5. package/dist/index.js +1 -1
  6. package/dist/methods/deleteClients.js +6 -0
  7. package/dist/methods/deleteResponsibilityEntities.js +6 -0
  8. package/dist/methods/getClientsBalance.js +1 -2
  9. package/dist/methods/getDiscountsGroups.js +0 -1
  10. package/dist/methods/getOrdersAnalytics.js +0 -4
  11. package/dist/methods/getProductsCodeExistence.js +2 -5
  12. package/dist/methods/getProductsMarketingZones.js +2 -8
  13. package/dist/methods/getProductsOmnibusPrices.js +2 -7
  14. package/dist/methods/getProductsReservations.js +2 -4
  15. package/dist/methods/getProductsStocks.js +2 -4
  16. package/dist/methods/getProductsStrikethroughPrices.js +2 -8
  17. package/dist/methods/getResponsibilityEntities.js +6 -0
  18. package/dist/methods/getShopsCurrencies.js +6 -0
  19. package/dist/methods/getShopsLanguages.js +6 -0
  20. package/dist/methods/postResponsibilityEntities.js +11 -0
  21. package/dist/methods/putProductsStrikethroughPrices.js +0 -5
  22. package/dist/methods/putResponsibilityEntities.js +11 -0
  23. package/dist/methods/{getClientsCrm.js → searchClientsCrm.js} +1 -1
  24. package/dist/methods/{getClientsGiftcards.js → searchClientsGiftcards.js} +1 -1
  25. package/dist/methods/{getClientsNewsletterEmailShops.js → searchClientsNewsletterEmail.js} +1 -1
  26. package/dist/methods/{getClientsNewsletterEmailSMS.js → searchClientsNewsletterSms.js} +1 -1
  27. package/dist/methods/{listOrders.js → searchOrders.js} +1 -1
  28. package/dist/methods/{getOrdersOpinions.js → searchOrdersOpinions.js} +1 -1
  29. package/dist/methods/{listOrdersUnfinished.js → searchOrdersUnfinished.js} +1 -1
  30. package/dist/methods/{getPackages.js → searchPackages.js} +1 -2
  31. package/dist/methods/{listProducts.js → searchProducts.js} +1 -1
  32. package/dist/methods/{getProductsCategoriesIdosell.js → searchProductsCategoriesIdosell.js} +1 -1
  33. package/dist/methods/{getProductsDeliveryTime.js → searchProductsDeliveryTime.js} +1 -1
  34. package/dist/methods/{getProductsParameters.js → searchProductsParameters.js} +1 -1
  35. package/dist/request.js +2 -4
  36. package/package.json +1 -1
  37. package/tests/getClientsBalance.test.js +2 -2
  38. package/tests/getClientsGiftcards.test.js +2 -2
  39. package/tests/getDiscountsGroups.test.js +1 -1
  40. package/tests/getOrdersAnalytics.test.js +2 -2
  41. package/tests/getProductsCodeExistence.test.js +5 -10
  42. package/tests/getProductsMarketingZones.test.js +6 -11
  43. package/tests/getProductsOmnibusPrices.test.js +6 -11
  44. package/tests/getProductsReservations.test.js +6 -11
  45. package/tests/getProductsStocks.test.js +6 -11
  46. package/tests/getProductsStrikethroughPrices.test.js +6 -11
  47. package/tests/getWmsStocksdocumentsDocuments.test.js +1 -1
  48. package/tests/getWmsStocksdocumentsOpenedDocuments.test.js +1 -1
  49. package/tests/postResponsibilityEntities.test.js +8 -0
  50. package/tests/putResponsibilityEntities.test.js +8 -0
  51. package/tests/searchClientsCrm.test.js +22 -0
  52. package/tests/searchClientsGiftcards.test.js +7 -0
  53. package/tests/searchClientsNewsletterEmail.test.js +12 -0
  54. package/tests/searchClientsNewsletterSms.test.js +17 -0
  55. package/tests/searchOrders.test.js +62 -0
  56. package/tests/searchOrdersOpinions.test.js +32 -0
  57. package/tests/searchOrdersUnfinished.test.js +32 -0
  58. package/tests/searchPackages.test.js +17 -0
  59. package/tests/searchProducts.test.js +82 -0
  60. package/tests/searchProductsCategoriesIdosell.test.js +7 -0
  61. package/tests/searchProductsDeliveryTime.test.js +17 -0
  62. package/tests/searchProductsParameters.test.js +17 -0
  63. package/dist/methods/deleteProductsOpinionsOpinions.js +0 -6
  64. package/dist/methods/deleteWmsSuppliersSuppliers.js +0 -6
  65. package/dist/methods/getProductsOpinionsOpinions.js +0 -6
  66. package/dist/methods/getWmsSuppliersSuppliers.js +0 -6
  67. package/dist/methods/postProductsBundlesBundles.js +0 -6
  68. package/dist/methods/postProductsOpinionsOpinions.js +0 -6
  69. package/dist/methods/putProductsOpinionsOpinions.js +0 -6
  70. package/dist/methods/putWmsSuppliersSuppliers.js +0 -6
package/dist/gates.def.js CHANGED
@@ -1,13 +1,13 @@
1
1
  /**
2
2
  * @typedef {Object} GetClientsBalanceRequest
3
- * @property {(client_numbers: Array<Integer>) => GetClientsBalanceRequest} client_numbers Customer Id
4
- * @property {(text_search: String) => GetClientsBalanceRequest} text_search Text search through customer data.
3
+ * @property {(clientNumbers: Array<Integer>) => GetClientsBalanceRequest} clientNumbers Customer Id
4
+ * @property {(textSearch: String) => GetClientsBalanceRequest} textSearch Text search through customer data.
5
5
  * @property {(active: 'yes'|'no') => GetClientsBalanceRequest} active
6
- * @property {(has_trade_credit: 'nonzero'|'positive'|'negative'|'zero') => GetClientsBalanceRequest} has_trade_credit
7
- * @property {(last_purchase_date: Object) => GetClientsBalanceRequest} last_purchase_date Start and end date (YYYY-MM-DD).
8
- * @property {(return_elements: Array<String>) => GetClientsBalanceRequest} return_elements Elements to be returned by the endpoint. By default all elements are returned
9
- * @property {(results_page: Integer) => GetClientsBalanceRequest} results_page Results page number. Numbering begins at 0. Default value: 0.
10
- * @property {(results_limit: Integer) => GetClientsBalanceRequest} results_limit Maximum number of results on a single page. Default is 100.
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
11
  * @property {(dateFrom: DateLike, dateTo: DateLike) => GetClientsBalanceRequest} lastPurchased Type of date according to the index results
12
12
  * @property {(page: Integer, limit: Integer) => GetClientsBalanceRequest} page Define page number and maximum results per page
13
13
  * @property {() => Integer} count Returns total numer of results
@@ -36,7 +36,7 @@
36
36
  * @property {(clientHasTradeCredit: 'nonzero'|'positive'|'negative'|'zero') => GetClientsRequest} clientHasTradeCredit Trade credit: - positive or negative, - only positive, - only negative, - only zero.
37
37
  * @property {(clientLastPurchaseDate: Object) => GetClientsRequest} clientLastPurchaseDate Date of last purchase.
38
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
39
+ * @property {(returnElements: Array<String>) => GetClientsRequest} returnElements Elements to be returned by the endpoint. By default all elements are returned. Available fields: - clientId - clientsLastModificationDate - clientLogin - clientEmail - clientType - showClientAsPartner - blockAutomaticallyAssigningGroupDiscount - clientFirstName - clientLastName - clientBirthDate - clientFirm - clientNip - clientStreet - clientZipCode - clientCity - clientCountryId - langId - currencyId - clientRegionId - clientIsWholesaler - clientVatPreferences - clientGroupDiscountNumber - clientGroupDiscountName - clientCodeExternal - clientPhone1 - clientPhone2 - clientProvinceId - newsletterEmailApprovalsData - shops - clientBalances - clientTradeCredit - clientLoyaltyPoints - operator - isUnregistered - affiliateLogin - affiliateId
40
40
  * @property {(resultsPage: Integer) => GetClientsRequest} resultsPage Page with results number. Numeration starts from 0
41
41
  * @property {(resultsLimit: Integer) => GetClientsRequest} resultsLimit Number of results on page. Value from 1 to 100
42
42
  * @property {(dateFrom: DateLike, dateTo: DateLike) => GetClientsRequest} lastPurchased Type of date according to the index results
@@ -127,40 +127,40 @@
127
127
  */
128
128
 
129
129
  /**
130
- * @typedef {Object} GetClientsCrmRequest
131
- * @property {(clientLogin: String) => GetClientsCrmRequest} clientLogin Customer's login.
132
- * @property {(clientIsWholesaler: 'yes'|'no') => GetClientsCrmRequest} clientIsWholesaler Determines, whether client is a wholesaler.
133
- * @property {(clientCountryId: String) => GetClientsCrmRequest} clientCountryId Country ID in accordance with ISO-3166.
134
- * @property {(langId: String) => GetClientsCrmRequest} langId Language ID
135
- * @property {(clientCustomerServiceRepresentativeLogin: String) => GetClientsCrmRequest} clientCustomerServiceRepresentativeLogin Customer service representative.
136
- * @property {(clientDiscountGroupNumber: Integer) => GetClientsCrmRequest} clientDiscountGroupNumber Customer group number
137
- * @property {(clientRegistrationDate: Object) => GetClientsCrmRequest} clientRegistrationDate Date range of customer registrations
138
- * @property {(clientLastLoginDate: Object) => GetClientsCrmRequest} clientLastLoginDate Date of last customer login (YYYY-MM-DD)
139
- * @property {(clientType: 'person'|'person_male'|'person_female'|'firm') => GetClientsCrmRequest} clientType Customer type, possible values: - person - if client sex is not determined, - person_male - when client is a male, - person_female - when a customer is a woman, - firm - when client is company.
140
- * @property {(clientAffiliateProgram: Array<Object>) => GetClientsCrmRequest} clientAffiliateProgram Information about the loyalty program possible values: - yes_voucher - when customers are in a loyalty program and have only used vouchers, - yes_voucher_cash - when customers are in a loyalty program and have only used vouchers or cash deposits, - yes_clients, - yes_orders - when customers are in the loyalty program and have made at least one order, - no - when customers are in the loyalty program, - banned - when customers are blocked.
141
- * @property {(newsletterEmailApproval: String) => GetClientsCrmRequest} newsletterEmailApproval Permission to E-mail Newsletter.
142
- * @property {(newsletterSmsApproval: String) => GetClientsCrmRequest} newsletterSmsApproval Permission to SMS Newsletter.
143
- * @property {(searchByShops: Object) => GetClientsCrmRequest} searchByShops Shops
144
- * @property {(clientLoyaltyCard: Object) => GetClientsCrmRequest} clientLoyaltyCard Loyalty cards:
145
- * @property {(clientCodeExternal: String) => GetClientsCrmRequest} clientCodeExternal External system code.
146
- * @property {(clientCodesExternal: Array<String>) => GetClientsCrmRequest} clientCodesExternal External system codes list.
147
- * @property {(clientFirstName: String) => GetClientsCrmRequest} clientFirstName Customer's first name.
148
- * @property {(clientLastName: String) => GetClientsCrmRequest} clientLastName Customer's last name.
149
- * @property {(clientNip: String) => GetClientsCrmRequest} clientNip Customer Tax no.
150
- * @property {(clientFirm: String) => GetClientsCrmRequest} clientFirm Customer's company name.
151
- * @property {(clientEmail: String) => GetClientsCrmRequest} clientEmail E-mail address.
152
- * @property {(newsletterEmailApprovalsData: Array<Object>) => GetClientsCrmRequest} newsletterEmailApprovalsData List of shops where a customer agreed or didn't agree to receive email newsletter.
153
- * @property {(newsletterSmsApprovalsData: Array<Object>) => GetClientsCrmRequest} newsletterSmsApprovalsData List of shops where a customer agreed or didn't agree to receive sms newsletter.
154
- * @property {(clientLoyaltyCardNumber: String) => GetClientsCrmRequest} clientLoyaltyCardNumber Customer loyalty card number, omitted when has_loyalty_card = no.
155
- * @property {(orders: Object) => GetClientsCrmRequest} orders Orders.
156
- * @property {(returnElements: Array<String>) => GetClientsCrmRequest} returnElements Elements to be returned by the endpoint. By default all elements are returned
157
- * @property {(resultsPage: Integer) => GetClientsCrmRequest} resultsPage Page with results number. Numeration starts from 0
158
- * @property {(resultsLimit: Integer) => GetClientsCrmRequest} resultsLimit Number of results on page. Value from 1 to 100
159
- * @property {(settingsExactSearch: Boolean) => GetClientsCrmRequest} settingsExactSearch Determines, if data - that will be returned - will be exactly as entered values, or values should be fragment of customer data.
160
- * @property {(dateFrom: DateLike, dateTo: DateLike) => GetClientsCrmRequest} registered Type of date according to the index results
161
- * @property {(dateFrom: DateLike, dateTo: DateLike) => GetClientsCrmRequest} lastLoggedIn Type of date according to the index results
162
- * @property {(dateFrom: DateLike, dateTo: DateLike) => GetClientsCrmRequest} ordered Type of date according to the index results
163
- * @property {(page: Integer, limit: Integer) => GetClientsCrmRequest} page Define page number and maximum results per page
130
+ * @typedef {Object} SearchClientsCrmRequest
131
+ * @property {(clientLogin: String) => SearchClientsCrmRequest} clientLogin Customer's login.
132
+ * @property {(clientIsWholesaler: 'yes'|'no') => SearchClientsCrmRequest} clientIsWholesaler Determines, whether client is a wholesaler.
133
+ * @property {(clientCountryId: String) => SearchClientsCrmRequest} clientCountryId Country ID in accordance with ISO-3166.
134
+ * @property {(langId: String) => SearchClientsCrmRequest} langId Language ID
135
+ * @property {(clientCustomerServiceRepresentativeLogin: String) => SearchClientsCrmRequest} clientCustomerServiceRepresentativeLogin Customer service representative.
136
+ * @property {(clientDiscountGroupNumber: Integer) => SearchClientsCrmRequest} clientDiscountGroupNumber Customer group number
137
+ * @property {(clientRegistrationDate: Object) => SearchClientsCrmRequest} clientRegistrationDate Date range of customer registrations
138
+ * @property {(clientLastLoginDate: Object) => SearchClientsCrmRequest} clientLastLoginDate Date of last customer login (YYYY-MM-DD)
139
+ * @property {(clientType: 'person'|'person_male'|'person_female'|'firm') => SearchClientsCrmRequest} clientType Customer type, possible values: - person - if client sex is not determined, - person_male - when client is a male, - person_female - when a customer is a woman, - firm - when client is company.
140
+ * @property {(clientAffiliateProgram: Array<Object>) => SearchClientsCrmRequest} clientAffiliateProgram Information about the loyalty program possible values: - yes_voucher - when customers are in a loyalty program and have only used vouchers, - yes_voucher_cash - when customers are in a loyalty program and have only used vouchers or cash deposits, - yes_clients, - yes_orders - when customers are in the loyalty program and have made at least one order, - no - when customers are in the loyalty program, - banned - when customers are blocked.
141
+ * @property {(newsletterEmailApproval: String) => SearchClientsCrmRequest} newsletterEmailApproval Permission to E-mail Newsletter.
142
+ * @property {(newsletterSmsApproval: String) => SearchClientsCrmRequest} newsletterSmsApproval Permission to SMS Newsletter.
143
+ * @property {(searchByShops: Object) => SearchClientsCrmRequest} searchByShops Shops
144
+ * @property {(clientLoyaltyCard: Object) => SearchClientsCrmRequest} clientLoyaltyCard Loyalty cards:
145
+ * @property {(clientCodeExternal: String) => SearchClientsCrmRequest} clientCodeExternal External system code.
146
+ * @property {(clientCodesExternal: Array<String>) => SearchClientsCrmRequest} clientCodesExternal External system codes list.
147
+ * @property {(clientFirstName: String) => SearchClientsCrmRequest} clientFirstName Customer's first name.
148
+ * @property {(clientLastName: String) => SearchClientsCrmRequest} clientLastName Customer's last name.
149
+ * @property {(clientNip: String) => SearchClientsCrmRequest} clientNip Customer Tax no.
150
+ * @property {(clientFirm: String) => SearchClientsCrmRequest} clientFirm Customer's company name.
151
+ * @property {(clientEmail: String) => SearchClientsCrmRequest} clientEmail E-mail address.
152
+ * @property {(newsletterEmailApprovalsData: Array<Object>) => SearchClientsCrmRequest} newsletterEmailApprovalsData List of shops where a customer agreed or didn't agree to receive email newsletter.
153
+ * @property {(newsletterSmsApprovalsData: Array<Object>) => SearchClientsCrmRequest} newsletterSmsApprovalsData List of shops where a customer agreed or didn't agree to receive sms newsletter.
154
+ * @property {(clientLoyaltyCardNumber: String) => SearchClientsCrmRequest} clientLoyaltyCardNumber Customer loyalty card number, omitted when has_loyalty_card = no.
155
+ * @property {(orders: Object) => SearchClientsCrmRequest} orders Orders.
156
+ * @property {(returnElements: Array<String>) => SearchClientsCrmRequest} returnElements Elements to be returned by the endpoint. By default all elements are returned
157
+ * @property {(resultsPage: Integer) => SearchClientsCrmRequest} resultsPage Page with results number. Numeration starts from 0
158
+ * @property {(resultsLimit: Integer) => SearchClientsCrmRequest} resultsLimit Number of results on page. Value from 1 to 100
159
+ * @property {(settingsExactSearch: Boolean) => SearchClientsCrmRequest} settingsExactSearch Determines, if data - that will be returned - will be exactly as entered values, or values should be fragment of customer data.
160
+ * @property {(dateFrom: DateLike, dateTo: DateLike) => SearchClientsCrmRequest} registered Type of date according to the index results
161
+ * @property {(dateFrom: DateLike, dateTo: DateLike) => SearchClientsCrmRequest} lastLoggedIn Type of date according to the index results
162
+ * @property {(dateFrom: DateLike, dateTo: DateLike) => SearchClientsCrmRequest} ordered Type of date according to the index results
163
+ * @property {(page: Integer, limit: Integer) => SearchClientsCrmRequest} page Define page number and maximum results per page
164
164
  * @property {() => Integer} count Returns total numer of results
165
165
  * @property {function} exec Excecute request
166
166
  */
@@ -252,16 +252,6 @@
252
252
  * @property {function} exec Excecute request
253
253
  */
254
254
 
255
- /**
256
- * @typedef {Object} GetClientsGiftcardsRequest
257
- * @property {(giftCards: Array<Object>) => GetClientsGiftcardsRequest} giftCards List of gift cards
258
- * @property {(searchGiftCards: Object) => GetClientsGiftcardsRequest} searchGiftCards element is an element array of type searchGiftCards
259
- * @property {(ids: Array<Integer>) => GetClientsGiftcardsRequest} ids Define giftCards by passing array of values
260
- * @property {(number: Array<Integer>) => GetClientsGiftcardsRequest} number Define giftCards by passing array of values
261
- * @property {(pins: Array<Integer>) => GetClientsGiftcardsRequest} pins Define giftCards by passing array of values
262
- * @property {function} exec Excecute request
263
- */
264
-
265
255
  /**
266
256
  * @typedef {Object} PostClientsGiftcardsRequest
267
257
  * @property {(giftCards: Array<Object>) => PostClientsGiftcardsRequest} giftCards List of cards to add
@@ -296,6 +286,16 @@
296
286
  * @property {function} exec Excecute request
297
287
  */
298
288
 
289
+ /**
290
+ * @typedef {Object} SearchClientsGiftcardsRequest
291
+ * @property {(giftCards: Array<Object>) => SearchClientsGiftcardsRequest} giftCards List of gift cards
292
+ * @property {(searchGiftCards: Object) => SearchClientsGiftcardsRequest} searchGiftCards element is an element array of type searchGiftCards
293
+ * @property {(ids: Array<Integer>) => SearchClientsGiftcardsRequest} ids Define giftCards by passing array of values
294
+ * @property {(number: Array<Integer>) => SearchClientsGiftcardsRequest} number Define giftCards by passing array of values
295
+ * @property {(pins: Array<Integer>) => SearchClientsGiftcardsRequest} pins Define giftCards by passing array of values
296
+ * @property {function} exec Excecute request
297
+ */
298
+
299
299
  /**
300
300
  * @typedef {Object} GetClientsGiftcardsTypesRequest
301
301
  * @property {(resultsPage: Integer) => GetClientsGiftcardsTypesRequest} resultsPage Page with results number. Numeration starts from 0
@@ -339,29 +339,29 @@
339
339
  */
340
340
 
341
341
  /**
342
- * @typedef {Object} GetClientsNewsletterEmailSMSRequest
343
- * @property {(shops: Array<Object>) => GetClientsNewsletterEmailSMSRequest} shops
344
- * @property {(language: String) => GetClientsNewsletterEmailSMSRequest} language Customer language ID.
345
- * @property {(date: Object) => GetClientsNewsletterEmailSMSRequest} date
346
- * @property {(return_elements: Array<String>) => GetClientsNewsletterEmailSMSRequest} return_elements Elements to be returned by the endpoint. By default all elements are returned
347
- * @property {(results_page: Integer) => GetClientsNewsletterEmailSMSRequest} results_page Results page number. Numbering begins at 0. Default value: 0.
348
- * @property {(results_limit: Integer) => GetClientsNewsletterEmailSMSRequest} results_limit Maximum number of results on a single page. Default is 100.
349
- * @property {(dateFrom: DateLike, dateTo: DateLike) => GetClientsNewsletterEmailSMSRequest} dates Type of date according to the index results
350
- * @property {(page: Integer, limit: Integer) => GetClientsNewsletterEmailSMSRequest} page Define page number and maximum results per page
342
+ * @typedef {Object} SearchClientsNewsletterEmailRequest
343
+ * @property {(shops: Array<Object>) => SearchClientsNewsletterEmailRequest} shops
344
+ * @property {(language: String) => SearchClientsNewsletterEmailRequest} language Customer language ID.
345
+ * @property {(date: Object) => SearchClientsNewsletterEmailRequest} date
346
+ * @property {(return_elements: Array<String>) => SearchClientsNewsletterEmailRequest} return_elements Elements to be returned by the endpoint. By default all elements are returned
347
+ * @property {(results_page: Integer) => SearchClientsNewsletterEmailRequest} results_page Results page number. Numbering begins at 0. Default value: 0.
348
+ * @property {(results_limit: Integer) => SearchClientsNewsletterEmailRequest} results_limit Maximum number of results on a single page. Default is 100.
349
+ * @property {(dateFrom: DateLike, dateTo: DateLike) => SearchClientsNewsletterEmailRequest} dates Type of date according to the index results
350
+ * @property {(page: Integer, limit: Integer) => SearchClientsNewsletterEmailRequest} page Define page number and maximum results per page
351
351
  * @property {() => Integer} count Returns total numer of results
352
352
  * @property {function} exec Excecute request
353
353
  */
354
354
 
355
355
  /**
356
- * @typedef {Object} GetClientsNewsletterEmailShopsRequest
357
- * @property {(shops: Array<Object>) => GetClientsNewsletterEmailShopsRequest} shops
358
- * @property {(language: String) => GetClientsNewsletterEmailShopsRequest} language Customer language ID.
359
- * @property {(date: Object) => GetClientsNewsletterEmailShopsRequest} date
360
- * @property {(return_elements: Array<String>) => GetClientsNewsletterEmailShopsRequest} return_elements Elements to be returned by the endpoint. By default all elements are returned
361
- * @property {(results_page: Integer) => GetClientsNewsletterEmailShopsRequest} results_page Results page number. Numbering begins at 0. Default value: 0.
362
- * @property {(results_limit: Integer) => GetClientsNewsletterEmailShopsRequest} results_limit Maximum number of results on a single page. Default is 100.
363
- * @property {(dateFrom: DateLike, dateTo: DateLike) => GetClientsNewsletterEmailShopsRequest} dates Type of date according to the index results
364
- * @property {(page: Integer, limit: Integer) => GetClientsNewsletterEmailShopsRequest} page Define page number and maximum results per page
356
+ * @typedef {Object} SearchClientsNewsletterSmsRequest
357
+ * @property {(shops: Array<Object>) => SearchClientsNewsletterSmsRequest} shops
358
+ * @property {(language: String) => SearchClientsNewsletterSmsRequest} language Customer language ID.
359
+ * @property {(date: Object) => SearchClientsNewsletterSmsRequest} date
360
+ * @property {(return_elements: Array<String>) => SearchClientsNewsletterSmsRequest} return_elements Elements to be returned by the endpoint. By default all elements are returned
361
+ * @property {(results_page: Integer) => SearchClientsNewsletterSmsRequest} results_page Results page number. Numbering begins at 0. Default value: 0.
362
+ * @property {(results_limit: Integer) => SearchClientsNewsletterSmsRequest} results_limit Maximum number of results on a single page. Default is 100.
363
+ * @property {(dateFrom: DateLike, dateTo: DateLike) => SearchClientsNewsletterSmsRequest} dates Type of date according to the index results
364
+ * @property {(page: Integer, limit: Integer) => SearchClientsNewsletterSmsRequest} page Define page number and maximum results per page
365
365
  * @property {() => Integer} count Returns total numer of results
366
366
  * @property {function} exec Excecute request
367
367
  */
@@ -442,7 +442,7 @@
442
442
  /**
443
443
  * @typedef {Object} GetClientsPricelistsRequest
444
444
  * @property {(priceListIds: Array<Integer>) => GetClientsPricelistsRequest} priceListIds List of individual price lists.
445
- * @property {(returnElements: Array<String>) => GetClientsPricelistsRequest} returnElements Elements to be returned by the endpoint. By default all elements are returned
445
+ * @property {(returnElements: Array<String>) => GetClientsPricelistsRequest} returnElements Elements to be returned by the endpoint. By default all elements are returned. Available elements: - priceListId - priceListName - onlyOrderProductsWithManuallySetPrices - onlySeeProductsWithManuallySetPrices
446
446
  * @property {(resultsPage: Integer) => GetClientsPricelistsRequest} resultsPage Page with results number. Numeration starts from 0
447
447
  * @property {(resultsLimit: Integer) => GetClientsPricelistsRequest} resultsLimit Number of results on page. Value from 1 to 100
448
448
  * @property {(page: Integer, limit: Integer) => GetClientsPricelistsRequest} page Define page number and maximum results per page
@@ -503,7 +503,7 @@
503
503
  /**
504
504
  * @typedef {Object} GetClientsPricesDiscountGroupsRequest
505
505
  * @property {(clientDiscountGroupsNumbers: Array<Integer>) => GetClientsPricesDiscountGroupsRequest} clientDiscountGroupsNumbers Customer groups.
506
- * @property {(returnElements: Array<String>) => GetClientsPricesDiscountGroupsRequest} returnElements Elements to be returned by the endpoint. By default all elements are returned
506
+ * @property {(returnElements: Array<String>) => GetClientsPricesDiscountGroupsRequest} returnElements Elements to be returned by the endpoint. By default all elements are returned. Available elements: - clientDiscountGroupNumber - clientDiscountGroupIsCombined - clientDiscountGroupType - clientDiscountGroupValue - clientDiscountGroupName
507
507
  * @property {(resultsPage: Integer) => GetClientsPricesDiscountGroupsRequest} resultsPage Page with results number. Numeration starts from 0
508
508
  * @property {(resultsLimit: Integer) => GetClientsPricesDiscountGroupsRequest} resultsLimit Number of results on page. Value from 1 to 100
509
509
  * @property {(page: Integer, limit: Integer) => GetClientsPricesDiscountGroupsRequest} page Define page number and maximum results per page
@@ -518,7 +518,7 @@
518
518
  * @property {(clientIsActive: 'yes'|'no') => GetClientsPricesDiscountsRequest} clientIsActive Active
519
519
  * @property {(clientHasTradeCredit: 'nonzero'|'positive'|'negative'|'zero') => GetClientsPricesDiscountsRequest} clientHasTradeCredit Trade credit: - positive or negative, - only positive, - only negative, - only zero.
520
520
  * @property {(clientLastPurchaseDate: Object) => GetClientsPricesDiscountsRequest} clientLastPurchaseDate Date of last purchase.
521
- * @property {(returnElements: Array<String>) => GetClientsPricesDiscountsRequest} returnElements Elements to be returned by the endpoint. By default all elements are returned
521
+ * @property {(returnElements: Array<String>) => GetClientsPricesDiscountsRequest} returnElements Elements to be returned by the endpoint. By default all elements are returned. Available elements: - clientId - clientDiscountIsCombined - clientDiscountType - clientDiscountValue
522
522
  * @property {(resultsPage: Integer) => GetClientsPricesDiscountsRequest} resultsPage Page with results number. Numeration starts from 0
523
523
  * @property {(resultsLimit: Integer) => GetClientsPricesDiscountsRequest} resultsLimit Number of results on page. Value from 1 to 100
524
524
  * @property {(dateFrom: DateLike, dateTo: DateLike) => GetClientsPricesDiscountsRequest} lastPurchased Type of date according to the index results
@@ -547,7 +547,7 @@
547
547
  * @property {(clientIsActive: 'yes'|'no') => GetClientsProfitPointsRequest} clientIsActive Active
548
548
  * @property {(clientHasTradeCredit: 'nonzero'|'positive'|'negative'|'zero') => GetClientsProfitPointsRequest} clientHasTradeCredit Trade credit: - positive or negative, - only positive, - only negative, - only zero.
549
549
  * @property {(clientLastPurchaseDate: Object) => GetClientsProfitPointsRequest} clientLastPurchaseDate Date of last purchase.
550
- * @property {(returnElements: Array<String>) => GetClientsProfitPointsRequest} returnElements Elements to be returned by the endpoint. By default all elements are returned
550
+ * @property {(returnElements: Array<String>) => GetClientsProfitPointsRequest} returnElements Elements to be returned by the endpoint. By default all elements are returned. Available elements: - clientId - clientProfitPoints - clientProfitPointsHistories
551
551
  * @property {(resultsPage: Integer) => GetClientsProfitPointsRequest} resultsPage Page with results number. Numeration starts from 0
552
552
  * @property {(resultsLimit: Integer) => GetClientsProfitPointsRequest} resultsLimit Number of results on page. Value from 1 to 100
553
553
  * @property {(dateFrom: DateLike, dateTo: DateLike) => GetClientsProfitPointsRequest} lastPurchased Type of date according to the index results
@@ -572,6 +572,12 @@
572
572
  * @property {function} exec Excecute request
573
573
  */
574
574
 
575
+ /**
576
+ * @typedef {Object} DeleteClientsRequest
577
+ * @property {(clientId: Integer) => DeleteClientsRequest} clientId Client's ID
578
+ * @property {function} exec Excecute request
579
+ */
580
+
575
581
  /**
576
582
  * @typedef {Object} DeleteClientsTagsClearRequest
577
583
  * @property {(clientId: Integer) => DeleteClientsTagsClearRequest} clientId Unique client's number.
@@ -808,10 +814,10 @@
808
814
 
809
815
  /**
810
816
  * @typedef {Object} GetDiscountsGroupsRequest
811
- * @property {(group_numbers: Array<Integer>) => GetDiscountsGroupsRequest} group_numbers
812
- * @property {(return_elements: Array<String>) => GetDiscountsGroupsRequest} return_elements Elements to be returned by the endpoint. By default all elements are returned
813
- * @property {(results_page: Integer) => GetDiscountsGroupsRequest} results_page Results page number. Numbering begins at 0. Default value: 0.
814
- * @property {(results_limit: Integer) => GetDiscountsGroupsRequest} results_limit Maximum number of results on a single page. Default is 100.
817
+ * @property {(groupNumbers: Array<Integer>) => GetDiscountsGroupsRequest} groupNumbers
818
+ * @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
819
+ * @property {(resultsPage: Integer) => GetDiscountsGroupsRequest} resultsPage Results page number. Numbering begins at 0. Default value: 0.
820
+ * @property {(resultsLimit: Integer) => GetDiscountsGroupsRequest} resultsLimit Maximum number of results on a single page. Default is 100.
815
821
  * @property {(page: Integer, limit: Integer) => GetDiscountsGroupsRequest} page Define page number and maximum results per page
816
822
  * @property {() => Integer} count Returns total numer of results
817
823
  * @property {function} exec Excecute request
@@ -1043,14 +1049,14 @@
1043
1049
 
1044
1050
  /**
1045
1051
  * @typedef {Object} GetOrdersAnalyticsRequest
1046
- * @property {(orders: Array<Object>) => GetOrdersAnalyticsRequest} orders Orders.
1047
- * @property {(serialNumbers: Array<Integer>) => GetOrdersAnalyticsRequest} serialNumbers Define orders by passing array of values
1052
+ * @property {(orderSerialNumber: Array<Integer>) => GetOrdersAnalyticsRequest} orderSerialNumber Array of order serial numbers.
1048
1053
  * @property {function} exec Excecute request
1049
1054
  */
1050
1055
 
1051
1056
  /**
1052
1057
  * @typedef {Object} GetOrdersAuctionDetailsRequest
1053
- * @property {(orders: Array<Object>) => GetOrdersAuctionDetailsRequest} orders Orders.
1058
+ * @property {(identType: 'orders_id'|'orders_sn') => GetOrdersAuctionDetailsRequest} identType Identifier type.
1059
+ * @property {(orders: Array<String>) => GetOrdersAuctionDetailsRequest} orders Orders Id values.
1054
1060
  * @property {(ids: Array<String>) => GetOrdersAuctionDetailsRequest} ids Define orders by passing array of values
1055
1061
  * @property {(serialNumbers: Array<Integer>) => GetOrdersAuctionDetailsRequest} serialNumbers Define orders by passing array of values
1056
1062
  * @property {function} exec Excecute request
@@ -1217,22 +1223,22 @@
1217
1223
  */
1218
1224
 
1219
1225
  /**
1220
- * @typedef {Object} GetOrdersOpinionsRequest
1221
- * @property {(opinion: Object) => GetOrdersOpinionsRequest} opinion Review identification
1222
- * @property {(orders: Object) => GetOrdersOpinionsRequest} orders Orders.
1223
- * @property {(clients: Object) => GetOrdersOpinionsRequest} clients Customer data.
1224
- * @property {(dateRange: Object) => GetOrdersOpinionsRequest} dateRange Date range
1225
- * @property {(resultsPage: Integer) => GetOrdersOpinionsRequest} resultsPage Page with results number. Numeration starts from 0
1226
- * @property {(resultsLimit: Integer) => GetOrdersOpinionsRequest} resultsLimit Number of results on page. Value from 1 to 100
1227
- * @property {(ordersBy: Array<Object>) => GetOrdersOpinionsRequest} ordersBy Possibility of sorting returned list
1228
- * @property {(orderId: String) => GetOrdersOpinionsRequest} orderId Define value value nested inside orders
1229
- * @property {(orderSerialNumber: String) => GetOrdersOpinionsRequest} orderSerialNumber Define value value nested inside orders
1230
- * @property {(clientId: String) => GetOrdersOpinionsRequest} clientId Define value value nested inside clients
1231
- * @property {(clientLogin: String) => GetOrdersOpinionsRequest} clientLogin Define value value nested inside clients
1232
- * @property {(clientCode: String) => GetOrdersOpinionsRequest} clientCode Define value value nested inside clients
1233
- * @property {(dateFrom: DateLike, dateTo: DateLike) => GetOrdersOpinionsRequest} dates Type of date according to the index results
1234
- * @property {(elementName: "date"|"rating"|"scorePositive"|"scoreNegative"|"modificationDatetime", descending: Boolean) => GetOrdersOpinionsRequest} orderBy Define sorting by element and direction
1235
- * @property {(page: Integer, limit: Integer) => GetOrdersOpinionsRequest} page Define page number and maximum results per page
1226
+ * @typedef {Object} SearchOrdersOpinionsRequest
1227
+ * @property {(opinion: Object) => SearchOrdersOpinionsRequest} opinion Review identification
1228
+ * @property {(orders: Object) => SearchOrdersOpinionsRequest} orders Orders.
1229
+ * @property {(clients: Object) => SearchOrdersOpinionsRequest} clients Customer data.
1230
+ * @property {(dateRange: Object) => SearchOrdersOpinionsRequest} dateRange Date range
1231
+ * @property {(resultsPage: Integer) => SearchOrdersOpinionsRequest} resultsPage Page with results number. Numeration starts from 0
1232
+ * @property {(resultsLimit: Integer) => SearchOrdersOpinionsRequest} resultsLimit Number of results on page. Value from 1 to 100
1233
+ * @property {(ordersBy: Array<Object>) => SearchOrdersOpinionsRequest} ordersBy Possibility of sorting returned list
1234
+ * @property {(orderId: String) => SearchOrdersOpinionsRequest} orderId Define value value nested inside orders
1235
+ * @property {(orderSerialNumber: String) => SearchOrdersOpinionsRequest} orderSerialNumber Define value value nested inside orders
1236
+ * @property {(clientId: String) => SearchOrdersOpinionsRequest} clientId Define value value nested inside clients
1237
+ * @property {(clientLogin: String) => SearchOrdersOpinionsRequest} clientLogin Define value value nested inside clients
1238
+ * @property {(clientCode: String) => SearchOrdersOpinionsRequest} clientCode Define value value nested inside clients
1239
+ * @property {(dateFrom: DateLike, dateTo: DateLike) => SearchOrdersOpinionsRequest} dates Type of date according to the index results
1240
+ * @property {(elementName: "date"|"rating"|"scorePositive"|"scoreNegative"|"modificationDatetime", descending: Boolean) => SearchOrdersOpinionsRequest} orderBy Define sorting by element and direction
1241
+ * @property {(page: Integer, limit: Integer) => SearchOrdersOpinionsRequest} page Define page number and maximum results per page
1236
1242
  * @property {() => Integer} count Returns total numer of results
1237
1243
  * @property {function} exec Excecute request
1238
1244
  */
@@ -1244,57 +1250,6 @@
1244
1250
  * @property {function} exec Excecute request
1245
1251
  */
1246
1252
 
1247
- /**
1248
- * @typedef {Object} ListOrdersRequest
1249
- * @property {(orderPrepaidStatus: String) => ListOrdersRequest} orderPrepaidStatus Prepayment status. Status list: "unpaid" - not paid, "restored" - returned, "waiting" - not registered.
1250
- * @property {(ordersStatuses: Array<String>) => ListOrdersRequest} ordersStatuses Order status. Status list: "new" - not handled, "finished" - completed, "false" - false, "lost" - lost, "on_order" - in progress, "packed" - being picked, "ready" - ready, "returned" - return, "canceled" - canceled by customer, "complainted" - complaint, "payment_waiting" - awaiting payment, "delivery_waiting" - awaiting delivery, "suspended" - on hold, "joined" - merged, "finished_ext" - handled in FA application.
1251
- * @property {(shippmentStatus: 'all'|'received'|'non-received') => ListOrdersRequest} shippmentStatus
1252
- * @property {(couriersName: Array<String>) => ListOrdersRequest} couriersName Shipping companies (packages deliverers).
1253
- * @property {(couriersId: Array<Integer>) => ListOrdersRequest} couriersId Courier service identifiers
1254
- * @property {(orderPaymentType: String) => ListOrdersRequest} orderPaymentType Order payment method. Allowed values. "cash_on_delivery" - cash on delivery, "prepaid" - prepayment, "tradecredit" - Trade credit.
1255
- * @property {(withMissingSalesDocuments: Array<String>) => ListOrdersRequest} withMissingSalesDocuments
1256
- * @property {(orderType: 'wholesale'|'retail'|'dropshipping'|'deliverer') => ListOrdersRequest} orderType Order type. Allowed values. "retail" - retail order, "wholesale" - wholesale order (can be added only by customer with wholesale account registered). Default value:: "retail"
1257
- * @property {(dropshippingOrderStatus: 'all'|'finished'|'canceled'|'notCanceled') => ListOrdersRequest} dropshippingOrderStatus
1258
- * @property {(ordersIds: Array<String>) => ListOrdersRequest} ordersIds Orders IDs.
1259
- * @property {(ordersSerialNumbers: Array<Integer>) => ListOrdersRequest} ordersSerialNumbers Order serial numbers.
1260
- * @property {(clients: Array<Object>) => ListOrdersRequest} clients Customer data.
1261
- * @property {(ordersRange: Object) => ListOrdersRequest} ordersRange Ranges of dates or serial numbers.
1262
- * @property {(orderSource: Object) => ListOrdersRequest} orderSource Order source data.
1263
- * @property {(products: Array<Object>) => ListOrdersRequest} products Products list.
1264
- * @property {(resultsPage: Integer) => ListOrdersRequest} resultsPage Page with results number. Numeration starts from 0
1265
- * @property {(resultsLimit: Integer) => ListOrdersRequest} resultsLimit Number of results on page. Value from 1 to 100
1266
- * @property {(clientRequestInvoice: String) => ListOrdersRequest} clientRequestInvoice Customer asked for invoice. List of parameters: "y" - yes (paper invoicing ), "e" - yes (electronic invoicing ), "n" - no.
1267
- * @property {(packages: Object) => ListOrdersRequest} packages Information on consignments.
1268
- * @property {(stocks: Array<Object>) => ListOrdersRequest} stocks Stock quantities data.
1269
- * @property {(campaign: Object) => ListOrdersRequest} campaign Used discount codes data.
1270
- * @property {(loyaltyPointsMode: 'all'|'given'|'taken'|'given_or_taken'|'given_and_taken'|'not_given_nor_taken') => ListOrdersRequest} loyaltyPointsMode Loyalty points.
1271
- * @property {(orderOperatorLogin: String) => ListOrdersRequest} orderOperatorLogin Order handler.
1272
- * @property {(orderPackingPersonLogin: String) => ListOrdersRequest} orderPackingPersonLogin Order picker.
1273
- * @property {(ordersBy: Array<Object>) => ListOrdersRequest} ordersBy Possibility of sorting returned list
1274
- * @property {(searchingOperatorTypeMatch: 'no_assignment'|'no_empty'|'empty') => ListOrdersRequest} searchingOperatorTypeMatch Method of searching orders by handler.
1275
- * @property {(ordersDelayed: 'y'|'n') => ListOrdersRequest} ordersDelayed Orders with the exceeded date of shipment.
1276
- * @property {(showBundles: Boolean) => ListOrdersRequest} showBundles Combine the components of the set into one item
1277
- * @property {(orderExternalId: String) => ListOrdersRequest} orderExternalId The order ID of the external service
1278
- * @property {(shopIds: Array<Integer>) => ListOrdersRequest} shopIds Define shopsIds value nested inside orderSource
1279
- * @property {(byPackageNumbers: Array<String>) => ListOrdersRequest} byPackageNumbers Define packagesNumbers value nested inside packages
1280
- * @property {(dateFrom: DateLike, dateTo: DateLike, dateType: "add"|"modified"|"dispatch"|"payment"|"last_payments_operation"|"declared_payments") => ListOrdersRequest} dates Type of date according to the index results. Possible type values: add, modified, dispatch, payment, last_payments_operation, declared_payments
1281
- * @property {(elementName: "id"|"sn"|"order_time"|"status"|"order_source"|"order_cost"|"discount_code"|"ready_to_send_date", descending: Boolean) => ListOrdersRequest} orderBy Define sorting by element and direction
1282
- * @property {(logins: Array<String>) => ListOrdersRequest} logins Define clients by passing array of values
1283
- * @property {(clientIds: Array<String>) => ListOrdersRequest} clientIds Define clients by passing array of values
1284
- * @property {(productIds: Array<Integer>) => ListOrdersRequest} productIds Define products by passing array of values
1285
- * @property {(stockIds: Array<Integer>) => ListOrdersRequest} stockIds Define stocks by passing array of values
1286
- * @property {(campaignIds: Array<Integer>) => ListOrdersRequest} campaignIds Define campaign by passing array of values
1287
- * @property {(discountCodes: Array<String>) => ListOrdersRequest} discountCodes Define campaign by passing array of values
1288
- * @property {(productId: Integer, sizeId: String|null) => ListProductsRequest} hasProduct Filter by product ID and optionally product size
1289
- * @property {(orderHasPackage: Boolean) => ListProductsRequest} hasPackage Filter by orders that have any package number
1290
- * @property {(accountName: String) => ListProductsRequest} fromAllegro Filter by orders from auction service Allegro
1291
- * @property {(accountName: String) => ListProductsRequest} fromEbay Filter by orders from action service EBay
1292
- * @property {(accountName: String) => ListProductsRequest} fromAmazon Filter by orders from action service Amazon
1293
- * @property {(page: Integer, limit: Integer) => ListOrdersRequest} page Define page number and maximum results per page
1294
- * @property {() => Integer} count Returns total numer of results
1295
- * @property {function} exec Excecute request
1296
- */
1297
-
1298
1253
  /**
1299
1254
  * @typedef {Object} GetOrdersRequest
1300
1255
  * @property {(ordersIds: Array<String>) => GetOrdersRequest} ordersIds Orders IDs.
@@ -1341,7 +1296,7 @@
1341
1296
  * @property {(orders: Array<Object>) => PutOrdersRequest} orders Orders.
1342
1297
  * @property {(orderId: String) => PutOrdersRequest} orderId Order ID.
1343
1298
  * @property {(orderSerialNumber: Integer) => PutOrdersRequest} orderSerialNumber Order serial number.
1344
- * @property {(orderStatus: String) => PutOrdersRequest} orderStatus Order status. Allowed values: "finished_ext" - order status: completed in FA application, "finished" - completed, "new" - not handled, "complainted" - complaint, "payment_waiting" - awaiting payment, "delivery_waiting" - awaiting delivery, "on_order" - in progress, "packed" - being picked, "packed_fulfillment" - being picked - fulfilment, "packed_ready" - packed, "ready" - ready, "returned" - return, "wait_for_dispatch" - awaiting dispatch date, "suspended" - on hold, "joined" - merged, "missing" - missing, "lost" - lost, "false" - false, "canceled" - Customer canceled.
1299
+ * @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.
1345
1300
  * @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.
1346
1301
  * @property {(apiNoteToOrder: String) => PutOrdersRequest} apiNoteToOrder API note added to order.
1347
1302
  * @property {(clientNoteToOrder: String) => PutOrdersRequest} clientNoteToOrder Customer comments on order.
@@ -1357,8 +1312,60 @@
1357
1312
  * @property {(billingCurrency: String) => PutOrdersRequest} billingCurrency Order settlement currency.
1358
1313
  * @property {(billingCurrencyRate: Number) => PutOrdersRequest} billingCurrencyRate Panel billing currency exchange rate in relation to billing currency in the shop .
1359
1314
  * @property {(purchaseDate: String) => PutOrdersRequest} purchaseDate Sale date. ISO 8602 format.
1360
- * @property {(estimatedDeliveryDate: String) => PutOrdersRequest} estimatedDeliveryDate Estimated date of shipment of the order.
1361
- * @property {function} append Append current data to array and start modifying next row
1315
+ * @property {(estimatedDeliveryDate: String) => PutOrdersRequest} estimatedDeliveryDate Estimated date of shipment of the order in format Y-m-d H:i
1316
+ * @property {function} append Append current data to array and start modifying next row
1317
+ * @property {function} exec Excecute request
1318
+ */
1319
+
1320
+ /**
1321
+ * @typedef {Object} SearchOrdersRequest
1322
+ * @property {(orderPrepaidStatus: String) => SearchOrdersRequest} orderPrepaidStatus Prepayment status. Status list: "unpaid" - not paid, "restored" - returned, "waiting" - not registered.
1323
+ * @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.
1324
+ * @property {(shippmentStatus: 'all'|'received'|'non-received') => SearchOrdersRequest} shippmentStatus
1325
+ * @property {(couriersName: Array<String>) => SearchOrdersRequest} couriersName Shipping companies (packages deliverers).
1326
+ * @property {(couriersId: Array<Integer>) => SearchOrdersRequest} couriersId Courier service identifiers
1327
+ * @property {(orderPaymentType: String) => SearchOrdersRequest} orderPaymentType Order payment method. Allowed values. "cash_on_delivery" - cash on delivery, "prepaid" - prepayment, "tradecredit" - Trade credit.
1328
+ * @property {(withMissingSalesDocuments: Array<String>) => SearchOrdersRequest} withMissingSalesDocuments
1329
+ * @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"
1330
+ * @property {(dropshippingOrderStatus: 'all'|'finished'|'canceled'|'notCanceled') => SearchOrdersRequest} dropshippingOrderStatus
1331
+ * @property {(ordersIds: Array<String>) => SearchOrdersRequest} ordersIds Orders IDs.
1332
+ * @property {(ordersSerialNumbers: Array<Integer>) => SearchOrdersRequest} ordersSerialNumbers Order serial numbers.
1333
+ * @property {(clients: Array<Object>) => SearchOrdersRequest} clients Customer data.
1334
+ * @property {(ordersRange: Object) => SearchOrdersRequest} ordersRange Ranges of dates or serial numbers.
1335
+ * @property {(orderSource: Object) => SearchOrdersRequest} orderSource Order source data.
1336
+ * @property {(products: Array<Object>) => SearchOrdersRequest} products Products list.
1337
+ * @property {(resultsPage: Integer) => SearchOrdersRequest} resultsPage Page with results number. Numeration starts from 0
1338
+ * @property {(resultsLimit: Integer) => SearchOrdersRequest} resultsLimit Number of results on page. Value from 1 to 100
1339
+ * @property {(clientRequestInvoice: String) => SearchOrdersRequest} clientRequestInvoice Customer asked for invoice. List of parameters: "y" - yes (paper invoicing ), "e" - yes (electronic invoicing ), "n" - no.
1340
+ * @property {(packages: Object) => SearchOrdersRequest} packages Information on consignments.
1341
+ * @property {(stocks: Array<Object>) => SearchOrdersRequest} stocks Stock quantities data.
1342
+ * @property {(campaign: Object) => SearchOrdersRequest} campaign Used discount codes data.
1343
+ * @property {(loyaltyPointsMode: 'all'|'given'|'taken'|'given_or_taken'|'given_and_taken'|'not_given_nor_taken') => SearchOrdersRequest} loyaltyPointsMode Loyalty points.
1344
+ * @property {(orderOperatorLogin: String) => SearchOrdersRequest} orderOperatorLogin Order handler.
1345
+ * @property {(orderPackingPersonLogin: String) => SearchOrdersRequest} orderPackingPersonLogin Order picker.
1346
+ * @property {(ordersBy: Array<Object>) => SearchOrdersRequest} ordersBy Possibility of sorting returned list
1347
+ * @property {(searchingOperatorTypeMatch: 'no_assignment'|'no_empty'|'empty') => SearchOrdersRequest} searchingOperatorTypeMatch Method of searching orders by handler.
1348
+ * @property {(ordersDelayed: 'y'|'n') => SearchOrdersRequest} ordersDelayed Orders with the exceeded date of shipment.
1349
+ * @property {(showBundles: Boolean) => SearchOrdersRequest} showBundles Combine the components of the set into one item
1350
+ * @property {(orderExternalId: String) => SearchOrdersRequest} orderExternalId The order ID of the external service
1351
+ * @property {(orderCurrency: String) => SearchOrdersRequest} orderCurrency Order currency
1352
+ * @property {(shopIds: Array<Integer>) => SearchOrdersRequest} shopIds Define shopsIds value nested inside orderSource
1353
+ * @property {(byPackageNumbers: Array<String>) => SearchOrdersRequest} byPackageNumbers Define packagesNumbers value nested inside packages
1354
+ * @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
1355
+ * @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
1356
+ * @property {(logins: Array<String>) => SearchOrdersRequest} logins Define clients by passing array of values
1357
+ * @property {(clientIds: Array<String>) => SearchOrdersRequest} clientIds Define clients by passing array of values
1358
+ * @property {(productIds: Array<Integer>) => SearchOrdersRequest} productIds Define products by passing array of values
1359
+ * @property {(stockIds: Array<Integer>) => SearchOrdersRequest} stockIds Define stocks by passing array of values
1360
+ * @property {(campaignIds: Array<Integer>) => SearchOrdersRequest} campaignIds Define campaign by passing array of values
1361
+ * @property {(discountCodes: Array<String>) => SearchOrdersRequest} discountCodes Define campaign by passing array of values
1362
+ * @property {(productId: Integer, sizeId: String|null) => searchProductsRequest} hasProduct Filter by product ID and optionally product size
1363
+ * @property {(orderHasPackage: Boolean) => searchProductsRequest} hasPackage Filter by orders that have any package number
1364
+ * @property {(accountName: String) => searchProductsRequest} fromAllegro Filter by orders from auction service Allegro
1365
+ * @property {(accountName: String) => searchProductsRequest} fromEbay Filter by orders from action service EBay
1366
+ * @property {(accountName: String) => searchProductsRequest} fromAmazon Filter by orders from action service Amazon
1367
+ * @property {(page: Integer, limit: Integer) => SearchOrdersRequest} page Define page number and maximum results per page
1368
+ * @property {() => Integer} count Returns total numer of results
1362
1369
  * @property {function} exec Excecute request
1363
1370
  */
1364
1371
 
@@ -1445,47 +1452,47 @@
1445
1452
  */
1446
1453
 
1447
1454
  /**
1448
- * @typedef {Object} ListOrdersUnfinishedRequest
1449
- * @property {(orderPrepaidStatus: String) => ListOrdersUnfinishedRequest} orderPrepaidStatus Prepayment status. Status list: "unpaid" - not paid, "restored" - returned, "waiting" - not registered.
1450
- * @property {(ordersStatuses: Array<String>) => ListOrdersUnfinishedRequest} ordersStatuses Order status. Status list: "new" - not handled, "on_order" - in progress, "packed" - being picked, "packed_fulfillment" - being picked - fulfilment, "packed_ready" - packed, "ready" - ready, "payment_waiting" - awaiting payment, "delivery_waiting" - awaiting delivery, "wait_for_dispatch" - awaiting dispatch date, "suspended" - on hold, "finished_ext" - handled in FA application.
1451
- * @property {(couriersName: Array<String>) => ListOrdersUnfinishedRequest} couriersName Shipping companies (packages deliverers).
1452
- * @property {(orderPaymentType: String) => ListOrdersUnfinishedRequest} orderPaymentType Order payment method. Allowed values. "cash_on_delivery" - cash on delivery, "prepaid" - prepayment, "tradecredit" - Trade credit.
1453
- * @property {(orderType: 'wholesale'|'retail'|'dropshipping'|'deliverer') => ListOrdersUnfinishedRequest} orderType Order type. Allowed values: "retail" - retail order, "wholesale" - whiolesale order , "dropshipping" - order to be handled, "deliverer" - order sent to the supplier.
1454
- * @property {(dropshippingOrderStatus: 'all'|'finished'|'canceled'|'notCanceled') => ListOrdersUnfinishedRequest} dropshippingOrderStatus Dropshipping order status in the supplier's system. Allowed values: "all" - all, "finished" - sent, "canceled" - canceled, "notCanceled" - failed to cancel.
1455
- * @property {(ordersIds: Array<String>) => ListOrdersUnfinishedRequest} ordersIds Orders IDs.
1456
- * @property {(ordersSerialNumbers: Array<Integer>) => ListOrdersUnfinishedRequest} ordersSerialNumbers Order serial numbers.
1457
- * @property {(clients: Array<Object>) => ListOrdersUnfinishedRequest} clients Customer data.
1458
- * @property {(ordersRange: Object) => ListOrdersUnfinishedRequest} ordersRange Ranges of dates or serial numbers.
1459
- * @property {(orderSource: Object) => ListOrdersUnfinishedRequest} orderSource Order source data.
1460
- * @property {(products: Array<Object>) => ListOrdersUnfinishedRequest} products Products list.
1461
- * @property {(resultsPage: Integer) => ListOrdersUnfinishedRequest} resultsPage Page with results number. Numeration starts from 0
1462
- * @property {(resultsLimit: Integer) => ListOrdersUnfinishedRequest} resultsLimit Number of results on page. Value from 1 to 100
1463
- * @property {(clientRequestInvoice: String) => ListOrdersUnfinishedRequest} clientRequestInvoice Customer asked for invoice. List of parameters: "invoice" - yes (paper invoicing ), "e_invoice" - yes (electronic invoicing ), "n" - no.
1464
- * @property {(packages: Object) => ListOrdersUnfinishedRequest} packages Information on consignments.
1465
- * @property {(stocks: Array<Object>) => ListOrdersUnfinishedRequest} stocks Stock quantities data.
1466
- * @property {(campaign: Object) => ListOrdersUnfinishedRequest} campaign Used discount codes data.
1467
- * @property {(loyaltyPointsMode: 'all'|'given'|'taken'|'given_or_taken'|'given_and_taken'|'not_given_nor_taken') => ListOrdersUnfinishedRequest} loyaltyPointsMode Loyalty points.
1468
- * @property {(orderOperatorLogin: String) => ListOrdersUnfinishedRequest} orderOperatorLogin Order handler.
1469
- * @property {(orderPackingPersonLogin: String) => ListOrdersUnfinishedRequest} orderPackingPersonLogin Order picker.
1470
- * @property {(ordersBy: Array<Object>) => ListOrdersUnfinishedRequest} ordersBy Possibility of sorting returned list
1471
- * @property {(searchingOperatorTypeMatch: 'no_assignment'|'no_empty'|'empty') => ListOrdersUnfinishedRequest} searchingOperatorTypeMatch Method of searching orders by handler.
1472
- * @property {(ordersDelayed: 'y'|'n') => ListOrdersUnfinishedRequest} ordersDelayed Orders with the exceeded date of shipment.
1473
- * @property {(shopIds: Array<Integer>) => ListOrdersUnfinishedRequest} shopIds Define shopsIds value nested inside orderSource
1474
- * @property {(byPackageNumbers: Array<String>) => ListOrdersUnfinishedRequest} byPackageNumbers Define packagesNumbers value nested inside packages
1475
- * @property {(dateFrom: DateLike, dateTo: DateLike, dateType: "add"|"modified"|"dispatch"|"payment"|"last_payments_operation"|"declared_payments") => ListOrdersUnfinishedRequest} dates Type of date according to the index results. Possible type values: add, modified, dispatch, payment, last_payments_operation, declared_payments
1476
- * @property {(elementName: "id"|"sn"|"order_time"|"status"|"order_source"|"order_cost"|"discount_code"|"ready_to_send_date", descending: Boolean) => ListOrdersUnfinishedRequest} orderBy Define sorting by element and direction
1477
- * @property {(logins: Array<String>) => ListOrdersUnfinishedRequest} logins Define clients by passing array of values
1478
- * @property {(clientIds: Array<String>) => ListOrdersUnfinishedRequest} clientIds Define clients by passing array of values
1479
- * @property {(productIds: Array<Integer>) => ListOrdersUnfinishedRequest} productIds Define products by passing array of values
1480
- * @property {(stockIds: Array<Integer>) => ListOrdersUnfinishedRequest} stockIds Define stocks by passing array of values
1481
- * @property {(campaignIds: Array<Integer>) => ListOrdersUnfinishedRequest} campaignIds Define campaign by passing array of values
1482
- * @property {(discountCodes: Array<String>) => ListOrdersUnfinishedRequest} discountCodes Define campaign by passing array of values
1483
- * @property {(productId: Integer, sizeId: String|null) => ListProductsRequest} hasProduct Filter by product ID and optionally product size
1484
- * @property {(orderHasPackage: Boolean) => ListProductsRequest} hasPackage Filter by orders that have any package number
1485
- * @property {(accountName: String) => ListProductsRequest} fromAllegro Filter by orders from auction service Allegro
1486
- * @property {(accountName: String) => ListProductsRequest} fromEbay Filter by orders from action service EBay
1487
- * @property {(accountName: String) => ListProductsRequest} fromAmazon Filter by orders from action service Amazon
1488
- * @property {(page: Integer, limit: Integer) => ListOrdersUnfinishedRequest} page Define page number and maximum results per page
1455
+ * @typedef {Object} SearchOrdersUnfinishedRequest
1456
+ * @property {(orderPrepaidStatus: String) => SearchOrdersUnfinishedRequest} orderPrepaidStatus Prepayment status. Status list: "unpaid" - not paid, "restored" - returned, "waiting" - not registered.
1457
+ * @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.
1458
+ * @property {(couriersName: Array<String>) => SearchOrdersUnfinishedRequest} couriersName Shipping companies (packages deliverers).
1459
+ * @property {(orderPaymentType: String) => SearchOrdersUnfinishedRequest} orderPaymentType Order payment method. Allowed values. "cash_on_delivery" - cash on delivery, "prepaid" - prepayment, "tradecredit" - Trade credit.
1460
+ * @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.
1461
+ * @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.
1462
+ * @property {(ordersIds: Array<String>) => SearchOrdersUnfinishedRequest} ordersIds Orders IDs.
1463
+ * @property {(ordersSerialNumbers: Array<Integer>) => SearchOrdersUnfinishedRequest} ordersSerialNumbers Order serial numbers.
1464
+ * @property {(clients: Array<Object>) => SearchOrdersUnfinishedRequest} clients Customer data.
1465
+ * @property {(ordersRange: Object) => SearchOrdersUnfinishedRequest} ordersRange Ranges of dates or serial numbers.
1466
+ * @property {(orderSource: Object) => SearchOrdersUnfinishedRequest} orderSource Order source data.
1467
+ * @property {(products: Array<Object>) => SearchOrdersUnfinishedRequest} products Products list.
1468
+ * @property {(resultsPage: Integer) => SearchOrdersUnfinishedRequest} resultsPage Page with results number. Numeration starts from 0
1469
+ * @property {(resultsLimit: Integer) => SearchOrdersUnfinishedRequest} resultsLimit Number of results on page. Value from 1 to 100
1470
+ * @property {(clientRequestInvoice: String) => SearchOrdersUnfinishedRequest} clientRequestInvoice Customer asked for invoice. List of parameters: "invoice" - yes (paper invoicing ), "e_invoice" - yes (electronic invoicing ), "n" - no.
1471
+ * @property {(packages: Object) => SearchOrdersUnfinishedRequest} packages Information on consignments.
1472
+ * @property {(stocks: Array<Object>) => SearchOrdersUnfinishedRequest} stocks Stock quantities data.
1473
+ * @property {(campaign: Object) => SearchOrdersUnfinishedRequest} campaign Used discount codes data.
1474
+ * @property {(loyaltyPointsMode: 'all'|'given'|'taken'|'given_or_taken'|'given_and_taken'|'not_given_nor_taken') => SearchOrdersUnfinishedRequest} loyaltyPointsMode Loyalty points.
1475
+ * @property {(orderOperatorLogin: String) => SearchOrdersUnfinishedRequest} orderOperatorLogin Order handler.
1476
+ * @property {(orderPackingPersonLogin: String) => SearchOrdersUnfinishedRequest} orderPackingPersonLogin Order picker.
1477
+ * @property {(ordersBy: Array<Object>) => SearchOrdersUnfinishedRequest} ordersBy Possibility of sorting returned list
1478
+ * @property {(searchingOperatorTypeMatch: 'no_assignment'|'no_empty'|'empty') => SearchOrdersUnfinishedRequest} searchingOperatorTypeMatch Method of searching orders by handler.
1479
+ * @property {(ordersDelayed: 'y'|'n') => SearchOrdersUnfinishedRequest} ordersDelayed Orders with the exceeded date of shipment.
1480
+ * @property {(shopIds: Array<Integer>) => SearchOrdersUnfinishedRequest} shopIds Define shopsIds value nested inside orderSource
1481
+ * @property {(byPackageNumbers: Array<String>) => SearchOrdersUnfinishedRequest} byPackageNumbers Define packagesNumbers value nested inside packages
1482
+ * @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
1483
+ * @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
1484
+ * @property {(logins: Array<String>) => SearchOrdersUnfinishedRequest} logins Define clients by passing array of values
1485
+ * @property {(clientIds: Array<String>) => SearchOrdersUnfinishedRequest} clientIds Define clients by passing array of values
1486
+ * @property {(productIds: Array<Integer>) => SearchOrdersUnfinishedRequest} productIds Define products by passing array of values
1487
+ * @property {(stockIds: Array<Integer>) => SearchOrdersUnfinishedRequest} stockIds Define stocks by passing array of values
1488
+ * @property {(campaignIds: Array<Integer>) => SearchOrdersUnfinishedRequest} campaignIds Define campaign by passing array of values
1489
+ * @property {(discountCodes: Array<String>) => SearchOrdersUnfinishedRequest} discountCodes Define campaign by passing array of values
1490
+ * @property {(productId: Integer, sizeId: String|null) => searchProductsRequest} hasProduct Filter by product ID and optionally product size
1491
+ * @property {(orderHasPackage: Boolean) => searchProductsRequest} hasPackage Filter by orders that have any package number
1492
+ * @property {(accountName: String) => searchProductsRequest} fromAllegro Filter by orders from auction service Allegro
1493
+ * @property {(accountName: String) => searchProductsRequest} fromEbay Filter by orders from action service EBay
1494
+ * @property {(accountName: String) => searchProductsRequest} fromAmazon Filter by orders from action service Amazon
1495
+ * @property {(page: Integer, limit: Integer) => SearchOrdersUnfinishedRequest} page Define page number and maximum results per page
1489
1496
  * @property {() => Integer} count Returns total numer of results
1490
1497
  * @property {function} exec Excecute request
1491
1498
  */
@@ -1524,17 +1531,6 @@
1524
1531
  * @property {function} exec Excecute request
1525
1532
  */
1526
1533
 
1527
- /**
1528
- * @typedef {Object} GetPackagesRequest
1529
- * @property {(deliveryPackageNumbers: Array<String>) => GetPackagesRequest} deliveryPackageNumbers Consignments numbers.
1530
- * @property {(events: Array<Object>) => GetPackagesRequest} events Element, package is assigned to
1531
- * @property {(returnLabels: Boolean) => GetPackagesRequest} returnLabels Return parcel labels.
1532
- * @property {(orderSerialNumbers: Array<Integer>) => GetPackagesRequest} orders Set type to orders with given order serial numbers
1533
- * @property {(rmaIds: Array<Integer>) => GetPackagesRequest} rma Set type to rma with given rma Ids
1534
- * @property {(returnIds: Array<Integer>) => GetPackagesRequest} returns Set type to returns with given return Ids
1535
- * @property {function} exec Excecute request
1536
- */
1537
-
1538
1534
  /**
1539
1535
  * @typedef {Object} PostPackagesRequest
1540
1536
  * @property {(orderPackages: Array<Object>) => PostPackagesRequest} orderPackages List of parcels assigned to the order Maximum default number: 100 parcels.
@@ -1555,6 +1551,20 @@
1555
1551
  * @property {function} exec Excecute request
1556
1552
  */
1557
1553
 
1554
+ /**
1555
+ * @typedef {Object} SearchPackagesRequest
1556
+ * @property {(deliveryPackageNumbers: Array<String>) => SearchPackagesRequest} deliveryPackageNumbers Consignments numbers.
1557
+ * @property {(events: Array<Object>) => SearchPackagesRequest} events Element, package is assigned to
1558
+ * @property {(returnLabels: Boolean) => SearchPackagesRequest} returnLabels Return parcel labels.
1559
+ * @property {(eventType: 'order'|'rma'|'return') => SearchPackagesRequest} eventType Type.
1560
+ * @property {(eventsIds: Array<Integer>) => SearchPackagesRequest} eventsIds IDs.
1561
+ * @property {function} append Append current data to array and start modifying next row
1562
+ * @property {(orderSerialNumbers: Array<Integer>) => GetPackagesRequest} orders Set type to orders with given order serial numbers
1563
+ * @property {(rmaIds: Array<Integer>) => GetPackagesRequest} rma Set type to rma with given rma Ids
1564
+ * @property {(returnIds: Array<Integer>) => GetPackagesRequest} returns Set type to returns with given return Ids
1565
+ * @property {function} exec Excecute request
1566
+ */
1567
+
1558
1568
  /**
1559
1569
  * @typedef {Object} PostPaymentsCancelRequest
1560
1570
  * @property {(sourceType: 'order'|'return'|'rma') => PostPaymentsCancelRequest} sourceType Defines payment category. For the payments regarding returns, enter 'return'.
@@ -1662,7 +1672,8 @@
1662
1672
 
1663
1673
  /**
1664
1674
  * @typedef {Object} GetProductsAuctionsRequest
1665
- * @property {(products: Array<Object>) => GetProductsAuctionsRequest} products Products list.
1675
+ * @property {(identType: 'id'|'index'|'codeExtern'|'codeProducer') => GetProductsAuctionsRequest} identType
1676
+ * @property {(products: Array<String>) => GetProductsAuctionsRequest} products Products list.
1666
1677
  * @property {(auctionSites: Array<String>) => GetProductsAuctionsRequest} auctionSites Array of auction site IDs
1667
1678
  * @property {(resultsPage: Integer) => GetProductsAuctionsRequest} resultsPage Page with results number. Numeration starts from 0
1668
1679
  * @property {(resultsLimit: Integer) => GetProductsAuctionsRequest} resultsLimit Number of results on page. Value from 1 to 100
@@ -1717,6 +1728,7 @@
1717
1728
  * @typedef {Object} PostProductsBrandsRequest
1718
1729
  * @property {(producers: Array<Object>) => PostProductsBrandsRequest} producers List of manufacturers assigned to sought products.
1719
1730
  * @property {(nameInPanel: String) => PostProductsBrandsRequest} nameInPanel Name in panel
1731
+ * @property {(imagesSettings: Object) => PostProductsBrandsRequest} imagesSettings
1720
1732
  * @property {(languagesConfigurations: Array<Object>) => PostProductsBrandsRequest} languagesConfigurations
1721
1733
  * @property {function} append Append current data to array and start modifying next row
1722
1734
  * @property {function} exec Excecute request
@@ -1727,6 +1739,7 @@
1727
1739
  * @property {(producers: Array<Object>) => PutProductsBrandsRequest} producers List of manufacturers assigned to sought products.
1728
1740
  * @property {(id: Integer) => PutProductsBrandsRequest} id Id
1729
1741
  * @property {(nameInPanel: String) => PutProductsBrandsRequest} nameInPanel Name in panel
1742
+ * @property {(imagesSettings: Object) => PutProductsBrandsRequest} imagesSettings
1730
1743
  * @property {(languagesConfigurations: Array<Object>) => PutProductsBrandsRequest} languagesConfigurations
1731
1744
  * @property {function} append Append current data to array and start modifying next row
1732
1745
  * @property {function} exec Excecute request
@@ -1801,26 +1814,25 @@
1801
1814
  */
1802
1815
 
1803
1816
  /**
1804
- * @typedef {Object} GetProductsCategoriesIdosellRequest
1805
- * @property {(languagesIds: Array<Object>) => GetProductsCategoriesIdosellRequest} languagesIds List of languages
1806
- * @property {(categoriesIdoSellIds: Array<String>) => GetProductsCategoriesIdosellRequest} categoriesIdoSellIds Number of IdoSell Categories identifiers
1807
- * @property {(categoriesIdoSellNames: Array<String>) => GetProductsCategoriesIdosellRequest} categoriesIdoSellNames IdoSell Categories name list
1808
- * @property {(categoriesIdoSellPaths: Array<String>) => GetProductsCategoriesIdosellRequest} categoriesIdoSellPaths IdoSell Categories path list
1809
- * @property {(resultsPage: Integer) => GetProductsCategoriesIdosellRequest} resultsPage Page with results number. Numeration starts from 0
1810
- * @property {(resultsLimit: Integer) => GetProductsCategoriesIdosellRequest} resultsLimit Number of results on page. Value from 1 to 100
1811
- * @property {(languages: Array<Integer>) => GetProductsCategoriesIdosellRequest} languages Define languagesIds by passing array of values
1812
- * @property {(page: Integer, limit: Integer) => GetProductsCategoriesIdosellRequest} page Define page number and maximum results per page
1817
+ * @typedef {Object} SearchProductsCategoriesIdosellRequest
1818
+ * @property {(languagesIds: Array<String>) => SearchProductsCategoriesIdosellRequest} languagesIds List of languages
1819
+ * @property {(categoriesIdoSellIds: Array<String>) => SearchProductsCategoriesIdosellRequest} categoriesIdoSellIds Number of IdoSell Categories identifiers
1820
+ * @property {(categoriesIdoSellNames: Array<String>) => SearchProductsCategoriesIdosellRequest} categoriesIdoSellNames IdoSell Categories name list
1821
+ * @property {(categoriesIdoSellPaths: Array<String>) => SearchProductsCategoriesIdosellRequest} categoriesIdoSellPaths IdoSell Categories path list
1822
+ * @property {(resultsPage: Integer) => SearchProductsCategoriesIdosellRequest} resultsPage Page with results number. Numeration starts from 0
1823
+ * @property {(resultsLimit: Integer) => SearchProductsCategoriesIdosellRequest} resultsLimit Number of results on page. Value from 1 to 100
1824
+ * @property {(languages: Array<Integer>) => SearchProductsCategoriesIdosellRequest} languages Define languagesIds by passing array of values
1825
+ * @property {(page: Integer, limit: Integer) => SearchProductsCategoriesIdosellRequest} page Define page number and maximum results per page
1813
1826
  * @property {() => Integer} count Returns total numer of results
1814
1827
  * @property {function} exec Excecute request
1815
1828
  */
1816
1829
 
1817
1830
  /**
1818
1831
  * @typedef {Object} GetProductsCodeExistenceRequest
1819
- * @property {(products: Array<Object>) => GetProductsCodeExistenceRequest} products Products list.
1820
- * @property {(ids: Array<Integer>) => GetProductsCodeExistenceRequest} ids Define products by passing array of values
1821
- * @property {(externalCodes: Array<String>) => GetProductsCodeExistenceRequest} externalCodes Define products by passing array of values
1822
- * @property {(producerCodes: Array<String>) => GetProductsCodeExistenceRequest} producerCodes Define products by passing array of values
1823
- * @property {(deliverers: Array<Integer>) => GetProductsCodeExistenceRequest} deliverers Define products by passing array of values
1832
+ * @property {(identType: 'id'|'index'|'codeExtern'|'codeProducer'|'codeDeliverer') => GetProductsCodeExistenceRequest} identType
1833
+ * @property {(products: Array<String>) => GetProductsCodeExistenceRequest} products Products list.
1834
+ * @property {(delivererId: String) => GetProductsCodeExistenceRequest} delivererId
1835
+ * @property {(productId: Integer|Array<Integer> type: 'id'|'index'|'codeExtern'|'codeProducer') => GetProductsStrikethroughPricesRequest} productId Set product identifiers
1824
1836
  * @property {function} exec Excecute request
1825
1837
  */
1826
1838
 
@@ -1869,10 +1881,16 @@
1869
1881
  */
1870
1882
 
1871
1883
  /**
1872
- * @typedef {Object} GetProductsDeliveryTimeRequest
1873
- * @property {(stockId: Integer) => GetProductsDeliveryTimeRequest} stockId Stock ID
1874
- * @property {(isCollectionInPerson: Boolean) => GetProductsDeliveryTimeRequest} isCollectionInPerson Should products be prepared for personal collection?
1875
- * @property {(products: Array<Object>) => GetProductsDeliveryTimeRequest} products
1884
+ * @typedef {Object} SearchProductsDeliveryTimeRequest
1885
+ * @property {(stockId: Integer) => SearchProductsDeliveryTimeRequest} stockId Stock ID
1886
+ * @property {(isCollectionInPerson: Boolean) => SearchProductsDeliveryTimeRequest} isCollectionInPerson Should products be prepared for personal collection?
1887
+ * @property {(products: Array<Object>) => SearchProductsDeliveryTimeRequest} products
1888
+ * @property {(productId: Integer) => SearchProductsDeliveryTimeRequest} productId Product Id
1889
+ * @property {(sizeId: String) => SearchProductsDeliveryTimeRequest} sizeId Size identifier
1890
+ * @property {(sizePanelName: String) => SearchProductsDeliveryTimeRequest} sizePanelName Size name
1891
+ * @property {(productIndex: String) => SearchProductsDeliveryTimeRequest} productIndex Product IAI code
1892
+ * @property {(productSizeQuantity: Number) => SearchProductsDeliveryTimeRequest} productSizeQuantity Product quantity.
1893
+ * @property {function} append Append current data to array and start modifying next row
1876
1894
  * @property {(productId: Integer) => GetProductsDeliveryTimeRequest} productId Product Id
1877
1895
  * @property {(sizeId: Integer) => GetProductsDeliveryTimeRequest} sizeId Size identifier
1878
1896
  * @property {(sizePanelName: String) => GetProductsDeliveryTimeRequest} sizePanelName Size name
@@ -1952,6 +1970,7 @@
1952
1970
  * @property {(productsImages: Array<Object>) => PutProductsImagesRequest} productsImages Information on product images
1953
1971
  * @property {(productIdent: Object) => PutProductsImagesRequest} productIdent
1954
1972
  * @property {(shopId: Integer) => PutProductsImagesRequest} shopId Shop Id
1973
+ * @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.
1955
1974
  * @property {(productImages: Array<Object>) => PutProductsImagesRequest} productImages Product photos details.
1956
1975
  * @property {(productIcons: Array<Object>) => PutProductsImagesRequest} productIcons Product icons list.
1957
1976
  * @property {(productImagesSettings: Object) => PutProductsImagesRequest} productImagesSettings Product settings.
@@ -1983,45 +2002,48 @@
1983
2002
  * @property {(promotionName: String) => PostProductsMarketingPromotionRequest} promotionName Promotion name
1984
2003
  * @property {(shopsIds: Array<Integer>) => PostProductsMarketingPromotionRequest} shopsIds List of stores IDs When mask is determined, this parameter is omitted.
1985
2004
  * @property {(marketingZones: Object) => PostProductsMarketingPromotionRequest} marketingZones Special zones
1986
- * @property {(newPriceSettings: Object) => PostProductsMarketingPromotionRequest} newPriceSettings #!KonfiguracjaCenyPromocyjnej!#
1987
- * @property {(startDate: String) => PostProductsMarketingPromotionRequest} startDate #!DataRozpoczeciaWFormacieYMDHIS!#
1988
- * @property {(endDate: String) => PostProductsMarketingPromotionRequest} endDate #!DataZakonczeniaWFormacieYMDHIS!#
2005
+ * @property {(newPriceSettings: Object) => PostProductsMarketingPromotionRequest} newPriceSettings Promotional price settings
2006
+ * @property {(startDate: String) => PostProductsMarketingPromotionRequest} startDate Promotion start date in Y-m-d H:i:s format
2007
+ * @property {(endDate: String) => PostProductsMarketingPromotionRequest} endDate Promotion end date in Y-m-d H:i:s format
1989
2008
  * @property {(changeProductsToVisibleWhileStarting: 'y'|'n') => PostProductsMarketingPromotionRequest} changeProductsToVisibleWhileStarting Change the status of hidden products to visible while starting the special offer
1990
2009
  * @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)
1991
- * @property {(reduceBasingPrice: 'net'|'gross') => PostProductsMarketingPromotionRequest} reduceBasingPrice #!ObnizNaPodstawieCenyNettoBrutto!#
2010
+ * @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)
2011
+ * @property {(reduceBasingPrice: 'net'|'gross') => PostProductsMarketingPromotionRequest} reduceBasingPrice Reduce based on price (net/gross)
1992
2012
  * @property {(calculationMethod: 'sum'|'chooseAdvantageous') => PostProductsMarketingPromotionRequest} calculationMethod Price reduction calculation method
1993
- * @property {(promotionElements: Array<Object>) => PostProductsMarketingPromotionRequest} promotionElements #!ElementyNaJakieMaDzialacPromocja!#
2013
+ * @property {(promotionElements: Array<Object>) => PostProductsMarketingPromotionRequest} promotionElements Elements to be affected by the promotion
1994
2014
  * @property {(elementType: 'product'|'series'|'producer'|'category'|'menu') => PostProductsMarketingPromotionRequest} elementType
1995
- * @property {(elementId: String) => PostProductsMarketingPromotionRequest} elementId #!IdentyfikatorElementuNaJakiOddzialujePromocja!#
2015
+ * @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)
1996
2016
  * @property {function} append Append current data to array and start modifying next row
1997
2017
  * @property {function} exec Excecute request
1998
2018
  */
1999
2019
 
2000
2020
  /**
2001
2021
  * @typedef {Object} PutProductsMarketingPromotionRequest
2002
- * @property {(promotionId: String) => PutProductsMarketingPromotionRequest} promotionId Special offer ID
2022
+ * @property {(promotionId: String) => PutProductsMarketingPromotionRequest} promotionId Promotion ID
2003
2023
  * @property {(promotionName: String) => PutProductsMarketingPromotionRequest} promotionName Promotion name
2004
2024
  * @property {(shopsIds: Array<Integer>) => PutProductsMarketingPromotionRequest} shopsIds List of stores IDs When mask is determined, this parameter is omitted.
2005
2025
  * @property {(marketingZones: Object) => PutProductsMarketingPromotionRequest} marketingZones Special zones
2006
- * @property {(newPriceSettings: Object) => PutProductsMarketingPromotionRequest} newPriceSettings #!KonfiguracjaCenyPromocyjnej!#
2007
- * @property {(startDate: String) => PutProductsMarketingPromotionRequest} startDate #!DataRozpoczeciaWFormacieYMDHIS!#
2008
- * @property {(endDate: String) => PutProductsMarketingPromotionRequest} endDate #!DataZakonczeniaWFormacieYMDHIS!#
2026
+ * @property {(newPriceSettings: Object) => PutProductsMarketingPromotionRequest} newPriceSettings Promotional price settings
2027
+ * @property {(startDate: String) => PutProductsMarketingPromotionRequest} startDate Promotion start date in Y-m-d H:i:s format
2028
+ * @property {(endDate: String) => PutProductsMarketingPromotionRequest} endDate Promotion end date in Y-m-d H:i:s format
2009
2029
  * @property {(changeProductsToVisibleWhileStarting: 'y'|'n') => PutProductsMarketingPromotionRequest} changeProductsToVisibleWhileStarting Change the status of hidden products to visible while starting the special offer
2010
2030
  * @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)
2011
- * @property {(reduceBasingPrice: 'net'|'gross') => PutProductsMarketingPromotionRequest} reduceBasingPrice #!ObnizNaPodstawieCenyNettoBrutto!#
2031
+ * @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)
2032
+ * @property {(reduceBasingPrice: 'net'|'gross') => PutProductsMarketingPromotionRequest} reduceBasingPrice Reduce based on price (net/gross)
2012
2033
  * @property {(calculationMethod: 'sum'|'chooseAdvantageous') => PutProductsMarketingPromotionRequest} calculationMethod Price reduction calculation method
2013
- * @property {(removeAllPromotionElements: 'y'|'n') => PutProductsMarketingPromotionRequest} removeAllPromotionElements #!OkreslaCzyUsunacWszystkieDotychczasoweElementyPromocji!#
2014
- * @property {(promotionElements: Array<Object>) => PutProductsMarketingPromotionRequest} promotionElements #!ElementyNaJakieMaDzialacPromocja!#
2034
+ * @property {(removeAllPromotionElements: 'y'|'n') => PutProductsMarketingPromotionRequest} removeAllPromotionElements Specifies whether to remove all existing promotion elements
2035
+ * @property {(promotionElements: Array<Object>) => PutProductsMarketingPromotionRequest} promotionElements Elements to be affected by the promotion
2015
2036
  * @property {(elementType: 'product'|'series'|'producer'|'category'|'menu') => PutProductsMarketingPromotionRequest} elementType
2016
- * @property {(elementId: String) => PutProductsMarketingPromotionRequest} elementId #!IdentyfikatorElementuNaJakiOddzialujePromocja!#
2037
+ * @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)
2017
2038
  * @property {function} append Append current data to array and start modifying next row
2018
2039
  * @property {function} exec Excecute request
2019
2040
  */
2020
2041
 
2021
2042
  /**
2022
2043
  * @typedef {Object} GetProductsMarketingZonesRequest
2023
- * @property {(products: Array<Object>) => GetProductsMarketingZonesRequest} products Products list.
2024
- * @property {(productId: Integer, sizeId: Integer|String, type: 'id'|'index'|'codeExtern'|'codeProducer') => GetProductsStrikethroughPricesRequest} productId Set product and size identifiers
2044
+ * @property {(identType: 'id'|'index'|'codeExtern'|'codeProducer') => GetProductsMarketingZonesRequest} identType
2045
+ * @property {(products: Array<String>) => GetProductsMarketingZonesRequest} products Products list.
2046
+ * @property {(productId: Integer|Array<Integer> type: 'id'|'index'|'codeExtern'|'codeProducer') => GetProductsStrikethroughPricesRequest} productId Set product identifiers
2025
2047
  * @property {function} exec Excecute request
2026
2048
  */
2027
2049
 
@@ -2041,8 +2063,9 @@
2041
2063
 
2042
2064
  /**
2043
2065
  * @typedef {Object} GetProductsOmnibusPricesRequest
2044
- * @property {(products: Array<Object>) => GetProductsOmnibusPricesRequest} products Products list.
2045
- * @property {(productId: Integer, sizeId: Integer|String, type: 'id'|'index'|'codeExtern'|'codeProducer') => GetProductsStrikethroughPricesRequest} productId Set product and size identifiers
2066
+ * @property {(identType: 'id'|'index'|'codeExtern'|'codeProducer') => GetProductsOmnibusPricesRequest} identType
2067
+ * @property {(products: Array<String>) => GetProductsOmnibusPricesRequest} products Products list.
2068
+ * @property {(productId: Integer|Array<Integer> type: 'id'|'index'|'codeExtern'|'codeProducer') => GetProductsStrikethroughPricesRequest} productId Set product identifiers
2046
2069
  * @property {function} exec Excecute request
2047
2070
  */
2048
2071
 
@@ -2127,18 +2150,6 @@
2127
2150
  * @property {function} exec Excecute request
2128
2151
  */
2129
2152
 
2130
- /**
2131
- * @typedef {Object} GetProductsParametersRequest
2132
- * @property {(ids: Array<Integer>) => GetProductsParametersRequest} ids List of identifiers
2133
- * @property {(textIds: Array<Object>) => GetProductsParametersRequest} textIds Element text ID - can be entered instead of "id".
2134
- * @property {(languagesIds: Array<String>) => GetProductsParametersRequest} languagesIds List of languages
2135
- * @property {(resultsPage: Integer) => GetProductsParametersRequest} resultsPage Page with results number. Numeration starts from 0
2136
- * @property {(resultsLimit: Integer) => GetProductsParametersRequest} resultsLimit Number of results on page. Value from 1 to 100
2137
- * @property {(page: Integer, limit: Integer) => GetProductsParametersRequest} page Define page number and maximum results per page
2138
- * @property {() => Integer} count Returns total numer of results
2139
- * @property {function} exec Excecute request
2140
- */
2141
-
2142
2153
  /**
2143
2154
  * @typedef {Object} PutProductsParametersRequest
2144
2155
  * @property {(items: Array<Object>) => PutProductsParametersRequest} items Sections, parameters or valued to add or edit.
@@ -2150,12 +2161,25 @@
2150
2161
  * @property {(search_description: Array<Object>) => PutProductsParametersRequest} search_description Search descriptions of parameter value.
2151
2162
  * @property {(card_icons: Array<Object>) => PutProductsParametersRequest} card_icons Icons of section, parameter or value to display on the product card.
2152
2163
  * @property {(link_icons: Array<Object>) => PutProductsParametersRequest} link_icons Icons of section, parameter or value to display on the list of products.
2153
- * @property {(context_id: String) => PutProductsParametersRequest} context_id Parameter's additional feature. 1. Status: context_id = "CONTEXT_STATE" Takes values context_value_id: - CONTEXT_STATE_NEW - New, - CONTEXT_STATE_USED - Used, - CONTEXT_STATE_REFURBISHED_BY_PRODUCER - Renewed by a manufacturer, - CONTEXT_STATE_REFURBISHED_BY_SELLER - Renewed by a seller, - CONTEXT_STATE_FOR_PARTS_OR_BROKEN - In parts or damaged. 2. Product weight in grams: context_id = "CONTEXT_STD_UNIT_WEIGHT" Takes values context_value_id: - Value of additional feature is set automatically basing on the parameter's value. 3. A product's value in milliliters: context_id = "CONTEXT_STD_UNIT_VOLUME" Takes values context_value_id: - Value of additional feature is set automatically basing on the parameter's value. 4. Sex: context_id = "CONTEXT_SEX" Takes values context_value_id: - CONTEXT_SEX_MAN - Man, - CONTEXT_SEX_WOMAN - Woman, - CONTEXT_SEX_UNISEX - Unisex. 5. Age group: context_id = "CONTEXT_AGE_GROUP" Takes values context_value_id: - CONTEXT_AGE_GROUP_ADULT - Adults, - CONTEXT_AGE_GROUP_MINOR - Children. 6. Maximum number of products in an order: context_id = "CONTEXT_MAX_QUANTITY_PER_RETAIL_ORDER" Takes values context_value_id: - Value of additional feature is set automatically basing on the parameter's value. 7. Maximum number of products in a wholesale order: context_id = "CONTEXT_MAX_QUANTITY_PER_WHOLESALE_ORDER" Takes values context_value_id: - Value of additional feature is set automatically basing on the parameter's value. 8. Minimal number of products in an order: context_id = "CONTEXT_MIN_QUANTITY_PER_RETAIL_ORDER" Takes values context_value_id: - Value of additional feature is set automatically basing on the parameter's value. 9. Minimum number of products in a wholesale order: context_id = "CONTEXT_MIN_QUANTITY_PER_WHOLESALE_ORDER" Takes values context_value_id: - Value of additional feature is set automatically basing on the parameter's value. 10. Maximal number of a single size in an order: context_id = "CONTEXT_MAX_SIZE_QUANTITY_PER_RETAIL_ORDER" Takes values context_value_id: - Value of additional feature is set automatically basing on the parameter's value. 11. Maximal number of a single size in a wholesale order: context_id = "CONTEXT_MAX_SIZE_QUANTITY_PER_WHOLESALE_ORDER" Takes values context_value_id: - Value of additional feature is set automatically basing on the parameter's value. 12. Minimal number of a single size in an order: context_id = "CONTEXT_MIN_SIZE_QUANTITY_PER_RETAIL_ORDER" Takes values context_value_id: - Value of additional feature is set automatically basing on the parameter's value. 13. Minimal number of a single size in a wholesale order: context_id = "CONTEXT_MIN_SIZE_QUANTITY_PER_WHOLESALE_ORDER" Takes values context_value_id: - Value of additional feature is set automatically basing on the parameter's value. 14. Net weight: context_id = "CONTEXT_WEIGHT_NET" Takes values context_value_id: - Value of additional feature is set automatically basing on the parameter's value. 15. Color: context_id = "CONTEXT_COLOR" Takes values context_value_id: - Value of additional feature is set automatically basing on the parameter's value. 16. #!TylkoDlaDoroslych!#: context_id = "CONTEXT_ONLY_ADULTS" Takes values context_value_id: - CONTEXT_ONLY_ADULTS_YES - yes, - CONTEXT_ONLY_ADULTS_NO - no. 17. Prescription drug: context_id = "CONTEXT_PRESCRIPTION_MEDICINE" Takes values context_value_id: - CONTEXT_PRESCRIPTION_MEDICINE_YES - yes, - CONTEXT_PRESCRIPTION_MEDICINE_NO - no. 18. Season Rate: context_id = "CONTEXT_SEASON" Takes values context_value_id: - CONTEXT_SEASON_SPRING - Spring, - CONTEXT_SEASON_SUMMER - Summer, - CONTEXT_SEASON_FALL - Autumn, - CONTEXT_SEASON_WINTER - Winter, - CONTEXT_SEASON_SPRING_SUMMER - Spring/Summer, - CONTEXT_SEASON_FALL_WINTER - Autumn/Winter.
2164
+ * @property {(context_id: String) => PutProductsParametersRequest} context_id Parameter's additional feature. 1. Status: context_id = "CONTEXT_STATE" Takes values context_value_id: - CONTEXT_STATE_NEW - New, - CONTEXT_STATE_USED - Used, - CONTEXT_STATE_REFURBISHED_BY_PRODUCER - Renewed by a manufacturer, - CONTEXT_STATE_REFURBISHED_BY_SELLER - Renewed by a seller, - CONTEXT_STATE_FOR_PARTS_OR_BROKEN - In parts or damaged. 2. Product weight in grams: context_id = "CONTEXT_STD_UNIT_WEIGHT" Takes values context_value_id: - Value of additional feature is set automatically basing on the parameter's value. 3. A product's value in milliliters: context_id = "CONTEXT_STD_UNIT_VOLUME" Takes values context_value_id: - Value of additional feature is set automatically basing on the parameter's value. 4. Sex: context_id = "CONTEXT_SEX" Takes values context_value_id: - CONTEXT_SEX_MAN - Man, - CONTEXT_SEX_WOMAN - Woman, - CONTEXT_SEX_UNISEX - Unisex. 5. Age group: context_id = "CONTEXT_AGE_GROUP" Takes values context_value_id: - CONTEXT_AGE_GROUP_ADULT - Adults, - CONTEXT_AGE_GROUP_MINOR - Children. 6. Maximum number of products in an order: context_id = "CONTEXT_MAX_QUANTITY_PER_RETAIL_ORDER" Takes values context_value_id: - Value of additional feature is set automatically basing on the parameter's value. 7. Maximum number of products in a wholesale order: context_id = "CONTEXT_MAX_QUANTITY_PER_WHOLESALE_ORDER" Takes values context_value_id: - Value of additional feature is set automatically basing on the parameter's value. 8. Minimal number of products in an order: context_id = "CONTEXT_MIN_QUANTITY_PER_RETAIL_ORDER" Takes values context_value_id: - Value of additional feature is set automatically basing on the parameter's value. 9. Minimum number of products in a wholesale order: context_id = "CONTEXT_MIN_QUANTITY_PER_WHOLESALE_ORDER" Takes values context_value_id: - Value of additional feature is set automatically basing on the parameter's value. 10. Maximal number of a single size in an order: context_id = "CONTEXT_MAX_SIZE_QUANTITY_PER_RETAIL_ORDER" Takes values context_value_id: - Value of additional feature is set automatically basing on the parameter's value. 11. Maximal number of a single size in a wholesale order: context_id = "CONTEXT_MAX_SIZE_QUANTITY_PER_WHOLESALE_ORDER" Takes values context_value_id: - Value of additional feature is set automatically basing on the parameter's value. 12. Minimal number of a single size in an order: context_id = "CONTEXT_MIN_SIZE_QUANTITY_PER_RETAIL_ORDER" Takes values context_value_id: - Value of additional feature is set automatically basing on the parameter's value. 13. Minimal number of a single size in a wholesale order: context_id = "CONTEXT_MIN_SIZE_QUANTITY_PER_WHOLESALE_ORDER" Takes values context_value_id: - Value of additional feature is set automatically basing on the parameter's value. 14. Net weight: context_id = "CONTEXT_WEIGHT_NET" Takes values context_value_id: - Value of additional feature is set automatically basing on the parameter's value. 15. Color: context_id = "CONTEXT_COLOR" Takes values context_value_id: - Value of additional feature is set automatically basing on the parameter's value. 16. #!TylkoDlaDoroslych!#: context_id = "CONTEXT_ONLY_ADULTS" Takes values context_value_id: - CONTEXT_ONLY_ADULTS_YES - yes, - CONTEXT_ONLY_ADULTS_NO - no. 17. Prescription drug: context_id = "CONTEXT_PRESCRIPTION_MEDICINE" Takes values context_value_id: - CONTEXT_PRESCRIPTION_MEDICINE_YES - yes, - CONTEXT_PRESCRIPTION_MEDICINE_NO - no. 18. Season Rate: context_id = "CONTEXT_SEASON" Takes values context_value_id: - CONTEXT_SEASON_SPRING - Spring, - CONTEXT_SEASON_SUMMER - Summer, - CONTEXT_SEASON_FALL - Autumn, - CONTEXT_SEASON_WINTER - Winter, - CONTEXT_SEASON_SPRING_SUMMER - Spring/Summer, - CONTEXT_SEASON_FALL_WINTER - Autumn/Winter 19. Risk - signal word: context_id = \"CONTEXT_HAZMAT_SIGNAL\" Takes values context_value_id: - CONTEXT_HAZMAT_SIGNAL_DANGER - danger, - CONTEXT_HAZMAT_SIGNAL_WARNING - warnging, - CONTEXT_HAZMAT_SIGNAL_CAUTION - caution, - CONTEXT_HAZMAT_SIGNAL_NOTICE - notice, 20. Risk - warning pictogram context_id = \"CONTEXT_HAZMAT_PICTOGRAM\" Takes values context_value_id: - GHS01, GHS02, GHS03, GHS04, GHS05, GHS06, GHS07, GHS08, GHS09 21. Risk - type of hazard: context_id = \"CONTEXT_HAZMAT_STATEMENT\" Takes values context_value_id: - H200, H201, H202, H203, H204, H205, H220, H221, H222, H223, H224, H225, H226, H228, H240, H241, H242, H250, H251, H252, H260, H261, H270, H271, H272, H280, H281, H290, H300, H301, H302, H304, H310, H311, H312, H314, H315, H317, H318, H319, H330, H331, H332, H334, H335, H336, H340, H341, H350, H351, H360, H361, H362, H370, H371, H372, H373, H400, H410, H411, H412, H413, EUH 001, EUH 014, EUH 018, EUH 019, EUH 044, EUH 029, EUH 031, EUH 032, EUH 066, EUH 070, EUH 071, EUH 201, EUH 201A, EUH 202, EUH 203, EUH 204, EUH 205, EUH 206, EUH 207, EUH 208, EUH 209, EUH 209A, EUH 210, EUH 401 22. Repair score: context_id = \"CONTEXT_REPAIR_SCORE\" Takes values context_value_id: - The value of the additional feature is set automatically based on the parameter's value 23. Safety - information pictogram: context_id = \"CONTEXT_SAFETY_PICTOGRAM\" Takes values context_value_id: - 1 (Not suitable for small children) - 2 (CE mark) 24. Safety - type of warning: context_id = \"CONTEXT_SAFETY_STATEMENT\" Takes values context_value_id: - 1 (Not suitable for children under 3 years) - 2 (Keep out of the reach of children) - 3 (Product contains a button cell or coin battery) - 4 (Use under the direct supervision of adults) - 5 (Required protective gear. Do not use in public traffic) - 6 (Contains toy. Adult supervision recommended) - 7 (To prevent possible injury from entanglement, remove this toy as soon as the child begins to crawl) - 8 (Use only in shallow water under adult supervision) - 9 (Only use under adult supervision) - 10 (This toy does not provide protection) - 11 (Contains fragrances that may cause allergies) - 12 (For household use only).
2154
2165
  * @property {(context_value_id: String) => PutProductsParametersRequest} context_value_id value of additional feature - Values described in context_id.
2155
2166
  * @property {function} append Append current data to array and start modifying next row
2156
2167
  * @property {function} exec Excecute request
2157
2168
  */
2158
2169
 
2170
+ /**
2171
+ * @typedef {Object} SearchProductsParametersRequest
2172
+ * @property {(ids: Array<Integer>) => SearchProductsParametersRequest} ids List of identifiers
2173
+ * @property {(textIds: Array<Object>) => SearchProductsParametersRequest} textIds Element text ID - can be entered instead of "id".
2174
+ * @property {(languagesIds: Array<String>) => SearchProductsParametersRequest} languagesIds List of languages
2175
+ * @property {(parameterValueIds: Boolean) => SearchProductsParametersRequest} parameterValueIds Whether to return a list of parameter value IDs
2176
+ * @property {(resultsPage: Integer) => SearchProductsParametersRequest} resultsPage Page with results number. Numeration starts from 0
2177
+ * @property {(resultsLimit: Integer) => SearchProductsParametersRequest} resultsLimit Number of results on page. Value from 1 to 100
2178
+ * @property {(page: Integer, limit: Integer) => SearchProductsParametersRequest} page Define page number and maximum results per page
2179
+ * @property {() => Integer} count Returns total numer of results
2180
+ * @property {function} exec Excecute request
2181
+ */
2182
+
2159
2183
  /**
2160
2184
  * @typedef {Object} DeleteProductsRequest
2161
2185
  * @property {(products: Array<Object>) => DeleteProductsRequest} products Products list.
@@ -2165,85 +2189,6 @@
2165
2189
  * @property {function} exec Excecute request
2166
2190
  */
2167
2191
 
2168
- /**
2169
- * @typedef {Object} ListProductsRequest
2170
- * @property {(dispatchSettings: Object) => ListProductsRequest} dispatchSettings
2171
- * @property {(returnProducts: String) => ListProductsRequest} returnProducts Element determines which products should be returned by the gate. Undeleted products are returned by default. Available values: "active" - undeleted products, "deleted" - deleted products. "in_trash" - products in the trash.
2172
- * @property {(returnElements: Array<String>) => ListProductsRequest} returnElements Elements to be returned by the endpoint. By default all elements are returned Available values: * lang_data * adding_time, * deleted, * code, * note, * taxcode, * inwrapper, * sellby_retail, * sellby_wholesale, * producer_id, * producer_name, * iaiCategoryId, * iaiCategoryName, * iaiCategoryPath, * category_id, * category_name, * size_group_id, * modification_time, * currency, * currency_shop, * bestseller, * new_product, * retail_price, * wholesale_price, * minimal_price, * automatic_calculation_price, * pos_price, * strikethrough_retail_price, * strikethrough_wholesale_price, * last_purchase_price, * purchase_price_net_average, * purchase_price_net_last, * purchase_price_gross_average, * purchase_price_gross_last, * vat, * vat_free, * rebate, * hotspots_zones, * profit_points, * points, * weight, * export_to_pricecomparers, * export_to_amazon_marketplace, * enable_in_pos, * complex_notes, * available_profile, * traits, * parameters, * version_data, * advance, * promotion, * discount, * distinguished, * special, * visible, * persistent, * priority, * shops_mask, * icon, * icon_for_auctions, * icon_for_group, * pictures, * unit, * warranty, * series, * products_associated, * shops, * quantities, * sizes_attributes, * shops_attributes, * auction_prices, * price_comparers_prices, * deliverer, * sizes, * size_group_name, * pictures_count, * product_type, * price_changed_time, * quantity_changed_time, * deliverer_name, * available_profile_name, * availability_management_type, * sum_in_basket, * menu, * auction_settings, * bundle, * sizeschart_id, * sizeschart_name, * serialnumbers, * producer_codes_standard, * javaScriptInTheItemCard, * productAuctionDescriptionsData, * priceFormula, * productIndividualDescriptionsData, * productIndividualUrlsData, * productServicesDescriptionsData, * cnTaricCode, * productIsGratis, * dimensions
2173
- * @property {(productIsAvailable: String) => ListProductsRequest} productIsAvailable Product availability. Available values: "y" - available, "n" - unavailable.
2174
- * @property {(productIsVisible: String) => ListProductsRequest} productIsVisible Product visibility in store Available values: "y" - Visible, "n" - Invisible.
2175
- * @property {(productVersionId: Integer) => ListProductsRequest} productVersionId Product group ID
2176
- * @property {(productInPromotion: String) => ListProductsRequest} productInPromotion Promoted product. Available values: "y" - promoted, "n" - not promoted.
2177
- * @property {(productInDiscount: String) => ListProductsRequest} productInDiscount Product on sale. Available values: "y" - on sale, "n" - not on sale.
2178
- * @property {(productInDistinguished: String) => ListProductsRequest} productInDistinguished Distinguished product. Available values: "y" - distinguished, "n" - not distinguished.
2179
- * @property {(productInSpecial: String) => ListProductsRequest} productInSpecial Special product. Available values: "y" - #!specjalny!#, "n" - not special.
2180
- * @property {(productInForPointsSelling: String) => ListProductsRequest} productInForPointsSelling Product available for points. Available values: "y" - Available for points, "n" - Unavailable for points.
2181
- * @property {(productIsObservedByClients: String) => ListProductsRequest} productIsObservedByClients Observed product. Available values: "Y" - observed, "n" - not observed.
2182
- * @property {(skipDefaultProduct: String) => ListProductsRequest} skipDefaultProduct Element determines if default product (with 0 ID, contains settings of newly added products) should be omitted Available values: "y" - omits default product, "n" - allows to download default product.
2183
- * @property {(showPromotionsPrices: String) => ListProductsRequest} showPromotionsPrices The item specifies whether promotional prices are to be shown in price nodes. Available values: "y" - show promotional prices, "n" - do not show promotional prices. (default value)
2184
- * @property {(categories: Array<Object>) => ListProductsRequest} categories List of categories in which sought products are present.
2185
- * @property {(producers: Array<Object>) => ListProductsRequest} producers List of manufacturers assigned to sought products.
2186
- * @property {(productParams: Array<Object>) => ListProductsRequest} productParams List of sought products. This parameter can be used, when there have been no other parameter entered productIndexes.
2187
- * @property {(productIndexes: Array<Object>) => ListProductsRequest} productIndexes List of sought products by indexes.
2188
- * @property {(productShops: Array<Object>) => ListProductsRequest} productShops Data of stores product is assigned to.
2189
- * @property {(productPromotionsIds: Array<Integer>) => ListProductsRequest} productPromotionsIds List of special offers, sought products are assigned to.
2190
- * @property {(productDate: Object) => ListProductsRequest} productDate Settings concerning narrowing list of products found by date.
2191
- * @property {(productParametersParams: Array<Object>) => ListProductsRequest} productParametersParams Parameters
2192
- * @property {(productSeriesParams: Array<Object>) => ListProductsRequest} productSeriesParams Series, sought products are assigned to.
2193
- * @property {(productUnits: Array<Object>) => ListProductsRequest} productUnits List of units of measure assigned to sought products.
2194
- * @property {(productWarranties: Array<Object>) => ListProductsRequest} productWarranties Narrowing list of products by set warranties.
2195
- * @property {(deliverersIds: Array<Integer>) => ListProductsRequest} deliverersIds Suppliers, sought products are assigned to.
2196
- * @property {(containsText: String) => ListProductsRequest} containsText Product contains text (searches in short and long description).
2197
- * @property {(containsCodePart: String) => ListProductsRequest} containsCodePart Product code or it's part (based on producer's code, external product system code and code that is visible on a product card). Search is accesible only with available products.
2198
- * @property {(productAvailableInStocks: Object) => ListProductsRequest} productAvailableInStocks Product availability in stocks
2199
- * @property {(productAvailableInAuctions: Object) => ListProductsRequest} productAvailableInAuctions Product availability on auctions
2200
- * @property {(resultsPage: Integer) => ListProductsRequest} resultsPage Page with results number. Numeration starts from 0
2201
- * @property {(resultsLimit: Integer) => ListProductsRequest} resultsLimit Number of results on page. Value from 1 to 100
2202
- * @property {(ordersBy: Array<Object>) => ListProductsRequest} ordersBy Possibility of sorting returned list
2203
- * @property {(productSearchingLangId: String) => ListProductsRequest} productSearchingLangId Language ID that allows to search and return data in chosen language. This parameter is optional. If it's lacking, she search process unfolds in all available languages.
2204
- * @property {(productSearchingCurrencyId: String) => ListProductsRequest} productSearchingCurrencyId Currency ID allowing to search and browse products in given currency. This parameter is optional, when it's lacking, the search process unfolds in all available currencies.
2205
- * @property {(returnPricesCurrency: String) => ListProductsRequest} returnPricesCurrency Currency ID allowing for returning all product prices in an indicated currency
2206
- * @property {(productHasNote: String) => ListProductsRequest} productHasNote Annotation contains text.
2207
- * @property {(productInExportToPriceComparisonSites: String) => ListProductsRequest} productInExportToPriceComparisonSites Product visibility in export to price comparison and marketplaces. Available values: "y" - Visible, "selected" - Selected, "assign_selected" - Enable the visibility of the product in the export to price comparison sites passed in the priceComparisonSites node. Price comparison sites previously assigned to the commodity will be retained, "unassign_selected" - Disable product visibility in exports to price comparison sites passed in the priceComparisonSites node, "n" - invisible.
2208
- * @property {(productInExportToAmazonMarketplace: String) => ListProductsRequest} productInExportToAmazonMarketplace Visibility of an item in an export to Amazon Marketplace. Available values: "y" - Visible, "selected" - Visible on selected regional services, "n" - invisible.
2209
- * @property {(selectedAmazonMarketplacesList: Array<String>) => ListProductsRequest} selectedAmazonMarketplacesList List of Amazon regional sites to which the product is exported (only in case of "selected" option)
2210
- * @property {(productInBestseller: String) => ListProductsRequest} productInBestseller Product is bestseller. Available values: "n" - no, "y" - yes.
2211
- * @property {(productInNew: String) => ListProductsRequest} productInNew Product is new. Available values: "y" - is new, "n" - is not new.
2212
- * @property {(searchByShops: Object) => ListProductsRequest} searchByShops Shops
2213
- * @property {(productSearchPriceRange: Object) => ListProductsRequest} productSearchPriceRange Price range for sought products.
2214
- * @property {(productVatRates: Array<Number>) => ListProductsRequest} productVatRates VAT value for sought products
2215
- * @property {(productIsVatFree: String) => ListProductsRequest} productIsVatFree Is product VAT-free Allowed values "y" - yes, "n" - no.
2216
- * @property {(productHasWholesalePrice: String) => ListProductsRequest} productHasWholesalePrice Product has defined wholesale price. Available values: "y" - has wholesale price, "n" - does not have wholesale price.
2217
- * @property {(productInPersistent: String) => ListProductsRequest} productInPersistent Product visible even though out of stock Available values: "y" - visible even though out of stock, "n" - not visible when out of stock.
2218
- * @property {(returnProductsVersions: String) => ListProductsRequest} returnProductsVersions Settings of products returned with variants All products with variants are returned by default Available values: version_all - returns all variants, version_main - returns only main variant.
2219
- * @property {(productInSumInBasket: String) => ListProductsRequest} productInSumInBasket Do You wish to sum up the products in the basket as a one order? Available values: "y" - yes, "n" - no.
2220
- * @property {(productType: Object) => ListProductsRequest} productType Product type. Allowed values: "product_item" - Goods, "product_packaging" - packaging, "product_bundle" - set. "product_collection" - collection. "product_service" - service. "product_virtual" - virtual product. "product_configurable" - configurable product.
2221
- * @property {(productMenuItems: Object) => ListProductsRequest} productMenuItems An array of menu elements
2222
- * @property {(productLocationId: Integer) => ListProductsRequest} productLocationId Warehouse location ID
2223
- * @property {(productLocationTextId: String) => ListProductsRequest} productLocationTextId Warehouse location full path Use a backslash (\) as a separator, for example: M1\Section name\Location name If location_id parameter is provided, the full warehouse location path will not be taken into account
2224
- * @property {(alwaysReturnProductShopSizesAttributes: Boolean) => ListProductsRequest} alwaysReturnProductShopSizesAttributes Return all size attributes regardless of whether product prices are the same as the base price or if they differ from it. Available values: 1 - all size attributes will be returned; 0 - only attributes of those sizes, where the prices will be different from the base price (default value) will be returned.
2225
- * @property {(returnEmptyStocksWithReservation: Boolean) => ListProductsRequest} returnEmptyStocksWithReservation Returns reservation information regardless of inventory levels
2226
- * @property {(picturesData: Object) => ListProductsRequest} picturesData Data for operations on individual photos
2227
- * @property {(byMenus: Array<Integer>) => ListProductsRequest} byMenus Define menuItemsIds value nested inside productMenuItems
2228
- * @property {(byShops: Array<Integer>) => ListProductsRequest} byShops Define shopsIds value nested inside searchByShops
2229
- * @property {(dateFrom: DateLike, dateTo: DateLike, dateType: "added"|"finished"|"resumed"|"modified"|"quantity_changed"|"price_changed"|"modified_and_quantity_changed") => ListProductsRequest} dates Type of date according to the index results. Possible type values: added, finished, resumed, modified, quantity_changed, price_changed, modified_and_quantity_changed
2230
- * @property {(elementName: "id"|"name"|"code"|"product_sizecode"|"code_producer"|"retail_price"|"pos_price"|"vat"|"wholesale_price"|"minimal_price"|"pictures_count"|"auction_name"|"pricecomparer_name"|"version_name"|"series_name"|"category_name"|"deliverer_name"|"adding_time"|"modification_time"|"price_changed_time"|"quantity_changed_time"|"currency"|"currency_shop"|"taxcode"|"meta_title"|"meta_description"|"meta_keywords"|"suggested_price"|"observed_clients"|"observed_time"|"wishes_clients"|"wishes_time", descending: Boolean) => ListProductsRequest} orderBy Define sorting by element and direction
2231
- * @property {(shops: Array<Integer>) => ListProductsRequest} shops Define productShops by passing array of values
2232
- * @property {(ids: Array<Integer>) => ListProductsRequest} ids Define productParams by passing array of values
2233
- * @property {(byProducers: Array<Integer>) => ListProductsRequest} byProducers Define producers by passing array of values
2234
- * @property {(byCategories: Array<Integer>) => ListProductsRequest} byCategories Define categories by passing array of values
2235
- * @property {(byUnits: Array<Integer>) => ListProductsRequest} byUnits Define productUnits by passing array of values
2236
- * @property {(bySeries: Array<Integer>) => ListProductsRequest} bySeries Define productSeriesParams by passing array of values
2237
- * @property {(byWarranties: Array<Integer>) => ListProductsRequest} byWarranties Define productWarranties by passing array of values
2238
- * @property {(byIndexes: Array<Integer>) => ListProductsRequest} byIndexes Define productIndexes by passing array of values
2239
- * @property {(onlyMain: Boolean) => ListProductsRequest} onlyMainVersion Toogle to return only main versions
2240
- * @property {(minPrice: Number, maxPrice: Number, priceType: "retail_price"|"wholesale_price"|"minimal_price"|"pos_price"|"last_purchase_price") => ListProductsRequest} byPrice Filter by minimum and maximym price
2241
- * @property {(stockIds: Boolean|Array<Integer>) => ListProductsRequest} inStock Filter by availibility on any stock or selected stocks
2242
- * @property {(page: Integer, limit: Integer) => ListProductsRequest} page Define page number and maximum results per page
2243
- * @property {() => Integer} count Returns total numer of results
2244
- * @property {function} exec Excecute request
2245
- */
2246
-
2247
2192
  /**
2248
2193
  * @typedef {Object} GetProductsRequest
2249
2194
  * @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.
@@ -2331,6 +2276,8 @@
2331
2276
  * @property {(standardUnit: Object) => PostProductsRequest} standardUnit Standard unit settings
2332
2277
  * @property {(minQuantityPerOrder: Object) => PostProductsRequest} minQuantityPerOrder Minimal number of products in an order
2333
2278
  * @property {(productDimensions: Object) => PostProductsRequest} productDimensions Dimensions and overall weight
2279
+ * @property {(responsibleProducerCode: String) => PostProductsRequest} responsibleProducerCode Responsible producer code
2280
+ * @property {(responsiblePersonCode: String) => PostProductsRequest} responsiblePersonCode Responsible person code
2334
2281
  * @property {function} append Append current data to array and start modifying next row
2335
2282
  * @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
2336
2283
  * @property {(value: Float, type: 'retail'|'wholesale'|'pos'|'minimal'|'strikethroughRetail'|'strikethroughWholesale'|'suggested'|'automaticCalculation') => PostProductsRequest} addPrice Increases product price by amount
@@ -2472,6 +2419,8 @@
2472
2419
  * @property {(dynamicPricingEnabled: String) => PutProductsRequest} dynamicPricingEnabled
2473
2420
  * @property {(clearStockQuantities: Object) => PutProductsRequest} clearStockQuantities The setting allows you to reset the inventory to zero
2474
2421
  * @property {(productDimensions: Object) => PutProductsRequest} productDimensions Dimensions and overall weight
2422
+ * @property {(responsibleProducerCode: String) => PutProductsRequest} responsibleProducerCode Responsible producer code
2423
+ * @property {(responsiblePersonCode: String) => PutProductsRequest} responsiblePersonCode Responsible person code
2475
2424
  * @property {function} append Append current data to array and start modifying next row
2476
2425
  * @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
2477
2426
  * @property {() => PutProductsRequest} editMode Set edit mode - disables adding new product
@@ -2483,6 +2432,87 @@
2483
2432
  * @property {function} exec Excecute request
2484
2433
  */
2485
2434
 
2435
+ /**
2436
+ * @typedef {Object} SearchProductsRequest
2437
+ * @property {(dispatchSettings: Object) => SearchProductsRequest} dispatchSettings
2438
+ * @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.
2439
+ * @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
2440
+ * @property {(productIsAvailable: String) => SearchProductsRequest} productIsAvailable Product availability. Available values: "y" - available, "n" - unavailable.
2441
+ * @property {(productIsVisible: String) => SearchProductsRequest} productIsVisible Product visibility in store Available values: "y" - Visible, "n" - Invisible.
2442
+ * @property {(productVersionId: Integer) => SearchProductsRequest} productVersionId Product group ID
2443
+ * @property {(productInPromotion: String) => SearchProductsRequest} productInPromotion Promoted product. Available values: "y" - promoted, "n" - not promoted.
2444
+ * @property {(productInDiscount: String) => SearchProductsRequest} productInDiscount Product on sale. Available values: "y" - on sale, "n" - not on sale.
2445
+ * @property {(productInDistinguished: String) => SearchProductsRequest} productInDistinguished Distinguished product. Available values: "y" - distinguished, "n" - not distinguished.
2446
+ * @property {(productInSpecial: String) => SearchProductsRequest} productInSpecial Special product. Available values: "y" - #!specjalny!#, "n" - not special.
2447
+ * @property {(productInForPointsSelling: String) => SearchProductsRequest} productInForPointsSelling Product available for points. Available values: "y" - Available for points, "n" - Unavailable for points.
2448
+ * @property {(productIsObservedByClients: String) => SearchProductsRequest} productIsObservedByClients Observed product. Available values: "Y" - observed, "n" - not observed.
2449
+ * @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.
2450
+ * @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)
2451
+ * @property {(categories: Array<Object>) => SearchProductsRequest} categories List of categories in which sought products are present.
2452
+ * @property {(producers: Array<Object>) => SearchProductsRequest} producers List of manufacturers assigned to sought products.
2453
+ * @property {(productParams: Array<Object>) => SearchProductsRequest} productParams List of sought products. This parameter can be used, when there have been no other parameter entered productIndexes.
2454
+ * @property {(productIndexes: Array<Object>) => SearchProductsRequest} productIndexes List of sought products by indexes.
2455
+ * @property {(productShops: Array<Object>) => SearchProductsRequest} productShops Data of stores product is assigned to.
2456
+ * @property {(productPromotionsIds: Array<Integer>) => SearchProductsRequest} productPromotionsIds List of special offers, sought products are assigned to.
2457
+ * @property {(productDate: Object) => SearchProductsRequest} productDate Settings concerning narrowing list of products found by date.
2458
+ * @property {(productParametersParams: Array<Object>) => SearchProductsRequest} productParametersParams Parameters
2459
+ * @property {(productSeriesParams: Array<Object>) => SearchProductsRequest} productSeriesParams Series, sought products are assigned to.
2460
+ * @property {(productUnits: Array<Object>) => SearchProductsRequest} productUnits List of units of measure assigned to sought products.
2461
+ * @property {(productWarranties: Array<Object>) => SearchProductsRequest} productWarranties Narrowing list of products by set warranties.
2462
+ * @property {(deliverersIds: Array<Integer>) => SearchProductsRequest} deliverersIds Suppliers, sought products are assigned to.
2463
+ * @property {(containsText: String) => SearchProductsRequest} containsText Product contains text (searches in short and long description).
2464
+ * @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.
2465
+ * @property {(productAvailableInStocks: Object) => SearchProductsRequest} productAvailableInStocks Product availability in stocks
2466
+ * @property {(productAvailableInAuctions: Object) => SearchProductsRequest} productAvailableInAuctions Product availability on auctions
2467
+ * @property {(resultsPage: Integer) => SearchProductsRequest} resultsPage Page with results number. Numeration starts from 0
2468
+ * @property {(resultsLimit: Integer) => SearchProductsRequest} resultsLimit Number of results on page. Value from 1 to 100
2469
+ * @property {(ordersBy: Array<Object>) => SearchProductsRequest} ordersBy Possibility of sorting returned list
2470
+ * @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.
2471
+ * @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.
2472
+ * @property {(returnPricesCurrency: String) => SearchProductsRequest} returnPricesCurrency Currency ID allowing for returning all product prices in an indicated currency
2473
+ * @property {(productHasNote: String) => SearchProductsRequest} productHasNote Annotation contains text.
2474
+ * @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.
2475
+ * @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.
2476
+ * @property {(selectedAmazonMarketplacesList: Array<String>) => SearchProductsRequest} selectedAmazonMarketplacesList List of Amazon regional sites to which the product is exported (only in case of "selected" option)
2477
+ * @property {(productInBestseller: String) => SearchProductsRequest} productInBestseller Product is bestseller. Available values: "n" - no, "y" - yes.
2478
+ * @property {(productInNew: String) => SearchProductsRequest} productInNew Product is new. Available values: "y" - is new, "n" - is not new.
2479
+ * @property {(searchByShops: Object) => SearchProductsRequest} searchByShops Shops
2480
+ * @property {(productSearchPriceRange: Object) => SearchProductsRequest} productSearchPriceRange Price range for sought products.
2481
+ * @property {(productVatRates: Array<Number>) => SearchProductsRequest} productVatRates VAT value for sought products
2482
+ * @property {(productIsVatFree: String) => SearchProductsRequest} productIsVatFree Is product VAT-free Allowed values "y" - yes, "n" - no.
2483
+ * @property {(productHasWholesalePrice: String) => SearchProductsRequest} productHasWholesalePrice Product has defined wholesale price. Available values: "y" - has wholesale price, "n" - does not have wholesale price.
2484
+ * @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.
2485
+ * @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.
2486
+ * @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.
2487
+ * @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.
2488
+ * @property {(productMenuItems: Object) => SearchProductsRequest} productMenuItems An array of menu elements
2489
+ * @property {(productLocationId: Integer) => SearchProductsRequest} productLocationId Warehouse location ID
2490
+ * @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
2491
+ * @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.
2492
+ * @property {(returnEmptyStocksWithReservation: Boolean) => SearchProductsRequest} returnEmptyStocksWithReservation Returns reservation information regardless of inventory levels
2493
+ * @property {(picturesData: Object) => SearchProductsRequest} picturesData Data for operations on individual photos
2494
+ * @property {(responsibleProducerCode: String) => SearchProductsRequest} responsibleProducerCode Responsible producer code
2495
+ * @property {(responsiblePersonCode: String) => SearchProductsRequest} responsiblePersonCode Responsible person code
2496
+ * @property {(byMenus: Array<Integer>) => SearchProductsRequest} byMenus Define menuItemsIds value nested inside productMenuItems
2497
+ * @property {(byShops: Array<Integer>) => SearchProductsRequest} byShops Define shopsIds value nested inside searchByShops
2498
+ * @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
2499
+ * @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
2500
+ * @property {(shops: Array<Integer>) => SearchProductsRequest} shops Define productShops by passing array of values
2501
+ * @property {(ids: Array<Integer>) => SearchProductsRequest} ids Define productParams by passing array of values
2502
+ * @property {(byProducers: Array<Integer>) => SearchProductsRequest} byProducers Define producers by passing array of values
2503
+ * @property {(byCategories: Array<Integer>) => SearchProductsRequest} byCategories Define categories by passing array of values
2504
+ * @property {(byUnits: Array<Integer>) => SearchProductsRequest} byUnits Define productUnits by passing array of values
2505
+ * @property {(bySeries: Array<Integer>) => SearchProductsRequest} bySeries Define productSeriesParams by passing array of values
2506
+ * @property {(byWarranties: Array<Integer>) => SearchProductsRequest} byWarranties Define productWarranties by passing array of values
2507
+ * @property {(byIndexes: Array<Integer>) => SearchProductsRequest} byIndexes Define productIndexes by passing array of values
2508
+ * @property {(onlyMain: Boolean) => searchProductsRequest} onlyMainVersion Toogle to return only main versions
2509
+ * @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
2510
+ * @property {(stockIds: Boolean|Array<Integer>) => searchProductsRequest} inStock Filter by availibility on any stock or selected stocks
2511
+ * @property {(page: Integer, limit: Integer) => SearchProductsRequest} page Define page number and maximum results per page
2512
+ * @property {() => Integer} count Returns total numer of results
2513
+ * @property {function} exec Excecute request
2514
+ */
2515
+
2486
2516
  /**
2487
2517
  * @typedef {Object} DeleteProductsProductsToFacebookCatalogRequest
2488
2518
  * @property {(facebookCatalogId: Integer) => DeleteProductsProductsToFacebookCatalogRequest} facebookCatalogId You can read the Facebook Catalog ID in the Marketing & Integrations/Facebook/Facebook Product Catalog admin panel
@@ -2550,10 +2580,9 @@
2550
2580
 
2551
2581
  /**
2552
2582
  * @typedef {Object} GetProductsReservationsRequest
2553
- * @property {(productsIdents: Array<Object>) => GetProductsReservationsRequest} productsIdents Products list.
2554
- * @property {(ids: Array<Integer>) => GetProductsReservationsRequest} ids Define productsIdents by passing array of values
2555
- * @property {(externalCodes: Array<String>) => GetProductsReservationsRequest} externalCodes Define productsIdents by passing array of values
2556
- * @property {(producerCodes: Array<String>) => GetProductsReservationsRequest} producerCodes Define productsIdents by passing array of values
2583
+ * @property {(identType: 'id'|'index'|'codeExtern'|'codeProducer') => GetProductsReservationsRequest} identType
2584
+ * @property {(products: Array<String>) => GetProductsReservationsRequest} products Products list.
2585
+ * @property {(productId: Integer|Array<Integer> type: 'id'|'index'|'codeExtern'|'codeProducer') => GetProductsStrikethroughPricesRequest} productId Set product identifiers
2557
2586
  * @property {function} exec Excecute request
2558
2587
  */
2559
2588
 
@@ -2660,10 +2689,9 @@
2660
2689
 
2661
2690
  /**
2662
2691
  * @typedef {Object} GetProductsStocksRequest
2663
- * @property {(products: Array<Object>) => GetProductsStocksRequest} products Products list.
2664
- * @property {(ids: Array<Integer>) => GetProductsStocksRequest} ids Define products by passing array of values
2665
- * @property {(externalCodes: Array<String>) => GetProductsStocksRequest} externalCodes Define products by passing array of values
2666
- * @property {(producerCodes: Array<String>) => GetProductsStocksRequest} producerCodes Define products by passing array of values
2692
+ * @property {(identType: 'id'|'index'|'codeExtern'|'codeProducer') => GetProductsStocksRequest} identType
2693
+ * @property {(products: Array<String>) => GetProductsStocksRequest} products Products list.
2694
+ * @property {(productId: Integer|Array<Integer> type: 'id'|'index'|'codeExtern'|'codeProducer') => GetProductsStrikethroughPricesRequest} productId Set product identifiers
2667
2695
  * @property {function} exec Excecute request
2668
2696
  */
2669
2697
 
@@ -2680,19 +2708,15 @@
2680
2708
 
2681
2709
  /**
2682
2710
  * @typedef {Object} GetProductsStrikethroughPricesRequest
2683
- * @property {(products: Array<Object>) => GetProductsStrikethroughPricesRequest} products Products list.
2684
- * @property {(productId: Integer, sizeId: Integer|String, type: 'id'|'index'|'codeExtern'|'codeProducer') => GetProductsStrikethroughPricesRequest} productId Set product and size identifiers
2711
+ * @property {(identType: 'id'|'index'|'codeExtern'|'codeProducer') => GetProductsStrikethroughPricesRequest} identType
2712
+ * @property {(products: Array<String>) => GetProductsStrikethroughPricesRequest} products Products list.
2713
+ * @property {(productId: Integer|Array<Integer> type: 'id'|'index'|'codeExtern'|'codeProducer') => GetProductsStrikethroughPricesRequest} productId Set product identifiers
2685
2714
  * @property {function} exec Excecute request
2686
2715
  */
2687
2716
 
2688
2717
  /**
2689
2718
  * @typedef {Object} PutProductsStrikethroughPricesRequest
2690
2719
  * @property {(products: Array<Object>) => PutProductsStrikethroughPricesRequest} products Products list.
2691
- * @property {(ident: Object) => PutProductsStrikethroughPricesRequest} ident Identifier type.
2692
- * @property {(sizes: Array<Object>) => PutProductsStrikethroughPricesRequest} sizes List of sizes
2693
- * @property {(stp_settings: Object) => PutProductsStrikethroughPricesRequest} stp_settings
2694
- * @property {(shops: Array<Object>) => PutProductsStrikethroughPricesRequest} shops Strikethrough price settings for the page.
2695
- * @property {function} append Append current data to array and start modifying next row
2696
2720
  * @property {function} exec Excecute request
2697
2721
  */
2698
2722
 
@@ -2811,6 +2835,62 @@
2811
2835
  * @property {function} exec Excecute request
2812
2836
  */
2813
2837
 
2838
+ /**
2839
+ * @typedef {Object} GetResponsibilityEntitiesRequest
2840
+ * @property {(code: Array<String>) => GetResponsibilityEntitiesRequest} code List of codes
2841
+ * @property {(type: String) => GetResponsibilityEntitiesRequest} type Type of entity
2842
+ * @property {(resultsPage: Integer) => GetResponsibilityEntitiesRequest} resultsPage Page with results number. Numeration starts from 0
2843
+ * @property {(resultsLimit: Integer) => GetResponsibilityEntitiesRequest} resultsLimit Number of results on page. Value from 1 to 100
2844
+ * @property {function} exec Excecute request
2845
+ */
2846
+
2847
+ /**
2848
+ * @typedef {Object} PostResponsibilityEntitiesRequest
2849
+ * @property {(entities: Array<Object>) => PostResponsibilityEntitiesRequest} entities
2850
+ * @property {(type: 'producer'|'person') => PostResponsibilityEntitiesRequest} type Type of entity
2851
+ * @property {(id: Integer) => PostResponsibilityEntitiesRequest} id Identificator of the entity.
2852
+ * @property {(code: String) => PostResponsibilityEntitiesRequest} code Short name/code.
2853
+ * @property {(name: String) => PostResponsibilityEntitiesRequest} name Full name.
2854
+ * @property {(mail: String) => PostResponsibilityEntitiesRequest} mail E-mail address.
2855
+ * @property {(street: String) => PostResponsibilityEntitiesRequest} street Street.
2856
+ * @property {(number: String) => PostResponsibilityEntitiesRequest} number Building number.
2857
+ * @property {(subnumber: String) => PostResponsibilityEntitiesRequest} subnumber Apartment number.
2858
+ * @property {(zipcode: String) => PostResponsibilityEntitiesRequest} zipcode Zipcode.
2859
+ * @property {(city: String) => PostResponsibilityEntitiesRequest} city City.
2860
+ * @property {(country: String) => PostResponsibilityEntitiesRequest} country 2-letter ISO country code.
2861
+ * @property {(phone: String) => PostResponsibilityEntitiesRequest} phone Phone number.
2862
+ * @property {(description: String) => PostResponsibilityEntitiesRequest} description Additional description.
2863
+ * @property {function} append Append current data to array and start modifying next row
2864
+ * @property {function} exec Excecute request
2865
+ */
2866
+
2867
+ /**
2868
+ * @typedef {Object} PutResponsibilityEntitiesRequest
2869
+ * @property {(entities: Array<Object>) => PutResponsibilityEntitiesRequest} entities
2870
+ * @property {(type: 'producer'|'person') => PutResponsibilityEntitiesRequest} type Type of entity
2871
+ * @property {(id: Integer) => PutResponsibilityEntitiesRequest} id Identificator of the entity.
2872
+ * @property {(code: String) => PutResponsibilityEntitiesRequest} code Short name/code.
2873
+ * @property {(name: String) => PutResponsibilityEntitiesRequest} name Full name.
2874
+ * @property {(mail: String) => PutResponsibilityEntitiesRequest} mail E-mail address.
2875
+ * @property {(street: String) => PutResponsibilityEntitiesRequest} street Street.
2876
+ * @property {(number: String) => PutResponsibilityEntitiesRequest} number Building number.
2877
+ * @property {(subnumber: String) => PutResponsibilityEntitiesRequest} subnumber Apartment number.
2878
+ * @property {(zipcode: String) => PutResponsibilityEntitiesRequest} zipcode Zipcode.
2879
+ * @property {(city: String) => PutResponsibilityEntitiesRequest} city City.
2880
+ * @property {(country: String) => PutResponsibilityEntitiesRequest} country 2-letter ISO country code.
2881
+ * @property {(phone: String) => PutResponsibilityEntitiesRequest} phone Phone number.
2882
+ * @property {(description: String) => PutResponsibilityEntitiesRequest} description Additional description.
2883
+ * @property {function} append Append current data to array and start modifying next row
2884
+ * @property {function} exec Excecute request
2885
+ */
2886
+
2887
+ /**
2888
+ * @typedef {Object} DeleteResponsibilityEntitiesRequest
2889
+ * @property {(code: Array<String>) => DeleteResponsibilityEntitiesRequest} code List of codes
2890
+ * @property {(type: String) => DeleteResponsibilityEntitiesRequest} type Type of entity
2891
+ * @property {function} exec Excecute request
2892
+ */
2893
+
2814
2894
  /**
2815
2895
  * @typedef {Object} GetReturnsRequest
2816
2896
  * @property {(order_sn: Integer) => GetReturnsRequest} order_sn Search by the order serial number to which a return was added.
@@ -2856,8 +2936,13 @@
2856
2936
  /**
2857
2937
  * @typedef {Object} PutReturnsRequest
2858
2938
  * @property {(returns: Array<Object>) => PutReturnsRequest} returns
2859
- * @property {(id: Integer) => PutReturnsRequest} id Returns ID.
2860
- * @property {(api_flag: Object) => PutReturnsRequest} api_flag
2939
+ * @property {(id: Integer) => PutReturnsRequest} id
2940
+ * @property {(status: Integer) => PutReturnsRequest} status
2941
+ * @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.
2942
+ * @property {(products: Array<Object>) => PutReturnsRequest} products Products list.
2943
+ * @property {(userNote: String) => PutReturnsRequest} userNote
2944
+ * @property {(clientNote: String) => PutReturnsRequest} clientNote Notes from customer.
2945
+ * @property {(tryCorrectInvoice: Boolean) => PutReturnsRequest} tryCorrectInvoice
2861
2946
  * @property {function} append Append current data to array and start modifying next row
2862
2947
  * @property {function} exec Excecute request
2863
2948
  */
@@ -2912,6 +2997,16 @@
2912
2997
  * @property {function} exec Excecute request
2913
2998
  */
2914
2999
 
3000
+ /**
3001
+ * @typedef {Object} GetShopsCurrenciesRequest
3002
+ * @property {function} exec Excecute request
3003
+ */
3004
+
3005
+ /**
3006
+ * @typedef {Object} GetShopsLanguagesRequest
3007
+ * @property {function} exec Excecute request
3008
+ */
3009
+
2915
3010
  /**
2916
3011
  * @typedef {Object} DeleteSizechartsRequest
2917
3012
  * @property {(ids: Array<Integer>) => DeleteSizechartsRequest} ids #!identyfikatory!#
@@ -3486,7 +3581,7 @@
3486
3581
  * @property {GetClientsRequest} getClients Method that enables extracting customer account details.
3487
3582
  * @property {PostClientsRequest} postClients Method that enables adding new customer accounts to the IdoSell Shop administration panel.
3488
3583
  * @property {PutClientsRequest} putClients Method enables modifying existing customer account data.
3489
- * @property {GetClientsCrmRequest} getClientsCrm The method allows to download information about customers from the CRM module assigned to stores to which the user has rights.
3584
+ * @property {SearchClientsCrmRequest} searchClientsCrm The method allows to download information about customers from the CRM module assigned to stores to which the user has rights.
3490
3585
  * @property {DeleteClientsDeliveryAddressRequest} deleteClientsDeliveryAddress The method allows you to delete unused delivery addresses for customer accounts in the IdoSell Shop administration panel
3491
3586
  * @property {GetClientsDeliveryAddressRequest} getClientsDeliveryAddress Method that enables extracting information about delivery addresses assigned to existing customer accounts.
3492
3587
  * @property {PostClientsDeliveryAddressRequest} postClientsDeliveryAddress Method that enables adding delivery address details to existing customer accounts.
@@ -3494,15 +3589,15 @@
3494
3589
  * @property {PutClientsExternalCodeRequest} putClientsExternalCode Method that enables setting external system codes for existing customer accounts.
3495
3590
  * @property {PutClientsGiftcardsBlockRequest} putClientsGiftcardsBlock Enables gift card blocking
3496
3591
  * @property {DeleteClientsGiftcardsRequest} deleteClientsGiftcards Enables deleting a single or a list of gift cards
3497
- * @property {GetClientsGiftcardsRequest} getClientsGiftcards Enables searching for gift cards and retrieving information about indicated gift cards
3498
3592
  * @property {PostClientsGiftcardsRequest} postClientsGiftcards Enables adding new gift cards with the selected card type
3499
3593
  * @property {PutClientsGiftcardsRequest} putClientsGiftcards Enables editing gift parameters, e.g. changing its balance, validity date, number or PIN
3594
+ * @property {SearchClientsGiftcardsRequest} searchClientsGiftcards Enables searching for gift cards and retrieving information about indicated gift cards
3500
3595
  * @property {GetClientsGiftcardsTypesRequest} getClientsGiftcardsTypes Allows for downloading all types of gift cards defined in the administration panel
3501
3596
  * @property {PutClientsGiftcardsUnblockRequest} putClientsGiftcardsUnblock Enables gift card unblocking
3502
3597
  * @property {GetClientsMembershipCardsRequest} getClientsMembershipCards Method that enables extracting information about loyalty cards available in the administration panel.
3503
3598
  * @property {PutClientsMembershipCardsRequest} putClientsMembershipCards Method that enables assigning loyalty cards to customer accounts.
3504
- * @property {GetClientsNewsletterEmailSMSRequest} getClientsNewsletterEmailSMS Method that enables extracting a list of customer accounts that agreed / did not agree to receiving text message newsletters.
3505
- * @property {GetClientsNewsletterEmailShopsRequest} getClientsNewsletterEmailShops Method that enables extracting a list of customer accounts that agreed / did not agree to receiving email newsletters.
3599
+ * @property {SearchClientsNewsletterEmailRequest} searchClientsNewsletterEmail Method that enables extracting a list of customer accounts that agreed / did not agree to receiving email newsletters.
3600
+ * @property {SearchClientsNewsletterSmsRequest} searchClientsNewsletterSms Method that enables extracting a list of customer accounts that agreed / did not agree to receiving text message newsletters.
3506
3601
  * @property {DeleteClientsPayerAddressRequest} deleteClientsPayerAddress The method allows you to delete unused buyer addresses for customer accounts in the IdoSell Shop administration panel
3507
3602
  * @property {GetClientsPayerAddressRequest} getClientsPayerAddress The method allows to retrieve buyer's addresses from sales documents, for existing customer accounts in the IdoSell administration panel.
3508
3603
  * @property {PostClientsPayerAddressRequest} postClientsPayerAddress The method allows to add buyer's addresses to sales documents, for existing customer accounts in the IdoSell administration panel.
@@ -3523,6 +3618,7 @@
3523
3618
  * @property {GetClientsProfitPointsRequest} getClientsProfitPoints Method that enables extracting information about the amount of loyalty points collected by customers in a loyalty program.
3524
3619
  * @property {PostClientsProfitPointsRequest} postClientsProfitPoints Method that allows for adding loyalty points to the balances of existing customer accounts.
3525
3620
  * @property {GetClientsProvinceListRequest} getClientsProvinceList The method allows to retrieve the list of administrative regions available in the IdoSell administration panel.
3621
+ * @property {DeleteClientsRequest} deleteClients This call is used to remove client's personal data and blocks the account.
3526
3622
  * @property {DeleteClientsTagsClearRequest} deleteClientsTagsClear Use this method to delete all tags assigned to a customer
3527
3623
  * @property {DeleteClientsTagsRequest} deleteClientsTags Use this method to delete selected tags assigned to a customer
3528
3624
  * @property {GetClientsTagsRequest} getClientsTags Use this method to retrieve all tags assigned to a client
@@ -3594,12 +3690,12 @@
3594
3690
  * @property {GetOrdersImagesRequest} getOrdersImages Method allows downloading image attachment data from the details of the specified order.
3595
3691
  * @property {PostOrdersImagesRequest} postOrdersImages Method allows to add image attachments to the details of the specified order.
3596
3692
  * @property {GetOrdersLabelsRequest} getOrdersLabels The method is used to generate parcels and printouts for a courier.
3597
- * @property {GetOrdersOpinionsRequest} getOrdersOpinions The method allows for downloading information about reviews issued for orders available in the IdoSell Shop administration panel.
3693
+ * @property {SearchOrdersOpinionsRequest} searchOrdersOpinions The method allows for downloading information about reviews issued for orders available in the IdoSell Shop administration panel.
3598
3694
  * @property {GetOrdersOpinionsRateRequest} getOrdersOpinionsRate Evaluation of the usefulness of opinions issued for orders.
3599
- * @property {ListOrdersRequest} listOrders Method that enables extracting information about orders present in the IdoSell Shop administration panel.
3600
3695
  * @property {GetOrdersRequest} getOrders Method that enables extracting information about orders present in the IdoSell Shop administration panel.
3601
3696
  * @property {PostOrdersRequest} postOrders Method that is used for adding new retail or wholesale orders to a shop in the administration panel.
3602
3697
  * @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.
3698
+ * @property {SearchOrdersRequest} searchOrders Method that enables extracting information about orders present in the IdoSell Shop administration panel.
3603
3699
  * @property {GetOrdersPackagesRequest} getOrdersPackages Method that enables getting a list of parcels assigned to an order.
3604
3700
  * @property {PostOrdersPackagesRequest} postOrdersPackages Method that enables editing parcels already assigned to an order.
3605
3701
  * @property {PutOrdersPackagesRequest} putOrdersPackages Method that enables editing parcels already assigned to an order.
@@ -3609,14 +3705,14 @@
3609
3705
  * @property {PutOrdersProfitMarginRequest} putOrdersProfitMargin Method that enables setting price margins for products in an order.
3610
3706
  * @property {GetOrdersProfitabilityRequest} getOrdersProfitability The method is used to retrieve information about the profitability of an order
3611
3707
  * @property {PutOrdersShippingCostsRequest} putOrdersShippingCosts Method that enables editing the delivery costs for an order in the administration panel.
3612
- * @property {ListOrdersUnfinishedRequest} listOrdersUnfinished It allows you to download information about unclosed orders located in the store's administration panel. Orders with a status of false and lost are considered closed. Orders with a status of false and lost are considered closed.
3708
+ * @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.
3613
3709
  * @property {GetOrdersWarehouseRequest} getOrdersWarehouse Method that enables getting information about which warehouse an order is being handled from.
3614
3710
  * @property {PutOrdersWarehouseRequest} putOrdersWarehouse Method that enables setting which warehouse an order is handled from.
3615
3711
  * @property {GetPackagesLabelsRequest} getPackagesLabels The method allows you to download labels for the courier from orders, complaints and returns.
3616
3712
  * @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.
3617
- * @property {GetPackagesRequest} getPackages Method that enables getting a list of parcels assigned to an order.
3618
3713
  * @property {PostPackagesRequest} postPackages Method that enables adding parcels to an order.
3619
3714
  * @property {PutPackagesRequest} putPackages Method that enables editing parcels already assigned to an order.
3715
+ * @property {SearchPackagesRequest} searchPackages Method that enables getting a list of parcels assigned to an order.
3620
3716
  * @property {PostPaymentsCancelRequest} postPaymentsCancel Method that enables cancelling payments for orders in the administration panel.
3621
3717
  * @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..
3622
3718
  * @property {PutPaymentsConfirmRequest} putPaymentsConfirm Method that enables accepting payments for orders in the administration panel.
@@ -3642,14 +3738,14 @@
3642
3738
  * @property {PutProductsBundlesRenewRequest} putProductsBundlesRenew the renewProductsInBundle method allows you to rebuild components of Sets existing in the administration panel
3643
3739
  * @property {GetProductsCategoriesRequest} getProductsCategories Method that returns information about categories configured in the administration panel.
3644
3740
  * @property {PutProductsCategoriesRequest} putProductsCategories Method that enables adding new categories to the administration panel as well editing and deleting of existing categories.
3645
- * @property {GetProductsCategoriesIdosellRequest} getProductsCategoriesIdosell Method returns information about IdoSell Categories available in store.
3741
+ * @property {SearchProductsCategoriesIdosellRequest} searchProductsCategoriesIdosell Method returns information about IdoSell Categories available in store.
3646
3742
  * @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.
3647
3743
  * @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
3648
3744
  * @property {DeleteProductsCollectionsProductsRequest} deleteProductsCollectionsProducts removeProductsFromCollection method allows to remove indicated collection components
3649
3745
  * @property {PostProductsCollectionsProductsRequest} postProductsCollectionsProducts addProductsToCollection method allows to add components to existing collections in the administration panel
3650
3746
  * @property {PutProductsCollectionsProductsRequest} putProductsCollectionsProducts setProductsQuantityInCollection method allows to indicate quantity of a collection component
3651
3747
  * @property {PutProductsCollectionsRenewRequest} putProductsCollectionsRenew the renewProductsInCollection method allows you to rebuild existing components of Collections in the administration panel
3652
- * @property {GetProductsDeliveryTimeRequest} getProductsDeliveryTime The method returns the time needed to prepare the product for shipment
3748
+ * @property {SearchProductsDeliveryTimeRequest} searchProductsDeliveryTime The method returns the time needed to prepare the product for shipment
3653
3749
  * @property {GetProductsDescriptionsRequest} getProductsDescriptions Method that returns text elements for a given product, e.g. product name, long and short description, metadata.
3654
3750
  * @property {PutProductsDescriptionsRequest} putProductsDescriptions The method allows for setting text elements for a given product, e.g. product name, long and short description, metadata.
3655
3751
  * @property {PutProductsGroupsMainProductRequest} putProductsGroupsMainProduct The method allows you to change the main product in a group of products.
@@ -3659,7 +3755,7 @@
3659
3755
  * @property {DeleteProductsImagesRequest} deleteProductsImages This method is used to delete images of products
3660
3756
  * @property {PutProductsImagesRequest} putProductsImages Method used for adding and editing product pictures.
3661
3757
  * @property {GetProductsMarketingAllFacebookCatalogIdsRequest} getProductsMarketingAllFacebookCatalogIds The method allows you to download available Facebook catalogs in a given store.
3662
- * @property {GetProductsMarketingPromotionRequest} getProductsMarketingPromotion The method allows to download a list of active special offers for the given store.
3758
+ * @property {GetProductsMarketingPromotionRequest} getProductsMarketingPromotion The method allows to download a list of active promotions for the given store.
3663
3759
  * @property {PostProductsMarketingPromotionRequest} postProductsMarketingPromotion The method allows you to add promotions from a new module with elements.
3664
3760
  * @property {PutProductsMarketingPromotionRequest} putProductsMarketingPromotion The method allows you to edit the promotion from the new module with the elements.
3665
3761
  * @property {GetProductsMarketingZonesRequest} getProductsMarketingZones Allows for getting information about products assigned to marketing hot spots
@@ -3672,13 +3768,13 @@
3672
3768
  * @property {PutProductsOpinionsRequest} putProductsOpinions The method allows to edit opinions about goods available in the IdoSell Shop administration panel.
3673
3769
  * @property {GetProductsOpinionsRateRequest} getProductsOpinionsRate Evaluation of the usefulness of opinions issued for products.
3674
3770
  * @property {DeleteProductsParametersRequest} deleteProductsParameters The method allows you to delete parameters and their values (for parameters that are not pinned to any product)..
3675
- * @property {GetProductsParametersRequest} getProductsParameters Method that enables adding and editing of sections and parameters, modifying their values and setting their order.
3676
3771
  * @property {PutProductsParametersRequest} putProductsParameters Method that enables adding and editing of sections and parameters, modifying their values and setting their order.
3772
+ * @property {SearchProductsParametersRequest} searchProductsParameters Method that enables adding and editing of sections and parameters, modifying their values and setting their order.
3677
3773
  * @property {DeleteProductsRequest} deleteProducts Method used for deleting products from the IdoSell Shop administration panel.
3678
- * @property {ListProductsRequest} listProducts Method that enables extracting information about non-deleted products available in the administration panel
3679
3774
  * @property {GetProductsRequest} getProducts Method that enables extracting information about non-deleted products available in the administration panel.
3680
3775
  * @property {PostProductsRequest} postProducts The method is used to add products
3681
3776
  * @property {PutProductsRequest} putProducts Method that enables editing and adding new products to the administration panel.
3777
+ * @property {SearchProductsRequest} searchProducts Method that enables extracting information about non-deleted products available in the administration panel
3682
3778
  * @property {DeleteProductsProductsToFacebookCatalogRequest} deleteProductsProductsToFacebookCatalog The method allows you to add products to the Facebook catalog.
3683
3779
  * @property {GetProductsProductsToFacebookCatalogRequest} getProductsProductsToFacebookCatalog The method allows you to retrieve products assigned to the Facebook catalog.
3684
3780
  * @property {PostProductsProductsToFacebookCatalogRequest} postProductsProductsToFacebookCatalog The method allows you to add products to the Facebook catalog.
@@ -3714,14 +3810,20 @@
3714
3810
  * @property {GetRefundsGetRefundStatusRequest} getRefundsGetRefundStatus Method returns refund status.
3715
3811
  * @property {GetRefundsRetrieveRefundsListRequest} getRefundsRetrieveRefundsList Method returns a list of incomplete refunds.
3716
3812
  * @property {PutRefundsUpdateRefundRequest} putRefundsUpdateRefund Method allows you to update refund.
3813
+ * @property {GetResponsibilityEntitiesRequest} getResponsibilityEntities This call returns a list of responsible entities.
3814
+ * @property {PostResponsibilityEntitiesRequest} postResponsibilityEntities Use this operation to create responsible entities.
3815
+ * @property {PutResponsibilityEntitiesRequest} putResponsibilityEntities Use this operation to update responsible entities.
3816
+ * @property {DeleteResponsibilityEntitiesRequest} deleteResponsibilityEntities This call is used to remove responsible entities.
3717
3817
  * @property {GetReturnsRequest} getReturns Method that enables getting information about returns issued for orders in the administration panel.
3718
3818
  * @property {PostReturnsRequest} postReturns
3719
- * @property {PutReturnsRequest} putReturns Method that enables editing returns issued for orders in the administration panel.
3819
+ * @property {PutReturnsRequest} putReturns
3720
3820
  * @property {PutReturnsSerialNumberRequest} putReturnsSerialNumber Method that enables setting serial numbers for products included in returns issued for orders in the administration panel.
3721
3821
  * @property {GetReturnsStatusesRequest} getReturnsStatuses Allows to download all configurable return statuses
3722
3822
  * @property {GetRmaRequest} getRma This get method allows you to retrieve data about existing claims
3723
3823
  * @property {PutRmaRequest} putRma This update method allows to update the data in existing complaints
3724
3824
  * @property {GetRmaStatusesRequest} getRmaStatuses Allows to download all possible complaint statuses
3825
+ * @property {GetShopsCurrenciesRequest} getShopsCurrencies Method is used for extracting information about a shop language templates.
3826
+ * @property {GetShopsLanguagesRequest} getShopsLanguages Method is used for extracting information about a shop language templates.
3725
3827
  * @property {DeleteSizechartsRequest} deleteSizecharts The method allows the removal of size charts.
3726
3828
  * @property {GetSizechartsRequest} getSizecharts The method allows size charts to be downloaded.
3727
3829
  * @property {PutSizechartsRequest} putSizecharts The method allows the size charts settings to be updated.