idosell 0.3.20 → 0.4.3

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,7 +27,6 @@ type FaultCodeString = {
27
27
  faultString: string;
28
28
  }
29
29
 
30
- /** @version v6.1 Typechecked 2025-08-02 */
31
30
  export type SearchOrdersResponse = {
32
31
  Results: {
33
32
  /** @description Order ID. */
@@ -478,7 +477,6 @@ export type SearchOrdersResponse = {
478
477
  }[];
479
478
  } & PagedResponse;
480
479
 
481
- /** @version v6.1 Typechecked 2025-08-02 */
482
480
  export type SearchProductsResponse = {
483
481
  /** @description Object contains detailed information on result of operation. */
484
482
  results: {
@@ -1757,12 +1755,10 @@ type ProductParameter = {
1757
1755
  parameterValueIds: number[];
1758
1756
  }
1759
1757
 
1760
- /** @version v6.1 Typechecked 2025-08-02 */
1761
1758
  export type SearchProductsParametersResponse = {
1762
1759
  parametersResult: Record<string, ProductParameter>;
1763
1760
  } & PagedResponse;
1764
1761
 
1765
- /** @version v6.1 Typechecked 2025-08-02 */
1766
1762
  export type SearchClientsCrmResponse = {
1767
1763
  /** @description List of customers. */
1768
1764
  clientsResults: {
@@ -1951,7 +1947,6 @@ export type SearchClientsCrmResponse = {
1951
1947
  }[];
1952
1948
  } & PagedResponse;
1953
1949
 
1954
- /** @version v6.1 Typechecked 2025-08-02 */
1955
1950
  export type SearchPackagesResponse = {
1956
1951
  /** @description Object contains detailed information on result of operation. */
1957
1952
  results: {
@@ -2038,8 +2033,7 @@ export type SearchPackagesResponse = {
2038
2033
  }[];
2039
2034
  };
2040
2035
 
2041
- /** @version v6.1 Typechecked 2025-08-02 */
2042
- export type SearchCategoriesIdosellResponse = {
2036
+ export type SearchProductsCategoriesIdosellResponse = {
2043
2037
  /** @description List of IdoSell Categories */
2044
2038
  categoriesIdoSell: {
2045
2039
  /** @description IdoSell Category ID */
@@ -2062,7 +2056,6 @@ export type SearchCategoriesIdosellResponse = {
2062
2056
  }[];
2063
2057
  } & PagedResponse;
2064
2058
 
2065
- /** @version v6.1 Typechecked 2025-08-02 */
2066
2059
  export type SearchOrdersOpinionsResponse = {
2067
2060
  /** @description Object contains detailed information on result of operation. */
2068
2061
  results: {
@@ -2129,7 +2122,6 @@ export type SearchOrdersOpinionsResponse = {
2129
2122
  }[];
2130
2123
  } & PagedResponse;
2131
2124
 
2132
- /** @version v6.1 Typechecked 2025-08-02 */
2133
2125
  export type SearchProductsDeliveryTimeResponse = {
2134
2126
  /** @description Object contains detailed information on result of operation. */
2135
2127
  results: {
@@ -2218,7 +2210,6 @@ export type SearchClientsNewsletterSmsResponse = SearchNewsletterResponse<{
2218
2210
  phone_cellular: string;
2219
2211
  }>;
2220
2212
 
2221
- /** @version v6.1 Typechecked 2025-08-02 */
2222
2213
  export type GetWmsStocksdocumentsProductsResponse = {
2223
2214
  /** @description Products list. */
2224
2215
  products: {
@@ -2261,7 +2252,6 @@ export type GetWmsStocksdocumentsProductsResponse = {
2261
2252
  }[];
2262
2253
  } & PagedSnakecaseResponse;
2263
2254
 
2264
- /** @version v6.1 Typechecked 2025-08-02 */
2265
2255
  export type GetWmsStocksdocumentsDocumentsResponse = {
2266
2256
  /** @description List of documents. */
2267
2257
  stocksDocuments: {
@@ -2321,7 +2311,6 @@ export type GetWmsStocksdocumentsDocumentsResponse = {
2321
2311
  }[];
2322
2312
  } & PagedResponse;
2323
2313
 
2324
- /** @version v6.1 Typechecked 2025-08-02 */
2325
2314
  export type GetClientsResponse = {
2326
2315
  /** @description Object contains detailed information on result of operation. */
2327
2316
  results: {
@@ -2443,7 +2432,6 @@ export type GetClientsResponse = {
2443
2432
  }[];
2444
2433
  } & PagedResponse;
2445
2434
 
2446
- /** @version v6.1 Typechecked 2025-08-02 */
2447
2435
  export type GetReturnsResponse = {
2448
2436
  /** @description Element that contains the list of found returns. */
2449
2437
  returns: {
@@ -2585,7 +2573,6 @@ export type GetReturnsResponse = {
2585
2573
  }[];
2586
2574
  } & PagedSnakecaseResponse;
2587
2575
 
2588
- /** @version v6.1 Typechecked 2025-08-02 */
2589
2576
  export type GetRmaResponse = {
2590
2577
  /** @description Complaints. */
2591
2578
  rmas: {
@@ -2678,7 +2665,6 @@ export type GetRmaResponse = {
2678
2665
  isErrors: boolean;
2679
2666
  } & PagedResponse;
2680
2667
 
2681
- /** @version v6.1 Typechecked 2025-08-02 */
2682
2668
  export type GetSystemConfigResponse = {
2683
2669
  /** @example 1 */
2684
2670
  client_id: number;
@@ -2986,8 +2972,30 @@ export type GetSystemConfigResponse = {
2986
2972
  typeOfPrinterProtocolAdress: string;
2987
2973
  };
2988
2974
 
2989
- /** @version v6.1 Typechecked 2025-08-02 */
2990
- export type GetSystemShopsDataResponse = Omit<GetConfigResponse, 'panel_settings'|'shops'> & {
2975
+ type ShopsPanelSettings = {
2976
+ /** @description Default panel language. */
2977
+ default_lang_id: string;
2978
+ /** @description Panel base currency. */
2979
+ basecurrency_id: string;
2980
+ /** @description Manual stock quantity modification restriction. */
2981
+ stocks_change_disabled: string;
2982
+ /** */
2983
+ stock_state_config: "uncontrolled" | "bridge" | "outside";
2984
+ /** */
2985
+ main_stock_system: "other" | "iai";
2986
+ /** @description Sales documents in third party application. */
2987
+ salesDocumentsAreCreatedByClient: boolean;
2988
+ search_by_code: {
2989
+ /** @description IAI code. */
2990
+ code_iai: boolean;
2991
+ /** @description External system code. */
2992
+ code_extern: boolean;
2993
+ /** @description Producer code. */
2994
+ code_producer: boolean;
2995
+ };
2996
+ }
2997
+
2998
+ export type GetSystemShopsDataResponse = Omit<GetSystemConfigResponse, 'panel_settings'|'shops'> & {
2991
2999
  /** @description Shop contact data */
2992
3000
  shop_contact: {
2993
3001
  /** @description shop ID */
@@ -3071,7 +3079,6 @@ export type GetSystemShopsDataResponse = Omit<GetConfigResponse, 'panel_settings
3071
3079
  }[];
3072
3080
  };
3073
3081
 
3074
- /** @version v6.1 Typechecked 2025-08-02 */
3075
3082
  export type GetSizechartsResponse = {
3076
3083
  sizeCharts: {
3077
3084
  [id: string]: {
@@ -3114,7 +3121,6 @@ export type GetSizechartsResponse = {
3114
3121
  } | [];
3115
3122
  } & PagedResponse;
3116
3123
 
3117
- /** @version v6.1 Typechecked 2025-08-02 */
3118
3124
  export type GetWmsLocationsResponse = {
3119
3125
  /** @description Object contains detailed information on result of operation. */
3120
3126
  results: {
@@ -3142,7 +3148,6 @@ export type GetWmsLocationsResponse = {
3142
3148
  }[];
3143
3149
  } & PagedResponse;
3144
3150
 
3145
- /** @version v6.1 Typechecked 2025-08-02 */
3146
3151
  export type GetWarrantiesResponse = {
3147
3152
  warranties: {
3148
3153
  /** @description Warranty language id (numeric). */
@@ -3168,7 +3173,6 @@ export type GetWarrantiesResponse = {
3168
3173
  }[];
3169
3174
  } & PagedSnakecaseResponse;
3170
3175
 
3171
- /** @version v6.1 Typechecked 2025-08-02 */
3172
3176
  export type GetProductsCategoriesResponse = {
3173
3177
  last_changed_time: string;
3174
3178
  /** @description Element containing a list of found results on a given page. */
@@ -3216,7 +3220,6 @@ export type GetProductsCategoriesResponse = {
3216
3220
  }[];
3217
3221
  } & PagedSnakecaseResponse;
3218
3222
 
3219
- /** @version v6.1 Typechecked 2025-08-02 */
3220
3223
  export type GetMenuResponse = {
3221
3224
  /** @description Parameters concerning returned results */
3222
3225
  result: {
@@ -3327,7 +3330,6 @@ export type GetMenuResponse = {
3327
3330
  }[];
3328
3331
  };
3329
3332
 
3330
- /** @version v6.1 Typechecked 2025-08-02 */
3331
3333
  export type GetOrdersAuctionDetailsResponse = {
3332
3334
  /** @description External listings - orders table. */
3333
3335
  auctions: {
@@ -3376,7 +3378,6 @@ export type GetOrdersAuctionDetailsResponse = {
3376
3378
  isErrors: boolean;
3377
3379
  };
3378
3380
 
3379
- /** @version v6.1 Typechecked 2025-08-02 */
3380
3381
  export type GetOrdersDocumentsResponse = {
3381
3382
  /** @description List of documents. */
3382
3383
  documents: {
@@ -3731,7 +3732,6 @@ export type GetCouriersPickupPointsResponse = {
3731
3732
  }[];
3732
3733
  } & PagedResponse;
3733
3734
 
3734
- /** @version v6.1 Typechecked 2025-08-02 */
3735
3735
  export type GetClientsDeliveryAddressResponse = {
3736
3736
  /** @description Object contains detailed information on result of operation. */
3737
3737
  results: {
@@ -3770,7 +3770,6 @@ export type GetClientsDeliveryAddressResponse = {
3770
3770
  }[];
3771
3771
  };
3772
3772
 
3773
- /** @version v6.1 Typechecked 2025-08-02 */
3774
3773
  export type GetClientsPayerAddressResponse = {
3775
3774
  payerAddressesResults: {
3776
3775
  /** @description Buyer's address id. */
@@ -3798,7 +3797,6 @@ export type GetClientsPayerAddressResponse = {
3798
3797
  }[];
3799
3798
  } & PagedResponse;
3800
3799
 
3801
- /** @version v6.1 Typechecked 2025-08-02 */
3802
3800
  export type GetProductsAuctionsResponse = {
3803
3801
  /** @description Object contains detailed information on result of operation. */
3804
3802
  results: {
@@ -3835,7 +3833,6 @@ export type GetProductsAuctionsResponse = {
3835
3833
  } & PagedResponse;
3836
3834
  };
3837
3835
 
3838
- /** @version v6.1 Typechecked 2025-08-02 */
3839
3836
  export type GetProductsBrandsResponse = {
3840
3837
  /** @description Element containing a list of found results on a given page. */
3841
3838
  producers: {
@@ -3887,7 +3884,6 @@ export type GetProductsBrandsResponse = {
3887
3884
  }[];
3888
3885
  } & PagedSnakecaseResponse;
3889
3886
 
3890
- /** @version v6.1 Typechecked 2025-08-02 */
3891
3887
  export type GetProductsDescriptionsResponse = {
3892
3888
  /** @description Object contains detailed information on result of operation. */
3893
3889
  results: {
@@ -3953,7 +3949,6 @@ export type GetProductsDescriptionsResponse = {
3953
3949
  errorsOccurred: boolean;
3954
3950
  };
3955
3951
 
3956
- /** @version v6.1 Typechecked 2025-08-02 */
3957
3952
  export type GetProductsOpinionsResponse = {
3958
3953
  /** @description Object contains detailed information on result of operation. */
3959
3954
  results: {
@@ -4022,7 +4017,6 @@ export type GetProductsOpinionsResponse = {
4022
4017
  }[];
4023
4018
  } & PagedResponse;
4024
4019
 
4025
- /** @version v6.3 Typechecked 2025-08-23 */
4026
4020
  export type GetSnippetsResponse = {
4027
4021
  results: {
4028
4022
  /** @description Id of the code snippet. */
@@ -4160,7 +4154,6 @@ export type GetSnippetsResponse = {
4160
4154
  pagination: PagedResponse;
4161
4155
  };
4162
4156
 
4163
- /** @version v6.3 Typechecked 2025-08-23 */
4164
4157
  export type GetSystemUsersResponse = {
4165
4158
  /** @description List of panel users. */
4166
4159
  users: {
@@ -4222,7 +4215,6 @@ export type GetSystemUsersResponse = {
4222
4215
  }[];
4223
4216
  };
4224
4217
 
4225
- /** @version v6.3 Typechecked 2025-08-23 */
4226
4218
  export type GetWmsSuppliersResponse = {
4227
4219
  /** @description List of product suppliers */
4228
4220
  suppliers: {
@@ -4278,7 +4270,6 @@ export type GetWmsSuppliersResponse = {
4278
4270
  }[];
4279
4271
  } & PagedResponse;
4280
4272
 
4281
- /** @version v6.3 Typechecked 2025-08-23 */
4282
4273
  export type GetProductsCodeExistenceResponse = {
4283
4274
  results: {
4284
4275
  /** @description Products list. */
@@ -4297,7 +4288,6 @@ export type GetProductsCodeExistenceResponse = {
4297
4288
  };
4298
4289
  };
4299
4290
 
4300
- /** @version v6.3 Typechecked 2025-08-23 */
4301
4291
  export type GetProductsIdBySizecodeResponse = {
4302
4292
  /** @description Object contains detailed information on result of operation. */
4303
4293
  results: {
@@ -4316,7 +4306,6 @@ export type GetProductsIdBySizecodeResponse = {
4316
4306
  }[];
4317
4307
  };
4318
4308
 
4319
- /** @version v6.3 Typechecked 2025-08-23 */
4320
4309
  export type GetProductsOmnibusPricesResponse = {
4321
4310
  /** @description Products list. */
4322
4311
  products: {
@@ -4357,7 +4346,6 @@ export type GetProductsOmnibusPricesResponse = {
4357
4346
  };
4358
4347
  };
4359
4348
 
4360
- /** @version v6.3 Typechecked 2025-08-23 */
4361
4349
  export type GetProductsSizesResponse = {
4362
4350
  /** @description Object contains detailed information on result of operation. */
4363
4351
  results: {
@@ -4407,7 +4395,6 @@ export type GetProductsSizesResponse = {
4407
4395
  };
4408
4396
  };
4409
4397
 
4410
- /** @version v6.3 Typechecked 2025-08-23 */
4411
4398
  export type GetProductsSKUbyBarcodeResponse = {
4412
4399
  /** @description Object contains detailed information on result of operation. */
4413
4400
  results: {
@@ -4554,7 +4541,6 @@ export type GetProductsSKUbyBarcodeResponse = {
4554
4541
  }[];
4555
4542
  };
4556
4543
 
4557
- /** @version v6.3 Typechecked 2025-08-23 */
4558
4544
  export type GetSystemUnitsResponse = {
4559
4545
  result: {
4560
4546
  units: {
@@ -4584,7 +4570,6 @@ export type GetSystemUnitsResponse = {
4584
4570
  };
4585
4571
  };
4586
4572
 
4587
- /** @version v6.3 Typechecked 2025-08-23 */
4588
4573
  export type GetProductsReservationsResponse = {
4589
4574
  /** @description Object contains detailed information on result of operation. */
4590
4575
  results: {
@@ -4625,7 +4610,6 @@ export type GetProductsReservationsResponse = {
4625
4610
  };
4626
4611
  };
4627
4612
 
4628
- /** @version v6.3 Typechecked 2025-08-23 */
4629
4613
  export type GetProductsSeriesResponse = {
4630
4614
  /** @description Date of last modification (YYYY-MM-DD HH-MM-SS). */
4631
4615
  last_changed_time: string;
@@ -4648,7 +4632,6 @@ export type GetProductsSeriesResponse = {
4648
4632
  }[];
4649
4633
  } & PagedResponse;
4650
4634
 
4651
- /** @version v6.3 Typechecked 2025-08-23 */
4652
4635
  export type GetShopsCurrenciesResponse = {
4653
4636
  /** @description List of shops */
4654
4637
  shops: {
@@ -4668,7 +4651,6 @@ export type GetShopsCurrenciesResponse = {
4668
4651
  }[];
4669
4652
  };
4670
4653
 
4671
- /** @version v6.3 Typechecked 2025-08-23 */
4672
4654
  export type GetShopsLanguagesResponse = {
4673
4655
  /** @description List of shops */
4674
4656
  shops: {
@@ -4713,7 +4695,6 @@ export type GetConfigVariablesResponse = {
4713
4695
  pagination: PagedResponse;
4714
4696
  };
4715
4697
 
4716
- /** @version v6.3 Typechecked 2025-08-23 */
4717
4698
  export type GetSystemCurrenciesResponse = {
4718
4699
  /** @description Number of decimal spaces for price rounding. */
4719
4700
  currency_round: number;
@@ -4733,7 +4714,6 @@ export type GetSystemCurrenciesResponse = {
4733
4714
  }[];
4734
4715
  };
4735
4716
 
4736
- /** @version v6.3 Typechecked 2025-08-23 */
4737
4717
  export type GetPackagesLabelsResponse = {
4738
4718
  /** @description Package labels encoded in base64 */
4739
4719
  labels: string[];
@@ -4741,7 +4721,6 @@ export type GetPackagesLabelsResponse = {
4741
4721
  labelsType: "PDF" | "A4" | "16x10" | "SPL" | "ZPL" | "EPL" | "DPL";
4742
4722
  };
4743
4723
 
4744
- /** @version v6.3 Typechecked 2025-08-23 */
4745
4724
  export type GetOrdersProfitabilityResponse = {
4746
4725
  /** @description Order value (net) */
4747
4726
  totalPrice: number;
@@ -4761,7 +4740,6 @@ export type GetOrdersProfitabilityResponse = {
4761
4740
  profitMarginPercent: number;
4762
4741
  };
4763
4742
 
4764
- /** @version v6.3 Typechecked 2025-08-23 */
4765
4743
  export type GetOrdersPackagesResponse = {
4766
4744
  /** @description Object contains detailed information on result of operation. */
4767
4745
  results: {
@@ -4846,7 +4824,6 @@ export type GetOrdersPackagesResponse = {
4846
4824
  }[];
4847
4825
  };
4848
4826
 
4849
- /** @version v6.3 Typechecked 2025-08-23 */
4850
4827
  export type GetOrdersAnalyticsResponse = {
4851
4828
  /** @description Object contains detailed information on result of operation. */
4852
4829
  results: null | {
@@ -4870,7 +4847,6 @@ export type GetOrdersAnalyticsResponse = {
4870
4847
  }[];
4871
4848
  };
4872
4849
 
4873
- /** @version v6.3 Typechecked 2025-08-23 */
4874
4850
  export type GetCouriersAssignedToShippingProfilesResponse = {
4875
4851
  couriers: {
4876
4852
  [courier: string]: {
@@ -4896,16 +4872,982 @@ export type GetCouriersAssignedToShippingProfilesResponse = {
4896
4872
  };
4897
4873
  };
4898
4874
 
4899
- /** @version v6.3 Typechecked 2025-08-23 */
4900
4875
  export type GetOrdersStatusesResponse = {
4901
4876
  statuses: {
4902
4877
  /** @description Status identifier */
4903
4878
  id: number;
4904
4879
  /** @description Parent status identifier */
4905
- parentId: string | null;
4880
+ parentId: number | null;
4906
4881
  /** @example Packed by Employee#1 */
4907
4882
  panelName: string;
4908
4883
  }[];
4909
4884
  };
4910
4885
 
4886
+ export type GetPaymentsResponse = {
4887
+ /** @description Parameters concerning returned results */
4888
+ result: {
4889
+ /** @description Order serial number. */
4890
+ orderNumber: number;
4891
+ /** @description Payment number for order. */
4892
+ ordinalNumber: number;
4893
+ /** @description Amount of payment. */
4894
+ value: number;
4895
+ /** @description Order currency ID (currency list can be obtained through getShopsData gate). */
4896
+ currency: string;
4897
+ /** @description Registering date. */
4898
+ accountingDate: string;
4899
+ /** */
4900
+ status: "pending" | "processed" | "cancelled";
4901
+ /** @description Form of payment ID. */
4902
+ paymentFormId: number;
4903
+ /** @description Transaction ID in external service */
4904
+ externalPaymentId: string;
4905
+ /** @description The additional status of the payment or refund returned by the third-party service. For returns by IdoPay, possible values are: "waiting", "waiting for funds", "waiting for data", "processed", "confirmed", "rejected", "error". */
4906
+ externalPaymentStatus: string;
4907
+ /** @description Event log. */
4908
+ eventLog: {
4909
+ /** @description Event log. */
4910
+ eventLogList: {
4911
+ /** @description User login. */
4912
+ user: string;
4913
+ /** @description Error code. */
4914
+ eventCode: string;
4915
+ /** @description Date. */
4916
+ date: string;
4917
+ /** */
4918
+ level: "info" | "error" | "warn";
4919
+ /** @description Error description. */
4920
+ details: string;
4921
+ }[];
4922
+ };
4923
+ };
4924
+ };
4925
+
4926
+ export type GetProductsStrikethroughPricesResponse = {
4927
+ /** @description Products list. */
4928
+ products: {
4929
+ [productId: string]: {
4930
+ /** @description Identifier type. */
4931
+ ident: {
4932
+ /** */
4933
+ type: "id" | "index" | "codeExtern" | "codeProducer";
4934
+ /** @description Value. */
4935
+ value: number;
4936
+ };
4937
+ /** @description Strikethrough gross retail price. */
4938
+ strikethrough_retail_price: number;
4939
+ /** @description Strikethrough gross wholesale price. */
4940
+ strikethrough_wholesale_price: number;
4941
+ shops: {
4942
+ [shop: string]: {
4943
+ /** @description Shop Id */
4944
+ shop_id: number;
4945
+ /** @description Strikethrough gross retail price. */
4946
+ strikethrough_retail_price: number;
4947
+ /** @description Strikethrough gross wholesale price. */
4948
+ strikethrough_wholesale_price: number;
4949
+ /** @description List of sizes */
4950
+ sizes: {
4951
+ [size: string]: {
4952
+ /** @description Identifier type. */
4953
+ ident: {
4954
+ /** */
4955
+ type: "id" | "index" | "codeExtern" | "codeProducer";
4956
+ /** @description Value. */
4957
+ value: string;
4958
+ };
4959
+ /** @description Strikethrough gross retail price. */
4960
+ strikethrough_retail_price: number;
4961
+ /** @description Strikethrough gross wholesale price. */
4962
+ strikethrough_wholesale_price: number
4963
+ } | []
4964
+ }
4965
+ } | []
4966
+ };
4967
+ /** @description Error information. */
4968
+ error?: FaultCodeString
4969
+ } | []
4970
+ };
4971
+ };
4972
+
4973
+ export type GetSystemProcessesAutomationResponse = {
4974
+ /** @description Orders. */
4975
+ orders: {
4976
+ shops: {
4977
+ /** @description Shop Id */
4978
+ shopId: number;
4979
+ /** @description Allow the status to be changed to "Shipped" even if the order payments and stock levels do not match */
4980
+ alwaysAllowSentStatus: "y" | "n";
4981
+ }[];
4982
+ /** @description Order management restrictions */
4983
+ restrictions: {
4984
+ /** @description Block the ability of selecting a status, if there are products in the warehouse from which the order is being processed, with insufficient stock level. */
4985
+ blockIfIncorrectStockQuantities: {
4986
+ restrictedShops: {
4987
+ /** @description Shop Id */
4988
+ shopId: number;
4989
+ /** @description Block the ability of selecting a status "completed" if there are products in the warehouse from which the order is being processed, with insufficient stock level */
4990
+ finished: "y" | "n";
4991
+ }[];
4992
+ };
4993
+ };
4994
+ };
4995
+ };
4996
+
4997
+ export type GetEntriesPagesToDisplayResponse = {
4998
+ /** @description Parameters concerning returned results */
4999
+ result: {
5000
+ /** @description List of pages on which the entry is to be published */
5001
+ pagesToDisplayOn: {
5002
+ /** @description Page ID */
5003
+ siteId: string;
5004
+ /** @description Store name */
5005
+ siteName: string;
5006
+ }[];
5007
+ };
5008
+ };
5009
+
5010
+ export type GetEntriesResponse = {
5011
+ /** @description Parameters concerning returned results */
5012
+ result: {
5013
+ /** @description Blog entry content */
5014
+ entry: {
5015
+ /** @description Date of creating an entry */
5016
+ date: string;
5017
+ /** @description Entry visibility */
5018
+ visible: "y" | "n";
5019
+ /** @description Photo */
5020
+ picture: string;
5021
+ /** @description Name on the page */
5022
+ title: string;
5023
+ /** @description short description */
5024
+ shortDescription: string;
5025
+ /** @description Long description */
5026
+ longDescription: string;
5027
+ /** @description Blog post URL */
5028
+ blogUrl: string;
5029
+ /** @description News item URL */
5030
+ newsUrl: string;
5031
+ /** @description Products list. */
5032
+ products: {
5033
+ /** @description Merchandise identifier */
5034
+ productId: string;
5035
+ /** @description Product name. */
5036
+ productName: string;
5037
+ }[];
5038
+ /** @description List of pages on which the entry is to be published */
5039
+ visibleOnSitesList: {
5040
+ /** @description Page ID */
5041
+ siteId: string;
5042
+ /** @description Store name */
5043
+ siteName: string;
5044
+ }[];
5045
+ /** @description Type of title and shortcut linking: fullContentLink - link to the subpage with full content, givenUrlLink - link to the given URL, noLink - static element */
5046
+ titleLinkType: string;
5047
+ /** @description Provided URL (for link to specified URL option) */
5048
+ link: string;
5049
+ };
5050
+ };
5051
+ };
5052
+
5053
+ export type GetCpaResponse = {
5054
+ results: {
5055
+ /** @description Id of the CPA program. */
5056
+ id: number | null;
5057
+ /** @description The CPA program name. */
5058
+ name: string;
5059
+ /** @description Whether the CPA program is active. */
5060
+ active: "y" | "n";
5061
+ /** @description CPA campaign id */
5062
+ campaign: number;
5063
+ /** @description CPA program page settings simple or advanced, depending on the mode. */
5064
+ pageSettings: (Omit<{
5065
+ /** @description Whether to display to all sites. */
5066
+ mode: "simple" | "advanced";
5067
+ }, "mode"> & {
5068
+ /** @description Whether to display to all sites. */
5069
+ mode: "simple";
5070
+ /** @description The place where the cpa code is loaded. (For "all" mode)
5071
+ |null} */
5072
+ zone: "head" | "bodyBegin" | "bodyEnd" | null;
5073
+ /** @description Snippet content for each language. (For "all" mode) */
5074
+ body: {
5075
+ /** @description Language code. */
5076
+ lang: string;
5077
+ /** @example Hello world */
5078
+ body: string;
5079
+ }[] | null;
5080
+ }) | (Omit<{
5081
+ /** @description Whether to display to all sites. */
5082
+ mode: "simple" | "advanced";
5083
+ }, "mode"> & {
5084
+ /** @description Whether to display to all sites. */
5085
+ mode: "advanced";
5086
+ /** @description Page setting for advance mode */
5087
+ pages: {
5088
+ /** @enum {string} */
5089
+ active: "y" | "n";
5090
+ /** @enum {string} */
5091
+ page: "home" | "basket" | "checkout_payment_delivery" | "checkout_confirmation" | "new_order_placement" | "order_details" | "navigation" | "product_details" | "search_results" | "after_order_place" | "mailing_subscribe" | "other_pages";
5092
+ /** @description The place where the cpa code is loaded. (For "all" mode) */
5093
+ zone: "head" | "bodyBegin" | "bodyEnd";
5094
+ body: {
5095
+ /** @description Language code. */
5096
+ lang: string;
5097
+ /** @example Hello world */
5098
+ body: string;
5099
+ }[];
5100
+ }[];
5101
+ });
5102
+ display: {
5103
+ /** @description Type of customers to whom to display the snippet */
5104
+ clientType: "all" | "unregistered" | "registered" | "retailer" | "wholesaler";
5105
+ /** @description Whether to display only for newsletter visitors. */
5106
+ newsletter: "y" | "n" | "all";
5107
+ /** @description Whether to display the code snippet only for customers who have placed an order */
5108
+ hasOrders: "y" | "n" | "all";
5109
+ /** @description Display only after entering rebate code */
5110
+ useRebateCode: "y" | "n" | "all";
5111
+ };
5112
+ /** @description Snippet entry source filter. */
5113
+ sources: {
5114
+ direct: {
5115
+ /** @description Whether source filter is active */
5116
+ active: "y" | "n";
5117
+ /** @description Id of service of given source */
5118
+ id: number | null;
5119
+ } | null;
5120
+ search: {
5121
+ /** @description Whether source filter is active */
5122
+ active: "y" | "n";
5123
+ /** @description Id of service of given source */
5124
+ id: number | null;
5125
+ } | null;
5126
+ advert: {
5127
+ /** @description Whether source filter is active */
5128
+ active: "y" | "n";
5129
+ /** @description Id of service of given source */
5130
+ id: number | null;
5131
+ } | null;
5132
+ priceComparers: {
5133
+ /** @description Whether source filter is active */
5134
+ active: "y" | "n";
5135
+ /** @description Id of service of given source */
5136
+ id: number | null;
5137
+ } | null;
5138
+ affiliate: {
5139
+ /** @description Whether source filter is active */
5140
+ active: "y" | "n";
5141
+ /** @description Id of service of given source */
5142
+ id: number | null;
5143
+ } | null;
5144
+ cpa: {
5145
+ /** @description Whether source filter is active */
5146
+ active: "y" | "n";
5147
+ /** @description Id of service of given source */
5148
+ id: number | null;
5149
+ } | null;
5150
+ newsletter: {
5151
+ /** @description Whether source filter is active */
5152
+ active: "y" | "n";
5153
+ /** @description Id of service of given source */
5154
+ id: number | null;
5155
+ } | null;
5156
+ social: {
5157
+ /** @description Whether source filter is active */
5158
+ active: "y" | "n";
5159
+ /** @description Id of service of given source */
5160
+ id: number | null;
5161
+ } | null;
5162
+ page: {
5163
+ /** @description Whether source filter is active */
5164
+ active: "y" | "n";
5165
+ /** @description Id of service of given source */
5166
+ id: number | null;
5167
+ } | null;
5168
+ };
5169
+ /** @description List of variables that can be used in a body template. */
5170
+ variables: {
5171
+ name: string;
5172
+ /** @enum {string} */
5173
+ source: "session" | "cookie";
5174
+ }[];
5175
+ }[];
5176
+ pagination: PagedResponse;
5177
+ };
5178
+
5179
+ export type GetVouchersTypesResponse = {
5180
+ /** @description List of all discount code campaigns defined in the administration panel */
5181
+ vouchersTypes: {
5182
+ /** @description Discount code campaign ID */
5183
+ voucherTypeId: number;
5184
+ /** @description Discount code campaign name */
5185
+ voucherTypeName: string;
5186
+ }[];
5187
+ } & PagedResponse;
5188
+
5189
+ export type GetVouchersResponse = {
5190
+ /** @description Parameters concerning returned results */
5191
+ result: {
5192
+ voucherData: {
5193
+ /** @description Voucher ID */
5194
+ id: number;
5195
+ /** @description Number. */
5196
+ number: string;
5197
+ /** @description Name. */
5198
+ name: string;
5199
+ /** @description Voucher expiration date */
5200
+ expirationDate: string;
5201
+ /** @description Voucher balance */
5202
+ balance: {
5203
+ /** @description Available balance */
5204
+ amount: number;
5205
+ /** @description Currency. */
5206
+ currency: string;
5207
+ };
5208
+ /** @description List of shops the voucher is active in */
5209
+ shops: number[];
5210
+ /** @example note */
5211
+ note: string;
5212
+ /** @description Status list: "y" - used, "n" - unused, "b" - blocked, "unverified" - awaiting approval */
5213
+ status: string;
5214
+ /** @description Is active? */
5215
+ blocked: "0" | "1";
5216
+ };
5217
+ /** @description Error code. List of error codes: "0" - Operation was successful, "1" - Login failure: invalid username or key, "123" - Error occurred when retrieving voucher data */
5218
+ faultCode: number;
5219
+ /** @description Error description. */
5220
+ faultString: string;
5221
+ }[];
5222
+ } & PagedResponse;
5223
+
5224
+ export type GetOrdersHistoryResponse = {
5225
+ /** @description List of events */
5226
+ historyEvents: {
5227
+ /** @description Date when the event occurred */
5228
+ eventDate: string;
5229
+ /** @description Login */
5230
+ username: string;
5231
+ /** @description Event details */
5232
+ eventDetails: string;
5233
+ }[];
5234
+ };
5235
+
5236
+ export type GetSnippetsCampaignResponse = {
5237
+ results: {
5238
+ /** @description Snippet campaign id */
5239
+ id: number | null;
5240
+ /** @description Snippet campaign name */
5241
+ name: string;
5242
+ /** @description Snippet campaign internal description */
5243
+ description: string;
5244
+ /** @description Shop ids where code snippets are active 1 ] */
5245
+ shop: number[] | null;
5246
+ /** @description Whether the snippet is active */
5247
+ active: "y" | "n";
5248
+ /** @description Whether the snippet campaign is deleted */
5249
+ readonly deleted: "y" | "n";
5250
+ /** @description Snippet order. */
5251
+ order: number;
5252
+ /** @description Number of code snippets associated with the campaign. */
5253
+ readonly snippetCount: number | null;
5254
+ /** @description Number of active code snippets associated with the campaign. */
5255
+ readonly activeSnippetCount: number | null;
5256
+ configVariables: {
5257
+ /** @description Key of config value. */
5258
+ key: string;
5259
+ /** @description Name of config item. */
5260
+ readonly name: string;
5261
+ /** @description Value of config item. */
5262
+ value: string;
5263
+ }[];
5264
+ }[];
5265
+ pagination: PagedResponse;
5266
+ };
5267
+
5268
+ export type GetSnippetsCookiesResponse = {
5269
+ results: {
5270
+ /** @description Snippet */
5271
+ id: number | null;
5272
+ /** @description Id of the snippet code. */
5273
+ snippetId: number;
5274
+ /** @description Name of the cookie vendor. */
5275
+ deliverer: string;
5276
+ /** @description Category of the cookie */
5277
+ category: "analytics" | "marketing" | "functional";
5278
+ /** @description Cookie description for each language. */
5279
+ description: {
5280
+ /** @description Language code. */
5281
+ lang: string;
5282
+ /** @example Hello world */
5283
+ body: string;
5284
+ }[];
5285
+ /** @description Name of the cookie. */
5286
+ name: string | null;
5287
+ /** @description Type of the cookie
5288
+ |null} */
5289
+ type: "cookie" | "pixel" | "localStorage" | null;
5290
+ /** @description Cookie lifetime mode
5291
+ |null} */
5292
+ lifeTimeType: "temporary" | "days" | "minutes" | null;
5293
+ /** @description Cookie lifetime */
5294
+ lifeTime: number | null;
5295
+ }[];
5296
+ pagination: PagedResponse;
5297
+ };
5298
+
5299
+ export type PostOrdersResponse = {
5300
+ results: {
5301
+ /** @description List of orders returned in gate call. */
5302
+ ordersResults: {
5303
+ /** @description Error code. */
5304
+ faultCode: number;
5305
+ /** @description Error description. */
5306
+ faultString: string;
5307
+ /** @description Order ID. */
5308
+ orderId: string;
5309
+ /** @description Order serial number. */
5310
+ orderSerialNumber?: number;
5311
+ /** @description The list of products returned due to a gate call */
5312
+ productsResults: null | {
5313
+ /** @description Product IAI code */
5314
+ productId: number;
5315
+ /** @description Size identifier */
5316
+ sizeId: string;
5317
+ /** @description External product system code for size. */
5318
+ productSizeCodeExternal: string;
5319
+ /** @description Stock ID */
5320
+ stockId?: number;
5321
+ /** @description Item in basket. */
5322
+ basketPosition: number;
5323
+ /** @description Error code. */
5324
+ faultCode: number;
5325
+ /** @description Error description. */
5326
+ faultString: string;
5327
+ }[];
5328
+ }[];
5329
+ };
5330
+ };
5331
+
5332
+ export type PostProductsResponse = {
5333
+ /** @description Object contains detailed information on result of operation. */
5334
+ results: {
5335
+ /** @description The list of products returned due to a gate call */
5336
+ productsResults: {
5337
+ /** @description Product IAI code */
5338
+ productId: number;
5339
+ /** @description Size identifier */
5340
+ sizeId: string | null;
5341
+ /** @description External product system code for size. */
5342
+ productSizeCodeExternal: string | null;
5343
+ /** @description Element containing details of the error. */
5344
+ faults?: {
5345
+ /** @description Error code. */
5346
+ faultCode: string;
5347
+ /** @description Error description. */
5348
+ faultString: string;
5349
+ }[];
5350
+ /** @description Object contains detailed information on performed operation. */
5351
+ productResultDetails?: {
5352
+ /** @description Stock ID */
5353
+ stockId?: number;
5354
+ /** @description Product stock quantity */
5355
+ productSizeQuantity?: number;
5356
+ /** @description Shop Id */
5357
+ shopId?: number;
5358
+ /** @description Size identifier */
5359
+ sizeId?: string;
5360
+ /** @description Operation type */
5361
+ operationType?: string;
5362
+ /** @description Element containing details of the error. */
5363
+ fault?: {
5364
+ /** @description Error code. */
5365
+ faultCode: string;
5366
+ /** @description Error description. */
5367
+ faultString: string;
5368
+ };
5369
+ existingCodes?: {
5370
+ [code: string]: {
5371
+ /** @description Product IAI code */
5372
+ productId: number;
5373
+ /** @description Size identifier */
5374
+ sizeId: string;
5375
+ /** @description External product system code for size. */
5376
+ productSizeCodeExternal: string;
5377
+ /** @description Producer code */
5378
+ productProducerCode: string
5379
+ } | []
5380
+ };
5381
+ }[];
5382
+ }[];
5383
+ };
5384
+ };
5385
+
5386
+ export type PutProductsResponse = {
5387
+ /** @description Object contains detailed information on result of operation. */
5388
+ results: {
5389
+ /** @description The list of products returned due to a gate call */
5390
+ productsResults: {
5391
+ /** @description Product IAI code */
5392
+ productId: number;
5393
+ /** @description One of the unique, indexed product codes (IAI code / External system code / Producer code) */
5394
+ productIndex?: string;
5395
+ promoteStatus?: {
5396
+ /** @description Is attribute set */
5397
+ promoteIsEnabled: boolean;
5398
+ /** @description Strikethrough price */
5399
+ promoteItemNormalPrice: number;
5400
+ /** @description Gross price */
5401
+ productRetailPrice: number;
5402
+ };
5403
+ /** @description Size identifier */
5404
+ sizeId: string | null;
5405
+ /** @description External product system code for size. */
5406
+ productSizeCodeExternal: string | null;
5407
+ /** @description Element containing details of the error. */
5408
+ faults: {
5409
+ /** @description Error code. */
5410
+ faultCode: string;
5411
+ /** @description Error description. */
5412
+ faultString: string;
5413
+ }[];
5414
+ /** @description Object contains detailed information on performed operation. */
5415
+ productResultDetails: {
5416
+ /** @description Stock ID */
5417
+ stockId: number;
5418
+ /** @description Product stock quantity */
5419
+ productSizeQuantity: number;
5420
+ /** @description Shop Id */
5421
+ shopId: number;
5422
+ /** @description Size identifier */
5423
+ sizeId: string;
5424
+ /** @description Operation type */
5425
+ operationType: string;
5426
+ /** @description Element containing details of the error. */
5427
+ fault: {
5428
+ /** @description Error code. */
5429
+ faultCode: string;
5430
+ /** @description Error description. */
5431
+ faultString: string;
5432
+ };
5433
+ existingCodes: {
5434
+ /** @description Product IAI code */
5435
+ productId: number;
5436
+ /** @description Size identifier */
5437
+ sizeId: string;
5438
+ /** @description External product system code for size. */
5439
+ productSizeCodeExternal: string;
5440
+ /** @description Producer code */
5441
+ productProducerCode: string;
5442
+ }[];
5443
+ }[];
5444
+ }[];
5445
+ };
5446
+ };
5447
+
5448
+ export type PutOrdersResponse = {
5449
+ results: {
5450
+ /** @description List of orders returned in gate call. */
5451
+ ordersResults: {
5452
+ /** @description Order ID. */
5453
+ orderId: string;
5454
+ /** @description Order serial number. */
5455
+ orderSerialNumber: number;
5456
+ /** @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. */
5457
+ orderStatus: string;
5458
+ /** @description Order status id . */
5459
+ orderStatusId: number;
5460
+ /** @description The list of products returned due to a gate call */
5461
+ productsResults?: {
5462
+ /** @description Product IAI code */
5463
+ productId: number;
5464
+ /** @description Size identifier */
5465
+ sizeId: string;
5466
+ /** @description External product system code for size. */
5467
+ productSizeCodeExternal: string;
5468
+ /** @description Item in basket. */
5469
+ basketPosition: number;
5470
+ /** @description Stock ID */
5471
+ stockId: number;
5472
+ /** @description Error code. List of error codes: 0 - Operation was successful, 1 - Not specified Id or serial number of the order, 2 - Order status entered in call parameters is not handled by the gate, 3 - Customer has not been informed about order status change, 4 - An error occurred during attempt to change order status., 5 - No such status, 6 - If you want to merge orders, use the tool provided by IdoSell Shop, 10 - Balance of payments made by customer for this order does not equal its value. Organize status of payments and try to change order status again., 11 - You cannot fulfill the order, because products are not removed from the stock. Remove the products first., 13 - You cannot send order, because not all product have been transferred from supplier stock., 14 - Balance of payments made by customer for this order does not equal its value. Organize status of payments and try to change order status again., 15 - There are payments registered for this order. Sort status of payments and try again to change the status of order., There are not registered payments for this order. Organize status of payments and try changing order status again., 16 - Order can't be completed by supplier as not all products are from foreign stock, Order cannot be sent. Check reservations and stock quantities., 18 - Ccustomers VAT settings have not been approved yet. To change the status of order confirm settings or charge VAT., 19 - There are products in order bought within presale., 19 - Order cannot be sent. There are products in order bought within presale., 20 - Not all products have been moved to target stock., 21 - You cannot complete order, , 22 - You can't send orders as there are products in it for which serial numbers were not saved, 23 - Order cannot be sent. Not all products have been moved to target stock., 24 - There are sale documents issued to this order. Cancel issued documents and change status next., 25 - Not all of documents demanded by customer have been issued., 2214 - Order status cannot be changed, 26 - Order status cannot be changed. List of products causing problems, 27 - Change of a billing currency is possible only in case of open orders which have neither any issued invoices (or all invoices have the status "cancelled") nor declared or completed payments., 28 - Invalid currency, 29 - Wrong sale date format 32 - Invalid order calculation parameter 33 - Incorrect loyalty point value for a product 34 - Customer does not have enough loyalty points 36 - Incorrect VAT rate of the product */
5473
+ faultCode: number;
5474
+ /** @description Error description. */
5475
+ faultString: string;
5476
+ }[];
5477
+ /** @description Error code. List of error codes: 0 - Operation was successful, 1 - Not specified Id or serial number of the order, 2 - Order status entered in call parameters is not handled by the gate, 3 - Customer has not been informed about order status change, 4 - An error occurred during attempt to change order status., 5 - No such status, 6 - If you want to merge orders, use the tool provided by IdoSell Shop, 10 - Balance of payments made by customer for this order does not equal its value. Organize status of payments and try to change order status again., 11 - You cannot fulfill the order, because products are not removed from the stock. Remove the products first., 13 - You cannot send order, because not all product have been transferred from supplier stock., 14 - Balance of payments made by customer for this order does not equal its value. Organize status of payments and try to change order status again., 15 - There are payments registered for this order. Sort status of payments and try again to change the status of order., There are not registered payments for this order. Organize status of payments and try changing order status again., 16 - Order can't be completed by supplier as not all products are from foreign stock, Order cannot be sent. Check reservations and stock quantities., 18 - Ccustomers VAT settings have not been approved yet. To change the status of order confirm settings or charge VAT., 19 - There are products in order bought within presale., 19 - Order cannot be sent. There are products in order bought within presale., 20 - Not all products have been moved to target stock., 21 - You cannot complete order, , 22 - You can't send orders as there are products in it for which serial numbers were not saved, 23 - Order cannot be sent. Not all products have been moved to target stock., 24 - There are sale documents issued to this order. Cancel issued documents and change status next., 25 - Not all of documents demanded by customer have been issued., 2214 - Order status cannot be changed, 26 - Order status cannot be changed. List of products causing problems, 27 - Change of a billing currency is possible only in case of open orders which have neither any issued invoices (or all invoices have the status "cancelled") nor declared or completed payments., 28 - Invalid currency, 29 - Wrong sale date format 32 - Invalid order calculation parameter 33 - Incorrect loyalty point value for a product 34 - Customer does not have enough loyalty points 36 - Incorrect VAT rate of the product */
5478
+ faultCode: number;
5479
+ /** @description Error description. */
5480
+ faultString: string;
5481
+ }[];
5482
+ };
5483
+ };
5484
+
5485
+ export type PostCouriersPickupPointsResponse = {
5486
+ /** @description Parameters concerning returned results */
5487
+ result: {
5488
+ /** @description Collection point ID. */
5489
+ pickupPointId: number;
5490
+ /** @description external system code. */
5491
+ pickupPointExternalId: string;
5492
+ /** @description Courier ID. */
5493
+ courierId: number;
5494
+ /** @description Error code. */
5495
+ faultCode: number;
5496
+ /** @description Error description. */
5497
+ faultString: string;
5498
+ }[];
5499
+ };
5500
+
5501
+ export type PutCouriersPickupPointsResponse = {
5502
+ /** @description Parameters concerning returned results */
5503
+ result: {
5504
+ /** @description Collection point ID. */
5505
+ pickupPointId: number;
5506
+ /** @description external system code. */
5507
+ pickupPointExternalId: string;
5508
+ /** @description Courier ID. */
5509
+ courierId: number;
5510
+ /** @description Error code. */
5511
+ faultCode: number;
5512
+ /** @description Error description. */
5513
+ faultString: string;
5514
+ }[];
5515
+ };
5516
+
5517
+ export type PostPackagesLabelsResponse = {
5518
+ /** @description Id. */
5519
+ eventId: number;
5520
+ /** @description Type. */
5521
+ eventType: string;
5522
+ /** @description Information on consignments. */
5523
+ packages: {
5524
+ /** @description Parcel ID in the panel */
5525
+ id: string;
5526
+ /** @description Shipment number provided by the courier. Returned only if the courier supports tracking numbers */
5527
+ shippingNumber?: string;
5528
+ /** @description Number of the parcel in the shipmnet given by the courier. Returned only if the courier supports parcel numbers */
5529
+ packageNumber: string;
5530
+ }[];
5531
+ /** @description Package labels encoded in base64 */
5532
+ labels: {
5533
+ /** @description Parcel label encoded with base64 algorythm. */
5534
+ label: string;
5535
+ /** @description Label format */
5536
+ format: "PDF" | "A4" | "16x10" | "EPL" | "ZPL" | "SPL";
5537
+ };
5538
+ };
5539
+
5540
+ export type PostOrdersDocumentsCreateResponse = {
5541
+ documentsResults: {
5542
+ documentsData: {
5543
+ /** @description Document type */
5544
+ documentType: "vat_invoice" | "corrective_vat_invoice" | "advance_vat_invoice" | "final_advance_vat_invoice" | "pro_forma_invoice" | "advance_pro_forma_invoice" | "final_advance_pro_forma_invoice" | "fiscalInvoice" | "invoices" | "fiscal_receipt" | "sales_confirmation";
5545
+ /** @description Order serial number */
5546
+ orderSerialNumber: number;
5547
+ /** @example */
5548
+ id?: number;
5549
+ /** @example */
5550
+ documentNumber?: string;
5551
+ /** @example */
5552
+ documentData?: string;
5553
+ error: {
5554
+ /** @description Error code. */
5555
+ faultCode: number;
5556
+ /** @description Error description. */
5557
+ faultString: string;
5558
+ };
5559
+ }[];
5560
+ pdfBase64: string;
5561
+ };
5562
+ };
5563
+
5564
+ export type PostClientsResponse = {
5565
+ /** @description Customer data. */
5566
+ clients: {
5567
+ /** @description Information about newly created customer accounts. */
5568
+ status: boolean;
5569
+ /** @description Parameters transmitted to method */
5570
+ params: {
5571
+ /** @description Customer ID. */
5572
+ id: number;
5573
+ /** @description Customer's login. */
5574
+ login: string;
5575
+ /** @description Field used for identifying request-response pairs for the endpoint. */
5576
+ request_reference?: string;
5577
+ };
5578
+ /** @description Information on error that occurred during gate call. */
5579
+ errors?: FaultCodeString[];
5580
+ }[];
5581
+ };
5582
+
5583
+ export type PostReturnsResponse = {
5584
+ /** @example 1 */
5585
+ return_id: number;
5586
+ };
5587
+
5588
+ export type PostWmsStocksdocumentsDocumentsResponse = {
5589
+ /** @description Document identifier. */
5590
+ id: number;
5591
+ };
5592
+
5593
+ export type PostWmsStocksdocumentsProductsResponse = {
5594
+ errors?: FaultCodeString;
5595
+ } | [];
5596
+
5597
+ export type PostPaymentsResponse = {
5598
+ /** @description Parameters concerning returned results */
5599
+ result: {
5600
+ /** @description Transaction ID. */
5601
+ paymentId: string;
5602
+ };
5603
+ };
5604
+
5605
+ export type PutReturnsResponse = {
5606
+ errors?: FaultCodeString;
5607
+ /** @description Object contains detailed information on result of operation. */
5608
+ results: {
5609
+ /** @example 1 */
5610
+ id: number;
5611
+ errors: FaultCodeString;
5612
+ }[];
5613
+ };
5614
+
5615
+ export type PutRmaResponse = {
5616
+ /** @description Object contains detailed information on result of operation. */
5617
+ results: {
5618
+ rmasResults: {
5619
+ /** @description Complaint id. */
5620
+ rmaId: number;
5621
+ /** @description Error code. */
5622
+ faultCode: number;
5623
+ /** @description Error description. */
5624
+ faultString?: string;
5625
+ }[];
5626
+ };
5627
+ };
5628
+
5629
+ export type PutWmsStocksdocumentsProductsResponse = {
5630
+ errors?: FaultCodeString;
5631
+ } | [];
5632
+
5633
+ export type PostMenuResponse = {
5634
+ /** @description Parameters concerning returned results */
5635
+ result: {
5636
+ /** @description Shop Id. */
5637
+ shop_id: number;
5638
+ /** @description Menu ID. */
5639
+ menu_id: number;
5640
+ /** @description Menu element ID */
5641
+ item_id: number;
5642
+ /** @description Parent menu element ID. Example: "item1\item2\item3". */
5643
+ item_textid: string;
5644
+ /** @description Parent menu element ID */
5645
+ parent_id: number;
5646
+ /** @description Menu element text identifier. Example: "item1\item2\item3". */
5647
+ parent_textid: string | null;
5648
+ /** @description Error code. List of error codes: "0" - Operation was successful, "1" - Incorrect shop id, "2" - Incorrect language ID, "3" - Incorrect menu id, "4" - Element with indicated ID doesn't exist, "5" - Element name is empty, "6" - Element with the provided name already exists. */
5649
+ faultCode: number;
5650
+ /** @description Error description. */
5651
+ faultString: string;
5652
+ /** @description Error adding graphics. */
5653
+ faultGfx: {
5654
+ /** @description Graphic type. List of types: "gfx_nav" - Graphic on the "navigation" page, "gfx_active" - Graphic - When the cursor is on the link, "gfx_active_desktop" - Graphic - When the cursor is on the link - Desktop, "gfx_active_tablet" - Graphic - When the cursor is on the link - Tablet, "gfx_active_mobile" - Graphic - When the cursor is on the link - Mobile, "gfx" - Graphic - When the cursor is outside link, "gfx_inactive_desktop" - Graphic - When the cursor is outside link - Desktop, "gfx_inactive_tablet" - Graphic - When the cursor is outside link - Tablet, "gfx_inactive_mobile" - Graphic - When the cursor is outside link - Mobile, "gfx_onmouseover" - Graphic - When the link is opened, "gfx_omo_desktop" - Graphic - When the link is opened - Desktop, "gfx_omo_tablet" - Graphic - When the link is opened - Tablet, "gfx_omo_mobile" - Graphic - When the link is opened - Mobile. */
5655
+ type: string;
5656
+ /** @description Graphic error code. List of error codes: "101" - File is not a graphics format, "102" - File size too large, "103" - Graphic is too wide, "104" - Graphics is too narrow. */
5657
+ code: number;
5658
+ /** @description Graphic error description. */
5659
+ val: string;
5660
+ }[];
5661
+ }[];
5662
+ };
5663
+
5664
+ export type PutClientsDeliveryAddressResponse = {
5665
+ /** @description Object contains detailed information on result of operation. */
5666
+ results: {
5667
+ /** @description Information whether the operation was successful. */
5668
+ resultStatus: boolean;
5669
+ /** @description Object contains detailed information on performed operation. */
5670
+ clientDeliveryAddressResult: {
5671
+ /** @description Unique client's number. */
5672
+ clientId: number;
5673
+ /** @description Delivery address ID. */
5674
+ clientDeliveryAddressId: number;
5675
+ };
5676
+ /** @description Information on error that occurred during gate call. */
5677
+ errors?: FaultCodeString[];
5678
+ }[];
5679
+ };
5680
+
5681
+ export type PutProductsAttachmentsResponse = {
5682
+ /** @description Object contains detailed information on result of operation. */
5683
+ results: {
5684
+ /** @description Stock keeping unit. */
5685
+ productIdent: {
5686
+ /** @description ID value. */
5687
+ identValue: string | number;
5688
+ /** @description Identifier type. */
5689
+ productIdentType: "id" | "index" | "codeExtern" | "codeProducer";
5690
+ };
5691
+ /** @description Product attachments list. */
5692
+ attachments?: {
5693
+ /** @description Attachment file link. */
5694
+ attachmentUrl: string;
5695
+ /** @description Attachment name. */
5696
+ attachmentName: string;
5697
+ /** @description Language ID */
5698
+ langId: string;
5699
+ /** @description File type: audio, video, doc, other. */
5700
+ attachmentFileType: "audio" | "video" | "doc" | "other" | "image";
5701
+ /** @description Type of customer, attachment should be available for: 'all','ordered','wholesaler','wholesaler_or_ordered','wholesaler_and_ordered'. */
5702
+ attachmentEnable: "all" | "ordered" | "wholesaler" | "wholesaler_or_orderer" | "wholesaler_and_ordered";
5703
+ /** @description Attachment ID. */
5704
+ attachmentId?: number;
5705
+ /** @description Attachment downloads record. */
5706
+ attachmentDownloadLog: "y" | "n";
5707
+ /** @description Attachment file extension. */
5708
+ attachmentFileExtension?: string;
5709
+ /** @description Attachment number. */
5710
+ attachmentPriority?: number;
5711
+ /** @description Flag indicating if an attachment should be removed. */
5712
+ attachmentToDelete?: boolean;
5713
+ /** @description Attachment document types list. */
5714
+ documentTypes?: {
5715
+ /** @description Document type. */
5716
+ documentType?: "energy_label" | "instruction_with_safety_information" | "user_manual" | "installation_instructions" | "product_card" | "guide" | "others";
5717
+ /** @description Additional description. */
5718
+ description?: string;
5719
+ }[];
5720
+ /** @description Information on error that occurred during gate call. */
5721
+ errors?: FaultCodeString;
5722
+ }[];
5723
+ /** @description List of product's virtual attachments. */
5724
+ virtualAttachments?: {
5725
+ /** @description Attachment file link. */
5726
+ attachmentUrl: string;
5727
+ /** @description Attachment name. */
5728
+ attachmentName: {
5729
+ /** @description List of languages. */
5730
+ attachmentLanguages: {
5731
+ /** @description Language ID */
5732
+ langId: string;
5733
+ /** @description Language name */
5734
+ langName: string;
5735
+ /** @description Literal in selected language. */
5736
+ langValue: string;
5737
+ }[];
5738
+ };
5739
+ /** @description Full version or sample. */
5740
+ attachmentType: "full" | "demo";
5741
+ /** @description Number of attachment downloads limit. */
5742
+ attachmentLimits: {
5743
+ /** @description Number of downloads limit. */
5744
+ attachmentDownloadsLimit: number;
5745
+ /** @description Number of days file should be available. */
5746
+ attachmentDaysLimit: number;
5747
+ };
5748
+ /** @description Attachment ID. */
5749
+ attachmentId: number;
5750
+ /** @description Attachment number. */
5751
+ attachmentPriority: number;
5752
+ /** @description Flag indicating if an attachment should be removed. */
5753
+ attachmentToDelete: boolean;
5754
+ /** @description Information on error that occurred during gate call. */
5755
+ errors?: FaultCodeString;
5756
+ }[];
5757
+ /** @description Information on error that occurred during gate call. */
5758
+ errors?: FaultCodeString;
5759
+ /** @description Flag indicating if there are errors in results of attachments settings. */
5760
+ attachmentsErrorsOccurred?: boolean;
5761
+ /** @description Flag indicating if there are errors in results of virtual attachments settings. */
5762
+ virtualAttachmentsErrorsOccurred?: boolean;
5763
+ }[];
5764
+ /** @description Information about whether any errors occurred. */
5765
+ errorsOccurred: boolean;
5766
+ };
5767
+
5768
+ export type PutMenuResponse = {
5769
+ /** @description Parameters concerning returned results */
5770
+ result: {
5771
+ /** @description Shop Id. */
5772
+ shop_id: number;
5773
+ /** @description Menu ID. */
5774
+ menu_id: number;
5775
+ /** @description Menu element ID. */
5776
+ item_id: string;
5777
+ /** @description Menu element text identifier. Example: "item1\item2\item3". */
5778
+ item_textid: null | string;
5779
+ /** @description Error code. List of error codes: "0" - Operation was successful, "1" - Incorrect shop id, "2" - Incorrect language ID, "3" - Incorrect menu id, "4" - Element with indicated ID doesn't exist, "5" - Element name is empty, "6" - Element with the provided name already exists, "7" - Menu element ID or menu element text identifier is required. */
5780
+ faultCode: number;
5781
+ /** @description Error description. */
5782
+ faultString: string;
5783
+ /** @description Error adding graphics. */
5784
+ faultGfx: {
5785
+ /** @description Graphic type. List of types: "gfx_nav" - Graphic on the "navigation" page, "gfx_active" - Graphic - When the cursor is on the link, "gfx_active_desktop" - Graphic - When the cursor is on the link - Desktop, "gfx_active_tablet" - Graphic - When the cursor is on the link - Tablet, "gfx_active_mobile" - Graphic - When the cursor is on the link - Mobile, "gfx" - Graphic - When the cursor is outside link, "gfx_inactive_desktop" - Graphic - When the cursor is outside link - Desktop, "gfx_inactive_tablet" - Graphic - When the cursor is outside link - Tablet, "gfx_inactive_mobile" - Graphic - When the cursor is outside link - Mobile, "gfx_onmouseover" - Graphic - When the link is opened, "gfx_omo_desktop" - Graphic - When the link is opened - Desktop, "gfx_omo_tablet" - Graphic - When the link is opened - Tablet, "gfx_omo_mobile" - Graphic - When the link is opened - Mobile. */
5786
+ type: string;
5787
+ /** @description Graphic error code. List of error codes: "101" - File is not a graphics format, "102" - File size too large, "103" - Graphic is too wide, "104" - Graphics is too narrow. */
5788
+ code: number;
5789
+ /** @description Graphic error description. */
5790
+ val: string;
5791
+ }[];
5792
+ }[];
5793
+ };
5794
+
5795
+ export type PostPaymentsRepaymentResponse = {
5796
+ /** @description Parameters concerning returned results */
5797
+ result: {
5798
+ /** @description Payment ID. */
5799
+ payment_id: string;
5800
+ };
5801
+ };
5802
+
5803
+ export type PostResponsibilityEntitiesResponse = {
5804
+ /** @description Results */
5805
+ results: {
5806
+ /** @description Responsible entity code */
5807
+ code: string;
5808
+ /** @description Errors */
5809
+ errors: ((({
5810
+ /** @description Error code. */
5811
+ code: string;
5812
+ /** @description Field associated with the error. */
5813
+ field: string | null;
5814
+ /** @description Error description. */
5815
+ message: string | null;
5816
+ /** @description Value associated with the error. */
5817
+ value: string | null;
5818
+ /** @description Unique identifier of the error (for support). */
5819
+ uid: string | null;
5820
+ } & {
5821
+ errorCode: string;
5822
+ }) & {
5823
+ /** @description Possible values: - unexpected_error - invalid_language_code - invalid_language_for_shop - invalid_shop - invalid_date_range - invalid_number_range - collection_is_empty - collection_limit_exceeded - invalid_parameter_for_post_method - invalid_parameter_for_put_method - no_data - connection_error
5824
+ * */
5825
+ errorCode: string;
5826
+ }) | {
5827
+ code: string;
5828
+ })[];
5829
+ }[];
5830
+ };
5831
+
5832
+ export type PutProductsCategoriesResponse = {
5833
+ /** @description Parameters concerning returned results */
5834
+ result: {
5835
+ /** @description List of categories in which sought products are present. */
5836
+ categories: {
5837
+ /** @description Category id. */
5838
+ id: number;
5839
+ /** @description Parent category ID. */
5840
+ parent_id?: number;
5841
+ /** @description Priority. */
5842
+ priority?: number;
5843
+ /** @description Operation code. */
5844
+ operation?: string;
5845
+ /** @description Error code. Error description: "0" - Operation was successful, "1" - Login failure: invalid username or key, "4" - Shop has been blocked due to number of overdue invoices owed to IAI Company */
5846
+ faultCode: number;
5847
+ /** @description Error description. */
5848
+ faultString: string;
5849
+ }[];
5850
+ };
5851
+ };
5852
+
4911
5853
  export { };