idosell 0.3.15 → 0.3.17

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.
@@ -27,13 +27,14 @@ type FaultCodeString = {
27
27
  faultString: string;
28
28
  }
29
29
 
30
+ /** Typechecked 2025-08-02 */
30
31
  export type SearchOrdersResponse = {
31
32
  Results: {
32
- /** @description Order ID i.e. login-1 */
33
+ /** @description Order ID. */
33
34
  orderId: string;
34
35
  /** @description Order note supported by IAI Bridge. */
35
36
  orderBridgeNote: string;
36
- /** @description Order serial number. i.e. 12345 */
37
+ /** @description Order serial number. */
37
38
  orderSerialNumber: number;
38
39
  /** @description Order type. List of values: "p" - wholesale order placed in panel, "t" - wholesale order placed in shop, "n" - retail order placed in shop, "r" - retail order placed in panel. */
39
40
  orderType: "p" | "t" | "n" | "r";
@@ -50,7 +51,7 @@ export type SearchOrdersResponse = {
50
51
  /** @description Customer's company name. */
51
52
  clientFirm: string;
52
53
  /** @description Product suggestion. */
53
- clientAdditional: string;
54
+ clientAdditional?: string;
54
55
  /** @description Street and number. */
55
56
  clientStreet: string;
56
57
  /** @description Customer's postal code. */
@@ -103,7 +104,7 @@ export type SearchOrdersResponse = {
103
104
  /** @description Internal Receiving Point Identifier. */
104
105
  clientDeliveryAddressPickupPointInternalId: number;
105
106
  };
106
- clientPickupPointAddress: {
107
+ clientPickupPointAddress?: {
107
108
  /** @description Collection point ID. */
108
109
  pickupPointId: string;
109
110
  /** @description Town / City. */
@@ -112,6 +113,7 @@ export type SearchOrdersResponse = {
112
113
  street: string;
113
114
  /** @description ZIP / Post code. */
114
115
  zipCode: string;
116
+ /** @example description */
115
117
  description: string;
116
118
  /** @description Latitude. */
117
119
  latitude: number;
@@ -121,7 +123,7 @@ export type SearchOrdersResponse = {
121
123
  name: string;
122
124
  };
123
125
  /** @description Buyer's address data. */
124
- payerAddress: {
126
+ payerAddress?: {
125
127
  /** @description Buyer's address id. */
126
128
  payerAddressId: string;
127
129
  /** @description Buyer's first name. */
@@ -182,16 +184,18 @@ export type SearchOrdersResponse = {
182
184
  apiFlag: "none" | "registered" | "realized" | "registered_pos" | "realized_pos" | "registration_fault";
183
185
  /** @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. */
184
186
  orderStatus: string;
187
+ /** @example dropshippingOrderStatus */
185
188
  dropshippingOrderStatus: string;
186
189
  /** @description Type of order confirmation. Confirmations listing: "none" - order unconfirmed , "email" - order confirmed by e-mail, "phone_client" - order confirmed by phone call made by client, "phone_service" - order confirmed by phone call made by staff, "postauction" - order confirmed by auction return page, "willingness" - confirmed by willingness to buy letter, "auctionfod" - confirmed by after-sales form Allegro. */
187
190
  orderConfirmation: string;
188
191
  /** @description Date of order placing in YYYY-MM-DD HH:MM:SS format. */
189
192
  orderAddDate: string;
190
193
  /** @description Date of order sending in YYYY-MM-DD HH:MM:SS format. */
191
- orderDispatchDate: string;
194
+ orderDispatchDate: 0 | string | null;
195
+ /** @example receivedDate */
192
196
  receivedDate: string;
193
197
  /** @description Order handling time in seconds. */
194
- orderPrepareTime: string;
198
+ orderPrepareTime: number | string;
195
199
  /** @description Customer comments on order. */
196
200
  clientNoteToOrder: string;
197
201
  /** @description Customer remarks for courier. */
@@ -211,7 +215,7 @@ export type SearchOrdersResponse = {
211
215
  /** @description Currency average rate set for order (by default, an average rate of order adding date, if it wasn't manually changed). */
212
216
  orderCurrencyValue: number;
213
217
  /** @description Currency scaler. */
214
- orderCurrencyScale: number;
218
+ orderCurrencyScale?: number;
215
219
  /** @description Panel billing currency exchange rate in relation to billing currency in the shop . */
216
220
  billingCurrencyRate: number;
217
221
  /** @description Products cost. */
@@ -225,6 +229,7 @@ export type SearchOrdersResponse = {
225
229
  };
226
230
  /** @description Information on order value in shop account currency. */
227
231
  orderBaseCurrency: {
232
+ /** @example billingCurrency */
228
233
  billingCurrency: string;
229
234
  /** @description Products cost. */
230
235
  orderProductsCost: number;
@@ -275,9 +280,9 @@ export type SearchOrdersResponse = {
275
280
  /** @description Currency ID */
276
281
  currencyId: string;
277
282
  /** @description Number of voucher used in a payment. */
278
- voucherNumber: string;
283
+ voucherNumber?: string;
279
284
  /** @description Number of gift card used in a payment. */
280
- giftCardNumber: string;
285
+ giftCardNumber?: string;
281
286
  }[];
282
287
  /** @description Order source data. */
283
288
  orderSourceResults: {
@@ -286,7 +291,7 @@ export type SearchOrdersResponse = {
286
291
  /** @description Shop Id */
287
292
  shopId: number;
288
293
  /** @description Auction site order comes from. Auction sites listing: "allegro" - Allegro.pl, "testwebapi" - Allegro.pl test site, "ebay" - eBay. */
289
- auctionsServiceName: string;
294
+ auctionsServiceName: string | null;
290
295
  /** @description Detailed information on order source. */
291
296
  orderSourceDetails: {
292
297
  /** @description order source type - possible values:. "self_added" - Orders from panel, "shop" - Orders from shop, "search_engine" - Orders from search engines, "auction" - Orders from auctions, "advertisement_campaign" - Advertisement campaigns, "price_comparer" - Price comparison sites, "affiliate_program" - Affiliate programme, "api" - Order from API, "eletronic_offer" - Order from ODT price lst, "cpa" - Order from CPA program, "refferer_site" - Order from reference sites, "pos" - Orders from POS, "marketplace" - Order from the Marketplace, "iai_ads" - Orders from IAI Ads */
@@ -297,10 +302,12 @@ export type SearchOrdersResponse = {
297
302
  orderSourceTypeId: number;
298
303
  /** @description Numerical ID of order source. */
299
304
  orderSourceId: number;
300
- entryProductIdBeforeOrder: number;
301
- sourcePageUrl: string;
305
+ /** @example 1 */
306
+ entryProductIdBeforeOrder?: number;
307
+ /** @example sourcePageUrl */
308
+ sourcePageUrl?: string;
302
309
  /** @description The order ID of the external service */
303
- orderExternalId: string;
310
+ orderExternalId: string | null;
304
311
  /** @description Order from the InPost Fresh marketplace */
305
312
  fresh: "y" | "n";
306
313
  /** @description Order supported by InPost fulfillment */
@@ -315,22 +322,23 @@ export type SearchOrdersResponse = {
315
322
  orderSourceTypeId: number;
316
323
  /** @description Numerical ID of order source. */
317
324
  orderSourceId: number;
325
+ /** @example entryDate */
318
326
  entryDate: string;
319
327
  }[];
320
328
  };
321
329
  /** @description Data of auction, order comes from (only if it comes from auction). */
322
330
  auctionInfo: {
323
331
  /** @description Account ID on auction site. */
324
- auctionClientId: string;
332
+ auctionClientId?: string;
325
333
  /** @description Account login on auction site. */
326
- auctionClientLogin: string;
334
+ auctionClientLogin?: string;
327
335
  /** @description #!TablicaNumerowAukcjiDoZamowienia!#. */
328
- auctionItemsIds: {
336
+ auctionItemsIds?: {
329
337
  /** @description Auction number. */
330
338
  auctionItemId: string;
331
339
  }[];
332
340
  /** @description The customer's email address at the auction service. */
333
- auctionClientEmail: string;
341
+ auctionClientEmail?: string;
334
342
  };
335
343
  /** @description Consignment data. */
336
344
  dispatch: {
@@ -360,7 +368,7 @@ export type SearchOrdersResponse = {
360
368
  /** @description External product system code */
361
369
  productCode: string;
362
370
  /** @description Name of the parameter value, e.g. orange, green, red */
363
- versionName: string;
371
+ versionName?: string;
364
372
  /** @description Size identifier */
365
373
  sizeId: string;
366
374
  /** @description Size name */
@@ -370,7 +378,7 @@ export type SearchOrdersResponse = {
370
378
  /** @description Stock ID */
371
379
  stockId: number;
372
380
  /** @description Serial number of the product. */
373
- productSerialNumber: string;
381
+ productSerialNumber?: string;
374
382
  /** @description Product quantity. */
375
383
  productQuantity: number;
376
384
  /** @description Weight. */
@@ -378,7 +386,7 @@ export type SearchOrdersResponse = {
378
386
  /** @description Value of VAT */
379
387
  productVat: number;
380
388
  /** @description Is product VAT free Allowed values "y" - yes, "n" - no. */
381
- productVatFree: string;
389
+ productVatFree?: string;
382
390
  /** @description Gross price of the product in the currency of the administration panel. */
383
391
  productPanelPrice: number;
384
392
  /** @description Net price of the product in the currency of the administration panel. */
@@ -392,7 +400,7 @@ export type SearchOrdersResponse = {
392
400
  /** @description Product net price of order in shop account currency. */
393
401
  productOrderPriceNetBaseCurrency: number;
394
402
  /** @description List of product suggestions . */
395
- orderAdditionalList: {
403
+ orderAdditionalList?: {
396
404
  /** @description Product suggestion. */
397
405
  orderAdditional: {
398
406
  /** @description Name of suggestion. */
@@ -403,12 +411,14 @@ export type SearchOrdersResponse = {
403
411
  };
404
412
  /** @description Client's remarks on product. */
405
413
  remarksToProduct: string;
414
+ /** @description Label for grouping products. */
415
+ label: string | null;
406
416
  /** @description Product selling mode. Available values: "money", "gift", "points". */
407
417
  orderSalesMode: "money" | "gift" | "points";
408
418
  /** @description A set's ID. */
409
419
  bundleId: number;
410
420
  /** @description Serial numbers. */
411
- productSerialNumbers: string;
421
+ productSerialNumbers: string | null;
412
422
  /** @description Additional information. */
413
423
  productOrderAdditional: string;
414
424
  /** @description Item in basket. */
@@ -416,14 +426,16 @@ export type SearchOrdersResponse = {
416
426
  /** @description price information. */
417
427
  productPriceLog: string;
418
428
  /** @description Information about the selected parameters in the configurator. */
419
- priceFormulaParameters: {
429
+ priceFormulaParameters?: {
420
430
  /** @description Parameter ID */
421
431
  parameterId: string;
422
432
  /** @description Parameter name. */
423
433
  parameterName: string;
424
434
  /** @description Parameter values */
425
435
  parameterValues: {
436
+ /** @example valueId */
426
437
  valueId: string;
438
+ /** @example valueName */
427
439
  valueName: string;
428
440
  }[];
429
441
  }[];
@@ -439,7 +451,7 @@ export type SearchOrdersResponse = {
439
451
  /** @description Note to the order. */
440
452
  orderNote: string;
441
453
  /** @description Information on used discount code. */
442
- discountCode: {
454
+ discountCode?: {
443
455
  /** @description Campaign ID. */
444
456
  campaignId: string;
445
457
  /** @description Name of code. */
@@ -448,14 +460,14 @@ export type SearchOrdersResponse = {
448
460
  discountCodeValue: string;
449
461
  };
450
462
  /** @description Discount card */
451
- discountCard: {
463
+ discountCard?: {
452
464
  /** @description Name of card */
453
465
  discountCardName: string;
454
466
  };
455
467
  /** @description Order handler. */
456
468
  orderOperatorLogin: string;
457
469
  /** @description Order picker. */
458
- orderPackingPersonLogin: string;
470
+ orderPackingPersonLogin: string | null;
459
471
  /** @description Sale date. ISO 8602 format. */
460
472
  purchaseDate: string;
461
473
  /** @description Modification date in YYYY-MM-DD HH:MM:SS format . */
@@ -466,6 +478,7 @@ export type SearchOrdersResponse = {
466
478
  }[];
467
479
  } & PagedResponse;
468
480
 
481
+ /** Typechecked 2025-08-02 */
469
482
  export type SearchProductsResponse = {
470
483
  /** @description Object contains detailed information on result of operation. */
471
484
  results: {
@@ -473,6 +486,7 @@ export type SearchProductsResponse = {
473
486
  productId: number;
474
487
  /** @description External product system code. */
475
488
  productDisplayedCode?: string;
489
+ /** @example productIsDeleted */
476
490
  productIsDeleted?: string;
477
491
  /** @description Annotation. */
478
492
  productNote?: string;
@@ -606,8 +620,10 @@ export type SearchProductsResponse = {
606
620
  /** @description URL to small icon graphic file */
607
621
  productIconSmallUrl: string;
608
622
  /** @description MD5 hash of large icon graphic file */
609
- productIconHash?: string;
623
+ productIconHash?: string | false;
624
+ /** @example productIconLargeUrlSecond */
610
625
  productIconLargeUrlSecond?: string;
626
+ /** */
611
627
  productIconLargeSizeSecond?: number;
612
628
  };
613
629
  /** @description Information about the external listing icon */
@@ -626,9 +642,13 @@ export type SearchProductsResponse = {
626
642
  productAuctionIconSmallUrl?: string;
627
643
  /** @description MD5 hash of large icon graphic file */
628
644
  productAuctionIconHash?: string;
645
+ /** @example productAuctionIconLargeUrlSecond */
629
646
  productAuctionIconLargeUrlSecond?: string;
647
+ /** */
630
648
  productAuctionIconLargeSizeSecond?: number;
649
+ /** @example productAuctionIconSmallUrlSecond */
631
650
  productAuctionIconSmallUrlSecond?: string;
651
+ /** */
632
652
  productAuctionIconSmallSizeSecond?: number;
633
653
  };
634
654
  /** @description Information about the product group icon */
@@ -647,18 +667,26 @@ export type SearchProductsResponse = {
647
667
  productGroupIconSmallUrl?: string;
648
668
  /** @description MD5 hash of large icon graphic file */
649
669
  productGroupIconHash?: string;
670
+ /** @example productGroupIconLargeUrlSecond */
650
671
  productGroupIconLargeUrlSecond?: string;
672
+ /** @example productGroupIconLargeSizeSecond */
651
673
  productGroupIconLargeSizeSecond?: string;
674
+ /** @example productGroupIconSmallUrlSecond */
652
675
  productGroupIconSmallUrlSecond?: string;
676
+ /** */
653
677
  productGroupIconSmallSize?: number;
678
+ /** */
654
679
  productGroupIconSmallSizeSecond?: number;
655
680
  };
656
681
  /** @description Product photos details. */
657
682
  productImages?: {
658
683
  /** @description URL of a large graphics */
659
684
  productImageLargeUrl?: string;
685
+ /** @example productImageLargeUrlSecond */
660
686
  productImageLargeUrlSecond?: string;
687
+ /** @example productImageMediumUrlSecond */
661
688
  productImageMediumUrlSecond?: string;
689
+ /** @example productImageSmallUrlSecond */
662
690
  productImageSmallUrlSecond?: string;
663
691
  /** @description URL of a medium graphics */
664
692
  productImageMediumUrl?: string;
@@ -772,7 +800,7 @@ export type SearchProductsResponse = {
772
800
  /** @description The same price. Available values: "y" - yes, "n" - no. */
773
801
  versionCommonPrice: string;
774
802
  /** @description Same price for auction services. Available values: "y" - yes, "n" - no. */
775
- versionCommonPriceAuctions: string;
803
+ versionCommonPriceAuctions?: string;
776
804
  /** @description Same advance. Available values: "y" - yes, "n" - no. */
777
805
  versionCommonAdvance: string;
778
806
  /** @description Same quantity discount. Available values: "y" - yes, "n" - no. */
@@ -782,19 +810,19 @@ export type SearchProductsResponse = {
782
810
  /** @description The same loyalty points. Available values: "y" - yes, "n" - no. */
783
811
  versionCommonProfitPoints: string;
784
812
  /** @description The same promotion. Available values: "y" - yes, "n" - no. */
785
- versionCommonPromotion: string;
813
+ versionCommonPromotion?: string;
786
814
  /** @description The same loyalty discount. Available values: "y" - yes, "n" - no. */
787
- versionCommonDiscount: string;
815
+ versionCommonDiscount?: string;
788
816
  /** @description The same privileged products. Available values: "y" - yes, "n" - no. */
789
- versionCommonDistinguished: string;
817
+ versionCommonDistinguished?: string;
790
818
  /** @description The same for special. Available values: "y" - yes, "n" - no. */
791
- versionCommonSpecial: string;
819
+ versionCommonSpecial?: string;
792
820
  /** @description The same related product. Available values: "y" - yes, "n" - no. */
793
821
  versionCommonAssociated: string;
794
822
  /** @description The same visibility. Available values: "y" - yes, "n" - no. */
795
823
  versionCommonVisibility: string;
796
824
  /** @description Same display when not in stock. Available values: "y" - yes, "n" - no. */
797
- versionCommonPersistent: string;
825
+ versionCommonPersistent?: string;
798
826
  /** @description The same priority. Available values: "y" - yes, "n" - no. */
799
827
  versionCommonPriority: string;
800
828
  /** @description The same shops. Available values: "y" - yes, "n" - no. */
@@ -802,7 +830,7 @@ export type SearchProductsResponse = {
802
830
  /** @description The same sizes. Available values: "y" - yes, "n" - no. */
803
831
  versionCommonSizes: string;
804
832
  /** @description The same unit of measure. Available values: "y" - yes, "n" - no. */
805
- versionCommonUnit: string;
833
+ versionCommonUnit?: string;
806
834
  /** @description The same weight. Available values: "y" - yes, "n" - no. */
807
835
  versionCommonWeight: string;
808
836
  /** @description The same parameters. possible values "y" - yes, "n" - no. */
@@ -830,10 +858,10 @@ export type SearchProductsResponse = {
830
858
  /** @description The same objects in menu Available values: "y" - yes, "n" - no. */
831
859
  versionCommonMenuItems: string;
832
860
  /** @description Same promotions Available values: "y" - yes, "n" - no. */
833
- versionCommonPromotions: string;
861
+ versionCommonPromotions?: string;
834
862
  };
835
863
  /** @description List of product variants. */
836
- versionProductsIds: number[];
864
+ versionProductsIds: string[];
837
865
  };
838
866
  /** @description Recommended products data. */
839
867
  associatedProductsIds?: number[];
@@ -870,16 +898,16 @@ export type SearchProductsResponse = {
870
898
  /** @description Product meta title. */
871
899
  productMetaTitle: string;
872
900
  /** @description Product meta description. */
873
- productMetaDescription: string;
901
+ productMetaDescription?: string;
874
902
  /** @description Product meta keywords. */
875
903
  productMetaKeywords: string;
876
904
  }[];
877
905
  /** @description Product data for auction services */
878
906
  productAuctionDescriptionsData?: {
879
907
  /** @description Auction system ID */
880
- productAuctionId: string;
908
+ productAuctionId: number;
881
909
  /** @description Auction site ID */
882
- productAuctionSiteId: string;
910
+ productAuctionSiteId: number;
883
911
  /** @description Product name for auction service. */
884
912
  productAuctionName: string;
885
913
  /** @description Subtitle for auction service */
@@ -925,9 +953,9 @@ export type SearchProductsResponse = {
925
953
  /** @description Object determines if the promotion should be active.. Allowed values: "y" - active promotion, "n" - inactive promotion. */
926
954
  promoteItemEnabled: string;
927
955
  /** @description Strikethrough price */
928
- promoteItemNormalPrice: number;
956
+ promoteItemNormalPrice?: number;
929
957
  /** @description Strikethrough wholesale price */
930
- promoteItemWholesaleNormalPrice: number;
958
+ promoteItemWholesaleNormalPrice?: number;
931
959
  /** @description Switching off date */
932
960
  promoteItemEndingDate?: string;
933
961
  };
@@ -1021,7 +1049,7 @@ export type SearchProductsResponse = {
1021
1049
  /** @description Product stock quantity */
1022
1050
  productSizeQuantity: number;
1023
1051
  /** @description Information of reservations */
1024
- productSizeReservations: {
1052
+ productSizeReservations?: {
1025
1053
  /** @description Number of products reserved ad hoc. */
1026
1054
  productSizeReservationAdhoc: number;
1027
1055
  /** @description Number of products reserved for auctions. */
@@ -1065,27 +1093,27 @@ export type SearchProductsResponse = {
1065
1093
  /** @description Available stock quantity of product from all stocks. */
1066
1094
  productSizeQuantityAllStocks: number;
1067
1095
  /** @description Available product quantity in own stock from before 1 day . */
1068
- productSizeDisposition1d: number;
1096
+ productSizeDisposition1d?: number;
1069
1097
  /** @description Available product quantity in own stock from before 2 Days. */
1070
- productSizeDisposition2d: number;
1098
+ productSizeDisposition2d?: number;
1071
1099
  /** @description Available product quantity in own stock from before 3 Days. */
1072
- productSizeDisposition3d: number;
1100
+ productSizeDisposition3d?: number;
1073
1101
  /** @description Available product quantity in own stock from before 4 Days. */
1074
- productSizeDisposition4d: number;
1102
+ productSizeDisposition4d?: number;
1075
1103
  /** @description Available product quantity in own stock from before 5 Days. */
1076
- productSizeDisposition5d: number;
1104
+ productSizeDisposition5d?: number;
1077
1105
  /** @description Available product quantity in own stock from before 6 Days. */
1078
- productSizeDisposition6d: number;
1106
+ productSizeDisposition6d?: number;
1079
1107
  /** @description Available product quantity in own stock from before 7 Days. */
1080
- productSizeDisposition7d: number;
1108
+ productSizeDisposition7d?: number;
1081
1109
  /** @description Available product quantity in own stock from before 1 week. */
1082
- productSizeDisposition1w: number;
1110
+ productSizeDisposition1w?: number;
1083
1111
  /** @description Available product quantity in own stock from before 2 weeks. */
1084
- productSizeDisposition2w: number;
1112
+ productSizeDisposition2w?: number;
1085
1113
  /** @description Available product quantity in own stock from before 3 weeks. */
1086
- productSizeDisposition3w: number;
1114
+ productSizeDisposition3w?: number;
1087
1115
  /** @description Available product quantity in own stock from before 4 weeks. */
1088
- productSizeDisposition4w: number;
1116
+ productSizeDisposition4w?: number;
1089
1117
  }[];
1090
1118
  };
1091
1119
  /** @description Delivery data */
@@ -1300,7 +1328,7 @@ export type SearchProductsResponse = {
1300
1328
  /** @description Price settings, possible values: "manual" - Price entered manually, "automatically_calculated" - Price calculated automatically. */
1301
1329
  auctionPricesConfig: string;
1302
1330
  /** @description Configuration details for setting of parameter prices_config=automatically_calculated */
1303
- auctionPricesConfigAutomatonDetails: {
1331
+ auctionPricesConfigAutomatonDetails?: {
1304
1332
  /** @description Price name, one of values: retail, wholsale, minimal. */
1305
1333
  priceAutomatonPriceName: string;
1306
1334
  /** @description Price setting, one of values: own, last_purchased, avarage_purchased, retail, wholsale, minimal */
@@ -1331,7 +1359,7 @@ export type SearchProductsResponse = {
1331
1359
  priceAutomatonDecimalRoundValue: number;
1332
1360
  }[];
1333
1361
  /** @description Parameters for sizes */
1334
- productAuctionsSizes: {
1362
+ productAuctionsSizes?: {
1335
1363
  /** @description Size identifier */
1336
1364
  sizeId: string;
1337
1365
  /** @description Configuration details for setting of parameter prices_config=automatically_calculated */
@@ -1372,7 +1400,7 @@ export type SearchProductsResponse = {
1372
1400
  /** @description price comparison website ID */
1373
1401
  priceComparisonSiteId: number;
1374
1402
  /** @description Whether the product is exported in the feed to the sales service */
1375
- active: boolean;
1403
+ active?: boolean;
1376
1404
  /** @description price comparison website name */
1377
1405
  priceComparisonSiteName: string;
1378
1406
  /** @description Price settings, possible values: "manual" - Price entered manually, "automatically_calculated" - Price calculated automatically. */
@@ -1411,7 +1439,7 @@ export type SearchProductsResponse = {
1411
1439
  /** @description Supplier ID. */
1412
1440
  delivererId?: number;
1413
1441
  /** @description Supplier name. */
1414
- delivererName?: string;
1442
+ delivererName?: string | null;
1415
1443
  /** @description Sizes available for products data. */
1416
1444
  productSizes?: {
1417
1445
  /** @description Size identifier */
@@ -1487,7 +1515,7 @@ export type SearchProductsResponse = {
1487
1515
  productParameters?: {
1488
1516
  /** @description Parameter ID */
1489
1517
  parameterId: number;
1490
- /** @description Parameter type * @enum {string} */
1518
+ /** @description Parameter type */
1491
1519
  parameterType: "section" | "parameter";
1492
1520
  /** @description Language data */
1493
1521
  parameterDescriptionsLangData: {
@@ -1543,7 +1571,7 @@ export type SearchProductsResponse = {
1543
1571
  priceFormulaFunction: string;
1544
1572
  };
1545
1573
  /** @description Identifiers of the sets, to which the goods are assigned */
1546
- bundledIds?: number[];
1574
+ bundledIds?: string[];
1547
1575
  /** @description Data of individual descriptions for stores */
1548
1576
  productIndividualDescriptionsData?: {
1549
1577
  /** @description Shop Id */
@@ -1563,6 +1591,7 @@ export type SearchProductsResponse = {
1563
1591
  shopId: string;
1564
1592
  /** @description Language ID */
1565
1593
  langId: string;
1594
+ /** @example url */
1566
1595
  url: string;
1567
1596
  }[];
1568
1597
  /** @description Individual description data for external services */
@@ -1594,11 +1623,11 @@ export type SearchProductsResponse = {
1594
1623
  /** @description Exclusion from the Smile service */
1595
1624
  excludeSmileService: boolean;
1596
1625
  /** @description List of courier services which cannot be used to ship this product */
1597
- disallowedCouriers: number[];
1626
+ disallowedCouriers: string[];
1598
1627
  };
1599
1628
  /** @description Free shipping settings */
1600
1629
  freeShippingSettings?: {
1601
- /** @description Edition mode * @enum {string} */
1630
+ /** @description Edition mode */
1602
1631
  mode: "no" | "onlyProduct" | "wholeBasket";
1603
1632
  /** @description Set free shipping for the payment method only . */
1604
1633
  availablePaymentForms: {
@@ -1617,7 +1646,7 @@ export type SearchProductsResponse = {
1617
1646
  availableRegions: number[];
1618
1647
  };
1619
1648
  /** @description Return and complaint settings */
1620
- returnProductSettings: {
1649
+ returnProductSettings?: {
1621
1650
  /** @description Product can be returned */
1622
1651
  returnOptions: {
1623
1652
  enabled: boolean;
@@ -1662,9 +1691,9 @@ export type SearchProductsResponse = {
1662
1691
  productOverallWeight: number;
1663
1692
  };
1664
1693
  /** @description Responsible producer code */
1665
- responsibleProducerCode?: string;
1694
+ responsibleProducerCode?: string | null;
1666
1695
  /** @description Responsible person code */
1667
- responsiblePersonCode?: string;
1696
+ responsiblePersonCode?: string | null;
1668
1697
  }[];
1669
1698
  } & PagedResponse;
1670
1699
 
@@ -1728,10 +1757,12 @@ type ProductParameter = {
1728
1757
  parameterValueIds: number[];
1729
1758
  }
1730
1759
 
1760
+ /** Typechecked 2025-08-02 */
1731
1761
  export type SearchProductsParametersResponse = {
1732
1762
  parametersResult: Record<string, ProductParameter>;
1733
1763
  } & PagedResponse;
1734
1764
 
1765
+ /** Typechecked 2025-08-02 */
1735
1766
  export type SearchClientsCrmResponse = {
1736
1767
  /** @description List of customers. */
1737
1768
  clientsResults: {
@@ -1741,7 +1772,7 @@ export type SearchClientsCrmResponse = {
1741
1772
  clientLogin: string;
1742
1773
  /** @description E-mail address. */
1743
1774
  clientEmail: string;
1744
- /** @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. */
1775
+ /** @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. */
1745
1776
  clientType: "person" | "person_male" | "person_female" | "firm";
1746
1777
  /** @description Determines, whether client is a wholesaler. */
1747
1778
  clientIsWholesaler: "yes" | "no";
@@ -1763,10 +1794,10 @@ export type SearchClientsCrmResponse = {
1763
1794
  clientLoyaltyPoints: number;
1764
1795
  /** @description Customer discount information */
1765
1796
  clientDiscount: {
1766
- /** @description Discount type:- advanced,- simple,- none,- group. */
1797
+ /** @description Discount type: - advanced, - simple, - none, - group. */
1767
1798
  clientDiscountType: "advanced" | "simple" | "none" | "group";
1768
1799
  /** @description percentage discount value. (No data is returned if rebate_type is not "simple"). */
1769
- clientDiscountValue: number;
1800
+ clientDiscountValue?: number;
1770
1801
  };
1771
1802
  /** @description Date of last purchase. */
1772
1803
  clientLastPurchaseDate: string;
@@ -1779,12 +1810,12 @@ export type SearchClientsCrmResponse = {
1779
1810
  /** @description Store name. */
1780
1811
  shopName: string;
1781
1812
  }[];
1782
- /** @description Information about the loyalty programpossible values:- yes_voucher - when customers are in a loyalty program and have only used vouchers,- yes_voucher_cash - when customers are in a loyalty program and have only used vouchers or cash deposits,- yes_clients,- yes_orders - when customers are in the loyalty program and have made at least one order,- no - when customers are in the loyalty program,- banned - when customers are blocked. */
1813
+ /** @description Information about the loyalty program possible values: - yes_voucher - when customers are in a loyalty program and have only used vouchers, - yes_voucher_cash - when customers are in a loyalty program and have only used vouchers or cash deposits, - yes_clients, - yes_orders - when customers are in the loyalty program and have made at least one order, - no - when customers are in the loyalty program, - banned - when customers are blocked. */
1783
1814
  clientAffiliateProgram: {
1784
- /** @description Does the customer participate in the loyalty program:- yes_voucher_cash,- yes_voucher,- no,- banned. */
1815
+ /** @description Does the customer participate in the loyalty program: - yes_voucher_cash, - yes_voucher, - no, - banned. */
1785
1816
  clientAffiliateProgramValue: "yes_voucher_cash" | "yes_voucher" | "no" | "banned";
1786
1817
  /** @description Data about loyalty program participant, omitted if active = no / banned. */
1787
- affiliatePrograms: {
1818
+ affiliatePrograms?: {
1788
1819
  /** @description Number of all orders. */
1789
1820
  clientAffiliateProgramTotalOrdersCount: number;
1790
1821
  /** @description Total cash transaction value. */
@@ -1794,28 +1825,28 @@ export type SearchClientsCrmResponse = {
1794
1825
  }[];
1795
1826
  };
1796
1827
  /** @description List of observed products. If this parameter is returned, the maximum number of results was reached: 10. */
1797
- clientObservedProductsData: {
1828
+ clientObservedProductsData?: {
1798
1829
  /** @description Product IAI code */
1799
1830
  productId: number;
1800
1831
  /** @description Size identifier */
1801
1832
  sizeId: string;
1802
1833
  }[];
1803
1834
  /** @description List of purchased products. If this parameter is returned, the maximum number of results was reached: 10. */
1804
- clientPurchasedProductsData: {
1835
+ clientPurchasedProductsData?: {
1805
1836
  /** @description Product IAI code */
1806
1837
  productId: number;
1807
1838
  /** @description Size identifier */
1808
1839
  sizeId: string;
1809
1840
  }[];
1810
1841
  /** @description Order list. If this parameter is returned, the maximum number of results was reached: 10. */
1811
- clientOrdersData: {
1842
+ clientOrdersData?: {
1812
1843
  /** @description Order ID. */
1813
1844
  orderId: string;
1814
1845
  /** @description Order serial number. */
1815
1846
  orderSerialNumber: number;
1816
1847
  }[];
1817
1848
  /** @description List of completed orders. If this parameter is returned, the maximum number of results was reached: 10. */
1818
- clientOrdersCompletedData: {
1849
+ clientOrdersCompletedData?: {
1819
1850
  /** @description Order ID. */
1820
1851
  orderId: string;
1821
1852
  /** @description Order serial number. */
@@ -1845,51 +1876,50 @@ export type SearchClientsCrmResponse = {
1845
1876
  }[];
1846
1877
  /** @description Information about customer balance. */
1847
1878
  clientBalances: {
1848
- /** @description Balance value. */
1849
- clientBalanceAmount: number;
1850
- /** @description Currency ID */
1851
- currencyId: string;
1852
- }[];
1879
+ [column: string]: {
1880
+ /** @description Balance value. */
1881
+ clientBalanceAmount: number;
1882
+ /** @description Currency ID */
1883
+ currencyId: string;
1884
+ }
1885
+ } | [];
1853
1886
  /** @description Customer orders statistics. */
1854
1887
  clientOrdersStatistic: {
1855
1888
  /** @description Retail turnover. */
1856
- clientOrdersStatisticRetailValues: {
1857
- /** @description Total net value. */
1858
- orderRetailValueNet: number;
1859
- /** @description Total gross value. */
1860
- orderRetailValue: number;
1861
- /** @description Currency ID */
1862
- currencyId: string;
1863
- }[];
1889
+ worth_retail: {
1890
+ [currency: string]: {
1891
+ currency: string;
1892
+ worth_net: string;
1893
+ worth_gross: string;
1894
+ }
1895
+ } | [];
1864
1896
  /** @description Wholesale turnover. */
1865
- clientOrdersStatisticWholesaleValues: {
1866
- /** @description Total net value. */
1867
- orderWholesaleValueNet: number;
1868
- /** @description Total gross value. */
1869
- orderWholesaleValue: number;
1870
- /** @description Currency ID */
1871
- currencyId: string;
1872
- }[];
1897
+ worth_wholesale: {
1898
+ [currency: string]: {
1899
+ currency: string;
1900
+ worth_net: string;
1901
+ worth_gross: string;
1902
+ }
1903
+ } | [];
1873
1904
  /** @description Turnover with the division to shops. */
1874
- clientOrdersStatisticValuesByShops: {
1905
+ worth_by_shops: {
1875
1906
  /** @description Shop Id */
1876
- shopId: number;
1907
+ shop_id: string;
1877
1908
  /** @description Turnover with the division to shops. */
1878
- clientOrdersStatisticValues: {
1879
- /** @description Total net value. */
1880
- orderValueNet: number;
1881
- /** @description Total gross value. */
1882
- orderValue: number;
1883
- /** @description Currency ID */
1884
- currencyId: string;
1885
- }[];
1909
+ worths: {
1910
+ [currency: string]: {
1911
+ currency: string;
1912
+ worth_net: string;
1913
+ worth_gross: string;
1914
+ }
1915
+ } | [];
1886
1916
  }[];
1887
1917
  /** @description Profit margin. */
1888
- clientProfitMargin: number;
1918
+ profit_margin: number;
1889
1919
  /** @description Average order value. */
1890
- clientOrderValueAverage: number;
1920
+ worth_average: number;
1891
1921
  /** @description Average amount of products in an order. */
1892
- clientProductsCountAverage: number;
1922
+ average_products_count: number;
1893
1923
  };
1894
1924
  /** @description Number of returns. */
1895
1925
  clientRmaCount: number;
@@ -1900,8 +1930,8 @@ export type SearchClientsCrmResponse = {
1900
1930
  /** @description Number of returned products. */
1901
1931
  clientReturnsProductsCount: number;
1902
1932
  };
1903
- clientLoyaltyCards: {
1904
- /** @description Does the customer have a loyalty card.- yes_active,- yes_not_active,- no. */
1933
+ clientLoyaltyCards?: {
1934
+ /** @description Does the customer have a loyalty card. - yes_active, - yes_not_active, - no. */
1905
1935
  clientHasLoyaltyCard: "yes_active" | "yes_not_active" | "no";
1906
1936
  /** @description Customer loyalty card ID, omitted when has_loyalty_card = no. */
1907
1937
  clientLoyaltyCardId: number;
@@ -1921,6 +1951,7 @@ export type SearchClientsCrmResponse = {
1921
1951
  }[];
1922
1952
  } & PagedResponse;
1923
1953
 
1954
+ /** Typechecked 2025-08-02 */
1924
1955
  export type SearchPackagesResponse = {
1925
1956
  /** @description Object contains detailed information on result of operation. */
1926
1957
  results: {
@@ -1985,16 +2016,18 @@ export type SearchPackagesResponse = {
1985
2016
  /** @description Default value for option */
1986
2017
  defaultValue: string;
1987
2018
  /** @description Available values ​​for the options */
1988
- options: {
2019
+ value?: string;
2020
+ options?: {
1989
2021
  /** @description Id */
1990
- id: string;
2022
+ id: string | number;
1991
2023
  /** @description Name */
1992
2024
  name: string;
1993
2025
  }[];
1994
2026
  }[];
1995
2027
  /** @description Information on error that occurred during gate call. */
1996
- errors: FaultCodeString;
2028
+ errors?: FaultCodeString;
1997
2029
  };
2030
+ incomingShippingNumber: null;
1998
2031
  };
1999
2032
  /** @description Type. */
2000
2033
  eventType: string;
@@ -2005,6 +2038,7 @@ export type SearchPackagesResponse = {
2005
2038
  }[];
2006
2039
  };
2007
2040
 
2041
+ /** Typechecked 2025-08-02 */
2008
2042
  export type SearchCategoriesIdosellResponse = {
2009
2043
  /** @description List of IdoSell Categories */
2010
2044
  categoriesIdoSell: {
@@ -2016,43 +2050,62 @@ export type SearchCategoriesIdosellResponse = {
2016
2050
  productsCount: number;
2017
2051
  /** @description Information about IdoSell Category in a given language */
2018
2052
  categoryIdoSellLangsData: {
2019
- /** @description Language ID (code in ISO 639-2). */
2020
- languageId: string;
2021
- /** @description IdoSell Category name */
2022
- categoryIdoSellName: string;
2023
- /** @description IdoSell Category pathname */
2024
- categoryIdoSellPath: string;
2025
- }[];
2053
+ [language: string]: {
2054
+ /** @description Language ID (code in ISO 639-2). */
2055
+ languageId: string;
2056
+ /** @description IdoSell Category name */
2057
+ categoryIdoSellName: string;
2058
+ /** @description IdoSell Category pathname */
2059
+ categoryIdoSellPath: string;
2060
+ }
2061
+ } | [];
2026
2062
  }[];
2027
2063
  } & PagedResponse;
2028
2064
 
2065
+ /** Typechecked 2025-08-02 */
2029
2066
  export type SearchOpinionsResponse = {
2030
2067
  /** @description Object contains detailed information on result of operation. */
2031
2068
  results: {
2069
+ /** @example 1 */
2032
2070
  id: number;
2071
+ /** @example content */
2033
2072
  content: string;
2073
+ /** @example createDate */
2034
2074
  createDate: string;
2035
- points: "1" | "2" | "3" | "4" | "5";
2075
+ /** */
2076
+ points: 0 | 1 | 2 | 3 | 4 | 5;
2036
2077
  confirmed: boolean;
2078
+ /** @example rating */
2037
2079
  rating: string;
2038
2080
  /** @description Customer language ID. */
2039
2081
  language: string;
2082
+ /** @example host */
2040
2083
  host: string;
2041
2084
  /** @description Shop Id */
2042
2085
  shopId: number;
2086
+ /** @example 1 */
2043
2087
  scorePositive: number;
2088
+ /** @example 1 */
2044
2089
  scoreNegative: number;
2045
- picture: {
2090
+ picture?: {
2046
2091
  large: {
2092
+ /** @example url */
2047
2093
  url: string;
2094
+ /** @example 1 */
2048
2095
  width: number;
2096
+ /** @example 1 */
2049
2097
  height: number;
2098
+ /** @example hash */
2050
2099
  hash: string;
2051
2100
  };
2052
2101
  small: {
2102
+ /** @example url */
2053
2103
  url: string;
2104
+ /** @example 1 */
2054
2105
  width: number;
2106
+ /** @example 1 */
2055
2107
  height: number;
2108
+ /** @example hash */
2056
2109
  hash: string;
2057
2110
  };
2058
2111
  };
@@ -2060,9 +2113,11 @@ export type SearchOpinionsResponse = {
2060
2113
  client: {
2061
2114
  /** @description Customer's login. */
2062
2115
  login: string;
2116
+ /** @example 1 */
2063
2117
  id: number;
2064
2118
  };
2065
2119
  order: {
2120
+ /** @example 1 */
2066
2121
  serialNumber: number;
2067
2122
  };
2068
2123
  /** @description Reply to an opinion */
@@ -2074,6 +2129,7 @@ export type SearchOpinionsResponse = {
2074
2129
  }[];
2075
2130
  } & PagedResponse;
2076
2131
 
2132
+ /** Typechecked 2025-08-02 */
2077
2133
  export type SearchDeliveryTimeResponse = {
2078
2134
  /** @description Object contains detailed information on result of operation. */
2079
2135
  results: {
@@ -2083,16 +2139,16 @@ export type SearchDeliveryTimeResponse = {
2083
2139
  sizeId: string;
2084
2140
  /** @description Size name */
2085
2141
  sizePanelName: string;
2086
- /* @description Product stock quantity */
2142
+ /** @description Product stock quantity */
2087
2143
  productSizeQuantity: number;
2088
2144
  /** @description Producer code */
2089
2145
  productProducerCode: string;
2090
2146
  /** @description External product system code for size. */
2091
2147
  productSizeCodeExternal: string;
2092
2148
  /** @description Number of days required to prepare product for shipment */
2093
- deliveryTimeDays: number;
2149
+ deliveryTimeDays?: number;
2094
2150
  /** @description Number of hours required to prepare product for shipment */
2095
- deliveryTimeHours: number;
2151
+ deliveryTimeHours?: number;
2096
2152
  /** @description Error number */
2097
2153
  errno: number;
2098
2154
  /** @description Error information. */
@@ -2162,54 +2218,57 @@ export type SearchNewsletterSmsResponse = SearchNewsletterResponse<{
2162
2218
  phone_cellular: string;
2163
2219
  }>;
2164
2220
 
2221
+ /** Typechecked 2025-08-02 */
2165
2222
  export type GetStocksdocumentsProductsResponse = {
2166
2223
  /** @description Products list. */
2167
2224
  products: {
2168
2225
  /** @description Stock keeping unit. */
2169
2226
  product: number;
2170
2227
  /** @description Product name. */
2171
- name: string;
2228
+ name?: string;
2172
2229
  /** @description Product size ID. */
2173
2230
  size: string;
2174
2231
  /** @description Size name */
2175
- sizeName: string;
2232
+ sizeName?: string;
2233
+ /** @example 1 */
2176
2234
  quantity: number;
2177
- ordersQuantity: {
2235
+ ordersQuantity?: {
2178
2236
  /** @description Order ID. If the products are not required for the order (they are collected to stock), 0 is returned. */
2179
2237
  orderSerialNumber: number;
2180
- /* @description Product quantity. */
2238
+ /** @description Product quantity. */
2181
2239
  productQuantity: number;
2182
2240
  }[];
2183
- /* @description Gross purchase price */
2241
+ /** @description Gross purchase price */
2184
2242
  productPurchasePriceGross: number;
2185
- /* @description Net purchase price */
2243
+ /** @description Net purchase price */
2186
2244
  productPurchasePriceNet: number;
2187
- /* @description Value of VAT */
2245
+ /** @description Value of VAT */
2188
2246
  productVat: number;
2189
2247
  /** @description Currency ID */
2190
2248
  currencyId: string;
2191
2249
  /** @description External system code. */
2192
- sizeCodeExternal: string;
2250
+ sizeCodeExternal?: string;
2193
2251
  /** @description Producer code. */
2194
- sizeCodeProducer: string;
2252
+ sizeCodeProducer?: string;
2195
2253
  /** @description Product type on the document. */
2196
2254
  typeOnDocument: "temporaryProduct" | "existingProduct";
2197
2255
  /** @description Warehouse location ID. The list of available warehouse locations can be downloaded via the method <a href = "pl/shop/api/?action=method&function=locations&method=get">#get</a> in gateway <a href = "en/shop/api/?action=documentation&function=locations">Locations</a> . */
2198
2256
  locationId: number;
2199
2257
  /** @description Storage location code */
2200
- locationCode: string;
2258
+ locationCode: string | null;
2201
2259
  /** @description Warehouse location full path. The list of available warehouse locations can be downloaded via the method <a href = "pl/shop/api/?action=method&function=locations&method=get">#get</a> in gateway <a href = "en/shop/api/?action=documentation&function=locations">Locations</a> . */
2202
- locationPath: string;
2260
+ locationPath: string | null;
2203
2261
  }[];
2204
2262
  } & PagedSnakecaseResponse;
2205
2263
 
2264
+ /** Typechecked 2025-08-02 */
2206
2265
  export type GetStocksdocumentsDocumentsResponse = {
2207
2266
  /** @description List of documents. */
2208
2267
  stocksDocuments: {
2209
2268
  /** @description Document identifier. */
2210
2269
  stockDocumentId: number;
2211
2270
  /** @description Document number. */
2212
- stockDocumentNumber: string;
2271
+ stockDocumentNumber?: string;
2213
2272
  /** @description Document type. */
2214
2273
  stockDocumentType: "pz" | "pw" | "px" | "rx" | "rw" | "wz" | "mm" | "zw";
2215
2274
  /** @description Document status. */
@@ -2219,7 +2278,7 @@ export type GetStocksdocumentsDocumentsResponse = {
2219
2278
  /** @description Stock ID */
2220
2279
  stockId: number;
2221
2280
  /** @description Source warehouse ID */
2222
- stockSourceId: number;
2281
+ stockSourceId?: number;
2223
2282
  /** @description Document issue date in the YYYY-MM-DD HH:MM:SS format */
2224
2283
  openDate: string;
2225
2284
  /** @description User who issued the document */
@@ -2237,32 +2296,34 @@ export type GetStocksdocumentsDocumentsResponse = {
2237
2296
  /** @description The user who caused the change in stock */
2238
2297
  stockOperationUser: string;
2239
2298
  /** @description Delivery on the way. */
2240
- deliveryOnTheWay: boolean;
2299
+ deliveryOnTheWay?: boolean;
2241
2300
  /** @description Planned date of acceptance of delivery. */
2242
- plannedDeliveryDate: string;
2301
+ plannedDeliveryDate?: string;
2243
2302
  /** @description Products available in presales. */
2244
- productsInPreorder: string;
2303
+ productsInPreorder?: string;
2245
2304
  /** @description Supplier ID. */
2246
- delivererId: number;
2305
+ delivererId?: number;
2247
2306
  /** @description Purchase document */
2248
- purchaseDocument: {
2307
+ purchaseDocument?: {
2249
2308
  /** @description Type of purchase document */
2250
2309
  type: "national_VAT_invoice" | "other_purchase_document" | "invoice_without_VAT" | "imports_from_outside_the_EU";
2251
2310
  /** @description Number of purchase document */
2252
2311
  number: string;
2253
2312
  };
2254
2313
  /** @description Order serial number. */
2255
- orderNumber: number;
2314
+ orderNumber?: number;
2256
2315
  /** @description Supplier name. */
2257
- delivererName: string;
2316
+ delivererName?: string;
2258
2317
  /** @description Issue date of purchase document */
2259
- saleDocumentCreationDate: string;
2318
+ saleDocumentCreationDate?: string;
2260
2319
  /** @description settled at */
2261
- priceType: string;
2320
+ priceType?: string;
2262
2321
  }[];
2263
2322
  } & PagedResponse;
2264
2323
 
2324
+ /** Typechecked 2025-08-02 */
2265
2325
  export type GetClientsResponse = {
2326
+ /** @description Object contains detailed information on result of operation. */
2266
2327
  results: {
2267
2328
  /** @description Unique client's number. */
2268
2329
  clientId: number;
@@ -2274,15 +2335,15 @@ export type GetClientsResponse = {
2274
2335
  clientCodeExternal: string;
2275
2336
  /** @description E-mail address. */
2276
2337
  clientEmail: string;
2277
- /** @description Customer type, possible values:- private - if client sex is not determined,- male - when client is a male,- female - when a customer is a woman,- firm - when client is company. */
2338
+ /** @description Customer type, possible values: - private - if client sex is not determined, - male - when client is a male, - female - when a customer is a woman, - firm - when client is company. */
2278
2339
  clientType: string;
2279
- /** @description Display as partner on the page:n - No,y - Yes. */
2280
- showClientAsPartner: "y" | "n";
2340
+ /** @description Display as partner on the page: n - No, y - Yes. */
2341
+ showClientAsPartner: "y" | "n" | "";
2281
2342
  operator: {
2282
2343
  /** @description Customer's login. */
2283
- login: string;
2344
+ login?: string;
2284
2345
  /** @description Name. */
2285
- name: string;
2346
+ name?: string;
2286
2347
  };
2287
2348
  /** @description Is client without registration */
2288
2349
  isUnregistered: "y" | "n";
@@ -2328,12 +2389,12 @@ export type GetClientsResponse = {
2328
2389
  currencyId: string;
2329
2390
  /** @description Determines, whether client is a wholesaler. */
2330
2391
  clientIsWholesaler: "yes" | "no";
2331
- /** @description Is the customer VAT registered:always - always,never - never,neverconfirm - no, this requires confirmation,bycountry - settings as per country. */
2392
+ /** @description Is the customer VAT registered: always - always, never - never, neverconfirm - no, this requires confirmation, bycountry - settings as per country. */
2332
2393
  clientVatPreferences: "always" | "never" | "neverconfirm" | "bycountry";
2333
2394
  /** @description Discount group ID. */
2334
2395
  clientGroupDiscountNumber: number;
2335
2396
  /** @description Customer group name. */
2336
- clientGroupDiscountName: string;
2397
+ clientGroupDiscountName: string | null;
2337
2398
  };
2338
2399
  /** @description List of shops where a customer agreed or didn't agree to receive email newsletter. */
2339
2400
  newsletterEmailApprovalsData: {
@@ -2351,25 +2412,25 @@ export type GetClientsResponse = {
2351
2412
  }[];
2352
2413
  /** @description Information about customer balance. */
2353
2414
  clientBalances: {
2354
- /* @description Balance value. */
2415
+ /** @description Balance value. */
2355
2416
  clientBalanceAmount: number;
2356
2417
  /** @description Currency ID */
2357
2418
  currencyId: string;
2358
2419
  }[];
2359
2420
  /** @description Customer trade credit information. */
2360
2421
  clientTradeCredit: {
2361
- /* @description Granted credit limit. */
2422
+ /** @description Granted credit limit. */
2362
2423
  clientTradeCreditLimit: number;
2363
2424
  /** @description Currency ID */
2364
2425
  currencyId: string;
2365
- /* @description Used credit limit. */
2426
+ /** @description Used credit limit. */
2366
2427
  clientTradeCreditUsed: number;
2367
2428
  };
2368
2429
  /** @description The parameter stores information about who acquired the customer */
2369
- affiliateLogin: string;
2430
+ affiliateLogin: string | null;
2370
2431
  /** @description ID of a partner who acquired a given customer. */
2371
2432
  affiliateId: number;
2372
- /* Format: date
2433
+ /** Format: date
2373
2434
  * @description Client registration date */
2374
2435
  clientRegistrationDate: string;
2375
2436
  /** @description List of shops the customer is active in */
@@ -2382,6 +2443,7 @@ export type GetClientsResponse = {
2382
2443
  }[];
2383
2444
  } & PagedResponse;
2384
2445
 
2446
+ /** Typechecked 2025-08-02 */
2385
2447
  export type GetReturnsResponse = {
2386
2448
  /** @description Element that contains the list of found returns. */
2387
2449
  returns: {
@@ -2410,37 +2472,37 @@ export type GetReturnsResponse = {
2410
2472
  /** @description Size identifier. */
2411
2473
  size: string;
2412
2474
  /** @description Code of outside system for product. */
2413
- product_sizecode: string;
2414
- /* @description Product quantity. */
2475
+ product_sizecode: string | null;
2476
+ /** @description Product quantity. */
2415
2477
  quantity: number;
2416
- /* @description Price. */
2478
+ /** @description Price. */
2417
2479
  price: number;
2418
- /* @description Net price. */
2480
+ /** @description Net price. */
2419
2481
  price_net: number;
2420
- /* @description Order value. */
2482
+ /** @description Order value. */
2421
2483
  order_price: number;
2422
- /* @description Net order worth. */
2484
+ /** @description Net order worth. */
2423
2485
  order_price_net: number;
2424
2486
  /** @description Client's remarks on product. */
2425
- remarks: string;
2426
- /* @description Loyalty points. */
2487
+ remarks?: string;
2488
+ /** @description Loyalty points. */
2427
2489
  points: number;
2428
- /* @description Accrued loyalty points. */
2490
+ /** @description Accrued loyalty points. */
2429
2491
  points_awarded: number;
2430
2492
  /** @description Product type. */
2431
2493
  product_type: string;
2432
- serial_numbers: string[];
2494
+ serial_numbers: Record<string,string> | null;
2433
2495
  /** @description Additional information. */
2434
2496
  product_order_additional: string;
2435
2497
  }[];
2436
2498
  /** @description Added on. */
2437
2499
  date_add: string;
2438
2500
  /** @description Ending date */
2439
- date_end: string;
2501
+ date_end: string | null;
2440
2502
  /** @description Consignment number assigned to return. */
2441
2503
  package_number: string;
2442
2504
  /** @description Last modification date. */
2443
- date_last_edit: string;
2505
+ date_last_edit: string | null;
2444
2506
  /** @description Currency. */
2445
2507
  currency: string;
2446
2508
  /** @description Note to return used by IAI Bridge. */
@@ -2449,11 +2511,11 @@ export type GetReturnsResponse = {
2449
2511
  include_shipping_cost: string;
2450
2512
  /** @description Refund additional fee for the payment?. */
2451
2513
  additional_payment_cost: string;
2452
- /* @description Cost for shop. */
2514
+ /** @description Cost for shop. */
2453
2515
  shop_shipping_cost: number;
2454
2516
  /** @description Return shipping number sent by the customer to the seller */
2455
2517
  incomingShippingNumber: string;
2456
- /* @description Cost for shop - VAT rate */
2518
+ /** @description Cost for shop - VAT rate */
2457
2519
  shop_shipping_cost_vat: number;
2458
2520
  /** @description Product return method. */
2459
2521
  return_method: string;
@@ -2489,36 +2551,41 @@ export type GetReturnsResponse = {
2489
2551
  payformName: string;
2490
2552
  /** @description Account. */
2491
2553
  payformAccount: string;
2492
- /* @description Payment amount. */
2554
+ /** @description Payment amount. */
2493
2555
  paymentValue: number;
2494
2556
  /** @description Currency ID */
2495
2557
  currencyId: string;
2496
2558
  /** @description Number of voucher used in a payment. */
2497
- voucherNumber: string;
2559
+ voucherNumber?: string;
2498
2560
  /** @description Number of gift card used in a payment. */
2499
- giftCardNumber: string;
2561
+ giftCardNumber?: string;
2500
2562
  }[];
2563
+ /** @description Shop return shipping cost */
2564
+ returnShopShippingCost: number;
2565
+ /** @description Shop return shipping cost - VAT rate */
2566
+ returnShopShippingCostVat: number;
2501
2567
  /** @description Shipping cost of the order */
2502
2568
  shippingCost: {
2503
- /* @description Gross value. */
2569
+ /** @description Gross value. */
2504
2570
  gross: number;
2505
- /* @description Net value. */
2571
+ /** @description Net value. */
2506
2572
  net: number;
2507
- /* @description VAT rate. */
2573
+ /** @description VAT rate. */
2508
2574
  vat: number;
2509
2575
  };
2510
2576
  /** @description Additional costs for the payment of the order */
2511
2577
  additionalPaymentCostValue: {
2512
- /* @description Gross value. */
2578
+ /** @description Gross value. */
2513
2579
  gross: number;
2514
- /* @description Net value. */
2580
+ /** @description Net value. */
2515
2581
  net: number;
2516
- /* @description VAT rate. */
2582
+ /** @description VAT rate. */
2517
2583
  vat: number;
2518
2584
  };
2519
2585
  }[];
2520
2586
  } & PagedSnakecaseResponse;
2521
2587
 
2588
+ /** Typechecked 2025-08-02 */
2522
2589
  export type GetRmaResponse = {
2523
2590
  /** @description Complaints. */
2524
2591
  rmas: {
@@ -2529,9 +2596,9 @@ export type GetRmaResponse = {
2529
2596
  /** @description Customer ID */
2530
2597
  clientNumber: number;
2531
2598
  /** @description ID of the product which the complaint concers */
2532
- productId: string;
2599
+ productId: string | null;
2533
2600
  /** @description Product name. */
2534
- productName: string;
2601
+ productName: string | null;
2535
2602
  /** @description Current complaint status */
2536
2603
  rmaStatus: string;
2537
2604
  /** @description Complaint creation date in the YYYY-MM-DD format */
@@ -2551,7 +2618,7 @@ export type GetRmaResponse = {
2551
2618
  /** @description Stock ID */
2552
2619
  stockId: number;
2553
2620
  /** @description Login of the user handling the complaint */
2554
- operatorLogin: string;
2621
+ operatorLogin: string | null;
2555
2622
  /** @description External auction number connected to the order which the complaint concerns */
2556
2623
  orderAuctionNumber: string;
2557
2624
  /** @description Order ID. */
@@ -2570,27 +2637,27 @@ export type GetRmaResponse = {
2570
2637
  size: string;
2571
2638
  /** @description Size code */
2572
2639
  productSizecode: string;
2573
- /* @description Product quantity */
2640
+ /** @description Product quantity */
2574
2641
  quantity: number;
2575
- /* @description Product price */
2642
+ /** @description Product price */
2576
2643
  price: number;
2577
- /* @description Product net price */
2644
+ /** @description Product net price */
2578
2645
  priceNet: number;
2579
- /* @description Order price */
2646
+ /** @description Order price */
2580
2647
  orderPrice: number;
2581
- /* @description Order price net */
2648
+ /** @description Order price net */
2582
2649
  orderPriceNet: number;
2583
- /* @description Points */
2650
+ /** @description Points */
2584
2651
  points: number;
2585
- /* @description Awarded points */
2652
+ /** @description Awarded points */
2586
2653
  pointsAwarded: number;
2587
2654
  /** @description Product types: `product_item` - single or multi variant product, `product_free` - free product, `product_packaging` - packaging, `product_bundle` - bundle, `product_collection` - collection, `product_service` - service, `product_virtual` - virtual, `product_configurable` - product with configurator */
2588
- productType: string;
2589
- /** @description Product serial numbers"1","2"] */
2590
- serial_numbers: string[];
2655
+ productType: string | null;
2656
+ /** @description Product serial numbers "1", "2" ] */
2657
+ serial_numbers?: Record<string,string>;
2591
2658
  /** @description Additional information */
2592
2659
  productOrderAdditional: string;
2593
- /** @description List of attachments"1","2"] */
2660
+ /** @description List of attachments "1", "2" ] */
2594
2661
  attachments: string[];
2595
2662
  }[];
2596
2663
  /** @description Customer correspondence */
@@ -2605,14 +2672,15 @@ export type GetRmaResponse = {
2605
2672
  messageAddTime: string;
2606
2673
  }[];
2607
2674
  /** @description Information on error that occurred during gate call. */
2608
- errors: FaultCodeString
2675
+ errors?: FaultCodeString;
2609
2676
  }[];
2610
2677
  /** @description Flag marking errors in the result. */
2611
2678
  isErrors: boolean;
2612
2679
  } & PagedResponse;
2613
2680
 
2681
+ /** Typechecked 2025-08-02 */
2614
2682
  export type GetConfigResponse = {
2615
- /** @description Customers ID */
2683
+ /** @example 1 */
2616
2684
  client_id: number;
2617
2685
  /** @description Dedicated server. */
2618
2686
  dedicated_server: boolean;
@@ -2671,13 +2739,13 @@ export type GetConfigResponse = {
2671
2739
  /** @description Fiscal and settlement settings */
2672
2740
  taxSettings: {
2673
2741
  /** @description Sales date settings on sales documents for prepaid orders */
2674
- saleDatePrepaid: "saleDateFromOrder" | "saleDateFromPayment" | "saleDateFromDocument";
2742
+ saleDatePrepaid: "saleDateFromOrder" | "saleDateFromPayment" | "saleDateFromDocument" | null;
2675
2743
  /** @description Sales date settings on sales documents for orders paid with cash on delivery */
2676
- saleDateCashOnDelivery: "saleDateFromOrder" | "saleDateFromPayment" | "saleDateFromDocument";
2744
+ saleDateCashOnDelivery: "saleDateFromOrder" | "saleDateFromPayment" | "saleDateFromDocument" | null;
2677
2745
  /** @description Sales date settings on sales documents for orders paid with trade credit */
2678
- saleDateTradeCredit: "saleDateFromOrder" | "saleDateFromPayment" | "saleDateFromDocument";
2746
+ saleDateTradeCredit: "saleDateFromOrder" | "saleDateFromPayment" | "saleDateFromDocument" | null;
2679
2747
  /** @description Configuration of default currency rate for orders */
2680
- currencyRate: "currentDay" | "previousDay";
2748
+ currencyRate: "currentDay" | "previousDay" | null;
2681
2749
  };
2682
2750
  };
2683
2751
  panel_literals: {
@@ -2710,7 +2778,7 @@ export type GetConfigResponse = {
2710
2778
  active_price_comparers: {
2711
2779
  /** @description Id */
2712
2780
  id: number;
2713
- /* @description Default price difference. */
2781
+ /** @description Default price difference. */
2714
2782
  default_price_percent_diff: number;
2715
2783
  }[];
2716
2784
  /** @description Url to default product icon. */
@@ -2763,9 +2831,9 @@ export type GetConfigResponse = {
2763
2831
  defaultConfigReturns: {
2764
2832
  /** @description Refund a shipping fee? */
2765
2833
  defaultIncludeShippingCost: string;
2766
- /** @description How to proceed with a refund.Available values:"fullOnFirstReturn" - refund all at the first refund,"proportionalToProductQuantity" - refund proportionally to a number of products in an original order,"fullOnAllProductsReturn" - refund at the return of a whole order. */
2834
+ /** @description How to proceed with a refund. Available values: "fullOnFirstReturn" - refund all at the first refund, "proportionalToProductQuantity" - refund proportionally to a number of products in an original order, "fullOnAllProductsReturn" - refund at the return of a whole order. */
2767
2835
  methodReturnShippingCost: "fullOnFirstReturn" | "proportionalToProductQuantity" | "fullOnAllProductsReturn";
2768
- /** @description Refund.Available values:"shipping" - delivery cost calculated for a primary order,"positive_min_shipping" - the lowest amount of delivery costs available at the moment of placing an order for the selected delivery method (more than zero but less than actual cost charged),"min_shipping" - absolute the lowest delivery cost available at the moment of placing an order for the selected delivery method (for free shipping it is zero). */
2836
+ /** @description Refund. Available values: "shipping" - delivery cost calculated for a primary order, "positive_min_shipping" - the lowest amount of delivery costs available at the moment of placing an order for the selected delivery method (more than zero but less than actual cost charged), "min_shipping" - absolute the lowest delivery cost available at the moment of placing an order for the selected delivery method (for free shipping it is zero). */
2769
2837
  defaultIncludeShippingCostValue: "shipping" | "positive_min_shipping" | "min_shipping";
2770
2838
  /** @description Refund a surcharge for a payment method used in an order? */
2771
2839
  defaultAdditionalPaymentCost: string;
@@ -2781,7 +2849,7 @@ export type GetConfigResponse = {
2781
2849
  unit_name: string;
2782
2850
  /** @description Accuracy (number of places after comma). */
2783
2851
  unit_precision: number;
2784
- /** @description Object determines unit visibility in panel.List of values:"y" - unit visible in panel,"n" - unit invisible in panel. */
2852
+ /** @description Object determines unit visibility in panel. List of values: "y" - unit visible in panel, "n" - unit invisible in panel. */
2785
2853
  unit_visible: string;
2786
2854
  lang_data: {
2787
2855
  /** @description Language code. Codes are compliant with ISO-639-3 standard. */
@@ -2795,7 +2863,7 @@ export type GetConfigResponse = {
2795
2863
  }[];
2796
2864
  }[];
2797
2865
  /** @description List of warranties. */
2798
- warranties: {
2866
+ warranties?: {
2799
2867
  /** @description Id */
2800
2868
  id: number;
2801
2869
  /** @description Name */
@@ -2817,10 +2885,10 @@ export type GetConfigResponse = {
2817
2885
  vat_rates: {
2818
2886
  /** @description Id */
2819
2887
  id: number;
2820
- /* @description VAT rate value. */
2888
+ /** @description VAT rate value. */
2821
2889
  value: number;
2822
2890
  }[];
2823
- auction_systems: {
2891
+ auction_systems?: {
2824
2892
  /** @description Auction system ID. */
2825
2893
  auction_id: number;
2826
2894
  /** @description Auction site ID. */
@@ -2836,16 +2904,16 @@ export type GetConfigResponse = {
2836
2904
  /** @description Name */
2837
2905
  name: string;
2838
2906
  }[];
2839
- rebate_profiles: {
2907
+ rebate_profiles?: {
2840
2908
  /** @description Id */
2841
2909
  id: number;
2842
2910
  /** @description Name */
2843
2911
  name: string;
2844
2912
  }[];
2845
2913
  pictures_settings: {
2846
- /** @description Object determines if the product icon should be scaled.List of values:"y" - icon is scaled,"n" - icon is unscaled. */
2914
+ /** @description Object determines if the product icon should be scaled. List of values: "y" - icon is scaled, "n" - icon is unscaled. */
2847
2915
  icon_resize: string;
2848
- /** @description Graphic quality in percent (0-100). ."0" - the worst quality,"100" - the best quality (no compression). */
2916
+ /** @description Graphic quality in percent (0-100). . "0" - the worst quality, "100" - the best quality (no compression). */
2849
2917
  icon_quality: number;
2850
2918
  /** @description Large icon width in pixels. */
2851
2919
  icon_large_width: number;
@@ -2863,7 +2931,7 @@ export type GetConfigResponse = {
2863
2931
  group_icon_height: number;
2864
2932
  /** @description Group icon height in pixels. */
2865
2933
  group_icon_width: number;
2866
- /** @description Photo quality in percents (0-100)."0" - the worst quality,"100" - the best quality (no compression). */
2934
+ /** @description Photo quality in percents (0-100). "0" - the worst quality, "100" - the best quality (no compression). */
2867
2935
  picture_quality: number;
2868
2936
  /** @description Large photo width in pixels. */
2869
2937
  picture_large_width: number;
@@ -2878,16 +2946,18 @@ export type GetConfigResponse = {
2878
2946
  /** @description Small photo height in pixels. */
2879
2947
  picture_small_height: number;
2880
2948
  };
2881
- price_comparers: {
2882
- /** @description Id */
2883
- id: number;
2884
- /** @description key */
2885
- key: string;
2886
- /** @description Name */
2887
- name: string;
2888
- /** @description Information about whether price comparison service is active. */
2889
- active: string;
2890
- }[];
2949
+ price_comparers: {
2950
+ [id: string]: {
2951
+ /** @description Id */
2952
+ id?: number;
2953
+ /** @example key */
2954
+ key?: string;
2955
+ /** @description Name */
2956
+ name?: string;
2957
+ /** @description Information about whether price comparison service is active. */
2958
+ active?: string;
2959
+ }
2960
+ } | [];
2891
2961
  /** @description Content of the column "Product or service name" on sales documents. */
2892
2962
  inv_prod_name_templace: string;
2893
2963
  /** @description List of document printers. */
@@ -2898,7 +2968,7 @@ export type GetConfigResponse = {
2898
2968
  name: string;
2899
2969
  /** @description Address. */
2900
2970
  address: string;
2901
- /** @description key */
2971
+ /** @example key */
2902
2972
  key: string;
2903
2973
  }[];
2904
2974
  /** @description List of fiscal printers. */
@@ -2909,14 +2979,15 @@ export type GetConfigResponse = {
2909
2979
  name: string;
2910
2980
  /** @description Address. */
2911
2981
  address: string;
2912
- /** @description key */
2982
+ /** @example key */
2913
2983
  key: string;
2914
2984
  }[];
2915
2985
  /** @description Monitoring address protocol from the main Printer window. */
2916
2986
  typeOfPrinterProtocolAdress: string;
2917
2987
  };
2918
2988
 
2919
- export type GetShopsDataResponse = GetConfigResponse & {
2989
+ /** Typechecked 2025-08-02 */
2990
+ export type GetShopsDataResponse = Omit<GetConfigResponse, 'panel_settings'|'shops'> & {
2920
2991
  /** @description Shop contact data */
2921
2992
  shop_contact: {
2922
2993
  /** @description shop ID */
@@ -2933,28 +3004,7 @@ export type GetShopsDataResponse = GetConfigResponse & {
2933
3004
  contact_phone_number: string;
2934
3005
  }[];
2935
3006
  }[];
2936
- panel_settings: {
2937
- /** @description Default panel language. */
2938
- default_lang_id: string;
2939
- /** @description Panel base currency. */
2940
- basecurrency_id: string;
2941
- /** @description Manual stock quantity modification restriction. */
2942
- stocks_change_disabled: string;
2943
- /** */
2944
- stock_state_config: "uncontrolled" | "bridge" | "outside";
2945
- /** */
2946
- main_stock_system: "other" | "iai";
2947
- /** @description Sales documents in third party application. */
2948
- salesDocumentsAreCreatedByClient: boolean;
2949
- search_by_code: {
2950
- /** @description IAI code. */
2951
- code_iai: boolean;
2952
- /** @description External system code. */
2953
- code_extern: boolean;
2954
- /** @description Producer code. */
2955
- code_producer: boolean;
2956
- };
2957
- };
3007
+ panel_settings: ShopsPanelSettings;
2958
3008
  /** @description List of stores. */
2959
3009
  shops: {
2960
3010
  /** @description Shop Id. */
@@ -3019,42 +3069,52 @@ export type GetShopsDataResponse = GetConfigResponse & {
3019
3069
  active: boolean;
3020
3070
  };
3021
3071
  }[];
3022
- }
3072
+ };
3023
3073
 
3074
+ /** Typechecked 2025-08-02 */
3024
3075
  export type GetSizechartsResponse = {
3025
3076
  sizeCharts: {
3077
+ [id: string]: {
3026
3078
  /** @description Id */
3027
- id: number;
3028
- /** @description Name in panel */
3029
- nameInPanel: string;
3030
- /** @description Display mode */
3031
- displayMode: string;
3032
- languagesData: {
3033
- /** @description Customer language ID. */
3034
- language: string;
3035
- columns: {
3036
- /** @description Column number */
3037
- columnNumber: number;
3038
- /** @description Column name */
3039
- columnTitle: string;
3040
- }[];
3041
- /** @description List of sizes */
3042
- sizes: {
3043
- /** @description Size identifier */
3044
- sizeId: string;
3045
- /** @description Priority */
3046
- priority: number;
3047
- descriptions: {
3048
- /** @description Column number */
3049
- columnNumber: number;
3050
- /** @description Value */
3051
- value: string;
3052
- }[];
3079
+ id: number;
3080
+ /** @description Name in panel */
3081
+ nameInPanel: string;
3082
+ /** @description Display mode */
3083
+ displayMode: string;
3084
+ languagesData: {
3085
+ /** @description Customer language ID. */
3086
+ language: string;
3087
+ columns: {
3088
+ [column: string]: {
3089
+ /** @description Column number */
3090
+ columnNumber: number;
3091
+ /** @description Column name */
3092
+ columnTitle: string;
3093
+ }
3094
+ } | [];
3095
+ /** @description List of sizes */
3096
+ sizes?: {
3097
+ [column: string]: {
3098
+ /** @description Size identifier */
3099
+ sizeId: string;
3100
+ /** @description Priority */
3101
+ priority: number;
3102
+ descriptions: {
3103
+ [column: string]: {
3104
+ /** @description Column number */
3105
+ columnNumber: number;
3106
+ /** @description Value */
3107
+ value: string;
3108
+ }
3109
+ } | [];
3110
+ }
3111
+ } | [];
3053
3112
  }[];
3054
- }[];
3055
- }[];
3113
+ }
3114
+ } | [];
3056
3115
  } & PagedResponse;
3057
3116
 
3117
+ /** Typechecked 2025-08-02 */
3058
3118
  export type GetLocationsResponse = {
3059
3119
  /** @description Object contains detailed information on result of operation. */
3060
3120
  results: {
@@ -3082,6 +3142,7 @@ export type GetLocationsResponse = {
3082
3142
  }[];
3083
3143
  } & PagedResponse;
3084
3144
 
3145
+ /** Typechecked 2025-08-02 */
3085
3146
  export type GetWarrantiesResponse = {
3086
3147
  warranties: {
3087
3148
  /** @description Warranty language id (numeric). */
@@ -3107,4 +3168,241 @@ export type GetWarrantiesResponse = {
3107
3168
  }[];
3108
3169
  } & PagedSnakecaseResponse;
3109
3170
 
3171
+ /** Typechecked 2025-08-02 */
3172
+ export type GetCategoriesResponse = {
3173
+ last_changed_time: string;
3174
+ /** @description Element containing a list of found results on a given page. */
3175
+ categories: {
3176
+ /** @description Category id. */
3177
+ id: number;
3178
+ /** @description Parent category ID. */
3179
+ parent_id: number;
3180
+ /** @description PKWiU number. */
3181
+ pkwiu: string;
3182
+ /** @description Priority. */
3183
+ priority: number;
3184
+ /** @description Number of products assigned to category. */
3185
+ product_count: number;
3186
+ /** @description Category ID on Allegro auction site. */
3187
+ allegro_category_id?: number;
3188
+ /** @description Category ID on eBay auction site. */
3189
+ ebay_category_id?: number;
3190
+ /** @description Category ID on WP shopping mall. */
3191
+ wp_category_id?: number;
3192
+ /** @description Category ID on Onet shopping mall. */
3193
+ onet_category_id?: number;
3194
+ /** @description Category ID on Interia shopping mall. */
3195
+ interia_category_id?: number;
3196
+ /** @description Store mask code. */
3197
+ shop_mask?: number;
3198
+ /** @description Array of IDs of stores, in which category is present. */
3199
+ shops?: number[];
3200
+ lang_data: {
3201
+ /** @description Language code. Codes are compliant with ISO-639-3 standard. */
3202
+ lang_id: string;
3203
+ /** @description Category singular name. */
3204
+ singular_name: string;
3205
+ /** @description Category plural name. */
3206
+ plural_name: string;
3207
+ /** @description Category description. */
3208
+ description: string;
3209
+ }[];
3210
+ vatMappings?: {
3211
+ /** @example 1 */
3212
+ regionId: number;
3213
+ /** */
3214
+ vat: number;
3215
+ }[];
3216
+ }[];
3217
+ } & PagedSnakecaseResponse;
3218
+
3219
+ /** Typechecked 2025-08-02 */
3220
+ export type GetMenuResponse = {
3221
+ /** @description Parameters concerning returned results */
3222
+ result: {
3223
+ /** @description Menu element ID. */
3224
+ item_id: number;
3225
+ /** @description Parent menu element ID. */
3226
+ parent_id: number;
3227
+ lang_data: {
3228
+ /** @description Language ID. */
3229
+ lang_id: string;
3230
+ /** @description Menu element text identifier. Example: "item1\item2\item3". */
3231
+ item_textid: string;
3232
+ /** @description Menu element name. */
3233
+ name: string;
3234
+ /** @description Menu element order. */
3235
+ priority: number;
3236
+ /** @description Description displayed at the top of products list. */
3237
+ description: string;
3238
+ /** @description Description displayed at the bottom of products list. */
3239
+ description_bottom: string | null;
3240
+ /** @description Own link. */
3241
+ link: string;
3242
+ /** */
3243
+ item_type: "products" | "navigation" | "products_with_rich_text" | "navigation_with_rich_text" | "rich_text" | "static" | "link";
3244
+ /** @description Meta title . */
3245
+ meta_title: string;
3246
+ /** @description Meta description. */
3247
+ meta_description: string;
3248
+ /** @description Meta - keywords. */
3249
+ meta_keywords: string;
3250
+ /** @description URL address */
3251
+ url: string;
3252
+ /** @description Link target attribute. !_self - open on the same page, !_blank - open in a new page. */
3253
+ href_target: "_self" | "_blank";
3254
+ sort?: {
3255
+ /** @description Default product list view. */
3256
+ view: "normal" | "list" | "gallery";
3257
+ /** @description Sort by. */
3258
+ sort_by: "date" | "priority" | "priorityname" | "name" | "price";
3259
+ /** @description Sort order. */
3260
+ sort_order: "ASC" | "DESC";
3261
+ }[];
3262
+ display_limit?: {
3263
+ /** @description Default product list view. */
3264
+ view: "normal" | "list" | "gallery";
3265
+ /** @description Limit. */
3266
+ limit: number;
3267
+ }[];
3268
+ /** */
3269
+ default_view: "normal" | "list" | "gallery";
3270
+ /** @description Headline name. Leaving this value empty will automatically generate name basing on a name in menu: */
3271
+ headline_name: string;
3272
+ /** @description Display by default nested elements: n - no, y - yes. */
3273
+ expand: "n" | "y";
3274
+ /** @description Element of the menu hidden from the clients: n - no, y - yes. */
3275
+ hidden: "n" | "y";
3276
+ /** @description After clicking on the element in the menu:: expand - Display subelements of the menu if any available, if not - create, reload - reload the page and open. */
3277
+ action: "reload" | "expand" | "";
3278
+ /** @description Element "show all" is:: products_list - link to the list of products, navigation_site - link to the "Navigation" page. */
3279
+ display_all_type: "products_list" | "navigation_site" | "";
3280
+ /** @description Display element "show all": n - no, y - yes. */
3281
+ display_all: "n" | "y" | "";
3282
+ /** @description Disable changing "sort by" for customers: n - no, y - yes, default - #!domyślny!#. */
3283
+ allow_sort_change: "n" | "y" | "default" | "";
3284
+ /** @description Disable possibility of changing the number of displayed products on the page by customers : n - no, y - yes, default - #!domyślny!#. */
3285
+ allow_limit_change: "n" | "y" | "default" | "";
3286
+ /** @description Link to graphic on the "navigation" page. */
3287
+ gfx_nav?: string;
3288
+ /** @description Graphics in menu: n - no, y - yes. */
3289
+ node_gfx: "n" | "y" | null;
3290
+ /** @description Type of graphics - When the cursor is on the link: img - Image (one size for computers, tablets and smartphones, not recommended), img_rwd - Image (three sizes for RWD). */
3291
+ gfx_active_type?: "img" | "img_rwd";
3292
+ /** @description Link to graphic - When the cursor is on the link. */
3293
+ gfx_active?: string;
3294
+ /** @description Link to graphic - When the cursor is on the link - Desktop. */
3295
+ gfx_active_desktop?: string;
3296
+ /** @description Link to graphic - When the cursor is on the link - Tablet. */
3297
+ gfx_active_tablet?: string;
3298
+ /** @description Link to graphic - When the cursor is on the link - Mobile. */
3299
+ gfx_active_mobile?: string;
3300
+ /** @description Type of graphics - When the cursor is outside link: img - Image (one size for computers, tablets and smartphones, not recommended), img_rwd - Image (three sizes for RWD). */
3301
+ gfx_inactive_type?: "img" | "img_rwd";
3302
+ /** @description Link to graphic - When the cursor is outside link. */
3303
+ gfx?: string;
3304
+ /** @description Link to graphic - When the cursor is outside link - Desktop. */
3305
+ gfx_inactive_desktop?: string;
3306
+ /** @description Link to graphic - When the cursor is outside link - Tablet. */
3307
+ gfx_inactive_tablet?: string;
3308
+ /** @description Link to graphic - When the cursor is outside link - Mobile. */
3309
+ gfx_inactive_mobile?: string;
3310
+ /** @description Type of graphics - When the link is opened: img - Image (one size for computers, tablets and smartphones, not recommended), img_rwd - Image (three sizes for RWD). */
3311
+ gfx_omo_type?: "img" | "img_rwd";
3312
+ /** @description Link to graphic - When the link is opened. */
3313
+ gfx_onmouseover?: string;
3314
+ /** @description Link to graphic - When the link is opened - Desktop. */
3315
+ gfx_omo_desktop?: string;
3316
+ /** @description Link to graphic - When the link is opened - Tablet. */
3317
+ gfx_omo_tablet?: string;
3318
+ /** @description Link to graphic - When the link is opened - Mobile. */
3319
+ gfx_omo_mobile?: string;
3320
+ /** @description Add a canonical link that points to the parent menu item: n - no, y - yes. */
3321
+ canonical_to_parent: "n" | "y" | null;
3322
+ /** @description Meta robots index settings: default - automatically generate, index - index, noindex - noindex. */
3323
+ meta_robots_index: "default" | "index" | "noindex" | null;
3324
+ /** @description Meta robots follow settings: default - automatically generate, follow - follow, nofollow - nofollow. */
3325
+ meta_robots_follow: "default" | "follow" | "nofollow" | null;
3326
+ }[];
3327
+ }[];
3328
+ };
3329
+
3330
+ export type GetAuctionDetailsResponse = {
3331
+ /** @description External listings - orders table. */
3332
+ auctions: {
3333
+ /** @description Order ID. */
3334
+ orderIdent: {
3335
+ /** @description Identifier type. */
3336
+ orderIdentType: "orders_id" | "orders_sn";
3337
+ /** @description ID value. */
3338
+ identValue: string;
3339
+ };
3340
+ /** @description The auctions array for the order. */
3341
+ auctionsDetails?: {
3342
+ /** @description Auction number. */
3343
+ auctionItemId: string | number;
3344
+ /** @description Link to the auction, from which the order came. */
3345
+ auctionUrl: string;
3346
+ /** @description Auction start date. */
3347
+ auctionStartDate: string;
3348
+ /** @description Auction end date. */
3349
+ auctionEndingDate: string;
3350
+ /** @description Transaction details. */
3351
+ auctionTransactionDetails: string;
3352
+ }[];
3353
+ /** @description External marketplace service name. */
3354
+ auctionServiceName?: string | null;
3355
+ /** @description External marketplace service address. */
3356
+ auctionServiceUrl?: string | null;
3357
+ /** @description Auction service account Id . */
3358
+ auctionsAccountId?: string;
3359
+ /** @description External marketplace service account name (which the listing was created from). */
3360
+ auctionsAccountLogin?: string;
3361
+ /** @description Account ID on auction site. */
3362
+ auctionClientId?: string;
3363
+ /** @description Account login on auction site. */
3364
+ auctionClientLogin?: string;
3365
+ /** @description detailed client data. */
3366
+ auctionClientDetails?: string;
3367
+ /** @description Buyer comment. */
3368
+ auctionFeedback?: string;
3369
+ /** @description Order ID in the auction service. */
3370
+ auctionOrderId?: string;
3371
+ /** @description Information on error that occurred during gate call. */
3372
+ errors?: FaultCodeString;
3373
+ }[];
3374
+ /** @description Flag marking errors in the result. */
3375
+ isErrors: boolean;
3376
+ };
3377
+
3378
+ export type GetOrdersDocumentsResponse = {
3379
+ /** @description List of documents. */
3380
+ documents: {
3381
+ /** @description Order serial number. */
3382
+ orderSerialNumber: number;
3383
+ /** @description Document type */
3384
+ documentType: "sales_confirmation" | "vat_invoice" | "corrective_vat_invoice" | "advance_vat_invoice" | "final_advance_vat_invoice" | "pro_forma_invoice" | "advance_pro_forma_invoice" | "final_advance_pro_forma_invoice" | "delivery_note" | "fiscal_receipt" | "fiscal_invoice";
3385
+ /** @description Document id. */
3386
+ id?: number;
3387
+ /** @description Document number. */
3388
+ documentId?: string;
3389
+ /** @description Document name */
3390
+ documentName?: string;
3391
+ /** @description Base64 encoded PDF document. */
3392
+ pdfWithDocumentsInBase64?: string;
3393
+ /** @description Information on error that occurred during gate call. */
3394
+ errors?: FaultCodeString;
3395
+ /** @description Sale date. ISO 8602 format. */
3396
+ documentPurchaseDate?: string | null;
3397
+ /** @example documentIssuedDate */
3398
+ documentIssuedDate?: string | null;
3399
+ /** @description Date of paying for order. */
3400
+ orderPaymentDate?: string | null;
3401
+ /** @description Document data. */
3402
+ documentData?: string;
3403
+ /** @description The identifier of the corrected invoice. */
3404
+ correctedInvoiceId?: string;
3405
+ }[];
3406
+ };
3407
+
3110
3408
  export { }