@wix/auto_sdk_stores_inventory 1.0.73 → 1.0.75

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.
Files changed (49) hide show
  1. package/build/cjs/index.d.ts +21 -21
  2. package/build/cjs/index.js +175 -175
  3. package/build/cjs/index.js.map +1 -1
  4. package/build/cjs/index.typings.d.ts +197 -197
  5. package/build/cjs/index.typings.js +154 -154
  6. package/build/cjs/index.typings.js.map +1 -1
  7. package/build/cjs/meta.d.ts +178 -178
  8. package/build/cjs/meta.js +140 -140
  9. package/build/cjs/meta.js.map +1 -1
  10. package/build/cjs/schemas.d.ts +63 -63
  11. package/build/cjs/schemas.js +172 -170
  12. package/build/cjs/schemas.js.map +1 -1
  13. package/build/es/index.d.mts +21 -21
  14. package/build/es/index.mjs +175 -175
  15. package/build/es/index.mjs.map +1 -1
  16. package/build/es/index.typings.d.mts +197 -197
  17. package/build/es/index.typings.mjs +154 -154
  18. package/build/es/index.typings.mjs.map +1 -1
  19. package/build/es/meta.d.mts +178 -178
  20. package/build/es/meta.mjs +140 -140
  21. package/build/es/meta.mjs.map +1 -1
  22. package/build/es/schemas.d.mts +63 -63
  23. package/build/es/schemas.mjs +172 -170
  24. package/build/es/schemas.mjs.map +1 -1
  25. package/build/internal/cjs/index.d.ts +21 -21
  26. package/build/internal/cjs/index.typings.d.ts +247 -230
  27. package/build/internal/cjs/meta.d.ts +195 -178
  28. package/build/internal/cjs/schemas.d.ts +63 -63
  29. package/build/internal/es/index.d.mts +21 -21
  30. package/build/internal/es/index.typings.d.mts +247 -230
  31. package/build/internal/es/meta.d.mts +195 -178
  32. package/build/internal/es/schemas.d.mts +63 -63
  33. package/package.json +4 -4
  34. package/build/internal/cjs/index.js +0 -560
  35. package/build/internal/cjs/index.js.map +0 -1
  36. package/build/internal/cjs/index.typings.js +0 -467
  37. package/build/internal/cjs/index.typings.js.map +0 -1
  38. package/build/internal/cjs/meta.js +0 -427
  39. package/build/internal/cjs/meta.js.map +0 -1
  40. package/build/internal/cjs/schemas.js +0 -274
  41. package/build/internal/cjs/schemas.js.map +0 -1
  42. package/build/internal/es/index.mjs +0 -528
  43. package/build/internal/es/index.mjs.map +0 -1
  44. package/build/internal/es/index.typings.mjs +0 -437
  45. package/build/internal/es/index.typings.mjs.map +0 -1
  46. package/build/internal/es/meta.mjs +0 -394
  47. package/build/internal/es/meta.mjs.map +0 -1
  48. package/build/internal/es/schemas.mjs +0 -228
  49. package/build/internal/es/schemas.mjs.map +0 -1
@@ -1,25 +1,7 @@
1
1
  import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
