idosell 0.4.34 → 0.4.41
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.
- package/README.md +22 -4
- package/changelog.md +14 -0
- package/dist/app.d.ts +140 -1
- package/dist/enums.d.ts +218 -0
- package/dist/enums.js +219 -1
- package/dist/gateways.d.ts +45 -45
- package/dist/index.js +2 -1
- package/dist/methods/getProductsAttachmentsGetContent.js +1 -0
- package/dist/methods/searchProductsCategoriesIdosell.js +1 -2
- package/dist/reqparams.d.ts +241 -206
- package/dist/responses.d.ts +70 -43
- package/dist/utils.d.ts +12 -0
- package/dist/utils.js +20 -1
- package/dist/webhooks.js +124 -0
- package/dist/webhooks.normalizer.js +140 -0
- package/package.json +2 -2
- package/tests/utilMapProductParameters.test.js +97 -0
- package/tests/utilTestData.ts +238 -1
package/dist/reqparams.d.ts
CHANGED
|
@@ -1,8 +1,12 @@
|
|
|
1
|
+
import { ENUMS } from "./enums";
|
|
2
|
+
type ProductReturnElement = `${ENUMS.PRODUCTS_RETURN_ELEMENTS}`;
|
|
3
|
+
type LangId = `${ENUMS.LANG_IDS}`;
|
|
4
|
+
|
|
1
5
|
export type PostOrdersParams = {
|
|
2
6
|
/** @description Orders. */
|
|
3
7
|
orders: {
|
|
4
8
|
/** @description Order type. Allowed values. "retail" - retail order, "wholesale" - wholesale order (can be added only by customer with wholesale account registered). Default value:: "retail" */
|
|
5
|
-
orderType?:
|
|
9
|
+
orderType?: "retail" | "wholesale";
|
|
6
10
|
/** @description Shop Id */
|
|
7
11
|
shopId?: number;
|
|
8
12
|
/** @description Stock ID */
|
|
@@ -12,7 +16,7 @@ export type PostOrdersParams = {
|
|
|
12
16
|
/** @description Currency ID */
|
|
13
17
|
currencyId: string;
|
|
14
18
|
/** @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". */
|
|
15
|
-
clientWithoutAccount:
|
|
19
|
+
clientWithoutAccount: "y" | "n";
|
|
16
20
|
/** @description Balance data for casual client. Object is necessary for casual clients (in case of client_once has y value). */
|
|
17
21
|
clientWithoutAccountData?: {
|
|
18
22
|
/** @description Customer's first name. */
|
|
@@ -38,7 +42,7 @@ export type PostOrdersParams = {
|
|
|
38
42
|
/** @description Land line. */
|
|
39
43
|
clientPhone2?: string;
|
|
40
44
|
/** @description Language ID */
|
|
41
|
-
langId?:
|
|
45
|
+
langId?: LangId;
|
|
42
46
|
};
|
|
43
47
|
/** @description Customer's login. */
|
|
44
48
|
clientLogin?: string;
|
|
@@ -117,7 +121,7 @@ export type PostOrdersParams = {
|
|
|
117
121
|
/** @description Value of VAT */
|
|
118
122
|
productVat?: number;
|
|
119
123
|
/** @description Is product VAT free Allowed values "y" - yes, "n" - no. */
|
|
120
|
-
productVatFree?:
|
|
124
|
+
productVatFree?: "y" | "n";
|
|
121
125
|
/** @description Information on used discount code. */
|
|
122
126
|
discountCode?: {
|
|
123
127
|
/** @description Name. */
|
|
@@ -162,6 +166,8 @@ export type PostOrdersParams = {
|
|
|
162
166
|
billingCurrencyRate?: number;
|
|
163
167
|
/** @description Sale date. ISO 8602 format. */
|
|
164
168
|
purchaseDate?: string;
|
|
169
|
+
/** @description Split payment MPP marking */
|
|
170
|
+
splitPayment?: boolean;
|
|
165
171
|
}[];
|
|
166
172
|
};
|
|
167
173
|
|
|
@@ -171,13 +177,13 @@ export type PostProductsParams = {
|
|
|
171
177
|
/** @description Price format. Parameter is currently unused. */
|
|
172
178
|
settingPriceFormat?: string;
|
|
173
179
|
/** @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. */
|
|
174
|
-
settingAddingCategoryAllowed?:
|
|
180
|
+
settingAddingCategoryAllowed?: "n" | "y";
|
|
175
181
|
/** @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. */
|
|
176
|
-
settingAddingSizeAllowed?:
|
|
182
|
+
settingAddingSizeAllowed?: "n" | "y";
|
|
177
183
|
/** @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. */
|
|
178
|
-
settingAddingProducerAllowed?:
|
|
184
|
+
settingAddingProducerAllowed?: "n" | "y";
|
|
179
185
|
/** @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. */
|
|
180
|
-
settingAddingSeriesAllowed?:
|
|
186
|
+
settingAddingSeriesAllowed?: "n" | "y";
|
|
181
187
|
/** @description Object determines default category which will be linked with product when it will not be linked with any category.. */
|
|
182
188
|
settingDefaultCategory?: {
|
|
183
189
|
/** @description Category id */
|
|
@@ -202,11 +208,11 @@ export type PostProductsParams = {
|
|
|
202
208
|
/** @description Object determines photo URL. */
|
|
203
209
|
picturesSettingInitialUrlPart?: string;
|
|
204
210
|
/** @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. */
|
|
205
|
-
picturesSettingInputType?:
|
|
211
|
+
picturesSettingInputType?: "base64" | "url";
|
|
206
212
|
/** @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. */
|
|
207
|
-
picturesSettingOverwrite?:
|
|
213
|
+
picturesSettingOverwrite?: "n" | "y";
|
|
208
214
|
/** @description Object determines if the photo should be scaled. Allowed values "n" - no scaling allowance, "y" - scaling allowance. */
|
|
209
|
-
picturesSettingScaling?:
|
|
215
|
+
picturesSettingScaling?: "n" | "y";
|
|
210
216
|
};
|
|
211
217
|
/** @description Products list. */
|
|
212
218
|
products: {
|
|
@@ -249,7 +255,7 @@ export type PostProductsParams = {
|
|
|
249
255
|
/** @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. */
|
|
250
256
|
sizesGroupId?: number;
|
|
251
257
|
/** @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). */
|
|
252
|
-
priceChangeMode?:
|
|
258
|
+
priceChangeMode?: "amount_set" | "amount_diff" | "percent_diff";
|
|
253
259
|
/** @description The JavaScript formula calculating prices */
|
|
254
260
|
priceFormula?: {
|
|
255
261
|
/** @description Formula parameters for calculating price */
|
|
@@ -270,7 +276,7 @@ export type PostProductsParams = {
|
|
|
270
276
|
/** @description Value of VAT */
|
|
271
277
|
productVat?: number;
|
|
272
278
|
/** @description Is product VAT free Allowed values "y" - yes, "n" - no. */
|
|
273
|
-
productVatFree?:
|
|
279
|
+
productVatFree?: "y" | "n";
|
|
274
280
|
/** @description Different prices for price comparison websites. */
|
|
275
281
|
productPriceComparisonSitesPrices?: {
|
|
276
282
|
/** @description price comparison website ID */
|
|
@@ -279,7 +285,7 @@ export type PostProductsParams = {
|
|
|
279
285
|
productPriceComparisonSitePrice?: number;
|
|
280
286
|
}[];
|
|
281
287
|
/** @description Object determines if the product is available in POS sale Available values: "n" - no, "y" - yes. */
|
|
282
|
-
productEnableInPos?:
|
|
288
|
+
productEnableInPos?: "n" | "y";
|
|
283
289
|
/** @description Required advance payment in percents */
|
|
284
290
|
productAdvancePrice?: number;
|
|
285
291
|
/** @description Annotation. */
|
|
@@ -289,15 +295,15 @@ export type PostProductsParams = {
|
|
|
289
295
|
/** @description Weight. */
|
|
290
296
|
productWeight?: number;
|
|
291
297
|
/** @description Product visibility. Allowed values "y" - product visible, "n" - product not visible. */
|
|
292
|
-
productInVisible?:
|
|
298
|
+
productInVisible?: "y" | "n";
|
|
293
299
|
/** @description Product visible even though out of stock Available values: "y" - visible even though out of stock, "n" - not visible when out of stock. */
|
|
294
|
-
productInPersistent?:
|
|
300
|
+
productInPersistent?: "y" | "n";
|
|
295
301
|
/** @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. */
|
|
296
302
|
shopsMask: number;
|
|
297
303
|
/** @description Complex rating Available values: "0" - no, "1" - yes. */
|
|
298
304
|
productComplexNotes?: number;
|
|
299
305
|
/** @description Product visibility in export to price comparison and marketplaces. Available values: "y" - Visible, "selected" - yes (selected), "n" - invisible. */
|
|
300
|
-
productInExportToPriceComparisonSites?:
|
|
306
|
+
productInExportToPriceComparisonSites?: "y" | "selected" | "n";
|
|
301
307
|
/** @description Selection of comparison sites for which the product visibility will be changed */
|
|
302
308
|
priceComparisonSites?: {
|
|
303
309
|
/** @description Shop Id */
|
|
@@ -306,7 +312,7 @@ export type PostProductsParams = {
|
|
|
306
312
|
priceComparisonSiteId?: number;
|
|
307
313
|
}[];
|
|
308
314
|
/** @description Visibility of an item in an export to Amazon Marketplace. Available values: "y" - Visible, "selected" - Visible on selected regional services, "n" - invisible. */
|
|
309
|
-
productInExportToAmazonMarketplace?:
|
|
315
|
+
productInExportToAmazonMarketplace?: "y" | "selected" | "n";
|
|
310
316
|
/** @description Availability profile ID. */
|
|
311
317
|
availableProfile?: number;
|
|
312
318
|
/** @description Discount profile ID */
|
|
@@ -377,7 +383,7 @@ export type PostProductsParams = {
|
|
|
377
383
|
/** @description External product system code */
|
|
378
384
|
productCode?: string;
|
|
379
385
|
/** @description Product visible even though out of stock Available values: "y" - visible even though out of stock, "n" - not visible when out of stock. */
|
|
380
|
-
productInPersistent?:
|
|
386
|
+
productInPersistent?: "y" | "n";
|
|
381
387
|
/** @description Product stock quantity data. */
|
|
382
388
|
productStocksData?: {
|
|
383
389
|
/** @description Object contains information on product quantity */
|
|
@@ -438,7 +444,7 @@ export type PostProductsParams = {
|
|
|
438
444
|
productNames?: {
|
|
439
445
|
productNamesLangData?: {
|
|
440
446
|
/** @description Language ID */
|
|
441
|
-
langId?:
|
|
447
|
+
langId?: LangId;
|
|
442
448
|
/** @description Product name. */
|
|
443
449
|
productName?: string;
|
|
444
450
|
}[];
|
|
@@ -447,7 +453,7 @@ export type PostProductsParams = {
|
|
|
447
453
|
/** @description Array of language-dependent elements. */
|
|
448
454
|
productDescriptionsLangData?: {
|
|
449
455
|
/** @description Language ID */
|
|
450
|
-
langId?:
|
|
456
|
+
langId?: LangId;
|
|
451
457
|
/** @description Short product description. */
|
|
452
458
|
productDescription?: string;
|
|
453
459
|
}[];
|
|
@@ -456,7 +462,7 @@ export type PostProductsParams = {
|
|
|
456
462
|
productLongDescriptions?: {
|
|
457
463
|
productLongDescriptionsLangData?: {
|
|
458
464
|
/** @description Language ID */
|
|
459
|
-
langId?:
|
|
465
|
+
langId?: LangId;
|
|
460
466
|
/** @description Long product description. */
|
|
461
467
|
productLongDescription?: string;
|
|
462
468
|
}[];
|
|
@@ -478,7 +484,7 @@ export type PostProductsParams = {
|
|
|
478
484
|
productMetaTitles?: {
|
|
479
485
|
productMetaTitlesLangData?: {
|
|
480
486
|
/** @description Language ID */
|
|
481
|
-
langId?:
|
|
487
|
+
langId?: LangId;
|
|
482
488
|
/** @description Language name */
|
|
483
489
|
langName?: string;
|
|
484
490
|
/** @description Product meta title. */
|
|
@@ -489,7 +495,7 @@ export type PostProductsParams = {
|
|
|
489
495
|
productMetaDescriptions?: {
|
|
490
496
|
productMetaDescriptionsLangData?: {
|
|
491
497
|
/** @description Language ID */
|
|
492
|
-
langId?:
|
|
498
|
+
langId?: LangId;
|
|
493
499
|
/** @description Language name */
|
|
494
500
|
langName?: string;
|
|
495
501
|
/** @description Product meta description. */
|
|
@@ -500,7 +506,7 @@ export type PostProductsParams = {
|
|
|
500
506
|
productMetaKeywords?: {
|
|
501
507
|
productMetaKeywordsLangData?: {
|
|
502
508
|
/** @description Language ID */
|
|
503
|
-
langId?:
|
|
509
|
+
langId?: LangId;
|
|
504
510
|
/** @description Language name */
|
|
505
511
|
langName?: string;
|
|
506
512
|
/** @description Product meta keywords. */
|
|
@@ -513,7 +519,7 @@ export type PostProductsParams = {
|
|
|
513
519
|
/** @description Shop Id */
|
|
514
520
|
shopId?: number;
|
|
515
521
|
/** @description Language ID */
|
|
516
|
-
langId?:
|
|
522
|
+
langId?: LangId;
|
|
517
523
|
/** @example url */
|
|
518
524
|
url?: string;
|
|
519
525
|
}[];
|
|
@@ -527,82 +533,82 @@ export type PostProductsParams = {
|
|
|
527
533
|
/** @description Settings for groups of items (variants) */
|
|
528
534
|
versionSettings?: {
|
|
529
535
|
/** @description Show in shop. Available values: "y" - all products from group, "n" - only the first product from group. */
|
|
530
|
-
versionDisplayAllInShop?:
|
|
536
|
+
versionDisplayAllInShop?: "y" | "n";
|
|
531
537
|
/** @description The same code. Available values: "y" - yes, "n" - no. */
|
|
532
|
-
versionCommonCode?:
|
|
538
|
+
versionCommonCode?: "y" | "n";
|
|
533
539
|
/** @description The same brand. Available values: "y" - yes, "n" - no. */
|
|
534
|
-
versionCommonProducer?:
|
|
540
|
+
versionCommonProducer?: "y" | "n";
|
|
535
541
|
/** @description The same annotation. Available values: "y" - yes, "n" - no. */
|
|
536
|
-
versionCommonNote?:
|
|
542
|
+
versionCommonNote?: "y" | "n";
|
|
537
543
|
/** @description The same warranty. Available values: "y" - yes, "n" - no. */
|
|
538
|
-
versionCommonWarranty?:
|
|
544
|
+
versionCommonWarranty?: "y" | "n";
|
|
539
545
|
/** @description The same series. Available values: "y" - yes, "n" - no. */
|
|
540
|
-
versionCommonSeries?:
|
|
546
|
+
versionCommonSeries?: "y" | "n";
|
|
541
547
|
/** @description The same category. Available values: "y" - yes, "n" - no. */
|
|
542
|
-
versionCommonCategory?:
|
|
548
|
+
versionCommonCategory?: "y" | "n";
|
|
543
549
|
/** @description The same price. Available values: "y" - yes, "n" - no. */
|
|
544
|
-
versionCommonPrice?:
|
|
550
|
+
versionCommonPrice?: "y" | "n";
|
|
545
551
|
/** @description Same price for auction services. possible values "y" - yes, "n" - no. */
|
|
546
552
|
versionCommonAuctionsPrice?: string;
|
|
547
553
|
/** @description Same advance. Available values: "y" - yes, "n" - no. */
|
|
548
|
-
versionCommonAdvance?:
|
|
554
|
+
versionCommonAdvance?: "y" | "n";
|
|
549
555
|
/** @description Same quantity discount. Available values: "y" - yes, "n" - no. */
|
|
550
|
-
versionCommonRebate?:
|
|
556
|
+
versionCommonRebate?: "y" | "n";
|
|
551
557
|
/** @description the same VAT rate. Available values: "y" - yes, "n" - no. */
|
|
552
|
-
versionCommonVat?:
|
|
558
|
+
versionCommonVat?: "y" | "n";
|
|
553
559
|
/** @description The same loyalty points. Available values: "y" - yes, "n" - no. */
|
|
554
|
-
versionCommonProfitPoints?:
|
|
560
|
+
versionCommonProfitPoints?: "y" | "n";
|
|
555
561
|
/** @description The same promotion. Available values: "y" - yes, "n" - no. */
|
|
556
|
-
versionCommonPromotion?:
|
|
562
|
+
versionCommonPromotion?: "y" | "n";
|
|
557
563
|
/** @description The same loyalty discount. Available values: "y" - yes, "n" - no. */
|
|
558
|
-
versionCommonDiscount?:
|
|
564
|
+
versionCommonDiscount?: "y" | "n";
|
|
559
565
|
/** @description The same privileged products. Available values: "y" - yes, "n" - no. */
|
|
560
|
-
versionCommonDistinguished?:
|
|
566
|
+
versionCommonDistinguished?: "y" | "n";
|
|
561
567
|
/** @description The same for special. Available values: "y" - yes, "n" - no. */
|
|
562
|
-
versionCommonSpecial?:
|
|
568
|
+
versionCommonSpecial?: "y" | "n";
|
|
563
569
|
/** @description DEPRECATED */
|
|
564
570
|
versionCommonTraits?: string;
|
|
565
571
|
/** @description The same related product. Available values: "y" - yes, "n" - no. */
|
|
566
|
-
versionCommonAssociated?:
|
|
572
|
+
versionCommonAssociated?: "y" | "n";
|
|
567
573
|
/** @description The same visibility. Available values: "y" - yes, "n" - no. */
|
|
568
|
-
versionCommonVisibility?:
|
|
574
|
+
versionCommonVisibility?: "y" | "n";
|
|
569
575
|
/** @description Same display when not in stock. Available values: "y" - yes, "n" - no. */
|
|
570
|
-
versionCommonPersistent?:
|
|
576
|
+
versionCommonPersistent?: "y" | "n";
|
|
571
577
|
/** @description The same priority. Available values: "y" - yes, "n" - no. */
|
|
572
|
-
versionCommonPriority?:
|
|
578
|
+
versionCommonPriority?: "y" | "n";
|
|
573
579
|
/** @description The same shops. Available values: "y" - yes, "n" - no. */
|
|
574
|
-
versionCommonShops?:
|
|
580
|
+
versionCommonShops?: "y" | "n";
|
|
575
581
|
/** @description The same sizes. Available values: "y" - yes, "n" - no. */
|
|
576
|
-
versionCommonSizes?:
|
|
582
|
+
versionCommonSizes?: "y" | "n";
|
|
577
583
|
/** @description The same unit of measure. Available values: "y" - yes, "n" - no. */
|
|
578
|
-
versionCommonUnit?:
|
|
584
|
+
versionCommonUnit?: "y" | "n";
|
|
579
585
|
/** @description The same weight. Available values: "y" - yes, "n" - no. */
|
|
580
|
-
versionCommonWeight?:
|
|
586
|
+
versionCommonWeight?: "y" | "n";
|
|
581
587
|
/** @description The same parameters. possible values "y" - yes, "n" - no. */
|
|
582
588
|
versionCommonDictionary?: string;
|
|
583
589
|
/** @description The same name. Available values: "y" - yes, "n" - no. */
|
|
584
|
-
versionCommonName?:
|
|
590
|
+
versionCommonName?: "y" | "n";
|
|
585
591
|
/** @description The same short description. Available values: "y" - yes, "n" - no. */
|
|
586
|
-
versionCommonDescription?:
|
|
592
|
+
versionCommonDescription?: "y" | "n";
|
|
587
593
|
/** @description The same long description. Available values: "y" - yes, "n" - no. */
|
|
588
|
-
versionCommonLongDescription?:
|
|
594
|
+
versionCommonLongDescription?: "y" | "n";
|
|
589
595
|
/** @description The same icon. Available values: "y" - yes, "n" - no. */
|
|
590
|
-
versionCommonIcon?:
|
|
596
|
+
versionCommonIcon?: "y" | "n";
|
|
591
597
|
/** @description The same large photos. Available values: "y" - yes, "n" - no. */
|
|
592
|
-
versionCommonPhotos?:
|
|
598
|
+
versionCommonPhotos?: "y" | "n";
|
|
593
599
|
/** @description The same availability profile. Available values: "y" - yes, "n" - no. */
|
|
594
|
-
versionCommonAvailableProfile?:
|
|
600
|
+
versionCommonAvailableProfile?: "y" | "n";
|
|
595
601
|
/** @description The same complex rating. Available values: "y" - yes, "n" - no. */
|
|
596
|
-
versionCommonComplexNotes?:
|
|
602
|
+
versionCommonComplexNotes?: "y" | "n";
|
|
597
603
|
/** @description Do You wish to sum up the products in the basket as a one order? Available values: "y" - yes, "n" - no. */
|
|
598
|
-
versionCommonSumInBasket?:
|
|
604
|
+
versionCommonSumInBasket?: "y" | "n";
|
|
599
605
|
};
|
|
600
606
|
/** @description Parameter value names */
|
|
601
607
|
versionNames?: {
|
|
602
608
|
/** @description Array of languages, values are displayed in. */
|
|
603
609
|
versionNamesLangData?: {
|
|
604
610
|
/** @description Language ID */
|
|
605
|
-
langId?:
|
|
611
|
+
langId?: LangId;
|
|
606
612
|
/** @description Name of the parameter value, e.g. orange, green, red */
|
|
607
613
|
versionName?: string;
|
|
608
614
|
}[];
|
|
@@ -612,7 +618,7 @@ export type PostProductsParams = {
|
|
|
612
618
|
/** @description Parameter name */
|
|
613
619
|
versionGroupNamesLangData?: {
|
|
614
620
|
/** @description Language ID */
|
|
615
|
-
langId?:
|
|
621
|
+
langId?: LangId;
|
|
616
622
|
/** @description Parameter name, e.g. color, width */
|
|
617
623
|
versionGroupName?: string;
|
|
618
624
|
}[];
|
|
@@ -632,7 +638,7 @@ export type PostProductsParams = {
|
|
|
632
638
|
productDeliveryTimeValue?: number;
|
|
633
639
|
};
|
|
634
640
|
/** @description Do You wish to sum up the products in the basket as a one order? Available values: "y" - yes, "n" - no. */
|
|
635
|
-
productSumInBasket?:
|
|
641
|
+
productSumInBasket?: "y" | "n";
|
|
636
642
|
/** @description Shipping, returns and complaints settings */
|
|
637
643
|
dispatchSettings?: {
|
|
638
644
|
enabled?: boolean;
|
|
@@ -874,7 +880,7 @@ export type PutProductsParams = {
|
|
|
874
880
|
/** @description Size group name. */
|
|
875
881
|
sizesGroupName?: string;
|
|
876
882
|
/** @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). */
|
|
877
|
-
priceChangeMode?:
|
|
883
|
+
priceChangeMode?: "amount_set" | "amount_diff" | "percent_diff";
|
|
878
884
|
/** @description Gross price */
|
|
879
885
|
productRetailPrice?: number;
|
|
880
886
|
/** @description Net retail price for every shop. */
|
|
@@ -910,7 +916,7 @@ export type PutProductsParams = {
|
|
|
910
916
|
/** @description Value of VAT */
|
|
911
917
|
productVat?: number;
|
|
912
918
|
/** @description Is product VAT free Allowed values "y" - yes, "n" - no. */
|
|
913
|
-
productVatFree?:
|
|
919
|
+
productVatFree?: "y" | "n";
|
|
914
920
|
/** @description Different prices for price comparison websites. */
|
|
915
921
|
productPriceComparisonSitesPrices?: {
|
|
916
922
|
/** @description price comparison website ID */
|
|
@@ -921,7 +927,7 @@ export type PutProductsParams = {
|
|
|
921
927
|
productPriceComparisonSitePriceNet?: number;
|
|
922
928
|
}[];
|
|
923
929
|
/** @description Object determines if the product is available in POS sale Available values: "n" - no, "y" - yes. */
|
|
924
|
-
productEnableInPos?:
|
|
930
|
+
productEnableInPos?: "n" | "y";
|
|
925
931
|
/** @description Required advance payment in percents */
|
|
926
932
|
productAdvancePrice?: number;
|
|
927
933
|
/** @description Annotation. */
|
|
@@ -968,7 +974,7 @@ export type PutProductsParams = {
|
|
|
968
974
|
/** @description Weight. */
|
|
969
975
|
productWeight?: number;
|
|
970
976
|
/** @description Product visibility. Allowed values "y" - product visible, "n" - product not visible. */
|
|
971
|
-
productInVisible?:
|
|
977
|
+
productInVisible?: "y" | "n";
|
|
972
978
|
/** @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. */
|
|
973
979
|
shopsMask?: number;
|
|
974
980
|
/** @description Complex rating Available values: "0" - no, "1" - yes. */
|
|
@@ -983,7 +989,7 @@ export type PutProductsParams = {
|
|
|
983
989
|
priceComparisonSiteId?: number;
|
|
984
990
|
}[];
|
|
985
991
|
/** @description Visibility of an item in an export to Amazon Marketplace. Available values: "y" - Visible, "selected" - Visible on selected regional services, "n" - invisible. */
|
|
986
|
-
productInExportToAmazonMarketplace?:
|
|
992
|
+
productInExportToAmazonMarketplace?: "y" | "selected" | "n";
|
|
987
993
|
/** @description Array */
|
|
988
994
|
exportToAmazonMarketplacesList?: string[];
|
|
989
995
|
/** @description Export sizes to Amazon: Available values: "y" - all, "n" - leave without change. */
|
|
@@ -1150,7 +1156,7 @@ export type PutProductsParams = {
|
|
|
1150
1156
|
/** @description List of languages. */
|
|
1151
1157
|
attachmentLanguages?: {
|
|
1152
1158
|
/** @description Language ID */
|
|
1153
|
-
langId?:
|
|
1159
|
+
langId?: LangId;
|
|
1154
1160
|
/** @description Language name */
|
|
1155
1161
|
langName?: string;
|
|
1156
1162
|
/** @description Literal in selected language. */
|
|
@@ -1180,7 +1186,7 @@ export type PutProductsParams = {
|
|
|
1180
1186
|
/** @description The list of attachments to be deleted. */
|
|
1181
1187
|
removeAttachments?: {
|
|
1182
1188
|
/** @description Language ID */
|
|
1183
|
-
langId?:
|
|
1189
|
+
langId?: LangId;
|
|
1184
1190
|
}[];
|
|
1185
1191
|
/** @description Do you want to delete attachments for digital files. */
|
|
1186
1192
|
virtualAttachmentsToRemove?: boolean;
|
|
@@ -1193,7 +1199,7 @@ export type PutProductsParams = {
|
|
|
1193
1199
|
/** @description List of languages. */
|
|
1194
1200
|
attachmentLanguages?: {
|
|
1195
1201
|
/** @description Language ID */
|
|
1196
|
-
langId?:
|
|
1202
|
+
langId?: LangId;
|
|
1197
1203
|
/** @description Language name */
|
|
1198
1204
|
langName?: string;
|
|
1199
1205
|
/** @description Literal in selected language. */
|
|
@@ -1460,7 +1466,7 @@ export type PutProductsParams = {
|
|
|
1460
1466
|
productNames?: {
|
|
1461
1467
|
productNamesLangData?: {
|
|
1462
1468
|
/** @description Language ID */
|
|
1463
|
-
langId?:
|
|
1469
|
+
langId?: LangId;
|
|
1464
1470
|
/** @description Product name. */
|
|
1465
1471
|
productName?: string;
|
|
1466
1472
|
/** @description Shop Id */
|
|
@@ -1473,7 +1479,7 @@ export type PutProductsParams = {
|
|
|
1473
1479
|
productNamesInAuction?: {
|
|
1474
1480
|
productNamesInAuctionLangData?: {
|
|
1475
1481
|
/** @description Language ID */
|
|
1476
|
-
langId?:
|
|
1482
|
+
langId?: LangId;
|
|
1477
1483
|
/** @example productNameInAuction */
|
|
1478
1484
|
productNameInAuction?: string;
|
|
1479
1485
|
}[];
|
|
@@ -1482,7 +1488,7 @@ export type PutProductsParams = {
|
|
|
1482
1488
|
productNamesInPriceComparer?: {
|
|
1483
1489
|
productNamesInPriceComparerLangData?: {
|
|
1484
1490
|
/** @description Language ID */
|
|
1485
|
-
langId?:
|
|
1491
|
+
langId?: LangId;
|
|
1486
1492
|
/** @description Product name for price comparison websites. */
|
|
1487
1493
|
productNameInPriceComparer?: string;
|
|
1488
1494
|
}[];
|
|
@@ -1491,7 +1497,7 @@ export type PutProductsParams = {
|
|
|
1491
1497
|
productParamDescriptions?: {
|
|
1492
1498
|
productParamDescriptionsLangData?: {
|
|
1493
1499
|
/** @description Language ID */
|
|
1494
|
-
langId?:
|
|
1500
|
+
langId?: LangId;
|
|
1495
1501
|
/** @description Product short description */
|
|
1496
1502
|
productParamDescriptions?: string;
|
|
1497
1503
|
/** @description Shop Id */
|
|
@@ -1504,7 +1510,7 @@ export type PutProductsParams = {
|
|
|
1504
1510
|
productLongDescriptions?: {
|
|
1505
1511
|
productLongDescriptionsLangData?: {
|
|
1506
1512
|
/** @description Language ID */
|
|
1507
|
-
langId?:
|
|
1513
|
+
langId?: LangId;
|
|
1508
1514
|
/** @description Long product description. */
|
|
1509
1515
|
productLongDescription?: string;
|
|
1510
1516
|
/** @description Shop Id */
|
|
@@ -1517,7 +1523,7 @@ export type PutProductsParams = {
|
|
|
1517
1523
|
productLongDescriptionsInAuction?: {
|
|
1518
1524
|
productLongDescriptionsInAuctionLangData?: {
|
|
1519
1525
|
/** @description Language ID */
|
|
1520
|
-
langId?:
|
|
1526
|
+
langId?: LangId;
|
|
1521
1527
|
/** @example productLongDescriptionInAuction */
|
|
1522
1528
|
productLongDescriptionInAuction?: string;
|
|
1523
1529
|
}[];
|
|
@@ -1541,7 +1547,7 @@ export type PutProductsParams = {
|
|
|
1541
1547
|
/** @description Shop Id */
|
|
1542
1548
|
shopId?: number;
|
|
1543
1549
|
/** @description Language ID */
|
|
1544
|
-
langId?:
|
|
1550
|
+
langId?: LangId;
|
|
1545
1551
|
/** @description Language name */
|
|
1546
1552
|
langName?: string;
|
|
1547
1553
|
/** @description Product meta title. */
|
|
@@ -1554,7 +1560,7 @@ export type PutProductsParams = {
|
|
|
1554
1560
|
/** @description Shop Id */
|
|
1555
1561
|
shopId?: number;
|
|
1556
1562
|
/** @description Language ID */
|
|
1557
|
-
langId?:
|
|
1563
|
+
langId?: LangId;
|
|
1558
1564
|
/** @description Language name */
|
|
1559
1565
|
langName?: string;
|
|
1560
1566
|
/** @description Product meta description. */
|
|
@@ -1567,7 +1573,7 @@ export type PutProductsParams = {
|
|
|
1567
1573
|
/** @description Shop Id */
|
|
1568
1574
|
shopId?: number;
|
|
1569
1575
|
/** @description Language ID */
|
|
1570
|
-
langId?:
|
|
1576
|
+
langId?: LangId;
|
|
1571
1577
|
/** @description Language name */
|
|
1572
1578
|
langName?: string;
|
|
1573
1579
|
/** @description Product meta keywords. */
|
|
@@ -1580,7 +1586,7 @@ export type PutProductsParams = {
|
|
|
1580
1586
|
/** @description Shop Id */
|
|
1581
1587
|
shopId?: number;
|
|
1582
1588
|
/** @description Language ID */
|
|
1583
|
-
langId?:
|
|
1589
|
+
langId?: LangId;
|
|
1584
1590
|
/** @example url */
|
|
1585
1591
|
url?: string;
|
|
1586
1592
|
}[];
|
|
@@ -1599,94 +1605,94 @@ export type PutProductsParams = {
|
|
|
1599
1605
|
/** @description Settings for groups of items (variants) */
|
|
1600
1606
|
versionSettings?: {
|
|
1601
1607
|
/** @description Show in shop. Available values: "y" - all products from group, "n" - only the first product from group. */
|
|
1602
|
-
versionDisplayAllInShop?:
|
|
1608
|
+
versionDisplayAllInShop?: "y" | "n";
|
|
1603
1609
|
/** @description Show in panel. Available values: "y" - wszystkie towary z grupy, "n" - only the first product from group. */
|
|
1604
|
-
versionDisplayAllInPanel?:
|
|
1610
|
+
versionDisplayAllInPanel?: "y" | "n";
|
|
1605
1611
|
/** @description Adding the canonical links to the site. Available values: "y" - on, "n" - Off. */
|
|
1606
|
-
versionDisplayRelCanonicalInShop?:
|
|
1612
|
+
versionDisplayRelCanonicalInShop?: "y" | "n";
|
|
1607
1613
|
/** @description The same code. Available values: "y" - yes, "n" - no. */
|
|
1608
|
-
versionCommonCode?:
|
|
1614
|
+
versionCommonCode?: "y" | "n";
|
|
1609
1615
|
/** @description The same brand. Available values: "y" - yes, "n" - no. */
|
|
1610
|
-
versionCommonProducer?:
|
|
1616
|
+
versionCommonProducer?: "y" | "n";
|
|
1611
1617
|
/** @description The same annotation. Available values: "y" - yes, "n" - no. */
|
|
1612
|
-
versionCommonNote?:
|
|
1618
|
+
versionCommonNote?: "y" | "n";
|
|
1613
1619
|
/** @description The same warranty. Available values: "y" - yes, "n" - no. */
|
|
1614
|
-
versionCommonWarranty?:
|
|
1620
|
+
versionCommonWarranty?: "y" | "n";
|
|
1615
1621
|
/** @description The same for size chart. Available values: "y" - yes, "n" - no. */
|
|
1616
|
-
versionCommonSizesChart?:
|
|
1622
|
+
versionCommonSizesChart?: "y" | "n";
|
|
1617
1623
|
/** @description The same series. Available values: "y" - yes, "n" - no. */
|
|
1618
|
-
versionCommonSeries?:
|
|
1624
|
+
versionCommonSeries?: "y" | "n";
|
|
1619
1625
|
/** @description The same category. Available values: "y" - yes, "n" - no. */
|
|
1620
|
-
versionCommonCategory?:
|
|
1626
|
+
versionCommonCategory?: "y" | "n";
|
|
1621
1627
|
/** @description The same price. Available values: "y" - yes, "n" - no. */
|
|
1622
|
-
versionCommonPrice?:
|
|
1628
|
+
versionCommonPrice?: "y" | "n";
|
|
1623
1629
|
/** @description Same advance. Available values: "y" - yes, "n" - no. */
|
|
1624
|
-
versionCommonAdvance?:
|
|
1630
|
+
versionCommonAdvance?: "y" | "n";
|
|
1625
1631
|
/** @description Same quantity discount. Available values: "y" - yes, "n" - no. */
|
|
1626
|
-
versionCommonRebate?:
|
|
1632
|
+
versionCommonRebate?: "y" | "n";
|
|
1627
1633
|
/** @description the same VAT rate. Available values: "y" - yes, "n" - no. */
|
|
1628
|
-
versionCommonVat?:
|
|
1634
|
+
versionCommonVat?: "y" | "n";
|
|
1629
1635
|
/** @description The same loyalty points. Available values: "y" - yes, "n" - no. */
|
|
1630
|
-
versionCommonProfitPoints?:
|
|
1636
|
+
versionCommonProfitPoints?: "y" | "n";
|
|
1631
1637
|
/** @description The same related product. Available values: "y" - yes, "n" - no. */
|
|
1632
|
-
versionCommonAssociated?:
|
|
1638
|
+
versionCommonAssociated?: "y" | "n";
|
|
1633
1639
|
/** @description The same visibility. Available values: "y" - yes, "n" - no. */
|
|
1634
|
-
versionCommonVisibility?:
|
|
1640
|
+
versionCommonVisibility?: "y" | "n";
|
|
1635
1641
|
/** @description The same priority. Available values: "y" - yes, "n" - no. */
|
|
1636
|
-
versionCommonPriority?:
|
|
1642
|
+
versionCommonPriority?: "y" | "n";
|
|
1637
1643
|
/** @description The same shops. Available values: "y" - yes, "n" - no. */
|
|
1638
|
-
versionCommonShops?:
|
|
1644
|
+
versionCommonShops?: "y" | "n";
|
|
1639
1645
|
/** @description The same sizes. Available values: "y" - yes, "n" - no. */
|
|
1640
|
-
versionCommonSizes?:
|
|
1646
|
+
versionCommonSizes?: "y" | "n";
|
|
1641
1647
|
/** @description The same weight. Available values: "y" - yes, "n" - no. */
|
|
1642
|
-
versionCommonWeight?:
|
|
1648
|
+
versionCommonWeight?: "y" | "n";
|
|
1643
1649
|
/** @description The same name. Available values: "y" - yes, "n" - no. */
|
|
1644
|
-
versionCommonName?:
|
|
1650
|
+
versionCommonName?: "y" | "n";
|
|
1645
1651
|
/** @description The same product's name for Internet auctions. Available values: "y" - yes, "n" - no. */
|
|
1646
|
-
versionCommonAuctionName?:
|
|
1652
|
+
versionCommonAuctionName?: "y" | "n";
|
|
1647
1653
|
/** @description The same short description. Available values: "y" - yes, "n" - no. */
|
|
1648
|
-
versionCommonDescription?:
|
|
1654
|
+
versionCommonDescription?: "y" | "n";
|
|
1649
1655
|
/** @description The same long description. Available values: "y" - yes, "n" - no. */
|
|
1650
|
-
versionCommonLongDescription?:
|
|
1656
|
+
versionCommonLongDescription?: "y" | "n";
|
|
1651
1657
|
/** @description The same icon. Available values: "y" - yes, "n" - no. */
|
|
1652
|
-
versionCommonIcon?:
|
|
1658
|
+
versionCommonIcon?: "y" | "n";
|
|
1653
1659
|
/** @description The same large photos. Available values: "y" - yes, "n" - no. */
|
|
1654
|
-
versionCommonPhotos?:
|
|
1660
|
+
versionCommonPhotos?: "y" | "n";
|
|
1655
1661
|
/** @description The same availability profile. Available values: "y" - yes, "n" - no. */
|
|
1656
|
-
versionCommonAvailableProfile?:
|
|
1662
|
+
versionCommonAvailableProfile?: "y" | "n";
|
|
1657
1663
|
/** @description The same complex rating. Available values: "y" - yes, "n" - no. */
|
|
1658
|
-
versionCommonComplexNotes?:
|
|
1664
|
+
versionCommonComplexNotes?: "y" | "n";
|
|
1659
1665
|
/** @description Do You wish to sum up the products in the basket as a one order? Available values: "y" - yes, "n" - no. */
|
|
1660
|
-
versionCommonSumInBasket?:
|
|
1666
|
+
versionCommonSumInBasket?: "y" | "n";
|
|
1661
1667
|
/** @description The same objects in menu Available values: "y" - yes, "n" - no. */
|
|
1662
|
-
versionCommonMenuItems?:
|
|
1668
|
+
versionCommonMenuItems?: "y" | "n";
|
|
1663
1669
|
/** @description The same supplier. Available values: "y" - yes, "n" - no. */
|
|
1664
|
-
versionCommonDeliverer?:
|
|
1670
|
+
versionCommonDeliverer?: "y" | "n";
|
|
1665
1671
|
/** @description The same attachments Available values: "y" - yes, "n" - no. */
|
|
1666
|
-
versionCommonAttachments?:
|
|
1672
|
+
versionCommonAttachments?: "y" | "n";
|
|
1667
1673
|
/** @description The same icons for auctions Available values: "y" - yes, "n" - no. */
|
|
1668
|
-
versionCommonAuctionIcon?:
|
|
1674
|
+
versionCommonAuctionIcon?: "y" | "n";
|
|
1669
1675
|
/** @description The same serial numbers Available values: "y" - yes, "n" - no. */
|
|
1670
|
-
versionCommonSerialNumbers?:
|
|
1676
|
+
versionCommonSerialNumbers?: "y" | "n";
|
|
1671
1677
|
/** @description The same parameters. possible values "y" - yes, "n" - no. */
|
|
1672
1678
|
versionCommonDictionary?: string;
|
|
1673
1679
|
/** @description Same promotions Available values: "y" - yes, "n" - no. */
|
|
1674
|
-
versionCommonPromotions?:
|
|
1680
|
+
versionCommonPromotions?: "y" | "n";
|
|
1675
1681
|
/** @description The same meta settings Available values: "y" - yes, "n" - no. */
|
|
1676
|
-
versionCommonMetaTags?:
|
|
1682
|
+
versionCommonMetaTags?: "y" | "n";
|
|
1677
1683
|
/** @description The same currency. Available values: "y" - yes, "n" - no. */
|
|
1678
|
-
versionCommonCurrency?:
|
|
1684
|
+
versionCommonCurrency?: "y" | "n";
|
|
1679
1685
|
/** @description The same formula for calculating prices Available values: "y" - yes, "n" - no. */
|
|
1680
|
-
versionCommonPriceFormula?:
|
|
1686
|
+
versionCommonPriceFormula?: "y" | "n";
|
|
1681
1687
|
/** @description The same JavaScript displayed on the product card Available values: "y" - yes, "n" - no. */
|
|
1682
|
-
versionCommonJavaScriptOnCard?:
|
|
1688
|
+
versionCommonJavaScriptOnCard?: "y" | "n";
|
|
1683
1689
|
};
|
|
1684
1690
|
/** @description Parameter value names */
|
|
1685
1691
|
versionNames?: {
|
|
1686
1692
|
/** @description Array of languages, values are displayed in. */
|
|
1687
1693
|
versionNamesLangData?: {
|
|
1688
1694
|
/** @description Language ID */
|
|
1689
|
-
langId?:
|
|
1695
|
+
langId?: LangId;
|
|
1690
1696
|
/** @description Name of the parameter value, e.g. orange, green, red */
|
|
1691
1697
|
versionName?: string;
|
|
1692
1698
|
}[];
|
|
@@ -1696,7 +1702,7 @@ export type PutProductsParams = {
|
|
|
1696
1702
|
/** @description Parameter name */
|
|
1697
1703
|
versionGroupNamesLangData?: {
|
|
1698
1704
|
/** @description Language ID */
|
|
1699
|
-
langId?:
|
|
1705
|
+
langId?: LangId;
|
|
1700
1706
|
/** @description Parameter name, e.g. color, width */
|
|
1701
1707
|
versionGroupName?: string;
|
|
1702
1708
|
}[];
|
|
@@ -1737,16 +1743,16 @@ export type PutProductsParams = {
|
|
|
1737
1743
|
/** @description Allows to enter parameter name i multiple languages at the same time. If it is used, item_textid and lang_id are ingored. */
|
|
1738
1744
|
productParameterTextIdsLangData?: {
|
|
1739
1745
|
/** @description Language ID */
|
|
1740
|
-
langId?:
|
|
1746
|
+
langId?: LangId;
|
|
1741
1747
|
/** @description Parameter ID. */
|
|
1742
1748
|
productParameterTextId?: string;
|
|
1743
1749
|
}[];
|
|
1744
1750
|
/** @description Language ID */
|
|
1745
|
-
langId?:
|
|
1751
|
+
langId?: LangId;
|
|
1746
1752
|
/** @description Parameters descriptions in indicated language versions. */
|
|
1747
1753
|
productParametersDescriptionsLangData?: {
|
|
1748
1754
|
/** @description Language ID */
|
|
1749
|
-
langId?:
|
|
1755
|
+
langId?: LangId;
|
|
1750
1756
|
/** @description Parameter description */
|
|
1751
1757
|
productParametersDescription?: string;
|
|
1752
1758
|
}[];
|
|
@@ -1759,7 +1765,7 @@ export type PutProductsParams = {
|
|
|
1759
1765
|
/** @description Parameter name (if ID was not used). */
|
|
1760
1766
|
productParameterTextIdent?: string;
|
|
1761
1767
|
/** @description Language ID */
|
|
1762
|
-
langId?:
|
|
1768
|
+
langId?: LangId;
|
|
1763
1769
|
/** @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 . */
|
|
1764
1770
|
productParameterDescriptionType?: "distinction" | "group_distinction" | "projector_hide" | "auction_template_hide";
|
|
1765
1771
|
/** @description Value. Allowed values: "y" "n" */
|
|
@@ -1788,7 +1794,7 @@ export type PutProductsParams = {
|
|
|
1788
1794
|
menuId?: number;
|
|
1789
1795
|
};
|
|
1790
1796
|
/** @description Do You wish to sum up the products in the basket as a one order? Available values: "y" - yes, "n" - no. */
|
|
1791
|
-
productSumInBasket?:
|
|
1797
|
+
productSumInBasket?: "y" | "n";
|
|
1792
1798
|
/** @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. */
|
|
1793
1799
|
productShopsPricesConfig?: "same_prices" | "different_prices";
|
|
1794
1800
|
/** @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. */
|
|
@@ -1926,6 +1932,8 @@ export type PutOrdersParams = {
|
|
|
1926
1932
|
orderStatus?: string;
|
|
1927
1933
|
/** @description Order status id . */
|
|
1928
1934
|
orderStatusId?: number;
|
|
1935
|
+
/** @description Transaction type. */
|
|
1936
|
+
transactionType?: "national" | "oss" | "export" | "intra";
|
|
1929
1937
|
/** @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. */
|
|
1930
1938
|
apiFlag?: "none" | "registered" | "realized" | "registered_pos" | "realized_pos" | "registration_fault";
|
|
1931
1939
|
/** @description API note added to order. */
|
|
@@ -1961,7 +1969,7 @@ export type PutOrdersParams = {
|
|
|
1961
1969
|
/** @description Value of VAT */
|
|
1962
1970
|
productVat?: number;
|
|
1963
1971
|
/** @description Is product VAT free Allowed values "y" - yes, "n" - no. */
|
|
1964
|
-
productVatFree?:
|
|
1972
|
+
productVatFree?: "y" | "n";
|
|
1965
1973
|
/** @description Client's remarks on product. */
|
|
1966
1974
|
remarksToProduct?: string;
|
|
1967
1975
|
/** @description Label for grouping products. */
|
|
@@ -2015,6 +2023,10 @@ export type PutOrdersParams = {
|
|
|
2015
2023
|
purchaseDate?: string;
|
|
2016
2024
|
/** @description Estimated date of shipment of the order in format Y-m-d H:i */
|
|
2017
2025
|
estimatedDeliveryDate?: string;
|
|
2026
|
+
/** @description Split payment MPP marking */
|
|
2027
|
+
splitPayment?: boolean;
|
|
2028
|
+
/** @description Planned date of packing */
|
|
2029
|
+
plannedDateOfPacking?: string;
|
|
2018
2030
|
}[];
|
|
2019
2031
|
};
|
|
2020
2032
|
|
|
@@ -2027,7 +2039,7 @@ export type PostCouriersPickupPointsParams = {
|
|
|
2027
2039
|
/** @description collection point details. */
|
|
2028
2040
|
descriptions?: {
|
|
2029
2041
|
/** @description Language ID (code in ISO 639-2). */
|
|
2030
|
-
languageId?:
|
|
2042
|
+
languageId?: LangId;
|
|
2031
2043
|
/** @description Name of the pickup point. */
|
|
2032
2044
|
name?: string;
|
|
2033
2045
|
/** @description collection point description . */
|
|
@@ -2082,7 +2094,7 @@ export type PutCouriersPickupPointsParams = {
|
|
|
2082
2094
|
/** @description collection point details. */
|
|
2083
2095
|
descriptions?: {
|
|
2084
2096
|
/** @description Language ID (code in ISO 639-2). */
|
|
2085
|
-
languageId?:
|
|
2097
|
+
languageId?: LangId;
|
|
2086
2098
|
/** @description Name of the pickup point. */
|
|
2087
2099
|
name?: string;
|
|
2088
2100
|
/** @description collection point description . */
|
|
@@ -2203,7 +2215,7 @@ export type PostClientsParams = {
|
|
|
2203
2215
|
/** @description Customer type, possible values: - person - if client sex is not determined, - person_male - when client is a male, - person_female - when a customer is a woman, - firm - when client is company. */
|
|
2204
2216
|
client_type?: "person" | "person_male" | "person_female" | "firm";
|
|
2205
2217
|
/** @description Customer language ID. */
|
|
2206
|
-
language?:
|
|
2218
|
+
language?: LangId;
|
|
2207
2219
|
/** @description Determines, in which store account should be active. */
|
|
2208
2220
|
shops: number[];
|
|
2209
2221
|
/** @description Defines availability of log in to other pages than the ones given in the element: shops . */
|
|
@@ -2440,7 +2452,7 @@ export type PostMenuParams = {
|
|
|
2440
2452
|
parent_textid?: string;
|
|
2441
2453
|
lang_data: {
|
|
2442
2454
|
/** @description Language ID. */
|
|
2443
|
-
lang_id?:
|
|
2455
|
+
lang_id?: LangId;
|
|
2444
2456
|
/** @description Menu element name. */
|
|
2445
2457
|
name?: string;
|
|
2446
2458
|
/** @description Menu element order. */
|
|
@@ -2650,26 +2662,26 @@ export type PutProductsAttachmentsParams = {
|
|
|
2650
2662
|
/** @description Stock keeping unit. */
|
|
2651
2663
|
productIdent: {
|
|
2652
2664
|
/** @description ID value. */
|
|
2653
|
-
identValue
|
|
2665
|
+
identValue?: string | number;
|
|
2654
2666
|
/** @description Identifier type. */
|
|
2655
|
-
productIdentType
|
|
2667
|
+
productIdentType?: "id" | "index" | "codeExtern" | "codeProducer";
|
|
2656
2668
|
};
|
|
2657
2669
|
/** @description Product attachments list. */
|
|
2658
2670
|
attachments?: {
|
|
2659
2671
|
/** @description Attachment file link. */
|
|
2660
|
-
attachmentUrl
|
|
2672
|
+
attachmentUrl?: string;
|
|
2661
2673
|
/** @description Attachment name. */
|
|
2662
|
-
attachmentName
|
|
2674
|
+
attachmentName?: string;
|
|
2663
2675
|
/** @description Language ID */
|
|
2664
|
-
langId
|
|
2676
|
+
langId?: LangId;
|
|
2665
2677
|
/** @description File type: audio, video, doc, other. */
|
|
2666
|
-
attachmentFileType
|
|
2678
|
+
attachmentFileType?: "audio" | "video" | "doc" | "other" | "image";
|
|
2667
2679
|
/** @description Type of customer, attachment should be available for: 'all','ordered','wholesaler','wholesaler_or_ordered','wholesaler_and_ordered'. */
|
|
2668
|
-
attachmentEnable
|
|
2680
|
+
attachmentEnable?: "all" | "ordered" | "wholesaler" | "wholesaler_or_orderer" | "wholesaler_and_ordered";
|
|
2669
2681
|
/** @description Attachment ID. */
|
|
2670
2682
|
attachmentId?: number;
|
|
2671
2683
|
/** @description Attachment downloads record. */
|
|
2672
|
-
attachmentDownloadLog
|
|
2684
|
+
attachmentDownloadLog?: "y" | "n";
|
|
2673
2685
|
/** @description Attachment file extension. */
|
|
2674
2686
|
attachmentFileExtension?: string;
|
|
2675
2687
|
/** @description Attachment number. */
|
|
@@ -2679,7 +2691,7 @@ export type PutProductsAttachmentsParams = {
|
|
|
2679
2691
|
/** @description Attachment document types list. */
|
|
2680
2692
|
documentTypes?: {
|
|
2681
2693
|
/** @description Document type. */
|
|
2682
|
-
documentType?: "energy_label" | "instruction_with_safety_information" | "user_manual" | "installation_instructions" | "product_card" | "guide" | "others";
|
|
2694
|
+
documentType?: "energy_label" | "instruction_with_safety_information" | "user_manual" | "installation_instructions" | "product_card" | "guide" | "software_data_processing" | "hardware_data_processing" | "others";
|
|
2683
2695
|
/** @description Additional description. */
|
|
2684
2696
|
description?: string;
|
|
2685
2697
|
}[];
|
|
@@ -2693,7 +2705,7 @@ export type PutProductsAttachmentsParams = {
|
|
|
2693
2705
|
/** @description List of languages. */
|
|
2694
2706
|
attachmentLanguages?: {
|
|
2695
2707
|
/** @description Language ID */
|
|
2696
|
-
langId?:
|
|
2708
|
+
langId?: LangId;
|
|
2697
2709
|
/** @description Language name */
|
|
2698
2710
|
langName?: string;
|
|
2699
2711
|
/** @description Literal in selected language. */
|
|
@@ -2749,7 +2761,7 @@ export type PutMenuParams = {
|
|
|
2749
2761
|
item_textid?: string;
|
|
2750
2762
|
lang_data?: {
|
|
2751
2763
|
/** @description Language ID. */
|
|
2752
|
-
lang_id?:
|
|
2764
|
+
lang_id?: LangId;
|
|
2753
2765
|
/** @description Menu element name. */
|
|
2754
2766
|
name?: string;
|
|
2755
2767
|
/** @description Menu element order. */
|
|
@@ -2991,10 +3003,10 @@ export type PutProductsCategoriesParams = {
|
|
|
2991
3003
|
/** @description Category priority. Value from 1 to 19. */
|
|
2992
3004
|
priority?: number;
|
|
2993
3005
|
/** @description Operation code. Allowed values. "add" - adds new category, "edit" - edits existing category, "del" - deletes existing category. */
|
|
2994
|
-
operation?:
|
|
3006
|
+
operation?: "add" | "edit" | "del";
|
|
2995
3007
|
lang_data?: {
|
|
2996
3008
|
/** @description Language code. Codes are compliant with ISO-639-3 standard. */
|
|
2997
|
-
lang_id?:
|
|
3009
|
+
lang_id?: LangId;
|
|
2998
3010
|
/** @description Category singular name. */
|
|
2999
3011
|
singular_name?: string;
|
|
3000
3012
|
/** @description Category plural name. */
|
|
@@ -3051,31 +3063,31 @@ export type SearchProductsParams = {
|
|
|
3051
3063
|
};
|
|
3052
3064
|
};
|
|
3053
3065
|
/** @description Element determines which products should be returned by the gate. Undeleted products are returned by default. Available values: "active" - undeleted products, "deleted" - deleted products. "in_trash" - products in the trash. */
|
|
3054
|
-
returnProducts?:
|
|
3055
|
-
/** @description Elements to be returned by the endpoint. By default all elements are returned Available values: * lang_data * adding_time, * deleted, * code, * note, * taxcode, * inwrapper, * sellby_retail, * sellby_wholesale, * producer_id, * producer_name, * iaiCategoryId, * iaiCategoryName, * iaiCategoryPath, * category_id, * category_name, * size_group_id, * modification_time, * currency, * currency_shop, * bestseller, * new_product, * retail_price, * wholesale_price, * minimal_price, * automatic_calculation_price, * pos_price, * strikethrough_retail_price, * strikethrough_wholesale_price, * last_purchase_price, * purchase_price_net_average, * purchase_price_net_last, * purchase_price_gross_average, * purchase_price_gross_last, * vat, * vat_free, * rebate, * hotspots_zones, * profit_points, * points, * weight, * export_to_pricecomparers, * export_to_amazon_marketplace, * enable_in_pos, * complex_notes, * available_profile, * traits, * parameters, * version_data, * advance, * promotion, * discount, * distinguished, * special, * visible, * persistent, * priority, * shops_mask, * icon, * icon_for_auctions, * icon_for_group, * pictures, * unit, * warranty, * series, * products_associated, * shops, * quantities, * sizes_attributes, * shops_attributes, * auction_prices, * price_comparers_prices, * deliverer, * sizes, * size_group_name, * pictures_count, * product_type, * price_changed_time, * quantity_changed_time, * deliverer_name, * available_profile_name, * availability_management_type, * sum_in_basket, * menu, * auction_settings, * bundle, * sizeschart_id, * sizeschart_name, * serialnumbers, * producer_codes_standard, * javaScriptInTheItemCard, * productAuctionDescriptionsData, * priceFormula, * productIndividualDescriptionsData, * productIndividualUrlsData, * productServicesDescriptionsData, * cnTaricCode, * productIsGratis, * dimensions, * responsibleProducerCode, * responsiblePersonCode */
|
|
3066
|
+
returnProducts?: "active" | "deleted" | "in_trash";
|
|
3067
|
+
/** @description Elements to be returned by the endpoint. By default all elements are returned Available values: * lang_data * adding_time, * deleted, * code, * note, * taxcode, * inwrapper, * sellby_retail, * sellby_wholesale, * producer_id, * producer_name, * iaiCategoryId, * iaiCategoryName, * iaiCategoryPath, * category_id, * category_name, * size_group_id, * modification_time, * currency, * currency_shop, * bestseller, * new_product, * retail_price, * wholesale_price, * minimal_price, * automatic_calculation_price, * pos_price, * strikethrough_retail_price, * strikethrough_wholesale_price, * last_purchase_price, * purchase_price_net_average, * purchase_price_net_last, * purchase_price_gross_average, * purchase_price_gross_last, * vat, * vat_free, * rebate, * hotspots_zones, * profit_points, * points, * weight, * export_to_pricecomparers, * export_to_amazon_marketplace, * enable_in_pos, * complex_notes, * available_profile, * traits, * parameters, * version_data, * advance, * promotion, * discount, * distinguished, * special, * visible, * persistent, * priority, * shops_mask, * icon, * icon_for_auctions, * icon_for_group, * pictures, * unit, * warranty, * series, * products_associated, * shops, * quantities, * sizes_attributes, * shops_attributes, * auction_prices, * price_comparers_prices, * deliverer, * sizes, * size_group_name, * pictures_count, * product_type, * price_changed_time, * quantity_changed_time, * deliverer_name, * available_profile_name, * availability_management_type, * sum_in_basket, * menu, * auction_settings, * bundle, * sizeschart_id, * sizeschart_name, * serialnumbers, * producer_codes_standard, * javaScriptInTheItemCard, * productAuctionDescriptionsData, * priceFormula, * productIndividualDescriptionsData, * productIndividualUrlsData, * productServicesDescriptionsData, * cnTaricCode, * productIsGratis, * dimensions, * responsibleProducerCode, * responsiblePersonCode, * dimensions, * depositProductId, * depositType, * depositCount, * minStockLevel, * productAttachments */
|
|
3056
3068
|
returnElements?: string[];
|
|
3057
3069
|
/** @description Product availability. Available values: "y" - available, "n" - unavailable. */
|
|
3058
|
-
productIsAvailable?:
|
|
3070
|
+
productIsAvailable?: "y" | "n";
|
|
3059
3071
|
/** @description Product visibility in store Available values: "y" - Visible, "n" - Invisible. */
|
|
3060
|
-
productIsVisible?:
|
|
3072
|
+
productIsVisible?: "y" | "n";
|
|
3061
3073
|
/** @description Product group ID */
|
|
3062
3074
|
productVersionId?: number;
|
|
3063
3075
|
/** @description Promoted product. Available values: "y" - promoted, "n" - not promoted. */
|
|
3064
|
-
productInPromotion?:
|
|
3076
|
+
productInPromotion?: "y" | "n";
|
|
3065
3077
|
/** @description Product on sale. Available values: "y" - on sale, "n" - not on sale. */
|
|
3066
|
-
productInDiscount?:
|
|
3078
|
+
productInDiscount?: "y" | "n";
|
|
3067
3079
|
/** @description Distinguished product. Available values: "y" - distinguished, "n" - not distinguished. */
|
|
3068
|
-
productInDistinguished?:
|
|
3080
|
+
productInDistinguished?: "y" | "n";
|
|
3069
3081
|
/** @description Special product. Available values: "y" - #!specjalny!#, "n" - not special. */
|
|
3070
|
-
productInSpecial?:
|
|
3082
|
+
productInSpecial?: "y" | "n";
|
|
3071
3083
|
/** @description Product available for points. Available values: "y" - Available for points, "n" - Unavailable for points. */
|
|
3072
|
-
productInForPointsSelling?:
|
|
3084
|
+
productInForPointsSelling?: "y" | "n";
|
|
3073
3085
|
/** @description Observed product. Available values: "Y" - observed, "n" - not observed. */
|
|
3074
|
-
productIsObservedByClients?:
|
|
3086
|
+
productIsObservedByClients?: "Y" | "n";
|
|
3075
3087
|
/** @description Element determines if default product (with 0 ID, contains settings of newly added products) should be omitted Available values: "y" - omits default product, "n" - allows to download default product. */
|
|
3076
|
-
skipDefaultProduct?:
|
|
3088
|
+
skipDefaultProduct?: "y" | "n";
|
|
3077
3089
|
/** @description The item specifies whether promotional prices are to be shown in price nodes. Available values: "y" - show promotional prices, "n" - do not show promotional prices. (default value) */
|
|
3078
|
-
showPromotionsPrices?:
|
|
3090
|
+
showPromotionsPrices?: "y" | "n";
|
|
3079
3091
|
/** @description List of categories in which sought products are present. */
|
|
3080
3092
|
categories?: {
|
|
3081
3093
|
/** @description Category id */
|
|
@@ -3122,7 +3134,7 @@ export type SearchProductsParams = {
|
|
|
3122
3134
|
/** @description Settings concerning narrowing list of products found by date. */
|
|
3123
3135
|
productDate?: {
|
|
3124
3136
|
/** @description Date type. Allowed values "added" - #!dataDodaniaProduktu!#, "finished" - date of running out of product, "resumed" - date of resuming product, "modified" - date of last modification of product, "quantity_changed" - date of last product stock quantity modification, "price_changed" - date of last price change, "modified_and_quantity_changed" - date of last modification and stock quantity change. */
|
|
3125
|
-
productDateMode?:
|
|
3137
|
+
productDateMode?: "added" | "finished" | "resumed" | "modified" | "quantity_changed" | "price_changed" | "modified_and_quantity_changed";
|
|
3126
3138
|
/** @description Starting date in the YYYY-MM-DD format */
|
|
3127
3139
|
productDateBegin?: string;
|
|
3128
3140
|
/** @description End date in the YYYY-MM-DD format */
|
|
@@ -3155,7 +3167,7 @@ export type SearchProductsParams = {
|
|
|
3155
3167
|
/** @description Name of series in indicated language */
|
|
3156
3168
|
seriesName?: string;
|
|
3157
3169
|
/** @description Language ID */
|
|
3158
|
-
langId?:
|
|
3170
|
+
langId?: LangId;
|
|
3159
3171
|
}[];
|
|
3160
3172
|
}[];
|
|
3161
3173
|
/** @description List of units of measure assigned to sought products. */
|
|
@@ -3183,14 +3195,14 @@ export type SearchProductsParams = {
|
|
|
3183
3195
|
/** @description Product availability in stocks */
|
|
3184
3196
|
productAvailableInStocks?: {
|
|
3185
3197
|
/** @description Determines whether availability in stocks has been set. Available values: "y" - is available in stocks, "n" - unavailable in stocks. */
|
|
3186
|
-
productIsAvailableInStocks?:
|
|
3198
|
+
productIsAvailableInStocks?: "y" | "n";
|
|
3187
3199
|
/** @description Narrowing list to stocks sought trough Empty list concerns all stocks. */
|
|
3188
3200
|
productAvailableInStocksIds?: number[];
|
|
3189
3201
|
};
|
|
3190
3202
|
/** @description Product availability on auctions */
|
|
3191
3203
|
productAvailableInAuctions?: {
|
|
3192
3204
|
/** @description Determines whether availability on auctions has been set. Available values: "y" - is available on auctions, "n" - is not available on auctions. */
|
|
3193
|
-
productIsAvailableInAuctions?:
|
|
3205
|
+
productIsAvailableInAuctions?: "y" | "n";
|
|
3194
3206
|
/** @description Narrow list of auction accounts sought through. */
|
|
3195
3207
|
productAvailableInAuctionsAccountsIds?: number[];
|
|
3196
3208
|
};
|
|
@@ -3206,7 +3218,7 @@ export type SearchProductsParams = {
|
|
|
3206
3218
|
sortDirection?: string;
|
|
3207
3219
|
}[];
|
|
3208
3220
|
/** @description Language ID that allows to search and return data in chosen language. This parameter is optional. If it's lacking, she search process unfolds in all available languages. */
|
|
3209
|
-
productSearchingLangId?:
|
|
3221
|
+
productSearchingLangId?: LangId;
|
|
3210
3222
|
/** @description Currency ID allowing to search and browse products in given currency. This parameter is optional, when it's lacking, the search process unfolds in all available currencies. */
|
|
3211
3223
|
productSearchingCurrencyId?: string;
|
|
3212
3224
|
/** @description Currency ID allowing for returning all product prices in an indicated currency */
|
|
@@ -3214,19 +3226,19 @@ export type SearchProductsParams = {
|
|
|
3214
3226
|
/** @description Annotation contains text. */
|
|
3215
3227
|
productHasNote?: string;
|
|
3216
3228
|
/** @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. */
|
|
3217
|
-
productInExportToPriceComparisonSites?:
|
|
3229
|
+
productInExportToPriceComparisonSites?: "y" | "selected" | "assign_selected" | "unassign_selected" | "n";
|
|
3218
3230
|
/** @description Visibility of an item in an export to Amazon Marketplace. Available values: "y" - Visible, "selected" - Visible on selected regional services, "n" - invisible. */
|
|
3219
|
-
productInExportToAmazonMarketplace?:
|
|
3231
|
+
productInExportToAmazonMarketplace?: "y" | "selected" | "n";
|
|
3220
3232
|
/** @description List of Amazon regional sites to which the product is exported (only in case of "selected" option) */
|
|
3221
3233
|
selectedAmazonMarketplacesList?: string[];
|
|
3222
3234
|
/** @description Product is bestseller. Available values: "n" - no, "y" - yes. */
|
|
3223
|
-
productInBestseller?:
|
|
3235
|
+
productInBestseller?: "n" | "y";
|
|
3224
3236
|
/** @description Product is new. Available values: "y" - is new, "n" - is not new. */
|
|
3225
|
-
productInNew?:
|
|
3237
|
+
productInNew?: "y" | "n";
|
|
3226
3238
|
/** @description Shops */
|
|
3227
3239
|
searchByShops?: {
|
|
3228
3240
|
/** @description Determine data search method on basis of options set for stores. Available values: "in_one_of_selected" - in one of indicated stores, "in_all_of_selected" - in all indicated stores, This parameter is optional. When it's lacking, search is performed by option: in one of indicated stores (in_one_of_selected). */
|
|
3229
|
-
searchModeInShops?:
|
|
3241
|
+
searchModeInShops?: "in_one_of_selected" | "in_all_of_selected";
|
|
3230
3242
|
/** @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. */
|
|
3231
3243
|
shopsMask?: number;
|
|
3232
3244
|
/** @description List of stores IDs When mask is determined, this parameter is omitted. */
|
|
@@ -3235,7 +3247,7 @@ export type SearchProductsParams = {
|
|
|
3235
3247
|
/** @description Price range for sought products. */
|
|
3236
3248
|
productSearchPriceRange?: {
|
|
3237
3249
|
/** @description Determines price type for indicated values. Available values: "retail_price" - Retail price of the product, "wholesale_price" - Wholesale price of the product, "minimal_price" - Product minimal price, "pos_price" - price for POS, "last_purchase_price" - Last purchase price. */
|
|
3238
|
-
productSearchPriceMode?:
|
|
3250
|
+
productSearchPriceMode?: "retail_price" | "wholesale_price" | "minimal_price" | "pos_price" | "last_purchase_price";
|
|
3239
3251
|
/** @description Minimal price for product. */
|
|
3240
3252
|
productSearchPriceMin?: number;
|
|
3241
3253
|
/** @description Maximum price for product. */
|
|
@@ -3246,15 +3258,15 @@ export type SearchProductsParams = {
|
|
|
3246
3258
|
/** @description VAT value for sought products */
|
|
3247
3259
|
productVatRates?: number[];
|
|
3248
3260
|
/** @description Is product VAT-free Allowed values "y" - yes, "n" - no. */
|
|
3249
|
-
productIsVatFree?:
|
|
3261
|
+
productIsVatFree?: "y" | "n";
|
|
3250
3262
|
/** @description Product has defined wholesale price. Available values: "y" - has wholesale price, "n" - does not have wholesale price. */
|
|
3251
|
-
productHasWholesalePrice?:
|
|
3263
|
+
productHasWholesalePrice?: "y" | "n";
|
|
3252
3264
|
/** @description Product visible even though out of stock Available values: "y" - visible even though out of stock, "n" - not visible when out of stock. */
|
|
3253
|
-
productInPersistent?:
|
|
3265
|
+
productInPersistent?: "y" | "n";
|
|
3254
3266
|
/** @description Settings of products returned with variants All products with variants are returned by default Available values: version_all - returns all variants, version_main - returns only main variant. */
|
|
3255
|
-
returnProductsVersions?:
|
|
3267
|
+
returnProductsVersions?: "version_all" | "version_main";
|
|
3256
3268
|
/** @description Do You wish to sum up the products in the basket as a one order? Available values: "y" - yes, "n" - no. */
|
|
3257
|
-
productInSumInBasket?:
|
|
3269
|
+
productInSumInBasket?: "y" | "n";
|
|
3258
3270
|
/** @description Product type. Allowed values: "product_item" - Goods, "product_packaging" - packaging, "product_bundle" - set. "product_collection" - collection. "product_service" - service. "product_virtual" - virtual product. "product_configurable" - configurable product. */
|
|
3259
3271
|
productType?: {
|
|
3260
3272
|
/** @description Should products be returned on list. By default this parameter is set on true. */
|
|
@@ -3316,6 +3328,8 @@ export type SearchOrdersParams = {
|
|
|
3316
3328
|
ordersStatuses?: string[];
|
|
3317
3329
|
/** @description Order statusses ids. */
|
|
3318
3330
|
ordersStatusesIds?: number[];
|
|
3331
|
+
/** @description Transaction type. */
|
|
3332
|
+
transactionType?: "national" | "oss" | "export" | "intra";
|
|
3319
3333
|
/** */
|
|
3320
3334
|
shippmentStatus?: "all" | "received" | "non-received";
|
|
3321
3335
|
/** @description Shipping companies (packages deliverers). */
|
|
@@ -3323,7 +3337,7 @@ export type SearchOrdersParams = {
|
|
|
3323
3337
|
/** @description Courier service identifiers */
|
|
3324
3338
|
couriersId?: number[];
|
|
3325
3339
|
/** @description Order payment method. Allowed values. "cash_on_delivery" - cash on delivery, "prepaid" - prepayment, "tradecredit" - Trade credit. */
|
|
3326
|
-
orderPaymentType?:
|
|
3340
|
+
orderPaymentType?: "cash_on_delivery" | "prepaid" | "tradecredit";
|
|
3327
3341
|
withMissingSalesDocuments?: string[];
|
|
3328
3342
|
/** @description Order type. Allowed values. "retail" - retail order, "wholesale" - wholesale order (can be added only by customer with wholesale account registered). Default value:: "retail" */
|
|
3329
3343
|
orderType?: "wholesale" | "retail" | "dropshipping" | "deliverer";
|
|
@@ -3348,9 +3362,9 @@ export type SearchOrdersParams = {
|
|
|
3348
3362
|
/** @description E-mail address. */
|
|
3349
3363
|
clientEmail?: string;
|
|
3350
3364
|
/** @description Parameter can be used to search for orders assigned to customer with VAT number. Available values: "y" - customer has VAT number, "n" - customer does not have VAT number. */
|
|
3351
|
-
clientHasTaxNumber?:
|
|
3365
|
+
clientHasTaxNumber?: "y" | "n";
|
|
3352
3366
|
/** @description Parameter allows to choose, by which data orders should be searched. Includes city, firstname, lastname. Available values: "billing_data" - search by billing data - default, "delivery_data"- search by delivery data, "billing_delivery_data" - search by billing and delivery data. */
|
|
3353
|
-
clientSearchingMode?:
|
|
3367
|
+
clientSearchingMode?: "billing_data" | "delivery_data" | "billing_delivery_data";
|
|
3354
3368
|
/** @description Customer's company name. */
|
|
3355
3369
|
clientFirm?: string;
|
|
3356
3370
|
/** @description Customer Tax no. */
|
|
@@ -3434,7 +3448,7 @@ export type SearchOrdersParams = {
|
|
|
3434
3448
|
/** @description Consignments numbers. */
|
|
3435
3449
|
packagesNumbers?: string[];
|
|
3436
3450
|
/** @description Does order have consignment number assigned. Available values: "y" - yes, "n" - no. */
|
|
3437
|
-
orderHasPackageNumbers?:
|
|
3451
|
+
orderHasPackageNumbers?: "y" | "n";
|
|
3438
3452
|
/** @description Multipack order. Available values: "y" - yes, "n" - no. */
|
|
3439
3453
|
hasMultiPackages?: "y" | "n";
|
|
3440
3454
|
};
|
|
@@ -3458,7 +3472,7 @@ export type SearchOrdersParams = {
|
|
|
3458
3472
|
orderPackingPersonLogin?: string;
|
|
3459
3473
|
/** @description Possibility of sorting returned list */
|
|
3460
3474
|
ordersBy?: {
|
|
3461
|
-
/** @description Name of field, list will be sorted by. Available values: "id" -
|
|
3475
|
+
/** @description Name of field, list will be sorted by. Available values: "id" - Order ID, "sn" - Order ID, "order_time" - Order placement time, "status" - Status order: t - finished , n - new, w - payment_waiting, d - delivery_waiting, o - on_order, b - packed, br - packed_ready, bf - packed_fulfillment, p - ready, wd - wait_for_dispatch, k - canceled, i - false, s - lost, z - returned, r - complainted, h - suspended, j - joined, l - missing, a - finished_ext, u - unconfirmed, "order_source" - Order source, "order_cost" - order cost calculated as a sum of: base order worth, delivery cost, payform cost, insurance cost, "discount_code" - order discount code, "ready_to_send_date" - orders with status p - ready first, "order_value" - order value calculated as a sum of: base order worth, delivery cost, payform cost, insurance cost */
|
|
3462
3476
|
elementName?: string;
|
|
3463
3477
|
/** @description Determines sorting direction. Available values: "ASC" - ascending, "DESC" - descending. */
|
|
3464
3478
|
sortDirection?: string;
|
|
@@ -3473,6 +3487,12 @@ export type SearchOrdersParams = {
|
|
|
3473
3487
|
orderExternalId?: string;
|
|
3474
3488
|
/** @description Order currency */
|
|
3475
3489
|
orderCurrency?: string;
|
|
3490
|
+
/** @description Subscription id */
|
|
3491
|
+
subscription?: number;
|
|
3492
|
+
/** @description Subscription ids */
|
|
3493
|
+
subscriptionIds?: number[];
|
|
3494
|
+
/** @description Orders from subscriptions */
|
|
3495
|
+
subscriptionsOrders?: "y" | "n";
|
|
3476
3496
|
};
|
|
3477
3497
|
|
|
3478
3498
|
export type SearchProductsParametersParams = {
|
|
@@ -3481,12 +3501,12 @@ export type SearchProductsParametersParams = {
|
|
|
3481
3501
|
/** @description Element text ID - can be entered instead of "id". */
|
|
3482
3502
|
textIds?: {
|
|
3483
3503
|
/** @description Language ID */
|
|
3484
|
-
languageId?:
|
|
3504
|
+
languageId?: LangId;
|
|
3485
3505
|
/** @description Text value */
|
|
3486
3506
|
value?: string;
|
|
3487
3507
|
}[];
|
|
3488
3508
|
/** @description List of languages */
|
|
3489
|
-
languagesIds?:
|
|
3509
|
+
languagesIds?: LangId[];
|
|
3490
3510
|
/** @description Whether to return a list of parameter value IDs */
|
|
3491
3511
|
parameterValueIds?: boolean;
|
|
3492
3512
|
/** @description Page with results number. Numeration starts from 0 */
|
|
@@ -3536,7 +3556,7 @@ export type SearchClientsCrmParams = {
|
|
|
3536
3556
|
/** @description Country ID in accordance with ISO-3166. */
|
|
3537
3557
|
clientCountryId?: string;
|
|
3538
3558
|
/** @description Language ID */
|
|
3539
|
-
langId?:
|
|
3559
|
+
langId?: LangId;
|
|
3540
3560
|
/** @description Customer service representative. */
|
|
3541
3561
|
clientCustomerServiceRepresentativeLogin?: string;
|
|
3542
3562
|
/** @description Customer group number */
|
|
@@ -3855,7 +3875,7 @@ export type PutSystemUnitsParams = {
|
|
|
3855
3875
|
/** @description Unit names */
|
|
3856
3876
|
descriptions?: {
|
|
3857
3877
|
/** @description ISO-639-3 Language */
|
|
3858
|
-
language?:
|
|
3878
|
+
language?: LangId;
|
|
3859
3879
|
/** @description Name (singular) (limit of 30 characters) */
|
|
3860
3880
|
nameSingular?: string;
|
|
3861
3881
|
/** @description Name (plural) (limit of 30 characters) */
|
|
@@ -3885,7 +3905,7 @@ export type PutSizesParams = {
|
|
|
3885
3905
|
operation: string;
|
|
3886
3906
|
lang_data?: {
|
|
3887
3907
|
/** @description Language code. Codes are compliant with ISO-639-3 standard. */
|
|
3888
|
-
lang_id?:
|
|
3908
|
+
lang_id?: LangId;
|
|
3889
3909
|
/** @description Category plural name. */
|
|
3890
3910
|
name?: string;
|
|
3891
3911
|
}[];
|
|
@@ -3902,7 +3922,7 @@ export type PutSizechartsParams = {
|
|
|
3902
3922
|
displayMode: "single" | "all";
|
|
3903
3923
|
languagesData?: {
|
|
3904
3924
|
/** @description Customer language ID. */
|
|
3905
|
-
language?:
|
|
3925
|
+
language?: LangId;
|
|
3906
3926
|
columns?: {
|
|
3907
3927
|
/** @description Column number */
|
|
3908
3928
|
columnNumber?: number;
|
|
@@ -3934,28 +3954,28 @@ export type PutProductsParametersParams = {
|
|
|
3934
3954
|
/** @description Element text ID - can be entered instead of "id". Recognized save format: "section" (without backslash), "parameter\" (parameter without assigned value). */
|
|
3935
3955
|
item_text_ids?: {
|
|
3936
3956
|
/** @description Language ID. */
|
|
3937
|
-
lang_id?:
|
|
3957
|
+
lang_id?: LangId;
|
|
3938
3958
|
/** @description Text value. */
|
|
3939
3959
|
value?: string;
|
|
3940
3960
|
}[];
|
|
3941
3961
|
/** @description Names of section, parameter or value. */
|
|
3942
3962
|
names?: {
|
|
3943
3963
|
/** @description Language ID. */
|
|
3944
|
-
lang_id?:
|
|
3964
|
+
lang_id?: LangId;
|
|
3945
3965
|
/** @description Text value. */
|
|
3946
3966
|
value?: string;
|
|
3947
3967
|
}[];
|
|
3948
3968
|
/** @description Descriptions of section, parameter or value. */
|
|
3949
3969
|
descriptions?: {
|
|
3950
3970
|
/** @description Language ID. */
|
|
3951
|
-
lang_id?:
|
|
3971
|
+
lang_id?: LangId;
|
|
3952
3972
|
/** @description Text value. */
|
|
3953
3973
|
value?: string;
|
|
3954
3974
|
}[];
|
|
3955
3975
|
/** @description Search descriptions of parameter value. */
|
|
3956
3976
|
search_description?: {
|
|
3957
3977
|
/** @description Language ID */
|
|
3958
|
-
lang_id?:
|
|
3978
|
+
lang_id?: LangId;
|
|
3959
3979
|
/** @description Text value */
|
|
3960
3980
|
value?: string;
|
|
3961
3981
|
/** @description Shop Id */
|
|
@@ -3964,7 +3984,7 @@ export type PutProductsParametersParams = {
|
|
|
3964
3984
|
/** @description Icons of section, parameter or value to display on the product card. */
|
|
3965
3985
|
card_icons?: {
|
|
3966
3986
|
/** @description Language ID. */
|
|
3967
|
-
lang_id?:
|
|
3987
|
+
lang_id?: LangId;
|
|
3968
3988
|
/** @description Text value. */
|
|
3969
3989
|
value?: string;
|
|
3970
3990
|
/** @description Shop Id */
|
|
@@ -3973,7 +3993,7 @@ export type PutProductsParametersParams = {
|
|
|
3973
3993
|
/** @description Icons of section, parameter or value to display on the list of products. */
|
|
3974
3994
|
link_icons?: {
|
|
3975
3995
|
/** @description Language ID. */
|
|
3976
|
-
lang_id?:
|
|
3996
|
+
lang_id?: LangId;
|
|
3977
3997
|
/** @description Text value. */
|
|
3978
3998
|
value?: string;
|
|
3979
3999
|
/** @description Shop Id */
|
|
@@ -4026,9 +4046,9 @@ export type PostWarrantiesParams = {
|
|
|
4026
4046
|
shopname?: {
|
|
4027
4047
|
languages?: {
|
|
4028
4048
|
/** @description Language ID. */
|
|
4029
|
-
language_id?:
|
|
4049
|
+
language_id?: LangId;
|
|
4030
4050
|
/** @description Language name. */
|
|
4031
|
-
language_name?:
|
|
4051
|
+
language_name?: LangId;
|
|
4032
4052
|
/** @description Literal in selected language. */
|
|
4033
4053
|
value?: string;
|
|
4034
4054
|
}[];
|
|
@@ -4037,9 +4057,9 @@ export type PostWarrantiesParams = {
|
|
|
4037
4057
|
description?: {
|
|
4038
4058
|
languages?: {
|
|
4039
4059
|
/** @description Language ID. */
|
|
4040
|
-
language_id?:
|
|
4060
|
+
language_id?: LangId;
|
|
4041
4061
|
/** @description Language name. */
|
|
4042
|
-
language_name?:
|
|
4062
|
+
language_name?: LangId;
|
|
4043
4063
|
/** @description Literal in selected language. */
|
|
4044
4064
|
value?: string;
|
|
4045
4065
|
}[];
|
|
@@ -4099,7 +4119,7 @@ export type PostEntriesParams = {
|
|
|
4099
4119
|
/** @description Element including entry content in selected languages */
|
|
4100
4120
|
langs: {
|
|
4101
4121
|
/** @description Language ID */
|
|
4102
|
-
langId:
|
|
4122
|
+
langId: LangId;
|
|
4103
4123
|
/** @description Name on the page */
|
|
4104
4124
|
title?: string;
|
|
4105
4125
|
/** @description short description */
|
|
@@ -4362,7 +4382,7 @@ export type PostSnippetsCookiesParams = {
|
|
|
4362
4382
|
/** @description Cookie description for each language. */
|
|
4363
4383
|
description?: {
|
|
4364
4384
|
/** @description Language code. */
|
|
4365
|
-
lang?:
|
|
4385
|
+
lang?: LangId;
|
|
4366
4386
|
/** @example Hello world */
|
|
4367
4387
|
body?: string;
|
|
4368
4388
|
}[];
|
|
@@ -4567,7 +4587,7 @@ export type PutClientsParams = {
|
|
|
4567
4587
|
/** @description Customer type, possible values: - person - if client sex is not determined, - person_male - when client is a male, - person_female - when a customer is a woman, - firm - when client is company. */
|
|
4568
4588
|
clientType?: "person" | "person_male" | "person_female" | "firm";
|
|
4569
4589
|
/** @description Language ID */
|
|
4570
|
-
langId?:
|
|
4590
|
+
langId?: LangId;
|
|
4571
4591
|
/** @description Defines availability of log in to other pages than the ones given in the element: shops . */
|
|
4572
4592
|
blockLoginToOtherShops?: boolean;
|
|
4573
4593
|
/** @description List of stores IDs When mask is determined, this parameter is omitted. */
|
|
@@ -5027,7 +5047,7 @@ export type PutEntriesParams = {
|
|
|
5027
5047
|
/** @description Element including entry content in selected languages */
|
|
5028
5048
|
langs?: {
|
|
5029
5049
|
/** @description Language ID */
|
|
5030
|
-
langId?:
|
|
5050
|
+
langId?: LangId;
|
|
5031
5051
|
/** @description Name on the page */
|
|
5032
5052
|
title?: string;
|
|
5033
5053
|
/** @description short description */
|
|
@@ -5156,7 +5176,7 @@ export type PutProductsBrandsParams = {
|
|
|
5156
5176
|
phoneGraphic?: string;
|
|
5157
5177
|
};
|
|
5158
5178
|
/** @description Language ID (code in ISO 639-2). */
|
|
5159
|
-
languageId?:
|
|
5179
|
+
languageId?: LangId;
|
|
5160
5180
|
shopsConfigurations?: {
|
|
5161
5181
|
/** @description Name. */
|
|
5162
5182
|
name?: string;
|
|
@@ -5207,7 +5227,7 @@ export type PutProductsDescriptionsParams = {
|
|
|
5207
5227
|
/** @description Array of language-dependent elements. */
|
|
5208
5228
|
productDescriptionsLangData?: {
|
|
5209
5229
|
/** @description Language ID */
|
|
5210
|
-
langId?:
|
|
5230
|
+
langId?: LangId;
|
|
5211
5231
|
/** @description Shop Id */
|
|
5212
5232
|
shopId?: number;
|
|
5213
5233
|
/** @description Product name. */
|
|
@@ -5297,7 +5317,7 @@ export type PostProductsBrandsParams = {
|
|
|
5297
5317
|
phoneGraphic?: string;
|
|
5298
5318
|
};
|
|
5299
5319
|
/** @description Language ID (code in ISO 639-2). */
|
|
5300
|
-
languageId?:
|
|
5320
|
+
languageId?: LangId;
|
|
5301
5321
|
shopsConfigurations?: {
|
|
5302
5322
|
/** @description Name. */
|
|
5303
5323
|
name?: string;
|
|
@@ -5347,7 +5367,7 @@ export type PostProductsOpinionsParams = {
|
|
|
5347
5367
|
/** @example content */
|
|
5348
5368
|
content?: string;
|
|
5349
5369
|
/** @description Customer language ID. */
|
|
5350
|
-
language?:
|
|
5370
|
+
language?: LangId;
|
|
5351
5371
|
/** @example picture */
|
|
5352
5372
|
picture?: string;
|
|
5353
5373
|
/** @description Shop Id */
|
|
@@ -5395,7 +5415,7 @@ export type PutProductsOpinionsParams = {
|
|
|
5395
5415
|
/** @example content */
|
|
5396
5416
|
content?: string;
|
|
5397
5417
|
/** @description Customer language ID. */
|
|
5398
|
-
language?:
|
|
5418
|
+
language?: LangId;
|
|
5399
5419
|
/** @description Reply to an opinion */
|
|
5400
5420
|
shopAnswer?: string;
|
|
5401
5421
|
/** @example picture */
|
|
@@ -5600,7 +5620,7 @@ export type PutProductsSeriesParams = {
|
|
|
5600
5620
|
/** @description Shop Id */
|
|
5601
5621
|
shopId?: number;
|
|
5602
5622
|
/** @description Customer language ID. */
|
|
5603
|
-
language?:
|
|
5623
|
+
language?: LangId;
|
|
5604
5624
|
/** @description Name on the page */
|
|
5605
5625
|
nameOnPage?: string;
|
|
5606
5626
|
/** @description Name displayed in the website header */
|
|
@@ -5964,7 +5984,7 @@ export type PutProductsQuestionsParams = {
|
|
|
5964
5984
|
/** @description Question ID. */
|
|
5965
5985
|
id?: number;
|
|
5966
5986
|
/** @description Language of the question e.g. 'pol', 'eng'. */
|
|
5967
|
-
lang?:
|
|
5987
|
+
lang?: LangId;
|
|
5968
5988
|
/** @description Your question(base64). */
|
|
5969
5989
|
question?: string;
|
|
5970
5990
|
/** @description Content of the answer(base64). */
|
|
@@ -6886,7 +6906,7 @@ export type PutMenuSortParams = {
|
|
|
6886
6906
|
/** @description Menu ID. */
|
|
6887
6907
|
menu_id: number;
|
|
6888
6908
|
/** @description Language ID. */
|
|
6889
|
-
lang_id:
|
|
6909
|
+
lang_id: LangId;
|
|
6890
6910
|
/** @description Menu element text identifier. */
|
|
6891
6911
|
parent_id?: number;
|
|
6892
6912
|
/** @description Menu element text identifier. Example: "item1\item2\item3". */
|
|
@@ -6952,7 +6972,7 @@ export type PutWarrantiesLanguageDataParams = {
|
|
|
6952
6972
|
warranty_id: string;
|
|
6953
6973
|
lang: {
|
|
6954
6974
|
/** @description Warranty language id (numeric) (three letter sequence). */
|
|
6955
|
-
lang_id?:
|
|
6975
|
+
lang_id?: LangId;
|
|
6956
6976
|
/** @description Warranty name. */
|
|
6957
6977
|
name?: string;
|
|
6958
6978
|
/** @description warranty icon for language. */
|
|
@@ -7225,4 +7245,19 @@ export type GetProductsAttachmentsGetContentParams = {
|
|
|
7225
7245
|
attachmentId: number;
|
|
7226
7246
|
};
|
|
7227
7247
|
|
|
7248
|
+
export type GetWmsLocationsParams = {
|
|
7249
|
+
/** @description Warehouse location ID */
|
|
7250
|
+
locationId?: number;
|
|
7251
|
+
/** @description Storage location code */
|
|
7252
|
+
locationCode?: string;
|
|
7253
|
+
/** @description Stock ID */
|
|
7254
|
+
stockId?: number;
|
|
7255
|
+
/** @description Elements to be returned by the endpoint. By default all elements are returned. Available values: locationName, locationPath, locationCode, stockId, products */
|
|
7256
|
+
returnElements?: ("locationName" | "locationPath" | "locationCode" | "stockId" | "products")[];
|
|
7257
|
+
/** @description Page with results number. Numeration starts from 0 */
|
|
7258
|
+
resultsPage?: number;
|
|
7259
|
+
/** @description Number of results on page. Value from 1 to 100 */
|
|
7260
|
+
resultsLimit?: number;
|
|
7261
|
+
};
|
|
7262
|
+
|
|
7228
7263
|
export { };
|