idosell 0.4.4 → 0.4.11

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.
@@ -2139,6 +2139,8 @@ export type PostCouriersPickupPointsParams = {
2139
2139
  city?: string;
2140
2140
  /** @description Administrative region (code in ISO 3166-2). */
2141
2141
  provinceCode?: string;
2142
+ /** @description Country code (ISO 3166-1 alpha-2). */
2143
+ countryCode?: string;
2142
2144
  };
2143
2145
  /** @description Geographic coordinates. */
2144
2146
  coordinates: {
@@ -3867,4 +3869,3273 @@ export type SearchClientsNewsletterSmsParams = {
3867
3869
  results_limit?: number;
3868
3870
  };
3869
3871
 
3872
+ export type PutWmsSuppliersParams = {
3873
+ suppliers: {
3874
+ /** @description Id */
3875
+ id?: number;
3876
+ /** @description Name. */
3877
+ name: string;
3878
+ /** @description e-mail address. (limit of 50 characters) */
3879
+ email?: string;
3880
+ /** @description Phone number. (limit of 20 characters) */
3881
+ phone?: string;
3882
+ /** @description Fax. (limit of 20 characters) */
3883
+ fax?: string;
3884
+ /** @description Address. (limit of 50 characters) */
3885
+ street?: string;
3886
+ /** @description ZIP / Post code. (limit of 6 characters) */
3887
+ zipCode?: string;
3888
+ /** @description Town / City. (limit of 50 characters) */
3889
+ city?: string;
3890
+ /** @description Region ID */
3891
+ country?: number;
3892
+ /** @description VAT no.. (limit of 13 characters) */
3893
+ taxCode?: string;
3894
+ /** @description Average delivery time */
3895
+ averageDeliveryTime?: {
3896
+ /** @description value */
3897
+ value?: number;
3898
+ /** @description Unit */
3899
+ unit?: "minutes" | "hours" | "days" | "immediately";
3900
+ };
3901
+ /** @description Description. (limit of 255 characters) */
3902
+ description?: string;
3903
+ /** @description Order preparation time for shipment */
3904
+ orderCompletionTime?: {
3905
+ /** @description value */
3906
+ value?: number;
3907
+ /** @description Unit */
3908
+ unit?: "minutes" | "hours" | "days" | "immediately";
3909
+ };
3910
+ /** @description Supplier working hours */
3911
+ workDays?: {
3912
+ /** @description day */
3913
+ day?: number;
3914
+ /** */
3915
+ type?: "deliverer_closed" | "deliverer_open_hours" | "deliverer_open_24h";
3916
+ /** @description from */
3917
+ from?: string;
3918
+ /** @description to */
3919
+ to?: string;
3920
+ }[];
3921
+ }[];
3922
+ };
3923
+
3924
+ export type PutWarrantiesParams = {
3925
+ warranties: {
3926
+ /** @description Warranty ID (numeric or text based). */
3927
+ id: string;
3928
+ /** @description Name. */
3929
+ name?: string;
3930
+ /** */
3931
+ type?: "seller" | "producer";
3932
+ /** @description Warranty time. Default value 12. */
3933
+ period?: number;
3934
+ }[];
3935
+ };
3936
+
3937
+ export type PutSystemUnitsParams = {
3938
+ units: {
3939
+ /** @description #!IdentyfikatorJednostki!# */
3940
+ id: number;
3941
+ /** @description Name in panel (limit of 30 characters) */
3942
+ nameInPanel?: string;
3943
+ /** @description Accuracy (number of places after comma) */
3944
+ precisionUnit?: number;
3945
+ /** @description Visibility */
3946
+ visible?: boolean;
3947
+ /** @description Unit names */
3948
+ descriptions?: {
3949
+ /** @description ISO-639-3 Language */
3950
+ language?: string;
3951
+ /** @description Name (singular) (limit of 30 characters) */
3952
+ nameSingular?: string;
3953
+ /** @description Name (plural) (limit of 30 characters) */
3954
+ namePlural?: string;
3955
+ /** @description Name (by fractions) (limit of 30 characters) */
3956
+ nameFractions?: string;
3957
+ }[];
3958
+ }[];
3959
+ };
3960
+
3961
+ export type PutSizesParams = {
3962
+ /** @description Size table. */
3963
+ sizes: {
3964
+ /** @description Error code. */
3965
+ faultCode?: number;
3966
+ /** @description Error description. */
3967
+ faultString?: string;
3968
+ /** @description Size group ID. */
3969
+ group_id?: number;
3970
+ /** @description Size identifier. */
3971
+ id?: string;
3972
+ /** @description Category plural name. */
3973
+ name?: string;
3974
+ /** @description Size description. */
3975
+ description?: string;
3976
+ /** @description Operation type: add, edit, del */
3977
+ operation: string;
3978
+ lang_data?: {
3979
+ /** @description Language code. Codes are compliant with ISO-639-3 standard. */
3980
+ lang_id?: string;
3981
+ /** @description Category plural name. */
3982
+ name?: string;
3983
+ }[];
3984
+ }[];
3985
+ };
3986
+
3987
+ export type PutSizechartsParams = {
3988
+ sizeCharts: {
3989
+ /** @description Id */
3990
+ id: number;
3991
+ /** @description Name in panel */
3992
+ nameInPanel?: string;
3993
+ /** @description Display mode */
3994
+ displayMode: "single" | "all";
3995
+ languagesData?: {
3996
+ /** @description Customer language ID. */
3997
+ language?: string;
3998
+ columns?: {
3999
+ /** @description Column number */
4000
+ columnNumber?: number;
4001
+ /** @description Column name */
4002
+ columnTitle?: string;
4003
+ }[];
4004
+ /** @description List of sizes */
4005
+ sizes?: {
4006
+ /** @description Size identifier */
4007
+ sizeId?: string;
4008
+ /** @description Priority */
4009
+ priority?: number;
4010
+ descriptions?: {
4011
+ /** @description Column number */
4012
+ columnNumber?: number;
4013
+ /** @description Value */
4014
+ value?: string;
4015
+ }[];
4016
+ }[];
4017
+ }[];
4018
+ }[];
4019
+ };
4020
+
4021
+ export type PutProductsParametersParams = {
4022
+ /** @description Sections, parameters or valued to add or edit. */
4023
+ items: {
4024
+ /** @description Parameter ID. */
4025
+ id: number;
4026
+ /** @description Element text ID - can be entered instead of "id". Recognized save format: "section" (without backslash), "parameter\" (parameter without assigned value). */
4027
+ item_text_ids?: {
4028
+ /** @description Language ID. */
4029
+ lang_id?: string;
4030
+ /** @description Text value. */
4031
+ value?: string;
4032
+ }[];
4033
+ /** @description Names of section, parameter or value. */
4034
+ names?: {
4035
+ /** @description Language ID. */
4036
+ lang_id?: string;
4037
+ /** @description Text value. */
4038
+ value?: string;
4039
+ }[];
4040
+ /** @description Descriptions of section, parameter or value. */
4041
+ descriptions?: {
4042
+ /** @description Language ID. */
4043
+ lang_id?: string;
4044
+ /** @description Text value. */
4045
+ value?: string;
4046
+ }[];
4047
+ /** @description Search descriptions of parameter value. */
4048
+ search_description?: {
4049
+ /** @description Language ID */
4050
+ lang_id?: string;
4051
+ /** @description Text value */
4052
+ value?: string;
4053
+ /** @description Shop Id */
4054
+ shop_id?: number;
4055
+ }[];
4056
+ /** @description Icons of section, parameter or value to display on the product card. */
4057
+ card_icons?: {
4058
+ /** @description Language ID. */
4059
+ lang_id?: string;
4060
+ /** @description Text value. */
4061
+ value?: string;
4062
+ /** @description Shop Id */
4063
+ shop_id?: number;
4064
+ }[];
4065
+ /** @description Icons of section, parameter or value to display on the list of products. */
4066
+ link_icons?: {
4067
+ /** @description Language ID. */
4068
+ lang_id?: string;
4069
+ /** @description Text value. */
4070
+ value?: string;
4071
+ /** @description Shop Id */
4072
+ shop_id?: number;
4073
+ }[];
4074
+ /** @description Parameter's additional feature. 1. Status: context_id = "CONTEXT_STATE" Takes values context_value_id: - CONTEXT_STATE_NEW - New, - CONTEXT_STATE_USED - Used, - CONTEXT_STATE_USED_EXCELLENT - Used - excellent condition - CONTEXT_STATE_USED_VERYGOOD - Used - very good condition - CONTEXT_STATE_USED_CORRECT - Used - good condition - CONTEXT_STATE_USED_ACCEPTABLE - Used - acceptable condition - CONTEXT_STATE_REFURBISHED_EXCELLENT - Refurbished - excellent condition - CONTEXT_STATE_REFURBISHED_VERYGOOD - Refurbished - very good condition - CONTEXT_STATE_REFURBISHED_CORRECT - Refurbished - good condition - CONTEXT_STATE_NEW_OTHERS - New other (see details) - CONTEXT_STATE_NEW_WITH_DEFECTS - New with defects - CONTEXT_STATE_NEW_OEM - New - OEM - CONTEXT_STATE_NEW_OPEN_BOX - New - open box - CONTEXT_STATE_REFURBISHED_BY_PRODUCER - Renewed by a manufacturer, - CONTEXT_STATE_REFURBISHED_BY_SELLER - Renewed by a seller, - CONTEXT_STATE_FOR_PARTS_OR_BROKEN - In parts or damaged. 2. Product weight in grams: context_id = "CONTEXT_STD_UNIT_WEIGHT" Takes values context_value_id: - Value of additional feature is set automatically basing on the parameter's value. 3. A product's value in milliliters: context_id = "CONTEXT_STD_UNIT_VOLUME" Takes values context_value_id: - Value of additional feature is set automatically basing on the parameter's value. 4. Sex: context_id = "CONTEXT_SEX" Takes values context_value_id: - CONTEXT_SEX_MAN - Man, - CONTEXT_SEX_WOMAN - Woman, - CONTEXT_SEX_UNISEX - Unisex. 5. Age group: context_id = "CONTEXT_AGE_GROUP" Takes values context_value_id: - CONTEXT_AGE_GROUP_ADULT - Adults, - CONTEXT_AGE_GROUP_MINOR - Children. 6. Maximum number of products in an order: context_id = "CONTEXT_MAX_QUANTITY_PER_RETAIL_ORDER" Takes values context_value_id: - Value of additional feature is set automatically basing on the parameter's value. 7. Maximum number of products in a wholesale order: context_id = "CONTEXT_MAX_QUANTITY_PER_WHOLESALE_ORDER" Takes values context_value_id: - Value of additional feature is set automatically basing on the parameter's value. 8. Minimal number of products in an order: context_id = "CONTEXT_MIN_QUANTITY_PER_RETAIL_ORDER" Takes values context_value_id: - Value of additional feature is set automatically basing on the parameter's value. 9. Minimum number of products in a wholesale order: context_id = "CONTEXT_MIN_QUANTITY_PER_WHOLESALE_ORDER" Takes values context_value_id: - Value of additional feature is set automatically basing on the parameter's value. 10. Maximal number of a single size in an order: context_id = "CONTEXT_MAX_SIZE_QUANTITY_PER_RETAIL_ORDER" Takes values context_value_id: - Value of additional feature is set automatically basing on the parameter's value. 11. Maximal number of a single size in a wholesale order: context_id = "CONTEXT_MAX_SIZE_QUANTITY_PER_WHOLESALE_ORDER" Takes values context_value_id: - Value of additional feature is set automatically basing on the parameter's value. 12. Minimal number of a single size in an order: context_id = "CONTEXT_MIN_SIZE_QUANTITY_PER_RETAIL_ORDER" Takes values context_value_id: - Value of additional feature is set automatically basing on the parameter's value. 13. Minimal number of a single size in a wholesale order: context_id = "CONTEXT_MIN_SIZE_QUANTITY_PER_WHOLESALE_ORDER" Takes values context_value_id: - Value of additional feature is set automatically basing on the parameter's value. 14. Net weight: context_id = "CONTEXT_WEIGHT_NET" Takes values context_value_id: - Value of additional feature is set automatically basing on the parameter's value. 15. Color: context_id = "CONTEXT_COLOR" Takes values context_value_id: - Value of additional feature is set automatically basing on the parameter's value. 16. #!TylkoDlaDoroslych!#: context_id = "CONTEXT_ONLY_ADULTS" Takes values context_value_id: - CONTEXT_ONLY_ADULTS_YES - yes, - CONTEXT_ONLY_ADULTS_NO - no. 17. Prescription drug: context_id = "CONTEXT_PRESCRIPTION_MEDICINE" Takes values context_value_id: - CONTEXT_PRESCRIPTION_MEDICINE_YES - yes, - CONTEXT_PRESCRIPTION_MEDICINE_NO - no. 18. Season Rate: context_id = "CONTEXT_SEASON" Takes values context_value_id: - CONTEXT_SEASON_SPRING - Spring, - CONTEXT_SEASON_SUMMER - Summer, - CONTEXT_SEASON_FALL - Autumn, - CONTEXT_SEASON_WINTER - Winter, - CONTEXT_SEASON_SPRING_SUMMER - Spring/Summer, - CONTEXT_SEASON_FALL_WINTER - Autumn/Winter 19. Risk - signal word: context_id = \"CONTEXT_HAZMAT_SIGNAL\" Takes values context_value_id: - CONTEXT_HAZMAT_SIGNAL_DANGER - danger, - CONTEXT_HAZMAT_SIGNAL_WARNING - warnging, - CONTEXT_HAZMAT_SIGNAL_CAUTION - caution, - CONTEXT_HAZMAT_SIGNAL_NOTICE - notice, 20. Risk - warning pictogram context_id = \"CONTEXT_HAZMAT_PICTOGRAM\" Takes values context_value_id: - GHS01, GHS02, GHS03, GHS04, GHS05, GHS06, GHS07, GHS08, GHS09 21. Risk - type of hazard: context_id = \"CONTEXT_HAZMAT_STATEMENT\" Takes values context_value_id: - H200, H201, H202, H203, H204, H205, H220, H221, H222, H223, H224, H225, H226, H228, H240, H241, H242, H250, H251, H252, H260, H261, H270, H271, H272, H280, H281, H290, H300, H301, H302, H304, H310, H311, H312, H314, H315, H317, H318, H319, H330, H331, H332, H334, H335, H336, H340, H341, H350, H351, H360, H361, H362, H370, H371, H372, H373, H400, H410, H411, H412, H413, EUH 001, EUH 014, EUH 018, EUH 019, EUH 044, EUH 029, EUH 031, EUH 032, EUH 066, EUH 070, EUH 071, EUH 201, EUH 201A, EUH 202, EUH 203, EUH 204, EUH 205, EUH 206, EUH 207, EUH 208, EUH 209, EUH 209A, EUH 210, EUH 401 22. Repair score: context_id = \"CONTEXT_REPAIR_SCORE\" Takes values context_value_id: - The value of the additional feature is set automatically based on the parameter's value 23. Safety - information pictogram: context_id = \"CONTEXT_SAFETY_PICTOGRAM\" Takes values context_value_id: - 1 (Not suitable for small children) - 2 (CE mark) 24. Safety - type of warning: context_id = \"CONTEXT_SAFETY_STATEMENT\" Takes values context_value_id: - 1 (Not suitable for children under 3 years) - 2 (Keep out of the reach of children) - 3 (Product contains a button cell or coin battery) - 4 (Use under the direct supervision of adults) - 5 (Required protective gear. Do not use in public traffic) - 6 (Contains toy. Adult supervision recommended) - 7 (To prevent possible injury from entanglement, remove this toy as soon as the child begins to crawl) - 8 (Use only in shallow water under adult supervision) - 9 (Only use under adult supervision) - 10 (This toy does not provide protection) - 11 (Contains fragrances that may cause allergies) - 12 (For household use only). */
4075
+ context_id?: string;
4076
+ /** @description value of additional feature - Values described in context_id. */
4077
+ context_value_id?: string;
4078
+ }[];
4079
+ /** @description Settings */
4080
+ settings?: {
4081
+ /** */
4082
+ icons_input_type?: "base64" | "url";
4083
+ };
4084
+ };
4085
+
4086
+ export type PutPaymentsParams = {
4087
+ /** @description Defines payment category. For the payments regarding returns, enter 'return'. */
4088
+ sourceType: "order" | "return" | "rma";
4089
+ /** @description Payment number - [order no.]-[payment no.], i.e. 1234-1. */
4090
+ paymentNumber: string;
4091
+ /** @description Payment method ID. Check getPaymentForms. */
4092
+ paymentFormId?: number;
4093
+ /** @description Refund value. */
4094
+ value: number;
4095
+ /** @description Registering date. */
4096
+ accountingDate?: string;
4097
+ /** @description Number of a bank account to which a payment is sent. */
4098
+ account?: string;
4099
+ /** @description Data of customer account in store. */
4100
+ clientAccount?: string;
4101
+ other?: {
4102
+ /** @description Payment system. */
4103
+ system?: number;
4104
+ };
4105
+ /** @description Transaction ID in external service */
4106
+ externalPaymentId?: string;
4107
+ };
4108
+
4109
+ export type PostWarrantiesParams = {
4110
+ warranties: {
4111
+ /** @description Name. */
4112
+ name: string;
4113
+ /** */
4114
+ type?: "seller" | "producer";
4115
+ /** @description Warranty time. Default value 12. */
4116
+ period?: number;
4117
+ /** @description Name of warranty. */
4118
+ shopname?: {
4119
+ languages?: {
4120
+ /** @description Language ID. */
4121
+ language_id?: string;
4122
+ /** @description Language name. */
4123
+ language_name?: string;
4124
+ /** @description Literal in selected language. */
4125
+ value?: string;
4126
+ }[];
4127
+ };
4128
+ /** @description Warranty description. */
4129
+ description?: {
4130
+ languages?: {
4131
+ /** @description Language ID. */
4132
+ language_id?: string;
4133
+ /** @description Language name. */
4134
+ language_name?: string;
4135
+ /** @description Literal in selected language. */
4136
+ value?: string;
4137
+ }[];
4138
+ };
4139
+ }[];
4140
+ };
4141
+
4142
+ export type PostVouchersParams = {
4143
+ /** @description List of vouchers to add */
4144
+ vouchers: {
4145
+ /** @description Gift voucher type id */
4146
+ typeId: number;
4147
+ /** @description Number. */
4148
+ number: string;
4149
+ /** @description Name. */
4150
+ name: string;
4151
+ /** @description Voucher expiration date */
4152
+ expirationDate?: string;
4153
+ /** @description Voucher balance */
4154
+ balance: {
4155
+ /** @description Available balance */
4156
+ amount?: number;
4157
+ /** @description Currency. */
4158
+ currency?: string;
4159
+ };
4160
+ /** @description List of shops the voucher is active in */
4161
+ shops: number[];
4162
+ /** @example note */
4163
+ note?: string;
4164
+ }[];
4165
+ };
4166
+
4167
+ export type PostEntriesParams = {
4168
+ /** @description Shop Id */
4169
+ shopId: number;
4170
+ /** @description Date of creating an entry */
4171
+ date: string;
4172
+ /** @description Entry visibility */
4173
+ visible: "y" | "n";
4174
+ /** @description List of pages on which the entry is to be published */
4175
+ visibleOnSitesList: {
4176
+ /** @description Site ID */
4177
+ siteId?: string;
4178
+ }[];
4179
+ /** @description Products list. */
4180
+ products?: {
4181
+ /** @description Merchandise identifier */
4182
+ productId?: number;
4183
+ }[];
4184
+ /** @description Photo */
4185
+ pictureData?: {
4186
+ /** @description Photo encoded with Base64 */
4187
+ pictureBase64?: string;
4188
+ /** @description Photo format */
4189
+ pictureFormat?: "jpg" | "jpeg" | "png" | "gif";
4190
+ };
4191
+ /** @description Element including entry content in selected languages */
4192
+ langs: {
4193
+ /** @description Language ID */
4194
+ langId: string;
4195
+ /** @description Name on the page */
4196
+ title?: string;
4197
+ /** @description short description */
4198
+ shortDescription?: string;
4199
+ /** @description Long description */
4200
+ longDescription?: string;
4201
+ /** @description Blog post URL */
4202
+ blogUrl?: string;
4203
+ /** @description News item URL */
4204
+ newsUrl?: string;
4205
+ }[];
4206
+ /** @description Type of title and shortcut linking: fullContentLink - link to the subpage with full content, givenUrlLink - link to the given URL, noLink - static element */
4207
+ titleLinkType?: "fullContentLink" | "givenUrlLink" | "noLink";
4208
+ /** @description Provided URL (for link to specified URL option) */
4209
+ link?: string;
4210
+ };
4211
+
4212
+ export type PostClientsPayerAddressParams = {
4213
+ payers: {
4214
+ /** @description Unique client's number. */
4215
+ clientId: number;
4216
+ /** @description Buyer's first name. */
4217
+ payerAddressFirstName?: string;
4218
+ /** @description Buyer's last name. */
4219
+ payerAddressLastName?: string;
4220
+ /** @description Company name. */
4221
+ payerAddressFirm?: string;
4222
+ /** @description Customer VAT ID. */
4223
+ payerAddressNip?: string;
4224
+ /** @description Buyer's street name and house number. */
4225
+ payerAddressStreet: string;
4226
+ /** @description Buyer's postal code. */
4227
+ payerAddressZipCode: string;
4228
+ /** @description Buyer's city. */
4229
+ payerAddressCity: string;
4230
+ /** @description Country code in the ISO 3166-1 A2 standard. */
4231
+ payerAddressCountryId: string;
4232
+ /** @description Buyer's telephone number. */
4233
+ payerAddressPhone?: string;
4234
+ }[];
4235
+ };
4236
+
4237
+ export type PostClientsDeliveryAddressParams = {
4238
+ /** @description Customer data. */
4239
+ clients: {
4240
+ /** @description Customer's login. */
4241
+ clientLogin: string;
4242
+ /** @description External system code. */
4243
+ clientCodeExternal?: string;
4244
+ /** @description List of stores IDs When mask is determined, this parameter is omitted. */
4245
+ shopsIds: number[];
4246
+ /** @description Currency ID */
4247
+ currencyId?: string;
4248
+ /** @description Recipient's first name. */
4249
+ clientDeliveryAddressFirstName: string;
4250
+ /** @description Recipient's last name. */
4251
+ clientDeliveryAddressLastName: string;
4252
+ /** @description Additional information. */
4253
+ clientDeliveryAddressAdditional?: string;
4254
+ /** @description Cell phone. */
4255
+ clientDeliveryAddressPhone1?: string;
4256
+ /** @description Recipient's city. */
4257
+ clientDeliveryAddressCity: string;
4258
+ /** @description Recipient street and number. */
4259
+ clientDeliveryAddressStreet: string;
4260
+ /** @description Administrative region code. */
4261
+ clientDeliveryAddressRegionId?: string;
4262
+ /** @description Administrative region code. */
4263
+ clientDeliveryAddressProvinceId?: string;
4264
+ /** @description Recipient's postal code. */
4265
+ clientDeliveryAddressZipCode: string;
4266
+ /** @description Recipient's country. */
4267
+ clientDeliveryAddressCountry?: string;
4268
+ }[];
4269
+ };
4270
+
4271
+ export type PostSnippetsParams = {
4272
+ snippets: ({
4273
+ /** @description Id of the code snippet. */
4274
+ id?: number | null;
4275
+ /** @description The snippet name. */
4276
+ name: string;
4277
+ /** @description Whether the snippet is active. */
4278
+ active?: "y" | "n";
4279
+ /** @description Snippet campaign id */
4280
+ campaign: number;
4281
+ dateBegin?: {
4282
+ /** @description Whether date condition is active */
4283
+ defined?: "y" | "n";
4284
+ /** Format: date
4285
+ * @description Date of snippet activation */
4286
+ date?: string | null;
4287
+ } & {
4288
+ /** @description Automatic shutdown control */
4289
+ autoBlock?: "y" | "n";
4290
+ };
4291
+ /** @description Filter to control snippet activation. */
4292
+ dateEnd?: {
4293
+ /** @description Whether date condition is active */
4294
+ defined?: "y" | "n";
4295
+ /** Format: date
4296
+ * @description Date of snippet activation */
4297
+ date?: string | null;
4298
+ };
4299
+ /** @description Code snippet type. */
4300
+ type?: "html" | "javascript" | "cgi";
4301
+ /** @description Whether to load contents asynchronously via XHR request. */
4302
+ useAjax?: "y" | "n";
4303
+ /** @description Url. */
4304
+ link?: string;
4305
+ /** @description Content waiting time (timeout) in seconds. */
4306
+ timeout?: number;
4307
+ /** @description The place where the code snippet is loaded. */
4308
+ zone?: "head" | "bodyBegin" | "bodyEnd";
4309
+ /** @description The order in which the code snippet will be displayed. */
4310
+ order?: number;
4311
+ /** @description Snippet content for each language. */
4312
+ body?: {
4313
+ /** @description Language code. */
4314
+ lang?: string;
4315
+ /** @example Hello world */
4316
+ body?: string;
4317
+ }[];
4318
+ display?: {
4319
+ /** @description Type of customers to whom to display the snippet */
4320
+ clientType?: "all" | "unregistered" | "registered" | "retailer" | "wholesaler";
4321
+ /** @description Whether to display only for newsletter visitors. */
4322
+ newsletter?: "y" | "n" | "all";
4323
+ /** @description Whether to display the code snippet only for customers who have placed an order */
4324
+ hasOrders?: "y" | "n" | "all";
4325
+ /** @description Display only after entering rebate code */
4326
+ useRebateCode?: "y" | "n" | "all";
4327
+ } & {
4328
+ /** @description Display on desktop screens */
4329
+ screen?: "y" | "n";
4330
+ /** @description Display on mobile tablets */
4331
+ tablet?: "y" | "n";
4332
+ /** @description Display on mobile phones */
4333
+ phone?: "y" | "n";
4334
+ };
4335
+ pages?: {
4336
+ /** @description Whether to display to all sites. */
4337
+ all?: "y" | "n";
4338
+ /** @description List of selected pages where snippet shows (works for all=n mode). If passed, the url should be omitted. */
4339
+ pages?: ("home" | "basket" | "checkout_payment_delivery" | "checkout_confirmation" | "new_order_placement" | "order_details" | "navigation" | "product_details" | "search_results" | "after_order_place" | "mailing_subscribe" | "payment_success" | "payment_error" | "payment_pending" | "other_pages")[];
4340
+ /** @description List of selected url (works for all=n mode) If passed, pages should be omitted. */
4341
+ url?: string[];
4342
+ };
4343
+ /** @description Snippet entry source filter. */
4344
+ sources?: {
4345
+ direct?: {
4346
+ /** @description Whether source filter is active */
4347
+ active?: "y" | "n";
4348
+ /** @description Id of service of given source */
4349
+ id?: number | null;
4350
+ } | null;
4351
+ search?: {
4352
+ /** @description Whether source filter is active */
4353
+ active?: "y" | "n";
4354
+ /** @description Id of service of given source */
4355
+ id?: number | null;
4356
+ } | null;
4357
+ advert?: {
4358
+ /** @description Whether source filter is active */
4359
+ active?: "y" | "n";
4360
+ /** @description Id of service of given source */
4361
+ id?: number | null;
4362
+ } | null;
4363
+ priceComparers?: {
4364
+ /** @description Whether source filter is active */
4365
+ active?: "y" | "n";
4366
+ /** @description Id of service of given source */
4367
+ id?: number | null;
4368
+ } | null;
4369
+ affiliate?: {
4370
+ /** @description Whether source filter is active */
4371
+ active?: "y" | "n";
4372
+ /** @description Id of service of given source */
4373
+ id?: number | null;
4374
+ } | null;
4375
+ cpa?: {
4376
+ /** @description Whether source filter is active */
4377
+ active?: "y" | "n";
4378
+ /** @description Id of service of given source */
4379
+ id?: number | null;
4380
+ } | null;
4381
+ newsletter?: {
4382
+ /** @description Whether source filter is active */
4383
+ active?: "y" | "n";
4384
+ /** @description Id of service of given source */
4385
+ id?: number | null;
4386
+ } | null;
4387
+ social?: {
4388
+ /** @description Whether source filter is active */
4389
+ active?: "y" | "n";
4390
+ /** @description Id of service of given source */
4391
+ id?: number | null;
4392
+ } | null;
4393
+ page?: {
4394
+ /** @description Whether source filter is active */
4395
+ active?: "y" | "n";
4396
+ /** @description Id of service of given source */
4397
+ id?: number | null;
4398
+ } | null;
4399
+ };
4400
+ /** @description Whether the snippet is marked as deleted. */
4401
+ readonly deleted?: "y" | "n";
4402
+ /** @description The number of cookies associated with the snippet. */
4403
+ readonly cookiesCount?: number;
4404
+ } & {
4405
+ /** @example null */
4406
+ id?: number | null;
4407
+ })[];
4408
+ };
4409
+
4410
+ export type PostSnippetsCampaignParams = {
4411
+ campaigns: ({
4412
+ /** @description Snippet campaign id */
4413
+ id?: number | null;
4414
+ /** @description Snippet campaign name */
4415
+ name: string;
4416
+ /** @description Snippet campaign internal description */
4417
+ description?: string;
4418
+ /** @description Shop ids where code snippets are active 1 ] */
4419
+ shop: number[] | null;
4420
+ /** @description Whether the snippet is active */
4421
+ active?: "y" | "n";
4422
+ /** @description Whether the snippet campaign is deleted */
4423
+ readonly deleted?: "y" | "n";
4424
+ /** @description Snippet order. */
4425
+ order?: number;
4426
+ /** @description Number of code snippets associated with the campaign. */
4427
+ readonly snippetCount?: number | null;
4428
+ /** @description Number of active code snippets associated with the campaign. */
4429
+ readonly activeSnippetCount?: number | null;
4430
+ configVariables?: {
4431
+ /** @description Key of config value. */
4432
+ key?: string;
4433
+ /** @description Name of config item. */
4434
+ readonly name: string;
4435
+ /** @description Value of config item. */
4436
+ value?: string;
4437
+ }[];
4438
+ } & {
4439
+ /** @example null */
4440
+ id?: number | null;
4441
+ })[];
4442
+ };
4443
+
4444
+ export type PostSnippetsCookiesParams = {
4445
+ cookies: ({
4446
+ /** @description Snippet */
4447
+ id?: number | null;
4448
+ /** @description Id of the snippet code. */
4449
+ snippetId: number;
4450
+ /** @description Name of the cookie vendor. */
4451
+ deliverer: string;
4452
+ /** @description Category of the cookie */
4453
+ category?: "analytics" | "marketing" | "functional";
4454
+ /** @description Cookie description for each language. */
4455
+ description?: {
4456
+ /** @description Language code. */
4457
+ lang?: string;
4458
+ /** @example Hello world */
4459
+ body?: string;
4460
+ }[];
4461
+ /** @description Name of the cookie. */
4462
+ name?: string | null;
4463
+ /** @description Type of the cookie|null} */
4464
+ type?: "cookie" | "pixel" | "localStorage" | null;
4465
+ /** @description Cookie lifetime mode|null} */
4466
+ lifeTimeType?: "temporary" | "days" | "minutes" | null;
4467
+ /** @description Cookie lifetime */
4468
+ lifeTime?: number | null;
4469
+ } & {
4470
+ /** @example null */
4471
+ id?: number | null;
4472
+ })[];
4473
+ };
4474
+
4475
+ export type PostCpaParams = {
4476
+ cpa: ({
4477
+ /** @description Id of the CPA program. */
4478
+ id?: number | null;
4479
+ /** @description The CPA program name. */
4480
+ name: string;
4481
+ /** @description Whether the CPA program is active. */
4482
+ active?: "y" | "n";
4483
+ /** @description CPA campaign id */
4484
+ campaign: number;
4485
+ /** @description CPA program page settings simple or advanced, depending on the mode. */
4486
+ pageSettings?: (Omit<{
4487
+ /** @description Whether to display to all sites. */
4488
+ mode: "simple" | "advanced";
4489
+ }, "mode"> & {
4490
+ /** @description Whether to display to all sites. */
4491
+ mode?: "simple";
4492
+ /** @description The place where the cpa code is loaded. (For "all" mode)|null} */
4493
+ zone?: "head" | "bodyBegin" | "bodyEnd" | null;
4494
+ /** @description Snippet content for each language. (For "all" mode) */
4495
+ body?: {
4496
+ /** @description Language code. */
4497
+ lang?: string;
4498
+ /** @example Hello world */
4499
+ body?: string;
4500
+ }[] | null;
4501
+ }) | (Omit<{
4502
+ /** @description Whether to display to all sites. */
4503
+ mode: "simple" | "advanced";
4504
+ }, "mode"> & {
4505
+ /** @description Whether to display to all sites. */
4506
+ mode?: "advanced";
4507
+ /** @description Page setting for advance mode */
4508
+ pages?: {
4509
+ /** @enum {string} */
4510
+ active?: "y" | "n";
4511
+ /** @enum {string} */
4512
+ 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";
4513
+ /** @description The place where the cpa code is loaded. (For "all" mode) */
4514
+ zone?: "head" | "bodyBegin" | "bodyEnd";
4515
+ body?: {
4516
+ /** @description Language code. */
4517
+ lang?: string;
4518
+ /** @example Hello world */
4519
+ body?: string;
4520
+ }[];
4521
+ }[];
4522
+ });
4523
+ display?: {
4524
+ /** @description Type of customers to whom to display the snippet */
4525
+ clientType?: "all" | "unregistered" | "registered" | "retailer" | "wholesaler";
4526
+ /** @description Whether to display only for newsletter visitors. */
4527
+ newsletter?: "y" | "n" | "all";
4528
+ /** @description Whether to display the code snippet only for customers who have placed an order */
4529
+ hasOrders?: "y" | "n" | "all";
4530
+ /** @description Display only after entering rebate code */
4531
+ useRebateCode?: "y" | "n" | "all";
4532
+ };
4533
+ /** @description Snippet entry source filter. */
4534
+ sources?: {
4535
+ direct?: {
4536
+ /** @description Whether source filter is active */
4537
+ active?: "y" | "n";
4538
+ /** @description Id of service of given source */
4539
+ id?: number | null;
4540
+ } | null;
4541
+ search?: {
4542
+ /** @description Whether source filter is active */
4543
+ active?: "y" | "n";
4544
+ /** @description Id of service of given source */
4545
+ id?: number | null;
4546
+ } | null;
4547
+ advert?: {
4548
+ /** @description Whether source filter is active */
4549
+ active?: "y" | "n";
4550
+ /** @description Id of service of given source */
4551
+ id?: number | null;
4552
+ } | null;
4553
+ priceComparers?: {
4554
+ /** @description Whether source filter is active */
4555
+ active?: "y" | "n";
4556
+ /** @description Id of service of given source */
4557
+ id?: number | null;
4558
+ } | null;
4559
+ affiliate?: {
4560
+ /** @description Whether source filter is active */
4561
+ active?: "y" | "n";
4562
+ /** @description Id of service of given source */
4563
+ id?: number | null;
4564
+ } | null;
4565
+ cpa?: {
4566
+ /** @description Whether source filter is active */
4567
+ active?: "y" | "n";
4568
+ /** @description Id of service of given source */
4569
+ id?: number | null;
4570
+ } | null;
4571
+ newsletter?: {
4572
+ /** @description Whether source filter is active */
4573
+ active?: "y" | "n";
4574
+ /** @description Id of service of given source */
4575
+ id?: number | null;
4576
+ } | null;
4577
+ social?: {
4578
+ /** @description Whether source filter is active */
4579
+ active?: "y" | "n";
4580
+ /** @description Id of service of given source */
4581
+ id?: number | null;
4582
+ } | null;
4583
+ page?: {
4584
+ /** @description Whether source filter is active */
4585
+ active?: "y" | "n";
4586
+ /** @description Id of service of given source */
4587
+ id?: number | null;
4588
+ } | null;
4589
+ };
4590
+ /** @description List of variables that can be used in a body template. */
4591
+ variables?: {
4592
+ name: string;
4593
+ /** @enum {string} */
4594
+ source?: "session" | "cookie";
4595
+ }[];
4596
+ } & {
4597
+ /** @example null */
4598
+ id?: number | null;
4599
+ })[];
4600
+ };
4601
+
4602
+ export type PostCpaCampaignParams = {
4603
+ campaigns: ({
4604
+ /** @description Snippet campaign id */
4605
+ id?: number | null;
4606
+ /** @description Snippet campaign name */
4607
+ name: string;
4608
+ /** @description Snippet campaign internal description */
4609
+ description?: string;
4610
+ /** @description Shop ids where code snippets are active 1 ] */
4611
+ shop: number[] | null;
4612
+ /** @description Whether the snippet is active */
4613
+ active?: "y" | "n";
4614
+ /** @description Number of CPA programs associated with the campaign. */
4615
+ readonly cpaCount?: number | null;
4616
+ /** @description Number of active CPA programs associated with the campaign. */
4617
+ readonly activeCpaCount?: number | null;
4618
+ } & {
4619
+ /** @example null */
4620
+ id?: number | null;
4621
+ })[];
4622
+ };
4623
+
4624
+ export type PutClientsParams = {
4625
+ /** @description Customer data. */
4626
+ clients: {
4627
+ /** @description Customer's login. */
4628
+ clientLogin: string;
4629
+ /** @description E-mail address. */
4630
+ clientEmail?: string;
4631
+ /** @description Customer's first name. */
4632
+ clientFirstName?: string;
4633
+ /** @description Customer's last name. */
4634
+ clientLastName?: string;
4635
+ /** @description Street and number. */
4636
+ clientStreet?: string;
4637
+ /** @description Customer's postal code. */
4638
+ clientZipCode?: string;
4639
+ /** @description Customer's city. */
4640
+ clientCity?: string;
4641
+ /** @description Country ID in accordance with ISO-3166. */
4642
+ clientCountryId?: string;
4643
+ /** @description Administrative region code. */
4644
+ clientProvinceId?: string;
4645
+ /** @description Customer password (min. 8 characters). */
4646
+ clientPassword?: string;
4647
+ /** @description Date of birth. */
4648
+ clientBirthDate?: string;
4649
+ /** @description Cell phone. */
4650
+ clientPhone1?: string;
4651
+ /** @description Customer's company name. */
4652
+ clientFirm?: string;
4653
+ /** @description Customer Tax no. */
4654
+ clientNip?: string;
4655
+ /** @description Determines, whether client is a wholesaler. */
4656
+ clientIsWholesaler?: boolean;
4657
+ /** @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. */
4658
+ clientType?: "person" | "person_male" | "person_female" | "firm";
4659
+ /** @description Language ID */
4660
+ langId?: string;
4661
+ /** @description Defines availability of log in to other pages than the ones given in the element: shops . */
4662
+ blockLoginToOtherShops?: boolean;
4663
+ /** @description List of stores IDs When mask is determined, this parameter is omitted. */
4664
+ shopsIds?: number[];
4665
+ /** @description Currency ID */
4666
+ currencyId?: string;
4667
+ /** @description External system code. */
4668
+ clientCodeExternal?: string;
4669
+ /** @description List with delivery dates and times */
4670
+ deliveryDates?: {
4671
+ /** @description Delivery date in format: Y-m-d */
4672
+ deliveryDate?: string;
4673
+ /** @description Delivery time in format: H:i */
4674
+ deliveryHours?: string[];
4675
+ }[];
4676
+ /** @description Customer account balance in external system. */
4677
+ clientBalanceAmountExternal?: number;
4678
+ /** @description Debt limit. */
4679
+ clientTradeCreditLimitExternal?: number;
4680
+ /** @description Permission to E-mail Newsletter. */
4681
+ newsletterEmailApproval?: boolean;
4682
+ /** @description Permission to SMS Newsletter. */
4683
+ newsletterSmsApproval?: boolean;
4684
+ /** @description Discount group ID. */
4685
+ clientGroupDiscountNumber?: number;
4686
+ /** @description Field used for identifying request-response pairs for the endpoint. */
4687
+ requestReference?: string;
4688
+ /** @description List of shops where a customer agreed or didn't agree to receive email newsletter. */
4689
+ newsletterEmailApprovalsData?: {
4690
+ /** @description Permission to E-mail Newsletter. */
4691
+ inNewsletterEmailApproval?: "y" | "n";
4692
+ /** @description Shop Id */
4693
+ shopId?: number;
4694
+ }[];
4695
+ /** @description List of shops where a customer agreed or didn't agree to receive sms newsletter. */
4696
+ newsletterSmsApprovalsData?: {
4697
+ /** @description Permission to SMS Newsletter. */
4698
+ inNewsletterSmsApproval?: "y" | "n";
4699
+ /** @description Shop Id */
4700
+ shopId?: number;
4701
+ }[];
4702
+ /** @description Is the customer active */
4703
+ clientActive?: boolean;
4704
+ /** @description Number of days to pay for invoice */
4705
+ numberOfDaysToPay?: number;
4706
+ /** @description The parameter stores information about who acquired the customer */
4707
+ affiliateLogin?: string;
4708
+ /** @description ID of a partner who acquired a given customer. */
4709
+ affiliateId?: number;
4710
+ /** @description Notes from customer. */
4711
+ clientNote?: string;
4712
+ }[];
4713
+ };
4714
+
4715
+ export type PutClientsPayerAddressParams = {
4716
+ payers: {
4717
+ /** @description Unique client's number. */
4718
+ clientId: string;
4719
+ /** @description Buyer's address id. */
4720
+ payerAddressId: string;
4721
+ /** @description Buyer's first name. */
4722
+ payerAddressFirstName?: string;
4723
+ /** @description Buyer's last name. */
4724
+ payerAddressLastName?: string;
4725
+ /** @description Company name. */
4726
+ payerAddressFirm?: string;
4727
+ /** @description Customer VAT ID. */
4728
+ payerAddressNip?: string;
4729
+ /** @description Buyer's street name and house number. */
4730
+ payerAddressStreet?: string;
4731
+ /** @description Buyer's postal code. */
4732
+ payerAddressZipCode?: string;
4733
+ /** @description Buyer's city. */
4734
+ payerAddressCity?: string;
4735
+ /** @description Country code in the ISO 3166-1 A2 standard. */
4736
+ payerAddressCountryId?: string;
4737
+ /** @description Buyer's telephone number. */
4738
+ payerAddressPhone?: string;
4739
+ }[];
4740
+ };
4741
+
4742
+ export type PutCpaCampaignParams = {
4743
+ campaigns: {
4744
+ /** @description Snippet campaign id */
4745
+ id: number | null;
4746
+ /** @description Snippet campaign name */
4747
+ name?: string;
4748
+ /** @description Snippet campaign internal description */
4749
+ description?: string;
4750
+ /** @description Shop ids where code snippets are active 1 ] */
4751
+ shop?: number[] | null;
4752
+ /** @description Whether the snippet is active */
4753
+ active?: "y" | "n";
4754
+ /** @description Number of CPA programs associated with the campaign. */
4755
+ readonly cpaCount?: number | null;
4756
+ /** @description Number of active CPA programs associated with the campaign. */
4757
+ readonly activeCpaCount?: number | null;
4758
+ }[];
4759
+ };
4760
+
4761
+ export type PutCpaParams = {
4762
+ cpa: ({
4763
+ /** @description Id of the CPA program. */
4764
+ id: number | null;
4765
+ /** @description The CPA program name. */
4766
+ name?: string;
4767
+ /** @description Whether the CPA program is active. */
4768
+ active?: "y" | "n";
4769
+ /** @description CPA campaign id */
4770
+ campaign?: number;
4771
+ /** @description CPA program page settings simple or advanced, depending on the mode. */
4772
+ pageSettings?: (Omit<{
4773
+ /** @description Whether to display to all sites. */
4774
+ mode: "simple" | "advanced";
4775
+ }, "mode"> & {
4776
+ /** @description Whether to display to all sites. */
4777
+ mode?: "simple";
4778
+ /** @description The place where the cpa code is loaded. (For "all" mode)|null} */
4779
+ zone?: "head" | "bodyBegin" | "bodyEnd" | null;
4780
+ /** @description Snippet content for each language. (For "all" mode) */
4781
+ body?: {
4782
+ /** @description Language code. */
4783
+ lang?: string;
4784
+ /** @example Hello world */
4785
+ body?: string;
4786
+ }[] | null;
4787
+ }) | (Omit<{
4788
+ /** @description Whether to display to all sites. */
4789
+ mode: "simple" | "advanced";
4790
+ }, "mode"> & {
4791
+ /** @description Whether to display to all sites. */
4792
+ mode?: "advanced";
4793
+ /** @description Page setting for advance mode */
4794
+ pages?: {
4795
+ /** @enum {string} */
4796
+ active?: "y" | "n";
4797
+ /** @enum {string} */
4798
+ 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";
4799
+ /** @description The place where the cpa code is loaded. (For "all" mode) */
4800
+ zone?: "head" | "bodyBegin" | "bodyEnd";
4801
+ body?: {
4802
+ /** @description Language code. */
4803
+ lang?: string;
4804
+ /** @example Hello world */
4805
+ body?: string;
4806
+ }[];
4807
+ }[];
4808
+ });
4809
+ display?: {
4810
+ /** @description Type of customers to whom to display the snippet */
4811
+ clientType?: "all" | "unregistered" | "registered" | "retailer" | "wholesaler";
4812
+ /** @description Whether to display only for newsletter visitors. */
4813
+ newsletter?: "y" | "n" | "all";
4814
+ /** @description Whether to display the code snippet only for customers who have placed an order */
4815
+ hasOrders?: "y" | "n" | "all";
4816
+ /** @description Display only after entering rebate code */
4817
+ useRebateCode?: "y" | "n" | "all";
4818
+ };
4819
+ /** @description Snippet entry source filter. */
4820
+ sources?: {
4821
+ direct?: {
4822
+ /** @description Whether source filter is active */
4823
+ active?: "y" | "n";
4824
+ /** @description Id of service of given source */
4825
+ id: number | null;
4826
+ } | null;
4827
+ search?: {
4828
+ /** @description Whether source filter is active */
4829
+ active?: "y" | "n";
4830
+ /** @description Id of service of given source */
4831
+ id?: number | null;
4832
+ } | null;
4833
+ advert?: {
4834
+ /** @description Whether source filter is active */
4835
+ active?: "y" | "n";
4836
+ /** @description Id of service of given source */
4837
+ id?: number | null;
4838
+ } | null;
4839
+ priceComparers?: {
4840
+ /** @description Whether source filter is active */
4841
+ active?: "y" | "n";
4842
+ /** @description Id of service of given source */
4843
+ id?: number | null;
4844
+ } | null;
4845
+ affiliate?: {
4846
+ /** @description Whether source filter is active */
4847
+ active?: "y" | "n";
4848
+ /** @description Id of service of given source */
4849
+ id?: number | null;
4850
+ } | null;
4851
+ cpa?: {
4852
+ /** @description Whether source filter is active */
4853
+ active?: "y" | "n";
4854
+ /** @description Id of service of given source */
4855
+ id?: number | null;
4856
+ } | null;
4857
+ newsletter?: {
4858
+ /** @description Whether source filter is active */
4859
+ active?: "y" | "n";
4860
+ /** @description Id of service of given source */
4861
+ id?: number | null;
4862
+ } | null;
4863
+ social?: {
4864
+ /** @description Whether source filter is active */
4865
+ active?: "y" | "n";
4866
+ /** @description Id of service of given source */
4867
+ id?: number | null;
4868
+ } | null;
4869
+ page?: {
4870
+ /** @description Whether source filter is active */
4871
+ active?: "y" | "n";
4872
+ /** @description Id of service of given source */
4873
+ id?: number | null;
4874
+ } | null;
4875
+ };
4876
+ /** @description List of variables that can be used in a body template. */
4877
+ variables?: {
4878
+ name?: string;
4879
+ /** @enum {string} */
4880
+ source?: "session" | "cookie";
4881
+ }[];
4882
+ } & {
4883
+ /** @example null */
4884
+ id: number | null;
4885
+ })[];
4886
+ };
4887
+
4888
+ export type PutSnippetsParams = {
4889
+ snippets: ({
4890
+ /** @description Id of the code snippet. */
4891
+ id: number | null;
4892
+ /** @description The snippet name. */
4893
+ name?: string;
4894
+ /** @description Whether the snippet is active. */
4895
+ active?: "y" | "n";
4896
+ /** @description Snippet campaign id */
4897
+ campaign?: number;
4898
+ dateBegin?: {
4899
+ /** @description Whether date condition is active */
4900
+ defined?: "y" | "n";
4901
+ /** Format: date
4902
+ * @description Date of snippet activation */
4903
+ date?: string | null;
4904
+ } & {
4905
+ /** @description Automatic shutdown control */
4906
+ autoBlock?: "y" | "n";
4907
+ };
4908
+ /** @description Filter to control snippet activation. */
4909
+ dateEnd?: {
4910
+ /** @description Whether date condition is active */
4911
+ defined?: "y" | "n";
4912
+ /** Format: date
4913
+ * @description Date of snippet activation */
4914
+ date?: string | null;
4915
+ };
4916
+ /** @description Code snippet type. */
4917
+ type?: "html" | "javascript" | "cgi";
4918
+ /** @description Whether to load contents asynchronously via XHR request. */
4919
+ useAjax?: "y" | "n";
4920
+ /** @description Url. */
4921
+ link?: string;
4922
+ /** @description Content waiting time (timeout) in seconds. */
4923
+ timeout?: number;
4924
+ /** @description The place where the code snippet is loaded. */
4925
+ zone?: "head" | "bodyBegin" | "bodyEnd";
4926
+ /** @description The order in which the code snippet will be displayed. */
4927
+ order?: number;
4928
+ /** @description Snippet content for each language. */
4929
+ body?: {
4930
+ /** @description Language code. */
4931
+ lang?: string;
4932
+ /** @example Hello world */
4933
+ body?: string;
4934
+ }[];
4935
+ display?: {
4936
+ /** @description Type of customers to whom to display the snippet */
4937
+ clientType?: "all" | "unregistered" | "registered" | "retailer" | "wholesaler";
4938
+ /** @description Whether to display only for newsletter visitors. */
4939
+ newsletter?: "y" | "n" | "all";
4940
+ /** @description Whether to display the code snippet only for customers who have placed an order */
4941
+ hasOrders?: "y" | "n" | "all";
4942
+ /** @description Display only after entering rebate code */
4943
+ useRebateCode?: "y" | "n" | "all";
4944
+ } & {
4945
+ /** @description Display on desktop screens */
4946
+ screen?: "y" | "n";
4947
+ /** @description Display on mobile tablets */
4948
+ tablet?: "y" | "n";
4949
+ /** @description Display on mobile phones */
4950
+ phone?: "y" | "n";
4951
+ };
4952
+ pages?: {
4953
+ /** @description Whether to display to all sites. */
4954
+ all?: "y" | "n";
4955
+ /** @description List of selected pages where snippet shows (works for all=n mode). If passed, the url should be omitted. */
4956
+ pages?: ("home" | "basket" | "checkout_payment_delivery" | "checkout_confirmation" | "new_order_placement" | "order_details" | "navigation" | "product_details" | "search_results" | "after_order_place" | "mailing_subscribe" | "payment_success" | "payment_error" | "payment_pending" | "other_pages")[];
4957
+ /** @description List of selected url (works for all=n mode) If passed, pages should be omitted. */
4958
+ url?: string[];
4959
+ };
4960
+ /** @description Snippet entry source filter. */
4961
+ sources?: {
4962
+ direct?: {
4963
+ /** @description Whether source filter is active */
4964
+ active?: "y" | "n";
4965
+ /** @description Id of service of given source */
4966
+ id: number | null;
4967
+ } | null;
4968
+ search?: {
4969
+ /** @description Whether source filter is active */
4970
+ active?: "y" | "n";
4971
+ /** @description Id of service of given source */
4972
+ id?: number | null;
4973
+ } | null;
4974
+ advert?: {
4975
+ /** @description Whether source filter is active */
4976
+ active?: "y" | "n";
4977
+ /** @description Id of service of given source */
4978
+ id?: number | null;
4979
+ } | null;
4980
+ priceComparers?: {
4981
+ /** @description Whether source filter is active */
4982
+ active?: "y" | "n";
4983
+ /** @description Id of service of given source */
4984
+ id?: number | null;
4985
+ } | null;
4986
+ affiliate?: {
4987
+ /** @description Whether source filter is active */
4988
+ active?: "y" | "n";
4989
+ /** @description Id of service of given source */
4990
+ id?: number | null;
4991
+ } | null;
4992
+ cpa?: {
4993
+ /** @description Whether source filter is active */
4994
+ active?: "y" | "n";
4995
+ /** @description Id of service of given source */
4996
+ id?: number | null;
4997
+ } | null;
4998
+ newsletter?: {
4999
+ /** @description Whether source filter is active */
5000
+ active?: "y" | "n";
5001
+ /** @description Id of service of given source */
5002
+ id?: number | null;
5003
+ } | null;
5004
+ social?: {
5005
+ /** @description Whether source filter is active */
5006
+ active?: "y" | "n";
5007
+ /** @description Id of service of given source */
5008
+ id?: number | null;
5009
+ } | null;
5010
+ page?: {
5011
+ /** @description Whether source filter is active */
5012
+ active?: "y" | "n";
5013
+ /** @description Id of service of given source */
5014
+ id?: number | null;
5015
+ } | null;
5016
+ };
5017
+ /** @description Whether the snippet is marked as deleted. */
5018
+ readonly deleted?: "y" | "n";
5019
+ /** @description The number of cookies associated with the snippet. */
5020
+ readonly cookiesCount?: number;
5021
+ } & {
5022
+ /** @example null */
5023
+ id: number | null;
5024
+ })[];
5025
+ };
5026
+
5027
+ export type PutSnippetsCampaignParams = {
5028
+ campaigns: {
5029
+ /** @description Snippet campaign id */
5030
+ id: number | null;
5031
+ /** @description Snippet campaign name */
5032
+ name?: string;
5033
+ /** @description Snippet campaign internal description */
5034
+ description?: string;
5035
+ /** @description Shop ids where code snippets are active 1 ] */
5036
+ shop?: number[] | null;
5037
+ /** @description Whether the snippet is active */
5038
+ active?: "y" | "n";
5039
+ /** @description Whether the snippet campaign is deleted */
5040
+ readonly deleted?: "y" | "n";
5041
+ /** @description Snippet order. */
5042
+ order?: number;
5043
+ /** @description Number of code snippets associated with the campaign. */
5044
+ readonly snippetCount?: number | null;
5045
+ /** @description Number of active code snippets associated with the campaign. */
5046
+ readonly activeSnippetCount?: number | null;
5047
+ configVariables?: {
5048
+ /** @description Key of config value. */
5049
+ key?: string;
5050
+ /** @description Name of config item. */
5051
+ readonly name?: string;
5052
+ /** @description Value of config item. */
5053
+ value?: string;
5054
+ }[];
5055
+ }[];
5056
+ };
5057
+
5058
+ export type PutSnippetsCookiesParams = {
5059
+ cookies: ({
5060
+ /** @description Snippet */
5061
+ id: number | null;
5062
+ /** @description Id of the snippet code. */
5063
+ snippetId?: number;
5064
+ /** @description Name of the cookie vendor. */
5065
+ deliverer?: string;
5066
+ /** @description Category of the cookie */
5067
+ category?: "analytics" | "marketing" | "functional";
5068
+ /** @description Cookie description for each language. */
5069
+ description?: {
5070
+ /** @description Language code. */
5071
+ lang?: string;
5072
+ /** @example Hello world */
5073
+ body?: string;
5074
+ }[];
5075
+ /** @description Name of the cookie. */
5076
+ name?: string | null;
5077
+ /** @description Type of the cookie|null} */
5078
+ type?: "cookie" | "pixel" | "localStorage" | null;
5079
+ /** @description Cookie lifetime mode|null} */
5080
+ lifeTimeType?: "temporary" | "days" | "minutes" | null;
5081
+ /** @description Cookie lifetime */
5082
+ lifeTime?: number | null;
5083
+ } & {
5084
+ /** @example null */
5085
+ id: number | null;
5086
+ })[];
5087
+ };
5088
+
5089
+ export type PutEntriesParams = {
5090
+ /** @description Entry ID */
5091
+ entryId: number;
5092
+ /** @description Shop Id */
5093
+ shopId: number;
5094
+ /** @description Date of creating an entry */
5095
+ date?: string;
5096
+ /** @description Entry visibility */
5097
+ visible?: "y" | "n";
5098
+ /** @description List of pages on which the entry is to be published */
5099
+ visibleOnSitesList?: {
5100
+ /** @description Page ID */
5101
+ siteId?: string;
5102
+ }[];
5103
+ /** @description Products list. */
5104
+ products?: {
5105
+ /** @description Merchandise identifier */
5106
+ productId?: number;
5107
+ }[];
5108
+ /** @description Photo */
5109
+ pictureData?: {
5110
+ /** @description Photo encoded with Base64 */
5111
+ pictureBase64?: string;
5112
+ /** @description Photo format */
5113
+ pictureFormat?: "jpg" | "jpeg" | "png" | "gif";
5114
+ };
5115
+ /** @description Determines whether to delete an entry photo */
5116
+ deletePicture?: "y" | "n";
5117
+ /** @description Element including entry content in selected languages */
5118
+ langs?: {
5119
+ /** @description Language ID */
5120
+ langId?: string;
5121
+ /** @description Name on the page */
5122
+ title?: string;
5123
+ /** @description short description */
5124
+ shortDescription?: string;
5125
+ /** @description Long description */
5126
+ longDescription?: string;
5127
+ /** @description Blog post URL */
5128
+ blogUrl?: string;
5129
+ /** @description News item URL */
5130
+ newsUrl?: string;
5131
+ }[];
5132
+ /** @description Type of title and shortcut linking: fullContentLink - link to the subpage with full content, givenUrlLink - link to the given URL, noLink - static element */
5133
+ titleLinkType?: "fullContentLink" | "givenUrlLink" | "noLink";
5134
+ /** @description Provided URL (for link to specified URL option) */
5135
+ link?: string;
5136
+ };
5137
+
5138
+ export type PutResponsibilityEntitiesParams = {
5139
+ entities: {
5140
+ /** @description Identificator of the entity. */
5141
+ id?: number;
5142
+ /** @description Short name/code. */
5143
+ code: string;
5144
+ /** @description Full name. */
5145
+ name?: string;
5146
+ /** @description E-mail address. */
5147
+ mail?: string;
5148
+ /** @description Street. */
5149
+ street?: string;
5150
+ /** @description Building number. */
5151
+ number?: string | null;
5152
+ /** @description Apartment number. */
5153
+ subnumber?: string | null;
5154
+ /** @description Zipcode. */
5155
+ zipcode?: string;
5156
+ /** @description City. */
5157
+ city?: string;
5158
+ /** @description 2-letter ISO country code. */
5159
+ country?: string;
5160
+ /** @description Phone number. */
5161
+ phone?: string | null;
5162
+ /** @description Additional description. */
5163
+ description?: string | null;
5164
+ /** @description URL to contact page. */
5165
+ url?: string | null;
5166
+ }[];
5167
+ /** @description Type of entity */
5168
+ type: "producer" | "person";
5169
+ };
5170
+
5171
+ export type PutSystemCurrenciesParams = {
5172
+ currencies: {
5173
+ /** @description Currency code in ISO 4217 standard. */
5174
+ id: string;
5175
+ /** @description Currency exchange rate. Maximal value is 10000. */
5176
+ rate: number;
5177
+ /** @description Currency smaller unit. */
5178
+ scale: number;
5179
+ }[];
5180
+ };
5181
+
5182
+ export type PutVouchersParams = {
5183
+ /** @description List of vouchers to edit */
5184
+ vouchers: {
5185
+ /** @description Voucher ID */
5186
+ id: number;
5187
+ /** @description Number. */
5188
+ number?: string;
5189
+ /** @description Name. */
5190
+ name?: string;
5191
+ /** @description Voucher expiration date */
5192
+ expirationDate?: string;
5193
+ /** @description Balance operation type, possible values: - set - balance positioning of funds, - add - add funds to balance, - subtract - subtract funds from balance. */
5194
+ balanceOperationType?: "set" | "add" | "subtract";
5195
+ /** @description Voucher balance */
5196
+ balance?: {
5197
+ /** @description Available balance */
5198
+ amount?: number;
5199
+ /** @description Currency. */
5200
+ currency?: string;
5201
+ };
5202
+ /** @description List of shops the voucher is active in */
5203
+ shops?: number[];
5204
+ /** @example note */
5205
+ note?: string;
5206
+ /** @description Status, possible values: - used - used, - unused - unused, */
5207
+ status?: "used" | "unused";
5208
+ }[];
5209
+ };
5210
+
5211
+ export type PutProductsBrandsParams = {
5212
+ /** @description List of manufacturers assigned to sought products. */
5213
+ producers: {
5214
+ /** @description Id */
5215
+ id: number;
5216
+ /** @description Name in panel */
5217
+ nameInPanel?: string;
5218
+ imagesSettings?: {
5219
+ /** @description Images source type. Available values: base64 - image data encoded using the base64 algorithm (default), url - image file link */
5220
+ sourceType?: "base64" | "url";
5221
+ };
5222
+ languagesConfigurations?: {
5223
+ productsListImagesConfiguration?: {
5224
+ /** @description Type of graphics */
5225
+ graphicType?: "img" | "img_rwd";
5226
+ /** @description Image (one size for computers, tablets and smartphones, not recommended) */
5227
+ singleGraphic?: string;
5228
+ /** @description #!GrafikaDlaEkranowKomputera#! */
5229
+ pcGraphic?: string;
5230
+ /** @description Graphics for tablets */
5231
+ tabletGraphic?: string;
5232
+ /** @description Graphics for smartphones */
5233
+ phoneGraphic?: string;
5234
+ };
5235
+ /** @description Graphic displayed on product card */
5236
+ productCardImagesConfiguration?: {
5237
+ /** @description Type of graphics */
5238
+ graphicType?: "img" | "img_rwd";
5239
+ /** @description Image (one size for computers, tablets and smartphones, not recommended) */
5240
+ singleGraphic?: string;
5241
+ /** @description #!GrafikaDlaEkranowKomputera#! */
5242
+ pcGraphic?: string;
5243
+ /** @description Graphics for tablets */
5244
+ tabletGraphic?: string;
5245
+ /** @description Graphics for smartphones */
5246
+ phoneGraphic?: string;
5247
+ };
5248
+ /** @description Language ID (code in ISO 639-2). */
5249
+ languageId?: string;
5250
+ shopsConfigurations?: {
5251
+ /** @description Name. */
5252
+ name?: string;
5253
+ /** @description Name displayed in the website header */
5254
+ headerName?: string;
5255
+ /** @description Description displayed at the top of products list */
5256
+ descriptionTop?: string;
5257
+ /** @description Description displayed at the bottom of products list */
5258
+ descriptionBottom?: string;
5259
+ /** @description Shop Id */
5260
+ shopId?: number;
5261
+ /** @description Products display settings */
5262
+ view?: "default" | "own";
5263
+ /** @description Enable customers to change sorting */
5264
+ enableSort?: boolean;
5265
+ /** @description Enable customers to change the number of products displayed */
5266
+ enableChangeDisplayCount?: boolean;
5267
+ /** @description Number of displayed products */
5268
+ numberOfProductsGrid?: number;
5269
+ /** @description Selected sorting mode */
5270
+ sortModeGrid?: "d_relevance" | "d_date" | "a_date" | "d_priority" | "a_priority" | "a_priorityname" | "d_priorityname" | "d_priorityonly" | "a_priorityonly" | "a_name" | "d_name" | "a_price" | "d_price";
5271
+ /** @description Meta settings */
5272
+ metaSettings?: "auto" | "custom";
5273
+ /** @description Title */
5274
+ metaTitle?: string;
5275
+ /** @description Description */
5276
+ metaDescription?: string;
5277
+ /** @description Keywords */
5278
+ metaKeywords?: string;
5279
+ /** @description Meta robots settings for index attribute */
5280
+ metaRobotsSettingsIndex?: "auto" | "index" | "noindex";
5281
+ /** @description Meta robots settings for follow attribute */
5282
+ metaRobotsSettingsFollow?: "auto" | "follow" | "nofollow";
5283
+ }[];
5284
+ }[];
5285
+ }[];
5286
+ };
5287
+
5288
+ export type PutProductsDescriptionsParams = {
5289
+ /** @description Products list. */
5290
+ products: {
5291
+ productIdent: {
5292
+ /** @description Identifier type. */
5293
+ productIdentType?: "id" | "index" | "codeExtern" | "codeProducer";
5294
+ /** @description ID value. */
5295
+ identValue?: string;
5296
+ };
5297
+ /** @description Array of language-dependent elements. */
5298
+ productDescriptionsLangData?: {
5299
+ /** @description Language ID */
5300
+ langId?: string;
5301
+ /** @description Shop Id */
5302
+ shopId?: number;
5303
+ /** @description Product name. */
5304
+ productName?: string;
5305
+ /** @description Product name for auction service. */
5306
+ productAuctionName?: string;
5307
+ /** @description Product name for price comparison websites */
5308
+ productPriceComparerName?: string;
5309
+ /** @description Short product description. */
5310
+ productDescription?: string;
5311
+ /** @description Long product description. */
5312
+ productLongDescription?: string;
5313
+ productDescriptionSections?: {
5314
+ descriptionSections?: {
5315
+ section_1?: {
5316
+ /** @enum {string} */
5317
+ type: "text" | "photo" | "video" | "html";
5318
+ /** @description HTML content depending on the type */
5319
+ content: string;
5320
+ };
5321
+ section_2?: {
5322
+ /** @enum {string} */
5323
+ type: "text" | "photo" | "video" | "html";
5324
+ /** @description HTML content depending on the type */
5325
+ content: string;
5326
+ };
5327
+ }[];
5328
+ };
5329
+ /** @description DEPRECATED. This parameter is deprecated. Long product description for external listings. */
5330
+ productAuctionLongDescription?: string;
5331
+ /** @description Product meta title. */
5332
+ productMetaTitle?: string;
5333
+ /** @description Product meta description. */
5334
+ productMetaDescription?: string;
5335
+ /** @description Product meta keywords. */
5336
+ productMetaKeywords?: string;
5337
+ }[];
5338
+ /** @description Product data for auction services */
5339
+ productAuctionDescriptionsData?: {
5340
+ /** @description Auction system ID */
5341
+ productAuctionId?: string;
5342
+ /** @description Auction site ID */
5343
+ productAuctionSiteId?: string;
5344
+ /** @description Product name for auction service. */
5345
+ productAuctionName?: string;
5346
+ /** @description Subtitle for auction service */
5347
+ productAuctionAdditionalName?: string;
5348
+ /** @description Product description for marketplaces */
5349
+ productAuctionDescription?: string;
5350
+ }[];
5351
+ }[];
5352
+ };
5353
+
5354
+ export type PostProductsBrandsParams = {
5355
+ /** @description List of manufacturers assigned to sought products. */
5356
+ producers: {
5357
+ /** @description Name in panel */
5358
+ nameInPanel: string;
5359
+ imagesSettings?: {
5360
+ /** @description Images source type. Available values: base64 - image data encoded using the base64 algorithm (default), url - image file link */
5361
+ sourceType?: "base64" | "url";
5362
+ };
5363
+ languagesConfigurations?: {
5364
+ productsListImagesConfiguration?: {
5365
+ /** @description Type of graphics */
5366
+ graphicType?: "img" | "img_rwd";
5367
+ /** @description Image (one size for computers, tablets and smartphones, not recommended) */
5368
+ singleGraphic?: string;
5369
+ /** @description #!GrafikaDlaEkranowKomputera#! */
5370
+ pcGraphic?: string;
5371
+ /** @description Graphics for tablets */
5372
+ tabletGraphic?: string;
5373
+ /** @description Graphics for smartphones */
5374
+ phoneGraphic?: string;
5375
+ };
5376
+ /** @description Graphic displayed on product card */
5377
+ productCardImagesConfiguration?: {
5378
+ /** @description Type of graphics */
5379
+ graphicType?: "img" | "img_rwd";
5380
+ /** @description Image (one size for computers, tablets and smartphones, not recommended) */
5381
+ singleGraphic?: string;
5382
+ /** @description #!GrafikaDlaEkranowKomputera#! */
5383
+ pcGraphic?: string;
5384
+ /** @description Graphics for tablets */
5385
+ tabletGraphic?: string;
5386
+ /** @description Graphics for smartphones */
5387
+ phoneGraphic?: string;
5388
+ };
5389
+ /** @description Language ID (code in ISO 639-2). */
5390
+ languageId?: string;
5391
+ shopsConfigurations?: {
5392
+ /** @description Name. */
5393
+ name?: string;
5394
+ /** @description Name displayed in the website header */
5395
+ headerName?: string;
5396
+ /** @description Description displayed at the top of products list */
5397
+ descriptionTop?: string;
5398
+ /** @description Description displayed at the bottom of products list */
5399
+ descriptionBottom?: string;
5400
+ /** @description Shop Id */
5401
+ shopId?: number;
5402
+ /** @description Products display settings */
5403
+ view?: "default" | "own";
5404
+ /** @description Enable customers to change sorting */
5405
+ enableSort?: boolean;
5406
+ /** @description Enable customers to change the number of products displayed */
5407
+ enableChangeDisplayCount?: boolean;
5408
+ /** @description Number of displayed products */
5409
+ numberOfProductsGrid?: number;
5410
+ /** @description Selected sorting mode */
5411
+ sortModeGrid?: "d_relevance" | "d_date" | "a_date" | "d_priority" | "a_priority" | "a_priorityname" | "d_priorityname" | "d_priorityonly" | "a_priorityonly" | "a_name" | "d_name" | "a_price" | "d_price";
5412
+ /** @description Meta settings */
5413
+ metaSettings?: "auto" | "custom";
5414
+ /** @description Title */
5415
+ metaTitle?: string;
5416
+ /** @description Description */
5417
+ metaDescription?: string;
5418
+ /** @description Keywords */
5419
+ metaKeywords?: string;
5420
+ /** @description Array */
5421
+ metaRobotsSettingsIndex?: "auto" | "index" | "noindex";
5422
+ /** @description Array */
5423
+ metaRobotsSettingsFollow?: "auto" | "follow" | "nofollow";
5424
+ }[];
5425
+ }[];
5426
+ }[];
5427
+ };
5428
+
5429
+ export type PostProductsOpinionsParams = {
5430
+ /** @description List of reviews */
5431
+ opinions: {
5432
+ /** @example createDate */
5433
+ createDate?: string;
5434
+ confirmed?: boolean;
5435
+ /** @example rating */
5436
+ rating?: string;
5437
+ /** @example content */
5438
+ content?: string;
5439
+ /** @description Customer language ID. */
5440
+ language?: string;
5441
+ /** @example picture */
5442
+ picture?: string;
5443
+ /** @description Shop Id */
5444
+ shopId?: number;
5445
+ /** @example host */
5446
+ host?: string;
5447
+ /** @description Customer data. */
5448
+ clients?: {
5449
+ /** */
5450
+ type?: "id" | "login" | "codeExtern";
5451
+ /** @example value */
5452
+ value?: string;
5453
+ /** @description Name. */
5454
+ name?: string;
5455
+ /** @description E-mail address */
5456
+ email?: string;
5457
+ };
5458
+ /** @example 1 */
5459
+ scorePositive?: number;
5460
+ /** @example 1 */
5461
+ scoreNegative?: number;
5462
+ /** @description Products list. */
5463
+ products: {
5464
+ /** */
5465
+ type?: "id" | "index" | "codeExtern" | "codeProducer";
5466
+ /** @example value */
5467
+ value?: string;
5468
+ };
5469
+ /** @description Order serial number. */
5470
+ orderSerialNumber?: number;
5471
+ /** @description Reply to an opinion */
5472
+ shopAnswer?: string;
5473
+ /** @description Opinion confirmed with purchase */
5474
+ opinionConfirmedByPurchase?: boolean;
5475
+ }[];
5476
+ };
5477
+
5478
+ export type PutProductsOpinionsParams = {
5479
+ /** @example 1 */
5480
+ id: number;
5481
+ /** */
5482
+ confirmed?: "y" | "n";
5483
+ /** */
5484
+ rating?: "1" | "2" | "3" | "4" | "5";
5485
+ /** @example content */
5486
+ content?: string;
5487
+ /** @description Customer language ID. */
5488
+ language?: string;
5489
+ /** @description Reply to an opinion */
5490
+ shopAnswer?: string;
5491
+ /** @example picture */
5492
+ picture?: string;
5493
+ /** @description Opinion confirmed with purchase */
5494
+ opinionConfirmedByPurchase?: boolean;
5495
+ };
5496
+
5497
+ export type PutProductsGroupsMainProductParams = {
5498
+ groups: {
5499
+ productIdent: {
5500
+ /** @description Identifier type. */
5501
+ productIdentType?: "id" | "index" | "codeExtern" | "codeProducer";
5502
+ /** @description ID value. */
5503
+ identValue?: string;
5504
+ };
5505
+ }[];
5506
+ };
5507
+
5508
+ export type PostProductsMarketingPromotionParams = {
5509
+ /** @description Promotion name */
5510
+ promotionName: string;
5511
+ /** @description List of stores IDs When mask is determined, this parameter is omitted. */
5512
+ shopsIds: number[];
5513
+ /** @description Special zones */
5514
+ marketingZones: {
5515
+ /** @description Reduced price */
5516
+ promotion?: "y" | "n";
5517
+ /** @description Sale */
5518
+ discount?: "y" | "n";
5519
+ /** @description Distinguished product */
5520
+ distinguished?: "y" | "n";
5521
+ /** @description Special product */
5522
+ special?: "y" | "n";
5523
+ /** @description New */
5524
+ new?: "y" | "n";
5525
+ };
5526
+ /** @description Promotional price settings */
5527
+ newPriceSettings?: {
5528
+ /** */
5529
+ type?: "retail" | "wholesale" | "pos";
5530
+ /** @description Discount value */
5531
+ discountValue?: number;
5532
+ /** @description ISO 4217 currency */
5533
+ currencyId?: string;
5534
+ /** @description Edition mode */
5535
+ mode?: "percent_diff" | "amount_diff" | "amount_set";
5536
+ /** @description Fractional price value */
5537
+ endValue?: string;
5538
+ };
5539
+ /** @description Promotion start date in Y-m-d H:i:s format */
5540
+ startDate?: string;
5541
+ /** @description Promotion end date in Y-m-d H:i:s format */
5542
+ endDate?: string;
5543
+ /** @description Change the status of hidden products to visible while starting the special offer */
5544
+ changeProductsToVisibleWhileStarting?: "y" | "n";
5545
+ /** @description After running out of stock, automatically remove from the promotion products added separately (does not apply to series, producers, categories and menu) */
5546
+ removeProductsAfterStockLevelRunsDown?: "y" | "n";
5547
+ /** @description After running out of own stock, automatically remove from the promotion products added separately (does not apply to series, producers, categories and menu) */
5548
+ removeProductsAfterOwnStockLevelRunsDown?: "y" | "n";
5549
+ /** @description Reduce based on price (net/gross) */
5550
+ reduceBasingPrice?: "net" | "gross";
5551
+ /** @description Price reduction calculation method */
5552
+ calculationMethod?: "sum" | "chooseAdvantageous";
5553
+ /** @description Elements to be affected by the promotion */
5554
+ promotionElements?: {
5555
+ /** */
5556
+ elementType?: "product" | "series" | "producer" | "category" | "menu";
5557
+ /** @description Identifier of the element affected by the promotion (in the case of a menu in the format: storeId-menuId-itemId) */
5558
+ elementId?: string;
5559
+ }[];
5560
+ };
5561
+
5562
+ export type PutProductsMarketingZonesParams = {
5563
+ /** @description Products list. */
5564
+ products: {
5565
+ /** @description Identifier type. */
5566
+ ident: {
5567
+ /** */
5568
+ type?: "id" | "index" | "codeExtern" | "codeProducer";
5569
+ /** @description Value. */
5570
+ value?: string;
5571
+ };
5572
+ /** */
5573
+ assignment_mode?: "auto" | "manual";
5574
+ marketing_zones?: {
5575
+ /** @description Promoted product. */
5576
+ promotion?: "yes" | "no";
5577
+ /** @description Product on sale. */
5578
+ discount?: "yes" | "no";
5579
+ /** @description Distinguished product. */
5580
+ distinguished?: "yes" | "no";
5581
+ /** @description Special product. */
5582
+ special?: "yes" | "no";
5583
+ };
5584
+ /** @description Marketing hotspots in shops */
5585
+ shops?: {
5586
+ /** @description Shop Id */
5587
+ shop_id?: number;
5588
+ /** */
5589
+ assignment_mode?: "auto" | "manual";
5590
+ marketing_zones?: {
5591
+ /** @description Promoted product. */
5592
+ promotion?: "yes" | "no";
5593
+ /** @description Product on sale. */
5594
+ discount?: "yes" | "no";
5595
+ /** @description Distinguished product. */
5596
+ distinguished?: "yes" | "no";
5597
+ /** @description Special product. */
5598
+ special?: "yes" | "no";
5599
+ };
5600
+ }[];
5601
+ }[];
5602
+ /** */
5603
+ assignment_mode?: "auto" | "manual";
5604
+ marketing_zones?: {
5605
+ /** @description Promoted product. */
5606
+ promotion?: "yes" | "no";
5607
+ /** @description Product on sale. */
5608
+ discount?: "yes" | "no";
5609
+ /** @description Distinguished product. */
5610
+ distinguished?: "yes" | "no";
5611
+ /** @description Special product. */
5612
+ special?: "yes" | "no";
5613
+ };
5614
+ /** @description Marketing hotspots in shops */
5615
+ shops?: {
5616
+ /** @description Shop Id */
5617
+ shop_id?: number;
5618
+ /** */
5619
+ assignment_mode?: "auto" | "manual";
5620
+ marketing_zones?: {
5621
+ /** @description Promoted product. */
5622
+ promotion?: "yes" | "no";
5623
+ /** @description Product on sale. */
5624
+ discount?: "yes" | "no";
5625
+ /** @description Distinguished product. */
5626
+ distinguished?: "yes" | "no";
5627
+ /** @description Special product. */
5628
+ special?: "yes" | "no";
5629
+ };
5630
+ }[];
5631
+ };
5632
+
5633
+ export type PutProductsImagesParams = {
5634
+ productsImagesSettings?: {
5635
+ /** @description How to provide information about images of products. */
5636
+ productsImagesSourceType?: "base64" | "url";
5637
+ /** @description Whether images for products should be scalable. */
5638
+ productsImagesApplyMacro?: boolean;
5639
+ };
5640
+ /** @description Information on product images */
5641
+ productsImages: {
5642
+ productIdent: {
5643
+ /** @description ID value. */
5644
+ identValue?: string;
5645
+ /** @description Identifier type. */
5646
+ productIdentType?: "id" | "index" | "codeExtern" | "codeProducer";
5647
+ };
5648
+ /** @description Shop Id */
5649
+ shopId?: number;
5650
+ /** @description List of shops for which photos will be added (including shop provided in shopId). If parameter is empty or not provided, photos will be added to all shops. */
5651
+ otherShopsForPic?: number[];
5652
+ /** @description Product photos details. */
5653
+ productImages?: {
5654
+ /** @description Product photo. */
5655
+ productImageSource?: string;
5656
+ /** @description A product photo's number. */
5657
+ productImageNumber?: number;
5658
+ /** @description Picture priority */
5659
+ productImagePriority?: number;
5660
+ /** @description Flag marking if a picture should be deleted. */
5661
+ deleteProductImage?: boolean;
5662
+ }[];
5663
+ /** @description Product icons list. */
5664
+ productIcons?: {
5665
+ /** @description Photo in the goods list. */
5666
+ productIconSource?: string;
5667
+ /** @description Flag indicating whether to remove the product icon. */
5668
+ deleteProductIcon?: boolean;
5669
+ /** @description Icon type. */
5670
+ productIconType?: "shop" | "auction" | "group";
5671
+ }[];
5672
+ /** @description Product settings. */
5673
+ productImagesSettings?: {
5674
+ /** @description How to provide information about images of product. */
5675
+ productImagesSourceType?: "base64" | "url";
5676
+ /** @description Whether images for products should be scalable. */
5677
+ productImagesApplyMacro?: boolean;
5678
+ };
5679
+ }[];
5680
+ };
5681
+
5682
+ export type PutProductsSeriesParams = {
5683
+ /** @description Series list. */
5684
+ series: {
5685
+ /** @description Id */
5686
+ id: number;
5687
+ /** @description Name in panel */
5688
+ nameInPanel?: string;
5689
+ shopsConfigurations?: {
5690
+ /** @description Shop Id */
5691
+ shopId?: number;
5692
+ /** @description Customer language ID. */
5693
+ language?: string;
5694
+ /** @description Name on the page */
5695
+ nameOnPage?: string;
5696
+ /** @description Name displayed in the website header */
5697
+ headerName?: string;
5698
+ /** @description Description */
5699
+ description?: string;
5700
+ /** @description Products display settings */
5701
+ view?: "default" | "own";
5702
+ /** @description Enable customers to change sorting */
5703
+ enableSort?: boolean;
5704
+ /** @description Enable customers to change the number of products displayed */
5705
+ enableChangeDisplayCount?: boolean;
5706
+ /** @description Number of displayed products */
5707
+ numberOfProductsGrid?: number;
5708
+ /** @description Selected sorting mode */
5709
+ sortModeGrid?: "d_relevance" | "d_date" | "a_date" | "d_priority" | "a_priority" | "a_priorityname" | "d_priorityname" | "d_priorityonly" | "a_priorityonly" | "a_name" | "d_name" | "a_price" | "d_price";
5710
+ imagesConfiguration?: {
5711
+ /** @description Type of graphics */
5712
+ graphicType?: "img" | "img_rwd";
5713
+ /** @description Image (one size for computers, tablets and smartphones, not recommended) */
5714
+ singleGraphic?: string;
5715
+ /** @description Graphics for computer screens */
5716
+ pcGraphic?: string;
5717
+ /** @description Graphics for tablets */
5718
+ tabletGraphic?: string;
5719
+ /** @description Graphics for smartphones */
5720
+ phoneGraphic?: string;
5721
+ };
5722
+ /** @description Meta settings */
5723
+ metaSettings?: "auto" | "custom";
5724
+ /** @description Title */
5725
+ metaTitle?: string;
5726
+ /** @description Description */
5727
+ metaDescription?: string;
5728
+ /** @description Keywords */
5729
+ metaKeywords?: string;
5730
+ /** @description Meta robots settings for index attribute */
5731
+ metaRobotsSettingsIndex?: "auto" | "index" | "noindex";
5732
+ /** @description Meta robots settings for follow attribute */
5733
+ metaRobotsSettingsFollow?: "auto" | "follow" | "nofollow";
5734
+ }[];
5735
+ }[];
5736
+ };
5737
+
5738
+ export type PutProductsSizesParams = {
5739
+ /** @description Edition mode */
5740
+ mode?: "edit" | "add" | "replace";
5741
+ /** @description Product parameters recognized by product ID or its sizes */
5742
+ sizesProductsData: {
5743
+ /** @description Product IAI code */
5744
+ productId: number;
5745
+ /** @description List of sizes */
5746
+ sizes: {
5747
+ /** @description Size identifier */
5748
+ sizeId?: string;
5749
+ /** @description Size name */
5750
+ sizePanelName?: string;
5751
+ /** @description Parameters set for sizes. */
5752
+ sizeData?: {
5753
+ /** @description Weight. */
5754
+ productWeight?: number;
5755
+ /** @description Producer code */
5756
+ codeProducer?: string;
5757
+ /** @description External product system code for size. */
5758
+ productSizeCodeExternal?: string;
5759
+ /** @description Parameters set for shops */
5760
+ sitesData?: {
5761
+ /** @description Page ID */
5762
+ siteId?: number;
5763
+ /** @description Prices in shops */
5764
+ productPrices?: {
5765
+ /** @description Gross price */
5766
+ productRetailPrice?: number;
5767
+ /** @description Wholesale price */
5768
+ productWholesalePrice?: number;
5769
+ /** @description Minimal price */
5770
+ productMinimalPrice?: number;
5771
+ /** @description Recommended retail price */
5772
+ productSuggestedPrice?: number;
5773
+ };
5774
+ }[];
5775
+ };
5776
+ }[];
5777
+ }[];
5778
+ /** @description Product parameters recognized by index */
5779
+ indexesData?: {
5780
+ /** @description Product index. */
5781
+ sizeIndex?: string;
5782
+ /** @description Parameters set for sizes. */
5783
+ sizeData?: {
5784
+ /** @description Weight. */
5785
+ productWeight?: number;
5786
+ /** @description Producer code */
5787
+ codeProducer?: string;
5788
+ /** @description External product system code for size. */
5789
+ productSizeCodeExternal?: string;
5790
+ /** @description Parameters set for shops */
5791
+ sitesData?: {
5792
+ /** @description Page ID */
5793
+ siteId?: number;
5794
+ prices?: {
5795
+ /** @description Retail price */
5796
+ productPriceRetail?: number;
5797
+ /** @description Wholesale price */
5798
+ productPriceWholesale?: number;
5799
+ /** @description Minimal price for product. */
5800
+ productSearchPriceMin?: number;
5801
+ /** @description Recommended retail price */
5802
+ productPriceSuggested?: number;
5803
+ };
5804
+ }[];
5805
+ };
5806
+ }[];
5807
+ };
5808
+
5809
+ export type PutProductsStockQuantityParams = {
5810
+ /** @description Products list. */
5811
+ products: {
5812
+ /** @description Product index */
5813
+ productIndex?: string;
5814
+ /** @description Product size code producer */
5815
+ productSizeCodeProducer?: string;
5816
+ /** @description External product system code for size. */
5817
+ productSizeCodeExternal: string;
5818
+ /** @description Stock ID */
5819
+ stockId: number;
5820
+ /** @description Product stock quantity */
5821
+ productSizeQuantity?: number;
5822
+ /** @description Cost price */
5823
+ productPurchasePrice?: number;
5824
+ /** @description Net purchase price */
5825
+ productPurchasePriceNet?: number;
5826
+ }[];
5827
+ };
5828
+
5829
+ export type PutProductsStocksParams = {
5830
+ /** @description Products list. */
5831
+ products: {
5832
+ ident: {
5833
+ /** */
5834
+ identType?: "id" | "index" | "codeExtern" | "codeProducer";
5835
+ /** @description ID value. */
5836
+ identValue?: string;
5837
+ };
5838
+ /** @description List of sizes */
5839
+ sizes: {
5840
+ ident: {
5841
+ /** */
5842
+ identType?: "id" | "index" | "codeExtern" | "codeProducer";
5843
+ /** @description ID value. */
5844
+ identValue?: string;
5845
+ };
5846
+ /** @description Product quantity. */
5847
+ quantity?: {
5848
+ /** @description Stock operations. */
5849
+ stocks?: {
5850
+ /** @description Stock ID. */
5851
+ stock_id?: number;
5852
+ quantity_operation?: {
5853
+ /** @description Operation type. */
5854
+ operation?: "set" | "add" | "substract";
5855
+ /** @description Product quantity. */
5856
+ quantity?: number;
5857
+ };
5858
+ /** @description Warehouse location ID. */
5859
+ location_id?: number;
5860
+ /** @description Warehouse location full path. Use a backslash (\) as a separator, for example: M1\Section name\Location name. If location_id parameter is provided, the full warehouse location path will not be taken into account. */
5861
+ location_text_id?: string;
5862
+ /** @description Storage location code */
5863
+ location_code?: string;
5864
+ /** @description Additional locations. */
5865
+ additionalLocations?: {
5866
+ /** @description Element specifying the modification mode for additional locations. Available values: "add" - assignment of additional product location, "remove" - Remove the assignment of an additional location to the product. */
5867
+ additionalLocationSettings?: "add" | "remove";
5868
+ /** @description Warehouse location ID. */
5869
+ additionalLocationId?: number;
5870
+ /** @description Warehouse location full path. */
5871
+ additionalLocationTextId?: string;
5872
+ /** @description Storage location code */
5873
+ additionalLocationCode?: string;
5874
+ }[];
5875
+ }[];
5876
+ };
5877
+ }[];
5878
+ settings?: {
5879
+ productIndent?: {
5880
+ /** */
5881
+ identType?: "id" | "index" | "codeExtern" | "codeProducer";
5882
+ /** @description ID value. */
5883
+ identValue?: string;
5884
+ };
5885
+ sizesIndent?: {
5886
+ /** */
5887
+ identType?: "id" | "index" | "codeExtern" | "codeProducer";
5888
+ /** @description ID value. */
5889
+ identValue?: string;
5890
+ };
5891
+ };
5892
+ /** @description Error information. */
5893
+ error?: {
5894
+ /** @description Error code. */
5895
+ faultCode?: number;
5896
+ /** @description Error description. */
5897
+ faultString?: string;
5898
+ };
5899
+ }[];
5900
+ };
5901
+
5902
+ export type PutProductsSupplierCodeParams = {
5903
+ /** @description Products list. */
5904
+ products: {
5905
+ /** @description Product IAI code */
5906
+ productId: number;
5907
+ /** @description Suppliers data */
5908
+ productDeliverers: {
5909
+ /** @description Supplier ID. */
5910
+ delivererId?: number;
5911
+ /** @description Sizes available for products data. */
5912
+ productSizes?: {
5913
+ /** @description Size identifier */
5914
+ sizeId?: string;
5915
+ /** @description Supplier code for size */
5916
+ sizeDelivererCode?: string;
5917
+ }[];
5918
+ }[];
5919
+ }[];
5920
+ };
5921
+
5922
+ export type PutProductsMarketingPromotionParams = {
5923
+ /** @description Promotion ID */
5924
+ promotionId: string;
5925
+ /** @description Promotion name */
5926
+ promotionName?: string;
5927
+ /** @description List of stores IDs When mask is determined, this parameter is omitted. */
5928
+ shopsIds?: number[];
5929
+ /** @description Special zones */
5930
+ marketingZones?: {
5931
+ /** @description Reduced price */
5932
+ promotion?: "y" | "n";
5933
+ /** @description Sale */
5934
+ discount?: "y" | "n";
5935
+ /** @description Distinguished product */
5936
+ distinguished?: "y" | "n";
5937
+ /** @description Special product */
5938
+ special?: "y" | "n";
5939
+ /** @description New */
5940
+ new?: "y" | "n";
5941
+ };
5942
+ /** @description Promotional price settings */
5943
+ newPriceSettings?: {
5944
+ /** */
5945
+ type?: "retail" | "wholesale" | "pos";
5946
+ /** @description Discount value */
5947
+ discountValue?: number;
5948
+ /** @description ISO 4217 currency */
5949
+ currencyId?: string;
5950
+ /** @description Edition mode */
5951
+ mode?: "percent_diff" | "amount_diff" | "amount_set";
5952
+ /** @description Fractional price value */
5953
+ endValue?: string;
5954
+ };
5955
+ /** @description Promotion start date in Y-m-d H:i:s format */
5956
+ startDate?: string;
5957
+ /** @description Promotion end date in Y-m-d H:i:s format */
5958
+ endDate?: string;
5959
+ /** @description Change the status of hidden products to visible while starting the special offer */
5960
+ changeProductsToVisibleWhileStarting?: "y" | "n";
5961
+ /** @description After running out of stock, automatically remove from the promotion products added separately (does not apply to series, producers, categories and menu) */
5962
+ removeProductsAfterStockLevelRunsDown?: "y" | "n";
5963
+ /** @description After running out of own stock, automatically remove from the promotion products added separately (does not apply to series, producers, categories and menu) */
5964
+ removeProductsAfterOwnStockLevelRunsDown?: "y" | "n";
5965
+ /** @description Reduce based on price (net/gross) */
5966
+ reduceBasingPrice?: "net" | "gross";
5967
+ /** @description Price reduction calculation method */
5968
+ calculationMethod?: "sum" | "chooseAdvantageous";
5969
+ /** @description Specifies whether to remove all existing promotion elements */
5970
+ removeAllPromotionElements?: "y" | "n";
5971
+ /** @description Elements to be affected by the promotion */
5972
+ promotionElements?: {
5973
+ /** */
5974
+ elementType?: "product" | "series" | "producer" | "category" | "menu";
5975
+ /** @description Identifier of the element affected by the promotion (in the case of a menu in the format: storeId-menuId-itemId) */
5976
+ elementId?: string;
5977
+ }[];
5978
+ };
5979
+
5980
+ export type PutProductsOmnibusPricesParams = {
5981
+ /** @description Products list. */
5982
+ products: {
5983
+ /** @description Identifier type. */
5984
+ ident: {
5985
+ /** */
5986
+ type?: "id" | "index" | "codeExtern" | "codeProducer";
5987
+ /** @description Value. */
5988
+ value?: string;
5989
+ };
5990
+ /** @description List of sizes */
5991
+ sizes?: {
5992
+ /** @description Identifier type. */
5993
+ ident?: {
5994
+ /** */
5995
+ type?: "id" | "index" | "codeExtern" | "codeProducer";
5996
+ /** @description Value. */
5997
+ value?: string;
5998
+ };
5999
+ /** @description Strikethrough price settings. */
6000
+ omnibusPrices?: {
6001
+ /** @description How to manage the lowest price before promotion. */
6002
+ omnibusPriceManagement?: "automatic" | "manual";
6003
+ /** @description Lowest retail price before active promotion (gross). */
6004
+ omnibusPriceRetail?: number;
6005
+ /** @description Lowest wholesale price before active promotion (gross). */
6006
+ omnibusPriceWholesale?: number;
6007
+ };
6008
+ /** @description Strikethrough price settings for the page. */
6009
+ shops?: {
6010
+ /** @description Shop Id */
6011
+ shopId?: number;
6012
+ /** @description Strikethrough price settings. */
6013
+ omnibusPrices?: {
6014
+ /** @description How to manage the lowest price before promotion. */
6015
+ omnibusPriceManagement?: "automatic" | "manual";
6016
+ /** @description Lowest retail price before active promotion (gross). */
6017
+ omnibusPriceRetail?: number;
6018
+ /** @description Lowest wholesale price before active promotion (gross). */
6019
+ omnibusPriceWholesale?: number;
6020
+ };
6021
+ }[];
6022
+ }[];
6023
+ /** @description Strikethrough price settings. */
6024
+ omnibusPrices?: {
6025
+ /** @description How to manage the lowest price before promotion. */
6026
+ omnibusPriceManagement?: "automatic" | "manual";
6027
+ /** @description Lowest retail price before active promotion (gross). */
6028
+ omnibusPriceRetail?: number;
6029
+ /** @description Lowest wholesale price before active promotion (gross). */
6030
+ omnibusPriceWholesale?: number;
6031
+ };
6032
+ /** @description Strikethrough price settings for the page. */
6033
+ shops?: {
6034
+ /** @description Shop Id */
6035
+ shopId?: number;
6036
+ /** @description Strikethrough price settings. */
6037
+ omnibusPrices?: {
6038
+ /** @description How to manage the lowest price before promotion. */
6039
+ omnibusPriceManagement?: "automatic" | "manual";
6040
+ /** @description Lowest retail price before active promotion (gross). */
6041
+ omnibusPriceRetail?: number;
6042
+ /** @description Lowest wholesale price before active promotion (gross). */
6043
+ omnibusPriceWholesale?: number;
6044
+ };
6045
+ }[];
6046
+ }[];
6047
+ };
6048
+
6049
+ export type PutProductsQuestionsParams = {
6050
+ /** @description Question Board. */
6051
+ questions: {
6052
+ /** @description Question ID. */
6053
+ id?: number;
6054
+ /** @description Language of the question e.g. 'pol', 'eng'. */
6055
+ lang?: string;
6056
+ /** @description Your question(base64). */
6057
+ question?: string;
6058
+ /** @description Content of the answer(base64). */
6059
+ answer?: string;
6060
+ /** @description The date the question was created. */
6061
+ dateAdd?: string;
6062
+ /** @description The name and address of the host from which the question was added. */
6063
+ host?: string;
6064
+ /** @description Author. */
6065
+ author?: string;
6066
+ /** @description Stock keeping unit. */
6067
+ productIdent?: {
6068
+ /** @description Product IAI code */
6069
+ productId?: string;
6070
+ /** @description Identifier type. */
6071
+ productIdentType?: "id" | "codeExtern" | "codeProducer";
6072
+ };
6073
+ /** @description Visibility: "y" - yes, "n" - no */
6074
+ visible?: "n" | "y";
6075
+ /** @description Priority. */
6076
+ priority?: number;
6077
+ /** @description Validate the question: "y" - yes, "n" - no */
6078
+ confirmed?: "n" | "y";
6079
+ /** @description Shop Id */
6080
+ shopId?: number;
6081
+ /** @description Date of response. */
6082
+ answerDate?: string;
6083
+ /** @description Response author. */
6084
+ answerAuthor?: string;
6085
+ }[];
6086
+ };
6087
+
6088
+ export type PutProductsStrikethroughPricesParams = {
6089
+ /** @description Products list. */
6090
+ products: {
6091
+ /** @description Identifier type. */
6092
+ ident: {
6093
+ /** */
6094
+ type?: "id" | "index" | "codeExtern" | "codeProducer";
6095
+ /** @description Value. */
6096
+ value?: string;
6097
+ };
6098
+ /** @description List of sizes */
6099
+ sizes?: {
6100
+ /** @description Identifier type. */
6101
+ ident?: {
6102
+ /** */
6103
+ type?: "id" | "index" | "codeExtern" | "codeProducer";
6104
+ /** @description Value. */
6105
+ value?: string;
6106
+ };
6107
+ stp_settings?: {
6108
+ /** */
6109
+ price_change_mode?: "amount_set" | "amount_diff" | "percent_diff";
6110
+ /** */
6111
+ price_change_basevalue?: "price" | "price_minimal" | "price_pos" | "price_srp" | "price_crossed";
6112
+ /** @description Strikethrough retail price value change in relation to the starting price. */
6113
+ retail_price_change_value?: number;
6114
+ /** @description Strikethrough wholesale price value change in relation to the starting price. */
6115
+ wholesale_price_change_value?: number;
6116
+ };
6117
+ /** @description Strikethrough price settings for the page. */
6118
+ shops?: {
6119
+ /** @description Shop Id */
6120
+ shop_id?: number;
6121
+ stp_settings?: {
6122
+ /** */
6123
+ price_change_mode?: "amount_set" | "amount_diff" | "percent_diff";
6124
+ /** */
6125
+ price_change_basevalue?: "price" | "price_minimal" | "price_pos" | "price_srp" | "price_crossed";
6126
+ /** @description Strikethrough retail price value change in relation to the starting price. */
6127
+ retail_price_change_value?: number;
6128
+ /** @description Strikethrough wholesale price value change in relation to the starting price. */
6129
+ wholesale_price_change_value?: number;
6130
+ };
6131
+ }[];
6132
+ }[];
6133
+ stp_settings?: {
6134
+ /** */
6135
+ price_change_mode?: "amount_set" | "amount_diff" | "percent_diff";
6136
+ /** */
6137
+ price_change_basevalue?: "price" | "price_minimal" | "price_pos" | "price_srp" | "price_crossed";
6138
+ /** @description Strikethrough retail price value change in relation to the starting price. */
6139
+ retail_price_change_value?: number;
6140
+ /** @description Strikethrough wholesale price value change in relation to the starting price. */
6141
+ wholesale_price_change_value?: number;
6142
+ };
6143
+ /** @description Strikethrough price settings for the page. */
6144
+ shops?: {
6145
+ /** @description Shop Id */
6146
+ shop_id?: number;
6147
+ stp_settings?: {
6148
+ /** */
6149
+ price_change_mode?: "amount_set" | "amount_diff" | "percent_diff";
6150
+ /** */
6151
+ price_change_basevalue?: "price" | "price_minimal" | "price_pos" | "price_srp" | "price_crossed";
6152
+ /** @description Strikethrough retail price value change in relation to the starting price. */
6153
+ retail_price_change_value?: number;
6154
+ /** @description Strikethrough wholesale price value change in relation to the starting price. */
6155
+ wholesale_price_change_value?: number;
6156
+ };
6157
+ }[];
6158
+ }[];
6159
+ };
6160
+
6161
+ export type PutProductsSupplierProductDataParams = {
6162
+ /** @description Products list. */
6163
+ products: {
6164
+ /** @description Product IAI code */
6165
+ productId: number;
6166
+ /** @description Suppliers data */
6167
+ productDeliverers?: {
6168
+ /** @description Supplier ID. */
6169
+ delivererId?: number;
6170
+ /** @description Sizes available for products data. */
6171
+ productSizes?: {
6172
+ /** @description Size identifier */
6173
+ sizeId?: string;
6174
+ /** @description Supplier code */
6175
+ sizeDelivererCode?: string;
6176
+ /** @description Supplier's stock level */
6177
+ quantity?: number;
6178
+ /** @description Last purchase price */
6179
+ lastPrice?: number;
6180
+ /** @description Last net purchase price */
6181
+ lastPriceNet?: number;
6182
+ }[];
6183
+ /** @description #!UstawieniePozwalaWyzerowacStanyMagazynowegoDostawcyDlaWszystkichRozmiarowDanegoProduktu!# */
6184
+ clearAllQuantities?: boolean;
6185
+ }[];
6186
+ }[];
6187
+ };
6188
+
6189
+ export type PostOrdersDocumentsParams = {
6190
+ /** @description List of documents. */
6191
+ documents: {
6192
+ /** @description Order serial number. */
6193
+ orderSerialNumber: number;
6194
+ /** @description File name. */
6195
+ name: string;
6196
+ /** @description BMP, PNG, JPG, JPEG, GIF or PDF files in Base64 encoding algorithm. */
6197
+ pdfBase64?: string;
6198
+ /** @description Document type. */
6199
+ type?: "vat_invoice" | "corrective_vat_invoice" | "other";
6200
+ /** @description Is it to be shown to the customer in the order view. */
6201
+ returnedInOrderDetails?: "y" | "n";
6202
+ /** @description Additional information. */
6203
+ additionalData?: {
6204
+ /** @description Document number. */
6205
+ documentId?: string;
6206
+ /** @description The date document was issued in the ISO 8601 format (YYYY-MM-DD). */
6207
+ documentIssuedDate?: string;
6208
+ };
6209
+ }[];
6210
+ };
6211
+
6212
+ export type PostOrdersImagesParams = {
6213
+ /** @description Login */
6214
+ userName?: string;
6215
+ settings?: {
6216
+ /** @description Source type. Available values: base64 - Attachment data encoded using the base64 algorithm, url - Attachment file link */
6217
+ sourceType?: "base64" | "url";
6218
+ };
6219
+ order: {
6220
+ /** @description Order ID */
6221
+ orderId?: string;
6222
+ /** @description Order serial number */
6223
+ orderSerialNumber?: number;
6224
+ };
6225
+ /** @description List of image attachments */
6226
+ images: {
6227
+ /** @description Type. Available values: product - Product photo, package - Package photo */
6228
+ type?: "product" | "package";
6229
+ /** @description Attachment source data, depending on the source type selected in the settings. BMP, PNG, JPG, JPEG, GIF or PDF files in Base64 encoding algorithm. */
6230
+ source?: string;
6231
+ /** @description Name */
6232
+ name?: string;
6233
+ }[];
6234
+ };
6235
+
6236
+ export type PostOrdersPackagesParams = {
6237
+ /** @description List of parcels assigned to the order Maximum default number: 100 parcels. */
6238
+ orderPackages: {
6239
+ /** @description Id. */
6240
+ eventId: string;
6241
+ /** @description Type. */
6242
+ eventType: "order" | "rma" | "return";
6243
+ /** @description Information on consignments. */
6244
+ packages: {
6245
+ /** @description Shipment ID. */
6246
+ deliveryPackageId?: number;
6247
+ /** @description Courier ID. */
6248
+ courierId?: string;
6249
+ /** @description Package number. */
6250
+ deliveryPackageNumber?: string;
6251
+ /** @description consignment number. */
6252
+ deliveryShippingNumber?: string;
6253
+ /** @description Package parameters. */
6254
+ deliveryPackageParameters?: {
6255
+ /** @description Product weight (g). */
6256
+ productWeight?: number;
6257
+ /** @description Packaging weight (g). */
6258
+ packagingWeight?: number;
6259
+ };
6260
+ /** @description Cost for shop. */
6261
+ shippingStoreCosts?: {
6262
+ /** @description Value. */
6263
+ amount?: number;
6264
+ /** @description Value Added Tax. */
6265
+ tax?: number;
6266
+ };
6267
+ }[];
6268
+ }[];
6269
+ };
6270
+
6271
+ export type PostPackagesParams = {
6272
+ /** @description List of parcels assigned to the order Maximum default number: 100 parcels. */
6273
+ orderPackages: {
6274
+ /** @description Order ID. */
6275
+ orderId: string;
6276
+ /** @description Order type. Allowed values. "retail" - retail order, "wholesale" - wholesale order (can be added only by customer with wholesale account registered). Default value:: "retail" */
6277
+ orderType: "order" | "rma" | "return";
6278
+ /** @description Information on consignments. */
6279
+ packages: {
6280
+ /** @description Courier Id. */
6281
+ delivery?: number;
6282
+ /** @description Number of the parcel in the shipmnet given by the courier. Returned only if the courier supports parcel numbers */
6283
+ packageNumber?: string;
6284
+ /** @description Shipment number provided by the courier. Returned only if the courier supports tracking numbers */
6285
+ shippingNumber?: string;
6286
+ /** @description Package parameters (this option is temporarily unavailable). */
6287
+ packageParameters?: string;
6288
+ /** @description Cost for shop. */
6289
+ shippingStoreCosts?: {
6290
+ /** @description Value. */
6291
+ amount?: number;
6292
+ /** @description Value Added Tax. */
6293
+ tax?: number;
6294
+ };
6295
+ }[];
6296
+ }[];
6297
+ };
6298
+
6299
+ export type PostProductsProductsToFacebookCatalogParams = {
6300
+ /** @description You can read the Facebook Catalog ID in the Marketing & Integrations/Facebook/Facebook Product Catalog admin panel */
6301
+ facebookCatalogId?: number;
6302
+ /** @description Shop Id */
6303
+ shopId?: number;
6304
+ /** @description Products list. */
6305
+ products?: number[];
6306
+ };
6307
+
6308
+ export type PostProductsProductsToPromotionParams = {
6309
+ /** @description Special offer ID */
6310
+ promotionId?: number;
6311
+ /** @description Products list. */
6312
+ products?: number[];
6313
+ };
6314
+
6315
+ export type SearchProductsCategoriesIdosellParams = {
6316
+ /** @description List of languages */
6317
+ languagesIds?: ("pol" | "eng" | "ger")[];
6318
+ /** @description Number of IdoSell Categories identifiers */
6319
+ categoriesIdoSellIds?: string[];
6320
+ /** @description IdoSell Categories name list */
6321
+ categoriesIdoSellNames?: string[];
6322
+ /** @description IdoSell Categories path list */
6323
+ categoriesIdoSellPaths?: string[];
6324
+ /** @description Page with results number. Numeration starts from 0 */
6325
+ resultsPage?: number;
6326
+ /** @description Number of results on page. Value from 1 to 100 */
6327
+ resultsLimit?: number;
6328
+ };
6329
+
6330
+ export type PostClientsPricelistsParams = {
6331
+ /** @description Name of individual price list. */
6332
+ priceListName: string;
6333
+ /** @description Restrict visibility to products listed in price list (other products will remain hidden) - yes - no */
6334
+ onlyOrderProductsWithManuallySetPrices?: "yes" | "no";
6335
+ /** @description Restrict products visibility to products listed in price list, remaining products will be seen as "Call for price" - yes - no */
6336
+ onlySeeProductsWithManuallySetPrices?: "yes" | "no";
6337
+ };
6338
+
6339
+ export type PutClientsPricelistsParams = {
6340
+ /** @description Individual price list ID. */
6341
+ priceListId: number;
6342
+ /** @description Name of individual price list. */
6343
+ priceListName?: string;
6344
+ /** @description Restrict visibility to products listed in price list (other products will remain hidden) - yes - no */
6345
+ onlyOrderProductsWithManuallySetPrices?: "yes" | "no";
6346
+ /** @description Restrict products visibility to products listed in price list, remaining products will be seen as "Call for price" - yes - no */
6347
+ onlySeeProductsWithManuallySetPrices?: "yes" | "no";
6348
+ };
6349
+
6350
+ export type PutClientsPricelistsClientsParams = {
6351
+ /** @description Individual price list ID. */
6352
+ priceListId: number;
6353
+ /** @description Customer numbers. */
6354
+ clientsIds: number[];
6355
+ };
6356
+
6357
+ export type PutClientsPricelistsProductsParams = {
6358
+ /** @description Individual price list ID. */
6359
+ priceListId: number;
6360
+ /** @description Products list. */
6361
+ products?: {
6362
+ /** @description Product IAI code */
6363
+ productId?: number;
6364
+ /** @description Price. */
6365
+ price?: number;
6366
+ /** @description Currency ID */
6367
+ currencyId?: string;
6368
+ }[];
6369
+ /** @description List of manufacturers assigned to sought products. */
6370
+ producers?: {
6371
+ /** @description Brand ID */
6372
+ producerId?: number;
6373
+ /** @description Price. */
6374
+ price?: number;
6375
+ /** @description Currency ID */
6376
+ currencyId?: string;
6377
+ }[];
6378
+ /** @description Series list. */
6379
+ series?: {
6380
+ /** @description ID of series, to which product belongs. */
6381
+ seriesId?: number;
6382
+ /** @description Price. */
6383
+ price?: number;
6384
+ /** @description Currency ID */
6385
+ currencyId?: string;
6386
+ }[];
6387
+ /** @description List of categories in which sought products are present. */
6388
+ categories?: {
6389
+ /** @description Category id */
6390
+ categoryId?: number;
6391
+ /** @description Price. */
6392
+ price?: number;
6393
+ /** @description Currency ID */
6394
+ currencyId?: string;
6395
+ }[];
6396
+ menuItems?: {
6397
+ /** @description ID of the menu node to which the product is to be assigned */
6398
+ menuItemId?: number;
6399
+ /** @description Price. */
6400
+ price?: number;
6401
+ /** @description Currency ID */
6402
+ currencyId?: string;
6403
+ }[];
6404
+ };
6405
+
6406
+ export type PutClientsPricelistsRenameParams = {
6407
+ /** @description Name of individual price list. */
6408
+ priceListName?: string;
6409
+ /** @description Individual price list ID. */
6410
+ priceListId: number;
6411
+ };
6412
+
6413
+ export type PostClientsBalanceParams = {
6414
+ /** @description Unique client's number. */
6415
+ clientId: number;
6416
+ /** @description Operation: - add, - remove. */
6417
+ operation: string;
6418
+ /** @description Value to add or remove from balance. */
6419
+ balance: number;
6420
+ /** @description Currency of operation. */
6421
+ currency: string;
6422
+ /** @description Note. */
6423
+ note?: string;
6424
+ /** @description Order payment identifier. */
6425
+ prepaidId?: number;
6426
+ };
6427
+
6428
+ export type PostClientsGiftcardsParams = {
6429
+ /** @description List of cards to add */
6430
+ giftCards: {
6431
+ /** @description Gift card type id */
6432
+ typeId: number;
6433
+ /** @description Card number */
6434
+ number: string;
6435
+ /** @description Card PIN */
6436
+ pin: string;
6437
+ /** @description Name of card */
6438
+ name: string;
6439
+ /** @description Card expiration date */
6440
+ expirationDate?: string;
6441
+ /** @description Card balance */
6442
+ balance: {
6443
+ /** @description Available balance */
6444
+ amount?: number;
6445
+ /** @description Currency. */
6446
+ currency?: string;
6447
+ };
6448
+ /** @description List of shops the card is active in */
6449
+ shops: number[];
6450
+ /** @example note */
6451
+ note?: string;
6452
+ }[];
6453
+ };
6454
+
6455
+ export type PostClientsTagsParams = {
6456
+ params: {
6457
+ /** @description Unique client's number. */
6458
+ clientId: number;
6459
+ /** @description Tag name. */
6460
+ tagName: string;
6461
+ /** @description Tag value. */
6462
+ tagValue: number;
6463
+ }[];
6464
+ };
6465
+
6466
+ export type PostDeliveriesRegionsParams = {
6467
+ /** @description Name of the region in the panel */
6468
+ regionName?: string;
6469
+ /** @description Shop Id */
6470
+ shopId?: number;
6471
+ /** @description The range of postal codes from %s */
6472
+ postCodeFrom?: string;
6473
+ /** @description The range of postal codes to %s */
6474
+ postCodeTo?: string;
6475
+ /** @description ID of the country for which the region is being added */
6476
+ parentRegionId: number;
6477
+ };
6478
+
6479
+ export type PostDiscountsGroupsParams = {
6480
+ /** @description Discount group name */
6481
+ discountGroupName: string;
6482
+ };
6483
+
6484
+ export type PostDiscountsRebatesCardParams = {
6485
+ /** @description Discount card type */
6486
+ campaign_id: number;
6487
+ /** @description Card number */
6488
+ card_number: string;
6489
+ };
6490
+
6491
+ export type PostDiscountsRebatesCodeParams = {
6492
+ /** @description Campaign ID */
6493
+ campaign_id: number;
6494
+ /** @description Code */
6495
+ code_number: string;
6496
+ };
6497
+
6498
+ export type PutClientsExternalCodeParams = {
6499
+ /** @example 1 */
6500
+ client_id?: number;
6501
+ /** @description Customer's login. */
6502
+ client_login?: string;
6503
+ /** @description External system code. */
6504
+ code_extern?: string;
6505
+ };
6506
+
6507
+ export type PutClientsGiftcardsParams = {
6508
+ /** @description List of cards to edit */
6509
+ giftCards: {
6510
+ /** @description Card ID */
6511
+ id?: number;
6512
+ /** @description Card number */
6513
+ number?: string;
6514
+ /** @description Card PIN */
6515
+ pin?: string;
6516
+ /** @description Name of card */
6517
+ name?: string;
6518
+ /** @description Card expiration date */
6519
+ expirationDate?: string;
6520
+ /** @description Balance operation type, possible values: - set - balance positioning of funds, - add - add funds to balance, - subtract - subtract funds from balance. */
6521
+ balanceOperationType?: "set" | "add" | "subtract";
6522
+ /** @description Card balance */
6523
+ balance?: {
6524
+ /** @description Available balance */
6525
+ amount?: number;
6526
+ /** @description Currency ID */
6527
+ currency?: string;
6528
+ };
6529
+ /** @description List of shops the card is active in */
6530
+ shops?: number[];
6531
+ /** @example note */
6532
+ note?: string;
6533
+ }[];
6534
+ };
6535
+
6536
+ export type PutClientsGiftcardsBlockParams = {
6537
+ /** @description List of gift cards */
6538
+ giftCards: {
6539
+ /** @description Card ID */
6540
+ id?: number;
6541
+ /** @description Card number */
6542
+ number?: string;
6543
+ }[];
6544
+ };
6545
+
6546
+ export type PutClientsGiftcardsUnblockParams = {
6547
+ /** @description List of gift cards */
6548
+ giftCards: {
6549
+ /** @description Card ID */
6550
+ id?: number;
6551
+ /** @description Card number */
6552
+ number?: string;
6553
+ }[];
6554
+ };
6555
+
6556
+ export type PutClientsMembershipCardsParams = {
6557
+ /** @description Customer ID. */
6558
+ id?: number;
6559
+ /** @description Customer's login. */
6560
+ login?: string;
6561
+ membership_cards: {
6562
+ /** @description Card ID entered by customer. */
6563
+ ordinal_number?: number;
6564
+ /** @description Card ID. */
6565
+ card_type?: number;
6566
+ /** @description Loyalty card number. */
6567
+ number?: string;
6568
+ /** @description Card PIN. */
6569
+ pin?: number;
6570
+ /** @description Issue date. */
6571
+ creation_date?: string;
6572
+ /** @description Determines whether a card should be deactivated. */
6573
+ deactivate?: boolean;
6574
+ /** @description Flag that determines whether a discount group should be set. */
6575
+ set_rebate_group?: boolean;
6576
+ /** @description Information on error that occurred during gate call. */
6577
+ errors?: {
6578
+ /** @description Error code. List of error codes: 0 - Operation was successful, 1 - Login failure: invalid username or key, 2 - Empty result, 3 - No parameters were received, 4 - Shop has been blocked due to number of overdue invoices owed to IAI Company */
6579
+ faultCode?: number;
6580
+ /** @description Error description. */
6581
+ faultString?: string;
6582
+ };
6583
+ }[];
6584
+ };
6585
+
6586
+ export type PutClientsPricesDiscountsParams = {
6587
+ customers?: {
6588
+ customers_numbers?: number[];
6589
+ };
6590
+ /** @description Discount type, possible values: - simple */
6591
+ discount_type?: string;
6592
+ /** @description Action, possible values: - sum_with_other_discounts_to_orders - sum with other discounts assigned to orders, - use_only_if_greater_than_the_sum_of_other_discounts - use only if greater than the sum of other discounts */
6593
+ discount_operating?: string;
6594
+ discount_parameters: {
6595
+ /** @description Parameter type. - DEPRECATED */
6596
+ parameter_type?: string;
6597
+ /** @description Parameter text ID. - DEPRECATED */
6598
+ parameter_value?: string;
6599
+ /** Format: decimal
6600
+ * @description Size of discount. */
6601
+ discount_value?: number;
6602
+ }[];
6603
+ };
6604
+
6605
+ export type PutClientsTagsParams = {
6606
+ /** @description Unique client's number. */
6607
+ clientId?: number;
6608
+ clientTags: {
6609
+ /** @description Tag ID. */
6610
+ tagId?: number;
6611
+ /** */
6612
+ operation?: "add" | "set" | "subtract";
6613
+ /** @description Tag value. */
6614
+ tagValue?: number;
6615
+ }[];
6616
+ };
6617
+
6618
+ export type PutPackagesParams = {
6619
+ /** @description List of parcels assigned to the order Maximum default number: 100 parcels. */
6620
+ orderPackages: {
6621
+ /** @description Order ID. */
6622
+ orderId?: string;
6623
+ /** @description Order type. Allowed values. "retail" - retail order, "wholesale" - wholesale order (can be added only by customer with wholesale account registered). Default value:: "retail" */
6624
+ orderType?: "order" | "rma" | "return";
6625
+ /** @description Information on consignments. */
6626
+ packages?: {
6627
+ /** @description Package ID in system. */
6628
+ packageId?: number;
6629
+ /** @description Courier Id. */
6630
+ delivery?: number;
6631
+ /** @description Number of the parcel in the shipmnet given by the courier. Returned only if the courier supports parcel numbers */
6632
+ packageNumber?: string;
6633
+ /** @description Shipment number provided by the courier. Returned only if the courier supports tracking numbers */
6634
+ shippingNumber?: string;
6635
+ /** @description Package parameters (this option is temporarily unavailable). */
6636
+ packageParameters?: string;
6637
+ /** @description Cost for shop. */
6638
+ shippingStoreCosts?: {
6639
+ /** @description Value. */
6640
+ amount?: number;
6641
+ /** @description Value Added Tax. */
6642
+ tax?: number;
6643
+ };
6644
+ }[];
6645
+ }[];
6646
+ };
6647
+
6648
+ export type PostClientsProfitPointsParams = {
6649
+ /** @example 1 */
6650
+ client_id: number;
6651
+ /** @description Operation: - add, - remove. */
6652
+ operation: string;
6653
+ /** @description Amount of points to add or subtract. */
6654
+ score: number;
6655
+ /** @example note */
6656
+ note?: string;
6657
+ /** @description Prepayment ID. */
6658
+ order_number?: number;
6659
+ };
6660
+
6661
+ export type PutDiscountsGroupsParams = {
6662
+ /** @description Discount group ID */
6663
+ discountGroupId: number;
6664
+ /** @description Discount group name */
6665
+ discountGroupName: string;
6666
+ };
6667
+
6668
+ export type PutDiscountsRebatesBlockCardParams = {
6669
+ /** @description Card number */
6670
+ card_number: string;
6671
+ };
6672
+
6673
+ export type PutDiscountsRebatesUnblockCardParams = {
6674
+ /** @description Card number */
6675
+ card_number: string;
6676
+ };
6677
+
6678
+ export type PutOrdersClientParams = {
6679
+ /** @description Order serial number. */
6680
+ orderSerialNumber?: number;
6681
+ /** @description Unique client's number. */
6682
+ clientId?: number;
6683
+ };
6684
+
6685
+ export type PutOrdersCourierParams = {
6686
+ /** @description Order serial number. */
6687
+ orderSerialNumber: number;
6688
+ /** @description Courier ID. */
6689
+ courierId: number;
6690
+ /** @description Collection point ID. */
6691
+ pickupPointId?: string;
6692
+ };
6693
+
6694
+ export type PutOrdersDeliveryAddressParams = {
6695
+ /** @description Order serial number. */
6696
+ orderSerialNumber: number;
6697
+ /** @description Delivery address ID. */
6698
+ clientDeliveryAddressId: number;
6699
+ /** @description Customer's login. */
6700
+ clientLogin: string;
6701
+ };
6702
+
6703
+ export type PutOrdersHandlerParams = {
6704
+ /** @description Order serial number. */
6705
+ orderSerialNumber: number;
6706
+ /** @description Order handler. */
6707
+ orderOperatorLogin: string;
6708
+ };
6709
+
6710
+ export type PutOrdersPackagesParams = {
6711
+ /** @description List of parcels assigned to the order Maximum default number: 100 parcels. */
6712
+ orderPackages: {
6713
+ /** @description Id. */
6714
+ eventId: string;
6715
+ /** @description Type. */
6716
+ eventType: "order" | "rma" | "return";
6717
+ /** @description Information on consignments. */
6718
+ packages?: {
6719
+ /** @description Shipment ID. */
6720
+ deliveryPackageId?: number;
6721
+ /** @description Courier ID. */
6722
+ courierId?: string;
6723
+ /** @description Package number. */
6724
+ deliveryPackageNumber?: string;
6725
+ /** @description consignment number. */
6726
+ deliveryShippingNumber?: string;
6727
+ /** @description Package parameters. */
6728
+ deliveryPackageParameters?: {
6729
+ /** @description Product weight (g). */
6730
+ productWeight?: number;
6731
+ /** @description Packaging weight (g). */
6732
+ packagingWeight?: number;
6733
+ };
6734
+ /** @description Cost for shop. */
6735
+ shippingStoreCosts?: {
6736
+ /** @description Value. */
6737
+ amount?: number;
6738
+ /** @description Value Added Tax. */
6739
+ tax?: number;
6740
+ };
6741
+ }[];
6742
+ }[];
6743
+ };
6744
+
6745
+ export type PutVouchersUnblockParams = {
6746
+ vouchers: {
6747
+ /** @description Voucher ID */
6748
+ id?: number;
6749
+ /** @description Number. */
6750
+ number?: string;
6751
+ }[];
6752
+ };
6753
+
6754
+ export type PutVouchersBlockParams = {
6755
+ vouchers: {
6756
+ /** @description Voucher ID */
6757
+ id?: number;
6758
+ /** @description Number. */
6759
+ number?: string;
6760
+ }[];
6761
+ };
6762
+
6763
+ export type PutProductsGroupsSettingsParams = {
6764
+ groups: {
6765
+ productIdent: {
6766
+ /** @description Identifier type. */
6767
+ productIdentType?: "id" | "index" | "codeExtern" | "codeProducer";
6768
+ /** @description ID value. */
6769
+ identValue?: string;
6770
+ };
6771
+ /** @description Display on the product list in the panel. */
6772
+ displayInPanel?: "firstAvailable" | "all";
6773
+ /** @description Display on a product list on the page. */
6774
+ displayOnPage?: "firstAvailable" | "all" | "specified";
6775
+ /** @description Selected product in the group. */
6776
+ specifiedProductIdent?: {
6777
+ /** @description Identifier type. */
6778
+ productIdentType?: "id" | "index" | "codeExtern" | "codeProducer";
6779
+ /** @description ID value. */
6780
+ identValue?: string;
6781
+ };
6782
+ }[];
6783
+ };
6784
+
6785
+ export type PutOrdersWarehouseParams = {
6786
+ /** @description Order serial number. */
6787
+ orderSerialNumber: number;
6788
+ /** @description Stock ID */
6789
+ stockId: number;
6790
+ /** @description Order handler. */
6791
+ orderOperatorLogin?: string;
6792
+ /** @description External warehouse ID (if required) */
6793
+ externalStockId?: "amazonde" | "amazones" | "amazonfr" | "amazonit" | "amazoncouk" | "amazonnl" | "amazonse" | "amazoncomtr" | "amazonae" | "amazonus" | "amazonpl";
6794
+ };
6795
+
6796
+ export type PutOrdersShippingCostsParams = {
6797
+ /** @description Order serial number. */
6798
+ orderSerialNumber: number;
6799
+ /** @description Delivery cost. */
6800
+ deliveryCost: number;
6801
+ /** @description Delivery VAT. */
6802
+ orderDeliveryVat?: number;
6803
+ };
6804
+
6805
+ export type PutOrdersProfitMarginParams = {
6806
+ /** @description Orders. */
6807
+ orders: {
6808
+ /** @description Order serial number. */
6809
+ orderSerialNumber?: number;
6810
+ /** @description Products list. */
6811
+ products?: {
6812
+ productIdent?: {
6813
+ /** @description ID value. */
6814
+ identValue?: string;
6815
+ /** @description Identifier type. */
6816
+ productIdentType?: "id" | "index" | "codeExtern";
6817
+ };
6818
+ /** @description Size identifier */
6819
+ sizeId?: string;
6820
+ /** @description Product profit margin gross. */
6821
+ productProfitMargin?: number;
6822
+ /** @description Product profit margin net. */
6823
+ productProfitMarginNet?: number;
6824
+ /** @description Information on error that occurred during gate call. */
6825
+ errors?: {
6826
+ /** @description Error code. */
6827
+ faultCode?: number;
6828
+ /** @description Error description. */
6829
+ faultString?: string;
6830
+ };
6831
+ }[];
6832
+ /** @description Information on error that occurred during gate call. */
6833
+ errors?: {
6834
+ /** @description Error code. */
6835
+ faultCode?: number;
6836
+ /** @description Error description. */
6837
+ faultString?: string;
6838
+ };
6839
+ /** @description Flag marking errors in the result. */
6840
+ isProductsErrors?: boolean;
6841
+ }[];
6842
+ };
6843
+
6844
+ export type PutOrdersPickupPointParams = {
6845
+ /** @description Order serial number. */
6846
+ orderSerialNumber: number;
6847
+ /** @description Collection point ID. */
6848
+ pickupPointId: string;
6849
+ };
6850
+
6851
+ export type PutDiscountsGroupsProductsParams = {
6852
+ /** @description Discount group ID */
6853
+ discountGroupId: number;
6854
+ /** @description Products list. */
6855
+ products?: {
6856
+ /** @description ID */
6857
+ id?: number;
6858
+ /** @description Price */
6859
+ price?: number;
6860
+ /** @description Currency. */
6861
+ currency?: string;
6862
+ }[];
6863
+ /** @description Brands */
6864
+ producers?: {
6865
+ /** @description ID */
6866
+ id?: number;
6867
+ /** @description Price */
6868
+ price?: number;
6869
+ /** @description Currency. */
6870
+ currency?: string;
6871
+ }[];
6872
+ /** @description Series */
6873
+ series?: {
6874
+ /** @description ID */
6875
+ id?: number;
6876
+ /** @description Price */
6877
+ price?: number;
6878
+ /** @description Currency. */
6879
+ currency?: string;
6880
+ }[];
6881
+ /** @description List of categories in which sought products are present. */
6882
+ categories?: {
6883
+ /** @description ID */
6884
+ id?: number;
6885
+ /** @description Price */
6886
+ price?: number;
6887
+ /** @description Currency. */
6888
+ currency?: string;
6889
+ }[];
6890
+ /** @description Menu elements */
6891
+ menuItems?: {
6892
+ /** @description ID */
6893
+ id?: number;
6894
+ /** @description Price */
6895
+ price?: number;
6896
+ /** @description Currency. */
6897
+ currency?: string;
6898
+ }[];
6899
+ };
6900
+
6901
+ export type PutOrdersProductsSerialNumbersParams = {
6902
+ /** @description Orders. */
6903
+ orders: {
6904
+ /** @description Order serial number. */
6905
+ orderSerialNumber: number;
6906
+ /** @description Products list. */
6907
+ orderProducts: {
6908
+ /** @description Product IAI code */
6909
+ productId?: number;
6910
+ /** @description Size identifier */
6911
+ sizeId?: string;
6912
+ /** @description Serial numbers. */
6913
+ productSerialNumbers?: string[];
6914
+ }[];
6915
+ }[];
6916
+ };
6917
+
6918
+ export type PutProductsGroupsOrderParams = {
6919
+ groups: {
6920
+ productsInOrder: {
6921
+ productIdent?: {
6922
+ /** @description Identifier type. */
6923
+ productIdentType?: "id" | "index" | "codeExtern" | "codeProducer";
6924
+ /** @description ID value. */
6925
+ identValue?: string;
6926
+ };
6927
+ /** @description The order of products in the group. Value needs to be more than 0. */
6928
+ priority?: number;
6929
+ }[];
6930
+ }[];
6931
+ };
6932
+
6933
+ export type PostPaymentsCancelParams = {
6934
+ /** @description Defines payment category. For the payments regarding returns, enter 'return'. */
6935
+ sourceType: "order" | "return" | "rma";
6936
+ /** @description Payment number - [order no.]-[payment no.], i.e. 1234-1. */
6937
+ paymentNumber: string;
6938
+ };
6939
+
6940
+ export type PutPaymentsConfirmParams = {
6941
+ /** @description Defines payment category. For the payments regarding returns, enter 'return'. */
6942
+ sourceType: "order" | "return" | "rma";
6943
+ /** @description Payment number - [order no.]-[payment no.], i.e. 1234-1. */
6944
+ paymentNumber: string;
6945
+ /** @description Registering date */
6946
+ accountingDate?: string;
6947
+ };
6948
+
6949
+ export type PutConfigVariablesParams = {
6950
+ variables: ({
6951
+ /** @description Key of config value. */
6952
+ key: string;
6953
+ /** @description Name of config item. */
6954
+ readonly name?: string;
6955
+ /** @description Value of config item. */
6956
+ value?: string;
6957
+ } & {
6958
+ /** @description The type of module for which the configuration is used */
6959
+ type: "snippets_campaign";
6960
+ /** @description Identifier of the item in used module */
6961
+ itemId: number;
6962
+ /** @description Name of config item. */
6963
+ name?: string;
6964
+ })[];
6965
+ };
6966
+
6967
+ export type PutMenuSortParams = {
6968
+ menu_list: {
6969
+ /** @description Shop Id. */
6970
+ shop_id: number;
6971
+ /** @description Menu ID. */
6972
+ menu_id: number;
6973
+ /** @description Language ID. */
6974
+ lang_id: string;
6975
+ /** @description Menu element text identifier. */
6976
+ parent_id?: number;
6977
+ /** @description Menu element text identifier. Example: "item1\item2\item3". */
6978
+ parent_textid?: string;
6979
+ /** @description Recurring: y/n! */
6980
+ recursive?: "y" | "n";
6981
+ }[];
6982
+ /** @description Settings */
6983
+ settings?: {
6984
+ /** @description Default: "\". */
6985
+ textid_separator?: string;
6986
+ };
6987
+ };
6988
+
6989
+ export type PutSystemConfigParams = {
6990
+ /** @description Panel settings */
6991
+ panelSettings: {
6992
+ /** @description The main warehouse and sales system */
6993
+ mainStockSystem?: "other" | "iai";
6994
+ /** @description Stock quantities in third party application */
6995
+ stockStateConfig?: "uncontrolled" | "bridge" | "outside";
6996
+ /** @description Fiscal and settlement settings */
6997
+ taxSettings?: {
6998
+ /** @description Sales date settings on sales documents for prepaid orders */
6999
+ saleDatePrepaid?: "saleDateFromOrder" | "saleDateFromPayment" | "saleDateFromDocument";
7000
+ /** @description Sales date settings on sales documents for orders paid with cash on delivery */
7001
+ saleDateCashOnDelivery?: "saleDateFromOrder" | "saleDateFromPayment" | "saleDateFromDocument";
7002
+ /** @description Sales date settings on sales documents for orders paid with trade credit */
7003
+ saleDateTradeCredit?: "saleDateFromOrder" | "saleDateFromPayment" | "saleDateFromDocument";
7004
+ /** @description Configuration of default currency rate for orders */
7005
+ currencyRate?: "currentDay" | "previousDay";
7006
+ };
7007
+ shops?: {
7008
+ /** @description Shop Id */
7009
+ shopId?: number;
7010
+ /** @description Sales documents in third party application. */
7011
+ salesDocumentsAreCreatedByClient?: "y" | "n";
7012
+ }[];
7013
+ };
7014
+ };
7015
+
7016
+ export type PutSystemProcessesAutomationParams = {
7017
+ /** @description Shop Id */
7018
+ shopId?: number;
7019
+ /** @description Orders. */
7020
+ orders: {
7021
+ /** @description Allow the status to be changed to "Shipped" even if the order payments and stock levels do not match */
7022
+ alwaysAllowSentStatus?: "y" | "n";
7023
+ /** @description Order management restrictions */
7024
+ restrictions?: {
7025
+ /** @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. */
7026
+ blockIfIncorrectStockQuantities?: {
7027
+ /** */
7028
+ finished?: "y" | "n";
7029
+ };
7030
+ };
7031
+ };
7032
+ };
7033
+
7034
+ export type PutWarrantiesLanguageDataParams = {
7035
+ lang_data: {
7036
+ /** @description Warranty ID (numeric or text based). */
7037
+ warranty_id: string;
7038
+ lang: {
7039
+ /** @description Warranty language id (numeric) (three letter sequence). */
7040
+ lang_id?: string;
7041
+ /** @description Warranty name. */
7042
+ name?: string;
7043
+ /** @description warranty icon for language. */
7044
+ icon?: string;
7045
+ icon_settings?: {
7046
+ /** */
7047
+ format?: "jpg" | "gif" | "png";
7048
+ /** */
7049
+ data_type?: "url" | "base64";
7050
+ };
7051
+ /** @description Warranty description. */
7052
+ description?: string;
7053
+ }[];
7054
+ }[];
7055
+ };
7056
+
7057
+ export type PutDeliveriesDefaultProfilesParams = {
7058
+ /** @description Country ID */
7059
+ regionId: number;
7060
+ /** @description Shop Id */
7061
+ shopId: number;
7062
+ /** @description ID of delivery profile for retail sales */
7063
+ retailProfileId?: number;
7064
+ /** @description ID of delivery profile for wholesale sales */
7065
+ wholesaleProfileId?: number;
7066
+ };
7067
+
7068
+ export type PutReturnsSerialNumberParams = {
7069
+ /** @description Return number. */
7070
+ return_id: number;
7071
+ /** @description Products list. */
7072
+ products: {
7073
+ /** @description Product ID. */
7074
+ id?: number;
7075
+ /** @description Size ID. */
7076
+ size: string;
7077
+ serialNumbers: string[];
7078
+ }[];
7079
+ };
7080
+
7081
+ export type PutWmsStocksdocumentsDocumentsParams = {
7082
+ /** @description Document identifier. */
7083
+ stockDocumentId: number;
7084
+ /** @description Document type. Available values: "pz" - goods received note (GRN), "pw" - internal delivery note (IDN), "px" - goods received correction note (GRX), "rx" - goods despatch note (GRN) , "rw" - goods issued note (GIN), "mm" - inter-warehouse transfer. */
7085
+ stockDocumentType: "pz" | "pw" | "px" | "rx" | "rw" | "mm";
7086
+ /** @description Number of purchase document */
7087
+ stockDocumentNumber?: string;
7088
+ /** @description Target warehouse ID. The list of available warehouses can be downloaded via the method <a href = "en/shop/api/?action=method&function=systemconfig&method=get">#get</a> in gateway <a href = "en/shop/api/?action=documentation&function=systemconfig">SystemConfig</a>. */
7089
+ stockId?: number;
7090
+ /** @description Source warehouse ID. The list of available warehouses can be downloaded via the method <a href = "en/shop/api/?action=method&function=systemconfig&method=get">#get</a> in gateway <a href = "en/shop/api/?action=documentation&function=systemconfig">SystemConfig</a>. */
7091
+ stockSourceId?: number;
7092
+ /** @example note */
7093
+ note?: string;
7094
+ /** @description Products available in presales. Available values: "y" - yes, "n" - no. */
7095
+ productsInPreorder?: "y" | "n";
7096
+ /** @description Supplier ID. */
7097
+ delivererId?: number;
7098
+ /** @description Type of purchase document. Available values: "national_VAT_invoice" - National VAT invoice, "other_purchase_document" - Other purchase document, "invoice_without_VAT" - Invoice without VAT (EU), "imports_from_outside_the_EU" - Import from outside EU. */
7099
+ wnt?: "national_VAT_invoice" | "other_purchase_document" | "invoice_without_VAT" | "imports_from_outside_the_EU";
7100
+ /** @description Issue date of purchase document. Correct format is yyyy-mm-dd, e.g. 2007-12-31.. */
7101
+ saleDocumentCreationDate?: string;
7102
+ /** @description Planned date of acceptance of delivery. Correct format is yyyy-mm-dd, e.g. 2007-12-31. Requires parameter: "confirmed=on_the_way". */
7103
+ deliveryOnTheWayPlannedDeliveryDate?: string;
7104
+ /** @description Document status. Available values: "open" - open, "on_the_way" - on the way. */
7105
+ confirmed?: "open" | "on_the_way";
7106
+ /** @description Purchase price currency, e.g. PLN, USD, GBP */
7107
+ currencyForPurchasePrice?: string;
7108
+ /** @description Currency exchange rate (Currency conversion) */
7109
+ currencyForPurchasePriceRate?: number;
7110
+ /** @description Type of currency rate. Available values: "custom" - not typical, "currentDay" - the currency rate from the day of issuing a stock document, "customDay" - on a selected day, "previousDay" - the currency rate of a working day preceding the date of the stock document issue. */
7111
+ currencyForPurchasePriceRateType?: "custom" | "currentDay" | "customDay" | "previousDay";
7112
+ /** @description Currency rate of the day. Correct format is yyyy-mm-dd, e.g. 2007-12-31.. */
7113
+ currencyForPurchasePriceRateDate?: string;
7114
+ /** @description Settlement by prices. Available values: "brutto" - Gross value, "netto" - Net value. */
7115
+ priceType?: "brutto" | "netto";
7116
+ /** @description Methods of stock level correction. Available values: "fifo" - first-in, first-out (FIFO), "lifo" - last-in, first-out (LIFO). */
7117
+ queueType?: "fifo" | "lifo";
7118
+ /** @description Verification date */
7119
+ verificationDate?: string;
7120
+ /** @description Users verification */
7121
+ verificationUser?: string;
7122
+ };
7123
+
7124
+ export type PutWmsStocksdocumentsCloseParams = {
7125
+ /** */
7126
+ type: "pz" | "pw" | "px" | "rx" | "rw" | "mm";
7127
+ /** @description Document identifier. */
7128
+ id: number;
7129
+ };
7130
+
7131
+ export type PutWmsStocksdocumentsRejectMMParams = {
7132
+ /** @description Document identifier. */
7133
+ id: number;
7134
+ };
7135
+
7136
+ export type PutWmsStocksdocumentsAcceptMMParams = {
7137
+ /** @description Document identifier. */
7138
+ id: number;
7139
+ };
7140
+
3870
7141
  export { };