2
- import { GetInventoryVariantsOptions, GetInventoryVariantsResponse, QueryInventoryOptions, QueryInventoryResponse, UpdateInventoryVariantsInventoryItem, DecrementData, IncrementData, InventoryItemChangedEnvelope, InventoryVariantsChangedEnvelope } from './index.typings.js';
2
+ import { UpdateInventoryVariantsInventoryItem, DecrementData, IncrementData, GetInventoryVariantsOptions, GetInventoryVariantsResponse, QueryInventoryOptions, QueryInventoryResponse, InventoryItemChangedEnvelope, InventoryVariantsChangedEnvelope } from './index.typings.js';
3
3
  export { AccountInfo, BaseEventMetadata, BulkUpdateInventoryItemsRequest, BulkUpdateInventoryItemsResponse, BulkUpdateInventoryVariantsRequest, BulkUpdateInventoryVariantsRequestActionOneOf, BulkUpdateInventoryVariantsResponse, ChangedInventoryVariant, ChangedInventoryVariantData, DecrementDataIdOneOf, DecrementInventoryRequest, DecrementInventoryResponse, GetInventoryItemsRequest, GetInventoryItemsResponse, GetInventoryVariantsOptionsIdOneOf, GetInventoryVariantsRequest, GetInventoryVariantsRequestIdOneOf, IdentificationData, IdentificationDataIdOneOf, IncrementDataIdOneOf, IncrementInventoryRequest, IncrementInventoryResponse, InventoryItemChanged, InventoryItemV2, InventoryVariantV2, InventoryVariantsChanged, MessageEnvelope, Paging, PagingMetadata, PreorderInfo, Query, QueryInventoryRequest, ReasonType, ReasonTypeWithLiterals, UpdateInventoryVariantsRequest, UpdateInventoryVariantsResponse, WebhookIdentityType, WebhookIdentityTypeWithLiterals } from './index.typings.js';
4
4
 
5
- declare function getInventoryVariants$1(httpClient: HttpClient): GetInventoryVariantsSignature;
6
- interface GetInventoryVariantsSignature {
7
- /**
8
- * Gets inventory variant information based on the specified option choices.
9
- *
10
- *
11
- * The `getInventoryVariants()` function returns a Promise that resolves to the specified inventory variant information.
12
- * @param - Inventory item ID.
13
- */
14
- (inventoryId: string, options?: GetInventoryVariantsOptions): Promise<NonNullablePaths<GetInventoryVariantsResponse, `inventoryItem.variants` | `inventoryItem.variants.${number}.variantId` | `inventoryItem.variants.${number}.availableForPreorder` | `inventoryItem.numericId` | `inventoryItem.preorderInfo.enabled`, 5>>;
15
- }
16
- declare function queryInventory$1(httpClient: HttpClient): QueryInventorySignature;
17
- interface QueryInventorySignature {
18
- /**
19
- * Returns a list of inventory items, given the provided paging, sorting and filtering.
20
- */
21
- (options?: QueryInventoryOptions): Promise<NonNullablePaths<QueryInventoryResponse, `inventoryItems` | `inventoryItems.${number}.numericId` | `inventoryItems.${number}.preorderInfo.enabled` | `metadata.items` | `metadata.offset` | `totalResults`, 5>>;
22
- }
23
5
  declare function updateInventoryVariants$1(httpClient: HttpClient): UpdateInventoryVariantsSignature;
24
6
  interface UpdateInventoryVariantsSignature {
25
7
  /**
@@ -54,14 +36,32 @@ interface IncrementInventorySignature {
54
36
  */
55
37
  (incrementData: IncrementData[]): Promise<void>;
56
38
  }
39
+ declare function getInventoryVariants$1(httpClient: HttpClient): GetInventoryVariantsSignature;
40
+ interface GetInventoryVariantsSignature {
41
+ /**
42
+ * Gets inventory variant information based on the specified option choices.
43
+ *
44
+ *
45
+ * The `getInventoryVariants()` function returns a Promise that resolves to the specified inventory variant information.
46
+ * @param - Inventory item ID.
47
+ */
48
+ (inventoryId: string, options?: GetInventoryVariantsOptions): Promise<NonNullablePaths<GetInventoryVariantsResponse, `inventoryItem.variants` | `inventoryItem.variants.${number}.variantId` | `inventoryItem.variants.${number}.availableForPreorder` | `inventoryItem.numericId` | `inventoryItem.preorderInfo.enabled`, 5>>;
49
+ }
50
+ declare function queryInventory$1(httpClient: HttpClient): QueryInventorySignature;
51
+ interface QueryInventorySignature {
52
+ /**
53
+ * Returns a list of inventory items, given the provided paging, sorting and filtering.
54
+ */
55
+ (options?: QueryInventoryOptions): Promise<NonNullablePaths<QueryInventoryResponse, `inventoryItems` | `inventoryItems.${number}.numericId` | `inventoryItems.${number}.preorderInfo.enabled` | `metadata.items` | `metadata.offset` | `totalResults`, 5>>;
56
+ }
57
57
  declare const onInventoryItemChanged$1: EventDefinition<InventoryItemChangedEnvelope, "com.wix.ecommerce.inventory.api.v1.InventoryItemChanged">;
