idosell 0.3.17 → 0.4.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.
@@ -0,0 +1,2260 @@
1
+ import type { PagableGateway, AppendableGateway, Gateway, DateLike, JSObject } from "./app.d.ts";
2
+
3
+ export type PostOrdersParams = {
4
+ /** @description Orders. */
5
+ orders: {
6
+ /** @description Order type. Allowed values. "retail" - retail order, "wholesale" - wholesale order (can be added only by customer with wholesale account registered). Default value:: "retail" */
7
+ orderType?: string;
8
+ /** @description Shop Id */
9
+ shopId?: number;
10
+ /** @description Stock ID */
11
+ stockId: number;
12
+ /** @description Order payment method. Allowed values. "cash_on_delivery" - cash on delivery, "prepaid" - prepayment, "tradecredit" - Trade credit. */
13
+ orderPaymentType: "cash_on_delivery" | "prepaid" | "tradecredit";
14
+ /** @description Currency ID */
15
+ currencyId: string;
16
+ /** @description Determines if customer unregistered. Allowed values. "y" - casual client, "n" - registered customer. Default value:: "y". If customer is unregistered, enter customer details in element: "clientWithoutAccountData". For client with account - existing login should be stored in: "clientLogin". */
17
+ clientWithoutAccount: string;
18
+ /** @description Balance data for casual client. Object is necessary for casual clients (in case of client_once has y value). */
19
+ clientWithoutAccountData?: {
20
+ /** @description Customer's first name. */
21
+ clientFirstName?: string;
22
+ /** @description Customer's last name. */
23
+ clientLastName?: string;
24
+ /** @description Customer's company name. */
25
+ clientFirm?: string;
26
+ /** @description Customer Tax no. */
27
+ clientNip?: string;
28
+ /** @description Street and number. */
29
+ clientStreet?: string;
30
+ /** @description Customer's postal code. */
31
+ clientZipCode?: string;
32
+ /** @description Customer's city. */
33
+ clientCity?: string;
34
+ /** @description Customer's country. */
35
+ clientCountry?: string;
36
+ /** @description E-mail address. */
37
+ clientEmail?: string;
38
+ /** @description Cell phone. */
39
+ clientPhone1?: string;
40
+ /** @description Land line. */
41
+ clientPhone2?: string;
42
+ /** @description Language ID */
43
+ langId?: string;
44
+ };
45
+ /** @description Customer's login. */
46
+ clientLogin?: string;
47
+ /** @description Customer comments on order. */
48
+ clientNoteToOrder?: string;
49
+ /** @description Customer remarks for courier. */
50
+ clientNoteToCourier?: string;
51
+ /** @description ID of a partner who acquired a given customer. */
52
+ affiliateId?: number;
53
+ /** @description Courier ID. */
54
+ courierId: number;
55
+ /** @description Collection point ID. */
56
+ pickupPointId?: string;
57
+ /** @description Delivery cost. */
58
+ deliveryCost?: number;
59
+ /** @description Delivery address data. */
60
+ clientDeliveryAddress?: {
61
+ /** @description Recipient's first name. */
62
+ clientDeliveryAddressFirstName?: string;
63
+ /** @description Recipient's last name. */
64
+ clientDeliveryAddressLastName?: string;
65
+ /** @description Additional information. */
66
+ clientDeliveryAddressAdditional?: string;
67
+ /** @description Recipient street and number. */
68
+ clientDeliveryAddressStreet?: string;
69
+ /** @description Recipient's postal code. */
70
+ clientDeliveryAddressZipCode?: string;
71
+ /** @description Recipient's city. */
72
+ clientDeliveryAddressCity?: string;
73
+ /** @description Recipient's country. */
74
+ clientDeliveryAddressCountry?: string;
75
+ /** @description Consignee's phone number. */
76
+ clientDeliveryAddressPhone?: string;
77
+ };
78
+ /** @description Buyer's address data. */
79
+ payerAddress?: {
80
+ /** @description Buyer's address id. */
81
+ payerAddressId?: number;
82
+ /** @description Buyer's first name. */
83
+ payerAddressFirstName?: string;
84
+ /** @description Buyer's last name. */
85
+ payerAddressLastName?: string;
86
+ /** @description Company name. */
87
+ payerAddressFirm?: string;
88
+ /** @description Customer VAT ID. */
89
+ payerAddressNip?: string;
90
+ /** @description Buyer's street name and house number. */
91
+ payerAddressStreet?: string;
92
+ /** @description Buyer's postal code. */
93
+ payerAddressZipCode?: string;
94
+ /** @description Buyer's city. */
95
+ payerAddressCity?: string;
96
+ /** @description Country code in the ISO 3166-1 A2 standard. */
97
+ payerAddressCountryId?: string;
98
+ /** @description Buyer's telephone number. */
99
+ payerAddressPhone?: string;
100
+ };
101
+ /** @description Products list. */
102
+ products: {
103
+ /** @description Product IAI code */
104
+ productId: number;
105
+ /** @description Size identifier */
106
+ sizeId: string;
107
+ /** @description External product system code for size. */
108
+ productSizeCodeExternal?: string;
109
+ /** @description Stock ID */
110
+ stockId?: number;
111
+ /** @description Product quantity. */
112
+ productQuantity: number;
113
+ /** @description Gross price */
114
+ productRetailPrice?: number;
115
+ /** @description Free product. */
116
+ productFree?: boolean;
117
+ /** */
118
+ forceLoyaltyPoints?: number;
119
+ /** @description Value of VAT */
120
+ productVat?: number;
121
+ /** @description Is product VAT free Allowed values "y" - yes, "n" - no. */
122
+ productVatFree?: string;
123
+ /** @description Information on used discount code. */
124
+ discountCode?: {
125
+ /** @description Name. */
126
+ name?: string;
127
+ };
128
+ /** @description Client's remarks on product. */
129
+ remarksToProduct?: string;
130
+ /** @description Label for grouping products. */
131
+ label?: string;
132
+ /** @description List of components if a products is a set or collection. */
133
+ productBundleItems?: {
134
+ /** @description Product IAI code */
135
+ productId?: number;
136
+ /** @description Size identifier */
137
+ sizeId?: string;
138
+ /** @description Size name */
139
+ sizePanelName?: string;
140
+ /** @description One of the unique, indexed product codes (IAI code / External system code / Producer code) */
141
+ productIndex?: string;
142
+ }[];
143
+ }[];
144
+ /** @description Discount value. */
145
+ orderRebateValue?: number;
146
+ /** @description Order handler. */
147
+ orderOperatorLogin?: string;
148
+ /** @description Omits collecting orders via IAI Bridge. */
149
+ ignoreBridge?: boolean;
150
+ /** @description Settings */
151
+ settings?: {
152
+ /** @description Send an email with order placement confirmation. */
153
+ settingSendMail?: boolean;
154
+ /** @description Send a text message with order placement confirmation. */
155
+ settingSendSMS?: boolean;
156
+ };
157
+ /** @description Settlement by prices. "gross" - gross, "net" - net, "net_without_VAT" - net without VAT. */
158
+ orderSettledAtPrice?: "gross" | "net" | "net_without_VAT";
159
+ /** @description Customer asked for invoice. List of parameters: "y" - yes (paper invoicing ), "e" - yes (electronic invoicing ), "n" - no. */
160
+ clientRequestInvoice?: string;
161
+ /** @description Order settlement currency. */
162
+ billingCurrency?: string;
163
+ /** @description Panel billing currency exchange rate in relation to billing currency in the shop . */
164
+ billingCurrencyRate?: number;
165
+ /** @description Sale date. ISO 8602 format. */
166
+ purchaseDate?: string;
167
+ }[];
168
+ };
169
+
170
+ export type PostProductsParams = {
171
+ /** @description Settings */
172
+ settings?: {
173
+ /** @description Price format. Parameter is currently unused. */
174
+ settingPriceFormat?: string;
175
+ /** @description Object determines if new categories can be added when category linked with product couldn't be found in system. Allowed values "n" - adding new categories not allowed (default value), "y" - adding new categories is possible. */
176
+ settingAddingCategoryAllowed?: string;
177
+ /** @description Object determines if new product sizes can be added when size linked with product couldn't be found in system. Allowed values "n" - adding new sizes not allowed (default value), "y" - adding new sizes is possible. */
178
+ settingAddingSizeAllowed?: string;
179
+ /** @description Object determines if new producers can be added when producer linked with product couldn't be found in system. Allowed values "n" - you have no rights to add new manufacturers (default value), "y" - adding new producer is possible. */
180
+ settingAddingProducerAllowed?: string;
181
+ /** @description Object determines if new product series can be added when series linked with product couldn't be found in system. Allowed values "n" - you have no rights to add new product series (default value), "y" - adding new series is possible. */
182
+ settingAddingSeriesAllowed?: string;
183
+ /** @description Object determines default category which will be linked with product when it will not be linked with any category.. */
184
+ settingDefaultCategory?: {
185
+ /** @description Category id */
186
+ categoryId?: number;
187
+ /** @description Category name */
188
+ categoryName?: string;
189
+ };
190
+ /** @description Element specifying the default size group that will be assigned to the new product in case no size group has been explicitly assigned. */
191
+ settingDefaultSizesGroup?: {
192
+ /** @description Size group ID Change of one size group to another results in zeroing all stock quantities in all stocks. Change of size group can be made, if product is not present in any unhandled orders nor listed on auctions. */
193
+ sizesGroupId?: number;
194
+ /** @description Size group name. */
195
+ sizesGroupName?: string;
196
+ };
197
+ /** @description The item shall determine whether the default visibility in stores can be set if a new commodity is to be created and no parameters have been uploaded to set visibility in at least one store.. */
198
+ settingsAddingDefaultShopMaskAllowed?: "n" | "y";
199
+ /** @description Element specifying whether the default visibility in stores can be set according to the list of stores indicated in the web import source configuration, if a new product will be created and no parameters have been sent to set visibility in at least one store.. */
200
+ settingsAddingManuallySelectedShopMaskAllowed?: number;
201
+ };
202
+ /** @description Icon and photos settings */
203
+ picturesSettings?: {
204
+ /** @description Object determines photo URL. */
205
+ picturesSettingInitialUrlPart?: string;
206
+ /** @description Object determines the method of adding photos in "pictures" object. Allowed values "base64" - photos added in base64 coding algorithm, "url" - photos added as URLs to external systems. */
207
+ picturesSettingInputType?: string;
208
+ /** @description Object determines the method of adding product photos. Allowed values "n" - photos are uploaded from the first free place, "y" - photos are uploaded from the first place. */
209
+ picturesSettingOverwrite?: string;
210
+ /** @description Object determines if the photo should be scaled. Allowed values "n" - no scaling allowance, "y" - scaling allowance. */
211
+ picturesSettingScaling?: string;
212
+ };
213
+ /** @description Products list. */
214
+ products: {
215
+ /** @description Product IAI code */
216
+ productId?: number;
217
+ /** @description External product system code for size. */
218
+ productSizeCodeExternal?: string;
219
+ /** @description External product system code. */
220
+ productDisplayedCode?: string;
221
+ /** @description PKWiU [PCPandS]. */
222
+ productTaxCode?: string;
223
+ /** @description Number of items in package data */
224
+ productInWrapper?: number;
225
+ /** @description Sold at - for retailers. */
226
+ productSellByRetail?: number;
227
+ /** @description Sold at - for wholesalers. */
228
+ productSellByWholesale?: number;
229
+ /** @description IdoSell Category ID */
230
+ categoryIdoSellId?: number;
231
+ /** @description IdoSell Category pathname */
232
+ categoryIdoSellPath?: string;
233
+ /** @description Category id */
234
+ categoryId?: number;
235
+ /** @description Category name */
236
+ categoryName?: string;
237
+ /** @description Brand ID */
238
+ producerId?: number;
239
+ /** @description Brand name */
240
+ producerName?: string;
241
+ /** @description CN/TARIC */
242
+ cnTaricCode?: string;
243
+ /** @description Country of origin. Country code in the ISO 3166-1 A2 standard */
244
+ countryOfOrigin?: string;
245
+ /** @description Product unit of measure ID. */
246
+ unitId?: number;
247
+ /** @description ID of series, to which product belongs. */
248
+ seriesId?: number;
249
+ /** @description Name of series, to which the product belongs, visible in panel. */
250
+ seriesPanelName?: string;
251
+ /** @description Size group ID Change of one size group to another results in zeroing all stock quantities in all stocks. Change of size group can be made, if product is not present in any unhandled orders nor listed on auctions. */
252
+ sizesGroupId?: number;
253
+ /** @description Optional element, that determines prices edition mode. Default value is "amount_set", when indicated element is omitted in API gate call.. Allowed values "amount_set" - sets product prices to desired value (default mode), "amount_diff" - sets sum difference between prices set (adds or subtracts entered sum from the current price), "percent_diff" - sets percentage difference between prices set (adds or subtracts entered percent from the current price). */
254
+ priceChangeMode?: string;
255
+ /** @description The JavaScript formula calculating prices */
256
+ priceFormula?: {
257
+ /** @description Formula parameters for calculating price */
258
+ priceFormulaParameters?: string;
259
+ /** @description Formula function for calculating price */
260
+ priceFormulaFunction?: string;
261
+ };
262
+ /** @description Gross price */
263
+ productRetailPrice?: number;
264
+ /** @description Wholesale price */
265
+ productWholesalePrice?: number;
266
+ /** @description Minimal price */
267
+ productMinimalPrice?: number;
268
+ /** @description Price for automatic calculations */
269
+ productAutomaticCalculationPrice?: number;
270
+ /** @description price for POS. */
271
+ productPosPrice?: number;
272
+ /** @description Value of VAT */
273
+ productVat?: number;
274
+ /** @description Is product VAT free Allowed values "y" - yes, "n" - no. */
275
+ productVatFree?: string;
276
+ /** @description Different prices for price comparison websites. */
277
+ productPriceComparisonSitesPrices?: {
278
+ /** @description price comparison website ID */
279
+ priceComparisonSiteId?: number;
280
+ /** @description Price for a price comparison website in a shop */
281
+ productPriceComparisonSitePrice?: number;
282
+ }[];
283
+ /** @description Object determines if the product is available in POS sale Available values: "n" - no, "y" - yes. */
284
+ productEnableInPos?: string;
285
+ /** @description Required advance payment in percents */
286
+ productAdvancePrice?: number;
287
+ /** @description Annotation. */
288
+ productNote?: string;
289
+ /** @description Product value in points. */
290
+ productProfitPoints?: number;
291
+ /** @description Weight. */
292
+ productWeight?: number;
293
+ /** @description Product visibility. Allowed values "y" - product visible, "n" - product not visible. */
294
+ productInVisible?: string;
295
+ /** @description Product visible even though out of stock Available values: "y" - visible even though out of stock, "n" - not visible when out of stock. */
296
+ productInPersistent?: string;
297
+ /** @description Bit mask of shop IDs. Mask for indicated store is calculated on basis of following formula: 2^(store_ID - 1). If the product should be available in more than one shop, the masks should be summed up. */
298
+ shopsMask: number;
299
+ /** @description Complex rating Available values: "0" - no, "1" - yes. */
300
+ productComplexNotes?: number;
301
+ /** @description Product visibility in export to price comparison and marketplaces. Available values: "y" - Visible, "selected" - yes (selected), "n" - invisible. */
302
+ productInExportToPriceComparisonSites?: string;
303
+ /** @description Selection of comparison sites for which the product visibility will be changed */
304
+ priceComparisonSites?: {
305
+ /** @description Shop Id */
306
+ shopId?: number;
307
+ /** @description price comparison website ID */
308
+ priceComparisonSiteId?: number;
309
+ }[];
310
+ /** @description Visibility of an item in an export to Amazon Marketplace. Available values: "y" - Visible, "selected" - Visible on selected regional services, "n" - invisible. */
311
+ productInExportToAmazonMarketplace?: string;
312
+ /** @description Availability profile ID. */
313
+ availableProfile?: number;
314
+ /** @description Discount profile ID */
315
+ productRebate?: number;
316
+ /** @description Product warranty ID. */
317
+ warrantyId?: number;
318
+ /** @description Priority. Allowed values from 1 to 10. */
319
+ productPriority?: number;
320
+ /** @description Product icon details. */
321
+ productIcon?: string;
322
+ /** @description Watermark ID */
323
+ productWatermarkId?: number;
324
+ /** @description Link to watermark */
325
+ productWatermarkUrl?: string;
326
+ /** @description List of product photos */
327
+ productPictures?: string[];
328
+ /** @description List of photos descriptions */
329
+ productDescriptionPictures?: string[];
330
+ /** @description Reduced price */
331
+ productPromotion?: {
332
+ /** @description Object determines if the promotion should be active.. Allowed values "y" - active promotion, "n" - inactive promotion. */
333
+ promoteInEnabled?: string;
334
+ /** @description Strikethrough price */
335
+ promoteItemNormalPrice?: number;
336
+ /** @description Strikethrough wholesale price */
337
+ promoteItemWholesaleNormalPrice?: number;
338
+ /** @description Switching off date */
339
+ promoteItemEndingDate?: string;
340
+ };
341
+ /** @description Discount for shop. */
342
+ productDiscount?: {
343
+ /** @description Object determines if the promotion should be active.. Allowed values "y" - active promotion, "n" - inactive promotion. */
344
+ promoteInEnabled?: string;
345
+ /** @description Strikethrough price */
346
+ promoteItemNormalPrice?: number;
347
+ /** @description Strikethrough wholesale price */
348
+ promoteItemWholesaleNormalPrice?: number;
349
+ /** @description Switching off date */
350
+ promoteItemEndingDate?: string;
351
+ };
352
+ /** @description Distinguished product in store. */
353
+ productDistinguished?: {
354
+ /** @description Object determines if the promotion should be active.. Allowed values "y" - active promotion, "n" - inactive promotion. */
355
+ promoteInEnabled?: string;
356
+ /** @description Strikethrough price */
357
+ promoteItemNormalPrice?: number;
358
+ /** @description Strikethrough wholesale price */
359
+ promoteItemWholesaleNormalPrice?: number;
360
+ /** @description Switching off date */
361
+ promoteItemEndingDate?: string;
362
+ };
363
+ /** @description Special product in store. */
364
+ productSpecial?: {
365
+ /** @description Object determines if the promotion should be active.. Allowed values "y" - active promotion, "n" - inactive promotion. */
366
+ promoteInEnabled?: string;
367
+ /** @description Strikethrough price */
368
+ promoteItemNormalPrice?: number;
369
+ /** @description Strikethrough wholesale price */
370
+ promoteItemWholesaleNormalPrice?: number;
371
+ /** @description Switching off date */
372
+ promoteItemEndingDate?: string;
373
+ };
374
+ /** @description Parameters (distinguished). */
375
+ productParametersDistinction?: {
376
+ /** @description Parameter ID */
377
+ parameterId?: number;
378
+ /** @description Parameter name. */
379
+ parameterName?: string;
380
+ /** @description Parameter value ID */
381
+ parameterValueId?: number;
382
+ /** @description Attributes group name. */
383
+ parameterValueName?: string;
384
+ }[];
385
+ /** @description List of products recommended with this product */
386
+ associatedProducts?: {
387
+ /** @description Recommended product ID */
388
+ associatedProductId?: number;
389
+ /** @description Recommended product name */
390
+ associatedProductName?: string;
391
+ /** @description Recommended product code. External system code. */
392
+ associatedProductCode?: string;
393
+ }[];
394
+ /** @description Sizes available for products data. */
395
+ productSizes?: {
396
+ /** @description Size identifier */
397
+ sizeId?: string;
398
+ /** @description Size name */
399
+ sizePanelName?: string;
400
+ /** @description Weight. */
401
+ productWeight?: number;
402
+ /** @description Net weight. */
403
+ productWeightNet?: number;
404
+ /** @description Gross price */
405
+ productRetailPrice?: number;
406
+ /** @description Wholesale price */
407
+ productWholesalePrice?: number;
408
+ /** @description Minimal price */
409
+ productMinimalPrice?: number;
410
+ /** @description Price for automatic calculations */
411
+ productAutomaticCalculationPrice?: number;
412
+ /** @description price for POS. */
413
+ productPosPrice?: number;
414
+ /** @description Prices for marketplaces */
415
+ productAuctionPrices?: {
416
+ /** @description Auction system ID */
417
+ productAuctionId?: number;
418
+ /** @description Auction site ID */
419
+ productAuctionSiteId?: number;
420
+ /** @description Price for auction site */
421
+ productAuctionPrice?: number;
422
+ }[];
423
+ /** @description External product system code */
424
+ productCode?: string;
425
+ /** @description Product visible even though out of stock Available values: "y" - visible even though out of stock, "n" - not visible when out of stock. */
426
+ productInPersistent?: string;
427
+ /** @description Product stock quantity data. */
428
+ productStocksData?: {
429
+ /** @description Object contains information on product quantity */
430
+ productStockQuantities?: {
431
+ /** @description Stock ID */
432
+ stockId?: number;
433
+ /** Format: decimal
434
+ * @description Product stock quantity */
435
+ productSizeQuantity?: number;
436
+ /** Format: decimal
437
+ * @description Product quantity to add up */
438
+ productSizeQuantityToAdd?: number;
439
+ /** Format: decimal
440
+ * @description Product quantity to subtract */
441
+ productSizeQuantityToSubstract?: number;
442
+ }[];
443
+ };
444
+ /** @description Object contains information dependent on shop and size. */
445
+ shopsSizeAttributes?: {
446
+ /** @description Shop Id */
447
+ shopId?: number;
448
+ /** @description Gross price */
449
+ productRetailPrice?: number;
450
+ /** @description Wholesale price */
451
+ productWholesalePrice?: number;
452
+ /** @description Minimal price */
453
+ productMinimalPrice?: number;
454
+ /** @description Price for automatic calculations */
455
+ productAutomaticCalculationPrice?: number;
456
+ }[];
457
+ }[];
458
+ /** @description Data concerning attributes dependent on indicated stores with particular product assigned. */
459
+ productShopsAttributes?: {
460
+ /** @description Shop Id */
461
+ shopId?: number;
462
+ /** @description Information about prices for price comparison websites dependent on a shop */
463
+ productShopPriceComparisonSitesPrices?: {
464
+ /** @description price comparison website ID */
465
+ priceComparisonSiteId?: number;
466
+ /** @description Percentage difference between the price comparison website and the shop */
467
+ productPriceComparisonSitePercentDiff?: number;
468
+ }[];
469
+ }[];
470
+ /** @description Products subscription settings. */
471
+ subscription?: {
472
+ /** @description Shop Id */
473
+ shopId?: number;
474
+ /** @description Is subscription enabled for product */
475
+ enabled?: boolean;
476
+ /** @description Days in period */
477
+ daysInPeriod?: number[];
478
+ /** @description Sold at - for retailers. */
479
+ unitsNumberRetail?: number;
480
+ /** @description Sold at - for wholesalers. */
481
+ unitsNumberWholesale?: number;
482
+ }[];
483
+ /** @description Product name. */
484
+ productNames?: {
485
+ productNamesLangData?: {
486
+ /** @description Language ID */
487
+ langId?: string;
488
+ /** @description Product name. */
489
+ productName?: string;
490
+ }[];
491
+ };
492
+ productDescriptions?: {
493
+ /** @description Array of language-dependent elements. */
494
+ productDescriptionsLangData?: {
495
+ /** @description Language ID */
496
+ langId?: string;
497
+ /** @description Short product description. */
498
+ productDescription?: string;
499
+ }[];
500
+ };
501
+ /** @description Long product description */
502
+ productLongDescriptions?: {
503
+ productLongDescriptionsLangData?: {
504
+ /** @description Language ID */
505
+ langId?: string;
506
+ /** @description Long product description. */
507
+ productLongDescription?: string;
508
+ }[];
509
+ };
510
+ /** @description Product data for auction services */
511
+ productAuctionDescriptionsData?: {
512
+ /** @description Auction system ID */
513
+ productAuctionId?: string;
514
+ /** @description Auction site ID */
515
+ productAuctionSiteId?: string;
516
+ /** @description Product name for auction service. */
517
+ productAuctionName?: string;
518
+ /** @description Subtitle for auction service */
519
+ productAuctionAdditionalName?: string;
520
+ /** @description Product description for marketplaces */
521
+ productAuctionDescription?: string;
522
+ }[];
523
+ /** @description Product meta title */
524
+ productMetaTitles?: {
525
+ productMetaTitlesLangData?: {
526
+ /** @description Language ID */
527
+ langId?: string;
528
+ /** @description Language name */
529
+ langName?: string;
530
+ /** @description Product meta title. */
531
+ productMetaTitle?: string;
532
+ }[];
533
+ };
534
+ /** @description Product meta description */
535
+ productMetaDescriptions?: {
536
+ productMetaDescriptionsLangData?: {
537
+ /** @description Language ID */
538
+ langId?: string;
539
+ /** @description Language name */
540
+ langName?: string;
541
+ /** @description Product meta description. */
542
+ productMetaDescription?: string;
543
+ }[];
544
+ };
545
+ /** @description Product meta keywords. */
546
+ productMetaKeywords?: {
547
+ productMetaKeywordsLangData?: {
548
+ /** @description Language ID */
549
+ langId?: string;
550
+ /** @description Language name */
551
+ langName?: string;
552
+ /** @description Product meta keywords. */
553
+ productMetaKeyword?: string;
554
+ }[];
555
+ };
556
+ /** @description #!AdresURLDlaTowaru!#. */
557
+ productUrl?: {
558
+ productUrlsLangData?: {
559
+ /** @description Shop Id */
560
+ shopId?: number;
561
+ /** @description Language ID */
562
+ langId?: string;
563
+ /** @example url */
564
+ url?: string;
565
+ }[];
566
+ };
567
+ /** @description Data on product groups (variants) */
568
+ productVersion?: {
569
+ /** @description ID of the main item (variant) in the group */
570
+ versionParentId?: number;
571
+ /** @description The order of products in the group. Value needs to be more than 0. */
572
+ versionPriority?: number;
573
+ /** @description Settings for groups of items (variants) */
574
+ versionSettings?: {
575
+ /** @description Show in shop. Available values: "y" - all products from group, "n" - only the first product from group. */
576
+ versionDisplayAllInShop?: string;
577
+ /** @description The same code. Available values: "y" - yes, "n" - no. */
578
+ versionCommonCode?: string;
579
+ /** @description The same brand. Available values: "y" - yes, "n" - no. */
580
+ versionCommonProducer?: string;
581
+ /** @description The same annotation. Available values: "y" - yes, "n" - no. */
582
+ versionCommonNote?: string;
583
+ /** @description The same warranty. Available values: "y" - yes, "n" - no. */
584
+ versionCommonWarranty?: string;
585
+ /** @description The same series. Available values: "y" - yes, "n" - no. */
586
+ versionCommonSeries?: string;
587
+ /** @description The same category. Available values: "y" - yes, "n" - no. */
588
+ versionCommonCategory?: string;
589
+ /** @description The same price. Available values: "y" - yes, "n" - no. */
590
+ versionCommonPrice?: string;
591
+ /** @description Same price for auction services. possible values "y" - yes, "n" - no. */
592
+ versionCommonAuctionsPrice?: string;
593
+ /** @description Same advance. Available values: "y" - yes, "n" - no. */
594
+ versionCommonAdvance?: string;
595
+ /** @description Same quantity discount. Available values: "y" - yes, "n" - no. */
596
+ versionCommonRebate?: string;
597
+ /** @description the same VAT rate. Available values: "y" - yes, "n" - no. */
598
+ versionCommonVat?: string;
599
+ /** @description The same loyalty points. Available values: "y" - yes, "n" - no. */
600
+ versionCommonProfitPoints?: string;
601
+ /** @description The same promotion. Available values: "y" - yes, "n" - no. */
602
+ versionCommonPromotion?: string;
603
+ /** @description The same loyalty discount. Available values: "y" - yes, "n" - no. */
604
+ versionCommonDiscount?: string;
605
+ /** @description The same privileged products. Available values: "y" - yes, "n" - no. */
606
+ versionCommonDistinguished?: string;
607
+ /** @description The same for special. Available values: "y" - yes, "n" - no. */
608
+ versionCommonSpecial?: string;
609
+ /** @description DEPRECATED */
610
+ versionCommonTraits?: string;
611
+ /** @description The same related product. Available values: "y" - yes, "n" - no. */
612
+ versionCommonAssociated?: string;
613
+ /** @description The same visibility. Available values: "y" - yes, "n" - no. */
614
+ versionCommonVisibility?: string;
615
+ /** @description Same display when not in stock. Available values: "y" - yes, "n" - no. */
616
+ versionCommonPersistent?: string;
617
+ /** @description The same priority. Available values: "y" - yes, "n" - no. */
618
+ versionCommonPriority?: string;
619
+ /** @description The same shops. Available values: "y" - yes, "n" - no. */
620
+ versionCommonShops?: string;
621
+ /** @description The same sizes. Available values: "y" - yes, "n" - no. */
622
+ versionCommonSizes?: string;
623
+ /** @description The same unit of measure. Available values: "y" - yes, "n" - no. */
624
+ versionCommonUnit?: string;
625
+ /** @description The same weight. Available values: "y" - yes, "n" - no. */
626
+ versionCommonWeight?: string;
627
+ /** @description The same parameters. possible values "y" - yes, "n" - no. */
628
+ versionCommonDictionary?: string;
629
+ /** @description The same name. Available values: "y" - yes, "n" - no. */
630
+ versionCommonName?: string;
631
+ /** @description The same short description. Available values: "y" - yes, "n" - no. */
632
+ versionCommonDescription?: string;
633
+ /** @description The same long description. Available values: "y" - yes, "n" - no. */
634
+ versionCommonLongDescription?: string;
635
+ /** @description The same icon. Available values: "y" - yes, "n" - no. */
636
+ versionCommonIcon?: string;
637
+ /** @description The same large photos. Available values: "y" - yes, "n" - no. */
638
+ versionCommonPhotos?: string;
639
+ /** @description The same availability profile. Available values: "y" - yes, "n" - no. */
640
+ versionCommonAvailableProfile?: string;
641
+ /** @description The same complex rating. Available values: "y" - yes, "n" - no. */
642
+ versionCommonComplexNotes?: string;
643
+ /** @description Do You wish to sum up the products in the basket as a one order? Available values: "y" - yes, "n" - no. */
644
+ versionCommonSumInBasket?: string;
645
+ };
646
+ /** @description Parameter value names */
647
+ versionNames?: {
648
+ /** @description Array of languages, values are displayed in. */
649
+ versionNamesLangData?: {
650
+ /** @description Language ID */
651
+ langId?: string;
652
+ /** @description Name of the parameter value, e.g. orange, green, red */
653
+ versionName?: string;
654
+ }[];
655
+ };
656
+ /** @description Parameter names */
657
+ versionGroupNames?: {
658
+ /** @description Parameter name */
659
+ versionGroupNamesLangData?: {
660
+ /** @description Language ID */
661
+ langId?: string;
662
+ /** @description Parameter name, e.g. color, width */
663
+ versionGroupName?: string;
664
+ }[];
665
+ };
666
+ };
667
+ /** @description Currency ID */
668
+ currencyId?: string;
669
+ /** @description Supplier ID. */
670
+ delivererId?: number;
671
+ /** @description This parameter is optional and it determines properties edition mode. Default value is "replace". Allowed values: "add" - adds properties to already existent ones, "delete" - removes properties of already existent ones, "delete_group" - removes properties from selected group, "replace" - overwrites properties already existent with new ones (default mode). */
672
+ productParametersDistinctionChangeMode?: "add" | "delete" | "delete_group" | "replace";
673
+ /** @description Product delivery time from the producer to the shop */
674
+ productDeliveryTime?: {
675
+ /** @description Operation type: "product" - sets own product delivery time, "deliverer" - sets product delivery time exactly the same as deliverer's. */
676
+ productDeliveryTimeChangeMode?: "product" | "deliverer";
677
+ /** @description The amount of time it takes to get goods from the supplier to the store. The maximum time is 99 for the unit "days" or 999 for the unit "hours" and "minutes" */
678
+ productDeliveryTimeValue?: number;
679
+ };
680
+ /** @description Do You wish to sum up the products in the basket as a one order? Available values: "y" - yes, "n" - no. */
681
+ productSumInBasket?: string;
682
+ /** @description Shipping, returns and complaints settings */
683
+ dispatchSettings?: {
684
+ enabled?: boolean;
685
+ /** @description Shipping settings */
686
+ shippingSettings?: {
687
+ /** @description Disable cash on delivery orders */
688
+ codDisabled?: boolean;
689
+ /** @description Only personal collection */
690
+ dvpOnly?: boolean;
691
+ /** @description Oversized product */
692
+ atypicalSize?: boolean;
693
+ /** @description Insurance required */
694
+ insuranceOnly?: boolean;
695
+ /** @description Exclusion from the Smile service */
696
+ excludeSmileService?: boolean;
697
+ /** @description List of courier services which cannot be used to ship this product */
698
+ disallowedCouriers?: number[];
699
+ };
700
+ /** @description Free shipping settings */
701
+ freeShippingSettings?: {
702
+ /** @description Edition mode */
703
+ mode?: "no" | "onlyProduct" | "wholeBasket";
704
+ /** @description Set free shipping for the payment method only . */
705
+ availablePaymentForms?: {
706
+ /** @description prepayment */
707
+ prepaid?: boolean;
708
+ /** @description Cash on delivery */
709
+ cashOnDelivery?: boolean;
710
+ /** @description Trade credit */
711
+ tradeCredit?: boolean;
712
+ };
713
+ /** @description List of courier services for which shipping is free */
714
+ availableCouriers?: number[];
715
+ /** @description List of regions with free shipment */
716
+ availableRegions?: number[];
717
+ };
718
+ /** @description Return and complaint settings */
719
+ returnProductSettings?: {
720
+ /** @description Product can be returned */
721
+ returnOptions?: {
722
+ enabled?: boolean;
723
+ /** @description yes - for companies */
724
+ firm?: boolean;
725
+ /** @description yes - for wholesalers */
726
+ hurt?: boolean;
727
+ /** @description yes - for retailers */
728
+ detalist?: boolean;
729
+ };
730
+ byOwnService?: boolean;
731
+ byInPostSzybkieZwrotyByIAI?: boolean;
732
+ };
733
+ };
734
+ /** @description Standard unit settings */
735
+ standardUnit?: {
736
+ /** @description Possible special contexts corresponding to standard units. Available values: "CONTEXT_STD_UNIT_WEIGHT" - #!WagaTowaruWGramach!#, "CONTEXT_STD_UNIT_WEIGHT_SI" - Product weight in kilograms, "CONTEXT_STD_UNIT_VOLUME" - A product's value in milliliters "CONTEXT_STD_UNIT_VOLUME_SI" - A product's value in liters "CONTEXT_STD_UNIT_LENGTH" - Length of product in meters "CONTEXT_STD_UNIT_AREA_M2" - Area of ​​product in square meters "CONTEXT_STD_UNIT_VOLUME_M3" - The volume of products in cubic meters "CONTEXT_STD_UNIT_QUANTITY_PACKAGE" - Number of pieces per pack for standard unit */
737
+ contextValue?: "CONTEXT_STD_UNIT_WEIGHT" | "CONTEXT_STD_UNIT_WEIGHT_SI" | "CONTEXT_STD_UNIT_VOLUME" | "CONTEXT_STD_UNIT_VOLUME_SI" | "CONTEXT_STD_UNIT_LENGTH" | "CONTEXT_STD_UNIT_AREA_M2" | "CONTEXT_STD_UNIT_VOLUME_M3" | "CONTEXT_STD_UNIT_QUANTITY_PACKAGE";
738
+ /** @description Total length/volume/area/weight of product */
739
+ standardUnitValue?: number;
740
+ /** @description Price converter per unit. Available values: "0" - default (taken from the category), "1" - price per gram/milliliter/meter "10" - price per 10 grams/10 milliliters/10 meters "100" - price per 100 grams/100 milliliters/100 meters "1000" - price per liter/kilogram/kilometer */
741
+ converterUnitValue?: "0" | "1" | "10" | "100" | "1000";
742
+ };
743
+ /** @description Minimal number of products in an order */
744
+ minQuantityPerOrder?: {
745
+ /** @description Minimum number of products in a retail order */
746
+ minQuantityPerOrderRetail?: number;
747
+ /** @description Minimum number of products in a wholesale order */
748
+ minQuantityPerOrderWholesale?: number;
749
+ };
750
+ /** @description Dimensions and overall weight */
751
+ productDimensions?: {
752
+ /** @description The width of a product in centimeters */
753
+ productWidth?: number;
754
+ /** @description Height of a product in centimeters */
755
+ productHeight?: number;
756
+ /** @description The length of a product in centimeters */
757
+ productLength?: number;
758
+ };
759
+ /** @description Responsible producer code */
760
+ responsibleProducerCode?: string;
761
+ /** @description Responsible person code */
762
+ responsiblePersonCode?: string;
763
+ }[];
764
+ };
765
+
766
+ export type PutProductsParams = {
767
+ /** @description Settings */
768
+ settings?: {
769
+ /** @description Object determines the products modification mode. Allowed values: "all" - (default value). - allows adding new products. If the product of entered ID or external product system code cannot be found in system, the product will be added as a new one., "edit" - doesn't allow adding new products. In this mode only editing the already existing products is possible. If the product of entered ID or external product system code cannot be found in shop, gate will return error and the product will not be added to shop. "add" - In this mode you can only add products. */
770
+ settingModificationType?: "all" | "edit" | "add";
771
+ /** @description Price format. Parameter is currently unused. */
772
+ settingPriceFormat?: string;
773
+ /** @description Element defining the way of calculating product base price basing on prices of sizes. If value is not provided, the base price will be calculated basing on prices of sizes with stock levels. In case of lack of the stock levels, the base price will be calculated basing on prices of all sizes. Allowed values "all" - Product price calculated basing on prices of all sizes "available" - Product price calculated basing on prices of sizes with stock levels */
774
+ settingCalculateBasePriceSizes?: "all" | "available";
775
+ /** @description Object determines if new categories can be added when category linked with product couldn't be found in system. Allowed values "n" - adding new categories not allowed (default value), "y" - adding new categories is possible. */
776
+ settingAddingCategoryAllowed?: "n" | "y";
777
+ /** @description Object determines if new product sizes can be added when size linked with product couldn't be found in system. Allowed values "n" - adding new sizes not allowed (default value), "y" - adding new sizes is possible. */
778
+ settingAddingSizeAllowed?: "n" | "y";
779
+ /** @description Object determines if new producers can be added when producer linked with product couldn't be found in system. Allowed values "n" - you have no rights to add new manufacturers (default value), "y" - adding new producer is possible. */
780
+ settingAddingProducerAllowed?: "n" | "y";
781
+ /** @description Object determines if new product series can be added when series linked with product couldn't be found in system. Allowed values "n" - you have no rights to add new product series (default value), "y" - adding new series is possible. */
782
+ settingAddingSeriesAllowed?: "n" | "y";
783
+ /** @description Element determines, whether new size charts can be added, when no size chart assigned to sizes is not found in the system. Allowed values: "n" - adding new size charts not allowed. (default value), "y" - adding new size charts allowed. */
784
+ settingAddingSizeschartAllowed?: "n" | "y";
785
+ /** @description Object determines default category which will be linked with product when it will not be linked with any category.. */
786
+ settingDefaultCategory?: {
787
+ /** @description Category id */
788
+ categoryId?: number;
789
+ /** @description Category name */
790
+ categoryName?: string;
791
+ };
792
+ /** @description Element specifying the default size group that will be assigned to the new product in case no size group has been explicitly assigned. */
793
+ settingDefaultSizesGroup?: {
794
+ /** @description Size group ID Change of one size group to another results in zeroing all stock quantities in all stocks. Change of size group can be made, if product is not present in any unhandled orders nor listed on auctions. */
795
+ sizesGroupId?: number;
796
+ /** @description Size group name. */
797
+ sizesGroupName?: string;
798
+ };
799
+ /** @description Delimiter separating elements of text ID. Default:. "\". */
800
+ settingTextIdSeparator?: string;
801
+ /** @description Element indicating if retail price in special offer should be ignored. */
802
+ settingIgnoreRetailPricesInCaseOfPromotion?: "n" | "y";
803
+ /** @description Element indicating if information about special offer should be retrieved. */
804
+ returnPromotionStatus?: "n" | "y";
805
+ /** @description Element specifying whether the item is to be restored after deletion. */
806
+ settingsRestoreDeletedProducts?: "n" | "y";
807
+ /** @description The item shall determine whether the default visibility in stores can be set if a new commodity is to be created and no parameters have been uploaded to set visibility in at least one store.. */
808
+ settingsAddingDefaultShopMaskAllowed?: "n" | "y";
809
+ /** @description Element specifying whether the default visibility in stores can be set according to the list of stores indicated in the web import source configuration, if a new product will be created and no parameters have been sent to set visibility in at least one store.. */
810
+ settingsAddingManuallySelectedShopMaskAllowed?: number;
811
+ /** @description Element specifying whether the system should create a new provider in case of not finding one in the panel. */
812
+ settingAddingSupplierAllowed?: "n" | "y";
813
+ /** @description The element specifies how to update the product supplier Available values: "always" - (default value). - update in any case, "ifNecessary" - update when no supplier is assigned to the product, "none" - supplier update disabled. */
814
+ settingActualizeDelivererMode?: "always" | "ifNecessary" | "none";
815
+ /** @description Element specifying the mask of stores for which individual names and descriptions are to be removed.. */
816
+ settingDeleteIndividualDescriptionsByShopsMask?: {
817
+ /** @description Bit mask of shop IDs. Mask for indicated store is calculated on basis of following formula: 2^(store_ID - 1). If the product should be available in more than one shop, the masks should be summed up. */
818
+ shopsMask?: number;
819
+ };
820
+ /** @description Element that specifies the mask of stores for which individual meta updated products are to be removed.. */
821
+ settingDeleteIndividualMetaByShopsMask?: {
822
+ /** @description Bit mask of shop IDs. Mask for indicated store is calculated on basis of following formula: 2^(store_ID - 1). If the product should be available in more than one shop, the masks should be summed up. */
823
+ shopsMask?: number;
824
+ };
825
+ /** @description Automatically skip adding manufacturer code and external system code in the product when adding goods if a duplicate code is encountered in other products. */
826
+ settingsSkipDuplicatedProducers?: boolean;
827
+ };
828
+ /** @description Icon and photos settings */
829
+ picturesSettings?: {
830
+ /** @description Object determines photo URL. */
831
+ picturesSettingInitialUrlPart?: string;
832
+ /** @description Object determines the method of adding photos in "pictures" object. Allowed values "base64" - photos added in base64 coding algorithm, "url" - photos added as URLs to external systems. */
833
+ picturesSettingInputType?: "base64" | "url";
834
+ /** @description Object determines the method of adding product photos. Allowed values "n" - photos are uploaded from the first free place, "y" - photos are uploaded from the first place. */
835
+ picturesSettingOverwrite?: "n" | "y";
836
+ /** @description Element determining whether or not to delete existing merchandise images. */
837
+ picturesSettingDeleteProductPictures?: "n" | "y";
838
+ /** @description Element determining whether to delete existing commodity icons. */
839
+ picturesSettingDeleteProductIcons?: "n" | "y";
840
+ /** @description Element determining whether to remove the selected icon. */
841
+ picturesSettingDeleteIcon?: "default" | "versions" | "auctions";
842
+ /** @description Element determining whether or not to create icon from the selected photo . */
843
+ picturesSettingCreateIconFromPicture?: "default" | "versions" | "auctions";
844
+ /** @description Element determining whether to restore existing original images. */
845
+ picturesSettingRestoreOriginalPictures?: "n" | "y";
846
+ /** @description Element determining the type of icon whose original is to be restored, if any. */
847
+ picturesSettingRestoreOriginalIcons?: "default" | "versions" | "auctions" | "all";
848
+ /** @description Macro ID to be applied to images on the product. */
849
+ picturesSettingApplyMacroForPictures?: number;
850
+ /** @description Macro for the selected icon. */
851
+ picturesSettingApplyMacroForIcon?: {
852
+ /** @description Icon type. */
853
+ iconType?: "default" | "versions" | "auctions";
854
+ /** @description Macro identifier. */
855
+ macroId?: number;
856
+ };
857
+ /** @description Identifier of the shop for which the action is to be performed. */
858
+ picturesSettingShopId?: string;
859
+ /** @description Identifier of an external service for which the action is to be performed on photos in the goods. */
860
+ picturesSettingServiceId?: number;
861
+ /** @description Object determines if the photo should be scaled. Allowed values "n" - no scaling allowance, "y" - scaling allowance. */
862
+ picturesSettingScaling?: "n" | "y";
863
+ /** @description Element determining whether to delete existing original images. */
864
+ picturesSettingDeleteOriginalPictures?: "n" | "y";
865
+ /** @description Element specifying the type of icon whose original is to be deleted. */
866
+ picturesSettingDeleteOriginalIcons?: "default" | "versions" | "auctions" | "all";
867
+ /** @example picturesSettingRestoreBackupPicturesAndIconsByDateTime */
868
+ picturesSettingRestoreBackupPicturesAndIconsByDateTime?: string;
869
+ };
870
+ /** @description Products list. */
871
+ products: {
872
+ /** @description Product IAI code */
873
+ productId?: number;
874
+ /** @description One of the unique, indexed product codes (IAI code / External system code / Producer code) */
875
+ productIndex?: string;
876
+ /** @description External product system code for size. */
877
+ productSizeCodeExternal?: string;
878
+ /** @description Producer code for size. */
879
+ productSizeCodeProducer?: string;
880
+ /** @description External product system code. */
881
+ productDisplayedCode?: string;
882
+ /** @description PKWiU [PCPandS]. */
883
+ productTaxCode?: string;
884
+ /** @description Number of items in package data */
885
+ productInWrapper?: number;
886
+ /** @description Sold at - for retailers. */
887
+ productSellByRetail?: number;
888
+ /** @description Sold at - for wholesalers. */
889
+ productSellByWholesale?: number;
890
+ /** @description IdoSell Category ID */
891
+ categoryIdoSellId?: number;
892
+ /** @description IdoSell Category pathname */
893
+ categoryIdoSellPath?: string;
894
+ /** @description Category id */
895
+ categoryId?: number;
896
+ /** @description Category name */
897
+ categoryName?: string;
898
+ /** @description Brand ID */
899
+ producerId?: number;
900
+ /** @description Brand name */
901
+ producerName?: string;
902
+ /** @description CN/TARIC */
903
+ cnTaricCode?: string;
904
+ /** @description Country of origin. Country code in the ISO 3166-1 A2 standard */
905
+ countryOfOrigin?: string;
906
+ /** @description Product unit of measure ID. */
907
+ unitId?: number;
908
+ /** @description ID of series, to which product belongs. */
909
+ seriesId?: number;
910
+ /** @description Name of series, to which the product belongs, visible in panel. */
911
+ seriesPanelName?: string;
912
+ /** @description Size group ID Change of one size group to another results in zeroing all stock quantities in all stocks. Change of size group can be made, if product is not present in any unhandled orders nor listed on auctions. */
913
+ sizesGroupId?: number;
914
+ /** @description Size group name. */
915
+ sizesGroupName?: string;
916
+ /** @description Optional element, that determines prices edition mode. Default value is "amount_set", when indicated element is omitted in API gate call.. Allowed values "amount_set" - sets product prices to desired value (default mode), "amount_diff" - sets sum difference between prices set (adds or subtracts entered sum from the current price), "percent_diff" - sets percentage difference between prices set (adds or subtracts entered percent from the current price). */
917
+ priceChangeMode?: string;
918
+ /** @description Gross price */
919
+ productRetailPrice?: number;
920
+ /** @description Net retail price for every shop. */
921
+ productRetailPriceNet?: number;
922
+ /** @description Wholesale price */
923
+ productWholesalePrice?: number;
924
+ /** @description Net wholesale price for every shop. */
925
+ productWholesalePriceNet?: number;
926
+ /** @description Minimal price */
927
+ productMinimalPrice?: number;
928
+ /** @description Net minimum price for every shop. */
929
+ productMinimalPriceNet?: number;
930
+ /** @description Price for automatic calculations */
931
+ productAutomaticCalculationPrice?: number;
932
+ /** @description Price for automatic net calculations for each store */
933
+ productAutomaticCalculationPriceNet?: number;
934
+ /** @description price for POS. */
935
+ productPosPrice?: number;
936
+ /** @description price for POS. */
937
+ productPosPriceNet?: number;
938
+ /** @description Recommended retail price */
939
+ productSuggestedPrice?: number;
940
+ /** @description Suggested net commodity price. */
941
+ productSuggestedPriceNet?: number;
942
+ /** @description Strikethrough gross retail price */
943
+ productStrikethroughRetailPrice?: number;
944
+ /** @description Strikethrough net retail price */
945
+ productStrikethroughRetailPriceNet?: number;
946
+ /** @description Strikethrough gross wholesale price */
947
+ productStrikethroughWholesalePrice?: number;
948
+ /** @description Strikethrough net wholesale price */
949
+ productStrikethroughWholesalePriceNet?: number;
950
+ /** @description Value of VAT */
951
+ productVat?: number;
952
+ /** @description Is product VAT free Allowed values "y" - yes, "n" - no. */
953
+ productVatFree?: string;
954
+ /** @description Different prices for price comparison websites. */
955
+ productPriceComparisonSitesPrices?: {
956
+ /** @description price comparison website ID */
957
+ priceComparisonSiteId?: number;
958
+ /** @description Price for a price comparison website in a shop */
959
+ productPriceComparisonSitePrice?: number;
960
+ /** @description Net price for price comparison service in shop */
961
+ productPriceComparisonSitePriceNet?: number;
962
+ }[];
963
+ /** @description Object determines if the product is available in POS sale Available values: "n" - no, "y" - yes. */
964
+ productEnableInPos?: string;
965
+ /** @description Required advance payment in percents */
966
+ productAdvancePrice?: number;
967
+ /** @description Annotation. */
968
+ productNote?: string;
969
+ /** @description Settings of hotspots display. */
970
+ productHotspotsZones?: {
971
+ /** @description Is attribute set */
972
+ productHotspotIsEnabled?: boolean;
973
+ /** @description Shop Id */
974
+ shopId?: number;
975
+ /** @description Promotion for shop. */
976
+ productIsPromotion?: boolean;
977
+ /** @description Discount for shop. */
978
+ productIsDiscount?: boolean;
979
+ /** @description Distinguished product in store. */
980
+ productIsDistinguished?: boolean;
981
+ /** @description Special product in store. */
982
+ productIsSpecial?: boolean;
983
+ }[];
984
+ /** @description Loyalty points. */
985
+ priceInPoints?: {
986
+ /** @description Element determines what kind of operation should be performed. Allowed values: "clients_cost" - Clients who are allowed to buy selected products for points, "clients_award" - Clients can be awarded with points for buying selected products, "count_cost" - Number of points for which the selected products will be sold, "count_award" - Number of points clients will be rewarded for buying selected products. */
987
+ priceInPointsOperation?: string;
988
+ /** @description Shop Id */
989
+ shopId?: number;
990
+ /** @description Price in points for manual points quantity configuration. Price in points will be calculated on basis of default exchange rates set for indicated store, when this value is 0. */
991
+ priceInPointsPrice?: number;
992
+ /** @description Element determines for which customers prices will be changed. Allowed values: "retailers" - Prices will be changed for retail customers, "wholesalers" - Prices will be changed for wholesale customers, "both" - Prices will be changed for both retail and wholesale customers, "nobody" - This option is available only for setting determining, which customers can buy for points. Using this value turns off possibility of granting points or buying for points for both retail and wholesale customers. */
993
+ priceInPointsClients?: string;
994
+ };
995
+ /** @description Loyalty points. */
996
+ loyaltyPoints?: {
997
+ /** @description Shop Id */
998
+ shopId?: number;
999
+ /** @description Customer type. */
1000
+ loyaltyPointsClientsType?: "retailers" | "wholesalers" | "both";
1001
+ /** @description Operation. */
1002
+ loyaltyPointsOperation?: "disablePoints" | "setDefaults" | "setPoints";
1003
+ /** @description Loyalty points type. */
1004
+ loyaltyPointsType?: "awardClient" | "chargeClient" | "both";
1005
+ /** @description Number of points. */
1006
+ numberOfLoyaltyPoints?: number;
1007
+ }[];
1008
+ /** @description Weight. */
1009
+ productWeight?: number;
1010
+ /** @description Product visibility. Allowed values "y" - product visible, "n" - product not visible. */
1011
+ productInVisible?: string;
1012
+ /** @description Bit mask of shop IDs. Mask for indicated store is calculated on basis of following formula: 2^(store_ID - 1). If the product should be available in more than one shop, the masks should be summed up. */
1013
+ shopsMask?: number;
1014
+ /** @description Complex rating Available values: "0" - no, "1" - yes. */
1015
+ productComplexNotes?: number;
1016
+ /** @description Product visibility in export to price comparison and marketplaces. Available values: "y" - Visible, "selected" - Selected, "assign_selected" - Enable the visibility of the product in the export to price comparison sites passed in the priceComparisonSites node. Price comparison sites previously assigned to the commodity will be retained, "unassign_selected" - Disable product visibility in exports to price comparison sites passed in the priceComparisonSites node, "n" - invisible. */
1017
+ productInExportToPriceComparisonSites?: "y" | "selected" | "n";
1018
+ /** @description Selection of comparison sites for which the product visibility will be changed */
1019
+ priceComparisonSites?: {
1020
+ /** @description Shop Id */
1021
+ shopId?: number;
1022
+ /** @description price comparison website ID */
1023
+ priceComparisonSiteId?: number;
1024
+ }[];
1025
+ /** @description Visibility of an item in an export to Amazon Marketplace. Available values: "y" - Visible, "selected" - Visible on selected regional services, "n" - invisible. */
1026
+ productInExportToAmazonMarketplace?: string;
1027
+ /** @description Array */
1028
+ exportToAmazonMarketplacesList?: string[];
1029
+ /** @description Export sizes to Amazon: Available values: "y" - all, "n" - leave without change. */
1030
+ exportToAmazonExportAllSizes?: "n" | "y";
1031
+ /** @description Update merchandise inventory, on the Amazon side */
1032
+ exportAmazonUpdateStocks?: "n" | "y";
1033
+ /** @description Visibility of product during the import to Strefa Marek Allegro. Allowed values: "yes" - product visible in the export to Strefa Marek Allegro, "no" - product invisible in the export to Strefa Marek Allegro. */
1034
+ productInExportToStrefaMarekAllegro?: string;
1035
+ /** @description Profile ID which should be used when sending products to Strefa Marek Allegro. */
1036
+ productInExportToSmaPreset?: number;
1037
+ /** @description Availability profile ID. */
1038
+ availableProfile?: number;
1039
+ /** @description Discount profile ID */
1040
+ productRebate?: number;
1041
+ /** @description Product warranty ID. */
1042
+ warrantyId?: number;
1043
+ /** @description Name of warranty for indicated product. */
1044
+ warrantyName?: string;
1045
+ /** @description The JavaScript formula calculating prices */
1046
+ priceFormula?: {
1047
+ /** @description Formula parameters for calculating price */
1048
+ priceFormulaParameters?: string;
1049
+ /** @description Formula function for calculating price */
1050
+ priceFormulaFunction?: string;
1051
+ };
1052
+ /** @description Size chart ID */
1053
+ sizeChartId?: number;
1054
+ /** @description Size chart name */
1055
+ sizeChartName?: string;
1056
+ /** @description Priority. Allowed values from 1 to 10. */
1057
+ productPriority?: number;
1058
+ /** @description Product priority in menu node. */
1059
+ productPriorityInMenuNodes?: {
1060
+ /** @description Menu element ID. */
1061
+ productMenuNodeId?: number;
1062
+ /** @description Priority. Allowed values from 1 to 10. */
1063
+ productPriority?: number;
1064
+ /** @description Shop Id */
1065
+ shopId?: number;
1066
+ /** @description Tree menu ID. */
1067
+ productMenuTreeId?: number;
1068
+ }[];
1069
+ /** @description Product icon link. */
1070
+ productIconLink?: string;
1071
+ /** @description Photo without background. */
1072
+ productAuctionIconLink?: string;
1073
+ /** @description Icon for a product group. */
1074
+ productGroupIconLink?: string;
1075
+ /** @description List of product photos */
1076
+ productPictures?: {
1077
+ /** @description A picture in url or base64 (depends on pictures_input_type). */
1078
+ productPictureSource?: string;
1079
+ /** @description Shop Id */
1080
+ shopId?: number;
1081
+ /** @description List of stores IDs When mask is determined, this parameter is omitted. */
1082
+ shopsIds?: number[];
1083
+ /** @description External service identifiers */
1084
+ servicesIds?: number[];
1085
+ }[];
1086
+ /** @description List of a product's photos with indication of a particular number of the photo. */
1087
+ productPicturesReplace?: {
1088
+ /** @description A product photo's number. */
1089
+ productPictureNumber?: number;
1090
+ /** @description A picture in url or base64 (depends on pictures_input_type). */
1091
+ productPictureSource?: string;
1092
+ }[];
1093
+ /** @description Reduced price */
1094
+ productPromotion?: {
1095
+ /** @description Is attribute set */
1096
+ promoteIsEnabled?: string;
1097
+ /** @description Strikethrough price */
1098
+ promoteItemNormalPrice?: number;
1099
+ /** @description Net strikethrough price. */
1100
+ promoteItemNormalPriceNet?: number;
1101
+ /** @description Strikethrough wholesale price */
1102
+ promoteItemWholesaleNormalPrice?: number;
1103
+ /** @description Net wholesale strikethrough price. */
1104
+ promoteItemWholesaleNormalPriceNet?: number;
1105
+ /** @description Switching off date */
1106
+ promoteItemEndingDate?: string;
1107
+ };
1108
+ /** @description Discount for shop. */
1109
+ productDiscount?: {
1110
+ /** @description Is attribute set */
1111
+ promoteIsEnabled?: string;
1112
+ /** @description Strikethrough price */
1113
+ promoteItemNormalPrice?: number;
1114
+ /** @description Net strikethrough price. */
1115
+ promoteItemNormalPriceNet?: number;
1116
+ /** @description Strikethrough wholesale price */
1117
+ promoteItemWholesaleNormalPrice?: number;
1118
+ /** @description Net wholesale strikethrough price. */
1119
+ promoteItemWholesaleNormalPriceNet?: number;
1120
+ /** @description Switching off date */
1121
+ promoteItemEndingDate?: string;
1122
+ };
1123
+ /** @description Distinguished product in store. */
1124
+ productDistinguished?: {
1125
+ /** @description Is attribute set */
1126
+ promoteIsEnabled?: string;
1127
+ /** @description Strikethrough price */
1128
+ promoteItemNormalPrice?: number;
1129
+ /** @description Net strikethrough price. */
1130
+ promoteItemNormalPriceNet?: number;
1131
+ /** @description Strikethrough wholesale price */
1132
+ promoteItemWholesaleNormalPrice?: number;
1133
+ /** @description Switching off date */
1134
+ promoteItemEndingDate?: string;
1135
+ /** @description Net wholesale strikethrough price. */
1136
+ promoteItemWholesaleNormalPriceNet?: number;
1137
+ };
1138
+ /** @description Special product in store. */
1139
+ productSpecial?: {
1140
+ /** @description Is attribute set */
1141
+ promoteIsEnabled?: string;
1142
+ /** @description Strikethrough price */
1143
+ promoteItemNormalPrice?: number;
1144
+ /** @description Net strikethrough price. */
1145
+ promoteItemNormalPriceNet?: number;
1146
+ /** @description Strikethrough wholesale price */
1147
+ promoteItemWholesaleNormalPrice?: number;
1148
+ /** @description Net wholesale strikethrough price. */
1149
+ promoteItemWholesaleNormalPriceNet?: number;
1150
+ /** @description Switching off date */
1151
+ promoteItemEndingDate?: string;
1152
+ };
1153
+ /** @description Parameters (distinguished). */
1154
+ productParametersDistinction?: {
1155
+ /** @description Parameter ID */
1156
+ parameterId?: number;
1157
+ /** @description Parameter name. */
1158
+ parameterName?: string;
1159
+ /** @description Parameter value ID */
1160
+ parameterValueId?: number;
1161
+ /** @description Attributes group name. */
1162
+ parameterValueName?: string;
1163
+ }[];
1164
+ /** @description Configuration parameters */
1165
+ parametersConfigurable?: {
1166
+ /** @description Parameter ID */
1167
+ parameterId?: number;
1168
+ /** @description Parameter type. Available values: "disable" - Deletion, "input" - Text field, "radio" - Single-choice field, "checkbox" - Checkbox type multiple choice list, "select" - Drop-down single choice list. */
1169
+ priceConfigurableType?: "disable" | "input" | "radio" | "checkbox" | "select";
1170
+ /** @description Price modifier value */
1171
+ priceModifierValues?: {
1172
+ /** @description Parameter ID */
1173
+ parameterId?: number;
1174
+ /** @example 1 */
1175
+ modifierValue?: number;
1176
+ /** @description Available values: "amount" - in value, "percent" - percentage */
1177
+ modifierType?: "amount" | "percent";
1178
+ }[];
1179
+ }[];
1180
+ /** @description List of products recommended with this product */
1181
+ associatedProducts?: {
1182
+ /** @description Recommended product ID */
1183
+ associatedProductId?: number;
1184
+ /** @description Recommended product name */
1185
+ associatedProductName?: string;
1186
+ /** @description Recommended product code. External system code. */
1187
+ associatedProductCode?: string;
1188
+ }[];
1189
+ /** @description Sizes available for products data. */
1190
+ productSizes?: {
1191
+ /** @description Size identifier */
1192
+ sizeId?: string;
1193
+ /** @description Size name */
1194
+ sizePanelName?: string;
1195
+ /** @description Weight. */
1196
+ productWeight?: number;
1197
+ /** @description Net weight. */
1198
+ productWeightNet?: number;
1199
+ /** @description Last gross purchase price */
1200
+ productPurchasePriceGrossLast?: number;
1201
+ /** @description Last net purchase price */
1202
+ productPurchasePriceNetLast?: number;
1203
+ /** @description External product system code for size. */
1204
+ productSizeCodeExternal?: string;
1205
+ /** @description Product stock quantity data. */
1206
+ productStocksData?: {
1207
+ /** @description Stocks data */
1208
+ productStocksQuantities?: {
1209
+ /** @description Stock ID */
1210
+ stockId?: number;
1211
+ /** Format: decimal
1212
+ * @description Product stock quantity */
1213
+ productSizeQuantity?: number;
1214
+ /** Format: decimal
1215
+ * @description Product quantity to add up */
1216
+ productSizeQuantityToAdd?: number;
1217
+ /** Format: decimal
1218
+ * @description Product quantity to subtract */
1219
+ productSizeQuantityToSubstract?: number;
1220
+ /** @description Warehouse location ID */
1221
+ stockLocationId?: number;
1222
+ /** @description Warehouse location full path */
1223
+ stockLocationTextId?: string;
1224
+ /** @description Storage location code */
1225
+ stockLocationCode?: string;
1226
+ /** @description Additional locations */
1227
+ stockAdditionalLocations?: {
1228
+ /** @description Element specifying the modification mode for additional locations. Available values: "add" - assignment of additional product location, "remove" - Remove the assignment of an additional location to the product. */
1229
+ stockAdditionalLocationSettings?: "add" | "remove";
1230
+ /** @description Warehouse location ID */
1231
+ stockAdditionalLocationId?: number;
1232
+ /** @description Warehouse location full path */
1233
+ stockAdditionalLocationTextId?: string;
1234
+ /** @description Storage location code */
1235
+ stockAdditionalLocationCode?: string;
1236
+ }[];
1237
+ }[];
1238
+ };
1239
+ /** @description Producer code for size. */
1240
+ productSizeCodeProducer?: string;
1241
+ /** @description Supplier code */
1242
+ productSizeCodeDeliverer?: string;
1243
+ }[];
1244
+ /** @description Product attachments list. */
1245
+ attachments?: {
1246
+ /** @description Attachment file link. */
1247
+ attachmentUrl?: string;
1248
+ /** @description Attachment name. */
1249
+ attachmentName?: {
1250
+ /** @description List of languages. */
1251
+ attachmentLanguages?: {
1252
+ /** @description Language ID */
1253
+ langId?: string;
1254
+ /** @description Language name */
1255
+ langName?: string;
1256
+ /** @description Literal in selected language. */
1257
+ langValue?: string;
1258
+ }[];
1259
+ };
1260
+ /** @description File type: audio, video, doc, other. */
1261
+ attachmentFileType?: "audio" | "video" | "doc" | "other" | "image";
1262
+ /** @description Type of customer, attachment should be available for: 'all','ordered','wholesaler','wholesaler_or_ordered','wholesaler_and_ordered'. */
1263
+ attachmentEnable?: "all" | "only_logged" | "ordered" | "wholesaler" | "wholesaler_or_orderer" | "wholesaler_and_ordered";
1264
+ /** @description Attachment ID. */
1265
+ attachmentId?: number;
1266
+ /** @description Attachment downloads record. */
1267
+ attachmentDownloadLog?: "y" | "n";
1268
+ /** @description Attachment file extension. */
1269
+ attachmentFileExtension?: string;
1270
+ /** @description Attachment number. */
1271
+ attachmentPriority?: number;
1272
+ /** @description Attachment document types list. */
1273
+ documentTypes?: {
1274
+ /** @description Document type. */
1275
+ documentType?: "energy_label" | "instruction_with_safety_information" | "user_manual" | "installation_instructions" | "product_card" | "guide" | "others";
1276
+ /** @description Additional description. */
1277
+ description?: string;
1278
+ }[];
1279
+ }[];
1280
+ /** @description The list of attachments to be deleted. */
1281
+ removeAttachments?: {
1282
+ /** @description Language ID */
1283
+ langId?: string;
1284
+ }[];
1285
+ /** @description Do you want to delete attachments for digital files. */
1286
+ virtualAttachmentsToRemove?: boolean;
1287
+ /** @description List of product's virtual attachments. */
1288
+ virtualAttachments?: {
1289
+ /** @description Attachment file link. */
1290
+ attachmentUrl?: string;
1291
+ /** @description Attachment name. */
1292
+ attachmentName?: {
1293
+ /** @description List of languages. */
1294
+ attachmentLanguages?: {
1295
+ /** @description Language ID */
1296
+ langId?: string;
1297
+ /** @description Language name */
1298
+ langName?: string;
1299
+ /** @description Literal in selected language. */
1300
+ langValue?: string;
1301
+ }[];
1302
+ };
1303
+ /** @description Full version or sample. */
1304
+ attachmentType?: "full" | "demo";
1305
+ /** @description Number of attachment downloads limit. */
1306
+ attachmentLimits?: {
1307
+ /** @description Number of downloads limit. */
1308
+ arrachmentDownloadsLimit?: number;
1309
+ /** @description Number of days file should be available. */
1310
+ arrachmentDaysLimit?: number;
1311
+ };
1312
+ /** @description Attachment ID. */
1313
+ attachmentId?: number;
1314
+ /** @description Attachment number. */
1315
+ attachmentPriority?: number;
1316
+ }[];
1317
+ /** @description Operation, that will be performed on attachments to product. */
1318
+ attachmentOperationValues?: "edit" | "add" | "remove";
1319
+ /** @description Data concerning attributes dependent on indicated stores with particular product assigned. */
1320
+ productShopsAttributes?: {
1321
+ /** @description Product visibility in store. */
1322
+ shopInVisible?: "y" | "n";
1323
+ /** @description Shop Id */
1324
+ shopId?: number;
1325
+ /** @description Prices for marketplaces */
1326
+ productAuctionsPrices?: {
1327
+ /** @description Auction site ID */
1328
+ auctionId?: number;
1329
+ /** @description Cost price. */
1330
+ auctionPrice?: number;
1331
+ /** @description Auction site page ID */
1332
+ auctionSiteId?: number;
1333
+ /** @description Size identifier */
1334
+ sizeId?: string;
1335
+ /** @description Auction starting price */
1336
+ auctionStartPrice?: number;
1337
+ /** @description Auction starting price net */
1338
+ auctionStartPriceNet?: number;
1339
+ /** @description "Buy It Now" price */
1340
+ auctionBuyNowPrice?: number;
1341
+ /** @description Kup Teraz price net. */
1342
+ auctionBuyNowPriceNet?: number;
1343
+ /** @description Minimal price */
1344
+ auctionMinimalPrice?: number;
1345
+ /** @description Minimal net price */
1346
+ auctionMinimalPriceNet?: number;
1347
+ /** @description Currency ID */
1348
+ currencyId?: string;
1349
+ /** @description External product system code for size. */
1350
+ productSizeCodeExternal?: string;
1351
+ /** @description Size name */
1352
+ sizePanelName?: string;
1353
+ }[];
1354
+ shopPriceComparersPrices?: {
1355
+ /** @description price comparison website ID */
1356
+ priceComparisonSiteId?: number;
1357
+ /** @description Price for a price comparison website in a shop */
1358
+ productPriceComparisonSitePrice?: number;
1359
+ /** @description Net price for price comparison service in shop */
1360
+ productPriceComparisonSitePriceNet?: number;
1361
+ /** @description Percentage difference between the price comparison website and the shop */
1362
+ productPriceComparisonSitePercentDiff?: number;
1363
+ /** @description Forced rounding up method. */
1364
+ priceRoundMode?: "none" | "00" | "x0" | "99" | "x9";
1365
+ }[];
1366
+ /** @description Gross price */
1367
+ productRetailPrice?: number;
1368
+ /** @description Net retail price for every shop. */
1369
+ productRetailPriceNet?: number;
1370
+ /** @description Wholesale price */
1371
+ productWholesalePrice?: number;
1372
+ /** @description Net wholesale price for every shop. */
1373
+ productWholesalePriceNet?: number;
1374
+ /** @description Minimal price */
1375
+ productMinimalPrice?: number;
1376
+ /** @description Net minimum price for every shop. */
1377
+ productMinimalPriceNet?: number;
1378
+ /** @description Price settings, possible values: "wholesale_equals_retail" - Wholesale price same as retail price, "wholesale_notequals_retail" - Wholesale price different than retail price, "all_prices_equals_zero" - All prices request a quote by phone, "retail_price_equals_zero" - Retail price on call, "default_prices" - default prices, "retail_equals_suggested" - Retail price is the same as recommended one, "automatically_calculated" - Price calculated automatically. */
1379
+ productPricesConfig?: "default_prices" | "wholesale_equals_retail" | "wholesale_notequals_retail" | "all_prices_equals_zero" | "retail_price_equals_zero" | "retail_equals_suggested" | "automatically_calculated" | "sizes_price_as_base_price";
1380
+ /** @description Recommended retail price */
1381
+ productSuggestedPrice?: number;
1382
+ /** @description Suggested net commodity price. */
1383
+ productSuggestedPriceNet?: number;
1384
+ /** @description Strikethrough gross retail price */
1385
+ productStrikethroughRetailPrice?: number;
1386
+ /** @description Strikethrough net retail price */
1387
+ productStrikethroughRetailPriceNet?: number;
1388
+ /** @description Strikethrough gross wholesale price */
1389
+ productStrikethroughWholesalePrice?: number;
1390
+ /** @description Strikethrough net wholesale price */
1391
+ productStrikethroughWholesalePriceNet?: number;
1392
+ /** @description Configuration details for setting of parameter prices_config=default_prices. */
1393
+ productConfigPricesDefaultShop?: number;
1394
+ /** @description Forced rounding up method. */
1395
+ priceRoundMode?: "none" | "00" | "x0" | "99" | "x9";
1396
+ /** @description Configuration details for setting of parameter prices_config=automatically_calculated. */
1397
+ productPricesConfigAutomatonDetails?: {
1398
+ /** @description Price name, one of values: retail, wholsale, minimal. */
1399
+ priceAutomatonPriceName?: "retail" | "wholesale" | "minimal" | "automatic_calculation";
1400
+ /** @description Price setting, one of values: own, last_purchased, avarage_purchased, retail, wholsale, minimal */
1401
+ priceAutomatonPriceSettings?: "own" | "last_purchased" | "avarage_purchased" | "retail" | "wholesale" | "minimal" | "automatic_calculation";
1402
+ /** @description Price type, one of values: gross, net */
1403
+ priceAutomatonPriceType?: "gross" | "net";
1404
+ /** @description Final amount */
1405
+ priceAutomatonPriceValue?: number;
1406
+ /** @description Final amount currency */
1407
+ priceAutomatonPriceCurrencyId?: string;
1408
+ /** @description shop ID from which price is retrieved */
1409
+ priceAutomatonPriceShop?: number;
1410
+ /** @description Amount margin */
1411
+ priceAutomatonMarginCurrencyValue?: number;
1412
+ /** @description Amount margin currency */
1413
+ priceAutomatonMarginCurrencyId?: string;
1414
+ /** @description Percentage margin */
1415
+ priceAutomatonMarginPercentValue?: number;
1416
+ /** @description Minimal value of percentage margin */
1417
+ priceAutomatonPricePercentMinimalValue?: number;
1418
+ /** @description Minimal value of percentage margin currency */
1419
+ priceAutomatonPricePercentMinimalCurrencyId?: string;
1420
+ /** @description Minimal amount with margins reflected */
1421
+ priceAutomatonPriceMinimalValue?: number;
1422
+ /** @description Minimal amount currency */
1423
+ priceAutomatonPriceMinimalCurrencyId?: string;
1424
+ /** @description Decimal complement should contain 0 to 2 digits. If it contains 0 digits, the system will calculate the amount with precision of up to 2 decimal places. If it contains 2 digits, the system will calculate the amount with precision of the total number and will add the value of this field as a decimal part of this amount */
1425
+ priceAutomatonDecimalRoundValue?: string;
1426
+ }[];
1427
+ /** @description Parameters set for auction sites */
1428
+ productAuctions?: {
1429
+ /** @description Auction site ID */
1430
+ auctionId?: number;
1431
+ /** @description Auction site page ID */
1432
+ auctionSiteId?: number;
1433
+ /** @description Price settings, possible values: "manual" - Price entered manually, "automatically_calculated" - Price calculated automatically. */
1434
+ auctionPricesConfig?: "manual" | "automatically_calculated";
1435
+ /** @description Configuration details for setting of parameter prices_config=automatically_calculated */
1436
+ auctionPricesConfigAutomatonDetails?: {
1437
+ /** @description Price name, one of values: buy_now, start, minimal_auction */
1438
+ auctionPriceAutomatonPriceName?: "buy_now" | "start" | "minimal_auction";
1439
+ /** @description Price setting, one of values: own, last_purchased, avarage_purchased, retail, wholsale, minimal, buy_now, start, minimal_auction. */
1440
+ auctionPriceAutomatonPriceSettings?: "own" | "last_purchased" | "avarage_purchased" | "retail" | "wholesale" | "minimal" | "automatic_calculation" | "buy_now" | "start" | "minimal_auction";
1441
+ /** @description Price type, one of values: gross, net */
1442
+ priceAutomatonPriceType?: "gross" | "net";
1443
+ /** @description Final amount */
1444
+ priceAutomatonPriceValue?: number;
1445
+ /** @description Final amount currency */
1446
+ priceAutomatonPriceCurrencyId?: string;
1447
+ /** @description shop ID from which price is retrieved */
1448
+ priceAutomatonPriceShop?: number;
1449
+ /** @description Amount margin */
1450
+ priceAutomatonMarginCurrencyValue?: number;
1451
+ /** @description Amount margin currency */
1452
+ priceAutomatonMarginCurrencyId?: string;
1453
+ /** @description Percentage margin */
1454
+ priceAutomatonMarginPercentValue?: number;
1455
+ /** @description Minimal value of percentage margin */
1456
+ priceAutomatonPricePercentMinimalValue?: number;
1457
+ /** @description Minimal value of percentage margin currency */
1458
+ priceAutomatonPricePercentMinimalCurrencyId?: string;
1459
+ /** @description Minimal amount with margins reflected */
1460
+ priceAutomatonPriceMinimalValue?: number;
1461
+ /** @description Minimal amount currency */
1462
+ priceAutomatonPriceMinimalCurrencyId?: string;
1463
+ /** @description Decimal complement should contain 0 to 2 digits. If it contains 0 digits, the system will calculate the amount with precision of up to 2 decimal places. If it contains 2 digits, the system will calculate the amount with precision of the total number and will add the value of this field as a decimal part of this amount */
1464
+ priceAutomatonDecimalRoundValue?: string;
1465
+ }[];
1466
+ /** @description Parameters for sizes */
1467
+ productAuctionsSizes?: {
1468
+ /** @description Size identifier */
1469
+ sizeId?: string;
1470
+ /** @description Size name */
1471
+ sizePanelName?: string;
1472
+ /** @description Configuration details for setting of parameter prices_config=automatically_calculated */
1473
+ auctionPricesConfigAutomatonDetails?: {
1474
+ /** @description Price name, one of values: buy_now, start, minimal_auction */
1475
+ auctionPriceAutomatonPriceName?: "buy_now" | "start" | "minimal_auction";
1476
+ /** @description Price setting, one of values: own, last_purchased, avarage_purchased, retail, wholsale, minimal, buy_now, start, minimal_auction. */
1477
+ auctionPriceAutomatonPriceSettings?: "own" | "last_purchased" | "avarage_purchased" | "retail" | "wholesale" | "minimal" | "buy_now" | "start" | "minimal_auction" | "automatic_calculation";
1478
+ /** @description Price type, one of values: gross, net */
1479
+ priceAutomatonPriceType?: "gross" | "net";
1480
+ /** @description Final amount */
1481
+ priceAutomatonPriceValue?: number;
1482
+ /** @description Final amount currency */
1483
+ priceAutomatonPriceCurrencyId?: string;
1484
+ /** @description shop ID from which price is retrieved */
1485
+ priceAutomatonPriceShop?: number;
1486
+ /** @description Amount margin */
1487
+ priceAutomatonMarginCurrencyValue?: number;
1488
+ /** @description Amount margin currency */
1489
+ priceAutomatonMarginCurrencyId?: string;
1490
+ /** @description Percentage margin */
1491
+ priceAutomatonMarginPercentValue?: number;
1492
+ /** @description Minimal value of percentage margin */
1493
+ priceAutomatonPricePercentMinimalValue?: number;
1494
+ /** @description Minimal value of percentage margin currency */
1495
+ priceAutomatonPricePercentMinimalCurrencyId?: string;
1496
+ /** @description Minimal amount with margins reflected */
1497
+ priceAutomatonPriceMinimalValue?: number;
1498
+ /** @description Minimal amount currency */
1499
+ priceAutomatonPriceMinimalCurrencyId?: string;
1500
+ /** @description Decimal complement should contain 0 to 2 digits. If it contains 0 digits, the system will calculate the amount with precision of up to 2 decimal places. If it contains 2 digits, the system will calculate the amount with precision of the total number and will add the value of this field as a decimal part of this amount */
1501
+ priceAutomatonDecimalRoundValue?: string;
1502
+ }[];
1503
+ }[];
1504
+ }[];
1505
+ /** @description Set the same price for auction sites as in store. */
1506
+ setTheSamePriceForAuctionAsInStore?: boolean;
1507
+ /** @description Parameters set for price comparison websites */
1508
+ productShopPriceComparisonSites?: {
1509
+ /** @description price comparison website ID */
1510
+ priceComparisonSiteId?: number;
1511
+ /** @description price comparison website name */
1512
+ priceComparisonSiteName?: string;
1513
+ /** @description Price settings, possible values: "manual" - Price entered manually, "automatically_calculated" - Price calculated automatically. */
1514
+ priceComparisonSitePricesConfig?: "manual" | "automatically_calculated";
1515
+ /** @description Configuration details for setting of parameter prices_config=automatically_calculated */
1516
+ priceComparisonSitePriceConfigAutomatonDetails?: {
1517
+ /** @description Price setting, one of values: own, last_purchased, avarage_purchased, retail, wholsale, minimal */
1518
+ priceAutomatonPriceSettings?: "own" | "last_purchased" | "avarage_purchased" | "retail" | "wholesale" | "minimal";
1519
+ /** @description Price type, one of values: gross, net */
1520
+ priceAutomatonPriceType?: "gross" | "net";
1521
+ /** @description Final amount */
1522
+ priceAutomatonPriceValue?: number;
1523
+ /** @description Final amount currency */
1524
+ priceAutomatonPriceCurrencyId?: string;
1525
+ /** @description shop ID from which price is retrieved */
1526
+ priceAutomatonPriceShop?: number;
1527
+ /** @description Amount margin */
1528
+ priceAutomatonMarginCurrencyValue?: number;
1529
+ /** @description Amount margin currency */
1530
+ priceAutomatonMarginCurrencyId?: string;
1531
+ /** @description Percentage margin */
1532
+ priceAutomatonMarginPercentValue?: number;
1533
+ /** @description Minimal value of percentage margin */
1534
+ priceAutomatonPricePercentMinimalValue?: number;
1535
+ /** @description Minimal value of percentage margin currency */
1536
+ priceAutomatonPricePercentMinimalCurrencyId?: string;
1537
+ /** @description Minimal amount with margins reflected */
1538
+ priceAutomatonPriceMinimalValue?: number;
1539
+ /** @description Minimal amount currency */
1540
+ priceAutomatonPriceMinimalCurrencyId?: string;
1541
+ /** @description Decimal complement should contain 0 to 2 digits. If it contains 0 digits, the system will calculate the amount with precision of up to 2 decimal places. If it contains 2 digits, the system will calculate the amount with precision of the total number and will add the value of this field as a decimal part of this amount */
1542
+ priceAutomatonDecimalRoundValue?: string;
1543
+ };
1544
+ }[];
1545
+ }[];
1546
+ /** @description Products subscription settings. */
1547
+ subscription?: {
1548
+ /** @description Shop Id */
1549
+ shopId?: number;
1550
+ /** @description Is subscription enabled for product */
1551
+ enabled?: boolean;
1552
+ /** @description Days in period */
1553
+ daysInPeriod?: number[];
1554
+ /** @description Sold at - for retailers. */
1555
+ unitsNumberRetail?: number;
1556
+ /** @description Sold at - for wholesalers. */
1557
+ unitsNumberWholesale?: number;
1558
+ }[];
1559
+ /** @description Product name. */
1560
+ productNames?: {
1561
+ productNamesLangData?: {
1562
+ /** @description Language ID */
1563
+ langId?: string;
1564
+ /** @description Product name. */
1565
+ productName?: string;
1566
+ /** @description Shop Id */
1567
+ shopId?: number;
1568
+ /** @description External service identifier */
1569
+ serviceId?: number;
1570
+ }[];
1571
+ };
1572
+ /** @description DEPRECATED. This parameter is deprecated. Product name for online auctions. */
1573
+ productNamesInAuction?: {
1574
+ productNamesInAuctionLangData?: {
1575
+ /** @description Language ID */
1576
+ langId?: string;
1577
+ /** @example productNameInAuction */
1578
+ productNameInAuction?: string;
1579
+ }[];
1580
+ };
1581
+ /** @description Product name for price comparison websites. */
1582
+ productNamesInPriceComparer?: {
1583
+ productNamesInPriceComparerLangData?: {
1584
+ /** @description Language ID */
1585
+ langId?: string;
1586
+ /** @description Product name for price comparison websites. */
1587
+ productNameInPriceComparer?: string;
1588
+ }[];
1589
+ };
1590
+ /** @description Product short description */
1591
+ productParamDescriptions?: {
1592
+ productParamDescriptionsLangData?: {
1593
+ /** @description Language ID */
1594
+ langId?: string;
1595
+ /** @description Product short description */
1596
+ productParamDescriptions?: string;
1597
+ /** @description Shop Id */
1598
+ shopId?: number;
1599
+ /** @description External service identifier */
1600
+ serviceId?: number;
1601
+ }[];
1602
+ };
1603
+ /** @description Long product description */
1604
+ productLongDescriptions?: {
1605
+ productLongDescriptionsLangData?: {
1606
+ /** @description Language ID */
1607
+ langId?: string;
1608
+ /** @description Long product description. */
1609
+ productLongDescription?: string;
1610
+ /** @description Shop Id */
1611
+ shopId?: number;
1612
+ /** @description External service identifier */
1613
+ serviceId?: number;
1614
+ }[];
1615
+ };
1616
+ /** @description DEPRECATED. This parameter is deprecated. Product description for marketplaces. */
1617
+ productLongDescriptionsInAuction?: {
1618
+ productLongDescriptionsInAuctionLangData?: {
1619
+ /** @description Language ID */
1620
+ langId?: string;
1621
+ /** @example productLongDescriptionInAuction */
1622
+ productLongDescriptionInAuction?: string;
1623
+ }[];
1624
+ };
1625
+ /** @description Product data for auction services */
1626
+ productAuctionDescriptionsData?: {
1627
+ /** @description Auction system ID */
1628
+ productAuctionId?: string;
1629
+ /** @description Auction site ID */
1630
+ productAuctionSiteId?: string;
1631
+ /** @description Product name for auction service. */
1632
+ productAuctionName?: string;
1633
+ /** @description Subtitle for auction service */
1634
+ productAuctionAdditionalName?: string;
1635
+ /** @description Product description for marketplaces */
1636
+ productAuctionDescription?: string;
1637
+ }[];
1638
+ /** @description Product meta title */
1639
+ productMetaTitles?: {
1640
+ productMetaTitlesLangData?: {
1641
+ /** @description Shop Id */
1642
+ shopId?: number;
1643
+ /** @description Language ID */
1644
+ langId?: string;
1645
+ /** @description Language name */
1646
+ langName?: string;
1647
+ /** @description Product meta title. */
1648
+ productMetaTitle?: string;
1649
+ }[];
1650
+ };
1651
+ /** @description Product meta description */
1652
+ productMetaDescriptions?: {
1653
+ productMetaDescriptionsLangData?: {
1654
+ /** @description Shop Id */
1655
+ shopId?: number;
1656
+ /** @description Language ID */
1657
+ langId?: string;
1658
+ /** @description Language name */
1659
+ langName?: string;
1660
+ /** @description Product meta description. */
1661
+ productMetaDescription?: string;
1662
+ }[];
1663
+ };
1664
+ /** @description Product meta keywords. */
1665
+ productMetaKeywords?: {
1666
+ productMetaKeywordsLangData?: {
1667
+ /** @description Shop Id */
1668
+ shopId?: number;
1669
+ /** @description Language ID */
1670
+ langId?: string;
1671
+ /** @description Language name */
1672
+ langName?: string;
1673
+ /** @description Product meta keywords. */
1674
+ productMetaKeyword?: string;
1675
+ }[];
1676
+ };
1677
+ /** @description URL for the product */
1678
+ productUrl?: {
1679
+ productUrlsLangData?: {
1680
+ /** @description Shop Id */
1681
+ shopId?: number;
1682
+ /** @description Language ID */
1683
+ langId?: string;
1684
+ /** @example url */
1685
+ url?: string;
1686
+ }[];
1687
+ };
1688
+ /** @description Data on product groups (variants) */
1689
+ productVersion?: {
1690
+ /** @description ID of the main item (variant) in the group. */
1691
+ versionParent?: {
1692
+ /** @description Value. */
1693
+ versionParentId?: string;
1694
+ /** @description Identifier type. */
1695
+ versionParentType?: "id" | "codeExtern" | "codeProducer";
1696
+ };
1697
+ /** @description The order of products in the group. Value needs to be more than 0. */
1698
+ versionPriority?: number;
1699
+ /** @description Settings for groups of items (variants) */
1700
+ versionSettings?: {
1701
+ /** @description Show in shop. Available values: "y" - all products from group, "n" - only the first product from group. */
1702
+ versionDisplayAllInShop?: string;
1703
+ /** @description Show in panel. Available values: "y" - wszystkie towary z grupy, "n" - only the first product from group. */
1704
+ versionDisplayAllInPanel?: string;
1705
+ /** @description Adding the canonical links to the site. Available values: "y" - on, "n" - Off. */
1706
+ versionDisplayRelCanonicalInShop?: string;
1707
+ /** @description The same code. Available values: "y" - yes, "n" - no. */
1708
+ versionCommonCode?: string;
1709
+ /** @description The same brand. Available values: "y" - yes, "n" - no. */
1710
+ versionCommonProducer?: string;
1711
+ /** @description The same annotation. Available values: "y" - yes, "n" - no. */
1712
+ versionCommonNote?: string;
1713
+ /** @description The same warranty. Available values: "y" - yes, "n" - no. */
1714
+ versionCommonWarranty?: string;
1715
+ /** @description The same for size chart. Available values: "y" - yes, "n" - no. */
1716
+ versionCommonSizesChart?: string;
1717
+ /** @description The same series. Available values: "y" - yes, "n" - no. */
1718
+ versionCommonSeries?: string;
1719
+ /** @description The same category. Available values: "y" - yes, "n" - no. */
1720
+ versionCommonCategory?: string;
1721
+ /** @description The same price. Available values: "y" - yes, "n" - no. */
1722
+ versionCommonPrice?: string;
1723
+ /** @description Same advance. Available values: "y" - yes, "n" - no. */
1724
+ versionCommonAdvance?: string;
1725
+ /** @description Same quantity discount. Available values: "y" - yes, "n" - no. */
1726
+ versionCommonRebate?: string;
1727
+ /** @description the same VAT rate. Available values: "y" - yes, "n" - no. */
1728
+ versionCommonVat?: string;
1729
+ /** @description The same loyalty points. Available values: "y" - yes, "n" - no. */
1730
+ versionCommonProfitPoints?: string;
1731
+ /** @description The same related product. Available values: "y" - yes, "n" - no. */
1732
+ versionCommonAssociated?: string;
1733
+ /** @description The same visibility. Available values: "y" - yes, "n" - no. */
1734
+ versionCommonVisibility?: string;
1735
+ /** @description The same priority. Available values: "y" - yes, "n" - no. */
1736
+ versionCommonPriority?: string;
1737
+ /** @description The same shops. Available values: "y" - yes, "n" - no. */
1738
+ versionCommonShops?: string;
1739
+ /** @description The same sizes. Available values: "y" - yes, "n" - no. */
1740
+ versionCommonSizes?: string;
1741
+ /** @description The same weight. Available values: "y" - yes, "n" - no. */
1742
+ versionCommonWeight?: string;
1743
+ /** @description The same name. Available values: "y" - yes, "n" - no. */
1744
+ versionCommonName?: string;
1745
+ /** @description The same product's name for Internet auctions. Available values: "y" - yes, "n" - no. */
1746
+ versionCommonAuctionName?: string;
1747
+ /** @description The same short description. Available values: "y" - yes, "n" - no. */
1748
+ versionCommonDescription?: string;
1749
+ /** @description The same long description. Available values: "y" - yes, "n" - no. */
1750
+ versionCommonLongDescription?: string;
1751
+ /** @description The same icon. Available values: "y" - yes, "n" - no. */
1752
+ versionCommonIcon?: string;
1753
+ /** @description The same large photos. Available values: "y" - yes, "n" - no. */
1754
+ versionCommonPhotos?: string;
1755
+ /** @description The same availability profile. Available values: "y" - yes, "n" - no. */
1756
+ versionCommonAvailableProfile?: string;
1757
+ /** @description The same complex rating. Available values: "y" - yes, "n" - no. */
1758
+ versionCommonComplexNotes?: string;
1759
+ /** @description Do You wish to sum up the products in the basket as a one order? Available values: "y" - yes, "n" - no. */
1760
+ versionCommonSumInBasket?: string;
1761
+ /** @description The same objects in menu Available values: "y" - yes, "n" - no. */
1762
+ versionCommonMenuItems?: string;
1763
+ /** @description The same supplier. Available values: "y" - yes, "n" - no. */
1764
+ versionCommonDeliverer?: string;
1765
+ /** @description The same attachments Available values: "y" - yes, "n" - no. */
1766
+ versionCommonAttachments?: string;
1767
+ /** @description The same icons for auctions Available values: "y" - yes, "n" - no. */
1768
+ versionCommonAuctionIcon?: string;
1769
+ /** @description The same serial numbers Available values: "y" - yes, "n" - no. */
1770
+ versionCommonSerialNumbers?: string;
1771
+ /** @description The same parameters. possible values "y" - yes, "n" - no. */
1772
+ versionCommonDictionary?: string;
1773
+ /** @description Same promotions Available values: "y" - yes, "n" - no. */
1774
+ versionCommonPromotions?: string;
1775
+ /** @description The same meta settings Available values: "y" - yes, "n" - no. */
1776
+ versionCommonMetaTags?: string;
1777
+ /** @description The same currency. Available values: "y" - yes, "n" - no. */
1778
+ versionCommonCurrency?: string;
1779
+ /** @description The same formula for calculating prices Available values: "y" - yes, "n" - no. */
1780
+ versionCommonPriceFormula?: string;
1781
+ /** @description The same JavaScript displayed on the product card Available values: "y" - yes, "n" - no. */
1782
+ versionCommonJavaScriptOnCard?: string;
1783
+ };
1784
+ /** @description Parameter value names */
1785
+ versionNames?: {
1786
+ /** @description Array of languages, values are displayed in. */
1787
+ versionNamesLangData?: {
1788
+ /** @description Language ID */
1789
+ langId?: string;
1790
+ /** @description Name of the parameter value, e.g. orange, green, red */
1791
+ versionName?: string;
1792
+ }[];
1793
+ };
1794
+ /** @description Parameter names */
1795
+ versionGroupNames?: {
1796
+ /** @description Parameter name */
1797
+ versionGroupNamesLangData?: {
1798
+ /** @description Language ID */
1799
+ langId?: string;
1800
+ /** @description Parameter name, e.g. color, width */
1801
+ versionGroupName?: string;
1802
+ }[];
1803
+ };
1804
+ };
1805
+ /** @description Currency ID */
1806
+ currencyId?: string;
1807
+ /** @description Currency, in which product prices are stored. */
1808
+ productCurrenciesShops?: {
1809
+ /** @description Shop Id */
1810
+ shopId?: number;
1811
+ /** @description Currency ID */
1812
+ currencyId?: string;
1813
+ }[];
1814
+ /** @description Supplier ID. */
1815
+ delivererId?: number;
1816
+ /** @description Supplier name. */
1817
+ delivererName?: string;
1818
+ /** @description This parameter is optional and it determines properties edition mode. Default value is "replace". Allowed values: "add" - adds properties to already existent ones, "delete" - removes properties of already existent ones, "delete_group" - removes properties from selected group, "replace" - overwrites properties already existent with new ones (default mode). */
1819
+ productParametersDistinctionChangeMode?: "add" | "delete" | "delete_group" | "replace";
1820
+ /** @description Product delivery time from the producer to the shop */
1821
+ productDeliveryTime?: {
1822
+ /** @description Operation type: "product" - sets own product delivery time, "deliverer" - sets product delivery time exactly the same as deliverer's. */
1823
+ productDeliveryTimeChangeMode?: "product" | "deliverer";
1824
+ /** @description The amount of time it takes to get goods from the supplier to the store. The maximum time is 99 for the unit "days" or 999 for the unit "hours" and "minutes" */
1825
+ productDeliveryTimeValue?: number;
1826
+ /** @description Determine the type of time it takes to get goods from supplier to store */
1827
+ productDeliveryTimeType?: "immediately" | "minutes" | "hours" | "upTo24h" | "workingDays" | "notKnown";
1828
+ };
1829
+ /** @description Parameters. */
1830
+ productParameters?: {
1831
+ /** @description "add_parameter" - assigning element to product, "delete_parameter" - removing element from product. */
1832
+ productParameterOperation?: "add_parameter" | "delete_parameter";
1833
+ /** @description Parameter ID */
1834
+ productParameterId?: number;
1835
+ /** @description Determines where the parameter will be added. If no value is specified, the parameter will be placed at the end of the list. If a value of e.g. 5 is set, the value of all priorities >= 5 will be increased by 1 to provide a unique priority value. */
1836
+ productParameterPriority?: number;
1837
+ /** @description Allows to enter parameter name i multiple languages at the same time. If it is used, item_textid and lang_id are ingored. */
1838
+ productParameterTextIdsLangData?: {
1839
+ /** @description Language ID */
1840
+ langId?: string;
1841
+ /** @description Parameter ID. */
1842
+ productParameterTextId?: string;
1843
+ }[];
1844
+ /** @description Language ID */
1845
+ langId?: string;
1846
+ /** @description Parameters descriptions in indicated language versions. */
1847
+ productParametersDescriptionsLangData?: {
1848
+ /** @description Language ID */
1849
+ langId?: string;
1850
+ /** @description Parameter description */
1851
+ productParametersDescription?: string;
1852
+ }[];
1853
+ }[];
1854
+ clearProductParameters?: boolean;
1855
+ /** @description Change parameter distinction. */
1856
+ changeParametersDistinction?: {
1857
+ /** @description Parameter ID */
1858
+ productParameterId?: number;
1859
+ /** @description Parameter name (if ID was not used). */
1860
+ productParameterTextIdent?: string;
1861
+ /** @description Language ID */
1862
+ langId?: string;
1863
+ /** @description Available values: distinction - Set as distinguished on product card, list of products (distinguished), projector_hide - Set as hidden on list of parameters on product card, group_distinction - Set as parameter differentiating products in group (nieaktywne), auction_template_hide - Hidden for a variable [iai:product_parameters] in auction templates . */
1864
+ productParameterDescriptionType?: "distinction" | "group_distinction" | "projector_hide" | "auction_template_hide";
1865
+ /** @description Value. Allowed values: "y" "n" */
1866
+ parameterDistinctionValue?: "y" | "n";
1867
+ }[];
1868
+ /** @description VAT rate change mode:. "change_gross" - changes the product gross price, leaving the net price unchanged, "change_net" - changes the net price, leaving the gross price unchanged (default mode). */
1869
+ productPriceVatChangeMode?: "change_net" | "change_gross";
1870
+ /** @description An array of menu elements */
1871
+ productMenuItems?: {
1872
+ /** @description Menu element operation type. Available values. - add_product - assigns a product to the menu element. - delete_product - removes a product from the menu element. */
1873
+ productMenuOperation?: "add_product" | "delete_product";
1874
+ /** @description ID of the menu node to which the product is to be assigned */
1875
+ menuItemId?: number;
1876
+ /** @description Menu element text identifier. Example: "item1\item2\item3". */
1877
+ menuItemTextId?: string;
1878
+ /** @description Shop Id */
1879
+ shopId?: number;
1880
+ /** @description ID of the menu zone displayed in the mask */
1881
+ menuId?: number;
1882
+ }[];
1883
+ /** @description Deletes all items assigned to the product of the selected menu */
1884
+ removeAllProductsAssignedToMenu?: {
1885
+ /** @description Shop Id */
1886
+ shopId?: number;
1887
+ /** @description ID of the menu zone displayed in the mask */
1888
+ menuId?: number;
1889
+ };
1890
+ /** @description Do You wish to sum up the products in the basket as a one order? Available values: "y" - yes, "n" - no. */
1891
+ productSumInBasket?: string;
1892
+ /** @description Settings of prices for shop. Values allowed: "same_prices" - prices in each shop are the same, "different_prices" - prices in each shop are different. */
1893
+ productShopsPricesConfig?: "same_prices" | "different_prices";
1894
+ /** @description Price settings for POS. Allowed values: "pos_equals_retail" - sets POS price the same as retail price. Possible to set only if the "shops_prices_config" parameter is set to jest same_prices or there is only one shop in panel, "pos_notequals_retail" - Price for POS different than retail price, "not_available_in_pos" - Product not available for POS sales. "sizes_pos_price_as_base_price" - Remove prices for sizes and set a sale price which equals a basic price. */
1895
+ productPosPricesConfig?: "pos_equals_retail" | "pos_notequals_retail" | "not_available_in_pos" | "sizes_pos_price_as_base_price";
1896
+ /** @description Product type. Allowed values: "product_item" - Goods, "product_free" - Free product, "product_packaging" - packaging, "product_bundle" - set. "product_collection" - collection. "product_service" - service. "product_virtual" - virtual product. "product_configurable" - configurable product. */
1897
+ productType?: "product_item" | "product_free" | "product_packaging" | "product_bundle" | "product_collection" | "product_virtual" | "product_service" | "product_configurable";
1898
+ /** @description Forced rounding up method. */
1899
+ priceRoundMode?: "none" | "00" | "x0" | "99" | "x9";
1900
+ /** @description Product availability management method Available values: "stock" - by means of stock management tools, "manual" - manually. */
1901
+ productAvailabilityManagementType?: "manual" | "stock";
1902
+ /** @description List of unused sizes in product to be deleted */
1903
+ removeChooseSizesValues?: string[];
1904
+ /** @description Remove all unused sizes. */
1905
+ removeAllUnusedProductSizes?: boolean;
1906
+ /** @description Standard producer code. Available values: "auto" - Choose automatically, "GTIN14" - GTIN-14 "GTIN13" - GTIN-13 (EAN-13) "ISBN13" - GTIN-13 (ISBN-13) "GTIN12" - GTIN-12 (UPC-A) "ISBN10" - ISBN-10 "GTIN8" - GTIN-8 (EAN-8) "UPCE" - UPC-E "MPN" - MPN "other" - Other */
1907
+ producerCodesStandard?: "auto" | "GTIN14" | "GTIN13" | "ISBN13" | "GTIN12" | "ISBN10" | "GTIN8" | "UPCE" | "MPN" | "other";
1908
+ /** @description JavaScript code displayed in the product page of the IdoSell Shop */
1909
+ javaScriptInTheItemCard?: {
1910
+ /** @description Shop Id */
1911
+ shopId?: number;
1912
+ /** @description JavaScript code displayed in the product page of the IdoSell Shop */
1913
+ scriptCode?: string;
1914
+ }[];
1915
+ /** @description Saving serial numbers Available values: "na" - not used, "optional" - Optional, "required" - required. */
1916
+ serialNumbersOption?: "na" | "optional" | "required";
1917
+ /** @description Shipping, returns and complaints settings */
1918
+ dispatchSettings?: {
1919
+ enabled?: boolean;
1920
+ /** @description Shipping settings */
1921
+ shippingSettings?: {
1922
+ /** @description Disable cash on delivery orders */
1923
+ codDisabled?: boolean;
1924
+ /** @description Only personal collection */
1925
+ dvpOnly?: boolean;
1926
+ /** @description Oversized product */
1927
+ atypicalSize?: boolean;
1928
+ /** @description Insurance required */
1929
+ insuranceOnly?: boolean;
1930
+ /** @description Exclusion from the Smile service */
1931
+ excludeSmileService?: boolean;
1932
+ /** @description List of courier services which cannot be used to ship this product */
1933
+ disallowedCouriers?: number[];
1934
+ };
1935
+ /** @description Free shipping settings */
1936
+ freeShippingSettings?: {
1937
+ /** @description Edition mode */
1938
+ mode?: "no" | "onlyProduct" | "wholeBasket";
1939
+ /** @description Set free shipping for the payment method only . */
1940
+ availablePaymentForms?: {
1941
+ /** @description prepayment */
1942
+ prepaid?: boolean;
1943
+ /** @description Cash on delivery */
1944
+ cashOnDelivery?: boolean;
1945
+ /** @description Trade credit */
1946
+ tradeCredit?: boolean;
1947
+ };
1948
+ /** @description List of courier services for which shipping is free */
1949
+ availableCouriers?: number[];
1950
+ /** @description List of courier services by which the products can be sent free of charge. IDs couriers */
1951
+ availableCouriersForSingleProduct?: number[];
1952
+ /** @description List of regions with free shipment */
1953
+ availableRegions?: number[];
1954
+ };
1955
+ /** @description Return and complaint settings */
1956
+ returnProductSettings?: {
1957
+ /** @description Product can be returned */
1958
+ returnOptions?: {
1959
+ enabled?: boolean;
1960
+ /** @description yes - for companies */
1961
+ firm?: boolean;
1962
+ /** @description yes - for wholesalers */
1963
+ hurt?: boolean;
1964
+ /** @description yes - for retailers */
1965
+ detalist?: boolean;
1966
+ };
1967
+ byOwnService?: boolean;
1968
+ byInPostSzybkieZwrotyByIAI?: boolean;
1969
+ };
1970
+ };
1971
+ /** @description Standard unit settings */
1972
+ standardUnit?: {
1973
+ /** @description Possible special contexts corresponding to standard units. Available values: "CONTEXT_STD_UNIT_WEIGHT" - Product weight in grams, "CONTEXT_STD_UNIT_WEIGHT_SI" - Product weight in kilograms, "CONTEXT_STD_UNIT_VOLUME" - A product's value in milliliters "CONTEXT_STD_UNIT_VOLUME_SI" - A product's value in liters "CONTEXT_STD_UNIT_LENGTH" - Length of product in meters "CONTEXT_STD_UNIT_AREA_M2" - Area of ​​product in square meters "CONTEXT_STD_UNIT_VOLUME_M3" - The volume of products in cubic meters "CONTEXT_STD_UNIT_QUANTITY_PACKAGE" - Number of pieces per pack for standard unit */
1974
+ contextValue?: "CONTEXT_STD_UNIT_WEIGHT" | "CONTEXT_STD_UNIT_WEIGHT_SI" | "CONTEXT_STD_UNIT_VOLUME" | "CONTEXT_STD_UNIT_VOLUME_SI" | "CONTEXT_STD_UNIT_LENGTH" | "CONTEXT_STD_UNIT_AREA_M2" | "CONTEXT_STD_UNIT_VOLUME_M3" | "CONTEXT_STD_UNIT_QUANTITY_PACKAGE";
1975
+ /** @description Total length/volume/area/weight of product */
1976
+ standardUnitValue?: number;
1977
+ /** @description Price converter per unit. Available values: "0" - default (taken from the category), "1" - price per gram/milliliter/meter "10" - price per 10 grams/10 milliliters/10 meters "100" - price per 100 grams/100 milliliters/100 meters "1000" - price per liter/kilogram/kilometer */
1978
+ converterUnitValue?: "0" | "1" | "10" | "100" | "1000";
1979
+ };
1980
+ /** @description Minimal number of products in an order */
1981
+ minQuantityPerOrder?: {
1982
+ /** @description Minimum number of products in a retail order */
1983
+ minQuantityPerOrderRetail?: number;
1984
+ /** @description Minimum number of products in a wholesale order */
1985
+ minQuantityPerOrderWholesale?: number;
1986
+ };
1987
+ /** @example dynamicPricingEnabled */
1988
+ dynamicPricingEnabled?: string;
1989
+ /** @description The setting allows you to reset the inventory to zero */
1990
+ clearStockQuantities?: {
1991
+ /** @description The setting allows you to reset the inventories of warehouse M0 and all your own warehouses */
1992
+ clearAllStockQuantities?: boolean;
1993
+ /** @description List of warehouses for which inventories are to be reset */
1994
+ stocksListToClear?: number[];
1995
+ };
1996
+ /** @description Dimensions and overall weight */
1997
+ productDimensions?: {
1998
+ /** @description The width of a product in centimeters */
1999
+ productWidth?: number;
2000
+ /** @description Height of a product in centimeters */
2001
+ productHeight?: number;
2002
+ /** @description The length of a product in centimeters */
2003
+ productLength?: number;
2004
+ };
2005
+ /** @description Responsible producer code */
2006
+ responsibleProducerCode?: string;
2007
+ /** @description Responsible person code */
2008
+ responsiblePersonCode?: string;
2009
+ }[];
2010
+ };
2011
+
2012
+ export type PutOrdersParams = {
2013
+ /** @description Orders. */
2014
+ orders: {
2015
+ /** @description Order ID. */
2016
+ orderId?: string;
2017
+ /** @description Order serial number. */
2018
+ orderSerialNumber?: number;
2019
+ /** @description Order status. Allowed values: "finished_ext" - order status: completed in FA application, "finished" - completed, "new" - not handled, "payment_waiting" - awaiting payment, "delivery_waiting" - awaiting delivery, "on_order" - in progress, "packed" - being picked, "packed_fulfillment" - being picked - fulfilment, "packed_ready" - packed, "ready" - ready, "wait_for_dispatch" - awaiting dispatch date, "suspended" - on hold, "joined" - merged, "missing" - missing, "lost" - lost, "false" - false, "canceled" - Customer canceled. */
2020
+ orderStatus?: string;
2021
+ /** @description Order status id . */
2022
+ orderStatusId?: number;
2023
+ /** @description Flag informing on order registration or completion in external program through API. Allowed values. "none" - order was not registered in external program, "registered" - order was registered in external program, "realized" - order was completed in external program, "registered_pos" - order was registered in external program, "realized_pos" - order was completed in external program. */
2024
+ apiFlag?: "none" | "registered" | "realized" | "registered_pos" | "realized_pos" | "registration_fault";
2025
+ /** @description API note added to order. */
2026
+ apiNoteToOrder?: string;
2027
+ /** @description Customer comments on order. */
2028
+ clientNoteToOrder?: string;
2029
+ /** @description Customer remarks for courier. */
2030
+ clientNoteToCourier?: string;
2031
+ /** @description Note to the order. */
2032
+ orderNote?: string;
2033
+ /** @description Products list. */
2034
+ products?: {
2035
+ /** @description Product IAI code */
2036
+ productId?: number;
2037
+ /** @description Size identifier */
2038
+ sizeId?: string;
2039
+ /** @description External product system code for size. */
2040
+ productSizeCodeExternal?: string;
2041
+ /** @description Item in basket. */
2042
+ basketPosition?: number;
2043
+ /** @description Stock ID */
2044
+ stockId?: number;
2045
+ /** @description Free product. */
2046
+ productFree?: boolean;
2047
+ /** */
2048
+ forceLoyaltyPoints?: number;
2049
+ /** @description Product quantity. */
2050
+ productQuantity?: number;
2051
+ /** @description Type of operation performed on product linked to current order. Allowed values: "add" - adds the product to current order in appropriate amount, "subtract" - removes the product from current order in appropriate amount. */
2052
+ productQuantityOperationType?: "add" | "substract";
2053
+ /** @description Gross price */
2054
+ productRetailPrice?: number;
2055
+ /** @description Value of VAT */
2056
+ productVat?: number;
2057
+ /** @description Is product VAT free Allowed values "y" - yes, "n" - no. */
2058
+ productVatFree?: string;
2059
+ /** @description Client's remarks on product. */
2060
+ remarksToProduct?: string;
2061
+ /** @description Label for grouping products. */
2062
+ label?: string;
2063
+ /** @description List of components if a products is a set or collection. */
2064
+ productBundleItems?: {
2065
+ /** @description Product IAI code */
2066
+ productId?: number;
2067
+ /** @description Size identifier */
2068
+ sizeId?: string;
2069
+ /** @description Size name */
2070
+ sizePanelName?: string;
2071
+ /** @description One of the unique, indexed product codes (IAI code / External system code / Producer code) */
2072
+ productIndex?: string;
2073
+ }[];
2074
+ /** @description Information about the selected parameters in the configurator. */
2075
+ priceFormulaParameters?: {
2076
+ /** @description Parameter ID */
2077
+ parameterId?: string;
2078
+ /** @example parameterValue */
2079
+ parameterValue?: string;
2080
+ /** @description Parameter values */
2081
+ parameterValues?: {
2082
+ /** @example valueId */
2083
+ valueId?: string;
2084
+ }[];
2085
+ }[];
2086
+ }[];
2087
+ /** @description Order payment method. Allowed values. "cash_on_delivery" - cash on delivery, "prepaid" - prepayment, "tradecredit" - Trade credit. */
2088
+ orderPaymentType?: "cash_on_delivery" | "prepaid" | "tradecredit";
2089
+ /** @description Settlement by prices. "gross" - gross, "net" - net, "net_without_VAT" - net without VAT. */
2090
+ orderSettledAtPrice?: "gross" | "net" | "net_without_VAT";
2091
+ /** @description Omits collecting orders via IAI Bridge. */
2092
+ ignoreBridge?: boolean;
2093
+ /** @description Settings */
2094
+ settings?: {
2095
+ /** @description Blocks the sending of emails */
2096
+ dontSendMail?: "y" | "n";
2097
+ /** @description Blocks the sending of sms messages */
2098
+ dontSendSMS?: "y" | "n";
2099
+ };
2100
+ /** @description Consent to send data to cooperating services */
2101
+ emailProcessingConsent?: "yes" | "no" | "disabled";
2102
+ /** @description Customer asked for invoice. List of parameters: "y" - yes (paper invoicing ), "e" - yes (electronic invoicing ), "n" - no. */
2103
+ clientRequestInvoice?: string;
2104
+ /** @description Order settlement currency. */
2105
+ billingCurrency?: string;
2106
+ /** @description Panel billing currency exchange rate in relation to billing currency in the shop . */
2107
+ billingCurrencyRate?: number;
2108
+ /** @description Sale date. ISO 8602 format. */
2109
+ purchaseDate?: string;
2110
+ /** @description Estimated date of shipment of the order in format Y-m-d H:i */
2111
+ estimatedDeliveryDate?: string;
2112
+ }[];
2113
+ };
2114
+
2115
+ export type PostCouriersPickupPointsParams = {
2116
+ pickupPoints: {
2117
+ /** @description external system code. */
2118
+ pickupPointExternalId: string;
2119
+ /** @description Courier ID. */
2120
+ courierId: number;
2121
+ /** @description collection point details. */
2122
+ descriptions?: {
2123
+ /** @description Language ID (code in ISO 639-2). */
2124
+ languageId?: string;
2125
+ /** @description Name of the pickup point. */
2126
+ name?: string;
2127
+ /** @description collection point description . */
2128
+ description?: string;
2129
+ }[];
2130
+ /** @description Accepted payment types. */
2131
+ paymentForms?: ("cash" | "card")[];
2132
+ /** @description Collection point activity. Available values: available, outOfService . */
2133
+ serviceStatus?: "out_of_service" | "available";
2134
+ /** @description Pickup point address. */
2135
+ address: {
2136
+ /** @description Address. */
2137
+ street?: string;
2138
+ /** @description ZIP / Post code. */
2139
+ zipCode?: string;
2140
+ /** @description Town / City. */
2141
+ city?: string;
2142
+ /** @description Administrative region (code in ISO 3166-2). */
2143
+ provinceCode?: string;
2144
+ };
2145
+ /** @description Geographic coordinates. */
2146
+ coordinates: {
2147
+ /** @description Longitude. */
2148
+ longitude?: number;
2149
+ /** @description Latitude. */
2150
+ latitude?: number;
2151
+ };
2152
+ /** @description Personal collection point work hours. */
2153
+ operatingDays?: {
2154
+ /** @description Days of the week designation.Day number: 1- Monday, 7 - Sunday. */
2155
+ weekday?: number;
2156
+ /** @description collection point opening hours (HH:MM). */
2157
+ opening?: string;
2158
+ /** @description collection point closing time (HH:MM). */
2159
+ closing?: string;
2160
+ /** @description #!trybPracyPunktuDostepneWartosciOpenInOtwartyOdDoClosedZamkniety24hCzynnyCalaDobe!#. */
2161
+ operatingMode?: "open_in" | "closed" | "24h";
2162
+ }[];
2163
+ }[];
2164
+ };
2165
+
2166
+ export type PutCouriersPickupPointsParams = {
2167
+ pickupPoints: {
2168
+ /** @description Collection point ID. */
2169
+ pickupPointId?: string | number;
2170
+ /** @description external system code. */
2171
+ pickupPointExternalId?: string;
2172
+ /** @description Courier ID. */
2173
+ courierId: number;
2174
+ /** @description collection point details. */
2175
+ descriptions?: {
2176
+ /** @description Language ID (code in ISO 639-2). */
2177
+ languageId?: string;
2178
+ /** @description Name of the pickup point. */
2179
+ name?: string;
2180
+ /** @description collection point description . */
2181
+ description?: string;
2182
+ }[];
2183
+ /** @description Accepted payment types. */
2184
+ paymentForms?: ("cash" | "card")[];
2185
+ /** @description Collection point activity. Available values: available, outOfService . */
2186
+ serviceStatus?: "out_of_service" | "available";
2187
+ /** @description Pickup point address. */
2188
+ address?: {
2189
+ /** @description Address. */
2190
+ street?: string;
2191
+ /** @description ZIP / Post code. */
2192
+ zipCode?: string;
2193
+ /** @description Town / City. */
2194
+ city?: string;
2195
+ /** @description Administrative region (code in ISO 3166-2). */
2196
+ provinceCode?: string;
2197
+ };
2198
+ /** @description Geographic coordinates. */
2199
+ coordinates?: {
2200
+ /** @description Longitude. */
2201
+ longitude?: number;
2202
+ /** @description Latitude. */
2203
+ latitude?: number;
2204
+ };
2205
+ /** @description Personal collection point work hours. */
2206
+ operatingDays?: {
2207
+ /** @description Days of the week designation.Day number: 1- Monday, 7 - Sunday. */
2208
+ weekday?: number;
2209
+ /** @description collection point opening hours (HH:MM). */
2210
+ opening?: string;
2211
+ /** @description collection point closing time (HH:MM). */
2212
+ closing?: string;
2213
+ /** @description #!trybPracyPunktuDostepneWartosciOpenInOtwartyOdDoClosedZamkniety24hCzynnyCalaDobe!#. */
2214
+ operatingMode?: "open_in" | "closed" | "24h";
2215
+ }[];
2216
+ }[];
2217
+ };
2218
+
2219
+ export type PostPackagesLabelsParams = {
2220
+ /** @description Id. */
2221
+ eventId: number;
2222
+ /** @description Type. */
2223
+ eventType: "order" | "rma" | "return";
2224
+ /** @description Shipment configuration options available for a given courier */
2225
+ parcelParameters?: {
2226
+ /** @description Configuration option identifier for the shipment */
2227
+ id?: string;
2228
+ /** @description The value of the configuration option for the shipment */
2229
+ value?: string;
2230
+ }[];
2231
+ /** @description Shipment configuration options available for Inpost Smile courier */
2232
+ parcelParametersByPackages?: {
2233
+ /** @description Package ID in system. */
2234
+ packageId?: string;
2235
+ /** @description Shipment configuration options available for a given courier */
2236
+ parcelParameters?: {
2237
+ /** @description Configuration option identifier for the shipment */
2238
+ id?: string;
2239
+ /** @description The value of the configuration option for the shipment */
2240
+ value?: string;
2241
+ }[];
2242
+ }[];
2243
+ };
2244
+
2245
+ export type PostOrdersDocumentsCreateParams = {
2246
+ /** @example [ 1, 2 ] */
2247
+ orderSerialNumbers: number[];
2248
+ /** @example false */
2249
+ actualize?: boolean;
2250
+ /** @description Document type */
2251
+ documentType: "vat_invoice" | "fiscal_invoice" | "corrective_vat_invoice" | "fiscal_receipt" | "sales_confirmation";
2252
+ /** @description Document issued date */
2253
+ documentIssuedDate?: string;
2254
+ /** @description Document purchase date */
2255
+ documentPurchaseDate?: string;
2256
+ /** @description Printer id */
2257
+ printerId?: number;
2258
+ };
2259
+
2260
+ export { };