idosell 0.3.20 → 0.4.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/changelog.md +6 -0
- package/dist/app.d.ts +5 -5
- package/dist/gateways.d.ts +330 -329
- package/dist/index.js +3 -3
- package/dist/methods/getEntries.js +1 -0
- package/dist/methods/putProductsAttachments.js +1 -0
- package/dist/reqparams.d.ts +3870 -0
- package/dist/responses.d.ts +993 -51
- package/package.json +3 -2
- package/tests/getEntries.test.js +2 -7
- package/tests/getOrdersAuctionDetails.test.js +1 -1
- package/tests/postOrdersDocumentsCreate.test.js +2 -2
- package/tests/putProductsAttachments.test.js +2 -2
|
@@ -0,0 +1,3870 @@
|
|
|
1
|
+
export type PostOrdersParams = {
|
|
2
|
+
/** @description Orders. */
|
|
3
|
+
orders: {
|
|
4
|
+
/** @description Order type. Allowed values. "retail" - retail order, "wholesale" - wholesale order (can be added only by customer with wholesale account registered). Default value:: "retail" */
|
|
5
|
+
orderType?: string;
|
|
6
|
+
/** @description Shop Id */
|
|
7
|
+
shopId?: number;
|
|
8
|
+
/** @description Stock ID */
|
|
9
|
+
stockId: number;
|
|
10
|
+
/** @description Order payment method. Allowed values. "cash_on_delivery" - cash on delivery, "prepaid" - prepayment, "tradecredit" - Trade credit. */
|
|
11
|
+
orderPaymentType: "cash_on_delivery" | "prepaid" | "tradecredit";
|
|
12
|
+
/** @description Currency ID */
|
|
13
|
+
currencyId: string;
|
|
14
|
+
/** @description Determines if customer unregistered. Allowed values. "y" - casual client, "n" - registered customer. Default value:: "y". If customer is unregistered, enter customer details in element: "clientWithoutAccountData". For client with account - existing login should be stored in: "clientLogin". */
|
|
15
|
+
clientWithoutAccount: string;
|
|
16
|
+
/** @description Balance data for casual client. Object is necessary for casual clients (in case of client_once has y value). */
|
|
17
|
+
clientWithoutAccountData?: {
|
|
18
|
+
/** @description Customer's first name. */
|
|
19
|
+
clientFirstName?: string;
|
|
20
|
+
/** @description Customer's last name. */
|
|
21
|
+
clientLastName?: string;
|
|
22
|
+
/** @description Customer's company name. */
|
|
23
|
+
clientFirm?: string;
|
|
24
|
+
/** @description Customer Tax no. */
|
|
25
|
+
clientNip?: string;
|
|
26
|
+
/** @description Street and number. */
|
|
27
|
+
clientStreet?: string;
|
|
28
|
+
/** @description Customer's postal code. */
|
|
29
|
+
clientZipCode?: string;
|
|
30
|
+
/** @description Customer's city. */
|
|
31
|
+
clientCity?: string;
|
|
32
|
+
/** @description Customer's country. */
|
|
33
|
+
clientCountry?: string;
|
|
34
|
+
/** @description E-mail address. */
|
|
35
|
+
clientEmail?: string;
|
|
36
|
+
/** @description Cell phone. */
|
|
37
|
+
clientPhone1?: string;
|
|
38
|
+
/** @description Land line. */
|
|
39
|
+
clientPhone2?: string;
|
|
40
|
+
/** @description Language ID */
|
|
41
|
+
langId?: string;
|
|
42
|
+
};
|
|
43
|
+
/** @description Customer's login. */
|
|
44
|
+
clientLogin?: string;
|
|
45
|
+
/** @description Customer comments on order. */
|
|
46
|
+
clientNoteToOrder?: string;
|
|
47
|
+
/** @description Customer remarks for courier. */
|
|
48
|
+
clientNoteToCourier?: string;
|
|
49
|
+
/** @description ID of a partner who acquired a given customer. */
|
|
50
|
+
affiliateId?: number;
|
|
51
|
+
/** @description Courier ID. */
|
|
52
|
+
courierId: number;
|
|
53
|
+
/** @description Collection point ID. */
|
|
54
|
+
pickupPointId?: string;
|
|
55
|
+
/** @description Delivery cost. */
|
|
56
|
+
deliveryCost?: number;
|
|
57
|
+
/** @description Delivery address data. */
|
|
58
|
+
clientDeliveryAddress?: {
|
|
59
|
+
/** @description Recipient's first name. */
|
|
60
|
+
clientDeliveryAddressFirstName?: string;
|
|
61
|
+
/** @description Recipient's last name. */
|
|
62
|
+
clientDeliveryAddressLastName?: string;
|
|
63
|
+
/** @description Additional information. */
|
|
64
|
+
clientDeliveryAddressAdditional?: string;
|
|
65
|
+
/** @description Recipient street and number. */
|
|
66
|
+
clientDeliveryAddressStreet?: string;
|
|
67
|
+
/** @description Recipient's postal code. */
|
|
68
|
+
clientDeliveryAddressZipCode?: string;
|
|
69
|
+
/** @description Recipient's city. */
|
|
70
|
+
clientDeliveryAddressCity?: string;
|
|
71
|
+
/** @description Recipient's country. */
|
|
72
|
+
clientDeliveryAddressCountry?: string;
|
|
73
|
+
/** @description Consignee's phone number. */
|
|
74
|
+
clientDeliveryAddressPhone?: string;
|
|
75
|
+
};
|
|
76
|
+
/** @description Buyer's address data. */
|
|
77
|
+
payerAddress?: {
|
|
78
|
+
/** @description Buyer's address id. */
|
|
79
|
+
payerAddressId?: number;
|
|
80
|
+
/** @description Buyer's first name. */
|
|
81
|
+
payerAddressFirstName?: string;
|
|
82
|
+
/** @description Buyer's last name. */
|
|
83
|
+
payerAddressLastName?: string;
|
|
84
|
+
/** @description Company name. */
|
|
85
|
+
payerAddressFirm?: string;
|
|
86
|
+
/** @description Customer VAT ID. */
|
|
87
|
+
payerAddressNip?: string;
|
|
88
|
+
/** @description Buyer's street name and house number. */
|
|
89
|
+
payerAddressStreet?: string;
|
|
90
|
+
/** @description Buyer's postal code. */
|
|
91
|
+
payerAddressZipCode?: string;
|
|
92
|
+
/** @description Buyer's city. */
|
|
93
|
+
payerAddressCity?: string;
|
|
94
|
+
/** @description Country code in the ISO 3166-1 A2 standard. */
|
|
95
|
+
payerAddressCountryId?: string;
|
|
96
|
+
/** @description Buyer's telephone number. */
|
|
97
|
+
payerAddressPhone?: string;
|
|
98
|
+
};
|
|
99
|
+
/** @description Products list. */
|
|
100
|
+
products: {
|
|
101
|
+
/** @description Product IAI code */
|
|
102
|
+
productId: number;
|
|
103
|
+
/** @description Size identifier */
|
|
104
|
+
sizeId: string;
|
|
105
|
+
/** @description External product system code for size. */
|
|
106
|
+
productSizeCodeExternal?: string;
|
|
107
|
+
/** @description Stock ID */
|
|
108
|
+
stockId?: number;
|
|
109
|
+
/** @description Product quantity. */
|
|
110
|
+
productQuantity: number;
|
|
111
|
+
/** @description Gross price */
|
|
112
|
+
productRetailPrice?: number;
|
|
113
|
+
/** @description Free product. */
|
|
114
|
+
productFree?: boolean;
|
|
115
|
+
/** */
|
|
116
|
+
forceLoyaltyPoints?: number;
|
|
117
|
+
/** @description Value of VAT */
|
|
118
|
+
productVat?: number;
|
|
119
|
+
/** @description Is product VAT free Allowed values "y" - yes, "n" - no. */
|
|
120
|
+
productVatFree?: string;
|
|
121
|
+
/** @description Information on used discount code. */
|
|
122
|
+
discountCode?: {
|
|
123
|
+
/** @description Name. */
|
|
124
|
+
name?: string;
|
|
125
|
+
};
|
|
126
|
+
/** @description Client's remarks on product. */
|
|
127
|
+
remarksToProduct?: string;
|
|
128
|
+
/** @description Label for grouping products. */
|
|
129
|
+
label?: string;
|
|
130
|
+
/** @description List of components if a products is a set or collection. */
|
|
131
|
+
productBundleItems?: {
|
|
132
|
+
/** @description Product IAI code */
|
|
133
|
+
productId?: number;
|
|
134
|
+
/** @description Size identifier */
|
|
135
|
+
sizeId?: string;
|
|
136
|
+
/** @description Size name */
|
|
137
|
+
sizePanelName?: string;
|
|
138
|
+
/** @description One of the unique, indexed product codes (IAI code / External system code / Producer code) */
|
|
139
|
+
productIndex?: string;
|
|
140
|
+
}[];
|
|
141
|
+
}[];
|
|
142
|
+
/** @description Discount value. */
|
|
143
|
+
orderRebateValue?: number;
|
|
144
|
+
/** @description Order handler. */
|
|
145
|
+
orderOperatorLogin?: string;
|
|
146
|
+
/** @description Omits collecting orders via IAI Bridge. */
|
|
147
|
+
ignoreBridge?: boolean;
|
|
148
|
+
/** @description Settings */
|
|
149
|
+
settings?: {
|
|
150
|
+
/** @description Send an email with order placement confirmation. */
|
|
151
|
+
settingSendMail?: boolean;
|
|
152
|
+
/** @description Send a text message with order placement confirmation. */
|
|
153
|
+
settingSendSMS?: boolean;
|
|
154
|
+
};
|
|
155
|
+
/** @description Settlement by prices. "gross" - gross, "net" - net, "net_without_VAT" - net without VAT. */
|
|
156
|
+
orderSettledAtPrice?: "gross" | "net" | "net_without_VAT";
|
|
157
|
+
/** @description Customer asked for invoice. List of parameters: "y" - yes (paper invoicing ), "e" - yes (electronic invoicing ), "n" - no. */
|
|
158
|
+
clientRequestInvoice?: string;
|
|
159
|
+
/** @description Order settlement currency. */
|
|
160
|
+
billingCurrency?: string;
|
|
161
|
+
/** @description Panel billing currency exchange rate in relation to billing currency in the shop . */
|
|
162
|
+
billingCurrencyRate?: number;
|
|
163
|
+
/** @description Sale date. ISO 8602 format. */
|
|
164
|
+
purchaseDate?: string;
|
|
165
|
+
}[];
|
|
166
|
+
};
|
|
167
|
+
|
|
168
|
+
export type PostProductsParams = {
|
|
169
|
+
/** @description Settings */
|
|
170
|
+
settings?: {
|
|
171
|
+
/** @description Price format. Parameter is currently unused. */
|
|
172
|
+
settingPriceFormat?: string;
|
|
173
|
+
/** @description Object determines if new categories can be added when category linked with product couldn't be found in system. Allowed values "n" - adding new categories not allowed (default value), "y" - adding new categories is possible. */
|
|
174
|
+
settingAddingCategoryAllowed?: string;
|
|
175
|
+
/** @description Object determines if new product sizes can be added when size linked with product couldn't be found in system. Allowed values "n" - adding new sizes not allowed (default value), "y" - adding new sizes is possible. */
|
|
176
|
+
settingAddingSizeAllowed?: string;
|
|
177
|
+
/** @description Object determines if new producers can be added when producer linked with product couldn't be found in system. Allowed values "n" - you have no rights to add new manufacturers (default value), "y" - adding new producer is possible. */
|
|
178
|
+
settingAddingProducerAllowed?: string;
|
|
179
|
+
/** @description Object determines if new product series can be added when series linked with product couldn't be found in system. Allowed values "n" - you have no rights to add new product series (default value), "y" - adding new series is possible. */
|
|
180
|
+
settingAddingSeriesAllowed?: string;
|
|
181
|
+
/** @description Object determines default category which will be linked with product when it will not be linked with any category.. */
|
|
182
|
+
settingDefaultCategory?: {
|
|
183
|
+
/** @description Category id */
|
|
184
|
+
categoryId?: number;
|
|
185
|
+
/** @description Category name */
|
|
186
|
+
categoryName?: string;
|
|
187
|
+
};
|
|
188
|
+
/** @description Element specifying the default size group that will be assigned to the new product in case no size group has been explicitly assigned. */
|
|
189
|
+
settingDefaultSizesGroup?: {
|
|
190
|
+
/** @description Size group ID Change of one size group to another results in zeroing all stock quantities in all stocks. Change of size group can be made, if product is not present in any unhandled orders nor listed on auctions. */
|
|
191
|
+
sizesGroupId?: number;
|
|
192
|
+
/** @description Size group name. */
|
|
193
|
+
sizesGroupName?: string;
|
|
194
|
+
};
|
|
195
|
+
/** @description The item shall determine whether the default visibility in stores can be set if a new commodity is to be created and no parameters have been uploaded to set visibility in at least one store.. */
|
|
196
|
+
settingsAddingDefaultShopMaskAllowed?: "n" | "y";
|
|
197
|
+
/** @description Element specifying whether the default visibility in stores can be set according to the list of stores indicated in the web import source configuration, if a new product will be created and no parameters have been sent to set visibility in at least one store.. */
|
|
198
|
+
settingsAddingManuallySelectedShopMaskAllowed?: number;
|
|
199
|
+
};
|
|
200
|
+
/** @description Icon and photos settings */
|
|
201
|
+
picturesSettings?: {
|
|
202
|
+
/** @description Object determines photo URL. */
|
|
203
|
+
picturesSettingInitialUrlPart?: string;
|
|
204
|
+
/** @description Object determines the method of adding photos in "pictures" object. Allowed values "base64" - photos added in base64 coding algorithm, "url" - photos added as URLs to external systems. */
|
|
205
|
+
picturesSettingInputType?: string;
|
|
206
|
+
/** @description Object determines the method of adding product photos. Allowed values "n" - photos are uploaded from the first free place, "y" - photos are uploaded from the first place. */
|
|
207
|
+
picturesSettingOverwrite?: string;
|
|
208
|
+
/** @description Object determines if the photo should be scaled. Allowed values "n" - no scaling allowance, "y" - scaling allowance. */
|
|
209
|
+
picturesSettingScaling?: string;
|
|
210
|
+
};
|
|
211
|
+
/** @description Products list. */
|
|
212
|
+
products: {
|
|
213
|
+
/** @description Product IAI code */
|
|
214
|
+
productId?: number;
|
|
215
|
+
/** @description External product system code for size. */
|
|
216
|
+
productSizeCodeExternal?: string;
|
|
217
|
+
/** @description External product system code. */
|
|
218
|
+
productDisplayedCode?: string;
|
|
219
|
+
/** @description PKWiU [PCPandS]. */
|
|
220
|
+
productTaxCode?: string;
|
|
221
|
+
/** @description Number of items in package data */
|
|
222
|
+
productInWrapper?: number;
|
|
223
|
+
/** @description Sold at - for retailers. */
|
|
224
|
+
productSellByRetail?: number;
|
|
225
|
+
/** @description Sold at - for wholesalers. */
|
|
226
|
+
productSellByWholesale?: number;
|
|
227
|
+
/** @description IdoSell Category ID */
|
|
228
|
+
categoryIdoSellId?: number;
|
|
229
|
+
/** @description IdoSell Category pathname */
|
|
230
|
+
categoryIdoSellPath?: string;
|
|
231
|
+
/** @description Category id */
|
|
232
|
+
categoryId?: number;
|
|
233
|
+
/** @description Category name */
|
|
234
|
+
categoryName?: string;
|
|
235
|
+
/** @description Brand ID */
|
|
236
|
+
producerId?: number;
|
|
237
|
+
/** @description Brand name */
|
|
238
|
+
producerName?: string;
|
|
239
|
+
/** @description CN/TARIC */
|
|
240
|
+
cnTaricCode?: string;
|
|
241
|
+
/** @description Country of origin. Country code in the ISO 3166-1 A2 standard */
|
|
242
|
+
countryOfOrigin?: string;
|
|
243
|
+
/** @description Product unit of measure ID. */
|
|
244
|
+
unitId?: number;
|
|
245
|
+
/** @description ID of series, to which product belongs. */
|
|
246
|
+
seriesId?: number;
|
|
247
|
+
/** @description Name of series, to which the product belongs, visible in panel. */
|
|
248
|
+
seriesPanelName?: string;
|
|
249
|
+
/** @description Size group ID Change of one size group to another results in zeroing all stock quantities in all stocks. Change of size group can be made, if product is not present in any unhandled orders nor listed on auctions. */
|
|
250
|
+
sizesGroupId?: number;
|
|
251
|
+
/** @description Optional element, that determines prices edition mode. Default value is "amount_set", when indicated element is omitted in API gate call.. Allowed values "amount_set" - sets product prices to desired value (default mode), "amount_diff" - sets sum difference between prices set (adds or subtracts entered sum from the current price), "percent_diff" - sets percentage difference between prices set (adds or subtracts entered percent from the current price). */
|
|
252
|
+
priceChangeMode?: string;
|
|
253
|
+
/** @description The JavaScript formula calculating prices */
|
|
254
|
+
priceFormula?: {
|
|
255
|
+
/** @description Formula parameters for calculating price */
|
|
256
|
+
priceFormulaParameters?: string;
|
|
257
|
+
/** @description Formula function for calculating price */
|
|
258
|
+
priceFormulaFunction?: string;
|
|
259
|
+
};
|
|
260
|
+
/** @description Gross price */
|
|
261
|
+
productRetailPrice?: number;
|
|
262
|
+
/** @description Wholesale price */
|
|
263
|
+
productWholesalePrice?: number;
|
|
264
|
+
/** @description Minimal price */
|
|
265
|
+
productMinimalPrice?: number;
|
|
266
|
+
/** @description Price for automatic calculations */
|
|
267
|
+
productAutomaticCalculationPrice?: number;
|
|
268
|
+
/** @description price for POS. */
|
|
269
|
+
productPosPrice?: number;
|
|
270
|
+
/** @description Value of VAT */
|
|
271
|
+
productVat?: number;
|
|
272
|
+
/** @description Is product VAT free Allowed values "y" - yes, "n" - no. */
|
|
273
|
+
productVatFree?: string;
|
|
274
|
+
/** @description Different prices for price comparison websites. */
|
|
275
|
+
productPriceComparisonSitesPrices?: {
|
|
276
|
+
/** @description price comparison website ID */
|
|
277
|
+
priceComparisonSiteId?: number;
|
|
278
|
+
/** @description Price for a price comparison website in a shop */
|
|
279
|
+
productPriceComparisonSitePrice?: number;
|
|
280
|
+
}[];
|
|
281
|
+
/** @description Object determines if the product is available in POS sale Available values: "n" - no, "y" - yes. */
|
|
282
|
+
productEnableInPos?: string;
|
|
283
|
+
/** @description Required advance payment in percents */
|
|
284
|
+
productAdvancePrice?: number;
|
|
285
|
+
/** @description Annotation. */
|
|
286
|
+
productNote?: string;
|
|
287
|
+
/** @description Product value in points. */
|
|
288
|
+
productProfitPoints?: number;
|
|
289
|
+
/** @description Weight. */
|
|
290
|
+
productWeight?: number;
|
|
291
|
+
/** @description Product visibility. Allowed values "y" - product visible, "n" - product not visible. */
|
|
292
|
+
productInVisible?: string;
|
|
293
|
+
/** @description Product visible even though out of stock Available values: "y" - visible even though out of stock, "n" - not visible when out of stock. */
|
|
294
|
+
productInPersistent?: string;
|
|
295
|
+
/** @description Bit mask of shop IDs. Mask for indicated store is calculated on basis of following formula: 2^(store_ID - 1). If the product should be available in more than one shop, the masks should be summed up. */
|
|
296
|
+
shopsMask: number;
|
|
297
|
+
/** @description Complex rating Available values: "0" - no, "1" - yes. */
|
|
298
|
+
productComplexNotes?: number;
|
|
299
|
+
/** @description Product visibility in export to price comparison and marketplaces. Available values: "y" - Visible, "selected" - yes (selected), "n" - invisible. */
|
|
300
|
+
productInExportToPriceComparisonSites?: string;
|
|
301
|
+
/** @description Selection of comparison sites for which the product visibility will be changed */
|
|
302
|
+
priceComparisonSites?: {
|
|
303
|
+
/** @description Shop Id */
|
|
304
|
+
shopId?: number;
|
|
305
|
+
/** @description price comparison website ID */
|
|
306
|
+
priceComparisonSiteId?: number;
|
|
307
|
+
}[];
|
|
308
|
+
/** @description Visibility of an item in an export to Amazon Marketplace. Available values: "y" - Visible, "selected" - Visible on selected regional services, "n" - invisible. */
|
|
309
|
+
productInExportToAmazonMarketplace?: string;
|
|
310
|
+
/** @description Availability profile ID. */
|
|
311
|
+
availableProfile?: number;
|
|
312
|
+
/** @description Discount profile ID */
|
|
313
|
+
productRebate?: number;
|
|
314
|
+
/** @description Product warranty ID. */
|
|
315
|
+
warrantyId?: number;
|
|
316
|
+
/** @description Priority. Allowed values from 1 to 10. */
|
|
317
|
+
productPriority?: number;
|
|
318
|
+
/** @description Product icon details. */
|
|
319
|
+
productIcon?: string;
|
|
320
|
+
/** @description Watermark ID */
|
|
321
|
+
productWatermarkId?: number;
|
|
322
|
+
/** @description Link to watermark */
|
|
323
|
+
productWatermarkUrl?: string;
|
|
324
|
+
/** @description List of product photos */
|
|
325
|
+
productPictures?: string[];
|
|
326
|
+
/** @description List of photos descriptions */
|
|
327
|
+
productDescriptionPictures?: string[];
|
|
328
|
+
/** @description Reduced price */
|
|
329
|
+
productPromotion?: {
|
|
330
|
+
/** @description Object determines if the promotion should be active.. Allowed values "y" - active promotion, "n" - inactive promotion. */
|
|
331
|
+
promoteInEnabled?: string;
|
|
332
|
+
/** @description Strikethrough price */
|
|
333
|
+
promoteItemNormalPrice?: number;
|
|
334
|
+
/** @description Strikethrough wholesale price */
|
|
335
|
+
promoteItemWholesaleNormalPrice?: number;
|
|
336
|
+
/** @description Switching off date */
|
|
337
|
+
promoteItemEndingDate?: string;
|
|
338
|
+
};
|
|
339
|
+
/** @description Discount for shop. */
|
|
340
|
+
productDiscount?: {
|
|
341
|
+
/** @description Object determines if the promotion should be active.. Allowed values "y" - active promotion, "n" - inactive promotion. */
|
|
342
|
+
promoteInEnabled?: string;
|
|
343
|
+
/** @description Strikethrough price */
|
|
344
|
+
promoteItemNormalPrice?: number;
|
|
345
|
+
/** @description Strikethrough wholesale price */
|
|
346
|
+
promoteItemWholesaleNormalPrice?: number;
|
|
347
|
+
/** @description Switching off date */
|
|
348
|
+
promoteItemEndingDate?: string;
|
|
349
|
+
};
|
|
350
|
+
/** @description Distinguished product in store. */
|
|
351
|
+
productDistinguished?: {
|
|
352
|
+
/** @description Object determines if the promotion should be active.. Allowed values "y" - active promotion, "n" - inactive promotion. */
|
|
353
|
+
promoteInEnabled?: string;
|
|
354
|
+
/** @description Strikethrough price */
|
|
355
|
+
promoteItemNormalPrice?: number;
|
|
356
|
+
/** @description Strikethrough wholesale price */
|
|
357
|
+
promoteItemWholesaleNormalPrice?: number;
|
|
358
|
+
/** @description Switching off date */
|
|
359
|
+
promoteItemEndingDate?: string;
|
|
360
|
+
};
|
|
361
|
+
/** @description Special product in store. */
|
|
362
|
+
productSpecial?: {
|
|
363
|
+
/** @description Object determines if the promotion should be active.. Allowed values "y" - active promotion, "n" - inactive promotion. */
|
|
364
|
+
promoteInEnabled?: string;
|
|
365
|
+
/** @description Strikethrough price */
|
|
366
|
+
promoteItemNormalPrice?: number;
|
|
367
|
+
/** @description Strikethrough wholesale price */
|
|
368
|
+
promoteItemWholesaleNormalPrice?: number;
|
|
369
|
+
/** @description Switching off date */
|
|
370
|
+
promoteItemEndingDate?: string;
|
|
371
|
+
};
|
|
372
|
+
/** @description Parameters (distinguished). */
|
|
373
|
+
productParametersDistinction?: {
|
|
374
|
+
/** @description Parameter ID */
|
|
375
|
+
parameterId?: number;
|
|
376
|
+
/** @description Parameter name. */
|
|
377
|
+
parameterName?: string;
|
|
378
|
+
/** @description Parameter value ID */
|
|
379
|
+
parameterValueId?: number;
|
|
380
|
+
/** @description Attributes group name. */
|
|
381
|
+
parameterValueName?: string;
|
|
382
|
+
}[];
|
|
383
|
+
/** @description List of products recommended with this product */
|
|
384
|
+
associatedProducts?: {
|
|
385
|
+
/** @description Recommended product ID */
|
|
386
|
+
associatedProductId?: number;
|
|
387
|
+
/** @description Recommended product name */
|
|
388
|
+
associatedProductName?: string;
|
|
389
|
+
/** @description Recommended product code. External system code. */
|
|
390
|
+
associatedProductCode?: string;
|
|
391
|
+
}[];
|
|
392
|
+
/** @description Sizes available for products data. */
|
|
393
|
+
productSizes?: {
|
|
394
|
+
/** @description Size identifier */
|
|
395
|
+
sizeId?: string;
|
|
396
|
+
/** @description Size name */
|
|
397
|
+
sizePanelName?: string;
|
|
398
|
+
/** @description Weight. */
|
|
399
|
+
productWeight?: number;
|
|
400
|
+
/** @description Net weight. */
|
|
401
|
+
productWeightNet?: number;
|
|
402
|
+
/** @description Gross price */
|
|
403
|
+
productRetailPrice?: number;
|
|
404
|
+
/** @description Wholesale price */
|
|
405
|
+
productWholesalePrice?: number;
|
|
406
|
+
/** @description Minimal price */
|
|
407
|
+
productMinimalPrice?: number;
|
|
408
|
+
/** @description Price for automatic calculations */
|
|
409
|
+
productAutomaticCalculationPrice?: number;
|
|
410
|
+
/** @description price for POS. */
|
|
411
|
+
productPosPrice?: number;
|
|
412
|
+
/** @description Prices for marketplaces */
|
|
413
|
+
productAuctionPrices?: {
|
|
414
|
+
/** @description Auction system ID */
|
|
415
|
+
productAuctionId?: number;
|
|
416
|
+
/** @description Auction site ID */
|
|
417
|
+
productAuctionSiteId?: number;
|
|
418
|
+
/** @description Price for auction site */
|
|
419
|
+
productAuctionPrice?: number;
|
|
420
|
+
}[];
|
|
421
|
+
/** @description External product system code */
|
|
422
|
+
productCode?: string;
|
|
423
|
+
/** @description Product visible even though out of stock Available values: "y" - visible even though out of stock, "n" - not visible when out of stock. */
|
|
424
|
+
productInPersistent?: string;
|
|
425
|
+
/** @description Product stock quantity data. */
|
|
426
|
+
productStocksData?: {
|
|
427
|
+
/** @description Object contains information on product quantity */
|
|
428
|
+
productStockQuantities?: {
|
|
429
|
+
/** @description Stock ID */
|
|
430
|
+
stockId?: number;
|
|
431
|
+
/** Format: decimal
|
|
432
|
+
* @description Product stock quantity */
|
|
433
|
+
productSizeQuantity?: number;
|
|
434
|
+
/** Format: decimal
|
|
435
|
+
* @description Product quantity to add up */
|
|
436
|
+
productSizeQuantityToAdd?: number;
|
|
437
|
+
/** Format: decimal
|
|
438
|
+
* @description Product quantity to subtract */
|
|
439
|
+
productSizeQuantityToSubstract?: number;
|
|
440
|
+
}[];
|
|
441
|
+
};
|
|
442
|
+
/** @description Object contains information dependent on shop and size. */
|
|
443
|
+
shopsSizeAttributes?: {
|
|
444
|
+
/** @description Shop Id */
|
|
445
|
+
shopId?: number;
|
|
446
|
+
/** @description Gross price */
|
|
447
|
+
productRetailPrice?: number;
|
|
448
|
+
/** @description Wholesale price */
|
|
449
|
+
productWholesalePrice?: number;
|
|
450
|
+
/** @description Minimal price */
|
|
451
|
+
productMinimalPrice?: number;
|
|
452
|
+
/** @description Price for automatic calculations */
|
|
453
|
+
productAutomaticCalculationPrice?: number;
|
|
454
|
+
}[];
|
|
455
|
+
}[];
|
|
456
|
+
/** @description Data concerning attributes dependent on indicated stores with particular product assigned. */
|
|
457
|
+
productShopsAttributes?: {
|
|
458
|
+
/** @description Shop Id */
|
|
459
|
+
shopId?: number;
|
|
460
|
+
/** @description Information about prices for price comparison websites dependent on a shop */
|
|
461
|
+
productShopPriceComparisonSitesPrices?: {
|
|
462
|
+
/** @description price comparison website ID */
|
|
463
|
+
priceComparisonSiteId?: number;
|
|
464
|
+
/** @description Percentage difference between the price comparison website and the shop */
|
|
465
|
+
productPriceComparisonSitePercentDiff?: number;
|
|
466
|
+
}[];
|
|
467
|
+
}[];
|
|
468
|
+
/** @description Products subscription settings. */
|
|
469
|
+
subscription?: {
|
|
470
|
+
/** @description Shop Id */
|
|
471
|
+
shopId?: number;
|
|
472
|
+
/** @description Is subscription enabled for product */
|
|
473
|
+
enabled?: boolean;
|
|
474
|
+
/** @description Days in period */
|
|
475
|
+
daysInPeriod?: number[];
|
|
476
|
+
/** @description Sold at - for retailers. */
|
|
477
|
+
unitsNumberRetail?: number;
|
|
478
|
+
/** @description Sold at - for wholesalers. */
|
|
479
|
+
unitsNumberWholesale?: number;
|
|
480
|
+
}[];
|
|
481
|
+
/** @description Product name. */
|
|
482
|
+
productNames?: {
|
|
483
|
+
productNamesLangData?: {
|
|
484
|
+
/** @description Language ID */
|
|
485
|
+
langId?: string;
|
|
486
|
+
/** @description Product name. */
|
|
487
|
+
productName?: string;
|
|
488
|
+
}[];
|
|
489
|
+
};
|
|
490
|
+
productDescriptions?: {
|
|
491
|
+
/** @description Array of language-dependent elements. */
|
|
492
|
+
productDescriptionsLangData?: {
|
|
493
|
+
/** @description Language ID */
|
|
494
|
+
langId?: string;
|
|
495
|
+
/** @description Short product description. */
|
|
496
|
+
productDescription?: string;
|
|
497
|
+
}[];
|
|
498
|
+
};
|
|
499
|
+
/** @description Long product description */
|
|
500
|
+
productLongDescriptions?: {
|
|
501
|
+
productLongDescriptionsLangData?: {
|
|
502
|
+
/** @description Language ID */
|
|
503
|
+
langId?: string;
|
|
504
|
+
/** @description Long product description. */
|
|
505
|
+
productLongDescription?: string;
|
|
506
|
+
}[];
|
|
507
|
+
};
|
|
508
|
+
/** @description Product data for auction services */
|
|
509
|
+
productAuctionDescriptionsData?: {
|
|
510
|
+
/** @description Auction system ID */
|
|
511
|
+
productAuctionId?: string;
|
|
512
|
+
/** @description Auction site ID */
|
|
513
|
+
productAuctionSiteId?: string;
|
|
514
|
+
/** @description Product name for auction service. */
|
|
515
|
+
productAuctionName?: string;
|
|
516
|
+
/** @description Subtitle for auction service */
|
|
517
|
+
productAuctionAdditionalName?: string;
|
|
518
|
+
/** @description Product description for marketplaces */
|
|
519
|
+
productAuctionDescription?: string;
|
|
520
|
+
}[];
|
|
521
|
+
/** @description Product meta title */
|
|
522
|
+
productMetaTitles?: {
|
|
523
|
+
productMetaTitlesLangData?: {
|
|
524
|
+
/** @description Language ID */
|
|
525
|
+
langId?: string;
|
|
526
|
+
/** @description Language name */
|
|
527
|
+
langName?: string;
|
|
528
|
+
/** @description Product meta title. */
|
|
529
|
+
productMetaTitle?: string;
|
|
530
|
+
}[];
|
|
531
|
+
};
|
|
532
|
+
/** @description Product meta description */
|
|
533
|
+
productMetaDescriptions?: {
|
|
534
|
+
productMetaDescriptionsLangData?: {
|
|
535
|
+
/** @description Language ID */
|
|
536
|
+
langId?: string;
|
|
537
|
+
/** @description Language name */
|
|
538
|
+
langName?: string;
|
|
539
|
+
/** @description Product meta description. */
|
|
540
|
+
productMetaDescription?: string;
|
|
541
|
+
}[];
|
|
542
|
+
};
|
|
543
|
+
/** @description Product meta keywords. */
|
|
544
|
+
productMetaKeywords?: {
|
|
545
|
+
productMetaKeywordsLangData?: {
|
|
546
|
+
/** @description Language ID */
|
|
547
|
+
langId?: string;
|
|
548
|
+
/** @description Language name */
|
|
549
|
+
langName?: string;
|
|
550
|
+
/** @description Product meta keywords. */
|
|
551
|
+
productMetaKeyword?: string;
|
|
552
|
+
}[];
|
|
553
|
+
};
|
|
554
|
+
/** @description #!AdresURLDlaTowaru!#. */
|
|
555
|
+
productUrl?: {
|
|
556
|
+
productUrlsLangData?: {
|
|
557
|
+
/** @description Shop Id */
|
|
558
|
+
shopId?: number;
|
|
559
|
+
/** @description Language ID */
|
|
560
|
+
langId?: string;
|
|
561
|
+
/** @example url */
|
|
562
|
+
url?: string;
|
|
563
|
+
}[];
|
|
564
|
+
};
|
|
565
|
+
/** @description Data on product groups (variants) */
|
|
566
|
+
productVersion?: {
|
|
567
|
+
/** @description ID of the main item (variant) in the group */
|
|
568
|
+
versionParentId?: number;
|
|
569
|
+
/** @description The order of products in the group. Value needs to be more than 0. */
|
|
570
|
+
versionPriority?: number;
|
|
571
|
+
/** @description Settings for groups of items (variants) */
|
|
572
|
+
versionSettings?: {
|
|
573
|
+
/** @description Show in shop. Available values: "y" - all products from group, "n" - only the first product from group. */
|
|
574
|
+
versionDisplayAllInShop?: string;
|
|
575
|
+
/** @description The same code. Available values: "y" - yes, "n" - no. */
|
|
576
|
+
versionCommonCode?: string;
|
|
577
|
+
/** @description The same brand. Available values: "y" - yes, "n" - no. */
|
|
578
|
+
versionCommonProducer?: string;
|
|
579
|
+
/** @description The same annotation. Available values: "y" - yes, "n" - no. */
|
|
580
|
+
versionCommonNote?: string;
|
|
581
|
+
/** @description The same warranty. Available values: "y" - yes, "n" - no. */
|
|
582
|
+
versionCommonWarranty?: string;
|
|
583
|
+
/** @description The same series. Available values: "y" - yes, "n" - no. */
|
|
584
|
+
versionCommonSeries?: string;
|
|
585
|
+
/** @description The same category. Available values: "y" - yes, "n" - no. */
|
|
586
|
+
versionCommonCategory?: string;
|
|
587
|
+
/** @description The same price. Available values: "y" - yes, "n" - no. */
|
|
588
|
+
versionCommonPrice?: string;
|
|
589
|
+
/** @description Same price for auction services. possible values "y" - yes, "n" - no. */
|
|
590
|
+
versionCommonAuctionsPrice?: string;
|
|
591
|
+
/** @description Same advance. Available values: "y" - yes, "n" - no. */
|
|
592
|
+
versionCommonAdvance?: string;
|
|
593
|
+
/** @description Same quantity discount. Available values: "y" - yes, "n" - no. */
|
|
594
|
+
versionCommonRebate?: string;
|
|
595
|
+
/** @description the same VAT rate. Available values: "y" - yes, "n" - no. */
|
|
596
|
+
versionCommonVat?: string;
|
|
597
|
+
/** @description The same loyalty points. Available values: "y" - yes, "n" - no. */
|
|
598
|
+
versionCommonProfitPoints?: string;
|
|
599
|
+
/** @description The same promotion. Available values: "y" - yes, "n" - no. */
|
|
600
|
+
versionCommonPromotion?: string;
|
|
601
|
+
/** @description The same loyalty discount. Available values: "y" - yes, "n" - no. */
|
|
602
|
+
versionCommonDiscount?: string;
|
|
603
|
+
/** @description The same privileged products. Available values: "y" - yes, "n" - no. */
|
|
604
|
+
versionCommonDistinguished?: string;
|
|
605
|
+
/** @description The same for special. Available values: "y" - yes, "n" - no. */
|
|
606
|
+
versionCommonSpecial?: string;
|
|
607
|
+
/** @description DEPRECATED */
|
|
608
|
+
versionCommonTraits?: string;
|
|
609
|
+
/** @description The same related product. Available values: "y" - yes, "n" - no. */
|
|
610
|
+
versionCommonAssociated?: string;
|
|
611
|
+
/** @description The same visibility. Available values: "y" - yes, "n" - no. */
|
|
612
|
+
versionCommonVisibility?: string;
|
|
613
|
+
/** @description Same display when not in stock. Available values: "y" - yes, "n" - no. */
|
|
614
|
+
versionCommonPersistent?: string;
|
|
615
|
+
/** @description The same priority. Available values: "y" - yes, "n" - no. */
|
|
616
|
+
versionCommonPriority?: string;
|
|
617
|
+
/** @description The same shops. Available values: "y" - yes, "n" - no. */
|
|
618
|
+
versionCommonShops?: string;
|
|
619
|
+
/** @description The same sizes. Available values: "y" - yes, "n" - no. */
|
|
620
|
+
versionCommonSizes?: string;
|
|
621
|
+
/** @description The same unit of measure. Available values: "y" - yes, "n" - no. */
|
|
622
|
+
versionCommonUnit?: string;
|
|
623
|
+
/** @description The same weight. Available values: "y" - yes, "n" - no. */
|
|
624
|
+
versionCommonWeight?: string;
|
|
625
|
+
/** @description The same parameters. possible values "y" - yes, "n" - no. */
|
|
626
|
+
versionCommonDictionary?: string;
|
|
627
|
+
/** @description The same name. Available values: "y" - yes, "n" - no. */
|
|
628
|
+
versionCommonName?: string;
|
|
629
|
+
/** @description The same short description. Available values: "y" - yes, "n" - no. */
|
|
630
|
+
versionCommonDescription?: string;
|
|
631
|
+
/** @description The same long description. Available values: "y" - yes, "n" - no. */
|
|
632
|
+
versionCommonLongDescription?: string;
|
|
633
|
+
/** @description The same icon. Available values: "y" - yes, "n" - no. */
|
|
634
|
+
versionCommonIcon?: string;
|
|
635
|
+
/** @description The same large photos. Available values: "y" - yes, "n" - no. */
|
|
636
|
+
versionCommonPhotos?: string;
|
|
637
|
+
/** @description The same availability profile. Available values: "y" - yes, "n" - no. */
|
|
638
|
+
versionCommonAvailableProfile?: string;
|
|
639
|
+
/** @description The same complex rating. Available values: "y" - yes, "n" - no. */
|
|
640
|
+
versionCommonComplexNotes?: string;
|
|
641
|
+
/** @description Do You wish to sum up the products in the basket as a one order? Available values: "y" - yes, "n" - no. */
|
|
642
|
+
versionCommonSumInBasket?: string;
|
|
643
|
+
};
|
|
644
|
+
/** @description Parameter value names */
|
|
645
|
+
versionNames?: {
|
|
646
|
+
/** @description Array of languages, values are displayed in. */
|
|
647
|
+
versionNamesLangData?: {
|
|
648
|
+
/** @description Language ID */
|
|
649
|
+
langId?: string;
|
|
650
|
+
/** @description Name of the parameter value, e.g. orange, green, red */
|
|
651
|
+
versionName?: string;
|
|
652
|
+
}[];
|
|
653
|
+
};
|
|
654
|
+
/** @description Parameter names */
|
|
655
|
+
versionGroupNames?: {
|
|
656
|
+
/** @description Parameter name */
|
|
657
|
+
versionGroupNamesLangData?: {
|
|
658
|
+
/** @description Language ID */
|
|
659
|
+
langId?: string;
|
|
660
|
+
/** @description Parameter name, e.g. color, width */
|
|
661
|
+
versionGroupName?: string;
|
|
662
|
+
}[];
|
|
663
|
+
};
|
|
664
|
+
};
|
|
665
|
+
/** @description Currency ID */
|
|
666
|
+
currencyId?: string;
|
|
667
|
+
/** @description Supplier ID. */
|
|
668
|
+
delivererId?: number;
|
|
669
|
+
/** @description This parameter is optional and it determines properties edition mode. Default value is "replace". Allowed values: "add" - adds properties to already existent ones, "delete" - removes properties of already existent ones, "delete_group" - removes properties from selected group, "replace" - overwrites properties already existent with new ones (default mode). */
|
|
670
|
+
productParametersDistinctionChangeMode?: "add" | "delete" | "delete_group" | "replace";
|
|
671
|
+
/** @description Product delivery time from the producer to the shop */
|
|
672
|
+
productDeliveryTime?: {
|
|
673
|
+
/** @description Operation type: "product" - sets own product delivery time, "deliverer" - sets product delivery time exactly the same as deliverer's. */
|
|
674
|
+
productDeliveryTimeChangeMode?: "product" | "deliverer";
|
|
675
|
+
/** @description The amount of time it takes to get goods from the supplier to the store. The maximum time is 99 for the unit "days" or 999 for the unit "hours" and "minutes" */
|
|
676
|
+
productDeliveryTimeValue?: number;
|
|
677
|
+
};
|
|
678
|
+
/** @description Do You wish to sum up the products in the basket as a one order? Available values: "y" - yes, "n" - no. */
|
|
679
|
+
productSumInBasket?: string;
|
|
680
|
+
/** @description Shipping, returns and complaints settings */
|
|
681
|
+
dispatchSettings?: {
|
|
682
|
+
enabled?: boolean;
|
|
683
|
+
/** @description Shipping settings */
|
|
684
|
+
shippingSettings?: {
|
|
685
|
+
/** @description Disable cash on delivery orders */
|
|
686
|
+
codDisabled?: boolean;
|
|
687
|
+
/** @description Only personal collection */
|
|
688
|
+
dvpOnly?: boolean;
|
|
689
|
+
/** @description Oversized product */
|
|
690
|
+
atypicalSize?: boolean;
|
|
691
|
+
/** @description Insurance required */
|
|
692
|
+
insuranceOnly?: boolean;
|
|
693
|
+
/** @description Exclusion from the Smile service */
|
|
694
|
+
excludeSmileService?: boolean;
|
|
695
|
+
/** @description List of courier services which cannot be used to ship this product */
|
|
696
|
+
disallowedCouriers?: number[];
|
|
697
|
+
};
|
|
698
|
+
/** @description Free shipping settings */
|
|
699
|
+
freeShippingSettings?: {
|
|
700
|
+
/** @description Edition mode */
|
|
701
|
+
mode?: "no" | "onlyProduct" | "wholeBasket";
|
|
702
|
+
/** @description Set free shipping for the payment method only . */
|
|
703
|
+
availablePaymentForms?: {
|
|
704
|
+
/** @description prepayment */
|
|
705
|
+
prepaid?: boolean;
|
|
706
|
+
/** @description Cash on delivery */
|
|
707
|
+
cashOnDelivery?: boolean;
|
|
708
|
+
/** @description Trade credit */
|
|
709
|
+
tradeCredit?: boolean;
|
|
710
|
+
};
|
|
711
|
+
/** @description List of courier services for which shipping is free */
|
|
712
|
+
availableCouriers?: number[];
|
|
713
|
+
/** @description List of regions with free shipment */
|
|
714
|
+
availableRegions?: number[];
|
|
715
|
+
};
|
|
716
|
+
/** @description Return and complaint settings */
|
|
717
|
+
returnProductSettings?: {
|
|
718
|
+
/** @description Product can be returned */
|
|
719
|
+
returnOptions?: {
|
|
720
|
+
enabled?: boolean;
|
|
721
|
+
/** @description yes - for companies */
|
|
722
|
+
firm?: boolean;
|
|
723
|
+
/** @description yes - for wholesalers */
|
|
724
|
+
hurt?: boolean;
|
|
725
|
+
/** @description yes - for retailers */
|
|
726
|
+
detalist?: boolean;
|
|
727
|
+
};
|
|
728
|
+
byOwnService?: boolean;
|
|
729
|
+
byInPostSzybkieZwrotyByIAI?: boolean;
|
|
730
|
+
};
|
|
731
|
+
};
|
|
732
|
+
/** @description Standard unit settings */
|
|
733
|
+
standardUnit?: {
|
|
734
|
+
/** @description Possible special contexts corresponding to standard units. Available values: "CONTEXT_STD_UNIT_WEIGHT" - #!WagaTowaruWGramach!#, "CONTEXT_STD_UNIT_WEIGHT_SI" - Product weight in kilograms, "CONTEXT_STD_UNIT_VOLUME" - A product's value in milliliters "CONTEXT_STD_UNIT_VOLUME_SI" - A product's value in liters "CONTEXT_STD_UNIT_LENGTH" - Length of product in meters "CONTEXT_STD_UNIT_AREA_M2" - Area of product in square meters "CONTEXT_STD_UNIT_VOLUME_M3" - The volume of products in cubic meters "CONTEXT_STD_UNIT_QUANTITY_PACKAGE" - Number of pieces per pack for standard unit */
|
|
735
|
+
contextValue?: "CONTEXT_STD_UNIT_WEIGHT" | "CONTEXT_STD_UNIT_WEIGHT_SI" | "CONTEXT_STD_UNIT_VOLUME" | "CONTEXT_STD_UNIT_VOLUME_SI" | "CONTEXT_STD_UNIT_LENGTH" | "CONTEXT_STD_UNIT_AREA_M2" | "CONTEXT_STD_UNIT_VOLUME_M3" | "CONTEXT_STD_UNIT_QUANTITY_PACKAGE";
|
|
736
|
+
/** @description Total length/volume/area/weight of product */
|
|
737
|
+
standardUnitValue?: number;
|
|
738
|
+
/** @description Price converter per unit. Available values: "0" - default (taken from the category), "1" - price per gram/milliliter/meter "10" - price per 10 grams/10 milliliters/10 meters "100" - price per 100 grams/100 milliliters/100 meters "1000" - price per liter/kilogram/kilometer */
|
|
739
|
+
converterUnitValue?: "0" | "1" | "10" | "100" | "1000";
|
|
740
|
+
};
|
|
741
|
+
/** @description Minimal number of products in an order */
|
|
742
|
+
minQuantityPerOrder?: {
|
|
743
|
+
/** @description Minimum number of products in a retail order */
|
|
744
|
+
minQuantityPerOrderRetail?: number;
|
|
745
|
+
/** @description Minimum number of products in a wholesale order */
|
|
746
|
+
minQuantityPerOrderWholesale?: number;
|
|
747
|
+
};
|
|
748
|
+
/** @description Dimensions and overall weight */
|
|
749
|
+
productDimensions?: {
|
|
750
|
+
/** @description The width of a product in centimeters */
|
|
751
|
+
productWidth?: number;
|
|
752
|
+
/** @description Height of a product in centimeters */
|
|
753
|
+
productHeight?: number;
|
|
754
|
+
/** @description The length of a product in centimeters */
|
|
755
|
+
productLength?: number;
|
|
756
|
+
};
|
|
757
|
+
/** @description Responsible producer code */
|
|
758
|
+
responsibleProducerCode?: string;
|
|
759
|
+
/** @description Responsible person code */
|
|
760
|
+
responsiblePersonCode?: string;
|
|
761
|
+
}[];
|
|
762
|
+
};
|
|
763
|
+
|
|
764
|
+
export type PutProductsParams = {
|
|
765
|
+
/** @description Settings */
|
|
766
|
+
settings?: {
|
|
767
|
+
/** @description Object determines the products modification mode. Allowed values: "all" - (default value). - allows adding new products. If the product of entered ID or external product system code cannot be found in system, the product will be added as a new one., "edit" - doesn't allow adding new products. In this mode only editing the already existing products is possible. If the product of entered ID or external product system code cannot be found in shop, gate will return error and the product will not be added to shop. "add" - In this mode you can only add products. */
|
|
768
|
+
settingModificationType?: "all" | "edit" | "add";
|
|
769
|
+
/** @description Price format. Parameter is currently unused. */
|
|
770
|
+
settingPriceFormat?: string;
|
|
771
|
+
/** @description Element defining the way of calculating product base price basing on prices of sizes. If value is not provided, the base price will be calculated basing on prices of sizes with stock levels. In case of lack of the stock levels, the base price will be calculated basing on prices of all sizes. Allowed values "all" - Product price calculated basing on prices of all sizes "available" - Product price calculated basing on prices of sizes with stock levels */
|
|
772
|
+
settingCalculateBasePriceSizes?: "all" | "available";
|
|
773
|
+
/** @description Object determines if new categories can be added when category linked with product couldn't be found in system. Allowed values "n" - adding new categories not allowed (default value), "y" - adding new categories is possible. */
|
|
774
|
+
settingAddingCategoryAllowed?: "n" | "y";
|
|
775
|
+
/** @description Object determines if new product sizes can be added when size linked with product couldn't be found in system. Allowed values "n" - adding new sizes not allowed (default value), "y" - adding new sizes is possible. */
|
|
776
|
+
settingAddingSizeAllowed?: "n" | "y";
|
|
777
|
+
/** @description Object determines if new producers can be added when producer linked with product couldn't be found in system. Allowed values "n" - you have no rights to add new manufacturers (default value), "y" - adding new producer is possible. */
|
|
778
|
+
settingAddingProducerAllowed?: "n" | "y";
|
|
779
|
+
/** @description Object determines if new product series can be added when series linked with product couldn't be found in system. Allowed values "n" - you have no rights to add new product series (default value), "y" - adding new series is possible. */
|
|
780
|
+
settingAddingSeriesAllowed?: "n" | "y";
|
|
781
|
+
/** @description Element determines, whether new size charts can be added, when no size chart assigned to sizes is not found in the system. Allowed values: "n" - adding new size charts not allowed. (default value), "y" - adding new size charts allowed. */
|
|
782
|
+
settingAddingSizeschartAllowed?: "n" | "y";
|
|
783
|
+
/** @description Object determines default category which will be linked with product when it will not be linked with any category.. */
|
|
784
|
+
settingDefaultCategory?: {
|
|
785
|
+
/** @description Category id */
|
|
786
|
+
categoryId?: number;
|
|
787
|
+
/** @description Category name */
|
|
788
|
+
categoryName?: string;
|
|
789
|
+
};
|
|
790
|
+
/** @description Element specifying the default size group that will be assigned to the new product in case no size group has been explicitly assigned. */
|
|
791
|
+
settingDefaultSizesGroup?: {
|
|
792
|
+
/** @description Size group ID Change of one size group to another results in zeroing all stock quantities in all stocks. Change of size group can be made, if product is not present in any unhandled orders nor listed on auctions. */
|
|
793
|
+
sizesGroupId?: number;
|
|
794
|
+
/** @description Size group name. */
|
|
795
|
+
sizesGroupName?: string;
|
|
796
|
+
};
|
|
797
|
+
/** @description Delimiter separating elements of text ID. Default:. "\". */
|
|
798
|
+
settingTextIdSeparator?: string;
|
|
799
|
+
/** @description Element indicating if retail price in special offer should be ignored. */
|
|
800
|
+
settingIgnoreRetailPricesInCaseOfPromotion?: "n" | "y";
|
|
801
|
+
/** @description Element indicating if information about special offer should be retrieved. */
|
|
802
|
+
returnPromotionStatus?: "n" | "y";
|
|
803
|
+
/** @description Element specifying whether the item is to be restored after deletion. */
|
|
804
|
+
settingsRestoreDeletedProducts?: "n" | "y";
|
|
805
|
+
/** @description The item shall determine whether the default visibility in stores can be set if a new commodity is to be created and no parameters have been uploaded to set visibility in at least one store.. */
|
|
806
|
+
settingsAddingDefaultShopMaskAllowed?: "n" | "y";
|
|
807
|
+
/** @description Element specifying whether the default visibility in stores can be set according to the list of stores indicated in the web import source configuration, if a new product will be created and no parameters have been sent to set visibility in at least one store.. */
|
|
808
|
+
settingsAddingManuallySelectedShopMaskAllowed?: number;
|
|
809
|
+
/** @description Element specifying whether the system should create a new provider in case of not finding one in the panel. */
|
|
810
|
+
settingAddingSupplierAllowed?: "n" | "y";
|
|
811
|
+
/** @description The element specifies how to update the product supplier Available values: "always" - (default value). - update in any case, "ifNecessary" - update when no supplier is assigned to the product, "none" - supplier update disabled. */
|
|
812
|
+
settingActualizeDelivererMode?: "always" | "ifNecessary" | "none";
|
|
813
|
+
/** @description Element specifying the mask of stores for which individual names and descriptions are to be removed.. */
|
|
814
|
+
settingDeleteIndividualDescriptionsByShopsMask?: {
|
|
815
|
+
/** @description Bit mask of shop IDs. Mask for indicated store is calculated on basis of following formula: 2^(store_ID - 1). If the product should be available in more than one shop, the masks should be summed up. */
|
|
816
|
+
shopsMask?: number;
|
|
817
|
+
};
|
|
818
|
+
/** @description Element that specifies the mask of stores for which individual meta updated products are to be removed.. */
|
|
819
|
+
settingDeleteIndividualMetaByShopsMask?: {
|
|
820
|
+
/** @description Bit mask of shop IDs. Mask for indicated store is calculated on basis of following formula: 2^(store_ID - 1). If the product should be available in more than one shop, the masks should be summed up. */
|
|
821
|
+
shopsMask?: number;
|
|
822
|
+
};
|
|
823
|
+
/** @description Automatically skip adding manufacturer code and external system code in the product when adding goods if a duplicate code is encountered in other products. */
|
|
824
|
+
settingsSkipDuplicatedProducers?: boolean;
|
|
825
|
+
};
|
|
826
|
+
/** @description Icon and photos settings */
|
|
827
|
+
picturesSettings?: {
|
|
828
|
+
/** @description Object determines photo URL. */
|
|
829
|
+
picturesSettingInitialUrlPart?: string;
|
|
830
|
+
/** @description Object determines the method of adding photos in "pictures" object. Allowed values "base64" - photos added in base64 coding algorithm, "url" - photos added as URLs to external systems. */
|
|
831
|
+
picturesSettingInputType?: "base64" | "url";
|
|
832
|
+
/** @description Object determines the method of adding product photos. Allowed values "n" - photos are uploaded from the first free place, "y" - photos are uploaded from the first place. */
|
|
833
|
+
picturesSettingOverwrite?: "n" | "y";
|
|
834
|
+
/** @description Element determining whether or not to delete existing merchandise images. */
|
|
835
|
+
picturesSettingDeleteProductPictures?: "n" | "y";
|
|
836
|
+
/** @description Element determining whether to delete existing commodity icons. */
|
|
837
|
+
picturesSettingDeleteProductIcons?: "n" | "y";
|
|
838
|
+
/** @description Element determining whether to remove the selected icon. */
|
|
839
|
+
picturesSettingDeleteIcon?: "default" | "versions" | "auctions";
|
|
840
|
+
/** @description Element determining whether or not to create icon from the selected photo . */
|
|
841
|
+
picturesSettingCreateIconFromPicture?: "default" | "versions" | "auctions";
|
|
842
|
+
/** @description Element determining whether to restore existing original images. */
|
|
843
|
+
picturesSettingRestoreOriginalPictures?: "n" | "y";
|
|
844
|
+
/** @description Element determining the type of icon whose original is to be restored, if any. */
|
|
845
|
+
picturesSettingRestoreOriginalIcons?: "default" | "versions" | "auctions" | "all";
|
|
846
|
+
/** @description Macro ID to be applied to images on the product. */
|
|
847
|
+
picturesSettingApplyMacroForPictures?: number;
|
|
848
|
+
/** @description Macro for the selected icon. */
|
|
849
|
+
picturesSettingApplyMacroForIcon?: {
|
|
850
|
+
/** @description Icon type. */
|
|
851
|
+
iconType?: "default" | "versions" | "auctions";
|
|
852
|
+
/** @description Macro identifier. */
|
|
853
|
+
macroId?: number;
|
|
854
|
+
};
|
|
855
|
+
/** @description Identifier of the shop for which the action is to be performed. */
|
|
856
|
+
picturesSettingShopId?: string;
|
|
857
|
+
/** @description Identifier of an external service for which the action is to be performed on photos in the goods. */
|
|
858
|
+
picturesSettingServiceId?: number;
|
|
859
|
+
/** @description Object determines if the photo should be scaled. Allowed values "n" - no scaling allowance, "y" - scaling allowance. */
|
|
860
|
+
picturesSettingScaling?: "n" | "y";
|
|
861
|
+
/** @description Element determining whether to delete existing original images. */
|
|
862
|
+
picturesSettingDeleteOriginalPictures?: "n" | "y";
|
|
863
|
+
/** @description Element specifying the type of icon whose original is to be deleted. */
|
|
864
|
+
picturesSettingDeleteOriginalIcons?: "default" | "versions" | "auctions" | "all";
|
|
865
|
+
/** @example picturesSettingRestoreBackupPicturesAndIconsByDateTime */
|
|
866
|
+
picturesSettingRestoreBackupPicturesAndIconsByDateTime?: string;
|
|
867
|
+
};
|
|
868
|
+
/** @description Products list. */
|
|
869
|
+
products: {
|
|
870
|
+
/** @description Product IAI code */
|
|
871
|
+
productId?: number;
|
|
872
|
+
/** @description One of the unique, indexed product codes (IAI code / External system code / Producer code) */
|
|
873
|
+
productIndex?: string;
|
|
874
|
+
/** @description External product system code for size. */
|
|
875
|
+
productSizeCodeExternal?: string;
|
|
876
|
+
/** @description Producer code for size. */
|
|
877
|
+
productSizeCodeProducer?: string;
|
|
878
|
+
/** @description External product system code. */
|
|
879
|
+
productDisplayedCode?: string;
|
|
880
|
+
/** @description PKWiU [PCPandS]. */
|
|
881
|
+
productTaxCode?: string;
|
|
882
|
+
/** @description Number of items in package data */
|
|
883
|
+
productInWrapper?: number;
|
|
884
|
+
/** @description Sold at - for retailers. */
|
|
885
|
+
productSellByRetail?: number;
|
|
886
|
+
/** @description Sold at - for wholesalers. */
|
|
887
|
+
productSellByWholesale?: number;
|
|
888
|
+
/** @description IdoSell Category ID */
|
|
889
|
+
categoryIdoSellId?: number;
|
|
890
|
+
/** @description IdoSell Category pathname */
|
|
891
|
+
categoryIdoSellPath?: string;
|
|
892
|
+
/** @description Category id */
|
|
893
|
+
categoryId?: number;
|
|
894
|
+
/** @description Category name */
|
|
895
|
+
categoryName?: string;
|
|
896
|
+
/** @description Brand ID */
|
|
897
|
+
producerId?: number;
|
|
898
|
+
/** @description Brand name */
|
|
899
|
+
producerName?: string;
|
|
900
|
+
/** @description CN/TARIC */
|
|
901
|
+
cnTaricCode?: string;
|
|
902
|
+
/** @description Country of origin. Country code in the ISO 3166-1 A2 standard */
|
|
903
|
+
countryOfOrigin?: string;
|
|
904
|
+
/** @description Product unit of measure ID. */
|
|
905
|
+
unitId?: number;
|
|
906
|
+
/** @description ID of series, to which product belongs. */
|
|
907
|
+
seriesId?: number;
|
|
908
|
+
/** @description Name of series, to which the product belongs, visible in panel. */
|
|
909
|
+
seriesPanelName?: string;
|
|
910
|
+
/** @description Size group ID Change of one size group to another results in zeroing all stock quantities in all stocks. Change of size group can be made, if product is not present in any unhandled orders nor listed on auctions. */
|
|
911
|
+
sizesGroupId?: number;
|
|
912
|
+
/** @description Size group name. */
|
|
913
|
+
sizesGroupName?: string;
|
|
914
|
+
/** @description Optional element, that determines prices edition mode. Default value is "amount_set", when indicated element is omitted in API gate call.. Allowed values "amount_set" - sets product prices to desired value (default mode), "amount_diff" - sets sum difference between prices set (adds or subtracts entered sum from the current price), "percent_diff" - sets percentage difference between prices set (adds or subtracts entered percent from the current price). */
|
|
915
|
+
priceChangeMode?: string;
|
|
916
|
+
/** @description Gross price */
|
|
917
|
+
productRetailPrice?: number;
|
|
918
|
+
/** @description Net retail price for every shop. */
|
|
919
|
+
productRetailPriceNet?: number;
|
|
920
|
+
/** @description Wholesale price */
|
|
921
|
+
productWholesalePrice?: number;
|
|
922
|
+
/** @description Net wholesale price for every shop. */
|
|
923
|
+
productWholesalePriceNet?: number;
|
|
924
|
+
/** @description Minimal price */
|
|
925
|
+
productMinimalPrice?: number;
|
|
926
|
+
/** @description Net minimum price for every shop. */
|
|
927
|
+
productMinimalPriceNet?: number;
|
|
928
|
+
/** @description Price for automatic calculations */
|
|
929
|
+
productAutomaticCalculationPrice?: number;
|
|
930
|
+
/** @description Price for automatic net calculations for each store */
|
|
931
|
+
productAutomaticCalculationPriceNet?: number;
|
|
932
|
+
/** @description price for POS. */
|
|
933
|
+
productPosPrice?: number;
|
|
934
|
+
/** @description price for POS. */
|
|
935
|
+
productPosPriceNet?: number;
|
|
936
|
+
/** @description Recommended retail price */
|
|
937
|
+
productSuggestedPrice?: number;
|
|
938
|
+
/** @description Suggested net commodity price. */
|
|
939
|
+
productSuggestedPriceNet?: number;
|
|
940
|
+
/** @description Strikethrough gross retail price */
|
|
941
|
+
productStrikethroughRetailPrice?: number;
|
|
942
|
+
/** @description Strikethrough net retail price */
|
|
943
|
+
productStrikethroughRetailPriceNet?: number;
|
|
944
|
+
/** @description Strikethrough gross wholesale price */
|
|
945
|
+
productStrikethroughWholesalePrice?: number;
|
|
946
|
+
/** @description Strikethrough net wholesale price */
|
|
947
|
+
productStrikethroughWholesalePriceNet?: number;
|
|
948
|
+
/** @description Value of VAT */
|
|
949
|
+
productVat?: number;
|
|
950
|
+
/** @description Is product VAT free Allowed values "y" - yes, "n" - no. */
|
|
951
|
+
productVatFree?: string;
|
|
952
|
+
/** @description Different prices for price comparison websites. */
|
|
953
|
+
productPriceComparisonSitesPrices?: {
|
|
954
|
+
/** @description price comparison website ID */
|
|
955
|
+
priceComparisonSiteId?: number;
|
|
956
|
+
/** @description Price for a price comparison website in a shop */
|
|
957
|
+
productPriceComparisonSitePrice?: number;
|
|
958
|
+
/** @description Net price for price comparison service in shop */
|
|
959
|
+
productPriceComparisonSitePriceNet?: number;
|
|
960
|
+
}[];
|
|
961
|
+
/** @description Object determines if the product is available in POS sale Available values: "n" - no, "y" - yes. */
|
|
962
|
+
productEnableInPos?: string;
|
|
963
|
+
/** @description Required advance payment in percents */
|
|
964
|
+
productAdvancePrice?: number;
|
|
965
|
+
/** @description Annotation. */
|
|
966
|
+
productNote?: string;
|
|
967
|
+
/** @description Settings of hotspots display. */
|
|
968
|
+
productHotspotsZones?: {
|
|
969
|
+
/** @description Is attribute set */
|
|
970
|
+
productHotspotIsEnabled?: boolean;
|
|
971
|
+
/** @description Shop Id */
|
|
972
|
+
shopId?: number;
|
|
973
|
+
/** @description Promotion for shop. */
|
|
974
|
+
productIsPromotion?: boolean;
|
|
975
|
+
/** @description Discount for shop. */
|
|
976
|
+
productIsDiscount?: boolean;
|
|
977
|
+
/** @description Distinguished product in store. */
|
|
978
|
+
productIsDistinguished?: boolean;
|
|
979
|
+
/** @description Special product in store. */
|
|
980
|
+
productIsSpecial?: boolean;
|
|
981
|
+
}[];
|
|
982
|
+
/** @description Loyalty points. */
|
|
983
|
+
priceInPoints?: {
|
|
984
|
+
/** @description Element determines what kind of operation should be performed. Allowed values: "clients_cost" - Clients who are allowed to buy selected products for points, "clients_award" - Clients can be awarded with points for buying selected products, "count_cost" - Number of points for which the selected products will be sold, "count_award" - Number of points clients will be rewarded for buying selected products. */
|
|
985
|
+
priceInPointsOperation?: string;
|
|
986
|
+
/** @description Shop Id */
|
|
987
|
+
shopId?: number;
|
|
988
|
+
/** @description Price in points for manual points quantity configuration. Price in points will be calculated on basis of default exchange rates set for indicated store, when this value is 0. */
|
|
989
|
+
priceInPointsPrice?: number;
|
|
990
|
+
/** @description Element determines for which customers prices will be changed. Allowed values: "retailers" - Prices will be changed for retail customers, "wholesalers" - Prices will be changed for wholesale customers, "both" - Prices will be changed for both retail and wholesale customers, "nobody" - This option is available only for setting determining, which customers can buy for points. Using this value turns off possibility of granting points or buying for points for both retail and wholesale customers. */
|
|
991
|
+
priceInPointsClients?: string;
|
|
992
|
+
};
|
|
993
|
+
/** @description Loyalty points. */
|
|
994
|
+
loyaltyPoints?: {
|
|
995
|
+
/** @description Shop Id */
|
|
996
|
+
shopId?: number;
|
|
997
|
+
/** @description Customer type. */
|
|
998
|
+
loyaltyPointsClientsType?: "retailers" | "wholesalers" | "both";
|
|
999
|
+
/** @description Operation. */
|
|
1000
|
+
loyaltyPointsOperation?: "disablePoints" | "setDefaults" | "setPoints";
|
|
1001
|
+
/** @description Loyalty points type. */
|
|
1002
|
+
loyaltyPointsType?: "awardClient" | "chargeClient" | "both";
|
|
1003
|
+
/** @description Number of points. */
|
|
1004
|
+
numberOfLoyaltyPoints?: number;
|
|
1005
|
+
}[];
|
|
1006
|
+
/** @description Weight. */
|
|
1007
|
+
productWeight?: number;
|
|
1008
|
+
/** @description Product visibility. Allowed values "y" - product visible, "n" - product not visible. */
|
|
1009
|
+
productInVisible?: string;
|
|
1010
|
+
/** @description Bit mask of shop IDs. Mask for indicated store is calculated on basis of following formula: 2^(store_ID - 1). If the product should be available in more than one shop, the masks should be summed up. */
|
|
1011
|
+
shopsMask?: number;
|
|
1012
|
+
/** @description Complex rating Available values: "0" - no, "1" - yes. */
|
|
1013
|
+
productComplexNotes?: number;
|
|
1014
|
+
/** @description Product visibility in export to price comparison and marketplaces. Available values: "y" - Visible, "selected" - Selected, "assign_selected" - Enable the visibility of the product in the export to price comparison sites passed in the priceComparisonSites node. Price comparison sites previously assigned to the commodity will be retained, "unassign_selected" - Disable product visibility in exports to price comparison sites passed in the priceComparisonSites node, "n" - invisible. */
|
|
1015
|
+
productInExportToPriceComparisonSites?: "y" | "selected" | "n";
|
|
1016
|
+
/** @description Selection of comparison sites for which the product visibility will be changed */
|
|
1017
|
+
priceComparisonSites?: {
|
|
1018
|
+
/** @description Shop Id */
|
|
1019
|
+
shopId?: number;
|
|
1020
|
+
/** @description price comparison website ID */
|
|
1021
|
+
priceComparisonSiteId?: number;
|
|
1022
|
+
}[];
|
|
1023
|
+
/** @description Visibility of an item in an export to Amazon Marketplace. Available values: "y" - Visible, "selected" - Visible on selected regional services, "n" - invisible. */
|
|
1024
|
+
productInExportToAmazonMarketplace?: string;
|
|
1025
|
+
/** @description Array */
|
|
1026
|
+
exportToAmazonMarketplacesList?: string[];
|
|
1027
|
+
/** @description Export sizes to Amazon: Available values: "y" - all, "n" - leave without change. */
|
|
1028
|
+
exportToAmazonExportAllSizes?: "n" | "y";
|
|
1029
|
+
/** @description Update merchandise inventory, on the Amazon side */
|
|
1030
|
+
exportAmazonUpdateStocks?: "n" | "y";
|
|
1031
|
+
/** @description Visibility of product during the import to Strefa Marek Allegro. Allowed values: "yes" - product visible in the export to Strefa Marek Allegro, "no" - product invisible in the export to Strefa Marek Allegro. */
|
|
1032
|
+
productInExportToStrefaMarekAllegro?: string;
|
|
1033
|
+
/** @description Profile ID which should be used when sending products to Strefa Marek Allegro. */
|
|
1034
|
+
productInExportToSmaPreset?: number;
|
|
1035
|
+
/** @description Availability profile ID. */
|
|
1036
|
+
availableProfile?: number;
|
|
1037
|
+
/** @description Discount profile ID */
|
|
1038
|
+
productRebate?: number;
|
|
1039
|
+
/** @description Product warranty ID. */
|
|
1040
|
+
warrantyId?: number;
|
|
1041
|
+
/** @description Name of warranty for indicated product. */
|
|
1042
|
+
warrantyName?: string;
|
|
1043
|
+
/** @description The JavaScript formula calculating prices */
|
|
1044
|
+
priceFormula?: {
|
|
1045
|
+
/** @description Formula parameters for calculating price */
|
|
1046
|
+
priceFormulaParameters?: string;
|
|
1047
|
+
/** @description Formula function for calculating price */
|
|
1048
|
+
priceFormulaFunction?: string;
|
|
1049
|
+
};
|
|
1050
|
+
/** @description Size chart ID */
|
|
1051
|
+
sizeChartId?: number;
|
|
1052
|
+
/** @description Size chart name */
|
|
1053
|
+
sizeChartName?: string;
|
|
1054
|
+
/** @description Priority. Allowed values from 1 to 10. */
|
|
1055
|
+
productPriority?: number;
|
|
1056
|
+
/** @description Product priority in menu node. */
|
|
1057
|
+
productPriorityInMenuNodes?: {
|
|
1058
|
+
/** @description Menu element ID. */
|
|
1059
|
+
productMenuNodeId?: number;
|
|
1060
|
+
/** @description Priority. Allowed values from 1 to 10. */
|
|
1061
|
+
productPriority?: number;
|
|
1062
|
+
/** @description Shop Id */
|
|
1063
|
+
shopId?: number;
|
|
1064
|
+
/** @description Tree menu ID. */
|
|
1065
|
+
productMenuTreeId?: number;
|
|
1066
|
+
}[];
|
|
1067
|
+
/** @description Product icon link. */
|
|
1068
|
+
productIconLink?: string;
|
|
1069
|
+
/** @description Photo without background. */
|
|
1070
|
+
productAuctionIconLink?: string;
|
|
1071
|
+
/** @description Icon for a product group. */
|
|
1072
|
+
productGroupIconLink?: string;
|
|
1073
|
+
/** @description List of product photos */
|
|
1074
|
+
productPictures?: {
|
|
1075
|
+
/** @description A picture in url or base64 (depends on pictures_input_type). */
|
|
1076
|
+
productPictureSource?: string;
|
|
1077
|
+
/** @description Shop Id */
|
|
1078
|
+
shopId?: number;
|
|
1079
|
+
/** @description List of stores IDs When mask is determined, this parameter is omitted. */
|
|
1080
|
+
shopsIds?: number[];
|
|
1081
|
+
/** @description External service identifiers */
|
|
1082
|
+
servicesIds?: number[];
|
|
1083
|
+
}[];
|
|
1084
|
+
/** @description List of a product's photos with indication of a particular number of the photo. */
|
|
1085
|
+
productPicturesReplace?: {
|
|
1086
|
+
/** @description A product photo's number. */
|
|
1087
|
+
productPictureNumber?: number;
|
|
1088
|
+
/** @description A picture in url or base64 (depends on pictures_input_type). */
|
|
1089
|
+
productPictureSource?: string;
|
|
1090
|
+
}[];
|
|
1091
|
+
/** @description Reduced price */
|
|
1092
|
+
productPromotion?: {
|
|
1093
|
+
/** @description Is attribute set */
|
|
1094
|
+
promoteIsEnabled?: string;
|
|
1095
|
+
/** @description Strikethrough price */
|
|
1096
|
+
promoteItemNormalPrice?: number;
|
|
1097
|
+
/** @description Net strikethrough price. */
|
|
1098
|
+
promoteItemNormalPriceNet?: number;
|
|
1099
|
+
/** @description Strikethrough wholesale price */
|
|
1100
|
+
promoteItemWholesaleNormalPrice?: number;
|
|
1101
|
+
/** @description Net wholesale strikethrough price. */
|
|
1102
|
+
promoteItemWholesaleNormalPriceNet?: number;
|
|
1103
|
+
/** @description Switching off date */
|
|
1104
|
+
promoteItemEndingDate?: string;
|
|
1105
|
+
};
|
|
1106
|
+
/** @description Discount for shop. */
|
|
1107
|
+
productDiscount?: {
|
|
1108
|
+
/** @description Is attribute set */
|
|
1109
|
+
promoteIsEnabled?: string;
|
|
1110
|
+
/** @description Strikethrough price */
|
|
1111
|
+
promoteItemNormalPrice?: number;
|
|
1112
|
+
/** @description Net strikethrough price. */
|
|
1113
|
+
promoteItemNormalPriceNet?: number;
|
|
1114
|
+
/** @description Strikethrough wholesale price */
|
|
1115
|
+
promoteItemWholesaleNormalPrice?: number;
|
|
1116
|
+
/** @description Net wholesale strikethrough price. */
|
|
1117
|
+
promoteItemWholesaleNormalPriceNet?: number;
|
|
1118
|
+
/** @description Switching off date */
|
|
1119
|
+
promoteItemEndingDate?: string;
|
|
1120
|
+
};
|
|
1121
|
+
/** @description Distinguished product in store. */
|
|
1122
|
+
productDistinguished?: {
|
|
1123
|
+
/** @description Is attribute set */
|
|
1124
|
+
promoteIsEnabled?: string;
|
|
1125
|
+
/** @description Strikethrough price */
|
|
1126
|
+
promoteItemNormalPrice?: number;
|
|
1127
|
+
/** @description Net strikethrough price. */
|
|
1128
|
+
promoteItemNormalPriceNet?: number;
|
|
1129
|
+
/** @description Strikethrough wholesale price */
|
|
1130
|
+
promoteItemWholesaleNormalPrice?: number;
|
|
1131
|
+
/** @description Switching off date */
|
|
1132
|
+
promoteItemEndingDate?: string;
|
|
1133
|
+
/** @description Net wholesale strikethrough price. */
|
|
1134
|
+
promoteItemWholesaleNormalPriceNet?: number;
|
|
1135
|
+
};
|
|
1136
|
+
/** @description Special product in store. */
|
|
1137
|
+
productSpecial?: {
|
|
1138
|
+
/** @description Is attribute set */
|
|
1139
|
+
promoteIsEnabled?: string;
|
|
1140
|
+
/** @description Strikethrough price */
|
|
1141
|
+
promoteItemNormalPrice?: number;
|
|
1142
|
+
/** @description Net strikethrough price. */
|
|
1143
|
+
promoteItemNormalPriceNet?: number;
|
|
1144
|
+
/** @description Strikethrough wholesale price */
|
|
1145
|
+
promoteItemWholesaleNormalPrice?: number;
|
|
1146
|
+
/** @description Net wholesale strikethrough price. */
|
|
1147
|
+
promoteItemWholesaleNormalPriceNet?: number;
|
|
1148
|
+
/** @description Switching off date */
|
|
1149
|
+
promoteItemEndingDate?: string;
|
|
1150
|
+
};
|
|
1151
|
+
/** @description Parameters (distinguished). */
|
|
1152
|
+
productParametersDistinction?: {
|
|
1153
|
+
/** @description Parameter ID */
|
|
1154
|
+
parameterId?: number;
|
|
1155
|
+
/** @description Parameter name. */
|
|
1156
|
+
parameterName?: string;
|
|
1157
|
+
/** @description Parameter value ID */
|
|
1158
|
+
parameterValueId?: number;
|
|
1159
|
+
/** @description Attributes group name. */
|
|
1160
|
+
parameterValueName?: string;
|
|
1161
|
+
}[];
|
|
1162
|
+
/** @description Configuration parameters */
|
|
1163
|
+
parametersConfigurable?: {
|
|
1164
|
+
/** @description Parameter ID */
|
|
1165
|
+
parameterId?: number;
|
|
1166
|
+
/** @description Parameter type. Available values: "disable" - Deletion, "input" - Text field, "radio" - Single-choice field, "checkbox" - Checkbox type multiple choice list, "select" - Drop-down single choice list. */
|
|
1167
|
+
priceConfigurableType?: "disable" | "input" | "radio" | "checkbox" | "select";
|
|
1168
|
+
/** @description Price modifier value */
|
|
1169
|
+
priceModifierValues?: {
|
|
1170
|
+
/** @description Parameter ID */
|
|
1171
|
+
parameterId?: number;
|
|
1172
|
+
/** @example 1 */
|
|
1173
|
+
modifierValue?: number;
|
|
1174
|
+
/** @description Available values: "amount" - in value, "percent" - percentage */
|
|
1175
|
+
modifierType?: "amount" | "percent";
|
|
1176
|
+
}[];
|
|
1177
|
+
}[];
|
|
1178
|
+
/** @description List of products recommended with this product */
|
|
1179
|
+
associatedProducts?: {
|
|
1180
|
+
/** @description Recommended product ID */
|
|
1181
|
+
associatedProductId?: number;
|
|
1182
|
+
/** @description Recommended product name */
|
|
1183
|
+
associatedProductName?: string;
|
|
1184
|
+
/** @description Recommended product code. External system code. */
|
|
1185
|
+
associatedProductCode?: string;
|
|
1186
|
+
}[];
|
|
1187
|
+
/** @description Sizes available for products data. */
|
|
1188
|
+
productSizes?: {
|
|
1189
|
+
/** @description Size identifier */
|
|
1190
|
+
sizeId?: string;
|
|
1191
|
+
/** @description Size name */
|
|
1192
|
+
sizePanelName?: string;
|
|
1193
|
+
/** @description Weight. */
|
|
1194
|
+
productWeight?: number;
|
|
1195
|
+
/** @description Net weight. */
|
|
1196
|
+
productWeightNet?: number;
|
|
1197
|
+
/** @description Last gross purchase price */
|
|
1198
|
+
productPurchasePriceGrossLast?: number;
|
|
1199
|
+
/** @description Last net purchase price */
|
|
1200
|
+
productPurchasePriceNetLast?: number;
|
|
1201
|
+
/** @description External product system code for size. */
|
|
1202
|
+
productSizeCodeExternal?: string;
|
|
1203
|
+
/** @description Product stock quantity data. */
|
|
1204
|
+
productStocksData?: {
|
|
1205
|
+
/** @description Stocks data */
|
|
1206
|
+
productStocksQuantities?: {
|
|
1207
|
+
/** @description Stock ID */
|
|
1208
|
+
stockId?: number;
|
|
1209
|
+
/** Format: decimal
|
|
1210
|
+
* @description Product stock quantity */
|
|
1211
|
+
productSizeQuantity?: number;
|
|
1212
|
+
/** Format: decimal
|
|
1213
|
+
* @description Product quantity to add up */
|
|
1214
|
+
productSizeQuantityToAdd?: number;
|
|
1215
|
+
/** Format: decimal
|
|
1216
|
+
* @description Product quantity to subtract */
|
|
1217
|
+
productSizeQuantityToSubstract?: number;
|
|
1218
|
+
/** @description Warehouse location ID */
|
|
1219
|
+
stockLocationId?: number;
|
|
1220
|
+
/** @description Warehouse location full path */
|
|
1221
|
+
stockLocationTextId?: string;
|
|
1222
|
+
/** @description Storage location code */
|
|
1223
|
+
stockLocationCode?: string;
|
|
1224
|
+
/** @description Additional locations */
|
|
1225
|
+
stockAdditionalLocations?: {
|
|
1226
|
+
/** @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. */
|
|
1227
|
+
stockAdditionalLocationSettings?: "add" | "remove";
|
|
1228
|
+
/** @description Warehouse location ID */
|
|
1229
|
+
stockAdditionalLocationId?: number;
|
|
1230
|
+
/** @description Warehouse location full path */
|
|
1231
|
+
stockAdditionalLocationTextId?: string;
|
|
1232
|
+
/** @description Storage location code */
|
|
1233
|
+
stockAdditionalLocationCode?: string;
|
|
1234
|
+
}[];
|
|
1235
|
+
}[];
|
|
1236
|
+
};
|
|
1237
|
+
/** @description Producer code for size. */
|
|
1238
|
+
productSizeCodeProducer?: string;
|
|
1239
|
+
/** @description Supplier code */
|
|
1240
|
+
productSizeCodeDeliverer?: string;
|
|
1241
|
+
}[];
|
|
1242
|
+
/** @description Product attachments list. */
|
|
1243
|
+
attachments?: {
|
|
1244
|
+
/** @description Attachment file link. */
|
|
1245
|
+
attachmentUrl?: string;
|
|
1246
|
+
/** @description Attachment name. */
|
|
1247
|
+
attachmentName?: {
|
|
1248
|
+
/** @description List of languages. */
|
|
1249
|
+
attachmentLanguages?: {
|
|
1250
|
+
/** @description Language ID */
|
|
1251
|
+
langId?: string;
|
|
1252
|
+
/** @description Language name */
|
|
1253
|
+
langName?: string;
|
|
1254
|
+
/** @description Literal in selected language. */
|
|
1255
|
+
langValue?: string;
|
|
1256
|
+
}[];
|
|
1257
|
+
};
|
|
1258
|
+
/** @description File type: audio, video, doc, other. */
|
|
1259
|
+
attachmentFileType?: "audio" | "video" | "doc" | "other" | "image";
|
|
1260
|
+
/** @description Type of customer, attachment should be available for: 'all','ordered','wholesaler','wholesaler_or_ordered','wholesaler_and_ordered'. */
|
|
1261
|
+
attachmentEnable?: "all" | "only_logged" | "ordered" | "wholesaler" | "wholesaler_or_orderer" | "wholesaler_and_ordered";
|
|
1262
|
+
/** @description Attachment ID. */
|
|
1263
|
+
attachmentId?: number;
|
|
1264
|
+
/** @description Attachment downloads record. */
|
|
1265
|
+
attachmentDownloadLog?: "y" | "n";
|
|
1266
|
+
/** @description Attachment file extension. */
|
|
1267
|
+
attachmentFileExtension?: string;
|
|
1268
|
+
/** @description Attachment number. */
|
|
1269
|
+
attachmentPriority?: number;
|
|
1270
|
+
/** @description Attachment document types list. */
|
|
1271
|
+
documentTypes?: {
|
|
1272
|
+
/** @description Document type. */
|
|
1273
|
+
documentType?: "energy_label" | "instruction_with_safety_information" | "user_manual" | "installation_instructions" | "product_card" | "guide" | "others";
|
|
1274
|
+
/** @description Additional description. */
|
|
1275
|
+
description?: string;
|
|
1276
|
+
}[];
|
|
1277
|
+
}[];
|
|
1278
|
+
/** @description The list of attachments to be deleted. */
|
|
1279
|
+
removeAttachments?: {
|
|
1280
|
+
/** @description Language ID */
|
|
1281
|
+
langId?: string;
|
|
1282
|
+
}[];
|
|
1283
|
+
/** @description Do you want to delete attachments for digital files. */
|
|
1284
|
+
virtualAttachmentsToRemove?: boolean;
|
|
1285
|
+
/** @description List of product's virtual attachments. */
|
|
1286
|
+
virtualAttachments?: {
|
|
1287
|
+
/** @description Attachment file link. */
|
|
1288
|
+
attachmentUrl?: string;
|
|
1289
|
+
/** @description Attachment name. */
|
|
1290
|
+
attachmentName?: {
|
|
1291
|
+
/** @description List of languages. */
|
|
1292
|
+
attachmentLanguages?: {
|
|
1293
|
+
/** @description Language ID */
|
|
1294
|
+
langId?: string;
|
|
1295
|
+
/** @description Language name */
|
|
1296
|
+
langName?: string;
|
|
1297
|
+
/** @description Literal in selected language. */
|
|
1298
|
+
langValue?: string;
|
|
1299
|
+
}[];
|
|
1300
|
+
};
|
|
1301
|
+
/** @description Full version or sample. */
|
|
1302
|
+
attachmentType?: "full" | "demo";
|
|
1303
|
+
/** @description Number of attachment downloads limit. */
|
|
1304
|
+
attachmentLimits?: {
|
|
1305
|
+
/** @description Number of downloads limit. */
|
|
1306
|
+
arrachmentDownloadsLimit?: number;
|
|
1307
|
+
/** @description Number of days file should be available. */
|
|
1308
|
+
arrachmentDaysLimit?: number;
|
|
1309
|
+
};
|
|
1310
|
+
/** @description Attachment ID. */
|
|
1311
|
+
attachmentId?: number;
|
|
1312
|
+
/** @description Attachment number. */
|
|
1313
|
+
attachmentPriority?: number;
|
|
1314
|
+
}[];
|
|
1315
|
+
/** @description Operation, that will be performed on attachments to product. */
|
|
1316
|
+
attachmentOperationValues?: "edit" | "add" | "remove";
|
|
1317
|
+
/** @description Data concerning attributes dependent on indicated stores with particular product assigned. */
|
|
1318
|
+
productShopsAttributes?: {
|
|
1319
|
+
/** @description Product visibility in store. */
|
|
1320
|
+
shopInVisible?: "y" | "n";
|
|
1321
|
+
/** @description Shop Id */
|
|
1322
|
+
shopId?: number;
|
|
1323
|
+
/** @description Prices for marketplaces */
|
|
1324
|
+
productAuctionsPrices?: {
|
|
1325
|
+
/** @description Auction site ID */
|
|
1326
|
+
auctionId?: number;
|
|
1327
|
+
/** @description Cost price. */
|
|
1328
|
+
auctionPrice?: number;
|
|
1329
|
+
/** @description Auction site page ID */
|
|
1330
|
+
auctionSiteId?: number;
|
|
1331
|
+
/** @description Size identifier */
|
|
1332
|
+
sizeId?: string;
|
|
1333
|
+
/** @description Auction starting price */
|
|
1334
|
+
auctionStartPrice?: number;
|
|
1335
|
+
/** @description Auction starting price net */
|
|
1336
|
+
auctionStartPriceNet?: number;
|
|
1337
|
+
/** @description "Buy It Now" price */
|
|
1338
|
+
auctionBuyNowPrice?: number;
|
|
1339
|
+
/** @description Kup Teraz price net. */
|
|
1340
|
+
auctionBuyNowPriceNet?: number;
|
|
1341
|
+
/** @description Minimal price */
|
|
1342
|
+
auctionMinimalPrice?: number;
|
|
1343
|
+
/** @description Minimal net price */
|
|
1344
|
+
auctionMinimalPriceNet?: number;
|
|
1345
|
+
/** @description Currency ID */
|
|
1346
|
+
currencyId?: string;
|
|
1347
|
+
/** @description External product system code for size. */
|
|
1348
|
+
productSizeCodeExternal?: string;
|
|
1349
|
+
/** @description Size name */
|
|
1350
|
+
sizePanelName?: string;
|
|
1351
|
+
}[];
|
|
1352
|
+
shopPriceComparersPrices?: {
|
|
1353
|
+
/** @description price comparison website ID */
|
|
1354
|
+
priceComparisonSiteId?: number;
|
|
1355
|
+
/** @description Price for a price comparison website in a shop */
|
|
1356
|
+
productPriceComparisonSitePrice?: number;
|
|
1357
|
+
/** @description Net price for price comparison service in shop */
|
|
1358
|
+
productPriceComparisonSitePriceNet?: number;
|
|
1359
|
+
/** @description Percentage difference between the price comparison website and the shop */
|
|
1360
|
+
productPriceComparisonSitePercentDiff?: number;
|
|
1361
|
+
/** @description Forced rounding up method. */
|
|
1362
|
+
priceRoundMode?: "none" | "00" | "x0" | "99" | "x9";
|
|
1363
|
+
}[];
|
|
1364
|
+
/** @description Gross price */
|
|
1365
|
+
productRetailPrice?: number;
|
|
1366
|
+
/** @description Net retail price for every shop. */
|
|
1367
|
+
productRetailPriceNet?: number;
|
|
1368
|
+
/** @description Wholesale price */
|
|
1369
|
+
productWholesalePrice?: number;
|
|
1370
|
+
/** @description Net wholesale price for every shop. */
|
|
1371
|
+
productWholesalePriceNet?: number;
|
|
1372
|
+
/** @description Minimal price */
|
|
1373
|
+
productMinimalPrice?: number;
|
|
1374
|
+
/** @description Net minimum price for every shop. */
|
|
1375
|
+
productMinimalPriceNet?: number;
|
|
1376
|
+
/** @description Price settings, possible values: "wholesale_equals_retail" - Wholesale price same as retail price, "wholesale_notequals_retail" - Wholesale price different than retail price, "all_prices_equals_zero" - All prices request a quote by phone, "retail_price_equals_zero" - Retail price on call, "default_prices" - default prices, "retail_equals_suggested" - Retail price is the same as recommended one, "automatically_calculated" - Price calculated automatically. */
|
|
1377
|
+
productPricesConfig?: "default_prices" | "wholesale_equals_retail" | "wholesale_notequals_retail" | "all_prices_equals_zero" | "retail_price_equals_zero" | "retail_equals_suggested" | "automatically_calculated" | "sizes_price_as_base_price";
|
|
1378
|
+
/** @description Recommended retail price */
|
|
1379
|
+
productSuggestedPrice?: number;
|
|
1380
|
+
/** @description Suggested net commodity price. */
|
|
1381
|
+
productSuggestedPriceNet?: number;
|
|
1382
|
+
/** @description Strikethrough gross retail price */
|
|
1383
|
+
productStrikethroughRetailPrice?: number;
|
|
1384
|
+
/** @description Strikethrough net retail price */
|
|
1385
|
+
productStrikethroughRetailPriceNet?: number;
|
|
1386
|
+
/** @description Strikethrough gross wholesale price */
|
|
1387
|
+
productStrikethroughWholesalePrice?: number;
|
|
1388
|
+
/** @description Strikethrough net wholesale price */
|
|
1389
|
+
productStrikethroughWholesalePriceNet?: number;
|
|
1390
|
+
/** @description Configuration details for setting of parameter prices_config=default_prices. */
|
|
1391
|
+
productConfigPricesDefaultShop?: number;
|
|
1392
|
+
/** @description Forced rounding up method. */
|
|
1393
|
+
priceRoundMode?: "none" | "00" | "x0" | "99" | "x9";
|
|
1394
|
+
/** @description Configuration details for setting of parameter prices_config=automatically_calculated. */
|
|
1395
|
+
productPricesConfigAutomatonDetails?: {
|
|
1396
|
+
/** @description Price name, one of values: retail, wholsale, minimal. */
|
|
1397
|
+
priceAutomatonPriceName?: "retail" | "wholesale" | "minimal" | "automatic_calculation";
|
|
1398
|
+
/** @description Price setting, one of values: own, last_purchased, avarage_purchased, retail, wholsale, minimal */
|
|
1399
|
+
priceAutomatonPriceSettings?: "own" | "last_purchased" | "avarage_purchased" | "retail" | "wholesale" | "minimal" | "automatic_calculation";
|
|
1400
|
+
/** @description Price type, one of values: gross, net */
|
|
1401
|
+
priceAutomatonPriceType?: "gross" | "net";
|
|
1402
|
+
/** @description Final amount */
|
|
1403
|
+
priceAutomatonPriceValue?: number;
|
|
1404
|
+
/** @description Final amount currency */
|
|
1405
|
+
priceAutomatonPriceCurrencyId?: string;
|
|
1406
|
+
/** @description shop ID from which price is retrieved */
|
|
1407
|
+
priceAutomatonPriceShop?: number;
|
|
1408
|
+
/** @description Amount margin */
|
|
1409
|
+
priceAutomatonMarginCurrencyValue?: number;
|
|
1410
|
+
/** @description Amount margin currency */
|
|
1411
|
+
priceAutomatonMarginCurrencyId?: string;
|
|
1412
|
+
/** @description Percentage margin */
|
|
1413
|
+
priceAutomatonMarginPercentValue?: number;
|
|
1414
|
+
/** @description Minimal value of percentage margin */
|
|
1415
|
+
priceAutomatonPricePercentMinimalValue?: number;
|
|
1416
|
+
/** @description Minimal value of percentage margin currency */
|
|
1417
|
+
priceAutomatonPricePercentMinimalCurrencyId?: string;
|
|
1418
|
+
/** @description Minimal amount with margins reflected */
|
|
1419
|
+
priceAutomatonPriceMinimalValue?: number;
|
|
1420
|
+
/** @description Minimal amount currency */
|
|
1421
|
+
priceAutomatonPriceMinimalCurrencyId?: string;
|
|
1422
|
+
/** @description Decimal complement should contain 0 to 2 digits. If it contains 0 digits, the system will calculate the amount with precision of up to 2 decimal places. If it contains 2 digits, the system will calculate the amount with precision of the total number and will add the value of this field as a decimal part of this amount */
|
|
1423
|
+
priceAutomatonDecimalRoundValue?: string;
|
|
1424
|
+
}[];
|
|
1425
|
+
/** @description Parameters set for auction sites */
|
|
1426
|
+
productAuctions?: {
|
|
1427
|
+
/** @description Auction site ID */
|
|
1428
|
+
auctionId?: number;
|
|
1429
|
+
/** @description Auction site page ID */
|
|
1430
|
+
auctionSiteId?: number;
|
|
1431
|
+
/** @description Price settings, possible values: "manual" - Price entered manually, "automatically_calculated" - Price calculated automatically. */
|
|
1432
|
+
auctionPricesConfig?: "manual" | "automatically_calculated";
|
|
1433
|
+
/** @description Configuration details for setting of parameter prices_config=automatically_calculated */
|
|
1434
|
+
auctionPricesConfigAutomatonDetails?: {
|
|
1435
|
+
/** @description Price name, one of values: buy_now, start, minimal_auction */
|
|
1436
|
+
auctionPriceAutomatonPriceName?: "buy_now" | "start" | "minimal_auction";
|
|
1437
|
+
/** @description Price setting, one of values: own, last_purchased, avarage_purchased, retail, wholsale, minimal, buy_now, start, minimal_auction. */
|
|
1438
|
+
auctionPriceAutomatonPriceSettings?: "own" | "last_purchased" | "avarage_purchased" | "retail" | "wholesale" | "minimal" | "automatic_calculation" | "buy_now" | "start" | "minimal_auction";
|
|
1439
|
+
/** @description Price type, one of values: gross, net */
|
|
1440
|
+
priceAutomatonPriceType?: "gross" | "net";
|
|
1441
|
+
/** @description Final amount */
|
|
1442
|
+
priceAutomatonPriceValue?: number;
|
|
1443
|
+
/** @description Final amount currency */
|
|
1444
|
+
priceAutomatonPriceCurrencyId?: string;
|
|
1445
|
+
/** @description shop ID from which price is retrieved */
|
|
1446
|
+
priceAutomatonPriceShop?: number;
|
|
1447
|
+
/** @description Amount margin */
|
|
1448
|
+
priceAutomatonMarginCurrencyValue?: number;
|
|
1449
|
+
/** @description Amount margin currency */
|
|
1450
|
+
priceAutomatonMarginCurrencyId?: string;
|
|
1451
|
+
/** @description Percentage margin */
|
|
1452
|
+
priceAutomatonMarginPercentValue?: number;
|
|
1453
|
+
/** @description Minimal value of percentage margin */
|
|
1454
|
+
priceAutomatonPricePercentMinimalValue?: number;
|
|
1455
|
+
/** @description Minimal value of percentage margin currency */
|
|
1456
|
+
priceAutomatonPricePercentMinimalCurrencyId?: string;
|
|
1457
|
+
/** @description Minimal amount with margins reflected */
|
|
1458
|
+
priceAutomatonPriceMinimalValue?: number;
|
|
1459
|
+
/** @description Minimal amount currency */
|
|
1460
|
+
priceAutomatonPriceMinimalCurrencyId?: string;
|
|
1461
|
+
/** @description Decimal complement should contain 0 to 2 digits. If it contains 0 digits, the system will calculate the amount with precision of up to 2 decimal places. If it contains 2 digits, the system will calculate the amount with precision of the total number and will add the value of this field as a decimal part of this amount */
|
|
1462
|
+
priceAutomatonDecimalRoundValue?: string;
|
|
1463
|
+
}[];
|
|
1464
|
+
/** @description Parameters for sizes */
|
|
1465
|
+
productAuctionsSizes?: {
|
|
1466
|
+
/** @description Size identifier */
|
|
1467
|
+
sizeId?: string;
|
|
1468
|
+
/** @description Size name */
|
|
1469
|
+
sizePanelName?: string;
|
|
1470
|
+
/** @description Configuration details for setting of parameter prices_config=automatically_calculated */
|
|
1471
|
+
auctionPricesConfigAutomatonDetails?: {
|
|
1472
|
+
/** @description Price name, one of values: buy_now, start, minimal_auction */
|
|
1473
|
+
auctionPriceAutomatonPriceName?: "buy_now" | "start" | "minimal_auction";
|
|
1474
|
+
/** @description Price setting, one of values: own, last_purchased, avarage_purchased, retail, wholsale, minimal, buy_now, start, minimal_auction. */
|
|
1475
|
+
auctionPriceAutomatonPriceSettings?: "own" | "last_purchased" | "avarage_purchased" | "retail" | "wholesale" | "minimal" | "buy_now" | "start" | "minimal_auction" | "automatic_calculation";
|
|
1476
|
+
/** @description Price type, one of values: gross, net */
|
|
1477
|
+
priceAutomatonPriceType?: "gross" | "net";
|
|
1478
|
+
/** @description Final amount */
|
|
1479
|
+
priceAutomatonPriceValue?: number;
|
|
1480
|
+
/** @description Final amount currency */
|
|
1481
|
+
priceAutomatonPriceCurrencyId?: string;
|
|
1482
|
+
/** @description shop ID from which price is retrieved */
|
|
1483
|
+
priceAutomatonPriceShop?: number;
|
|
1484
|
+
/** @description Amount margin */
|
|
1485
|
+
priceAutomatonMarginCurrencyValue?: number;
|
|
1486
|
+
/** @description Amount margin currency */
|
|
1487
|
+
priceAutomatonMarginCurrencyId?: string;
|
|
1488
|
+
/** @description Percentage margin */
|
|
1489
|
+
priceAutomatonMarginPercentValue?: number;
|
|
1490
|
+
/** @description Minimal value of percentage margin */
|
|
1491
|
+
priceAutomatonPricePercentMinimalValue?: number;
|
|
1492
|
+
/** @description Minimal value of percentage margin currency */
|
|
1493
|
+
priceAutomatonPricePercentMinimalCurrencyId?: string;
|
|
1494
|
+
/** @description Minimal amount with margins reflected */
|
|
1495
|
+
priceAutomatonPriceMinimalValue?: number;
|
|
1496
|
+
/** @description Minimal amount currency */
|
|
1497
|
+
priceAutomatonPriceMinimalCurrencyId?: string;
|
|
1498
|
+
/** @description Decimal complement should contain 0 to 2 digits. If it contains 0 digits, the system will calculate the amount with precision of up to 2 decimal places. If it contains 2 digits, the system will calculate the amount with precision of the total number and will add the value of this field as a decimal part of this amount */
|
|
1499
|
+
priceAutomatonDecimalRoundValue?: string;
|
|
1500
|
+
}[];
|
|
1501
|
+
}[];
|
|
1502
|
+
}[];
|
|
1503
|
+
/** @description Set the same price for auction sites as in store. */
|
|
1504
|
+
setTheSamePriceForAuctionAsInStore?: boolean;
|
|
1505
|
+
/** @description Parameters set for price comparison websites */
|
|
1506
|
+
productShopPriceComparisonSites?: {
|
|
1507
|
+
/** @description price comparison website ID */
|
|
1508
|
+
priceComparisonSiteId?: number;
|
|
1509
|
+
/** @description price comparison website name */
|
|
1510
|
+
priceComparisonSiteName?: string;
|
|
1511
|
+
/** @description Price settings, possible values: "manual" - Price entered manually, "automatically_calculated" - Price calculated automatically. */
|
|
1512
|
+
priceComparisonSitePricesConfig?: "manual" | "automatically_calculated";
|
|
1513
|
+
/** @description Configuration details for setting of parameter prices_config=automatically_calculated */
|
|
1514
|
+
priceComparisonSitePriceConfigAutomatonDetails?: {
|
|
1515
|
+
/** @description Price setting, one of values: own, last_purchased, avarage_purchased, retail, wholsale, minimal */
|
|
1516
|
+
priceAutomatonPriceSettings?: "own" | "last_purchased" | "avarage_purchased" | "retail" | "wholesale" | "minimal";
|
|
1517
|
+
/** @description Price type, one of values: gross, net */
|
|
1518
|
+
priceAutomatonPriceType?: "gross" | "net";
|
|
1519
|
+
/** @description Final amount */
|
|
1520
|
+
priceAutomatonPriceValue?: number;
|
|
1521
|
+
/** @description Final amount currency */
|
|
1522
|
+
priceAutomatonPriceCurrencyId?: string;
|
|
1523
|
+
/** @description shop ID from which price is retrieved */
|
|
1524
|
+
priceAutomatonPriceShop?: number;
|
|
1525
|
+
/** @description Amount margin */
|
|
1526
|
+
priceAutomatonMarginCurrencyValue?: number;
|
|
1527
|
+
/** @description Amount margin currency */
|
|
1528
|
+
priceAutomatonMarginCurrencyId?: string;
|
|
1529
|
+
/** @description Percentage margin */
|
|
1530
|
+
priceAutomatonMarginPercentValue?: number;
|
|
1531
|
+
/** @description Minimal value of percentage margin */
|
|
1532
|
+
priceAutomatonPricePercentMinimalValue?: number;
|
|
1533
|
+
/** @description Minimal value of percentage margin currency */
|
|
1534
|
+
priceAutomatonPricePercentMinimalCurrencyId?: string;
|
|
1535
|
+
/** @description Minimal amount with margins reflected */
|
|
1536
|
+
priceAutomatonPriceMinimalValue?: number;
|
|
1537
|
+
/** @description Minimal amount currency */
|
|
1538
|
+
priceAutomatonPriceMinimalCurrencyId?: string;
|
|
1539
|
+
/** @description Decimal complement should contain 0 to 2 digits. If it contains 0 digits, the system will calculate the amount with precision of up to 2 decimal places. If it contains 2 digits, the system will calculate the amount with precision of the total number and will add the value of this field as a decimal part of this amount */
|
|
1540
|
+
priceAutomatonDecimalRoundValue?: string;
|
|
1541
|
+
};
|
|
1542
|
+
}[];
|
|
1543
|
+
}[];
|
|
1544
|
+
/** @description Products subscription settings. */
|
|
1545
|
+
subscription?: {
|
|
1546
|
+
/** @description Shop Id */
|
|
1547
|
+
shopId?: number;
|
|
1548
|
+
/** @description Is subscription enabled for product */
|
|
1549
|
+
enabled?: boolean;
|
|
1550
|
+
/** @description Days in period */
|
|
1551
|
+
daysInPeriod?: number[];
|
|
1552
|
+
/** @description Sold at - for retailers. */
|
|
1553
|
+
unitsNumberRetail?: number;
|
|
1554
|
+
/** @description Sold at - for wholesalers. */
|
|
1555
|
+
unitsNumberWholesale?: number;
|
|
1556
|
+
}[];
|
|
1557
|
+
/** @description Product name. */
|
|
1558
|
+
productNames?: {
|
|
1559
|
+
productNamesLangData?: {
|
|
1560
|
+
/** @description Language ID */
|
|
1561
|
+
langId?: string;
|
|
1562
|
+
/** @description Product name. */
|
|
1563
|
+
productName?: string;
|
|
1564
|
+
/** @description Shop Id */
|
|
1565
|
+
shopId?: number;
|
|
1566
|
+
/** @description External service identifier */
|
|
1567
|
+
serviceId?: number;
|
|
1568
|
+
}[];
|
|
1569
|
+
};
|
|
1570
|
+
/** @description DEPRECATED. This parameter is deprecated. Product name for online auctions. */
|
|
1571
|
+
productNamesInAuction?: {
|
|
1572
|
+
productNamesInAuctionLangData?: {
|
|
1573
|
+
/** @description Language ID */
|
|
1574
|
+
langId?: string;
|
|
1575
|
+
/** @example productNameInAuction */
|
|
1576
|
+
productNameInAuction?: string;
|
|
1577
|
+
}[];
|
|
1578
|
+
};
|
|
1579
|
+
/** @description Product name for price comparison websites. */
|
|
1580
|
+
productNamesInPriceComparer?: {
|
|
1581
|
+
productNamesInPriceComparerLangData?: {
|
|
1582
|
+
/** @description Language ID */
|
|
1583
|
+
langId?: string;
|
|
1584
|
+
/** @description Product name for price comparison websites. */
|
|
1585
|
+
productNameInPriceComparer?: string;
|
|
1586
|
+
}[];
|
|
1587
|
+
};
|
|
1588
|
+
/** @description Product short description */
|
|
1589
|
+
productParamDescriptions?: {
|
|
1590
|
+
productParamDescriptionsLangData?: {
|
|
1591
|
+
/** @description Language ID */
|
|
1592
|
+
langId?: string;
|
|
1593
|
+
/** @description Product short description */
|
|
1594
|
+
productParamDescriptions?: string;
|
|
1595
|
+
/** @description Shop Id */
|
|
1596
|
+
shopId?: number;
|
|
1597
|
+
/** @description External service identifier */
|
|
1598
|
+
serviceId?: number;
|
|
1599
|
+
}[];
|
|
1600
|
+
};
|
|
1601
|
+
/** @description Long product description */
|
|
1602
|
+
productLongDescriptions?: {
|
|
1603
|
+
productLongDescriptionsLangData?: {
|
|
1604
|
+
/** @description Language ID */
|
|
1605
|
+
langId?: string;
|
|
1606
|
+
/** @description Long product description. */
|
|
1607
|
+
productLongDescription?: string;
|
|
1608
|
+
/** @description Shop Id */
|
|
1609
|
+
shopId?: number;
|
|
1610
|
+
/** @description External service identifier */
|
|
1611
|
+
serviceId?: number;
|
|
1612
|
+
}[];
|
|
1613
|
+
};
|
|
1614
|
+
/** @description DEPRECATED. This parameter is deprecated. Product description for marketplaces. */
|
|
1615
|
+
productLongDescriptionsInAuction?: {
|
|
1616
|
+
productLongDescriptionsInAuctionLangData?: {
|
|
1617
|
+
/** @description Language ID */
|
|
1618
|
+
langId?: string;
|
|
1619
|
+
/** @example productLongDescriptionInAuction */
|
|
1620
|
+
productLongDescriptionInAuction?: string;
|
|
1621
|
+
}[];
|
|
1622
|
+
};
|
|
1623
|
+
/** @description Product data for auction services */
|
|
1624
|
+
productAuctionDescriptionsData?: {
|
|
1625
|
+
/** @description Auction system ID */
|
|
1626
|
+
productAuctionId?: string;
|
|
1627
|
+
/** @description Auction site ID */
|
|
1628
|
+
productAuctionSiteId?: string;
|
|
1629
|
+
/** @description Product name for auction service. */
|
|
1630
|
+
productAuctionName?: string;
|
|
1631
|
+
/** @description Subtitle for auction service */
|
|
1632
|
+
productAuctionAdditionalName?: string;
|
|
1633
|
+
/** @description Product description for marketplaces */
|
|
1634
|
+
productAuctionDescription?: string;
|
|
1635
|
+
}[];
|
|
1636
|
+
/** @description Product meta title */
|
|
1637
|
+
productMetaTitles?: {
|
|
1638
|
+
productMetaTitlesLangData?: {
|
|
1639
|
+
/** @description Shop Id */
|
|
1640
|
+
shopId?: number;
|
|
1641
|
+
/** @description Language ID */
|
|
1642
|
+
langId?: string;
|
|
1643
|
+
/** @description Language name */
|
|
1644
|
+
langName?: string;
|
|
1645
|
+
/** @description Product meta title. */
|
|
1646
|
+
productMetaTitle?: string;
|
|
1647
|
+
}[];
|
|
1648
|
+
};
|
|
1649
|
+
/** @description Product meta description */
|
|
1650
|
+
productMetaDescriptions?: {
|
|
1651
|
+
productMetaDescriptionsLangData?: {
|
|
1652
|
+
/** @description Shop Id */
|
|
1653
|
+
shopId?: number;
|
|
1654
|
+
/** @description Language ID */
|
|
1655
|
+
langId?: string;
|
|
1656
|
+
/** @description Language name */
|
|
1657
|
+
langName?: string;
|
|
1658
|
+
/** @description Product meta description. */
|
|
1659
|
+
productMetaDescription?: string;
|
|
1660
|
+
}[];
|
|
1661
|
+
};
|
|
1662
|
+
/** @description Product meta keywords. */
|
|
1663
|
+
productMetaKeywords?: {
|
|
1664
|
+
productMetaKeywordsLangData?: {
|
|
1665
|
+
/** @description Shop Id */
|
|
1666
|
+
shopId?: number;
|
|
1667
|
+
/** @description Language ID */
|
|
1668
|
+
langId?: string;
|
|
1669
|
+
/** @description Language name */
|
|
1670
|
+
langName?: string;
|
|
1671
|
+
/** @description Product meta keywords. */
|
|
1672
|
+
productMetaKeyword?: string;
|
|
1673
|
+
}[];
|
|
1674
|
+
};
|
|
1675
|
+
/** @description URL for the product */
|
|
1676
|
+
productUrl?: {
|
|
1677
|
+
productUrlsLangData?: {
|
|
1678
|
+
/** @description Shop Id */
|
|
1679
|
+
shopId?: number;
|
|
1680
|
+
/** @description Language ID */
|
|
1681
|
+
langId?: string;
|
|
1682
|
+
/** @example url */
|
|
1683
|
+
url?: string;
|
|
1684
|
+
}[];
|
|
1685
|
+
};
|
|
1686
|
+
/** @description Data on product groups (variants) */
|
|
1687
|
+
productVersion?: {
|
|
1688
|
+
/** @description ID of the main item (variant) in the group. */
|
|
1689
|
+
versionParent?: {
|
|
1690
|
+
/** @description Value. */
|
|
1691
|
+
versionParentId?: string;
|
|
1692
|
+
/** @description Identifier type. */
|
|
1693
|
+
versionParentType?: "id" | "codeExtern" | "codeProducer";
|
|
1694
|
+
};
|
|
1695
|
+
/** @description The order of products in the group. Value needs to be more than 0. */
|
|
1696
|
+
versionPriority?: number;
|
|
1697
|
+
/** @description Settings for groups of items (variants) */
|
|
1698
|
+
versionSettings?: {
|
|
1699
|
+
/** @description Show in shop. Available values: "y" - all products from group, "n" - only the first product from group. */
|
|
1700
|
+
versionDisplayAllInShop?: string;
|
|
1701
|
+
/** @description Show in panel. Available values: "y" - wszystkie towary z grupy, "n" - only the first product from group. */
|
|
1702
|
+
versionDisplayAllInPanel?: string;
|
|
1703
|
+
/** @description Adding the canonical links to the site. Available values: "y" - on, "n" - Off. */
|
|
1704
|
+
versionDisplayRelCanonicalInShop?: string;
|
|
1705
|
+
/** @description The same code. Available values: "y" - yes, "n" - no. */
|
|
1706
|
+
versionCommonCode?: string;
|
|
1707
|
+
/** @description The same brand. Available values: "y" - yes, "n" - no. */
|
|
1708
|
+
versionCommonProducer?: string;
|
|
1709
|
+
/** @description The same annotation. Available values: "y" - yes, "n" - no. */
|
|
1710
|
+
versionCommonNote?: string;
|
|
1711
|
+
/** @description The same warranty. Available values: "y" - yes, "n" - no. */
|
|
1712
|
+
versionCommonWarranty?: string;
|
|
1713
|
+
/** @description The same for size chart. Available values: "y" - yes, "n" - no. */
|
|
1714
|
+
versionCommonSizesChart?: string;
|
|
1715
|
+
/** @description The same series. Available values: "y" - yes, "n" - no. */
|
|
1716
|
+
versionCommonSeries?: string;
|
|
1717
|
+
/** @description The same category. Available values: "y" - yes, "n" - no. */
|
|
1718
|
+
versionCommonCategory?: string;
|
|
1719
|
+
/** @description The same price. Available values: "y" - yes, "n" - no. */
|
|
1720
|
+
versionCommonPrice?: string;
|
|
1721
|
+
/** @description Same advance. Available values: "y" - yes, "n" - no. */
|
|
1722
|
+
versionCommonAdvance?: string;
|
|
1723
|
+
/** @description Same quantity discount. Available values: "y" - yes, "n" - no. */
|
|
1724
|
+
versionCommonRebate?: string;
|
|
1725
|
+
/** @description the same VAT rate. Available values: "y" - yes, "n" - no. */
|
|
1726
|
+
versionCommonVat?: string;
|
|
1727
|
+
/** @description The same loyalty points. Available values: "y" - yes, "n" - no. */
|
|
1728
|
+
versionCommonProfitPoints?: string;
|
|
1729
|
+
/** @description The same related product. Available values: "y" - yes, "n" - no. */
|
|
1730
|
+
versionCommonAssociated?: string;
|
|
1731
|
+
/** @description The same visibility. Available values: "y" - yes, "n" - no. */
|
|
1732
|
+
versionCommonVisibility?: string;
|
|
1733
|
+
/** @description The same priority. Available values: "y" - yes, "n" - no. */
|
|
1734
|
+
versionCommonPriority?: string;
|
|
1735
|
+
/** @description The same shops. Available values: "y" - yes, "n" - no. */
|
|
1736
|
+
versionCommonShops?: string;
|
|
1737
|
+
/** @description The same sizes. Available values: "y" - yes, "n" - no. */
|
|
1738
|
+
versionCommonSizes?: string;
|
|
1739
|
+
/** @description The same weight. Available values: "y" - yes, "n" - no. */
|
|
1740
|
+
versionCommonWeight?: string;
|
|
1741
|
+
/** @description The same name. Available values: "y" - yes, "n" - no. */
|
|
1742
|
+
versionCommonName?: string;
|
|
1743
|
+
/** @description The same product's name for Internet auctions. Available values: "y" - yes, "n" - no. */
|
|
1744
|
+
versionCommonAuctionName?: string;
|
|
1745
|
+
/** @description The same short description. Available values: "y" - yes, "n" - no. */
|
|
1746
|
+
versionCommonDescription?: string;
|
|
1747
|
+
/** @description The same long description. Available values: "y" - yes, "n" - no. */
|
|
1748
|
+
versionCommonLongDescription?: string;
|
|
1749
|
+
/** @description The same icon. Available values: "y" - yes, "n" - no. */
|
|
1750
|
+
versionCommonIcon?: string;
|
|
1751
|
+
/** @description The same large photos. Available values: "y" - yes, "n" - no. */
|
|
1752
|
+
versionCommonPhotos?: string;
|
|
1753
|
+
/** @description The same availability profile. Available values: "y" - yes, "n" - no. */
|
|
1754
|
+
versionCommonAvailableProfile?: string;
|
|
1755
|
+
/** @description The same complex rating. Available values: "y" - yes, "n" - no. */
|
|
1756
|
+
versionCommonComplexNotes?: string;
|
|
1757
|
+
/** @description Do You wish to sum up the products in the basket as a one order? Available values: "y" - yes, "n" - no. */
|
|
1758
|
+
versionCommonSumInBasket?: string;
|
|
1759
|
+
/** @description The same objects in menu Available values: "y" - yes, "n" - no. */
|
|
1760
|
+
versionCommonMenuItems?: string;
|
|
1761
|
+
/** @description The same supplier. Available values: "y" - yes, "n" - no. */
|
|
1762
|
+
versionCommonDeliverer?: string;
|
|
1763
|
+
/** @description The same attachments Available values: "y" - yes, "n" - no. */
|
|
1764
|
+
versionCommonAttachments?: string;
|
|
1765
|
+
/** @description The same icons for auctions Available values: "y" - yes, "n" - no. */
|
|
1766
|
+
versionCommonAuctionIcon?: string;
|
|
1767
|
+
/** @description The same serial numbers Available values: "y" - yes, "n" - no. */
|
|
1768
|
+
versionCommonSerialNumbers?: string;
|
|
1769
|
+
/** @description The same parameters. possible values "y" - yes, "n" - no. */
|
|
1770
|
+
versionCommonDictionary?: string;
|
|
1771
|
+
/** @description Same promotions Available values: "y" - yes, "n" - no. */
|
|
1772
|
+
versionCommonPromotions?: string;
|
|
1773
|
+
/** @description The same meta settings Available values: "y" - yes, "n" - no. */
|
|
1774
|
+
versionCommonMetaTags?: string;
|
|
1775
|
+
/** @description The same currency. Available values: "y" - yes, "n" - no. */
|
|
1776
|
+
versionCommonCurrency?: string;
|
|
1777
|
+
/** @description The same formula for calculating prices Available values: "y" - yes, "n" - no. */
|
|
1778
|
+
versionCommonPriceFormula?: string;
|
|
1779
|
+
/** @description The same JavaScript displayed on the product card Available values: "y" - yes, "n" - no. */
|
|
1780
|
+
versionCommonJavaScriptOnCard?: string;
|
|
1781
|
+
};
|
|
1782
|
+
/** @description Parameter value names */
|
|
1783
|
+
versionNames?: {
|
|
1784
|
+
/** @description Array of languages, values are displayed in. */
|
|
1785
|
+
versionNamesLangData?: {
|
|
1786
|
+
/** @description Language ID */
|
|
1787
|
+
langId?: string;
|
|
1788
|
+
/** @description Name of the parameter value, e.g. orange, green, red */
|
|
1789
|
+
versionName?: string;
|
|
1790
|
+
}[];
|
|
1791
|
+
};
|
|
1792
|
+
/** @description Parameter names */
|
|
1793
|
+
versionGroupNames?: {
|
|
1794
|
+
/** @description Parameter name */
|
|
1795
|
+
versionGroupNamesLangData?: {
|
|
1796
|
+
/** @description Language ID */
|
|
1797
|
+
langId?: string;
|
|
1798
|
+
/** @description Parameter name, e.g. color, width */
|
|
1799
|
+
versionGroupName?: string;
|
|
1800
|
+
}[];
|
|
1801
|
+
};
|
|
1802
|
+
};
|
|
1803
|
+
/** @description Currency ID */
|
|
1804
|
+
currencyId?: string;
|
|
1805
|
+
/** @description Currency, in which product prices are stored. */
|
|
1806
|
+
productCurrenciesShops?: {
|
|
1807
|
+
/** @description Shop Id */
|
|
1808
|
+
shopId?: number;
|
|
1809
|
+
/** @description Currency ID */
|
|
1810
|
+
currencyId?: string;
|
|
1811
|
+
}[];
|
|
1812
|
+
/** @description Supplier ID. */
|
|
1813
|
+
delivererId?: number;
|
|
1814
|
+
/** @description Supplier name. */
|
|
1815
|
+
delivererName?: string;
|
|
1816
|
+
/** @description This parameter is optional and it determines properties edition mode. Default value is "replace". Allowed values: "add" - adds properties to already existent ones, "delete" - removes properties of already existent ones, "delete_group" - removes properties from selected group, "replace" - overwrites properties already existent with new ones (default mode). */
|
|
1817
|
+
productParametersDistinctionChangeMode?: "add" | "delete" | "delete_group" | "replace";
|
|
1818
|
+
/** @description Product delivery time from the producer to the shop */
|
|
1819
|
+
productDeliveryTime?: {
|
|
1820
|
+
/** @description Operation type: "product" - sets own product delivery time, "deliverer" - sets product delivery time exactly the same as deliverer's. */
|
|
1821
|
+
productDeliveryTimeChangeMode?: "product" | "deliverer";
|
|
1822
|
+
/** @description The amount of time it takes to get goods from the supplier to the store. The maximum time is 99 for the unit "days" or 999 for the unit "hours" and "minutes" */
|
|
1823
|
+
productDeliveryTimeValue?: number;
|
|
1824
|
+
/** @description Determine the type of time it takes to get goods from supplier to store */
|
|
1825
|
+
productDeliveryTimeType?: "immediately" | "minutes" | "hours" | "upTo24h" | "workingDays" | "notKnown";
|
|
1826
|
+
};
|
|
1827
|
+
/** @description Parameters. */
|
|
1828
|
+
productParameters?: {
|
|
1829
|
+
/** @description "add_parameter" - assigning element to product, "delete_parameter" - removing element from product. */
|
|
1830
|
+
productParameterOperation?: "add_parameter" | "delete_parameter";
|
|
1831
|
+
/** @description Parameter ID */
|
|
1832
|
+
productParameterId?: number;
|
|
1833
|
+
/** @description Determines where the parameter will be added. If no value is specified, the parameter will be placed at the end of the list. If a value of e.g. 5 is set, the value of all priorities >= 5 will be increased by 1 to provide a unique priority value. */
|
|
1834
|
+
productParameterPriority?: number;
|
|
1835
|
+
/** @description Allows to enter parameter name i multiple languages at the same time. If it is used, item_textid and lang_id are ingored. */
|
|
1836
|
+
productParameterTextIdsLangData?: {
|
|
1837
|
+
/** @description Language ID */
|
|
1838
|
+
langId?: string;
|
|
1839
|
+
/** @description Parameter ID. */
|
|
1840
|
+
productParameterTextId?: string;
|
|
1841
|
+
}[];
|
|
1842
|
+
/** @description Language ID */
|
|
1843
|
+
langId?: string;
|
|
1844
|
+
/** @description Parameters descriptions in indicated language versions. */
|
|
1845
|
+
productParametersDescriptionsLangData?: {
|
|
1846
|
+
/** @description Language ID */
|
|
1847
|
+
langId?: string;
|
|
1848
|
+
/** @description Parameter description */
|
|
1849
|
+
productParametersDescription?: string;
|
|
1850
|
+
}[];
|
|
1851
|
+
}[];
|
|
1852
|
+
clearProductParameters?: boolean;
|
|
1853
|
+
/** @description Change parameter distinction. */
|
|
1854
|
+
changeParametersDistinction?: {
|
|
1855
|
+
/** @description Parameter ID */
|
|
1856
|
+
productParameterId?: number;
|
|
1857
|
+
/** @description Parameter name (if ID was not used). */
|
|
1858
|
+
productParameterTextIdent?: string;
|
|
1859
|
+
/** @description Language ID */
|
|
1860
|
+
langId?: string;
|
|
1861
|
+
/** @description Available values: distinction - Set as distinguished on product card, list of products (distinguished), projector_hide - Set as hidden on list of parameters on product card, group_distinction - Set as parameter differentiating products in group (nieaktywne), auction_template_hide - Hidden for a variable [iai:product_parameters] in auction templates . */
|
|
1862
|
+
productParameterDescriptionType?: "distinction" | "group_distinction" | "projector_hide" | "auction_template_hide";
|
|
1863
|
+
/** @description Value. Allowed values: "y" "n" */
|
|
1864
|
+
parameterDistinctionValue?: "y" | "n";
|
|
1865
|
+
}[];
|
|
1866
|
+
/** @description VAT rate change mode:. "change_gross" - changes the product gross price, leaving the net price unchanged, "change_net" - changes the net price, leaving the gross price unchanged (default mode). */
|
|
1867
|
+
productPriceVatChangeMode?: "change_net" | "change_gross";
|
|
1868
|
+
/** @description An array of menu elements */
|
|
1869
|
+
productMenuItems?: {
|
|
1870
|
+
/** @description Menu element operation type. Available values. - add_product - assigns a product to the menu element. - delete_product - removes a product from the menu element. */
|
|
1871
|
+
productMenuOperation?: "add_product" | "delete_product";
|
|
1872
|
+
/** @description ID of the menu node to which the product is to be assigned */
|
|
1873
|
+
menuItemId?: number;
|
|
1874
|
+
/** @description Menu element text identifier. Example: "item1\item2\item3". */
|
|
1875
|
+
menuItemTextId?: string;
|
|
1876
|
+
/** @description Shop Id */
|
|
1877
|
+
shopId?: number;
|
|
1878
|
+
/** @description ID of the menu zone displayed in the mask */
|
|
1879
|
+
menuId?: number;
|
|
1880
|
+
}[];
|
|
1881
|
+
/** @description Deletes all items assigned to the product of the selected menu */
|
|
1882
|
+
removeAllProductsAssignedToMenu?: {
|
|
1883
|
+
/** @description Shop Id */
|
|
1884
|
+
shopId?: number;
|
|
1885
|
+
/** @description ID of the menu zone displayed in the mask */
|
|
1886
|
+
menuId?: number;
|
|
1887
|
+
};
|
|
1888
|
+
/** @description Do You wish to sum up the products in the basket as a one order? Available values: "y" - yes, "n" - no. */
|
|
1889
|
+
productSumInBasket?: string;
|
|
1890
|
+
/** @description Settings of prices for shop. Values allowed: "same_prices" - prices in each shop are the same, "different_prices" - prices in each shop are different. */
|
|
1891
|
+
productShopsPricesConfig?: "same_prices" | "different_prices";
|
|
1892
|
+
/** @description Price settings for POS. Allowed values: "pos_equals_retail" - sets POS price the same as retail price. Possible to set only if the "shops_prices_config" parameter is set to jest same_prices or there is only one shop in panel, "pos_notequals_retail" - Price for POS different than retail price, "not_available_in_pos" - Product not available for POS sales. "sizes_pos_price_as_base_price" - Remove prices for sizes and set a sale price which equals a basic price. */
|
|
1893
|
+
productPosPricesConfig?: "pos_equals_retail" | "pos_notequals_retail" | "not_available_in_pos" | "sizes_pos_price_as_base_price";
|
|
1894
|
+
/** @description Product type. Allowed values: "product_item" - Goods, "product_free" - Free product, "product_packaging" - packaging, "product_bundle" - set. "product_collection" - collection. "product_service" - service. "product_virtual" - virtual product. "product_configurable" - configurable product. */
|
|
1895
|
+
productType?: "product_item" | "product_free" | "product_packaging" | "product_bundle" | "product_collection" | "product_virtual" | "product_service" | "product_configurable";
|
|
1896
|
+
/** @description Forced rounding up method. */
|
|
1897
|
+
priceRoundMode?: "none" | "00" | "x0" | "99" | "x9";
|
|
1898
|
+
/** @description Product availability management method Available values: "stock" - by means of stock management tools, "manual" - manually. */
|
|
1899
|
+
productAvailabilityManagementType?: "manual" | "stock";
|
|
1900
|
+
/** @description List of unused sizes in product to be deleted */
|
|
1901
|
+
removeChooseSizesValues?: string[];
|
|
1902
|
+
/** @description Remove all unused sizes. */
|
|
1903
|
+
removeAllUnusedProductSizes?: boolean;
|
|
1904
|
+
/** @description Standard producer code. Available values: "auto" - Choose automatically, "GTIN14" - GTIN-14 "GTIN13" - GTIN-13 (EAN-13) "ISBN13" - GTIN-13 (ISBN-13) "GTIN12" - GTIN-12 (UPC-A) "ISBN10" - ISBN-10 "GTIN8" - GTIN-8 (EAN-8) "UPCE" - UPC-E "MPN" - MPN "other" - Other */
|
|
1905
|
+
producerCodesStandard?: "auto" | "GTIN14" | "GTIN13" | "ISBN13" | "GTIN12" | "ISBN10" | "GTIN8" | "UPCE" | "MPN" | "other";
|
|
1906
|
+
/** @description JavaScript code displayed in the product page of the IdoSell Shop */
|
|
1907
|
+
javaScriptInTheItemCard?: {
|
|
1908
|
+
/** @description Shop Id */
|
|
1909
|
+
shopId?: number;
|
|
1910
|
+
/** @description JavaScript code displayed in the product page of the IdoSell Shop */
|
|
1911
|
+
scriptCode?: string;
|
|
1912
|
+
}[];
|
|
1913
|
+
/** @description Saving serial numbers Available values: "na" - not used, "optional" - Optional, "required" - required. */
|
|
1914
|
+
serialNumbersOption?: "na" | "optional" | "required";
|
|
1915
|
+
/** @description Shipping, returns and complaints settings */
|
|
1916
|
+
dispatchSettings?: {
|
|
1917
|
+
enabled?: boolean;
|
|
1918
|
+
/** @description Shipping settings */
|
|
1919
|
+
shippingSettings?: {
|
|
1920
|
+
/** @description Disable cash on delivery orders */
|
|
1921
|
+
codDisabled?: boolean;
|
|
1922
|
+
/** @description Only personal collection */
|
|
1923
|
+
dvpOnly?: boolean;
|
|
1924
|
+
/** @description Oversized product */
|
|
1925
|
+
atypicalSize?: boolean;
|
|
1926
|
+
/** @description Insurance required */
|
|
1927
|
+
insuranceOnly?: boolean;
|
|
1928
|
+
/** @description Exclusion from the Smile service */
|
|
1929
|
+
excludeSmileService?: boolean;
|
|
1930
|
+
/** @description List of courier services which cannot be used to ship this product */
|
|
1931
|
+
disallowedCouriers?: number[];
|
|
1932
|
+
};
|
|
1933
|
+
/** @description Free shipping settings */
|
|
1934
|
+
freeShippingSettings?: {
|
|
1935
|
+
/** @description Edition mode */
|
|
1936
|
+
mode?: "no" | "onlyProduct" | "wholeBasket";
|
|
1937
|
+
/** @description Set free shipping for the payment method only . */
|
|
1938
|
+
availablePaymentForms?: {
|
|
1939
|
+
/** @description prepayment */
|
|
1940
|
+
prepaid?: boolean;
|
|
1941
|
+
/** @description Cash on delivery */
|
|
1942
|
+
cashOnDelivery?: boolean;
|
|
1943
|
+
/** @description Trade credit */
|
|
1944
|
+
tradeCredit?: boolean;
|
|
1945
|
+
};
|
|
1946
|
+
/** @description List of courier services for which shipping is free */
|
|
1947
|
+
availableCouriers?: number[];
|
|
1948
|
+
/** @description List of courier services by which the products can be sent free of charge. IDs couriers */
|
|
1949
|
+
availableCouriersForSingleProduct?: number[];
|
|
1950
|
+
/** @description List of regions with free shipment */
|
|
1951
|
+
availableRegions?: number[];
|
|
1952
|
+
};
|
|
1953
|
+
/** @description Return and complaint settings */
|
|
1954
|
+
returnProductSettings?: {
|
|
1955
|
+
/** @description Product can be returned */
|
|
1956
|
+
returnOptions?: {
|
|
1957
|
+
enabled?: boolean;
|
|
1958
|
+
/** @description yes - for companies */
|
|
1959
|
+
firm?: boolean;
|
|
1960
|
+
/** @description yes - for wholesalers */
|
|
1961
|
+
hurt?: boolean;
|
|
1962
|
+
/** @description yes - for retailers */
|
|
1963
|
+
detalist?: boolean;
|
|
1964
|
+
};
|
|
1965
|
+
byOwnService?: boolean;
|
|
1966
|
+
byInPostSzybkieZwrotyByIAI?: boolean;
|
|
1967
|
+
};
|
|
1968
|
+
};
|
|
1969
|
+
/** @description Standard unit settings */
|
|
1970
|
+
standardUnit?: {
|
|
1971
|
+
/** @description Possible special contexts corresponding to standard units. Available values: "CONTEXT_STD_UNIT_WEIGHT" - Product weight in grams, "CONTEXT_STD_UNIT_WEIGHT_SI" - Product weight in kilograms, "CONTEXT_STD_UNIT_VOLUME" - A product's value in milliliters "CONTEXT_STD_UNIT_VOLUME_SI" - A product's value in liters "CONTEXT_STD_UNIT_LENGTH" - Length of product in meters "CONTEXT_STD_UNIT_AREA_M2" - Area of product in square meters "CONTEXT_STD_UNIT_VOLUME_M3" - The volume of products in cubic meters "CONTEXT_STD_UNIT_QUANTITY_PACKAGE" - Number of pieces per pack for standard unit */
|
|
1972
|
+
contextValue?: "CONTEXT_STD_UNIT_WEIGHT" | "CONTEXT_STD_UNIT_WEIGHT_SI" | "CONTEXT_STD_UNIT_VOLUME" | "CONTEXT_STD_UNIT_VOLUME_SI" | "CONTEXT_STD_UNIT_LENGTH" | "CONTEXT_STD_UNIT_AREA_M2" | "CONTEXT_STD_UNIT_VOLUME_M3" | "CONTEXT_STD_UNIT_QUANTITY_PACKAGE";
|
|
1973
|
+
/** @description Total length/volume/area/weight of product */
|
|
1974
|
+
standardUnitValue?: number;
|
|
1975
|
+
/** @description Price converter per unit. Available values: "0" - default (taken from the category), "1" - price per gram/milliliter/meter "10" - price per 10 grams/10 milliliters/10 meters "100" - price per 100 grams/100 milliliters/100 meters "1000" - price per liter/kilogram/kilometer */
|
|
1976
|
+
converterUnitValue?: "0" | "1" | "10" | "100" | "1000";
|
|
1977
|
+
};
|
|
1978
|
+
/** @description Minimal number of products in an order */
|
|
1979
|
+
minQuantityPerOrder?: {
|
|
1980
|
+
/** @description Minimum number of products in a retail order */
|
|
1981
|
+
minQuantityPerOrderRetail?: number;
|
|
1982
|
+
/** @description Minimum number of products in a wholesale order */
|
|
1983
|
+
minQuantityPerOrderWholesale?: number;
|
|
1984
|
+
};
|
|
1985
|
+
/** @example dynamicPricingEnabled */
|
|
1986
|
+
dynamicPricingEnabled?: string;
|
|
1987
|
+
/** @description The setting allows you to reset the inventory to zero */
|
|
1988
|
+
clearStockQuantities?: {
|
|
1989
|
+
/** @description The setting allows you to reset the inventories of warehouse M0 and all your own warehouses */
|
|
1990
|
+
clearAllStockQuantities?: boolean;
|
|
1991
|
+
/** @description List of warehouses for which inventories are to be reset */
|
|
1992
|
+
stocksListToClear?: number[];
|
|
1993
|
+
};
|
|
1994
|
+
/** @description Dimensions and overall weight */
|
|
1995
|
+
productDimensions?: {
|
|
1996
|
+
/** @description The width of a product in centimeters */
|
|
1997
|
+
productWidth?: number;
|
|
1998
|
+
/** @description Height of a product in centimeters */
|
|
1999
|
+
productHeight?: number;
|
|
2000
|
+
/** @description The length of a product in centimeters */
|
|
2001
|
+
productLength?: number;
|
|
2002
|
+
};
|
|
2003
|
+
/** @description Responsible producer code */
|
|
2004
|
+
responsibleProducerCode?: string;
|
|
2005
|
+
/** @description Responsible person code */
|
|
2006
|
+
responsiblePersonCode?: string;
|
|
2007
|
+
}[];
|
|
2008
|
+
};
|
|
2009
|
+
|
|
2010
|
+
export type PutOrdersParams = {
|
|
2011
|
+
/** @description Orders. */
|
|
2012
|
+
orders: {
|
|
2013
|
+
/** @description Order ID. */
|
|
2014
|
+
orderId?: string;
|
|
2015
|
+
/** @description Order serial number. */
|
|
2016
|
+
orderSerialNumber?: number;
|
|
2017
|
+
/** @description Order status. Allowed values: "finished_ext" - order status: completed in FA application, "finished" - completed, "new" - not handled, "payment_waiting" - awaiting payment, "delivery_waiting" - awaiting delivery, "on_order" - in progress, "packed" - being picked, "packed_fulfillment" - being picked - fulfilment, "packed_ready" - packed, "ready" - ready, "wait_for_dispatch" - awaiting dispatch date, "suspended" - on hold, "joined" - merged, "missing" - missing, "lost" - lost, "false" - false, "canceled" - Customer canceled. */
|
|
2018
|
+
orderStatus?: string;
|
|
2019
|
+
/** @description Order status id . */
|
|
2020
|
+
orderStatusId?: number;
|
|
2021
|
+
/** @description Flag informing on order registration or completion in external program through API. Allowed values. "none" - order was not registered in external program, "registered" - order was registered in external program, "realized" - order was completed in external program, "registered_pos" - order was registered in external program, "realized_pos" - order was completed in external program. */
|
|
2022
|
+
apiFlag?: "none" | "registered" | "realized" | "registered_pos" | "realized_pos" | "registration_fault";
|
|
2023
|
+
/** @description API note added to order. */
|
|
2024
|
+
apiNoteToOrder?: string;
|
|
2025
|
+
/** @description Customer comments on order. */
|
|
2026
|
+
clientNoteToOrder?: string;
|
|
2027
|
+
/** @description Customer remarks for courier. */
|
|
2028
|
+
clientNoteToCourier?: string;
|
|
2029
|
+
/** @description Note to the order. */
|
|
2030
|
+
orderNote?: string;
|
|
2031
|
+
/** @description Products list. */
|
|
2032
|
+
products?: {
|
|
2033
|
+
/** @description Product IAI code */
|
|
2034
|
+
productId?: number;
|
|
2035
|
+
/** @description Size identifier */
|
|
2036
|
+
sizeId?: string;
|
|
2037
|
+
/** @description External product system code for size. */
|
|
2038
|
+
productSizeCodeExternal?: string;
|
|
2039
|
+
/** @description Item in basket. */
|
|
2040
|
+
basketPosition?: number;
|
|
2041
|
+
/** @description Stock ID */
|
|
2042
|
+
stockId?: number;
|
|
2043
|
+
/** @description Free product. */
|
|
2044
|
+
productFree?: boolean;
|
|
2045
|
+
/** */
|
|
2046
|
+
forceLoyaltyPoints?: number;
|
|
2047
|
+
/** @description Product quantity. */
|
|
2048
|
+
productQuantity?: number;
|
|
2049
|
+
/** @description Type of operation performed on product linked to current order. Allowed values: "add" - adds the product to current order in appropriate amount, "subtract" - removes the product from current order in appropriate amount. */
|
|
2050
|
+
productQuantityOperationType?: "add" | "substract";
|
|
2051
|
+
/** @description Gross price */
|
|
2052
|
+
productRetailPrice?: number;
|
|
2053
|
+
/** @description Value of VAT */
|
|
2054
|
+
productVat?: number;
|
|
2055
|
+
/** @description Is product VAT free Allowed values "y" - yes, "n" - no. */
|
|
2056
|
+
productVatFree?: string;
|
|
2057
|
+
/** @description Client's remarks on product. */
|
|
2058
|
+
remarksToProduct?: string;
|
|
2059
|
+
/** @description Label for grouping products. */
|
|
2060
|
+
label?: string;
|
|
2061
|
+
/** @description List of components if a products is a set or collection. */
|
|
2062
|
+
productBundleItems?: {
|
|
2063
|
+
/** @description Product IAI code */
|
|
2064
|
+
productId?: number;
|
|
2065
|
+
/** @description Size identifier */
|
|
2066
|
+
sizeId?: string;
|
|
2067
|
+
/** @description Size name */
|
|
2068
|
+
sizePanelName?: string;
|
|
2069
|
+
/** @description One of the unique, indexed product codes (IAI code / External system code / Producer code) */
|
|
2070
|
+
productIndex?: string;
|
|
2071
|
+
}[];
|
|
2072
|
+
/** @description Information about the selected parameters in the configurator. */
|
|
2073
|
+
priceFormulaParameters?: {
|
|
2074
|
+
/** @description Parameter ID */
|
|
2075
|
+
parameterId?: string;
|
|
2076
|
+
/** @example parameterValue */
|
|
2077
|
+
parameterValue?: string;
|
|
2078
|
+
/** @description Parameter values */
|
|
2079
|
+
parameterValues?: {
|
|
2080
|
+
/** @example valueId */
|
|
2081
|
+
valueId?: string;
|
|
2082
|
+
}[];
|
|
2083
|
+
}[];
|
|
2084
|
+
}[];
|
|
2085
|
+
/** @description Order payment method. Allowed values. "cash_on_delivery" - cash on delivery, "prepaid" - prepayment, "tradecredit" - Trade credit. */
|
|
2086
|
+
orderPaymentType?: "cash_on_delivery" | "prepaid" | "tradecredit";
|
|
2087
|
+
/** @description Settlement by prices. "gross" - gross, "net" - net, "net_without_VAT" - net without VAT. */
|
|
2088
|
+
orderSettledAtPrice?: "gross" | "net" | "net_without_VAT";
|
|
2089
|
+
/** @description Omits collecting orders via IAI Bridge. */
|
|
2090
|
+
ignoreBridge?: boolean;
|
|
2091
|
+
/** @description Settings */
|
|
2092
|
+
settings?: {
|
|
2093
|
+
/** @description Blocks the sending of emails */
|
|
2094
|
+
dontSendMail?: "y" | "n";
|
|
2095
|
+
/** @description Blocks the sending of sms messages */
|
|
2096
|
+
dontSendSMS?: "y" | "n";
|
|
2097
|
+
};
|
|
2098
|
+
/** @description Consent to send data to cooperating services */
|
|
2099
|
+
emailProcessingConsent?: "yes" | "no" | "disabled";
|
|
2100
|
+
/** @description Customer asked for invoice. List of parameters: "y" - yes (paper invoicing ), "e" - yes (electronic invoicing ), "n" - no. */
|
|
2101
|
+
clientRequestInvoice?: string;
|
|
2102
|
+
/** @description Order settlement currency. */
|
|
2103
|
+
billingCurrency?: string;
|
|
2104
|
+
/** @description Panel billing currency exchange rate in relation to billing currency in the shop . */
|
|
2105
|
+
billingCurrencyRate?: number;
|
|
2106
|
+
/** @description Sale date. ISO 8602 format. */
|
|
2107
|
+
purchaseDate?: string;
|
|
2108
|
+
/** @description Estimated date of shipment of the order in format Y-m-d H:i */
|
|
2109
|
+
estimatedDeliveryDate?: string;
|
|
2110
|
+
}[];
|
|
2111
|
+
};
|
|
2112
|
+
|
|
2113
|
+
export type PostCouriersPickupPointsParams = {
|
|
2114
|
+
pickupPoints: {
|
|
2115
|
+
/** @description external system code. */
|
|
2116
|
+
pickupPointExternalId: string;
|
|
2117
|
+
/** @description Courier ID. */
|
|
2118
|
+
courierId: number;
|
|
2119
|
+
/** @description collection point details. */
|
|
2120
|
+
descriptions?: {
|
|
2121
|
+
/** @description Language ID (code in ISO 639-2). */
|
|
2122
|
+
languageId?: string;
|
|
2123
|
+
/** @description Name of the pickup point. */
|
|
2124
|
+
name?: string;
|
|
2125
|
+
/** @description collection point description . */
|
|
2126
|
+
description?: string;
|
|
2127
|
+
}[];
|
|
2128
|
+
/** @description Accepted payment types. */
|
|
2129
|
+
paymentForms?: ("cash" | "card")[];
|
|
2130
|
+
/** @description Collection point activity. Available values: available, outOfService . */
|
|
2131
|
+
serviceStatus?: "out_of_service" | "available";
|
|
2132
|
+
/** @description Pickup point address. */
|
|
2133
|
+
address: {
|
|
2134
|
+
/** @description Address. */
|
|
2135
|
+
street?: string;
|
|
2136
|
+
/** @description ZIP / Post code. */
|
|
2137
|
+
zipCode?: string;
|
|
2138
|
+
/** @description Town / City. */
|
|
2139
|
+
city?: string;
|
|
2140
|
+
/** @description Administrative region (code in ISO 3166-2). */
|
|
2141
|
+
provinceCode?: string;
|
|
2142
|
+
};
|
|
2143
|
+
/** @description Geographic coordinates. */
|
|
2144
|
+
coordinates: {
|
|
2145
|
+
/** @description Longitude. */
|
|
2146
|
+
longitude?: number;
|
|
2147
|
+
/** @description Latitude. */
|
|
2148
|
+
latitude?: number;
|
|
2149
|
+
};
|
|
2150
|
+
/** @description Personal collection point work hours. */
|
|
2151
|
+
operatingDays?: {
|
|
2152
|
+
/** @description Days of the week designation.Day number: 1- Monday, 7 - Sunday. */
|
|
2153
|
+
weekday?: number;
|
|
2154
|
+
/** @description collection point opening hours (HH:MM). */
|
|
2155
|
+
opening?: string;
|
|
2156
|
+
/** @description collection point closing time (HH:MM). */
|
|
2157
|
+
closing?: string;
|
|
2158
|
+
/** @description #!trybPracyPunktuDostepneWartosciOpenInOtwartyOdDoClosedZamkniety24hCzynnyCalaDobe!#. */
|
|
2159
|
+
operatingMode?: "open_in" | "closed" | "24h";
|
|
2160
|
+
}[];
|
|
2161
|
+
}[];
|
|
2162
|
+
};
|
|
2163
|
+
|
|
2164
|
+
export type PutCouriersPickupPointsParams = {
|
|
2165
|
+
pickupPoints: {
|
|
2166
|
+
/** @description Collection point ID. */
|
|
2167
|
+
pickupPointId?: string | number;
|
|
2168
|
+
/** @description external system code. */
|
|
2169
|
+
pickupPointExternalId?: string;
|
|
2170
|
+
/** @description Courier ID. */
|
|
2171
|
+
courierId: number;
|
|
2172
|
+
/** @description collection point details. */
|
|
2173
|
+
descriptions?: {
|
|
2174
|
+
/** @description Language ID (code in ISO 639-2). */
|
|
2175
|
+
languageId?: string;
|
|
2176
|
+
/** @description Name of the pickup point. */
|
|
2177
|
+
name?: string;
|
|
2178
|
+
/** @description collection point description . */
|
|
2179
|
+
description?: string;
|
|
2180
|
+
}[];
|
|
2181
|
+
/** @description Accepted payment types. */
|
|
2182
|
+
paymentForms?: ("cash" | "card")[];
|
|
2183
|
+
/** @description Collection point activity. Available values: available, outOfService . */
|
|
2184
|
+
serviceStatus?: "out_of_service" | "available";
|
|
2185
|
+
/** @description Pickup point address. */
|
|
2186
|
+
address?: {
|
|
2187
|
+
/** @description Address. */
|
|
2188
|
+
street?: string;
|
|
2189
|
+
/** @description ZIP / Post code. */
|
|
2190
|
+
zipCode?: string;
|
|
2191
|
+
/** @description Town / City. */
|
|
2192
|
+
city?: string;
|
|
2193
|
+
/** @description Administrative region (code in ISO 3166-2). */
|
|
2194
|
+
provinceCode?: string;
|
|
2195
|
+
};
|
|
2196
|
+
/** @description Geographic coordinates. */
|
|
2197
|
+
coordinates?: {
|
|
2198
|
+
/** @description Longitude. */
|
|
2199
|
+
longitude?: number;
|
|
2200
|
+
/** @description Latitude. */
|
|
2201
|
+
latitude?: number;
|
|
2202
|
+
};
|
|
2203
|
+
/** @description Personal collection point work hours. */
|
|
2204
|
+
operatingDays?: {
|
|
2205
|
+
/** @description Days of the week designation.Day number: 1- Monday, 7 - Sunday. */
|
|
2206
|
+
weekday?: number;
|
|
2207
|
+
/** @description collection point opening hours (HH:MM). */
|
|
2208
|
+
opening?: string;
|
|
2209
|
+
/** @description collection point closing time (HH:MM). */
|
|
2210
|
+
closing?: string;
|
|
2211
|
+
/** @description #!trybPracyPunktuDostepneWartosciOpenInOtwartyOdDoClosedZamkniety24hCzynnyCalaDobe!#. */
|
|
2212
|
+
operatingMode?: "open_in" | "closed" | "24h";
|
|
2213
|
+
}[];
|
|
2214
|
+
}[];
|
|
2215
|
+
};
|
|
2216
|
+
|
|
2217
|
+
export type PostPackagesLabelsParams = {
|
|
2218
|
+
/** @description Id. */
|
|
2219
|
+
eventId: number;
|
|
2220
|
+
/** @description Type. */
|
|
2221
|
+
eventType: "order" | "rma" | "return";
|
|
2222
|
+
/** @description Shipment configuration options available for a given courier */
|
|
2223
|
+
parcelParameters?: {
|
|
2224
|
+
/** @description Configuration option identifier for the shipment */
|
|
2225
|
+
id?: string;
|
|
2226
|
+
/** @description The value of the configuration option for the shipment */
|
|
2227
|
+
value?: string;
|
|
2228
|
+
}[];
|
|
2229
|
+
/** @description Shipment configuration options available for Inpost Smile courier */
|
|
2230
|
+
parcelParametersByPackages?: {
|
|
2231
|
+
/** @description Package ID in system. */
|
|
2232
|
+
packageId?: string;
|
|
2233
|
+
/** @description Shipment configuration options available for a given courier */
|
|
2234
|
+
parcelParameters?: {
|
|
2235
|
+
/** @description Configuration option identifier for the shipment */
|
|
2236
|
+
id?: string;
|
|
2237
|
+
/** @description The value of the configuration option for the shipment */
|
|
2238
|
+
value?: string;
|
|
2239
|
+
}[];
|
|
2240
|
+
}[];
|
|
2241
|
+
};
|
|
2242
|
+
|
|
2243
|
+
export type PostOrdersDocumentsCreateParams = {
|
|
2244
|
+
/** @example [ 1, 2 ] */
|
|
2245
|
+
orderSerialNumbers: number[];
|
|
2246
|
+
/** @example false */
|
|
2247
|
+
actualize?: boolean;
|
|
2248
|
+
/** @description Document type */
|
|
2249
|
+
documentType: "vat_invoice" | "fiscal_invoice" | "corrective_vat_invoice" | "fiscal_receipt" | "sales_confirmation";
|
|
2250
|
+
/** @description Document issued date */
|
|
2251
|
+
documentIssuedDate?: string;
|
|
2252
|
+
/** @description Document purchase date */
|
|
2253
|
+
documentPurchaseDate?: string;
|
|
2254
|
+
/** @description Printer id */
|
|
2255
|
+
printerId?: number;
|
|
2256
|
+
};
|
|
2257
|
+
|
|
2258
|
+
export type PostClientsParams = {
|
|
2259
|
+
/** @description Customer data. */
|
|
2260
|
+
clients: {
|
|
2261
|
+
/** @description Customer's login. */
|
|
2262
|
+
login?: string;
|
|
2263
|
+
/** @description External system code. */
|
|
2264
|
+
code_extern?: string;
|
|
2265
|
+
/** @description Customer e-mail address. */
|
|
2266
|
+
email: string;
|
|
2267
|
+
/** @description Customer's first name. */
|
|
2268
|
+
firstname?: string;
|
|
2269
|
+
/** @description Customer's last name. */
|
|
2270
|
+
lastname?: string;
|
|
2271
|
+
/** @description Address. */
|
|
2272
|
+
street: string;
|
|
2273
|
+
/** @description Customer's postal code. */
|
|
2274
|
+
zipcode: string;
|
|
2275
|
+
/** @description Customer's city. */
|
|
2276
|
+
city: string;
|
|
2277
|
+
/** @description Customer country (ISO 3166-1 alfa-2 code). */
|
|
2278
|
+
country_code?: string;
|
|
2279
|
+
/** @description Administrative region code. */
|
|
2280
|
+
province_code?: string;
|
|
2281
|
+
/** @description Customer password (min. 8 characters). */
|
|
2282
|
+
password?: string;
|
|
2283
|
+
/** @description Date of birth. */
|
|
2284
|
+
birth_date?: string;
|
|
2285
|
+
/** @description Customer phone number. */
|
|
2286
|
+
phone: string;
|
|
2287
|
+
/** @example company */
|
|
2288
|
+
company?: string;
|
|
2289
|
+
/** @description Customer Tax no. */
|
|
2290
|
+
vat_number?: string;
|
|
2291
|
+
/** @description Determines, whether client is a wholesaler. */
|
|
2292
|
+
wholesaler?: boolean;
|
|
2293
|
+
/** @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. */
|
|
2294
|
+
client_type?: "person" | "person_male" | "person_female" | "firm";
|
|
2295
|
+
/** @description Customer language ID. */
|
|
2296
|
+
language?: string;
|
|
2297
|
+
/** @description Determines, in which store account should be active. */
|
|
2298
|
+
shops: number[];
|
|
2299
|
+
/** @description Defines availability of log in to other pages than the ones given in the element: shops . */
|
|
2300
|
+
block_autosigning_to_shops?: boolean;
|
|
2301
|
+
/** @description Customer default currency (ISO 4217 code). */
|
|
2302
|
+
currency?: string;
|
|
2303
|
+
delivery_dates?: string[];
|
|
2304
|
+
/** @description Customer account balance in external system. */
|
|
2305
|
+
external_balance_value?: number;
|
|
2306
|
+
/** @description Debt limit. */
|
|
2307
|
+
external_trade_credit_limit_value?: number;
|
|
2308
|
+
/** @description Have customer agreed to a newsletter. List of allowed parameters: "y" - yes, "n" - no. The value will be set in all shops in which the customer account is active. */
|
|
2309
|
+
email_newsletter?: boolean;
|
|
2310
|
+
/** @description Have customer agreed to a newsletter. List of allowed parameters: "y" - yes, "n" - no. The value will be set in all shops in which the customer account is active. */
|
|
2311
|
+
sms_newsletter?: boolean;
|
|
2312
|
+
/** @description Discount group ID. */
|
|
2313
|
+
client_group?: number;
|
|
2314
|
+
/** @description Field used for identifying request-response pairs for the endpoint. */
|
|
2315
|
+
request_reference?: string;
|
|
2316
|
+
/** @description List of shops where a customer agreed or didn't agree to receive email newsletter. */
|
|
2317
|
+
newsletter_email_approvals?: {
|
|
2318
|
+
/** @description Have customer agreed to a newsletter. List of allowed parameters: "y" - yes, "n" - no. */
|
|
2319
|
+
approval?: "y" | "n";
|
|
2320
|
+
/** @description Store ID. */
|
|
2321
|
+
shop_id?: number;
|
|
2322
|
+
}[];
|
|
2323
|
+
/** @description List of shops where a customer agreed or didn't agree to receive sms newsletter. */
|
|
2324
|
+
newsletter_sms_approvals?: {
|
|
2325
|
+
/** @description Have customer agreed to a newsletter. List of allowed parameters: "y" - yes, "n" - no. */
|
|
2326
|
+
approval?: "y" | "n";
|
|
2327
|
+
/** @description Store ID. */
|
|
2328
|
+
shop_id?: number;
|
|
2329
|
+
}[];
|
|
2330
|
+
/** @description Block assigning of discount groups automatically based on order history */
|
|
2331
|
+
block_group_auto_assignment?: boolean;
|
|
2332
|
+
}[];
|
|
2333
|
+
};
|
|
2334
|
+
|
|
2335
|
+
export type PostReturnsParams = {
|
|
2336
|
+
/** @description Order serial number */
|
|
2337
|
+
order_sn: number;
|
|
2338
|
+
/** @example 1 */
|
|
2339
|
+
stock_id: number;
|
|
2340
|
+
/** @description Products list. */
|
|
2341
|
+
products: {
|
|
2342
|
+
/** @example 1 */
|
|
2343
|
+
id?: number;
|
|
2344
|
+
/** @example size */
|
|
2345
|
+
size?: string;
|
|
2346
|
+
/** */
|
|
2347
|
+
quantity?: number;
|
|
2348
|
+
/** @description Price. */
|
|
2349
|
+
price?: number;
|
|
2350
|
+
serialNumbers?: string[];
|
|
2351
|
+
/** @description Additional information. */
|
|
2352
|
+
productOrderAdditional?: string;
|
|
2353
|
+
}[];
|
|
2354
|
+
/** @example 1 */
|
|
2355
|
+
status?: number;
|
|
2356
|
+
client_received?: boolean;
|
|
2357
|
+
change_status?: boolean;
|
|
2358
|
+
/** @example 1 */
|
|
2359
|
+
courier_id?: number;
|
|
2360
|
+
/** @example return_operator */
|
|
2361
|
+
return_operator?: string;
|
|
2362
|
+
tryCorrectInvoice?: boolean;
|
|
2363
|
+
/** @example include_shipping_cost */
|
|
2364
|
+
include_shipping_cost?: string;
|
|
2365
|
+
/** @example additional_payment_cost */
|
|
2366
|
+
additional_payment_cost?: string;
|
|
2367
|
+
/** */
|
|
2368
|
+
emptyReturn?: "n" | "y";
|
|
2369
|
+
};
|
|
2370
|
+
|
|
2371
|
+
export type PostWmsStocksdocumentsDocumentsParams = {
|
|
2372
|
+
/** */
|
|
2373
|
+
type: "pz" | "pw" | "px" | "rx" | "rw" | "mm";
|
|
2374
|
+
/** @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>. */
|
|
2375
|
+
stockId: number;
|
|
2376
|
+
/** @description Document number. */
|
|
2377
|
+
stockDocumentNumber?: string;
|
|
2378
|
+
/** @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>. */
|
|
2379
|
+
stockSourceId?: number;
|
|
2380
|
+
/** @example note */
|
|
2381
|
+
note?: string;
|
|
2382
|
+
/** @description Products available in presales. Available values: "y" - yes, "n" - no. */
|
|
2383
|
+
productsInPreorder?: "y" | "n";
|
|
2384
|
+
/** @description Supplier ID. */
|
|
2385
|
+
delivererId?: number;
|
|
2386
|
+
/** @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. */
|
|
2387
|
+
wnt?: "national_VAT_invoice" | "other_purchase_document" | "invoice_without_VAT" | "imports_from_outside_the_EU";
|
|
2388
|
+
/** @description Issue date of purchase document. Correct format is yyyy-mm-dd, e.g. 2007-12-31.. */
|
|
2389
|
+
saleDocumentCreationDate?: string;
|
|
2390
|
+
/** @description Planned date of acceptance of delivery. Correct format is yyyy-mm-dd, e.g. 2007-12-31. Requires parameter: "confirmed=on_the_way". */
|
|
2391
|
+
deliveryOnTheWayPlannedDeliveryDate?: string;
|
|
2392
|
+
/** @description Document status. Available values: "open" - open, "on_the_way" - on the way. */
|
|
2393
|
+
confirmed?: "open" | "on_the_way";
|
|
2394
|
+
/** @description Purchase price currency, e.g. PLN, USD, GBP */
|
|
2395
|
+
currencyForPurchasePrice?: string;
|
|
2396
|
+
/** @description Settlement by prices. Available values: "brutto" - Gross value, "netto" - Net value */
|
|
2397
|
+
priceType?: "brutto" | "netto";
|
|
2398
|
+
/** @description Methods of stock level correction. Available values: "fifo" - first-in, first-out (FIFO), "lifo" - last-in, first-out (LIFO) */
|
|
2399
|
+
queueType?: "fifo" | "lifo";
|
|
2400
|
+
};
|
|
2401
|
+
|
|
2402
|
+
export type PostWmsStocksdocumentsProductsParams = {
|
|
2403
|
+
/** @description Products list. */
|
|
2404
|
+
products: {
|
|
2405
|
+
/** @description Stock keeping unit. */
|
|
2406
|
+
product: number;
|
|
2407
|
+
/** @description Product size ID. */
|
|
2408
|
+
size: string;
|
|
2409
|
+
/** @description Product quantity. */
|
|
2410
|
+
quantity: number;
|
|
2411
|
+
/** @description Cost price */
|
|
2412
|
+
productPurchasePrice?: number;
|
|
2413
|
+
/** @description Warehouse location ID. The list of available warehouse locations can be downloaded via the method <a href = "pl/shop/api/?action=method&function=locations&method=get">#get</a> in gateway <a href = "en/shop/api/?action=documentation&function=locations">Locations</a> . */
|
|
2414
|
+
locationId?: number;
|
|
2415
|
+
/** @description Storage location code */
|
|
2416
|
+
locationCode?: string;
|
|
2417
|
+
/** @description Warehouse location full path. Use a backslash (\) as a separator, for example: M1\Section name\Location name. The list of available warehouse locations can be downloaded via the method <a href = "pl/shop/api/?action=method&function=locations&method=get">#get</a> in gateway <a href = "en/shop/api/?action=documentation&function=locations">Locations</a> . */
|
|
2418
|
+
locationTextId?: string;
|
|
2419
|
+
}[];
|
|
2420
|
+
/** */
|
|
2421
|
+
type: "pz" | "pw" | "px" | "rx" | "rw" | "mm";
|
|
2422
|
+
/** @description Document identifier. */
|
|
2423
|
+
id: number;
|
|
2424
|
+
};
|
|
2425
|
+
|
|
2426
|
+
export type PostPaymentsParams = {
|
|
2427
|
+
/** @description Source ID. */
|
|
2428
|
+
sourceId: number;
|
|
2429
|
+
/** @description Source type. */
|
|
2430
|
+
sourceType: "order" | "return" | "rma";
|
|
2431
|
+
/** @description Payment amount. */
|
|
2432
|
+
value: number;
|
|
2433
|
+
/** @description Number of a bank account to which a payment is sent. */
|
|
2434
|
+
account?: string;
|
|
2435
|
+
/** */
|
|
2436
|
+
type: "payment" | "advance" | "repayment" | "fee";
|
|
2437
|
+
/** @description Form of payment ID. */
|
|
2438
|
+
paymentFormId: number;
|
|
2439
|
+
/** @description Gift card or voucher number */
|
|
2440
|
+
paymentVoucherKey?: string;
|
|
2441
|
+
/** @description Gift card PIN. */
|
|
2442
|
+
giftCardPIN?: number;
|
|
2443
|
+
/** @description Transaction ID in external service */
|
|
2444
|
+
externalPaymentId?: string;
|
|
2445
|
+
};
|
|
2446
|
+
|
|
2447
|
+
export type PutReturnsParams = {
|
|
2448
|
+
returns: {
|
|
2449
|
+
/** @example 1 */
|
|
2450
|
+
id: number;
|
|
2451
|
+
/** @example 1 */
|
|
2452
|
+
status?: number;
|
|
2453
|
+
/** @description Flag informing on order registration or completion in external program through API. Allowed values. "none" - order was not registered in external program, "registered" - order was registered in external program, "realized" - order was completed in external program, "registered_pos" - order was registered in external program, "realized_pos" - order was completed in external program. */
|
|
2454
|
+
apiFlag?: {
|
|
2455
|
+
/** */
|
|
2456
|
+
flag?: "none" | "registered" | "registration_fault";
|
|
2457
|
+
/** @example note */
|
|
2458
|
+
note?: string;
|
|
2459
|
+
};
|
|
2460
|
+
/** @description Products list. */
|
|
2461
|
+
products?: {
|
|
2462
|
+
/** @example 1 */
|
|
2463
|
+
id?: number;
|
|
2464
|
+
/** @example size */
|
|
2465
|
+
size?: string;
|
|
2466
|
+
/** */
|
|
2467
|
+
quantity?: number;
|
|
2468
|
+
/** @description Price. */
|
|
2469
|
+
price?: number;
|
|
2470
|
+
serialNumbers?: string[];
|
|
2471
|
+
/** @description Additional information. */
|
|
2472
|
+
productOrderAdditional?: string;
|
|
2473
|
+
}[];
|
|
2474
|
+
/** @example userNote */
|
|
2475
|
+
userNote?: string;
|
|
2476
|
+
/** @description Notes from customer. */
|
|
2477
|
+
clientNote?: string;
|
|
2478
|
+
tryCorrectInvoice?: boolean;
|
|
2479
|
+
}[];
|
|
2480
|
+
};
|
|
2481
|
+
|
|
2482
|
+
export type PutRmaParams = {
|
|
2483
|
+
/** @description Complaints. */
|
|
2484
|
+
rmas: {
|
|
2485
|
+
/** @description Complaint id. */
|
|
2486
|
+
rmaId: number;
|
|
2487
|
+
/** @description Claim status. Available values: 15 - Complaint not confirmed by the shop service, 17 - The complaint has been cancelled, 18 - Complaint canceled by the customer, 14 - Complaint didn't arrive, 20 - Complaint not handled, * 22 - Complaint rejected - no fault was found, 23 - Complaint rejected - the warranty period has expired, 24 - Complaint rejected - defect caused by improper use, * 19 - Complaint confirmed, * 28 - Complaint is being considered - repair completed, 5 - Complaint is being considered - Product sent to the producer , 4 - Complaint is being considered - Product was sent for testing, 6 - Complaint is being considered - Repair in progress, 29 - Complaint is being considered - the complaint requires additional information from the customer, * 7 - Complaint adjusted negatively - no fault was found, 9 - Complaint adjusted negatively - the warranty period has expired, 30 - Complaint adjusted negatively - return shipment sent to the customer, 8 - Complaint adjusted negatively - defect caused by improper use, * 25 - Complaint handled positively - return shipment sent to the customer, 12 - Complaint handled positively - replacement for a new product, 13 - Complaint handled positively - replacement for a different product, 26 - Complaint handled positively - a new item was shipped without waiting for the original one, 27 - Complaint handled positively - the recipient's data change on the sales document, 10 - Complaint handled positively - Refund - payment processing, 11 - Complaint handled positively - repair completed - payout made, 31 - Complaint handled positively - Awaiting correction invoice confirmation, 34 - Complaint handled positively - Refund - preparing correction invoice */
|
|
2488
|
+
rmaStatusId?: number;
|
|
2489
|
+
/** @description Customer correspondence. */
|
|
2490
|
+
rmaChat?: {
|
|
2491
|
+
/** @description Message content */
|
|
2492
|
+
message?: string;
|
|
2493
|
+
}[];
|
|
2494
|
+
}[];
|
|
2495
|
+
};
|
|
2496
|
+
|
|
2497
|
+
export type PutWmsStocksdocumentsProductsParams = {
|
|
2498
|
+
/** @description Products list. */
|
|
2499
|
+
products: {
|
|
2500
|
+
/** @description Stock keeping unit. */
|
|
2501
|
+
product: number;
|
|
2502
|
+
/** @description Product size ID. */
|
|
2503
|
+
size: string;
|
|
2504
|
+
/** @description Product quantity. */
|
|
2505
|
+
quantity?: number;
|
|
2506
|
+
/** @description Cost price */
|
|
2507
|
+
productPurchasePrice?: number;
|
|
2508
|
+
/** @description Warehouse location ID. The list of available warehouse locations can be downloaded via the method <a href = "pl/shop/api/?action=method&function=locations&method=get">#get</a> in gateway <a href = "en/shop/api/?action=documentation&function=locations">Locations</a> . */
|
|
2509
|
+
locationId?: number;
|
|
2510
|
+
/** @description Storage location code */
|
|
2511
|
+
locationCode?: string;
|
|
2512
|
+
/** @description Warehouse location full path. Use a backslash (\) as a separator, for example: M1\Section name\Location name. The list of available warehouse locations can be downloaded via the method <a href = "pl/shop/api/?action=method&function=locations&method=get">#get</a> in gateway <a href = "en/shop/api/?action=documentation&function=locations">Locations</a> . */
|
|
2513
|
+
locationTextId?: string;
|
|
2514
|
+
}[];
|
|
2515
|
+
/** */
|
|
2516
|
+
type: "pz" | "pw" | "px" | "rx" | "rw" | "mm";
|
|
2517
|
+
/** @description Document identifier. */
|
|
2518
|
+
id: number;
|
|
2519
|
+
};
|
|
2520
|
+
|
|
2521
|
+
export type PostMenuParams = {
|
|
2522
|
+
menu_list: {
|
|
2523
|
+
/** @description Shop Id. */
|
|
2524
|
+
shop_id: number;
|
|
2525
|
+
/** @description Menu ID. */
|
|
2526
|
+
menu_id: number;
|
|
2527
|
+
/** @description Parent menu element ID. */
|
|
2528
|
+
parent_id?: string;
|
|
2529
|
+
/** @description Menu element text identifier. Example: "item1\item2". */
|
|
2530
|
+
parent_textid?: string;
|
|
2531
|
+
lang_data: {
|
|
2532
|
+
/** @description Language ID. */
|
|
2533
|
+
lang_id?: string;
|
|
2534
|
+
/** @description Menu element name. */
|
|
2535
|
+
name?: string;
|
|
2536
|
+
/** @description Menu element order. */
|
|
2537
|
+
priority?: number;
|
|
2538
|
+
/** @description Description displayed at the top of products list. */
|
|
2539
|
+
description?: string;
|
|
2540
|
+
/** @description Description displayed at the bottom of products list. */
|
|
2541
|
+
description_bottom?: string;
|
|
2542
|
+
/** @description Own link. */
|
|
2543
|
+
link?: string;
|
|
2544
|
+
/** */
|
|
2545
|
+
item_type?: "products" | "navigation" | "products_with_rich_text" | "navigation_with_rich_text" | "rich_text" | "static" | "link";
|
|
2546
|
+
/** @description Meta - title. */
|
|
2547
|
+
meta_title?: string;
|
|
2548
|
+
/** @description Meta description. */
|
|
2549
|
+
meta_description?: string;
|
|
2550
|
+
/** @description Meta - keywords. */
|
|
2551
|
+
meta_keywords?: string;
|
|
2552
|
+
/** @description URL address */
|
|
2553
|
+
url?: string;
|
|
2554
|
+
/** @description Link target attribute: !_self - open on the same page, !_blank - open in a new page. */
|
|
2555
|
+
href_target?: "_self" | "_blank";
|
|
2556
|
+
sort?: {
|
|
2557
|
+
/** @description Default product list view. */
|
|
2558
|
+
view?: "normal" | "list" | "gallery";
|
|
2559
|
+
/** @description Sort by. */
|
|
2560
|
+
sort_by?: "date" | "priority" | "priorityname" | "name" | "price";
|
|
2561
|
+
/** @description Sort order. */
|
|
2562
|
+
sort_order?: "ASC" | "DESC";
|
|
2563
|
+
}[];
|
|
2564
|
+
display_limit?: {
|
|
2565
|
+
/** @description Default product list view. */
|
|
2566
|
+
view?: "normal" | "list" | "gallery";
|
|
2567
|
+
/** @description Limit. */
|
|
2568
|
+
limit?: number;
|
|
2569
|
+
}[];
|
|
2570
|
+
/** */
|
|
2571
|
+
default_view?: "normal" | "list" | "gallery";
|
|
2572
|
+
/** @description Headline name. Leaving this value empty will automatically generate name basing on a name in menu. */
|
|
2573
|
+
headline_name?: string;
|
|
2574
|
+
/** @description Display by default nested elements. n - no, y - yes. */
|
|
2575
|
+
expand?: "n" | "y";
|
|
2576
|
+
/** @description Element of the menu hidden from the clients: n - no, y - yes. */
|
|
2577
|
+
hidden?: "n" | "y";
|
|
2578
|
+
/** @description After clicking on the element in the menu:: expand - Display subelements of the menu if any available, if not - create, reload - reload the page and open. */
|
|
2579
|
+
action?: "reload" | "expand";
|
|
2580
|
+
/** @description Element "show all" is:: products_list - link to the list of products, navigation_site - link to the "Navigation" page. */
|
|
2581
|
+
display_all_type?: "products_list" | "navigation_site";
|
|
2582
|
+
/** @description Display element "show all": n - no, y - yes. */
|
|
2583
|
+
display_all?: "n" | "y";
|
|
2584
|
+
/** @description Disable changing "sort by" for customers: n - no, y - yes. */
|
|
2585
|
+
allow_sort_change?: "n" | "y";
|
|
2586
|
+
/** @description Disable possibility of changing the number of displayed products on the page by customers : n - no, y - yes. */
|
|
2587
|
+
allow_limit_change?: "n" | "y";
|
|
2588
|
+
/** @description Graphics in menu: n - no, y - yes. */
|
|
2589
|
+
node_gfx?: "n" | "y";
|
|
2590
|
+
/** @description Type of graphics - When the cursor is on the link: img - Image (one size for computers, tablets and smartphones, not recommended), img_rwd - Image (three sizes for RWD). */
|
|
2591
|
+
gfx_active_type?: "img" | "img_rwd";
|
|
2592
|
+
/** @description Type of graphics - When the cursor is outside link: img - Image (one size for computers, tablets and smartphones, not recommended), img_rwd - Image (three sizes for RWD). */
|
|
2593
|
+
gfx_inactive_type?: "img" | "img_rwd";
|
|
2594
|
+
/** @description Type of graphics - When the link is opened: img - Image (one size for computers, tablets and smartphones, not recommended), img_rwd - Image (three sizes for RWD). */
|
|
2595
|
+
gfx_omo_type?: "img" | "img_rwd";
|
|
2596
|
+
/** @description Graphic on the "navigation" page. */
|
|
2597
|
+
gfx_nav?: {
|
|
2598
|
+
/** @description Graphic encoded with Base64 */
|
|
2599
|
+
base64?: string;
|
|
2600
|
+
/** @description Graphic format */
|
|
2601
|
+
format?: "jpg" | "jpeg" | "png" | "gif" | "svg" | "webp";
|
|
2602
|
+
};
|
|
2603
|
+
/** @description Graphic - When the cursor is on the link. */
|
|
2604
|
+
gfx_active?: {
|
|
2605
|
+
/** @description Graphic encoded with Base64 */
|
|
2606
|
+
base64?: string;
|
|
2607
|
+
/** @description Graphic format */
|
|
2608
|
+
format?: "jpg" | "jpeg" | "png" | "gif" | "svg" | "webp";
|
|
2609
|
+
};
|
|
2610
|
+
/** @description Graphic - When the cursor is on the link - Desktop. */
|
|
2611
|
+
gfx_active_desktop?: {
|
|
2612
|
+
/** @description Graphic encoded with Base64 */
|
|
2613
|
+
base64?: string;
|
|
2614
|
+
/** @description Graphic format */
|
|
2615
|
+
format?: "jpg" | "jpeg" | "png" | "gif" | "svg" | "webp";
|
|
2616
|
+
};
|
|
2617
|
+
/** @description Graphic - When the cursor is on the link - Tablet. */
|
|
2618
|
+
gfx_active_tablet?: {
|
|
2619
|
+
/** @description Graphic encoded with Base64 */
|
|
2620
|
+
base64?: string;
|
|
2621
|
+
/** @description Graphic format */
|
|
2622
|
+
format?: "jpg" | "jpeg" | "png" | "gif" | "svg" | "webp";
|
|
2623
|
+
};
|
|
2624
|
+
/** @description Graphic - When the cursor is on the link - Mobile. */
|
|
2625
|
+
gfx_active_mobile?: {
|
|
2626
|
+
/** @description Graphic encoded with Base64 */
|
|
2627
|
+
base64?: string;
|
|
2628
|
+
/** @description Graphic format */
|
|
2629
|
+
format?: "jpg" | "jpeg" | "png" | "gif" | "svg" | "webp";
|
|
2630
|
+
};
|
|
2631
|
+
/** @description Graphic - When the cursor is outside link. */
|
|
2632
|
+
gfx?: {
|
|
2633
|
+
/** @description Graphic encoded with Base64 */
|
|
2634
|
+
base64?: string;
|
|
2635
|
+
/** @description Graphic format */
|
|
2636
|
+
format?: "jpg" | "jpeg" | "png" | "gif" | "svg" | "webp";
|
|
2637
|
+
};
|
|
2638
|
+
/** @description Graphic - When the cursor is outside link - Desktop. */
|
|
2639
|
+
gfx_inactive_desktop?: {
|
|
2640
|
+
/** @description Graphic encoded with Base64 */
|
|
2641
|
+
base64?: string;
|
|
2642
|
+
/** @description Graphic format */
|
|
2643
|
+
format?: "jpg" | "jpeg" | "png" | "gif" | "svg" | "webp";
|
|
2644
|
+
};
|
|
2645
|
+
/** @description Graphic - When the cursor is outside link - Tablet. */
|
|
2646
|
+
gfx_inactive_tablet?: {
|
|
2647
|
+
/** @description Graphic encoded with Base64 */
|
|
2648
|
+
base64?: string;
|
|
2649
|
+
/** @description Graphic format */
|
|
2650
|
+
format?: "jpg" | "jpeg" | "png" | "gif" | "svg" | "webp";
|
|
2651
|
+
};
|
|
2652
|
+
/** @description Graphic - When the cursor is outside link - Mobile. */
|
|
2653
|
+
gfx_inactive_mobile?: {
|
|
2654
|
+
/** @description Graphic encoded with Base64 */
|
|
2655
|
+
base64?: string;
|
|
2656
|
+
/** @description Graphic format */
|
|
2657
|
+
format?: "jpg" | "jpeg" | "png" | "gif" | "svg" | "webp";
|
|
2658
|
+
};
|
|
2659
|
+
/** @description Graphic - When the link is opened. */
|
|
2660
|
+
gfx_onmouseover?: {
|
|
2661
|
+
/** @description Graphic encoded with Base64 */
|
|
2662
|
+
base64?: string;
|
|
2663
|
+
/** @description Graphic format */
|
|
2664
|
+
format?: "jpg" | "jpeg" | "png" | "gif" | "svg" | "webp";
|
|
2665
|
+
};
|
|
2666
|
+
/** @description Graphic - When the link is opened - Desktop. */
|
|
2667
|
+
gfx_omo_desktop?: {
|
|
2668
|
+
/** @description Graphic encoded with Base64 */
|
|
2669
|
+
base64?: string;
|
|
2670
|
+
/** @description Graphic format */
|
|
2671
|
+
format?: "jpg" | "jpeg" | "png" | "gif" | "svg" | "webp";
|
|
2672
|
+
};
|
|
2673
|
+
/** @description Graphic - When the link is opened - Tablet. */
|
|
2674
|
+
gfx_omo_tablet?: {
|
|
2675
|
+
/** @description Graphic encoded with Base64 */
|
|
2676
|
+
base64?: string;
|
|
2677
|
+
/** @description Graphic format */
|
|
2678
|
+
format?: "jpg" | "jpeg" | "png" | "gif" | "svg" | "webp";
|
|
2679
|
+
};
|
|
2680
|
+
/** @description Graphic - When the link is opened - Mobile. */
|
|
2681
|
+
gfx_omo_mobile?: {
|
|
2682
|
+
/** @description Graphic encoded with Base64 */
|
|
2683
|
+
base64?: string;
|
|
2684
|
+
/** @description Graphic format */
|
|
2685
|
+
format?: "jpg" | "jpeg" | "png" | "gif" | "svg" | "webp";
|
|
2686
|
+
};
|
|
2687
|
+
/** @description Add a canonical link that points to the parent menu item: n - no, y - yes. */
|
|
2688
|
+
canonical_to_parent?: "n" | "y";
|
|
2689
|
+
/** @description Meta robots index settings: default - automatically generate, index - index, noindex - noindex. */
|
|
2690
|
+
meta_robots_index?: "default" | "index" | "noindex";
|
|
2691
|
+
/** @description Meta robots follow settings: default - automatically generate, follow - follow, nofollow - nofollow. */
|
|
2692
|
+
meta_robots_follow?: "default" | "follow" | "nofollow";
|
|
2693
|
+
}[];
|
|
2694
|
+
}[];
|
|
2695
|
+
/** @description Settings */
|
|
2696
|
+
settings?: {
|
|
2697
|
+
/** @description Default: "\". */
|
|
2698
|
+
textid_separator?: string;
|
|
2699
|
+
};
|
|
2700
|
+
};
|
|
2701
|
+
|
|
2702
|
+
export type PutClientsDeliveryAddressParams = {
|
|
2703
|
+
/** @description Customer data. */
|
|
2704
|
+
clients: {
|
|
2705
|
+
/** @description Customer's login. */
|
|
2706
|
+
clientLogin: string;
|
|
2707
|
+
/** @description External system code. */
|
|
2708
|
+
clientCodeExternal?: string;
|
|
2709
|
+
/** @description Delivery address ID. */
|
|
2710
|
+
clientDeliveryAddressId: string | number;
|
|
2711
|
+
/** @description List of stores IDs When mask is determined, this parameter is omitted. */
|
|
2712
|
+
shopsIds: number[];
|
|
2713
|
+
/** @description Currency ID */
|
|
2714
|
+
currencyId?: string;
|
|
2715
|
+
/** @description Recipient's first name. */
|
|
2716
|
+
clientDeliveryAddressFirstName?: string;
|
|
2717
|
+
/** @description Recipient's last name. */
|
|
2718
|
+
clientDeliveryAddressLastName?: string;
|
|
2719
|
+
/** @description Additional information. */
|
|
2720
|
+
clientDeliveryAddressAdditional?: string;
|
|
2721
|
+
/** @description Cell phone. */
|
|
2722
|
+
clientDeliveryAddressPhone1?: string;
|
|
2723
|
+
/** @description Recipient's city. */
|
|
2724
|
+
clientDeliveryAddressCity?: string;
|
|
2725
|
+
/** @description Recipient street and number. */
|
|
2726
|
+
clientDeliveryAddressStreet?: string;
|
|
2727
|
+
/** @description Administrative region code. */
|
|
2728
|
+
clientDeliveryAddressRegionId?: string;
|
|
2729
|
+
/** @description Administrative region code. */
|
|
2730
|
+
clientDeliveryAddressProvinceId?: string;
|
|
2731
|
+
/** @description Recipient's postal code. */
|
|
2732
|
+
clientDeliveryAddressZipCode?: string;
|
|
2733
|
+
/** @description Recipient's country. */
|
|
2734
|
+
clientDeliveryAddressCountry?: string;
|
|
2735
|
+
}[];
|
|
2736
|
+
};
|
|
2737
|
+
|
|
2738
|
+
export type PutProductsAttachmentsParams = {
|
|
2739
|
+
productsAttachments: {
|
|
2740
|
+
/** @description Stock keeping unit. */
|
|
2741
|
+
productIdent: {
|
|
2742
|
+
/** @description ID value. */
|
|
2743
|
+
identValue: string | number;
|
|
2744
|
+
/** @description Identifier type. */
|
|
2745
|
+
productIdentType: "id" | "index" | "codeExtern" | "codeProducer";
|
|
2746
|
+
};
|
|
2747
|
+
/** @description Product attachments list. */
|
|
2748
|
+
attachments?: {
|
|
2749
|
+
/** @description Attachment file link. */
|
|
2750
|
+
attachmentUrl: string;
|
|
2751
|
+
/** @description Attachment name. */
|
|
2752
|
+
attachmentName: string;
|
|
2753
|
+
/** @description Language ID */
|
|
2754
|
+
langId: string;
|
|
2755
|
+
/** @description File type: audio, video, doc, other. */
|
|
2756
|
+
attachmentFileType: "audio" | "video" | "doc" | "other" | "image";
|
|
2757
|
+
/** @description Type of customer, attachment should be available for: 'all','ordered','wholesaler','wholesaler_or_ordered','wholesaler_and_ordered'. */
|
|
2758
|
+
attachmentEnable: "all" | "ordered" | "wholesaler" | "wholesaler_or_orderer" | "wholesaler_and_ordered";
|
|
2759
|
+
/** @description Attachment ID. */
|
|
2760
|
+
attachmentId?: number;
|
|
2761
|
+
/** @description Attachment downloads record. */
|
|
2762
|
+
attachmentDownloadLog: "y" | "n";
|
|
2763
|
+
/** @description Attachment file extension. */
|
|
2764
|
+
attachmentFileExtension?: string;
|
|
2765
|
+
/** @description Attachment number. */
|
|
2766
|
+
attachmentPriority?: number;
|
|
2767
|
+
/** @description Flag indicating if an attachment should be removed. */
|
|
2768
|
+
attachmentToDelete?: boolean;
|
|
2769
|
+
/** @description Attachment document types list. */
|
|
2770
|
+
documentTypes?: {
|
|
2771
|
+
/** @description Document type. */
|
|
2772
|
+
documentType?: "energy_label" | "instruction_with_safety_information" | "user_manual" | "installation_instructions" | "product_card" | "guide" | "others";
|
|
2773
|
+
/** @description Additional description. */
|
|
2774
|
+
description?: string;
|
|
2775
|
+
}[];
|
|
2776
|
+
}[];
|
|
2777
|
+
/** @description List of product's virtual attachments. */
|
|
2778
|
+
virtualAttachments?: {
|
|
2779
|
+
/** @description Attachment file link. */
|
|
2780
|
+
attachmentUrl?: string;
|
|
2781
|
+
/** @description Attachment name. */
|
|
2782
|
+
attachmentName?: {
|
|
2783
|
+
/** @description List of languages. */
|
|
2784
|
+
attachmentLanguages?: {
|
|
2785
|
+
/** @description Language ID */
|
|
2786
|
+
langId?: string;
|
|
2787
|
+
/** @description Language name */
|
|
2788
|
+
langName?: string;
|
|
2789
|
+
/** @description Literal in selected language. */
|
|
2790
|
+
langValue?: string;
|
|
2791
|
+
}[];
|
|
2792
|
+
};
|
|
2793
|
+
/** @description Full version or sample. */
|
|
2794
|
+
attachmentType?: "full" | "demo";
|
|
2795
|
+
/** @description Number of attachment downloads limit. */
|
|
2796
|
+
attachmentLimits?: {
|
|
2797
|
+
/** @description Number of downloads limit. */
|
|
2798
|
+
attachmentDownloadsLimit?: number;
|
|
2799
|
+
/** @description Number of days file should be available. */
|
|
2800
|
+
attachmentDaysLimit?: number;
|
|
2801
|
+
};
|
|
2802
|
+
/** @description Attachment ID. */
|
|
2803
|
+
attachmentId?: number;
|
|
2804
|
+
/** @description Attachment number. */
|
|
2805
|
+
attachmentPriority?: number;
|
|
2806
|
+
/** @description Information on error that occurred during gate call. */
|
|
2807
|
+
errors?: {
|
|
2808
|
+
/** @description Error code. */
|
|
2809
|
+
faultCode?: number;
|
|
2810
|
+
/** @description Error description. */
|
|
2811
|
+
faultString?: string;
|
|
2812
|
+
};
|
|
2813
|
+
/** @description Flag indicating if an attachment should be removed. */
|
|
2814
|
+
attachmentToDelete?: boolean;
|
|
2815
|
+
}[];
|
|
2816
|
+
/** @description Information on error that occurred during gate call. */
|
|
2817
|
+
errors?: {
|
|
2818
|
+
/** @description Error code. */
|
|
2819
|
+
faultCode?: number;
|
|
2820
|
+
/** @description Error description. */
|
|
2821
|
+
faultString?: string;
|
|
2822
|
+
};
|
|
2823
|
+
/** @description Flag indicating if there are errors in results of attachments settings. */
|
|
2824
|
+
attachmentsErrorsOccurred?: boolean;
|
|
2825
|
+
/** @description Flag indicating if there are errors in results of virtual attachments settings. */
|
|
2826
|
+
virtualAttachmentsErrorsOccurred?: boolean;
|
|
2827
|
+
}[];
|
|
2828
|
+
};
|
|
2829
|
+
|
|
2830
|
+
export type PutMenuParams = {
|
|
2831
|
+
menu_list: {
|
|
2832
|
+
/** @description Shop Id. */
|
|
2833
|
+
shop_id: number;
|
|
2834
|
+
/** @description Menu ID. */
|
|
2835
|
+
menu_id: number;
|
|
2836
|
+
/** @description Menu element ID. */
|
|
2837
|
+
item_id: string;
|
|
2838
|
+
/** @description Menu element text identifier. Example: "item1\item2\item3". */
|
|
2839
|
+
item_textid?: string;
|
|
2840
|
+
lang_data?: {
|
|
2841
|
+
/** @description Language ID. */
|
|
2842
|
+
lang_id?: string;
|
|
2843
|
+
/** @description Menu element name. */
|
|
2844
|
+
name?: string;
|
|
2845
|
+
/** @description Menu element order. */
|
|
2846
|
+
priority?: number;
|
|
2847
|
+
/** @description Description displayed at the top of products list. */
|
|
2848
|
+
description?: string;
|
|
2849
|
+
/** @description Description displayed at the bottom of products list. */
|
|
2850
|
+
description_bottom?: string;
|
|
2851
|
+
/** @description Own link. */
|
|
2852
|
+
link?: string;
|
|
2853
|
+
/** */
|
|
2854
|
+
item_type?: "products" | "navigation" | "products_with_rich_text" | "navigation_with_rich_text" | "rich_text" | "static" | "link";
|
|
2855
|
+
/** @description Meta title . */
|
|
2856
|
+
meta_title?: string;
|
|
2857
|
+
/** @description Meta description. */
|
|
2858
|
+
meta_description?: string;
|
|
2859
|
+
/** @description Meta - keywords. */
|
|
2860
|
+
meta_keywords?: string;
|
|
2861
|
+
/** @description URL address */
|
|
2862
|
+
url?: string;
|
|
2863
|
+
/** @description Link target attribute: !_self - open on the same page, !_blank - open in a new page. */
|
|
2864
|
+
href_target?: "_self" | "_blank";
|
|
2865
|
+
sort?: {
|
|
2866
|
+
/** @description Default product list view. */
|
|
2867
|
+
view?: "normal" | "list" | "gallery";
|
|
2868
|
+
/** @description Sort by. */
|
|
2869
|
+
sort_by?: "date" | "priority" | "priorityname" | "name" | "price";
|
|
2870
|
+
/** @description Sort order. */
|
|
2871
|
+
sort_order?: "ASC" | "DESC";
|
|
2872
|
+
}[];
|
|
2873
|
+
display_limit?: {
|
|
2874
|
+
/** @description Default product list view. */
|
|
2875
|
+
view?: "normal" | "list" | "gallery";
|
|
2876
|
+
/** @description Limit. */
|
|
2877
|
+
limit?: number;
|
|
2878
|
+
}[];
|
|
2879
|
+
/** */
|
|
2880
|
+
default_view?: "normal" | "list" | "gallery";
|
|
2881
|
+
/** @description Headline name. Leaving this value empty will automatically generate name basing on a name in menu. */
|
|
2882
|
+
headline_name?: string;
|
|
2883
|
+
/** @description Display by default nested elements. n - no, y - yes. */
|
|
2884
|
+
expand?: "n" | "y";
|
|
2885
|
+
/** @description Element of the menu hidden from the clients: n - no, y - yes. */
|
|
2886
|
+
hidden?: "n" | "y";
|
|
2887
|
+
/** @description After clicking on the element in the menu:: expand - Display subelements of the menu if any available, if not - create, reload - reload the page and open. */
|
|
2888
|
+
action?: "reload" | "expand";
|
|
2889
|
+
/** @description Element "show all" is:: products_list - link to the list of products, navigation_site - link to the "Navigation" page. */
|
|
2890
|
+
display_all_type?: "products_list" | "navigation_site";
|
|
2891
|
+
/** @description Display element "show all": n - no, y - yes. */
|
|
2892
|
+
display_all?: "n" | "y";
|
|
2893
|
+
/** @description Disable changing "sort by" for customers: n - no, y - yes. */
|
|
2894
|
+
allow_sort_change?: "n" | "y";
|
|
2895
|
+
/** @description Disable possibility of changing the number of displayed products on the page by customers : n - no, y - yes. */
|
|
2896
|
+
allow_limit_change?: "n" | "y";
|
|
2897
|
+
/** @description Graphics in menu: n - no, y - yes. */
|
|
2898
|
+
node_gfx?: "n" | "y";
|
|
2899
|
+
/** @description Type of graphics - When the cursor is on the link: img - Image (one size for computers, tablets and smartphones, not recommended), img_rwd - Image (three sizes for RWD). */
|
|
2900
|
+
gfx_active_type?: "img" | "img_rwd";
|
|
2901
|
+
/** @description Type of graphics - When the cursor is outside link: img - Image (one size for computers, tablets and smartphones, not recommended), img_rwd - Image (three sizes for RWD). */
|
|
2902
|
+
gfx_inactive_type?: "img" | "img_rwd";
|
|
2903
|
+
/** @description Type of graphics - When the link is opened: img - Image (one size for computers, tablets and smartphones, not recommended), img_rwd - Image (three sizes for RWD). */
|
|
2904
|
+
gfx_omo_type?: "img" | "img_rwd";
|
|
2905
|
+
/** @description Graphic on the "navigation" page. */
|
|
2906
|
+
gfx_nav?: {
|
|
2907
|
+
/** @description Graphic encoded with Base64 */
|
|
2908
|
+
base64?: string;
|
|
2909
|
+
/** @description Graphic format */
|
|
2910
|
+
format?: "jpg" | "jpeg" | "png" | "gif" | "svg" | "webp";
|
|
2911
|
+
};
|
|
2912
|
+
/** @description Graphic - When the cursor is on the link. */
|
|
2913
|
+
gfx_active?: {
|
|
2914
|
+
/** @description Graphic encoded with Base64 */
|
|
2915
|
+
base64?: string;
|
|
2916
|
+
/** @description Graphic format */
|
|
2917
|
+
format?: "jpg" | "jpeg" | "png" | "gif" | "svg" | "webp";
|
|
2918
|
+
};
|
|
2919
|
+
/** @description Graphic - When the cursor is on the link - Desktop. */
|
|
2920
|
+
gfx_active_desktop?: {
|
|
2921
|
+
/** @description Graphic encoded with Base64 */
|
|
2922
|
+
base64?: string;
|
|
2923
|
+
/** @description Graphic format */
|
|
2924
|
+
format?: "jpg" | "jpeg" | "png" | "gif" | "svg" | "webp";
|
|
2925
|
+
};
|
|
2926
|
+
/** @description Graphic - When the cursor is on the link - Tablet. */
|
|
2927
|
+
gfx_active_tablet?: {
|
|
2928
|
+
/** @description Graphic encoded with Base64 */
|
|
2929
|
+
base64?: string;
|
|
2930
|
+
/** @description Graphic format */
|
|
2931
|
+
format?: "jpg" | "jpeg" | "png" | "gif" | "svg" | "webp";
|
|
2932
|
+
};
|
|
2933
|
+
/** @description Graphic - When the cursor is on the link - Mobile. */
|
|
2934
|
+
gfx_active_mobile?: {
|
|
2935
|
+
/** @description Graphic encoded with Base64 */
|
|
2936
|
+
base64?: string;
|
|
2937
|
+
/** @description Graphic format */
|
|
2938
|
+
format?: "jpg" | "jpeg" | "png" | "gif" | "svg" | "webp";
|
|
2939
|
+
};
|
|
2940
|
+
/** @description Graphic - When the cursor is outside link. */
|
|
2941
|
+
gfx?: {
|
|
2942
|
+
/** @description Graphic encoded with Base64 */
|
|
2943
|
+
base64?: string;
|
|
2944
|
+
/** @description Graphic format */
|
|
2945
|
+
format?: "jpg" | "jpeg" | "png" | "gif" | "svg" | "webp";
|
|
2946
|
+
};
|
|
2947
|
+
/** @description Graphic - When the cursor is outside link - Desktop. */
|
|
2948
|
+
gfx_inactive_desktop?: {
|
|
2949
|
+
/** @description Graphic encoded with Base64 */
|
|
2950
|
+
base64?: string;
|
|
2951
|
+
/** @description Graphic format */
|
|
2952
|
+
format?: "jpg" | "jpeg" | "png" | "gif" | "svg" | "webp";
|
|
2953
|
+
};
|
|
2954
|
+
/** @description Graphic - When the cursor is outside link - Tablet. */
|
|
2955
|
+
gfx_inactive_tablet?: {
|
|
2956
|
+
/** @description Graphic encoded with Base64 */
|
|
2957
|
+
base64?: string;
|
|
2958
|
+
/** @description Graphic format */
|
|
2959
|
+
format?: "jpg" | "jpeg" | "png" | "gif" | "svg" | "webp";
|
|
2960
|
+
};
|
|
2961
|
+
/** @description Graphic - When the cursor is outside link - Mobile. */
|
|
2962
|
+
gfx_inactive_mobile?: {
|
|
2963
|
+
/** @description Graphic encoded with Base64 */
|
|
2964
|
+
base64?: string;
|
|
2965
|
+
/** @description Graphic format */
|
|
2966
|
+
format?: "jpg" | "jpeg" | "png" | "gif" | "svg" | "webp";
|
|
2967
|
+
};
|
|
2968
|
+
/** @description Graphic - When the link is opened. */
|
|
2969
|
+
gfx_onmouseover?: {
|
|
2970
|
+
/** @description Graphic encoded with Base64 */
|
|
2971
|
+
base64?: string;
|
|
2972
|
+
/** @description Graphic format */
|
|
2973
|
+
format?: "jpg" | "jpeg" | "png" | "gif" | "svg" | "webp";
|
|
2974
|
+
};
|
|
2975
|
+
/** @description Graphic - When the link is opened - Desktop. */
|
|
2976
|
+
gfx_omo_desktop?: {
|
|
2977
|
+
/** @description Graphic encoded with Base64 */
|
|
2978
|
+
base64?: string;
|
|
2979
|
+
/** @description Graphic format */
|
|
2980
|
+
format?: "jpg" | "jpeg" | "png" | "gif" | "svg" | "webp";
|
|
2981
|
+
};
|
|
2982
|
+
/** @description Graphic - When the link is opened - Tablet. */
|
|
2983
|
+
gfx_omo_tablet?: {
|
|
2984
|
+
/** @description Graphic encoded with Base64 */
|
|
2985
|
+
base64?: string;
|
|
2986
|
+
/** @description Graphic format */
|
|
2987
|
+
format?: "jpg" | "jpeg" | "png" | "gif" | "svg" | "webp";
|
|
2988
|
+
};
|
|
2989
|
+
/** @description Graphic - When the link is opened - Mobile. */
|
|
2990
|
+
gfx_omo_mobile?: {
|
|
2991
|
+
/** @description Graphic encoded with Base64 */
|
|
2992
|
+
base64?: string;
|
|
2993
|
+
/** @description Graphic format */
|
|
2994
|
+
format?: "jpg" | "jpeg" | "png" | "gif" | "svg" | "webp";
|
|
2995
|
+
};
|
|
2996
|
+
/** @description Add a canonical link that points to the parent menu item: n - no, y - yes. */
|
|
2997
|
+
canonical_to_parent?: "n" | "y";
|
|
2998
|
+
/** @description Meta robots index settings: default - automatically generate, index - index, noindex - noindex. */
|
|
2999
|
+
meta_robots_index?: "default" | "index" | "noindex";
|
|
3000
|
+
/** @description Meta robots follow settings: default - automatically generate, follow - follow, nofollow - nofollow. */
|
|
3001
|
+
meta_robots_follow?: "default" | "follow" | "nofollow";
|
|
3002
|
+
}[];
|
|
3003
|
+
}[];
|
|
3004
|
+
/** @description Settings. */
|
|
3005
|
+
settings?: {
|
|
3006
|
+
/** @description Default: "\". */
|
|
3007
|
+
textid_separator?: string;
|
|
3008
|
+
};
|
|
3009
|
+
};
|
|
3010
|
+
|
|
3011
|
+
export type PostPaymentsRepaymentParams = {
|
|
3012
|
+
/** @description Returns ID. */
|
|
3013
|
+
source_id: number;
|
|
3014
|
+
/** @description Defines payment category. For the payments regarding returns, enter 'return'. */
|
|
3015
|
+
source_type: string;
|
|
3016
|
+
/** @description Refund value. */
|
|
3017
|
+
value: number;
|
|
3018
|
+
/** @description Payment method ID. Check getPaymentForms. */
|
|
3019
|
+
payment_form_id: number;
|
|
3020
|
+
/** @description Number of a bank account to which a payment is sent. */
|
|
3021
|
+
account?: string;
|
|
3022
|
+
/** @description Customer account. */
|
|
3023
|
+
client_account?: string;
|
|
3024
|
+
/** @description Other. */
|
|
3025
|
+
other?: {
|
|
3026
|
+
/** @description Payment system. */
|
|
3027
|
+
system?: number;
|
|
3028
|
+
/** @description Number. */
|
|
3029
|
+
number?: string;
|
|
3030
|
+
/** @description Month. */
|
|
3031
|
+
month?: number;
|
|
3032
|
+
/** @description Year. */
|
|
3033
|
+
year?: number;
|
|
3034
|
+
/** @description Security code. */
|
|
3035
|
+
securityCode?: string;
|
|
3036
|
+
/** @description Name. */
|
|
3037
|
+
name?: string;
|
|
3038
|
+
};
|
|
3039
|
+
};
|
|
3040
|
+
|
|
3041
|
+
export type PostResponsibilityEntitiesParams = {
|
|
3042
|
+
entities: {
|
|
3043
|
+
/** @description Identificator of the entity. */
|
|
3044
|
+
id?: number;
|
|
3045
|
+
/** @description Short name/code. */
|
|
3046
|
+
code: string;
|
|
3047
|
+
/** @description Full name. */
|
|
3048
|
+
name: string;
|
|
3049
|
+
/** @description E-mail address. */
|
|
3050
|
+
mail: string;
|
|
3051
|
+
/** @description Street. */
|
|
3052
|
+
street: string;
|
|
3053
|
+
/** @description Building number. */
|
|
3054
|
+
number?: number | null;
|
|
3055
|
+
/** @description Apartment number. */
|
|
3056
|
+
subnumber?: number | null;
|
|
3057
|
+
/** @description Zipcode. */
|
|
3058
|
+
zipcode: string;
|
|
3059
|
+
/** @description City. */
|
|
3060
|
+
city: string;
|
|
3061
|
+
/** @description 2-letter ISO country code. */
|
|
3062
|
+
country: string;
|
|
3063
|
+
/** @description Phone number. */
|
|
3064
|
+
phone?: string | null;
|
|
3065
|
+
/** @description Additional description. */
|
|
3066
|
+
description?: string | null;
|
|
3067
|
+
/** @description URL to contact page. */
|
|
3068
|
+
url?: string | null;
|
|
3069
|
+
}[];
|
|
3070
|
+
/** @description Type of entity */
|
|
3071
|
+
type: "producer" | "person";
|
|
3072
|
+
};
|
|
3073
|
+
|
|
3074
|
+
export type PutProductsCategoriesParams = {
|
|
3075
|
+
/** @description List of categories in which sought products are present. */
|
|
3076
|
+
categories: {
|
|
3077
|
+
/** @description Category id. */
|
|
3078
|
+
id: number;
|
|
3079
|
+
/** @description Parent category ID. */
|
|
3080
|
+
parent_id?: number;
|
|
3081
|
+
/** @description Category priority. Value from 1 to 19. */
|
|
3082
|
+
priority?: number;
|
|
3083
|
+
/** @description Operation code. Allowed values. "add" - adds new category, "edit" - edits existing category, "del" - deletes existing category. */
|
|
3084
|
+
operation?: string;
|
|
3085
|
+
lang_data?: {
|
|
3086
|
+
/** @description Language code. Codes are compliant with ISO-639-3 standard. */
|
|
3087
|
+
lang_id?: string;
|
|
3088
|
+
/** @description Category singular name. */
|
|
3089
|
+
singular_name?: string;
|
|
3090
|
+
/** @description Category plural name. */
|
|
3091
|
+
plural_name?: string;
|
|
3092
|
+
}[];
|
|
3093
|
+
}[];
|
|
3094
|
+
};
|
|
3095
|
+
|
|
3096
|
+
export type SearchProductsParams = {
|
|
3097
|
+
dispatchSettings?: {
|
|
3098
|
+
enabled?: boolean;
|
|
3099
|
+
shippingSettings?: {
|
|
3100
|
+
/** */
|
|
3101
|
+
codDisabled?: "true" | "false";
|
|
3102
|
+
/** */
|
|
3103
|
+
dvpOnly?: "true" | "false";
|
|
3104
|
+
/** */
|
|
3105
|
+
insuranceOnly?: "true" | "false";
|
|
3106
|
+
atypicalSize?: boolean;
|
|
3107
|
+
/** @description Exclusion from the Smile service */
|
|
3108
|
+
excludeSmileService?: boolean;
|
|
3109
|
+
/** @description List of courier services which cannot be used to ship this product. IDs couriers */
|
|
3110
|
+
disallowedCouriers?: number[];
|
|
3111
|
+
};
|
|
3112
|
+
freeShippingSettings?: {
|
|
3113
|
+
/** @description Edition mode */
|
|
3114
|
+
mode?: "no" | "onlyProduct" | "wholeBasket";
|
|
3115
|
+
/** @description Set free shipping for the payment method only */
|
|
3116
|
+
availablePaymentForms?: {
|
|
3117
|
+
prepaid?: boolean;
|
|
3118
|
+
/** @description Cash on delivery. */
|
|
3119
|
+
cashOnDelivery?: boolean;
|
|
3120
|
+
tradeCredit?: boolean;
|
|
3121
|
+
};
|
|
3122
|
+
/** @description List of courier services for which shipping is free. IDs couriers */
|
|
3123
|
+
availableCouriers?: number[];
|
|
3124
|
+
/** @description List of courier services by which the products can be sent free of charge. IDs couriers */
|
|
3125
|
+
availableCouriersForSingleProduct?: number[];
|
|
3126
|
+
/** @description List of regions with free shipment. IDs Delivery regions */
|
|
3127
|
+
availableRegions?: number[];
|
|
3128
|
+
};
|
|
3129
|
+
returnProductSettings?: {
|
|
3130
|
+
/** @description Product can be returned */
|
|
3131
|
+
returnOptions?: {
|
|
3132
|
+
enabled?: boolean;
|
|
3133
|
+
firm?: boolean;
|
|
3134
|
+
hurt?: boolean;
|
|
3135
|
+
detalist?: boolean;
|
|
3136
|
+
};
|
|
3137
|
+
/** */
|
|
3138
|
+
byOwnService?: "true" | "false";
|
|
3139
|
+
/** */
|
|
3140
|
+
byInPostSzybkieZwrotyByIAI?: "true" | "false";
|
|
3141
|
+
};
|
|
3142
|
+
};
|
|
3143
|
+
/** @description Element determines which products should be returned by the gate. Undeleted products are returned by default. Available values: "active" - undeleted products, "deleted" - deleted products. "in_trash" - products in the trash. */
|
|
3144
|
+
returnProducts?: string;
|
|
3145
|
+
/** @description Elements to be returned by the endpoint. By default all elements are returned Available values: * lang_data * adding_time, * deleted, * code, * note, * taxcode, * inwrapper, * sellby_retail, * sellby_wholesale, * producer_id, * producer_name, * iaiCategoryId, * iaiCategoryName, * iaiCategoryPath, * category_id, * category_name, * size_group_id, * modification_time, * currency, * currency_shop, * bestseller, * new_product, * retail_price, * wholesale_price, * minimal_price, * automatic_calculation_price, * pos_price, * strikethrough_retail_price, * strikethrough_wholesale_price, * last_purchase_price, * purchase_price_net_average, * purchase_price_net_last, * purchase_price_gross_average, * purchase_price_gross_last, * vat, * vat_free, * rebate, * hotspots_zones, * profit_points, * points, * weight, * export_to_pricecomparers, * export_to_amazon_marketplace, * enable_in_pos, * complex_notes, * available_profile, * traits, * parameters, * version_data, * advance, * promotion, * discount, * distinguished, * special, * visible, * persistent, * priority, * shops_mask, * icon, * icon_for_auctions, * icon_for_group, * pictures, * unit, * warranty, * series, * products_associated, * shops, * quantities, * sizes_attributes, * shops_attributes, * auction_prices, * price_comparers_prices, * deliverer, * sizes, * size_group_name, * pictures_count, * product_type, * price_changed_time, * quantity_changed_time, * deliverer_name, * available_profile_name, * availability_management_type, * sum_in_basket, * menu, * auction_settings, * bundle, * sizeschart_id, * sizeschart_name, * serialnumbers, * producer_codes_standard, * javaScriptInTheItemCard, * productAuctionDescriptionsData, * priceFormula, * productIndividualDescriptionsData, * productIndividualUrlsData, * productServicesDescriptionsData, * cnTaricCode, * productIsGratis, * dimensions, * responsibleProducerCode, * responsiblePersonCode */
|
|
3146
|
+
returnElements?: string[];
|
|
3147
|
+
/** @description Product availability. Available values: "y" - available, "n" - unavailable. */
|
|
3148
|
+
productIsAvailable?: string;
|
|
3149
|
+
/** @description Product visibility in store Available values: "y" - Visible, "n" - Invisible. */
|
|
3150
|
+
productIsVisible?: string;
|
|
3151
|
+
/** @description Product group ID */
|
|
3152
|
+
productVersionId?: number;
|
|
3153
|
+
/** @description Promoted product. Available values: "y" - promoted, "n" - not promoted. */
|
|
3154
|
+
productInPromotion?: string;
|
|
3155
|
+
/** @description Product on sale. Available values: "y" - on sale, "n" - not on sale. */
|
|
3156
|
+
productInDiscount?: string;
|
|
3157
|
+
/** @description Distinguished product. Available values: "y" - distinguished, "n" - not distinguished. */
|
|
3158
|
+
productInDistinguished?: string;
|
|
3159
|
+
/** @description Special product. Available values: "y" - #!specjalny!#, "n" - not special. */
|
|
3160
|
+
productInSpecial?: string;
|
|
3161
|
+
/** @description Product available for points. Available values: "y" - Available for points, "n" - Unavailable for points. */
|
|
3162
|
+
productInForPointsSelling?: string;
|
|
3163
|
+
/** @description Observed product. Available values: "Y" - observed, "n" - not observed. */
|
|
3164
|
+
productIsObservedByClients?: string;
|
|
3165
|
+
/** @description Element determines if default product (with 0 ID, contains settings of newly added products) should be omitted Available values: "y" - omits default product, "n" - allows to download default product. */
|
|
3166
|
+
skipDefaultProduct?: string;
|
|
3167
|
+
/** @description The item specifies whether promotional prices are to be shown in price nodes. Available values: "y" - show promotional prices, "n" - do not show promotional prices. (default value) */
|
|
3168
|
+
showPromotionsPrices?: string;
|
|
3169
|
+
/** @description List of categories in which sought products are present. */
|
|
3170
|
+
categories?: {
|
|
3171
|
+
/** @description Category id */
|
|
3172
|
+
categoryId?: number;
|
|
3173
|
+
/** @description Category name */
|
|
3174
|
+
categoryName?: string;
|
|
3175
|
+
}[];
|
|
3176
|
+
/** @description List of manufacturers assigned to sought products. */
|
|
3177
|
+
producers?: {
|
|
3178
|
+
/** @description Brand ID */
|
|
3179
|
+
producerId?: number;
|
|
3180
|
+
/** @description Brand name */
|
|
3181
|
+
producerName?: string;
|
|
3182
|
+
}[];
|
|
3183
|
+
/** @description List of sought products. This parameter can be used, when there have been no other parameter entered productIndexes. */
|
|
3184
|
+
productParams?: {
|
|
3185
|
+
/** @description Product IAI code */
|
|
3186
|
+
productId?: number;
|
|
3187
|
+
/** @description External product system code */
|
|
3188
|
+
productCode?: string;
|
|
3189
|
+
/** @description Product name. */
|
|
3190
|
+
productName?: string;
|
|
3191
|
+
/** @description External product system code for size. */
|
|
3192
|
+
productSizeCodeExternal?: string;
|
|
3193
|
+
/** @description Producer code */
|
|
3194
|
+
productProducerCode?: string;
|
|
3195
|
+
/** @description The product is free of charge. Possible values: "y" - is free of charge, "n" - is not free of charge. */
|
|
3196
|
+
productIsGratis?: string;
|
|
3197
|
+
}[];
|
|
3198
|
+
/** @description List of sought products by indexes. */
|
|
3199
|
+
productIndexes?: {
|
|
3200
|
+
/** @description One of the unique, indexed product codes (IAI code / External system code / Producer code) */
|
|
3201
|
+
productIndex?: string;
|
|
3202
|
+
}[];
|
|
3203
|
+
/** @description Data of stores product is assigned to. */
|
|
3204
|
+
productShops?: {
|
|
3205
|
+
/** @description Bit mask of shop IDs. Mask for indicated store is calculated on basis of following formula: 2^(store_ID - 1). If the product should be available in more than one shop, the masks should be summed up. */
|
|
3206
|
+
shopsMask?: number;
|
|
3207
|
+
/** @description Shop Id */
|
|
3208
|
+
shopId?: number;
|
|
3209
|
+
}[];
|
|
3210
|
+
/** @description List of special offers, sought products are assigned to. */
|
|
3211
|
+
productPromotionsIds?: number[];
|
|
3212
|
+
/** @description Settings concerning narrowing list of products found by date. */
|
|
3213
|
+
productDate?: {
|
|
3214
|
+
/** @description Date type. Allowed values "added" - #!dataDodaniaProduktu!#, "finished" - date of running out of product, "resumed" - date of resuming product, "modified" - date of last modification of product, "quantity_changed" - date of last product stock quantity modification, "price_changed" - date of last price change, "modified_and_quantity_changed" - date of last modification and stock quantity change. */
|
|
3215
|
+
productDateMode?: string;
|
|
3216
|
+
/** @description Starting date in the YYYY-MM-DD format */
|
|
3217
|
+
productDateBegin?: string;
|
|
3218
|
+
/** @description End date in the YYYY-MM-DD format */
|
|
3219
|
+
productDateEnd?: string;
|
|
3220
|
+
};
|
|
3221
|
+
/** @description Parameters */
|
|
3222
|
+
productParametersParams?: {
|
|
3223
|
+
/** @description Parameters group name */
|
|
3224
|
+
parameterNames?: string[];
|
|
3225
|
+
/** @description Properties IDs */
|
|
3226
|
+
parameterValuesIds?: number[];
|
|
3227
|
+
/** @description Parameters name */
|
|
3228
|
+
parameterValuesNames?: string[];
|
|
3229
|
+
/** @description Parameters group ID */
|
|
3230
|
+
productParameterIds?: {
|
|
3231
|
+
/** @description Set properties groups ID. */
|
|
3232
|
+
productParameterIdsEnabled?: number[];
|
|
3233
|
+
/** @description Unset properties groups ID. */
|
|
3234
|
+
productParameterIdsDisabled?: number[];
|
|
3235
|
+
};
|
|
3236
|
+
}[];
|
|
3237
|
+
/** @description Series, sought products are assigned to. */
|
|
3238
|
+
productSeriesParams?: {
|
|
3239
|
+
/** @description ID of series, to which product belongs. */
|
|
3240
|
+
seriesId?: number;
|
|
3241
|
+
/** @description Name of series, to which the product belongs, visible in panel. */
|
|
3242
|
+
seriesPanelName?: string;
|
|
3243
|
+
/** @description Names of series in indicated language visible in shop. */
|
|
3244
|
+
seriesDescriptionsLangData?: {
|
|
3245
|
+
/** @description Name of series in indicated language */
|
|
3246
|
+
seriesName?: string;
|
|
3247
|
+
/** @description Language ID */
|
|
3248
|
+
langId?: string;
|
|
3249
|
+
}[];
|
|
3250
|
+
}[];
|
|
3251
|
+
/** @description List of units of measure assigned to sought products. */
|
|
3252
|
+
productUnits?: {
|
|
3253
|
+
/** @description Product unit of measure ID. */
|
|
3254
|
+
unitId?: number;
|
|
3255
|
+
/** @description Product unit of measure name. */
|
|
3256
|
+
unitName?: string;
|
|
3257
|
+
/** @description Unit of measure precision. */
|
|
3258
|
+
unitPrecision?: number;
|
|
3259
|
+
}[];
|
|
3260
|
+
/** @description Narrowing list of products by set warranties. */
|
|
3261
|
+
productWarranties?: {
|
|
3262
|
+
/** @description Product warranty ID. */
|
|
3263
|
+
warrantyId?: number;
|
|
3264
|
+
/** @description Name of warranty for indicated product. */
|
|
3265
|
+
warrantyName?: string;
|
|
3266
|
+
}[];
|
|
3267
|
+
/** @description Suppliers, sought products are assigned to. */
|
|
3268
|
+
deliverersIds?: number[];
|
|
3269
|
+
/** @description Product contains text (searches in short and long description). */
|
|
3270
|
+
containsText?: string;
|
|
3271
|
+
/** @description Product code or it's part (based on producer's code, external product system code and code that is visible on a product card). Search is accesible only with available products. */
|
|
3272
|
+
containsCodePart?: string;
|
|
3273
|
+
/** @description Product availability in stocks */
|
|
3274
|
+
productAvailableInStocks?: {
|
|
3275
|
+
/** @description Determines whether availability in stocks has been set. Available values: "y" - is available in stocks, "n" - unavailable in stocks. */
|
|
3276
|
+
productIsAvailableInStocks?: string;
|
|
3277
|
+
/** @description Narrowing list to stocks sought trough Empty list concerns all stocks. */
|
|
3278
|
+
productAvailableInStocksIds?: number[];
|
|
3279
|
+
};
|
|
3280
|
+
/** @description Product availability on auctions */
|
|
3281
|
+
productAvailableInAuctions?: {
|
|
3282
|
+
/** @description Determines whether availability on auctions has been set. Available values: "y" - is available on auctions, "n" - is not available on auctions. */
|
|
3283
|
+
productIsAvailableInAuctions?: string;
|
|
3284
|
+
/** @description Narrow list of auction accounts sought through. */
|
|
3285
|
+
productAvailableInAuctionsAccountsIds?: number[];
|
|
3286
|
+
};
|
|
3287
|
+
/** @description Page with results number. Numeration starts from 0 */
|
|
3288
|
+
resultsPage?: number;
|
|
3289
|
+
/** @description Number of results on page. Value from 1 to 100 */
|
|
3290
|
+
resultsLimit?: number;
|
|
3291
|
+
/** @description Possibility of sorting returned list */
|
|
3292
|
+
ordersBy?: {
|
|
3293
|
+
/** @description Name of field, list will be sorted by. Available values: "id" - product ID, "name" - Product name, "code" - Product code, "product_sizecode" - External system code, "code_producer" - Producer code, "retail_price" - Retail price of the product, "pos_price" - price for POS, "vat" - Value of VAT, "wholesale_price" - wholesale price, "minimal_price" - Minimal price, "pictures_count" - number of product photos, "auction_name" - product name for auction sites, "pricecomparer_name" - Product name for price comparison websites, "version_name" - Name of the good in the group, "series_name" - Name of the batch, "category_name" - Category name, "deliverer_name" - Supplier name, "adding_time" - Date of entry, "modification_time" - date modified, "price_changed_time" - Date of last price change, "quantity_changed_time" - Date of modification of stock levels, "currency" - Currency DEPRECATED. This parameter is deprecated, "currency_shop" - Currency, "taxcode" - PKWiU [PCPandS], "meta_title" - Products meta titles, "meta_description" - Products meta description, "meta_keywords" - Products meta keywords, "suggested_price" - Recommended price. "observed_clients" - Number of visitors, who signed up to re-availability notifications "observed_time" - Average time of waiting for availability notification "wishes_clients" - Customers, who added product to favorites "wishes_time" - Average number of days, product is in favorites */
|
|
3294
|
+
elementName?: string;
|
|
3295
|
+
/** @description Determines sorting direction. Available values: "ASC" - ascending, "DESC" - descending. */
|
|
3296
|
+
sortDirection?: string;
|
|
3297
|
+
}[];
|
|
3298
|
+
/** @description Language ID that allows to search and return data in chosen language. This parameter is optional. If it's lacking, she search process unfolds in all available languages. */
|
|
3299
|
+
productSearchingLangId?: string;
|
|
3300
|
+
/** @description Currency ID allowing to search and browse products in given currency. This parameter is optional, when it's lacking, the search process unfolds in all available currencies. */
|
|
3301
|
+
productSearchingCurrencyId?: string;
|
|
3302
|
+
/** @description Currency ID allowing for returning all product prices in an indicated currency */
|
|
3303
|
+
returnPricesCurrency?: string;
|
|
3304
|
+
/** @description Annotation contains text. */
|
|
3305
|
+
productHasNote?: string;
|
|
3306
|
+
/** @description Product visibility in export to price comparison and marketplaces. Available values: "y" - Visible, "selected" - Selected, "assign_selected" - Enable the visibility of the product in the export to price comparison sites passed in the priceComparisonSites node. Price comparison sites previously assigned to the commodity will be retained, "unassign_selected" - Disable product visibility in exports to price comparison sites passed in the priceComparisonSites node, "n" - invisible. */
|
|
3307
|
+
productInExportToPriceComparisonSites?: string;
|
|
3308
|
+
/** @description Visibility of an item in an export to Amazon Marketplace. Available values: "y" - Visible, "selected" - Visible on selected regional services, "n" - invisible. */
|
|
3309
|
+
productInExportToAmazonMarketplace?: string;
|
|
3310
|
+
/** @description List of Amazon regional sites to which the product is exported (only in case of "selected" option) */
|
|
3311
|
+
selectedAmazonMarketplacesList?: string[];
|
|
3312
|
+
/** @description Product is bestseller. Available values: "n" - no, "y" - yes. */
|
|
3313
|
+
productInBestseller?: string;
|
|
3314
|
+
/** @description Product is new. Available values: "y" - is new, "n" - is not new. */
|
|
3315
|
+
productInNew?: string;
|
|
3316
|
+
/** @description Shops */
|
|
3317
|
+
searchByShops?: {
|
|
3318
|
+
/** @description Determine data search method on basis of options set for stores. Available values: "in_one_of_selected" - in one of indicated stores, "in_all_of_selected" - in all indicated stores, This parameter is optional. When it's lacking, search is performed by option: in one of indicated stores (in_one_of_selected). */
|
|
3319
|
+
searchModeInShops?: string;
|
|
3320
|
+
/** @description Bit mask of shop IDs. Mask for indicated store is calculated on basis of following formula: 2^(store_ID - 1). If the product should be available in more than one shop, the masks should be summed up. */
|
|
3321
|
+
shopsMask?: number;
|
|
3322
|
+
/** @description List of stores IDs When mask is determined, this parameter is omitted. */
|
|
3323
|
+
shopsIds?: number[];
|
|
3324
|
+
};
|
|
3325
|
+
/** @description Price range for sought products. */
|
|
3326
|
+
productSearchPriceRange?: {
|
|
3327
|
+
/** @description Determines price type for indicated values. Available values: "retail_price" - Retail price of the product, "wholesale_price" - Wholesale price of the product, "minimal_price" - Product minimal price, "pos_price" - price for POS, "last_purchase_price" - Last purchase price. */
|
|
3328
|
+
productSearchPriceMode?: string;
|
|
3329
|
+
/** @description Minimal price for product. */
|
|
3330
|
+
productSearchPriceMin?: number;
|
|
3331
|
+
/** @description Maximum price for product. */
|
|
3332
|
+
productSearchPriceMax?: number;
|
|
3333
|
+
/** @description Shop Id */
|
|
3334
|
+
shopId?: number;
|
|
3335
|
+
};
|
|
3336
|
+
/** @description VAT value for sought products */
|
|
3337
|
+
productVatRates?: number[];
|
|
3338
|
+
/** @description Is product VAT-free Allowed values "y" - yes, "n" - no. */
|
|
3339
|
+
productIsVatFree?: string;
|
|
3340
|
+
/** @description Product has defined wholesale price. Available values: "y" - has wholesale price, "n" - does not have wholesale price. */
|
|
3341
|
+
productHasWholesalePrice?: string;
|
|
3342
|
+
/** @description Product visible even though out of stock Available values: "y" - visible even though out of stock, "n" - not visible when out of stock. */
|
|
3343
|
+
productInPersistent?: string;
|
|
3344
|
+
/** @description Settings of products returned with variants All products with variants are returned by default Available values: version_all - returns all variants, version_main - returns only main variant. */
|
|
3345
|
+
returnProductsVersions?: string;
|
|
3346
|
+
/** @description Do You wish to sum up the products in the basket as a one order? Available values: "y" - yes, "n" - no. */
|
|
3347
|
+
productInSumInBasket?: string;
|
|
3348
|
+
/** @description Product type. Allowed values: "product_item" - Goods, "product_packaging" - packaging, "product_bundle" - set. "product_collection" - collection. "product_service" - service. "product_virtual" - virtual product. "product_configurable" - configurable product. */
|
|
3349
|
+
productType?: {
|
|
3350
|
+
/** @description Should products be returned on list. By default this parameter is set on true. */
|
|
3351
|
+
productTypeInItem?: boolean;
|
|
3352
|
+
/** @description Should sets be returned on list. By default this parameter is set on true. */
|
|
3353
|
+
productTypeInBundle?: boolean;
|
|
3354
|
+
/** @description Should collections be returned. By default this parameter is set on true. */
|
|
3355
|
+
productTypeInCollection?: boolean;
|
|
3356
|
+
/** @description Should packagings be returned on list. By default this parameter is set on true. */
|
|
3357
|
+
productTypeInPackaging?: boolean;
|
|
3358
|
+
/** @description Should services be returned. By default this parameter is set on true. */
|
|
3359
|
+
productTypeInService?: boolean;
|
|
3360
|
+
/** @description Should virtuals be returned. By default this parameter is set on true. */
|
|
3361
|
+
productTypeInVirtual?: boolean;
|
|
3362
|
+
/** @description Should configurable be returned. By default this parameter is set on true. */
|
|
3363
|
+
productTypeInConfigurable?: boolean;
|
|
3364
|
+
};
|
|
3365
|
+
/** @description An array of menu elements */
|
|
3366
|
+
productMenuItems?: {
|
|
3367
|
+
/** @description An array of IDs */
|
|
3368
|
+
menuItemsIds?: number[];
|
|
3369
|
+
/** @description An array of text IDs */
|
|
3370
|
+
menuItemsTextIds?: {
|
|
3371
|
+
/** @description Menu element text identifier. Example: "item1\item2\item3". */
|
|
3372
|
+
menuItemTextId?: string;
|
|
3373
|
+
/** @description Shop Id */
|
|
3374
|
+
shopId?: number;
|
|
3375
|
+
/** @description ID of the menu zone displayed in the mask */
|
|
3376
|
+
menuId?: number;
|
|
3377
|
+
/** @description The separator separates the individual elements of a text id. Default: "\". */
|
|
3378
|
+
menuItemTextIdSeparator?: string;
|
|
3379
|
+
}[];
|
|
3380
|
+
};
|
|
3381
|
+
/** @description Warehouse location ID */
|
|
3382
|
+
productLocationId?: number;
|
|
3383
|
+
/** @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 */
|
|
3384
|
+
productLocationTextId?: string;
|
|
3385
|
+
/** @description Return all size attributes regardless of whether product prices are the same as the base price or if they differ from it. Available values: 1 - all size attributes will be returned; 0 - only attributes of those sizes, where the prices will be different from the base price (default value) will be returned. */
|
|
3386
|
+
alwaysReturnProductShopSizesAttributes?: boolean;
|
|
3387
|
+
/** @description Returns reservation information regardless of inventory levels */
|
|
3388
|
+
returnEmptyStocksWithReservation?: boolean;
|
|
3389
|
+
/** @description Data for operations on individual photos */
|
|
3390
|
+
picturesData?: {
|
|
3391
|
+
/** @description Shop Id */
|
|
3392
|
+
shopId?: number;
|
|
3393
|
+
/** @description External service identifier */
|
|
3394
|
+
serviceId?: number;
|
|
3395
|
+
};
|
|
3396
|
+
/** @description Responsible producer code */
|
|
3397
|
+
responsibleProducerCode?: string;
|
|
3398
|
+
/** @description Responsible person code */
|
|
3399
|
+
responsiblePersonCode?: string;
|
|
3400
|
+
};
|
|
3401
|
+
|
|
3402
|
+
export type SearchOrdersParams = {
|
|
3403
|
+
/** @description Prepayment status. Status list: "unpaid" - not paid, "restored" - returned, "waiting" - not registered. */
|
|
3404
|
+
orderPrepaidStatus?: string;
|
|
3405
|
+
/** @description Order status. Status list: "new" - not handled, "finished" - completed, "false" - false, "lost" - lost, "on_order" - in progress, "packed" - being picked, "ready" - ready, "canceled" - canceled by customer, "payment_waiting" - awaiting payment, "delivery_waiting" - awaiting delivery, "suspended" - on hold, "joined" - merged, "finished_ext" - handled in FA application. */
|
|
3406
|
+
ordersStatuses?: string[];
|
|
3407
|
+
/** @description Order statusses ids. */
|
|
3408
|
+
ordersStatusesIds?: number[];
|
|
3409
|
+
/** */
|
|
3410
|
+
shippmentStatus?: "all" | "received" | "non-received";
|
|
3411
|
+
/** @description Shipping companies (packages deliverers). */
|
|
3412
|
+
couriersName?: string[];
|
|
3413
|
+
/** @description Courier service identifiers */
|
|
3414
|
+
couriersId?: number[];
|
|
3415
|
+
/** @description Order payment method. Allowed values. "cash_on_delivery" - cash on delivery, "prepaid" - prepayment, "tradecredit" - Trade credit. */
|
|
3416
|
+
orderPaymentType?: string;
|
|
3417
|
+
withMissingSalesDocuments?: string[];
|
|
3418
|
+
/** @description Order type. Allowed values. "retail" - retail order, "wholesale" - wholesale order (can be added only by customer with wholesale account registered). Default value:: "retail" */
|
|
3419
|
+
orderType?: "wholesale" | "retail" | "dropshipping" | "deliverer";
|
|
3420
|
+
/** */
|
|
3421
|
+
dropshippingOrderStatus?: "all" | "finished" | "canceled" | "notCanceled";
|
|
3422
|
+
/** @description Orders IDs. */
|
|
3423
|
+
ordersIds?: string[];
|
|
3424
|
+
/** @description Order serial numbers. */
|
|
3425
|
+
ordersSerialNumbers?: number[];
|
|
3426
|
+
/** @description Customer data. */
|
|
3427
|
+
clients?: {
|
|
3428
|
+
/** @description Customer's login. */
|
|
3429
|
+
clientLogin?: string;
|
|
3430
|
+
/** @description Unique client's number. */
|
|
3431
|
+
clientId?: number;
|
|
3432
|
+
/** @description Customer's first name. */
|
|
3433
|
+
clientFirstName?: string;
|
|
3434
|
+
/** @description Customer's last name. */
|
|
3435
|
+
clientLastName?: string;
|
|
3436
|
+
/** @description Customer's city. */
|
|
3437
|
+
clientCity?: string;
|
|
3438
|
+
/** @description E-mail address. */
|
|
3439
|
+
clientEmail?: string;
|
|
3440
|
+
/** @description Parameter can be used to search for orders assigned to customer with VAT number. Available values: "y" - customer has VAT number, "n" - customer does not have VAT number. */
|
|
3441
|
+
clientHasTaxNumber?: string;
|
|
3442
|
+
/** @description Parameter allows to choose, by which data orders should be searched. Includes city, firstname, lastname. Available values: "billing_data" - search by billing data - default, "delivery_data"- search by delivery data, "billing_delivery_data" - search by billing and delivery data. */
|
|
3443
|
+
clientSearchingMode?: string;
|
|
3444
|
+
/** @description Customer's company name. */
|
|
3445
|
+
clientFirm?: string;
|
|
3446
|
+
/** @description Customer Tax no. */
|
|
3447
|
+
clientNip?: string;
|
|
3448
|
+
/** @description Country ID in accordance with ISO-3166. */
|
|
3449
|
+
clientCountryId?: string;
|
|
3450
|
+
/** @description Region name takes priority over clientCountryId. */
|
|
3451
|
+
clientCountryName?: string;
|
|
3452
|
+
}[];
|
|
3453
|
+
/** @description Ranges of dates or serial numbers. */
|
|
3454
|
+
ordersRange?: {
|
|
3455
|
+
/** @description Data for date range */
|
|
3456
|
+
ordersDateRange?: {
|
|
3457
|
+
/** @description Type of date according to the orders are searched. Type of date listing: "add" - date of order was placed, "modified" - date of order modification, "dispatch" - date or order dispatch, "payment" - date of order payment, "last_payments_operation" - date of last payment operation, "declared_payments" - date of last payment. */
|
|
3458
|
+
ordersDateType?: "add" | "modified" | "dispatch" | "payment" | "last_payments_operation" | "declared_payments";
|
|
3459
|
+
/** @description Date chart according to which orders are searched. Type of date listing: "add" - date of order was placed, "modified" - date of order modification, "dispatch" - date or order dispatch, "payment" - date of order payment. "last_payments_operation" - date of last payment operation, "declared_payments" - date of last payment. */
|
|
3460
|
+
ordersDatesTypes?: {
|
|
3461
|
+
/** */
|
|
3462
|
+
ordersDatesType?: "add" | "modified" | "dispatch" | "payment" | "last_payments_operation" | "declared_payments";
|
|
3463
|
+
}[];
|
|
3464
|
+
/** @description Beginning date in YYYY-MM-DD HH:MM:SS format. */
|
|
3465
|
+
ordersDateBegin?: string;
|
|
3466
|
+
/** @description Ending date in YYYY-MM-DD HH:MM:SS format. */
|
|
3467
|
+
ordersDateEnd?: string;
|
|
3468
|
+
};
|
|
3469
|
+
/** @description Data for serial number range. */
|
|
3470
|
+
ordersSerialNumberRange?: {
|
|
3471
|
+
/** @description Starting number of serial numbers range for sought products. */
|
|
3472
|
+
ordersSerialNumberBegin?: number;
|
|
3473
|
+
/** @description Ending number for serial number range. */
|
|
3474
|
+
ordersSerialNumberEnd?: number;
|
|
3475
|
+
};
|
|
3476
|
+
};
|
|
3477
|
+
/** @description Order source data. */
|
|
3478
|
+
orderSource?: {
|
|
3479
|
+
/** @description Bit mask of shop IDs. Mask for indicated store is calculated on basis of following formula: 2^(store_ID - 1). If the product should be available in more than one shop, the masks should be summed up. */
|
|
3480
|
+
shopsMask?: number;
|
|
3481
|
+
/** @description List of stores IDs When mask is determined, this parameter is omitted. */
|
|
3482
|
+
shopsIds?: number[];
|
|
3483
|
+
/** @description Object used for order searching based on auctions' parameters. */
|
|
3484
|
+
auctionsParams?: {
|
|
3485
|
+
/** @description Auction sites names. Auction sites listing: "allegro" - Allegro.pl, "testwebapi" - Allegro.pl test site, "ebay" - eBay. */
|
|
3486
|
+
auctionsServicesNames?: string[];
|
|
3487
|
+
/** @description Auctions' numbers. */
|
|
3488
|
+
auctionsItemsIds?: number[];
|
|
3489
|
+
/** @description Auction sites accounts' data. */
|
|
3490
|
+
auctionsAccounts?: {
|
|
3491
|
+
/** @description Auction service account Id . */
|
|
3492
|
+
auctionsAccountId?: number;
|
|
3493
|
+
/** @description External marketplace service account name (which the listing was created from). */
|
|
3494
|
+
auctionsAccountLogin?: string;
|
|
3495
|
+
}[];
|
|
3496
|
+
/** @description Client's account on auction site data. */
|
|
3497
|
+
auctionsClients?: {
|
|
3498
|
+
/** @description Account ID on auction site. */
|
|
3499
|
+
auctionClientId?: string;
|
|
3500
|
+
/** @description Account login on auction site. */
|
|
3501
|
+
auctionClientLogin?: string;
|
|
3502
|
+
}[];
|
|
3503
|
+
};
|
|
3504
|
+
};
|
|
3505
|
+
/** @description Products list. */
|
|
3506
|
+
products?: {
|
|
3507
|
+
/** @description Product IAI code */
|
|
3508
|
+
productId?: number;
|
|
3509
|
+
/** @description Product name. */
|
|
3510
|
+
productName?: string;
|
|
3511
|
+
/** @description Size identifier */
|
|
3512
|
+
sizeId?: string;
|
|
3513
|
+
/** @description Size name */
|
|
3514
|
+
sizePanelName?: string;
|
|
3515
|
+
}[];
|
|
3516
|
+
/** @description Page with results number. Numeration starts from 0 */
|
|
3517
|
+
resultsPage?: number;
|
|
3518
|
+
/** @description Number of results on page. Value from 1 to 100 */
|
|
3519
|
+
resultsLimit?: number;
|
|
3520
|
+
/** @description Customer asked for invoice. List of parameters: "y" - yes (paper invoicing ), "e" - yes (electronic invoicing ), "n" - no. */
|
|
3521
|
+
clientRequestInvoice?: string;
|
|
3522
|
+
/** @description Information on consignments. */
|
|
3523
|
+
packages?: {
|
|
3524
|
+
/** @description Consignments numbers. */
|
|
3525
|
+
packagesNumbers?: string[];
|
|
3526
|
+
/** @description Does order have consignment number assigned. Available values: "y" - yes, "n" - no. */
|
|
3527
|
+
orderHasPackageNumbers?: string;
|
|
3528
|
+
/** @description Multipack order. Available values: "y" - yes, "n" - no. */
|
|
3529
|
+
hasMultiPackages?: "y" | "n";
|
|
3530
|
+
};
|
|
3531
|
+
/** @description Stock quantities data. */
|
|
3532
|
+
stocks?: {
|
|
3533
|
+
/** @description Stock ID */
|
|
3534
|
+
stockId?: number;
|
|
3535
|
+
}[];
|
|
3536
|
+
/** @description Used discount codes data. */
|
|
3537
|
+
campaign?: {
|
|
3538
|
+
/** @description Campaign ID. */
|
|
3539
|
+
campaignId?: number;
|
|
3540
|
+
/** @description Discount codes. */
|
|
3541
|
+
discountCodes?: string[];
|
|
3542
|
+
};
|
|
3543
|
+
/** @description Loyalty points. */
|
|
3544
|
+
loyaltyPointsMode?: "all" | "given" | "taken" | "given_or_taken" | "given_and_taken" | "not_given_nor_taken";
|
|
3545
|
+
/** @description Order handler. */
|
|
3546
|
+
orderOperatorLogin?: string;
|
|
3547
|
+
/** @description Order picker. */
|
|
3548
|
+
orderPackingPersonLogin?: string;
|
|
3549
|
+
/** @description Possibility of sorting returned list */
|
|
3550
|
+
ordersBy?: {
|
|
3551
|
+
/** @description Name of field, list will be sorted by. Available values: "id" - product ID, "name" - Product name, "code" - Product code, "product_sizecode" - External system code, "code_producer" - Producer code, "retail_price" - Retail price of the product, "pos_price" - price for POS, "vat" - Value of VAT, "wholesale_price" - wholesale price, "minimal_price" - Minimal price, "pictures_count" - number of product photos, "auction_name" - product name for auction sites, "pricecomparer_name" - Product name for price comparison websites, "version_name" - Name of the good in the group, "series_name" - Name of the batch, "category_name" - Category name, "deliverer_name" - Supplier name, "adding_time" - Date of entry, "modification_time" - date modified, "price_changed_time" - Date of last price change, "quantity_changed_time" - Date of modification of stock levels, "currency" - Currency DEPRECATED. This parameter is deprecated, "currency_shop" - Currency, "taxcode" - PKWiU [PCPandS], "meta_title" - Products meta titles, "meta_description" - Products meta description, "meta_keywords" - Products meta keywords, "suggested_price" - Recommended price. "observed_clients" - Number of visitors, who signed up to re-availability notifications "observed_time" - Average time of waiting for availability notification "wishes_clients" - Customers, who added product to favorites "wishes_time" - Average number of days, product is in favorites */
|
|
3552
|
+
elementName?: string;
|
|
3553
|
+
/** @description Determines sorting direction. Available values: "ASC" - ascending, "DESC" - descending. */
|
|
3554
|
+
sortDirection?: string;
|
|
3555
|
+
}[];
|
|
3556
|
+
/** @description Method of searching orders by handler. */
|
|
3557
|
+
searchingOperatorTypeMatch?: "no_assignment" | "no_empty" | "empty";
|
|
3558
|
+
/** @description Orders with the exceeded date of shipment. */
|
|
3559
|
+
ordersDelayed?: "y" | "n";
|
|
3560
|
+
/** @description Combine the components of the set into one item */
|
|
3561
|
+
showBundles?: boolean;
|
|
3562
|
+
/** @description The order ID of the external service */
|
|
3563
|
+
orderExternalId?: string;
|
|
3564
|
+
/** @description Order currency */
|
|
3565
|
+
orderCurrency?: string;
|
|
3566
|
+
};
|
|
3567
|
+
|
|
3568
|
+
export type SearchProductsParametersParams = {
|
|
3569
|
+
/** @description List of identifiers */
|
|
3570
|
+
ids?: number[];
|
|
3571
|
+
/** @description Element text ID - can be entered instead of "id". */
|
|
3572
|
+
textIds?: {
|
|
3573
|
+
/** @description Language ID */
|
|
3574
|
+
languageId?: string;
|
|
3575
|
+
/** @description Text value */
|
|
3576
|
+
value?: string;
|
|
3577
|
+
}[];
|
|
3578
|
+
/** @description List of languages */
|
|
3579
|
+
languagesIds?: string[];
|
|
3580
|
+
/** @description Whether to return a list of parameter value IDs */
|
|
3581
|
+
parameterValueIds?: boolean;
|
|
3582
|
+
/** @description Page with results number. Numeration starts from 0 */
|
|
3583
|
+
resultsPage?: number;
|
|
3584
|
+
/** @description Number of results on page. Value from 1 to 100 */
|
|
3585
|
+
resultsLimit?: number;
|
|
3586
|
+
};
|
|
3587
|
+
|
|
3588
|
+
export type SearchProductsDeliveryTimeParams = {
|
|
3589
|
+
/** @description Stock ID */
|
|
3590
|
+
stockId?: number;
|
|
3591
|
+
/** @description Should products be prepared for personal collection? */
|
|
3592
|
+
isCollectionInPerson?: boolean;
|
|
3593
|
+
products: {
|
|
3594
|
+
/** @description Product Id */
|
|
3595
|
+
productId?: number;
|
|
3596
|
+
/** @description Size identifier */
|
|
3597
|
+
sizeId?: string;
|
|
3598
|
+
/** @description Size name */
|
|
3599
|
+
sizePanelName?: string;
|
|
3600
|
+
/** @description Product IAI code */
|
|
3601
|
+
productIndex?: string;
|
|
3602
|
+
/** @description Product quantity. */
|
|
3603
|
+
productSizeQuantity?: number;
|
|
3604
|
+
}[];
|
|
3605
|
+
};
|
|
3606
|
+
|
|
3607
|
+
export type SearchPackagesParams = {
|
|
3608
|
+
/** @description Consignments numbers. */
|
|
3609
|
+
deliveryPackageNumbers?: string[];
|
|
3610
|
+
/** @description Element, package is assigned to */
|
|
3611
|
+
events: {
|
|
3612
|
+
/** @description Type. */
|
|
3613
|
+
eventType?: "order" | "rma" | "return";
|
|
3614
|
+
/** @description IDs. */
|
|
3615
|
+
eventsIds?: number[];
|
|
3616
|
+
}[];
|
|
3617
|
+
/** @description Return parcel labels. */
|
|
3618
|
+
returnLabels?: boolean;
|
|
3619
|
+
};
|
|
3620
|
+
|
|
3621
|
+
export type SearchClientsCrmParams = {
|
|
3622
|
+
/** @description Customer's login. */
|
|
3623
|
+
clientLogin?: string;
|
|
3624
|
+
/** @description Determines, whether client is a wholesaler. */
|
|
3625
|
+
clientIsWholesaler?: "yes" | "no";
|
|
3626
|
+
/** @description Country ID in accordance with ISO-3166. */
|
|
3627
|
+
clientCountryId?: string;
|
|
3628
|
+
/** @description Language ID */
|
|
3629
|
+
langId?: string;
|
|
3630
|
+
/** @description Customer service representative. */
|
|
3631
|
+
clientCustomerServiceRepresentativeLogin?: string;
|
|
3632
|
+
/** @description Customer group number */
|
|
3633
|
+
clientDiscountGroupNumber?: number;
|
|
3634
|
+
/** @description Date range of customer registrations */
|
|
3635
|
+
clientRegistrationDate?: {
|
|
3636
|
+
/** @description Start date (YYYY-MM-DD). */
|
|
3637
|
+
clientRegistrationDateBegin?: string;
|
|
3638
|
+
/** @description End date (YYYY-MM-DD). */
|
|
3639
|
+
clientRegistrationDateEnd?: string;
|
|
3640
|
+
};
|
|
3641
|
+
/** @description Date of last customer login (YYYY-MM-DD) */
|
|
3642
|
+
clientLastLoginDate?: {
|
|
3643
|
+
/** @description Start date (YYYY-MM-DD). */
|
|
3644
|
+
clientLastLoginDateBegin?: string;
|
|
3645
|
+
/** @description End date (YYYY-MM-DD). */
|
|
3646
|
+
clientLastLoginDateEnd?: string;
|
|
3647
|
+
};
|
|
3648
|
+
/** @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. */
|
|
3649
|
+
clientType?: "person" | "person_male" | "person_female" | "firm";
|
|
3650
|
+
/** @description Information about the loyalty program possible values: - yes_voucher - when customers are in a loyalty program and have only used vouchers, - yes_voucher_cash - when customers are in a loyalty program and have only used vouchers or cash deposits, - yes_clients, - yes_orders - when customers are in the loyalty program and have made at least one order, - no - when customers are in the loyalty program, - banned - when customers are blocked. */
|
|
3651
|
+
clientAffiliateProgram?: {
|
|
3652
|
+
/** @description Does the customer participate in the loyalty program: - yes_voucher_cash, - yes_voucher, - no, - banned. */
|
|
3653
|
+
clientAffiliateProgramValue?: "yes_voucher" | "yes_voucher_cash" | "yes_clients" | "yes_orders" | "no" | "banned";
|
|
3654
|
+
}[];
|
|
3655
|
+
/** @description Permission to E-mail Newsletter. */
|
|
3656
|
+
newsletterEmailApproval?: string;
|
|
3657
|
+
/** @description Permission to SMS Newsletter. */
|
|
3658
|
+
newsletterSmsApproval?: string;
|
|
3659
|
+
/** @description Shops */
|
|
3660
|
+
searchByShops?: {
|
|
3661
|
+
/** @description How to match shops. - one_of_selected - searches for customers assigned to at least one shop present in shopsList. - exactly_selected - searches for customers assigned to all shops present in shopsList. */
|
|
3662
|
+
searchModeInShops?: "one_of_selected" | "exactly_selected";
|
|
3663
|
+
/** @description List of stores IDs When mask is determined, this parameter is omitted. */
|
|
3664
|
+
shopsIds?: number[];
|
|
3665
|
+
};
|
|
3666
|
+
/** @description Loyalty cards: */
|
|
3667
|
+
clientLoyaltyCard?: {
|
|
3668
|
+
/** @description Does the customer have a loyalty card. - yes_active, - yes_not_active, - no. */
|
|
3669
|
+
clientHasLoyaltyCard?: "yes_active" | "yes_not_active" | "no";
|
|
3670
|
+
/** @description Customer loyalty card ID, omitted when has_loyalty_card = no. */
|
|
3671
|
+
clientLoyaltyCardId?: number;
|
|
3672
|
+
/** @description Customer loyalty card number, omitted when has_loyalty_card = no. */
|
|
3673
|
+
clientLoyaltyCardNumber?: string;
|
|
3674
|
+
};
|
|
3675
|
+
/** @description External system code. */
|
|
3676
|
+
clientCodeExternal?: string;
|
|
3677
|
+
/** @description External system codes list. */
|
|
3678
|
+
clientCodesExternal?: string[];
|
|
3679
|
+
/** @description Customer's first name. */
|
|
3680
|
+
clientFirstName?: string;
|
|
3681
|
+
/** @description Customer's last name. */
|
|
3682
|
+
clientLastName?: string;
|
|
3683
|
+
/** @description Customer Tax no. */
|
|
3684
|
+
clientNip?: string;
|
|
3685
|
+
/** @description Customer's company name. */
|
|
3686
|
+
clientFirm?: string;
|
|
3687
|
+
/** @description E-mail address. */
|
|
3688
|
+
clientEmail?: string;
|
|
3689
|
+
/** @description List of shops where a customer agreed or didn't agree to receive email newsletter. */
|
|
3690
|
+
newsletterEmailApprovalsData?: {
|
|
3691
|
+
/** @description Permission to E-mail Newsletter. */
|
|
3692
|
+
inNewsletterEmailApproval?: "y" | "n";
|
|
3693
|
+
/** @description Shop Id */
|
|
3694
|
+
shopId?: number;
|
|
3695
|
+
}[];
|
|
3696
|
+
/** @description List of shops where a customer agreed or didn't agree to receive sms newsletter. */
|
|
3697
|
+
newsletterSmsApprovalsData?: {
|
|
3698
|
+
/** @description Permission to SMS Newsletter. */
|
|
3699
|
+
inNewsletterSmsApproval?: "y" | "n";
|
|
3700
|
+
/** @description Shop Id */
|
|
3701
|
+
shopId?: number;
|
|
3702
|
+
}[];
|
|
3703
|
+
/** @description Customer loyalty card number, omitted when has_loyalty_card = no. */
|
|
3704
|
+
clientLoyaltyCardNumber?: string;
|
|
3705
|
+
/** @description Orders. */
|
|
3706
|
+
orders?: {
|
|
3707
|
+
/** @description Has the customer made an order. - yes, - no. */
|
|
3708
|
+
clientHasOrders?: "yes" | "no";
|
|
3709
|
+
/** @description Minimum order value, omitted when hasOrders = no. */
|
|
3710
|
+
ordersMinimalValue?: number;
|
|
3711
|
+
/** @description Data for serial number range. */
|
|
3712
|
+
ordersSerialNumberRange?: {
|
|
3713
|
+
/** @description Starting number of serial numbers range for sought products. */
|
|
3714
|
+
ordersSerialNumberBegin?: string;
|
|
3715
|
+
/** @description Ending number for serial number range. */
|
|
3716
|
+
ordersSerialNumberEnd?: string;
|
|
3717
|
+
};
|
|
3718
|
+
/** @description Date range of orders made by customers, omitted when hasOrders = no. */
|
|
3719
|
+
ordersAddDate?: {
|
|
3720
|
+
/** @description Start date (YYYY-MM-DD). */
|
|
3721
|
+
ordersAddDateBegin?: string;
|
|
3722
|
+
/** @description End date (YYYY-MM-DD). */
|
|
3723
|
+
ordersAddDateEnd?: string;
|
|
3724
|
+
};
|
|
3725
|
+
};
|
|
3726
|
+
/** @description Elements to be returned by the endpoint. By default all elements are returned */
|
|
3727
|
+
returnElements?: string[];
|
|
3728
|
+
/** @description Page with results number. Numeration starts from 0 */
|
|
3729
|
+
resultsPage?: number;
|
|
3730
|
+
/** @description Number of results on page. Value from 1 to 100 */
|
|
3731
|
+
resultsLimit?: number;
|
|
3732
|
+
/** @description Determines, if data - that will be returned - will be exactly as entered values, or values should be fragment of customer data. */
|
|
3733
|
+
settingsExactSearch?: boolean;
|
|
3734
|
+
};
|
|
3735
|
+
|
|
3736
|
+
export type SearchClientsGiftcardsParams = {
|
|
3737
|
+
/** @description List of gift cards */
|
|
3738
|
+
giftCards?: {
|
|
3739
|
+
/** @description Card ID */
|
|
3740
|
+
id?: number;
|
|
3741
|
+
/** @description Card number */
|
|
3742
|
+
number?: string;
|
|
3743
|
+
/** @description Card PIN */
|
|
3744
|
+
pin?: string;
|
|
3745
|
+
}[];
|
|
3746
|
+
/** @description element is an element array of type searchGiftCards */
|
|
3747
|
+
searchGiftCards?: {
|
|
3748
|
+
/** @description Gift cards type ID */
|
|
3749
|
+
giftCardTypeId?: number;
|
|
3750
|
+
/** @description Name */
|
|
3751
|
+
name?: string;
|
|
3752
|
+
/** @description Notes contain */
|
|
3753
|
+
noteContain?: string;
|
|
3754
|
+
/** @description Value from */
|
|
3755
|
+
balanceFrom?: number;
|
|
3756
|
+
/** @description Value to */
|
|
3757
|
+
balanceTo?: number;
|
|
3758
|
+
/** @description Expiration date from */
|
|
3759
|
+
expirationDateFrom?: string;
|
|
3760
|
+
/** @description Expiration date to */
|
|
3761
|
+
expirationDateTo?: string;
|
|
3762
|
+
/** @description Created from */
|
|
3763
|
+
issueDateFrom?: string;
|
|
3764
|
+
/** @description Created to */
|
|
3765
|
+
issueDateTo?: string;
|
|
3766
|
+
/** @description Page with results number. Numeration starts from 0 */
|
|
3767
|
+
resultsPage?: number;
|
|
3768
|
+
/** @description Number of results on page. Value from 1 to 100 */
|
|
3769
|
+
resultsLimit?: number;
|
|
3770
|
+
};
|
|
3771
|
+
};
|
|
3772
|
+
|
|
3773
|
+
export type SearchClientsNewsletterEmailParams = {
|
|
3774
|
+
shops?: {
|
|
3775
|
+
/** @description Store ID. */
|
|
3776
|
+
shop_id?: number;
|
|
3777
|
+
/** @description Have customer agreed to a newsletter. List of allowed parameters: "y" - yes, "n" - no. */
|
|
3778
|
+
approval?: "y" | "n";
|
|
3779
|
+
/** @description Is registered: y - only registered customers, n - only non-registered customers, null (argument not sent) - all. */
|
|
3780
|
+
registered?: "y" | "n";
|
|
3781
|
+
}[];
|
|
3782
|
+
/** @description Customer language ID. */
|
|
3783
|
+
language?: string;
|
|
3784
|
+
date?: {
|
|
3785
|
+
/** @description Start date (YYYY-MM-DD HH:MM:SS). */
|
|
3786
|
+
from?: string;
|
|
3787
|
+
/** @description End date (YYYY-MM-DD HH:MM:SS). */
|
|
3788
|
+
to?: string;
|
|
3789
|
+
};
|
|
3790
|
+
/** @description Elements to be returned by the endpoint. By default all elements are returned */
|
|
3791
|
+
return_elements?: string[];
|
|
3792
|
+
/** @description Results page number. Numbering begins at 0. Default value: 0. */
|
|
3793
|
+
results_page?: number;
|
|
3794
|
+
/** @description Maximum number of results on a single page. Default is 100. */
|
|
3795
|
+
results_limit?: number;
|
|
3796
|
+
};
|
|
3797
|
+
|
|
3798
|
+
export type SearchOrdersOpinionsParams = {
|
|
3799
|
+
/** @description Review identification */
|
|
3800
|
+
opinion?: {
|
|
3801
|
+
/** @example 1 */
|
|
3802
|
+
id?: number;
|
|
3803
|
+
/** @description Customer language ID. */
|
|
3804
|
+
language?: string;
|
|
3805
|
+
confirmed?: boolean;
|
|
3806
|
+
/** @example host */
|
|
3807
|
+
host?: string;
|
|
3808
|
+
/** @description Shop Id */
|
|
3809
|
+
shopId?: number;
|
|
3810
|
+
};
|
|
3811
|
+
/** @description Orders. */
|
|
3812
|
+
orders?: {
|
|
3813
|
+
/** */
|
|
3814
|
+
type?: "id" | "serialNumber";
|
|
3815
|
+
/** @example value */
|
|
3816
|
+
value?: string;
|
|
3817
|
+
};
|
|
3818
|
+
/** @description Customer data. */
|
|
3819
|
+
clients?: {
|
|
3820
|
+
/** */
|
|
3821
|
+
type?: "id" | "login" | "codeExtern";
|
|
3822
|
+
/** @example value */
|
|
3823
|
+
value?: string;
|
|
3824
|
+
};
|
|
3825
|
+
/** @description Date range */
|
|
3826
|
+
dateRange?: {
|
|
3827
|
+
/** @example begin */
|
|
3828
|
+
begin?: string;
|
|
3829
|
+
/** @example end */
|
|
3830
|
+
end?: string;
|
|
3831
|
+
};
|
|
3832
|
+
/** @description Page with results number. Numeration starts from 0 */
|
|
3833
|
+
resultsPage?: number;
|
|
3834
|
+
/** @description Number of results on page. Value from 1 to 100 */
|
|
3835
|
+
resultsLimit?: number;
|
|
3836
|
+
/** @description Possibility of sorting returned list */
|
|
3837
|
+
ordersBy?: {
|
|
3838
|
+
/** @description Field name by which a list will be sorted. Available values: "date" - Date of adding an opinion, "rating" - Rating attached to opinion, "scorePositive" - Usefulness of the opinion - number of positive ratings, "scoreNegative" - Usefulness of the opinion - number of negative ratings, "modificationDatetime" - Last modification date */
|
|
3839
|
+
elementName?: string;
|
|
3840
|
+
/** @description Determines sorting direction. Available values: "ASC" - ascending, "DESC" - descending. */
|
|
3841
|
+
sortDirection?: string;
|
|
3842
|
+
}[];
|
|
3843
|
+
};
|
|
3844
|
+
|
|
3845
|
+
export type SearchClientsNewsletterSmsParams = {
|
|
3846
|
+
shops?: {
|
|
3847
|
+
/** @description Store ID. */
|
|
3848
|
+
shop_id?: number;
|
|
3849
|
+
/** @description Have customer agreed to a newsletter. List of allowed parameters: "y" - yes, "n" - no. */
|
|
3850
|
+
approval?: "y" | "n";
|
|
3851
|
+
/** @description Is registered: yes - only registered customers, no - only non-registered customers, null (argument not sent) - all. */
|
|
3852
|
+
registered?: "y" | "n";
|
|
3853
|
+
}[];
|
|
3854
|
+
/** @description Customer language ID. */
|
|
3855
|
+
language?: string;
|
|
3856
|
+
date?: {
|
|
3857
|
+
/** @description Start date (YYYY-MM-DD HH:MM:SS). */
|
|
3858
|
+
from?: string;
|
|
3859
|
+
/** @description End date (YYYY-MM-DD HH:MM:SS). */
|
|
3860
|
+
to?: string;
|
|
3861
|
+
};
|
|
3862
|
+
/** @description Elements to be returned by the endpoint. By default all elements are returned */
|
|
3863
|
+
return_elements?: string[];
|
|
3864
|
+
/** @description Results page number. Numbering begins at 0. Default value: 0. */
|
|
3865
|
+
results_page?: number;
|
|
3866
|
+
/** @description Maximum number of results on a single page. Default is 100. */
|
|
3867
|
+
results_limit?: number;
|
|
3868
|
+
};
|
|
3869
|
+
|
|
3870
|
+
export { };
|