58
58
  declare const onInventoryVariantsChanged$1: EventDefinition<InventoryVariantsChangedEnvelope, "com.wix.ecommerce.inventory.api.v1.InventoryVariantsChanged">;
59
59
 
60
- declare const getInventoryVariants: MaybeContext<BuildRESTFunction<typeof getInventoryVariants$1> & typeof getInventoryVariants$1>;
61
- declare const queryInventory: MaybeContext<BuildRESTFunction<typeof queryInventory$1> & typeof queryInventory$1>;
62
60
  declare const updateInventoryVariants: MaybeContext<BuildRESTFunction<typeof updateInventoryVariants$1> & typeof updateInventoryVariants$1>;
63
61
  declare const decrementInventory: MaybeContext<BuildRESTFunction<typeof decrementInventory$1> & typeof decrementInventory$1>;
64
62
  declare const incrementInventory: MaybeContext<BuildRESTFunction<typeof incrementInventory$1> & typeof incrementInventory$1>;
63
+ declare const getInventoryVariants: MaybeContext<BuildRESTFunction<typeof getInventoryVariants$1> & typeof getInventoryVariants$1>;
64
+ declare const queryInventory: MaybeContext<BuildRESTFunction<typeof queryInventory$1> & typeof queryInventory$1>;
65
65
  /**
66
66
  * Triggered when an inventory item is changed.
67
67
  */
@@ -63,6 +63,195 @@ interface PreorderInfo {
63
63
  */
64
64
  limit?: number | null;
65
65
  }
66
+ interface UpdateInventoryVariantsRequest {
67
+ /** Inventory item. */
68
+ inventoryItem: InventoryItemV2;
69
+ /** @internal */
70
+ reason?: ReasonTypeWithLiterals;
71
+ }
72
+ declare enum ReasonType {
73
+ /** Unknown reason. */
74
+ UNKNOWN = "UNKNOWN",
75
+ /** Order related. */
76
+ ORDER = "ORDER",
77
+ /** Manual adjustment. */
78
+ MANUAL = "MANUAL",
79
+ /** Reverting an inventory change. */
80
+ REVERT_INVENTORY_CHANGE = "REVERT_INVENTORY_CHANGE"
81
+ }
82
+ /** @enumType */
83
+ type ReasonTypeWithLiterals = ReasonType | 'UNKNOWN' | 'ORDER' | 'MANUAL' | 'REVERT_INVENTORY_CHANGE';
84
+ interface UpdateInventoryVariantsResponse {
85
+ }
86
+ interface BulkUpdateInventoryVariantsRequest extends BulkUpdateInventoryVariantsRequestActionOneOf {
87
+ /** Change availability. */
88
+ setInStock?: boolean | null;
89
+ /** Set new quantity. */
90
+ setQuantity?: number | null;
91
+ /**
92
+ * Number to increment inventory by.
93
+ * @min 1
94
+ */
95
+ incrementBy?: number | null;
96
+ /**
97
+ * Number to decrement inventory by.
98
+ * @min 1
99
+ */
100
+ decrementBy?: number | null;
101
+ /** Variants filter. Learn more about [API query language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language). */
102
+ filter?: Record<string, any> | null;
103
+ /** @internal */
104
+ reason?: ReasonTypeWithLiterals;
105
+ /** @internal */
106
+ changeTrackingMethod?: boolean;
107
+ }
108
+ /** @oneof */
109
+ interface BulkUpdateInventoryVariantsRequestActionOneOf {
110
+ /** Change availability. */
111
+ setInStock?: boolean | null;
112
+ /** Set new quantity. */
113
+ setQuantity?: number | null;
114
+ /**
115
+ * Number to increment inventory by.
116
+ * @min 1
117
+ */
118
+ incrementBy?: number | null;
119
+ /**
120
+ * Number to decrement inventory by.
121
+ * @min 1
122
+ */
123
+ decrementBy?: number | null;
124
+ }
125
+ interface BulkUpdateInventoryVariantsResponse {
126
+ }
127
+ interface BulkUpdateInventoryItemsRequest {
128
+ /** Variants filter */
129
+ variantsFilter?: Record<string, any> | null;
130
+ /** Whether inventory is being tracked. */
131
+ trackInventory?: boolean | null;
132
+ }
133
+ interface BulkUpdateInventoryItemsResponse {
134
+ }
135
+ interface DecrementInventoryRequest {
136
+ /**
137
+ * Item or product to decrement.
138
+ * @minSize 1
139
+ * @maxSize 300
140
+ */
141
+ decrementData?: DecrementData[];
142
+ /** @internal */
143
+ reason?: ReasonTypeWithLiterals;
144
+ /** @internal */
145
+ restrictInventoryValue?: boolean;
146
+ }
147
+ interface DecrementData extends DecrementDataIdOneOf {
148
+ /**
149
+ * Inventory item ID.
150
+ * @maxLength 36
151
+ */
152
+ inventoryId?: string;
153
+ /**
154
+ * @internal
155
+ * @internal
156
+ * @maxLength 36
157
+ * @deprecated Deprecated: use productId.
158
+ * @replacedBy product_id
159
+ * @targetRemovalDate 2024-12-31
160
+ */
161
+ externalId?: string;
162
+ /**
163
+ * Product ID.
164
+ * @maxLength 36
165
+ */
166
+ productId?: string;
167
+ /**
168
+ * Variant ID.
169
+ * @format GUID
170
+ */
171
+ variantId?: string;
172
+ /**
173
+ * Number to decrement inventory by.
174
+ * @min 1
175
+ */
176
+ decrementBy?: number;
177
+ /**
178
+ * Whether the request to decrement the item's inventory was made as part of a purchase that includes preorder items.
179
+ * If true and the item is available for preorder, we allow negative inventory.
180
+ * If false and the item is not available for preorder, we allow regular buy flow (no negative inventory).
181
+ */
182
+ preorderRequest?: boolean;
183
+ }
184
+ /** @oneof */
185
+ interface DecrementDataIdOneOf {
186
+ /**
187
+ * Inventory item ID.
188
+ * @maxLength 36
189
+ */
190
+ inventoryId?: string;
191
+ /**
192
+ * @internal
193
+ * @internal
194
+ * @maxLength 36
195
+ * @deprecated Deprecated: use productId.
196
+ * @replacedBy product_id
197
+ * @targetRemovalDate 2024-12-31
198
+ */
199
+ externalId?: string;
200
+ /**
201
+ * Product ID.
202
+ * @maxLength 36
203
+ */
204
+ productId?: string;
205
+ }
206
+ interface DecrementInventoryResponse {
207
+ }
208
+ interface IncrementInventoryRequest {
209
+ /**
210
+ * Item or product to increment.
211
+ * @minSize 1
212
+ * @maxSize 300
213
+ */
214
+ incrementData?: IncrementData[];
215
+ /** @internal */
216
+ reason?: ReasonTypeWithLiterals;
217
+ }
218
+ interface IncrementData extends IncrementDataIdOneOf {
219
+ /**
220
+ * Inventory item ID.
221
+ * @maxLength 36
222
+ */
223
+ inventoryId?: string;
224
+ /**
225
+ * Product ID.
226
+ * @maxLength 36
227
+ */
228
+ productId?: string;
229
+ /**
230
+ * Variant ID.
231
+ * @format GUID
232
+ */
233
+ variantId?: string;
234
+ /**
235
+ * Number to increment inventory by.
236
+ * @min 1
237
+ */
238
+ incrementBy?: number;
239
+ }
240
+ /** @oneof */
241
+ interface IncrementDataIdOneOf {
242
+ /**
243
+ * Inventory item ID.
244
+ * @maxLength 36
245
+ */
246
+ inventoryId?: string;
247
+ /**
248
+ * Product ID.
249
+ * @maxLength 36
250
+ */
251
+ productId?: string;
252
+ }
253
+ interface IncrementInventoryResponse {
254
+ }
66
255
  interface InventoryItemChanged {
67
256
  /** Inventory item ID. */
68
257
  inventoryItemId?: string;
@@ -100,6 +289,11 @@ interface InventoryVariantsChanged {
100
289
  productId?: string;
101
290
  /** Information about changed variants. */
102
291
  variants?: ChangedInventoryVariant[];
292
+ /**
293
+ * Reason data
294
+ * @internal
295
+ */
296
+ reason?: ReasonTypeWithLiterals;
103
297
  /** Date and time the inventory variant item was last updated. */
104
298
  _updatedDate?: Date | null;
105
299
  }
@@ -119,18 +313,6 @@ interface ChangedInventoryVariantData {
119
313
  /** Whether the variant is available for preorder. When `true`, the variant is out of stock and preorder is enabled on inventory level. */
120
314
  availableForPreorder?: boolean;
121
315
  }
122
- declare enum ReasonType {
123
- /** Unknown reason. */
124
- UNKNOWN = "UNKNOWN",
125
- /** Order related. */
126
- ORDER = "ORDER",
127
- /** Manual adjustment. */
128
- MANUAL = "MANUAL",
129
- /** Reverting an inventory change. */
130
- REVERT_INVENTORY_CHANGE = "REVERT_INVENTORY_CHANGE"
131
- }
132
- /** @enumType */
133
- type ReasonTypeWithLiterals = ReasonType | 'UNKNOWN' | 'ORDER' | 'MANUAL' | 'REVERT_INVENTORY_CHANGE';
134
316
  interface GetInventoryVariantsRequest extends GetInventoryVariantsRequestIdOneOf {
135
317
  /** Inventory item ID. */
136
318
  inventoryId: string;
@@ -300,171 +482,6 @@ interface AccountInfo {
300
482
  */
301
483
  siteId?: string | null;
302
484
  }
303
- interface UpdateInventoryVariantsRequest {
304
- /** Inventory item. */
305
- inventoryItem: InventoryItemV2;
306
- }
307
- interface UpdateInventoryVariantsResponse {
308
- }
309
- interface BulkUpdateInventoryVariantsRequest extends BulkUpdateInventoryVariantsRequestActionOneOf {
310
- /** Change availability. */
311
- setInStock?: boolean | null;
312
- /** Set new quantity. */
313
- setQuantity?: number | null;
314
- /**
315
- * Number to increment inventory by.
316
- * @min 1
317
- */
318
- incrementBy?: number | null;
319
- /**
320
- * Number to decrement inventory by.
321
- * @min 1
322
- */
323
- decrementBy?: number | null;
324
- /** Variants filter. Learn more about [API query language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language). */
325
- filter?: Record<string, any> | null;
326
- }
327
- /** @oneof */
328
- interface BulkUpdateInventoryVariantsRequestActionOneOf {
329
- /** Change availability. */
330
- setInStock?: boolean | null;
331
- /** Set new quantity. */
332
- setQuantity?: number | null;
333
- /**
334
- * Number to increment inventory by.
335
- * @min 1
336
- */
337
- incrementBy?: number | null;
338
- /**
339
- * Number to decrement inventory by.
340
- * @min 1
341
- */
342
- decrementBy?: number | null;
343
- }
344
- interface BulkUpdateInventoryVariantsResponse {
345
- }
346
- interface BulkUpdateInventoryItemsRequest {
347
- /** Variants filter */
348
- variantsFilter?: Record<string, any> | null;
349
- /** Whether inventory is being tracked. */
350
- trackInventory?: boolean | null;
351
- }
352
- interface BulkUpdateInventoryItemsResponse {
353
- }
354
- interface DecrementInventoryRequest {
355
- /**
356
- * Item or product to decrement.
357
- * @minSize 1
358
- * @maxSize 300
359
- */
360
- decrementData?: DecrementData[];
361
- }
362
- interface DecrementData extends DecrementDataIdOneOf {
363
- /**
364
- * Inventory item ID.
365
- * @maxLength 36
366
- */
367
- inventoryId?: string;
368
- /**
369
- * @internal
370
- * @internal
371
- * @maxLength 36
372
- * @deprecated Deprecated: use productId.
373
- * @replacedBy product_id
374
- * @targetRemovalDate 2024-12-31
375
- */
376
- externalId?: string;
377
- /**
378
- * Product ID.
379
- * @maxLength 36
380
- */
381
- productId?: string;
382
- /**
383
- * Variant ID.
384
- * @format GUID
385
- */
386
- variantId?: string;
387
- /**
388
- * Number to decrement inventory by.
389
- * @min 1
390
- */
391
- decrementBy?: number;
392
- /**
393
- * Whether the request to decrement the item's inventory was made as part of a purchase that includes preorder items.
394
- * If true and the item is available for preorder, we allow negative inventory.
395
- * If false and the item is not available for preorder, we allow regular buy flow (no negative inventory).
396
- */
397
- preorderRequest?: boolean;
398
- }
399
- /** @oneof */
400
- interface DecrementDataIdOneOf {
401
- /**
402
- * Inventory item ID.
403
- * @maxLength 36
404
- */
405
- inventoryId?: string;
406
- /**
407
- * @internal
408
- * @internal
409
- * @maxLength 36
410
- * @deprecated Deprecated: use productId.
411
- * @replacedBy product_id
412
- * @targetRemovalDate 2024-12-31
413
- */
414
- externalId?: string;
415
- /**
416
- * Product ID.
417
- * @maxLength 36
418
- */
419
- productId?: string;
420
- }
421
- interface DecrementInventoryResponse {
422
- }
423
- interface IncrementInventoryRequest {
424
- /**
425
- * Item or product to increment.
426
- * @minSize 1
427
- * @maxSize 300
428
- */
429
- incrementData?: IncrementData[];
430
- }
431
- interface IncrementData extends IncrementDataIdOneOf {
432
- /**
433
- * Inventory item ID.
434
- * @maxLength 36
435
- */
436
- inventoryId?: string;
437
- /**
438
- * Product ID.
439
- * @maxLength 36
440
- */
441
- productId?: string;
442
- /**
443
- * Variant ID.
444
- * @format GUID
445
- */
446
- variantId?: string;
447
- /**
448
- * Number to increment inventory by.
449
- * @min 1
450
- */
451
- incrementBy?: number;
452
- }
453
- /** @oneof */
454
- interface IncrementDataIdOneOf {
455
- /**
456
- * Inventory item ID.
457
- * @maxLength 36
458
- */
459
- inventoryId?: string;
460
- /**
461
- * Product ID.
462
- * @maxLength 36
463
- */
464
- productId?: string;
465
- }
466
- interface IncrementInventoryResponse {
467
- }
468
485
  interface BaseEventMetadata {
469
486
  /**
470
487
  * App instance ID.
@@ -527,59 +544,6 @@ interface InventoryVariantsChangedEnvelope {
527
544
  * @slug inventory_variants_changed
528
545
  */
529
546
  declare function onInventoryVariantsChanged(handler: (event: InventoryVariantsChangedEnvelope) => void | Promise<void>): void;
530
- /**
531
- * Gets inventory variant information based on the specified option choices.
532
- *
533
- *
534
- * The `getInventoryVariants()` function returns a Promise that resolves to the specified inventory variant information.
535
- * @param inventoryId - Inventory item ID.
536
- * @public
537
- * @requiredField inventoryId
538
- * @permissionId WIX_STORES.READ_INVENTORY
539
- * @applicableIdentity APP
540
- * @fqn wix.inventory.api.v1.InventoryReadApi.GetInventoryVariants
541
- */
542
- declare function getInventoryVariants(inventoryId: string, options?: GetInventoryVariantsOptions): Promise<NonNullablePaths<GetInventoryVariantsResponse, `inventoryItem.variants` | `inventoryItem.variants.${number}.variantId` | `inventoryItem.variants.${number}.availableForPreorder` | `inventoryItem.numericId` | `inventoryItem.preorderInfo.enabled`, 5>>;
543
- interface GetInventoryVariantsOptions extends GetInventoryVariantsOptionsIdOneOf {
544
- /**
545
- * @internal
546
- * @internal
547
- * @deprecated Deprecated (use productID instead).
548
- * @replacedBy product_id
549
- * @targetRemovalDate 2024-12-31
550
- */
551
- externalId?: string;
552
- /** Product ID. */
553
- productId?: string;
554
- /** Variant IDs to query for this inventory item (optional). */
555
- variantIds?: string[];
556
- }
557
- /** @oneof */
558
- interface GetInventoryVariantsOptionsIdOneOf {
559
- /** Inventory item ID. */
560
- inventoryId?: string;
561
- /**
562
- * @internal
563
- * @deprecated Deprecated (use productID instead).
564
- * @replacedBy product_id
565
- * @targetRemovalDate 2024-12-31
566
- */
567
- externalId?: string;
568
- /** Product ID. */
569
- productId?: string;
570
- }
571
- /**
572
- * Returns a list of inventory items, given the provided paging, sorting and filtering.
573
- * @public
574
- * @permissionId WIX_STORES.READ_INVENTORY
575
- * @applicableIdentity APP
576
- * @fqn wix.inventory.api.v1.InventoryReadApi.QueryInventory
577
- */
578
- declare function queryInventory(options?: QueryInventoryOptions): Promise<NonNullablePaths<QueryInventoryResponse, `inventoryItems` | `inventoryItems.${number}.numericId` | `inventoryItems.${number}.preorderInfo.enabled` | `metadata.items` | `metadata.offset` | `totalResults`, 5>>;
579
- interface QueryInventoryOptions {
580
- /** Information about paging, filters, sorting. */
581
- query?: Query;
582
- }
583
547
  /**
584
548
  * Updates product inventory, including total quantity, whether the product is in stock, and whether the product inventory is tracked.
585
549
  *
@@ -651,5 +615,58 @@ declare function decrementInventory(decrementData: DecrementData[]): Promise<voi
651
615
  * @fqn wix.inventory.api.v1.InventoryWriteApi.IncrementInventory
652
616
  */
653
617
  declare function incrementInventory(incrementData: IncrementData[]): Promise<void>;
618
+ /**
619
+ * Gets inventory variant information based on the specified option choices.
620
+ *
621
+ *
622
+ * The `getInventoryVariants()` function returns a Promise that resolves to the specified inventory variant information.
623
+ * @param inventoryId - Inventory item ID.
624
+ * @public
625
+ * @requiredField inventoryId
626
+ * @permissionId WIX_STORES.READ_INVENTORY
627
+ * @applicableIdentity APP
628
+ * @fqn wix.inventory.api.v1.InventoryReadApi.GetInventoryVariants
629
+ */
630
+ declare function getInventoryVariants(inventoryId: string, options?: GetInventoryVariantsOptions): Promise<NonNullablePaths<GetInventoryVariantsResponse, `inventoryItem.variants` | `inventoryItem.variants.${number}.variantId` | `inventoryItem.variants.${number}.availableForPreorder` | `inventoryItem.numericId` | `inventoryItem.preorderInfo.enabled`, 5>>;
631
+ interface GetInventoryVariantsOptions extends GetInventoryVariantsOptionsIdOneOf {
632
+ /**
633
+ * @internal
634
+ * @internal
635
+ * @deprecated Deprecated (use productID instead).
636
+ * @replacedBy product_id
637
+ * @targetRemovalDate 2024-12-31
638
+ */
639
+ externalId?: string;
640
+ /** Product ID. */
641
+ productId?: string;
642
+ /** Variant IDs to query for this inventory item (optional). */
643
+ variantIds?: string[];
644
+ }
645
+ /** @oneof */
646
+ interface GetInventoryVariantsOptionsIdOneOf {
647
+ /** Inventory item ID. */
648
+ inventoryId?: string;
649
+ /**
650
+ * @internal
651
+ * @deprecated Deprecated (use productID instead).
652
+ * @replacedBy product_id
653
+ * @targetRemovalDate 2024-12-31
654
+ */
655
+ externalId?: string;
656
+ /** Product ID. */
657
+ productId?: string;
658
+ }
659
+ /**
660
+ * Returns a list of inventory items, given the provided paging, sorting and filtering.
661
+ * @public
662
+ * @permissionId WIX_STORES.READ_INVENTORY
663
+ * @applicableIdentity APP
664
+ * @fqn wix.inventory.api.v1.InventoryReadApi.QueryInventory
665
+ */
666
+ declare function queryInventory(options?: QueryInventoryOptions): Promise<NonNullablePaths<QueryInventoryResponse, `inventoryItems` | `inventoryItems.${number}.numericId` | `inventoryItems.${number}.preorderInfo.enabled` | `metadata.items` | `metadata.offset` | `totalResults`, 5>>;
667
+ interface QueryInventoryOptions {
668
+ /** Information about paging, filters, sorting. */
669
+ query?: Query;
670
+ }
654
671
 
655
672
  export { type AccountInfo, type BaseEventMetadata, type BulkUpdateInventoryItemsRequest, type BulkUpdateInventoryItemsResponse, type BulkUpdateInventoryVariantsRequest, type BulkUpdateInventoryVariantsRequestActionOneOf, type BulkUpdateInventoryVariantsResponse, type ChangedInventoryVariant, type ChangedInventoryVariantData, type DecrementData, type DecrementDataIdOneOf, type DecrementInventoryRequest, type DecrementInventoryResponse, type GetInventoryItemsRequest, type GetInventoryItemsResponse, type GetInventoryVariantsOptions, type GetInventoryVariantsOptionsIdOneOf, type GetInventoryVariantsRequest, type GetInventoryVariantsRequestIdOneOf, type GetInventoryVariantsResponse, type IdentificationData, type IdentificationDataIdOneOf, type IncrementData, type IncrementDataIdOneOf, type IncrementInventoryRequest, type IncrementInventoryResponse, type InventoryItemChanged, type InventoryItemChangedEnvelope, type InventoryItemV2, type InventoryVariantV2, type InventoryVariantsChanged, type InventoryVariantsChangedEnvelope, type MessageEnvelope, type Paging, type PagingMetadata, type PreorderInfo, type Query, type QueryInventoryOptions, type QueryInventoryRequest, type QueryInventoryResponse, ReasonType, type ReasonTypeWithLiterals, type UpdateInventoryVariantsInventoryItem, type UpdateInventoryVariantsRequest, type UpdateInventoryVariantsResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, decrementInventory, getInventoryVariants, incrementInventory, onInventoryItemChanged, onInventoryVariantsChanged, queryInventory, updateInventoryVariants };