@wix/stores 1.0.289 → 1.0.291
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/package.json +14 -14
- package/type-bundles/context.bundle.d.ts +2628 -2674
- package/type-bundles/index.bundle.d.ts +2628 -2674
- package/type-bundles/meta.bundle.d.ts +759 -755
|
@@ -9126,6 +9126,8 @@ interface Product$3 {
|
|
|
9126
9126
|
variantName?: string | null;
|
|
9127
9127
|
/** Variant SKU (stock keeping unit). */
|
|
9128
9128
|
variantSku?: string | null;
|
|
9129
|
+
/** Variant visible. */
|
|
9130
|
+
variantVisible?: boolean | null;
|
|
9129
9131
|
}
|
|
9130
9132
|
interface ExtendedFields$3 {
|
|
9131
9133
|
/**
|
|
@@ -10209,6 +10211,8 @@ interface Product$2 {
|
|
|
10209
10211
|
variantName?: string | null;
|
|
10210
10212
|
/** Variant SKU (stock keeping unit). */
|
|
10211
10213
|
variantSku?: string | null;
|
|
10214
|
+
/** Variant visible. */
|
|
10215
|
+
variantVisible?: boolean | null;
|
|
10212
10216
|
}
|
|
10213
10217
|
interface ExtendedFields$2 {
|
|
10214
10218
|
/**
|
|
@@ -13496,17 +13500,6 @@ interface VariantSummary$1 {
|
|
|
13496
13500
|
*/
|
|
13497
13501
|
visibleVariantIds?: string[];
|
|
13498
13502
|
}
|
|
13499
|
-
interface CreateProductRequest$1 {
|
|
13500
|
-
/**
|
|
13501
|
-
* Product to create.
|
|
13502
|
-
*
|
|
13503
|
-
* At least 1 variant must be provided and each variant must have relevant item in `choices` field for every item in `options`.
|
|
13504
|
-
* If `options` is empty one default variant must be provided with empty `choices` list.
|
|
13505
|
-
*/
|
|
13506
|
-
product: V3Product$1;
|
|
13507
|
-
/** Fields to include in the response. */
|
|
13508
|
-
fields?: SingleEntityOpsRequestedFields$1[];
|
|
13509
|
-
}
|
|
13510
13503
|
declare enum SingleEntityOpsRequestedFields$1 {
|
|
13511
13504
|
UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
|
|
13512
13505
|
URL = "URL",
|
|
@@ -13530,6 +13523,189 @@ declare enum SingleEntityOpsRequestedFields$1 {
|
|
|
13530
13523
|
THUMBNAIL = "THUMBNAIL",
|
|
13531
13524
|
DIRECT_CATEGORY_IDS = "DIRECT_CATEGORY_IDS"
|
|
13532
13525
|
}
|
|
13526
|
+
declare enum RequestedFields$3 {
|
|
13527
|
+
UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
|
|
13528
|
+
URL = "URL",
|
|
13529
|
+
CURRENCY = "CURRENCY",
|
|
13530
|
+
INFO_SECTION = "INFO_SECTION",
|
|
13531
|
+
/** You can request merchant data only if you have `WIX_STORES.PRODUCT_MERCHANT_DATA_READ` permission. */
|
|
13532
|
+
MERCHANT_DATA = "MERCHANT_DATA",
|
|
13533
|
+
PLAIN_DESCRIPTION = "PLAIN_DESCRIPTION",
|
|
13534
|
+
INFO_SECTION_PLAIN_DESCRIPTION = "INFO_SECTION_PLAIN_DESCRIPTION",
|
|
13535
|
+
SUBSCRIPTION_PRICES_INFO = "SUBSCRIPTION_PRICES_INFO",
|
|
13536
|
+
VARIANTS_INFO = "VARIANTS_INFO",
|
|
13537
|
+
BREADCRUMBS_INFO = "BREADCRUMBS_INFO",
|
|
13538
|
+
WEIGHT_MEASUREMENT_UNIT_INFO = "WEIGHT_MEASUREMENT_UNIT_INFO",
|
|
13539
|
+
VARIANT_OPTION_CHOICE_NAMES = "VARIANT_OPTION_CHOICE_NAMES",
|
|
13540
|
+
MEDIA_ITEMS_INFO = "MEDIA_ITEMS_INFO",
|
|
13541
|
+
DESCRIPTION = "DESCRIPTION",
|
|
13542
|
+
DIRECT_CATEGORIES_INFO = "DIRECT_CATEGORIES_INFO",
|
|
13543
|
+
ALL_CATEGORIES_INFO = "ALL_CATEGORIES_INFO",
|
|
13544
|
+
MIN_VARIANT_PRICE_INFO = "MIN_VARIANT_PRICE_INFO",
|
|
13545
|
+
INFO_SECTION_DESCRIPTION = "INFO_SECTION_DESCRIPTION",
|
|
13546
|
+
THUMBNAIL = "THUMBNAIL",
|
|
13547
|
+
DIRECT_CATEGORY_IDS = "DIRECT_CATEGORY_IDS"
|
|
13548
|
+
}
|
|
13549
|
+
interface ApplicationError$3 {
|
|
13550
|
+
/** Error code. */
|
|
13551
|
+
code?: string;
|
|
13552
|
+
/** Description of the error. */
|
|
13553
|
+
description?: string;
|
|
13554
|
+
/** Data related to the error. */
|
|
13555
|
+
data?: Record<string, any> | null;
|
|
13556
|
+
}
|
|
13557
|
+
/** Inventory Item. */
|
|
13558
|
+
interface InventoryItem$1 extends InventoryItemTrackingMethodOneOf$1 {
|
|
13559
|
+
/**
|
|
13560
|
+
* Tracking method - in stock.
|
|
13561
|
+
*
|
|
13562
|
+
* When set to `true`, the item is available for sale without a quantity limit.
|
|
13563
|
+
*/
|
|
13564
|
+
inStock?: boolean;
|
|
13565
|
+
/**
|
|
13566
|
+
* Tracking method - quantity left in inventory.
|
|
13567
|
+
*
|
|
13568
|
+
* Quantity can be negative when decrementing inventory for an order that has already been paid.
|
|
13569
|
+
*/
|
|
13570
|
+
quantity?: number;
|
|
13571
|
+
/**
|
|
13572
|
+
* Inventory item ID.
|
|
13573
|
+
* @readonly
|
|
13574
|
+
*/
|
|
13575
|
+
id?: string | null;
|
|
13576
|
+
/**
|
|
13577
|
+
* Revision number, which increments by 1 each time the inventory item is updated.
|
|
13578
|
+
* To prevent conflicting changes,
|
|
13579
|
+
* the current revision must be passed when updating the inventory item.
|
|
13580
|
+
*
|
|
13581
|
+
* Ignored when creating an inventory item.
|
|
13582
|
+
* @readonly
|
|
13583
|
+
*/
|
|
13584
|
+
revision?: string | null;
|
|
13585
|
+
/**
|
|
13586
|
+
* Date and time the inventory item was created.
|
|
13587
|
+
* @readonly
|
|
13588
|
+
*/
|
|
13589
|
+
createdDate?: Date | null;
|
|
13590
|
+
/**
|
|
13591
|
+
* Date and time the inventory item was created.
|
|
13592
|
+
* @readonly
|
|
13593
|
+
*/
|
|
13594
|
+
updatedDate?: Date | null;
|
|
13595
|
+
/** Variant ID. */
|
|
13596
|
+
variantId?: string;
|
|
13597
|
+
/** Stores location ID. */
|
|
13598
|
+
locationId?: string | null;
|
|
13599
|
+
/** Product ID. */
|
|
13600
|
+
productId?: string;
|
|
13601
|
+
/**
|
|
13602
|
+
* Whether the quantity is being tracked.
|
|
13603
|
+
* @readonly
|
|
13604
|
+
*/
|
|
13605
|
+
trackQuantity?: boolean;
|
|
13606
|
+
/**
|
|
13607
|
+
* Inventory item availability status.
|
|
13608
|
+
*
|
|
13609
|
+
* Supported values:
|
|
13610
|
+
* + OUT_OF_STOCK: Product is out of stock.
|
|
13611
|
+
* + IN_STOCK: Product is in stock. See `quantity` field for exact amount in stock.
|
|
13612
|
+
* + PREORDER: Product is only available for preorder. See `preorderInfo` field for more info.
|
|
13613
|
+
* @readonly
|
|
13614
|
+
*/
|
|
13615
|
+
availabilityStatus?: AvailabilityStatus$1;
|
|
13616
|
+
/** Item preorder info. */
|
|
13617
|
+
preorderInfo?: PreorderInfo$3;
|
|
13618
|
+
/**
|
|
13619
|
+
* Product.
|
|
13620
|
+
* @readonly
|
|
13621
|
+
*/
|
|
13622
|
+
product?: Product$1;
|
|
13623
|
+
/**
|
|
13624
|
+
* Custom field data for the inventory item object.
|
|
13625
|
+
*
|
|
13626
|
+
* [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the app dashboard before they can be accessed with API calls.
|
|
13627
|
+
*/
|
|
13628
|
+
extendedFields?: ExtendedFields$1;
|
|
13629
|
+
}
|
|
13630
|
+
/** @oneof */
|
|
13631
|
+
interface InventoryItemTrackingMethodOneOf$1 {
|
|
13632
|
+
/**
|
|
13633
|
+
* Tracking method - in stock.
|
|
13634
|
+
*
|
|
13635
|
+
* When set to `true`, the item is available for sale without a quantity limit.
|
|
13636
|
+
*/
|
|
13637
|
+
inStock?: boolean;
|
|
13638
|
+
/**
|
|
13639
|
+
* Tracking method - quantity left in inventory.
|
|
13640
|
+
*
|
|
13641
|
+
* Quantity can be negative when decrementing inventory for an order that has already been paid.
|
|
13642
|
+
*/
|
|
13643
|
+
quantity?: number;
|
|
13644
|
+
}
|
|
13645
|
+
declare enum AvailabilityStatus$1 {
|
|
13646
|
+
UNKNOWN_AVAILABILITY_STATUS = "UNKNOWN_AVAILABILITY_STATUS",
|
|
13647
|
+
OUT_OF_STOCK = "OUT_OF_STOCK",
|
|
13648
|
+
IN_STOCK = "IN_STOCK",
|
|
13649
|
+
/**
|
|
13650
|
+
* Whether the variant is available for preorder. InventoryItem will be available only when all below conditions are met:
|
|
13651
|
+
* 1. the variant is out of stock
|
|
13652
|
+
* 2. preorder is enabled on inventory item level (preorder_setting.enabled is true)
|
|
13653
|
+
* 3. preorder limit wasn't reached (preorder_setting.limit)
|
|
13654
|
+
*/
|
|
13655
|
+
PREORDER = "PREORDER"
|
|
13656
|
+
}
|
|
13657
|
+
interface PreorderInfo$3 {
|
|
13658
|
+
/**
|
|
13659
|
+
* Whether preorder is enabled for the product.
|
|
13660
|
+
*
|
|
13661
|
+
* Default: `false`
|
|
13662
|
+
*/
|
|
13663
|
+
enabled?: boolean | null;
|
|
13664
|
+
/** A message the customer will see when the item is out of stock and preorder is enabled. */
|
|
13665
|
+
message?: string | null;
|
|
13666
|
+
/**
|
|
13667
|
+
* Number of products that can be preordered after stock reaches zero.
|
|
13668
|
+
* Supported only for inventory items with `trackQuantity = true`.
|
|
13669
|
+
*
|
|
13670
|
+
* Default: `100000`
|
|
13671
|
+
*/
|
|
13672
|
+
limit?: number | null;
|
|
13673
|
+
/**
|
|
13674
|
+
* Number of times the product was preordered.
|
|
13675
|
+
*
|
|
13676
|
+
* Supported only for inventory items with `trackQuantity = true`.
|
|
13677
|
+
* @readonly
|
|
13678
|
+
*/
|
|
13679
|
+
counter?: number | null;
|
|
13680
|
+
/**
|
|
13681
|
+
* Quantity of products that can be preordered.
|
|
13682
|
+
*
|
|
13683
|
+
* Supported only for inventory items with `trackQuantity = true`.
|
|
13684
|
+
* @readonly
|
|
13685
|
+
*/
|
|
13686
|
+
quantity?: number | null;
|
|
13687
|
+
}
|
|
13688
|
+
interface Product$1 {
|
|
13689
|
+
/** Product name. */
|
|
13690
|
+
name?: string | null;
|
|
13691
|
+
/** List of category IDs that this product is included in directly. */
|
|
13692
|
+
directCategoryIds?: string[];
|
|
13693
|
+
/** Variant name. */
|
|
13694
|
+
variantName?: string | null;
|
|
13695
|
+
/** Variant SKU (stock keeping unit). */
|
|
13696
|
+
variantSku?: string | null;
|
|
13697
|
+
}
|
|
13698
|
+
interface CreateProductRequest$1 {
|
|
13699
|
+
/**
|
|
13700
|
+
* Product to create.
|
|
13701
|
+
*
|
|
13702
|
+
* At least 1 variant must be provided and each variant must have relevant item in `choices` field for every item in `options`.
|
|
13703
|
+
* If `options` is empty one default variant must be provided with empty `choices` list.
|
|
13704
|
+
*/
|
|
13705
|
+
product: V3Product$1;
|
|
13706
|
+
/** Fields to include in the response. */
|
|
13707
|
+
fields?: SingleEntityOpsRequestedFields$1[];
|
|
13708
|
+
}
|
|
13533
13709
|
interface CreateProductResponse$1 {
|
|
13534
13710
|
/** Created product. */
|
|
13535
13711
|
product?: V3Product$1;
|
|
@@ -13766,37 +13942,6 @@ interface InventoryItemCompositeTrackingMethodOneOf$1 {
|
|
|
13766
13942
|
*/
|
|
13767
13943
|
quantity?: number;
|
|
13768
13944
|
}
|
|
13769
|
-
interface PreorderInfo$3 {
|
|
13770
|
-
/**
|
|
13771
|
-
* Whether preorder is enabled for the product.
|
|
13772
|
-
*
|
|
13773
|
-
* Default: `false`
|
|
13774
|
-
*/
|
|
13775
|
-
enabled?: boolean | null;
|
|
13776
|
-
/** A message the customer will see when the item is out of stock and preorder is enabled. */
|
|
13777
|
-
message?: string | null;
|
|
13778
|
-
/**
|
|
13779
|
-
* Number of products that can be preordered after stock reaches zero.
|
|
13780
|
-
* Supported only for inventory items with `trackQuantity = true`.
|
|
13781
|
-
*
|
|
13782
|
-
* Default: `100000`
|
|
13783
|
-
*/
|
|
13784
|
-
limit?: number | null;
|
|
13785
|
-
/**
|
|
13786
|
-
* Number of times the product was preordered.
|
|
13787
|
-
*
|
|
13788
|
-
* Supported only for inventory items with `trackQuantity = true`.
|
|
13789
|
-
* @readonly
|
|
13790
|
-
*/
|
|
13791
|
-
counter?: number | null;
|
|
13792
|
-
/**
|
|
13793
|
-
* Quantity of products that can be preordered.
|
|
13794
|
-
*
|
|
13795
|
-
* Supported only for inventory items with `trackQuantity = true`.
|
|
13796
|
-
* @readonly
|
|
13797
|
-
*/
|
|
13798
|
-
quantity?: number | null;
|
|
13799
|
-
}
|
|
13800
13945
|
interface OptionChoiceReferences$1 {
|
|
13801
13946
|
/** Option and choice IDs. */
|
|
13802
13947
|
optionChoiceIds?: V3OptionChoiceIds$1;
|
|
@@ -13851,147 +13996,29 @@ interface CommonItemMetadata$1 {
|
|
|
13851
13996
|
/** Details about the error in case of failure. */
|
|
13852
13997
|
error?: ApplicationError$3;
|
|
13853
13998
|
}
|
|
13854
|
-
interface
|
|
13855
|
-
/**
|
|
13856
|
-
|
|
13857
|
-
/**
|
|
13858
|
-
|
|
13859
|
-
/**
|
|
13860
|
-
|
|
13999
|
+
interface CommonBulkActionMetadata$1 {
|
|
14000
|
+
/** Number of items that were successfully processed. */
|
|
14001
|
+
totalSuccesses?: number;
|
|
14002
|
+
/** Number of items that couldn't be processed. */
|
|
14003
|
+
totalFailures?: number;
|
|
14004
|
+
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
14005
|
+
undetailedFailures?: number;
|
|
13861
14006
|
}
|
|
13862
|
-
|
|
13863
|
-
|
|
14007
|
+
interface UpdateProductRequest$1 {
|
|
14008
|
+
/** Product to update. */
|
|
14009
|
+
product: V3Product$1;
|
|
14010
|
+
/** Fields to include in the response. */
|
|
14011
|
+
fields?: SingleEntityOpsRequestedFields$1[];
|
|
14012
|
+
}
|
|
14013
|
+
interface UpdateProductResponse$1 {
|
|
14014
|
+
/** Updated product. */
|
|
14015
|
+
product?: V3Product$1;
|
|
14016
|
+
}
|
|
14017
|
+
interface UpdateProductWithInventoryRequest$1 {
|
|
14018
|
+
/** Product to update. */
|
|
14019
|
+
product: ProductWithInventory$1;
|
|
13864
14020
|
/**
|
|
13865
|
-
*
|
|
13866
|
-
*
|
|
13867
|
-
* When set to `true`, the item is available for sale without a quantity limit.
|
|
13868
|
-
*/
|
|
13869
|
-
inStock?: boolean;
|
|
13870
|
-
/**
|
|
13871
|
-
* Tracking method - quantity left in inventory.
|
|
13872
|
-
*
|
|
13873
|
-
* Quantity can be negative when decrementing inventory for an order that has already been paid.
|
|
13874
|
-
*/
|
|
13875
|
-
quantity?: number;
|
|
13876
|
-
/**
|
|
13877
|
-
* Inventory item ID.
|
|
13878
|
-
* @readonly
|
|
13879
|
-
*/
|
|
13880
|
-
id?: string | null;
|
|
13881
|
-
/**
|
|
13882
|
-
* Revision number, which increments by 1 each time the inventory item is updated.
|
|
13883
|
-
* To prevent conflicting changes,
|
|
13884
|
-
* the current revision must be passed when updating the inventory item.
|
|
13885
|
-
*
|
|
13886
|
-
* Ignored when creating an inventory item.
|
|
13887
|
-
* @readonly
|
|
13888
|
-
*/
|
|
13889
|
-
revision?: string | null;
|
|
13890
|
-
/**
|
|
13891
|
-
* Date and time the inventory item was created.
|
|
13892
|
-
* @readonly
|
|
13893
|
-
*/
|
|
13894
|
-
createdDate?: Date | null;
|
|
13895
|
-
/**
|
|
13896
|
-
* Date and time the inventory item was created.
|
|
13897
|
-
* @readonly
|
|
13898
|
-
*/
|
|
13899
|
-
updatedDate?: Date | null;
|
|
13900
|
-
/** Variant ID. */
|
|
13901
|
-
variantId?: string;
|
|
13902
|
-
/** Stores location ID. */
|
|
13903
|
-
locationId?: string | null;
|
|
13904
|
-
/** Product ID. */
|
|
13905
|
-
productId?: string;
|
|
13906
|
-
/**
|
|
13907
|
-
* Whether the quantity is being tracked.
|
|
13908
|
-
* @readonly
|
|
13909
|
-
*/
|
|
13910
|
-
trackQuantity?: boolean;
|
|
13911
|
-
/**
|
|
13912
|
-
* Inventory item availability status.
|
|
13913
|
-
*
|
|
13914
|
-
* Supported values:
|
|
13915
|
-
* + OUT_OF_STOCK: Product is out of stock.
|
|
13916
|
-
* + IN_STOCK: Product is in stock. See `quantity` field for exact amount in stock.
|
|
13917
|
-
* + PREORDER: Product is only available for preorder. See `preorderInfo` field for more info.
|
|
13918
|
-
* @readonly
|
|
13919
|
-
*/
|
|
13920
|
-
availabilityStatus?: AvailabilityStatus$1;
|
|
13921
|
-
/** Item preorder info. */
|
|
13922
|
-
preorderInfo?: PreorderInfo$3;
|
|
13923
|
-
/**
|
|
13924
|
-
* Product.
|
|
13925
|
-
* @readonly
|
|
13926
|
-
*/
|
|
13927
|
-
product?: Product$1;
|
|
13928
|
-
/**
|
|
13929
|
-
* Custom field data for the inventory item object.
|
|
13930
|
-
*
|
|
13931
|
-
* [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the app dashboard before they can be accessed with API calls.
|
|
13932
|
-
*/
|
|
13933
|
-
extendedFields?: ExtendedFields$1;
|
|
13934
|
-
}
|
|
13935
|
-
/** @oneof */
|
|
13936
|
-
interface InventoryItemTrackingMethodOneOf$1 {
|
|
13937
|
-
/**
|
|
13938
|
-
* Tracking method - in stock.
|
|
13939
|
-
*
|
|
13940
|
-
* When set to `true`, the item is available for sale without a quantity limit.
|
|
13941
|
-
*/
|
|
13942
|
-
inStock?: boolean;
|
|
13943
|
-
/**
|
|
13944
|
-
* Tracking method - quantity left in inventory.
|
|
13945
|
-
*
|
|
13946
|
-
* Quantity can be negative when decrementing inventory for an order that has already been paid.
|
|
13947
|
-
*/
|
|
13948
|
-
quantity?: number;
|
|
13949
|
-
}
|
|
13950
|
-
declare enum AvailabilityStatus$1 {
|
|
13951
|
-
UNKNOWN_AVAILABILITY_STATUS = "UNKNOWN_AVAILABILITY_STATUS",
|
|
13952
|
-
OUT_OF_STOCK = "OUT_OF_STOCK",
|
|
13953
|
-
IN_STOCK = "IN_STOCK",
|
|
13954
|
-
/**
|
|
13955
|
-
* Whether the variant is available for preorder. InventoryItem will be available only when all below conditions are met:
|
|
13956
|
-
* 1. the variant is out of stock
|
|
13957
|
-
* 2. preorder is enabled on inventory item level (preorder_setting.enabled is true)
|
|
13958
|
-
* 3. preorder limit wasn't reached (preorder_setting.limit)
|
|
13959
|
-
*/
|
|
13960
|
-
PREORDER = "PREORDER"
|
|
13961
|
-
}
|
|
13962
|
-
interface Product$1 {
|
|
13963
|
-
/** Product name. */
|
|
13964
|
-
name?: string | null;
|
|
13965
|
-
/** List of category IDs that this product is included in directly. */
|
|
13966
|
-
directCategoryIds?: string[];
|
|
13967
|
-
/** Variant name. */
|
|
13968
|
-
variantName?: string | null;
|
|
13969
|
-
/** Variant SKU (stock keeping unit). */
|
|
13970
|
-
variantSku?: string | null;
|
|
13971
|
-
}
|
|
13972
|
-
interface CommonBulkActionMetadata$1 {
|
|
13973
|
-
/** Number of items that were successfully processed. */
|
|
13974
|
-
totalSuccesses?: number;
|
|
13975
|
-
/** Number of items that couldn't be processed. */
|
|
13976
|
-
totalFailures?: number;
|
|
13977
|
-
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
13978
|
-
undetailedFailures?: number;
|
|
13979
|
-
}
|
|
13980
|
-
interface UpdateProductRequest$1 {
|
|
13981
|
-
/** Product to update. */
|
|
13982
|
-
product: V3Product$1;
|
|
13983
|
-
/** Fields to include in the response. */
|
|
13984
|
-
fields?: SingleEntityOpsRequestedFields$1[];
|
|
13985
|
-
}
|
|
13986
|
-
interface UpdateProductResponse$1 {
|
|
13987
|
-
/** Updated product. */
|
|
13988
|
-
product?: V3Product$1;
|
|
13989
|
-
}
|
|
13990
|
-
interface UpdateProductWithInventoryRequest$1 {
|
|
13991
|
-
/** Product to update. */
|
|
13992
|
-
product: ProductWithInventory$1;
|
|
13993
|
-
/**
|
|
13994
|
-
* Whether to return the full inventory entities in the response.
|
|
14021
|
+
* Whether to return the full inventory entities in the response.
|
|
13995
14022
|
*
|
|
13996
14023
|
* Default: `false`
|
|
13997
14024
|
*/
|
|
@@ -14017,29 +14044,6 @@ interface BulkCreateProductsRequest$1 {
|
|
|
14017
14044
|
/** Fields to include in the response. */
|
|
14018
14045
|
fields?: RequestedFields$3[];
|
|
14019
14046
|
}
|
|
14020
|
-
declare enum RequestedFields$3 {
|
|
14021
|
-
UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
|
|
14022
|
-
URL = "URL",
|
|
14023
|
-
CURRENCY = "CURRENCY",
|
|
14024
|
-
INFO_SECTION = "INFO_SECTION",
|
|
14025
|
-
/** You can request merchant data only if you have `WIX_STORES.PRODUCT_MERCHANT_DATA_READ` permission. */
|
|
14026
|
-
MERCHANT_DATA = "MERCHANT_DATA",
|
|
14027
|
-
PLAIN_DESCRIPTION = "PLAIN_DESCRIPTION",
|
|
14028
|
-
INFO_SECTION_PLAIN_DESCRIPTION = "INFO_SECTION_PLAIN_DESCRIPTION",
|
|
14029
|
-
SUBSCRIPTION_PRICES_INFO = "SUBSCRIPTION_PRICES_INFO",
|
|
14030
|
-
VARIANTS_INFO = "VARIANTS_INFO",
|
|
14031
|
-
BREADCRUMBS_INFO = "BREADCRUMBS_INFO",
|
|
14032
|
-
WEIGHT_MEASUREMENT_UNIT_INFO = "WEIGHT_MEASUREMENT_UNIT_INFO",
|
|
14033
|
-
VARIANT_OPTION_CHOICE_NAMES = "VARIANT_OPTION_CHOICE_NAMES",
|
|
14034
|
-
MEDIA_ITEMS_INFO = "MEDIA_ITEMS_INFO",
|
|
14035
|
-
DESCRIPTION = "DESCRIPTION",
|
|
14036
|
-
DIRECT_CATEGORIES_INFO = "DIRECT_CATEGORIES_INFO",
|
|
14037
|
-
ALL_CATEGORIES_INFO = "ALL_CATEGORIES_INFO",
|
|
14038
|
-
MIN_VARIANT_PRICE_INFO = "MIN_VARIANT_PRICE_INFO",
|
|
14039
|
-
INFO_SECTION_DESCRIPTION = "INFO_SECTION_DESCRIPTION",
|
|
14040
|
-
THUMBNAIL = "THUMBNAIL",
|
|
14041
|
-
DIRECT_CATEGORY_IDS = "DIRECT_CATEGORY_IDS"
|
|
14042
|
-
}
|
|
14043
14047
|
interface BulkCreateProductsResponse$1 {
|
|
14044
14048
|
/** Products created by bulk action. */
|
|
14045
14049
|
results?: CatalogV3BulkProductResult$1[];
|
|
@@ -17883,17 +17887,6 @@ interface VariantSummary {
|
|
|
17883
17887
|
*/
|
|
17884
17888
|
visibleVariantIds?: string[];
|
|
17885
17889
|
}
|
|
17886
|
-
interface CreateProductRequest {
|
|
17887
|
-
/**
|
|
17888
|
-
* Product to create.
|
|
17889
|
-
*
|
|
17890
|
-
* At least 1 variant must be provided and each variant must have relevant item in `choices` field for every item in `options`.
|
|
17891
|
-
* If `options` is empty one default variant must be provided with empty `choices` list.
|
|
17892
|
-
*/
|
|
17893
|
-
product: V3Product;
|
|
17894
|
-
/** Fields to include in the response. */
|
|
17895
|
-
fields?: SingleEntityOpsRequestedFields[];
|
|
17896
|
-
}
|
|
17897
17890
|
declare enum SingleEntityOpsRequestedFields {
|
|
17898
17891
|
UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
|
|
17899
17892
|
URL = "URL",
|
|
@@ -17917,67 +17910,250 @@ declare enum SingleEntityOpsRequestedFields {
|
|
|
17917
17910
|
THUMBNAIL = "THUMBNAIL",
|
|
17918
17911
|
DIRECT_CATEGORY_IDS = "DIRECT_CATEGORY_IDS"
|
|
17919
17912
|
}
|
|
17920
|
-
|
|
17921
|
-
|
|
17922
|
-
|
|
17913
|
+
declare enum RequestedFields$2 {
|
|
17914
|
+
UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
|
|
17915
|
+
URL = "URL",
|
|
17916
|
+
CURRENCY = "CURRENCY",
|
|
17917
|
+
INFO_SECTION = "INFO_SECTION",
|
|
17918
|
+
/** You can request merchant data only if you have `WIX_STORES.PRODUCT_MERCHANT_DATA_READ` permission. */
|
|
17919
|
+
MERCHANT_DATA = "MERCHANT_DATA",
|
|
17920
|
+
PLAIN_DESCRIPTION = "PLAIN_DESCRIPTION",
|
|
17921
|
+
INFO_SECTION_PLAIN_DESCRIPTION = "INFO_SECTION_PLAIN_DESCRIPTION",
|
|
17922
|
+
SUBSCRIPTION_PRICES_INFO = "SUBSCRIPTION_PRICES_INFO",
|
|
17923
|
+
VARIANTS_INFO = "VARIANTS_INFO",
|
|
17924
|
+
BREADCRUMBS_INFO = "BREADCRUMBS_INFO",
|
|
17925
|
+
WEIGHT_MEASUREMENT_UNIT_INFO = "WEIGHT_MEASUREMENT_UNIT_INFO",
|
|
17926
|
+
VARIANT_OPTION_CHOICE_NAMES = "VARIANT_OPTION_CHOICE_NAMES",
|
|
17927
|
+
MEDIA_ITEMS_INFO = "MEDIA_ITEMS_INFO",
|
|
17928
|
+
DESCRIPTION = "DESCRIPTION",
|
|
17929
|
+
DIRECT_CATEGORIES_INFO = "DIRECT_CATEGORIES_INFO",
|
|
17930
|
+
ALL_CATEGORIES_INFO = "ALL_CATEGORIES_INFO",
|
|
17931
|
+
MIN_VARIANT_PRICE_INFO = "MIN_VARIANT_PRICE_INFO",
|
|
17932
|
+
INFO_SECTION_DESCRIPTION = "INFO_SECTION_DESCRIPTION",
|
|
17933
|
+
THUMBNAIL = "THUMBNAIL",
|
|
17934
|
+
DIRECT_CATEGORY_IDS = "DIRECT_CATEGORY_IDS"
|
|
17923
17935
|
}
|
|
17924
|
-
interface
|
|
17925
|
-
/**
|
|
17926
|
-
|
|
17927
|
-
|
|
17928
|
-
|
|
17929
|
-
|
|
17930
|
-
|
|
17931
|
-
|
|
17936
|
+
interface ApplicationError$2 {
|
|
17937
|
+
/** Error code. */
|
|
17938
|
+
code?: string;
|
|
17939
|
+
/** Description of the error. */
|
|
17940
|
+
description?: string;
|
|
17941
|
+
/** Data related to the error. */
|
|
17942
|
+
data?: Record<string, any> | null;
|
|
17943
|
+
}
|
|
17944
|
+
/** Inventory Item. */
|
|
17945
|
+
interface InventoryItem extends InventoryItemTrackingMethodOneOf {
|
|
17932
17946
|
/**
|
|
17933
|
-
*
|
|
17947
|
+
* Tracking method - in stock.
|
|
17934
17948
|
*
|
|
17935
|
-
*
|
|
17949
|
+
* When set to `true`, the item is available for sale without a quantity limit.
|
|
17936
17950
|
*/
|
|
17937
|
-
|
|
17938
|
-
/** Fields to include in the response. */
|
|
17939
|
-
fields?: SingleEntityOpsRequestedFields[];
|
|
17940
|
-
}
|
|
17941
|
-
interface ProductWithInventory extends ProductWithInventoryTypedPropertiesOneOf {
|
|
17951
|
+
inStock?: boolean;
|
|
17942
17952
|
/**
|
|
17943
|
-
*
|
|
17953
|
+
* Tracking method - quantity left in inventory.
|
|
17944
17954
|
*
|
|
17945
|
-
*
|
|
17955
|
+
* Quantity can be negative when decrementing inventory for an order that has already been paid.
|
|
17946
17956
|
*/
|
|
17947
|
-
|
|
17957
|
+
quantity?: number;
|
|
17948
17958
|
/**
|
|
17949
|
-
*
|
|
17959
|
+
* Inventory item ID.
|
|
17950
17960
|
* @readonly
|
|
17951
17961
|
*/
|
|
17952
17962
|
_id?: string | null;
|
|
17953
17963
|
/**
|
|
17954
|
-
* Revision number, which increments by 1 each time the
|
|
17964
|
+
* Revision number, which increments by 1 each time the inventory item is updated.
|
|
17955
17965
|
* To prevent conflicting changes,
|
|
17956
|
-
* the current revision must be passed when updating the
|
|
17966
|
+
* the current revision must be passed when updating the inventory item.
|
|
17957
17967
|
*
|
|
17958
|
-
* Ignored when creating
|
|
17968
|
+
* Ignored when creating an inventory item.
|
|
17959
17969
|
* @readonly
|
|
17960
17970
|
*/
|
|
17961
17971
|
revision?: string | null;
|
|
17962
|
-
/** Product name. */
|
|
17963
|
-
name?: string | null;
|
|
17964
17972
|
/**
|
|
17965
|
-
*
|
|
17966
|
-
*
|
|
17967
|
-
* If not provided, the slug is autogenerated based on the product name.
|
|
17973
|
+
* Date and time the inventory item was created.
|
|
17974
|
+
* @readonly
|
|
17968
17975
|
*/
|
|
17969
|
-
|
|
17976
|
+
_createdDate?: Date | null;
|
|
17970
17977
|
/**
|
|
17971
|
-
*
|
|
17972
|
-
*
|
|
17973
|
-
* + When provided on create/update, this string must be a valid HTML. It will then be converted to rich content.
|
|
17974
|
-
* + `plainDescription` is ignored when value is also passed to the `description` field.
|
|
17975
|
-
* > **Note:** Returned only when you pass `"PLAIN_DESCRIPTION"` to the `fields` array in Products API requests.
|
|
17978
|
+
* Date and time the inventory item was created.
|
|
17979
|
+
* @readonly
|
|
17976
17980
|
*/
|
|
17977
|
-
|
|
17981
|
+
_updatedDate?: Date | null;
|
|
17982
|
+
/** Variant ID. */
|
|
17983
|
+
variantId?: string;
|
|
17984
|
+
/** Stores location ID. */
|
|
17985
|
+
locationId?: string | null;
|
|
17986
|
+
/** Product ID. */
|
|
17987
|
+
productId?: string;
|
|
17978
17988
|
/**
|
|
17979
|
-
* Whether the
|
|
17980
|
-
*
|
|
17989
|
+
* Whether the quantity is being tracked.
|
|
17990
|
+
* @readonly
|
|
17991
|
+
*/
|
|
17992
|
+
trackQuantity?: boolean;
|
|
17993
|
+
/**
|
|
17994
|
+
* Inventory item availability status.
|
|
17995
|
+
*
|
|
17996
|
+
* Supported values:
|
|
17997
|
+
* + OUT_OF_STOCK: Product is out of stock.
|
|
17998
|
+
* + IN_STOCK: Product is in stock. See `quantity` field for exact amount in stock.
|
|
17999
|
+
* + PREORDER: Product is only available for preorder. See `preorderInfo` field for more info.
|
|
18000
|
+
* @readonly
|
|
18001
|
+
*/
|
|
18002
|
+
availabilityStatus?: AvailabilityStatus;
|
|
18003
|
+
/** Item preorder info. */
|
|
18004
|
+
preorderInfo?: PreorderInfo$2;
|
|
18005
|
+
/**
|
|
18006
|
+
* Product.
|
|
18007
|
+
* @readonly
|
|
18008
|
+
*/
|
|
18009
|
+
product?: Product;
|
|
18010
|
+
/**
|
|
18011
|
+
* Custom field data for the inventory item object.
|
|
18012
|
+
*
|
|
18013
|
+
* [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the app dashboard before they can be accessed with API calls.
|
|
18014
|
+
*/
|
|
18015
|
+
extendedFields?: ExtendedFields;
|
|
18016
|
+
}
|
|
18017
|
+
/** @oneof */
|
|
18018
|
+
interface InventoryItemTrackingMethodOneOf {
|
|
18019
|
+
/**
|
|
18020
|
+
* Tracking method - in stock.
|
|
18021
|
+
*
|
|
18022
|
+
* When set to `true`, the item is available for sale without a quantity limit.
|
|
18023
|
+
*/
|
|
18024
|
+
inStock?: boolean;
|
|
18025
|
+
/**
|
|
18026
|
+
* Tracking method - quantity left in inventory.
|
|
18027
|
+
*
|
|
18028
|
+
* Quantity can be negative when decrementing inventory for an order that has already been paid.
|
|
18029
|
+
*/
|
|
18030
|
+
quantity?: number;
|
|
18031
|
+
}
|
|
18032
|
+
declare enum AvailabilityStatus {
|
|
18033
|
+
UNKNOWN_AVAILABILITY_STATUS = "UNKNOWN_AVAILABILITY_STATUS",
|
|
18034
|
+
OUT_OF_STOCK = "OUT_OF_STOCK",
|
|
18035
|
+
IN_STOCK = "IN_STOCK",
|
|
18036
|
+
/**
|
|
18037
|
+
* Whether the variant is available for preorder. InventoryItem will be available only when all below conditions are met:
|
|
18038
|
+
* 1. the variant is out of stock
|
|
18039
|
+
* 2. preorder is enabled on inventory item level (preorder_setting.enabled is true)
|
|
18040
|
+
* 3. preorder limit wasn't reached (preorder_setting.limit)
|
|
18041
|
+
*/
|
|
18042
|
+
PREORDER = "PREORDER"
|
|
18043
|
+
}
|
|
18044
|
+
interface PreorderInfo$2 {
|
|
18045
|
+
/**
|
|
18046
|
+
* Whether preorder is enabled for the product.
|
|
18047
|
+
*
|
|
18048
|
+
* Default: `false`
|
|
18049
|
+
*/
|
|
18050
|
+
enabled?: boolean | null;
|
|
18051
|
+
/** A message the customer will see when the item is out of stock and preorder is enabled. */
|
|
18052
|
+
message?: string | null;
|
|
18053
|
+
/**
|
|
18054
|
+
* Number of products that can be preordered after stock reaches zero.
|
|
18055
|
+
* Supported only for inventory items with `trackQuantity = true`.
|
|
18056
|
+
*
|
|
18057
|
+
* Default: `100000`
|
|
18058
|
+
*/
|
|
18059
|
+
limit?: number | null;
|
|
18060
|
+
/**
|
|
18061
|
+
* Number of times the product was preordered.
|
|
18062
|
+
*
|
|
18063
|
+
* Supported only for inventory items with `trackQuantity = true`.
|
|
18064
|
+
* @readonly
|
|
18065
|
+
*/
|
|
18066
|
+
counter?: number | null;
|
|
18067
|
+
/**
|
|
18068
|
+
* Quantity of products that can be preordered.
|
|
18069
|
+
*
|
|
18070
|
+
* Supported only for inventory items with `trackQuantity = true`.
|
|
18071
|
+
* @readonly
|
|
18072
|
+
*/
|
|
18073
|
+
quantity?: number | null;
|
|
18074
|
+
}
|
|
18075
|
+
interface Product {
|
|
18076
|
+
/** Product name. */
|
|
18077
|
+
name?: string | null;
|
|
18078
|
+
/** List of category IDs that this product is included in directly. */
|
|
18079
|
+
directCategoryIds?: string[];
|
|
18080
|
+
/** Variant name. */
|
|
18081
|
+
variantName?: string | null;
|
|
18082
|
+
/** Variant SKU (stock keeping unit). */
|
|
18083
|
+
variantSku?: string | null;
|
|
18084
|
+
}
|
|
18085
|
+
interface CreateProductRequest {
|
|
18086
|
+
/**
|
|
18087
|
+
* Product to create.
|
|
18088
|
+
*
|
|
18089
|
+
* At least 1 variant must be provided and each variant must have relevant item in `choices` field for every item in `options`.
|
|
18090
|
+
* If `options` is empty one default variant must be provided with empty `choices` list.
|
|
18091
|
+
*/
|
|
18092
|
+
product: V3Product;
|
|
18093
|
+
/** Fields to include in the response. */
|
|
18094
|
+
fields?: SingleEntityOpsRequestedFields[];
|
|
18095
|
+
}
|
|
18096
|
+
interface CreateProductResponse {
|
|
18097
|
+
/** Created product. */
|
|
18098
|
+
product?: V3Product;
|
|
18099
|
+
}
|
|
18100
|
+
interface CreateProductWithInventoryRequest {
|
|
18101
|
+
/**
|
|
18102
|
+
* Product to create with inventory.
|
|
18103
|
+
*
|
|
18104
|
+
* At least one variant must be provided and each variant must have relevant item in `choices` field for every item in `options`.
|
|
18105
|
+
* If `options` is empty one default variant must be provided with empty `choices` list.
|
|
18106
|
+
*/
|
|
18107
|
+
product: ProductWithInventory;
|
|
18108
|
+
/**
|
|
18109
|
+
* Whether to return inventory entities in the response.
|
|
18110
|
+
*
|
|
18111
|
+
* Default: `false`
|
|
18112
|
+
*/
|
|
18113
|
+
returnEntity?: boolean;
|
|
18114
|
+
/** Fields to include in the response. */
|
|
18115
|
+
fields?: SingleEntityOpsRequestedFields[];
|
|
18116
|
+
}
|
|
18117
|
+
interface ProductWithInventory extends ProductWithInventoryTypedPropertiesOneOf {
|
|
18118
|
+
/**
|
|
18119
|
+
* Physical properties.
|
|
18120
|
+
*
|
|
18121
|
+
* Required when `productType: PHYSICAL`.
|
|
18122
|
+
*/
|
|
18123
|
+
physicalProperties?: PhysicalProperties;
|
|
18124
|
+
/**
|
|
18125
|
+
* Product ID.
|
|
18126
|
+
* @readonly
|
|
18127
|
+
*/
|
|
18128
|
+
_id?: string | null;
|
|
18129
|
+
/**
|
|
18130
|
+
* Revision number, which increments by 1 each time the product is updated.
|
|
18131
|
+
* To prevent conflicting changes,
|
|
18132
|
+
* the current revision must be passed when updating the product.
|
|
18133
|
+
*
|
|
18134
|
+
* Ignored when creating a product with inventory.
|
|
18135
|
+
* @readonly
|
|
18136
|
+
*/
|
|
18137
|
+
revision?: string | null;
|
|
18138
|
+
/** Product name. */
|
|
18139
|
+
name?: string | null;
|
|
18140
|
+
/**
|
|
18141
|
+
* Product slug.
|
|
18142
|
+
*
|
|
18143
|
+
* If not provided, the slug is autogenerated based on the product name.
|
|
18144
|
+
*/
|
|
18145
|
+
slug?: string | null;
|
|
18146
|
+
/**
|
|
18147
|
+
* Product description in HTML.
|
|
18148
|
+
*
|
|
18149
|
+
* + When provided on create/update, this string must be a valid HTML. It will then be converted to rich content.
|
|
18150
|
+
* + `plainDescription` is ignored when value is also passed to the `description` field.
|
|
18151
|
+
* > **Note:** Returned only when you pass `"PLAIN_DESCRIPTION"` to the `fields` array in Products API requests.
|
|
18152
|
+
*/
|
|
18153
|
+
plainDescription?: string | null;
|
|
18154
|
+
/**
|
|
18155
|
+
* Whether the product is visible to site visitors on the site.
|
|
18156
|
+
*
|
|
17981
18157
|
* Default: `true`
|
|
17982
18158
|
*/
|
|
17983
18159
|
visible?: boolean | null;
|
|
@@ -18153,37 +18329,6 @@ interface InventoryItemCompositeTrackingMethodOneOf {
|
|
|
18153
18329
|
*/
|
|
18154
18330
|
quantity?: number;
|
|
18155
18331
|
}
|
|
18156
|
-
interface PreorderInfo$2 {
|
|
18157
|
-
/**
|
|
18158
|
-
* Whether preorder is enabled for the product.
|
|
18159
|
-
*
|
|
18160
|
-
* Default: `false`
|
|
18161
|
-
*/
|
|
18162
|
-
enabled?: boolean | null;
|
|
18163
|
-
/** A message the customer will see when the item is out of stock and preorder is enabled. */
|
|
18164
|
-
message?: string | null;
|
|
18165
|
-
/**
|
|
18166
|
-
* Number of products that can be preordered after stock reaches zero.
|
|
18167
|
-
* Supported only for inventory items with `trackQuantity = true`.
|
|
18168
|
-
*
|
|
18169
|
-
* Default: `100000`
|
|
18170
|
-
*/
|
|
18171
|
-
limit?: number | null;
|
|
18172
|
-
/**
|
|
18173
|
-
* Number of times the product was preordered.
|
|
18174
|
-
*
|
|
18175
|
-
* Supported only for inventory items with `trackQuantity = true`.
|
|
18176
|
-
* @readonly
|
|
18177
|
-
*/
|
|
18178
|
-
counter?: number | null;
|
|
18179
|
-
/**
|
|
18180
|
-
* Quantity of products that can be preordered.
|
|
18181
|
-
*
|
|
18182
|
-
* Supported only for inventory items with `trackQuantity = true`.
|
|
18183
|
-
* @readonly
|
|
18184
|
-
*/
|
|
18185
|
-
quantity?: number | null;
|
|
18186
|
-
}
|
|
18187
18332
|
interface OptionChoiceReferences {
|
|
18188
18333
|
/** Option and choice IDs. */
|
|
18189
18334
|
optionChoiceIds?: V3OptionChoiceIds;
|
|
@@ -18238,124 +18383,6 @@ interface CommonItemMetadata {
|
|
|
18238
18383
|
/** Details about the error in case of failure. */
|
|
18239
18384
|
error?: ApplicationError$2;
|
|
18240
18385
|
}
|
|
18241
|
-
interface ApplicationError$2 {
|
|
18242
|
-
/** Error code. */
|
|
18243
|
-
code?: string;
|
|
18244
|
-
/** Description of the error. */
|
|
18245
|
-
description?: string;
|
|
18246
|
-
/** Data related to the error. */
|
|
18247
|
-
data?: Record<string, any> | null;
|
|
18248
|
-
}
|
|
18249
|
-
/** Inventory Item. */
|
|
18250
|
-
interface InventoryItem extends InventoryItemTrackingMethodOneOf {
|
|
18251
|
-
/**
|
|
18252
|
-
* Tracking method - in stock.
|
|
18253
|
-
*
|
|
18254
|
-
* When set to `true`, the item is available for sale without a quantity limit.
|
|
18255
|
-
*/
|
|
18256
|
-
inStock?: boolean;
|
|
18257
|
-
/**
|
|
18258
|
-
* Tracking method - quantity left in inventory.
|
|
18259
|
-
*
|
|
18260
|
-
* Quantity can be negative when decrementing inventory for an order that has already been paid.
|
|
18261
|
-
*/
|
|
18262
|
-
quantity?: number;
|
|
18263
|
-
/**
|
|
18264
|
-
* Inventory item ID.
|
|
18265
|
-
* @readonly
|
|
18266
|
-
*/
|
|
18267
|
-
_id?: string | null;
|
|
18268
|
-
/**
|
|
18269
|
-
* Revision number, which increments by 1 each time the inventory item is updated.
|
|
18270
|
-
* To prevent conflicting changes,
|
|
18271
|
-
* the current revision must be passed when updating the inventory item.
|
|
18272
|
-
*
|
|
18273
|
-
* Ignored when creating an inventory item.
|
|
18274
|
-
* @readonly
|
|
18275
|
-
*/
|
|
18276
|
-
revision?: string | null;
|
|
18277
|
-
/**
|
|
18278
|
-
* Date and time the inventory item was created.
|
|
18279
|
-
* @readonly
|
|
18280
|
-
*/
|
|
18281
|
-
_createdDate?: Date | null;
|
|
18282
|
-
/**
|
|
18283
|
-
* Date and time the inventory item was created.
|
|
18284
|
-
* @readonly
|
|
18285
|
-
*/
|
|
18286
|
-
_updatedDate?: Date | null;
|
|
18287
|
-
/** Variant ID. */
|
|
18288
|
-
variantId?: string;
|
|
18289
|
-
/** Stores location ID. */
|
|
18290
|
-
locationId?: string | null;
|
|
18291
|
-
/** Product ID. */
|
|
18292
|
-
productId?: string;
|
|
18293
|
-
/**
|
|
18294
|
-
* Whether the quantity is being tracked.
|
|
18295
|
-
* @readonly
|
|
18296
|
-
*/
|
|
18297
|
-
trackQuantity?: boolean;
|
|
18298
|
-
/**
|
|
18299
|
-
* Inventory item availability status.
|
|
18300
|
-
*
|
|
18301
|
-
* Supported values:
|
|
18302
|
-
* + OUT_OF_STOCK: Product is out of stock.
|
|
18303
|
-
* + IN_STOCK: Product is in stock. See `quantity` field for exact amount in stock.
|
|
18304
|
-
* + PREORDER: Product is only available for preorder. See `preorderInfo` field for more info.
|
|
18305
|
-
* @readonly
|
|
18306
|
-
*/
|
|
18307
|
-
availabilityStatus?: AvailabilityStatus;
|
|
18308
|
-
/** Item preorder info. */
|
|
18309
|
-
preorderInfo?: PreorderInfo$2;
|
|
18310
|
-
/**
|
|
18311
|
-
* Product.
|
|
18312
|
-
* @readonly
|
|
18313
|
-
*/
|
|
18314
|
-
product?: Product;
|
|
18315
|
-
/**
|
|
18316
|
-
* Custom field data for the inventory item object.
|
|
18317
|
-
*
|
|
18318
|
-
* [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the app dashboard before they can be accessed with API calls.
|
|
18319
|
-
*/
|
|
18320
|
-
extendedFields?: ExtendedFields;
|
|
18321
|
-
}
|
|
18322
|
-
/** @oneof */
|
|
18323
|
-
interface InventoryItemTrackingMethodOneOf {
|
|
18324
|
-
/**
|
|
18325
|
-
* Tracking method - in stock.
|
|
18326
|
-
*
|
|
18327
|
-
* When set to `true`, the item is available for sale without a quantity limit.
|
|
18328
|
-
*/
|
|
18329
|
-
inStock?: boolean;
|
|
18330
|
-
/**
|
|
18331
|
-
* Tracking method - quantity left in inventory.
|
|
18332
|
-
*
|
|
18333
|
-
* Quantity can be negative when decrementing inventory for an order that has already been paid.
|
|
18334
|
-
*/
|
|
18335
|
-
quantity?: number;
|
|
18336
|
-
}
|
|
18337
|
-
declare enum AvailabilityStatus {
|
|
18338
|
-
UNKNOWN_AVAILABILITY_STATUS = "UNKNOWN_AVAILABILITY_STATUS",
|
|
18339
|
-
OUT_OF_STOCK = "OUT_OF_STOCK",
|
|
18340
|
-
IN_STOCK = "IN_STOCK",
|
|
18341
|
-
/**
|
|
18342
|
-
* Whether the variant is available for preorder. InventoryItem will be available only when all below conditions are met:
|
|
18343
|
-
* 1. the variant is out of stock
|
|
18344
|
-
* 2. preorder is enabled on inventory item level (preorder_setting.enabled is true)
|
|
18345
|
-
* 3. preorder limit wasn't reached (preorder_setting.limit)
|
|
18346
|
-
*/
|
|
18347
|
-
PREORDER = "PREORDER"
|
|
18348
|
-
}
|
|
18349
|
-
interface Product {
|
|
18350
|
-
/** Product name. */
|
|
18351
|
-
name?: string | null;
|
|
18352
|
-
/** List of category IDs that this product is included in directly. */
|
|
18353
|
-
directCategoryIds?: string[];
|
|
18354
|
-
/** Variant name. */
|
|
18355
|
-
variantName?: string | null;
|
|
18356
|
-
/** Variant SKU (stock keeping unit). */
|
|
18357
|
-
variantSku?: string | null;
|
|
18358
|
-
}
|
|
18359
18386
|
interface CommonBulkActionMetadata {
|
|
18360
18387
|
/** Number of items that were successfully processed. */
|
|
18361
18388
|
totalSuccesses?: number;
|
|
@@ -18404,29 +18431,6 @@ interface BulkCreateProductsRequest {
|
|
|
18404
18431
|
/** Fields to include in the response. */
|
|
18405
18432
|
fields?: RequestedFields$2[];
|
|
18406
18433
|
}
|
|
18407
|
-
declare enum RequestedFields$2 {
|
|
18408
|
-
UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
|
|
18409
|
-
URL = "URL",
|
|
18410
|
-
CURRENCY = "CURRENCY",
|
|
18411
|
-
INFO_SECTION = "INFO_SECTION",
|
|
18412
|
-
/** You can request merchant data only if you have `WIX_STORES.PRODUCT_MERCHANT_DATA_READ` permission. */
|
|
18413
|
-
MERCHANT_DATA = "MERCHANT_DATA",
|
|
18414
|
-
PLAIN_DESCRIPTION = "PLAIN_DESCRIPTION",
|
|
18415
|
-
INFO_SECTION_PLAIN_DESCRIPTION = "INFO_SECTION_PLAIN_DESCRIPTION",
|
|
18416
|
-
SUBSCRIPTION_PRICES_INFO = "SUBSCRIPTION_PRICES_INFO",
|
|
18417
|
-
VARIANTS_INFO = "VARIANTS_INFO",
|
|
18418
|
-
BREADCRUMBS_INFO = "BREADCRUMBS_INFO",
|
|
18419
|
-
WEIGHT_MEASUREMENT_UNIT_INFO = "WEIGHT_MEASUREMENT_UNIT_INFO",
|
|
18420
|
-
VARIANT_OPTION_CHOICE_NAMES = "VARIANT_OPTION_CHOICE_NAMES",
|
|
18421
|
-
MEDIA_ITEMS_INFO = "MEDIA_ITEMS_INFO",
|
|
18422
|
-
DESCRIPTION = "DESCRIPTION",
|
|
18423
|
-
DIRECT_CATEGORIES_INFO = "DIRECT_CATEGORIES_INFO",
|
|
18424
|
-
ALL_CATEGORIES_INFO = "ALL_CATEGORIES_INFO",
|
|
18425
|
-
MIN_VARIANT_PRICE_INFO = "MIN_VARIANT_PRICE_INFO",
|
|
18426
|
-
INFO_SECTION_DESCRIPTION = "INFO_SECTION_DESCRIPTION",
|
|
18427
|
-
THUMBNAIL = "THUMBNAIL",
|
|
18428
|
-
DIRECT_CATEGORY_IDS = "DIRECT_CATEGORY_IDS"
|
|
18429
|
-
}
|
|
18430
18434
|
interface BulkCreateProductsResponse {
|
|
18431
18435
|
/** Products created by bulk action. */
|
|
18432
18436
|
results?: CatalogV3BulkProductResult[];
|
|
@@ -21207,55 +21211,23 @@ declare enum DiscountType$1 {
|
|
|
21207
21211
|
AMOUNT = "AMOUNT",
|
|
21208
21212
|
PERCENT = "PERCENT"
|
|
21209
21213
|
}
|
|
21210
|
-
interface
|
|
21211
|
-
/** Subscription option
|
|
21212
|
-
subscriptionOption: SubscriptionOption$1;
|
|
21213
|
-
}
|
|
21214
|
-
interface CreateSubscriptionOptionResponse$1 {
|
|
21215
|
-
/** Newly created subscription option. */
|
|
21216
|
-
subscriptionOption?: SubscriptionOption$1;
|
|
21217
|
-
}
|
|
21218
|
-
interface UpdateSubscriptionOptionRequest$1 {
|
|
21219
|
-
/** Subscription option info. Only the passed parameters will be updated. */
|
|
21220
|
-
subscriptionOption: SubscriptionOption$1;
|
|
21221
|
-
}
|
|
21222
|
-
interface UpdateSubscriptionOptionResponse$1 {
|
|
21223
|
-
/** Updated subscription option. */
|
|
21224
|
-
subscriptionOption?: SubscriptionOption$1;
|
|
21225
|
-
}
|
|
21226
|
-
interface DeleteSubscriptionOptionRequest$1 {
|
|
21227
|
-
/** ID of the subscription option to delete. */
|
|
21214
|
+
interface GetSubscriptionOptionRequest$1 {
|
|
21215
|
+
/** Subscription option ID. */
|
|
21228
21216
|
id: string;
|
|
21229
21217
|
}
|
|
21230
|
-
interface
|
|
21231
|
-
|
|
21232
|
-
|
|
21233
|
-
/** Subscription options info. */
|
|
21234
|
-
subscriptionOptions: SubscriptionOption$1[];
|
|
21235
|
-
}
|
|
21236
|
-
interface BulkCreateSubscriptionOptionsResponse$1 {
|
|
21237
|
-
/** Newly created subscription options. */
|
|
21238
|
-
subscriptionOptions?: SubscriptionOption$1[];
|
|
21239
|
-
}
|
|
21240
|
-
interface BulkUpdateSubscriptionOptionsRequest$1 {
|
|
21241
|
-
/** Subscription options info. Only the passed parameters in each subscription option will be updated. */
|
|
21242
|
-
subscriptionOptions: SubscriptionOption$1[];
|
|
21243
|
-
}
|
|
21244
|
-
interface BulkUpdateSubscriptionOptionsResponse$1 {
|
|
21245
|
-
/** Updated subscription options. */
|
|
21246
|
-
subscriptionOptions?: SubscriptionOption$1[];
|
|
21247
|
-
}
|
|
21248
|
-
interface BulkDeleteSubscriptionOptionsRequest$1 {
|
|
21249
|
-
/** IDs of the subscription options to delete. */
|
|
21250
|
-
ids: string[];
|
|
21251
|
-
}
|
|
21252
|
-
interface BulkDeleteSubscriptionOptionsResponse$1 {
|
|
21218
|
+
interface GetSubscriptionOptionResponse$1 {
|
|
21219
|
+
/** Subscription option. */
|
|
21220
|
+
subscriptionOption?: SubscriptionOption$1;
|
|
21253
21221
|
}
|
|
21254
|
-
interface
|
|
21222
|
+
interface GetSubscriptionOptionsForProductRequest$1 {
|
|
21255
21223
|
/** Product ID. */
|
|
21256
21224
|
productId: string;
|
|
21257
|
-
/**
|
|
21258
|
-
|
|
21225
|
+
/** Whether to include hidden subscription options in the results. */
|
|
21226
|
+
includeHiddenSubscriptionOptions?: boolean;
|
|
21227
|
+
}
|
|
21228
|
+
interface GetSubscriptionOptionsForProductResponse$1 {
|
|
21229
|
+
/** Subscription options. */
|
|
21230
|
+
subscriptionOptions?: SubscriptionOptionInProduct$1[];
|
|
21259
21231
|
}
|
|
21260
21232
|
interface SubscriptionOptionInProduct$1 {
|
|
21261
21233
|
/** Subscription option ID. */
|
|
@@ -21283,34 +21255,6 @@ interface SubscriptionOptionInProduct$1 {
|
|
|
21283
21255
|
*/
|
|
21284
21256
|
discount?: Discount$1;
|
|
21285
21257
|
}
|
|
21286
|
-
interface AssignSubscriptionOptionsToProductResponse$1 {
|
|
21287
|
-
}
|
|
21288
|
-
interface AllowOneTimePurchasesRequest$1 {
|
|
21289
|
-
/** Product ID. */
|
|
21290
|
-
productId: string;
|
|
21291
|
-
/** Pass `true` to offer product by subscription and as one-time purchase. Pass `false` to offer product as subscription only. */
|
|
21292
|
-
allowed: boolean | null;
|
|
21293
|
-
}
|
|
21294
|
-
interface AllowOneTimePurchasesResponse$1 {
|
|
21295
|
-
}
|
|
21296
|
-
interface GetSubscriptionOptionRequest$1 {
|
|
21297
|
-
/** Subscription option ID. */
|
|
21298
|
-
id: string;
|
|
21299
|
-
}
|
|
21300
|
-
interface GetSubscriptionOptionResponse$1 {
|
|
21301
|
-
/** Subscription option. */
|
|
21302
|
-
subscriptionOption?: SubscriptionOption$1;
|
|
21303
|
-
}
|
|
21304
|
-
interface GetSubscriptionOptionsForProductRequest$1 {
|
|
21305
|
-
/** Product ID. */
|
|
21306
|
-
productId: string;
|
|
21307
|
-
/** Whether to include hidden subscription options in the results. */
|
|
21308
|
-
includeHiddenSubscriptionOptions?: boolean;
|
|
21309
|
-
}
|
|
21310
|
-
interface GetSubscriptionOptionsForProductResponse$1 {
|
|
21311
|
-
/** Subscription options. */
|
|
21312
|
-
subscriptionOptions?: SubscriptionOptionInProduct$1[];
|
|
21313
|
-
}
|
|
21314
21258
|
interface GetProductIdsForSubscriptionOptionRequest$1 {
|
|
21315
21259
|
/** Subscription option ID. */
|
|
21316
21260
|
id: string;
|
|
@@ -21343,9 +21287,69 @@ interface GetOneTimePurchasesStatusRequest$1 {
|
|
|
21343
21287
|
/** Product ID. */
|
|
21344
21288
|
productId: string;
|
|
21345
21289
|
}
|
|
21346
|
-
interface GetOneTimePurchasesStatusResponse$1 {
|
|
21347
|
-
/** Whether the specified product is available for one-time purchase */
|
|
21348
|
-
allowed?: boolean;
|
|
21290
|
+
interface GetOneTimePurchasesStatusResponse$1 {
|
|
21291
|
+
/** Whether the specified product is available for one-time purchase */
|
|
21292
|
+
allowed?: boolean;
|
|
21293
|
+
}
|
|
21294
|
+
interface CreateSubscriptionOptionRequest$1 {
|
|
21295
|
+
/** Subscription option info. */
|
|
21296
|
+
subscriptionOption: SubscriptionOption$1;
|
|
21297
|
+
}
|
|
21298
|
+
interface CreateSubscriptionOptionResponse$1 {
|
|
21299
|
+
/** Newly created subscription option. */
|
|
21300
|
+
subscriptionOption?: SubscriptionOption$1;
|
|
21301
|
+
}
|
|
21302
|
+
interface UpdateSubscriptionOptionRequest$1 {
|
|
21303
|
+
/** Subscription option info. Only the passed parameters will be updated. */
|
|
21304
|
+
subscriptionOption: SubscriptionOption$1;
|
|
21305
|
+
}
|
|
21306
|
+
interface UpdateSubscriptionOptionResponse$1 {
|
|
21307
|
+
/** Updated subscription option. */
|
|
21308
|
+
subscriptionOption?: SubscriptionOption$1;
|
|
21309
|
+
}
|
|
21310
|
+
interface DeleteSubscriptionOptionRequest$1 {
|
|
21311
|
+
/** ID of the subscription option to delete. */
|
|
21312
|
+
id: string;
|
|
21313
|
+
}
|
|
21314
|
+
interface DeleteSubscriptionOptionResponse$1 {
|
|
21315
|
+
}
|
|
21316
|
+
interface BulkCreateSubscriptionOptionsRequest$1 {
|
|
21317
|
+
/** Subscription options info. */
|
|
21318
|
+
subscriptionOptions: SubscriptionOption$1[];
|
|
21319
|
+
}
|
|
21320
|
+
interface BulkCreateSubscriptionOptionsResponse$1 {
|
|
21321
|
+
/** Newly created subscription options. */
|
|
21322
|
+
subscriptionOptions?: SubscriptionOption$1[];
|
|
21323
|
+
}
|
|
21324
|
+
interface BulkUpdateSubscriptionOptionsRequest$1 {
|
|
21325
|
+
/** Subscription options info. Only the passed parameters in each subscription option will be updated. */
|
|
21326
|
+
subscriptionOptions: SubscriptionOption$1[];
|
|
21327
|
+
}
|
|
21328
|
+
interface BulkUpdateSubscriptionOptionsResponse$1 {
|
|
21329
|
+
/** Updated subscription options. */
|
|
21330
|
+
subscriptionOptions?: SubscriptionOption$1[];
|
|
21331
|
+
}
|
|
21332
|
+
interface BulkDeleteSubscriptionOptionsRequest$1 {
|
|
21333
|
+
/** IDs of the subscription options to delete. */
|
|
21334
|
+
ids: string[];
|
|
21335
|
+
}
|
|
21336
|
+
interface BulkDeleteSubscriptionOptionsResponse$1 {
|
|
21337
|
+
}
|
|
21338
|
+
interface AssignSubscriptionOptionsToProductRequest$1 {
|
|
21339
|
+
/** Product ID. */
|
|
21340
|
+
productId: string;
|
|
21341
|
+
/** Ordered array of subscription options that will be assigned to the product. Pass an empty array to remove all subscription options from the product. */
|
|
21342
|
+
assignedSubscriptionOptions?: SubscriptionOptionInProduct$1[];
|
|
21343
|
+
}
|
|
21344
|
+
interface AssignSubscriptionOptionsToProductResponse$1 {
|
|
21345
|
+
}
|
|
21346
|
+
interface AllowOneTimePurchasesRequest$1 {
|
|
21347
|
+
/** Product ID. */
|
|
21348
|
+
productId: string;
|
|
21349
|
+
/** Pass `true` to offer product by subscription and as one-time purchase. Pass `false` to offer product as subscription only. */
|
|
21350
|
+
allowed: boolean | null;
|
|
21351
|
+
}
|
|
21352
|
+
interface AllowOneTimePurchasesResponse$1 {
|
|
21349
21353
|
}
|
|
21350
21354
|
interface SubscriptionSettingsNonNullableFields$1 {
|
|
21351
21355
|
frequency: SubscriptionFrequency$1;
|
|
@@ -21359,18 +21363,6 @@ interface SubscriptionOptionNonNullableFields$1 {
|
|
|
21359
21363
|
subscriptionSettings?: SubscriptionSettingsNonNullableFields$1;
|
|
21360
21364
|
discount?: DiscountNonNullableFields$1;
|
|
21361
21365
|
}
|
|
21362
|
-
interface CreateSubscriptionOptionResponseNonNullableFields$1 {
|
|
21363
|
-
subscriptionOption?: SubscriptionOptionNonNullableFields$1;
|
|
21364
|
-
}
|
|
21365
|
-
interface UpdateSubscriptionOptionResponseNonNullableFields$1 {
|
|
21366
|
-
subscriptionOption?: SubscriptionOptionNonNullableFields$1;
|
|
21367
|
-
}
|
|
21368
|
-
interface BulkCreateSubscriptionOptionsResponseNonNullableFields$1 {
|
|
21369
|
-
subscriptionOptions: SubscriptionOptionNonNullableFields$1[];
|
|
21370
|
-
}
|
|
21371
|
-
interface BulkUpdateSubscriptionOptionsResponseNonNullableFields$1 {
|
|
21372
|
-
subscriptionOptions: SubscriptionOptionNonNullableFields$1[];
|
|
21373
|
-
}
|
|
21374
21366
|
interface GetSubscriptionOptionResponseNonNullableFields$1 {
|
|
21375
21367
|
subscriptionOption?: SubscriptionOptionNonNullableFields$1;
|
|
21376
21368
|
}
|
|
@@ -21395,6 +21387,18 @@ interface GetProductIdsForSubscriptionOptionResponseNonNullableFields$1 {
|
|
|
21395
21387
|
interface GetOneTimePurchasesStatusResponseNonNullableFields$1 {
|
|
21396
21388
|
allowed: boolean;
|
|
21397
21389
|
}
|
|
21390
|
+
interface CreateSubscriptionOptionResponseNonNullableFields$1 {
|
|
21391
|
+
subscriptionOption?: SubscriptionOptionNonNullableFields$1;
|
|
21392
|
+
}
|
|
21393
|
+
interface UpdateSubscriptionOptionResponseNonNullableFields$1 {
|
|
21394
|
+
subscriptionOption?: SubscriptionOptionNonNullableFields$1;
|
|
21395
|
+
}
|
|
21396
|
+
interface BulkCreateSubscriptionOptionsResponseNonNullableFields$1 {
|
|
21397
|
+
subscriptionOptions: SubscriptionOptionNonNullableFields$1[];
|
|
21398
|
+
}
|
|
21399
|
+
interface BulkUpdateSubscriptionOptionsResponseNonNullableFields$1 {
|
|
21400
|
+
subscriptionOptions: SubscriptionOptionNonNullableFields$1[];
|
|
21401
|
+
}
|
|
21398
21402
|
|
|
21399
21403
|
interface SubscriptionOption {
|
|
21400
21404
|
/** Subscription option ID (auto-generated upon subscription option creation). */
|
|
@@ -21439,55 +21443,23 @@ declare enum DiscountType {
|
|
|
21439
21443
|
AMOUNT = "AMOUNT",
|
|
21440
21444
|
PERCENT = "PERCENT"
|
|
21441
21445
|
}
|
|
21442
|
-
interface
|
|
21443
|
-
/** Subscription option
|
|
21444
|
-
subscriptionOption: SubscriptionOption;
|
|
21445
|
-
}
|
|
21446
|
-
interface CreateSubscriptionOptionResponse {
|
|
21447
|
-
/** Newly created subscription option. */
|
|
21448
|
-
subscriptionOption?: SubscriptionOption;
|
|
21449
|
-
}
|
|
21450
|
-
interface UpdateSubscriptionOptionRequest {
|
|
21451
|
-
/** Subscription option info. Only the passed parameters will be updated. */
|
|
21452
|
-
subscriptionOption: SubscriptionOption;
|
|
21453
|
-
}
|
|
21454
|
-
interface UpdateSubscriptionOptionResponse {
|
|
21455
|
-
/** Updated subscription option. */
|
|
21456
|
-
subscriptionOption?: SubscriptionOption;
|
|
21457
|
-
}
|
|
21458
|
-
interface DeleteSubscriptionOptionRequest {
|
|
21459
|
-
/** ID of the subscription option to delete. */
|
|
21446
|
+
interface GetSubscriptionOptionRequest {
|
|
21447
|
+
/** Subscription option ID. */
|
|
21460
21448
|
_id: string;
|
|
21461
21449
|
}
|
|
21462
|
-
interface
|
|
21463
|
-
|
|
21464
|
-
|
|
21465
|
-
/** Subscription options info. */
|
|
21466
|
-
subscriptionOptions: SubscriptionOption[];
|
|
21467
|
-
}
|
|
21468
|
-
interface BulkCreateSubscriptionOptionsResponse {
|
|
21469
|
-
/** Newly created subscription options. */
|
|
21470
|
-
subscriptionOptions?: SubscriptionOption[];
|
|
21471
|
-
}
|
|
21472
|
-
interface BulkUpdateSubscriptionOptionsRequest {
|
|
21473
|
-
/** Subscription options info. Only the passed parameters in each subscription option will be updated. */
|
|
21474
|
-
subscriptionOptions: SubscriptionOption[];
|
|
21475
|
-
}
|
|
21476
|
-
interface BulkUpdateSubscriptionOptionsResponse {
|
|
21477
|
-
/** Updated subscription options. */
|
|
21478
|
-
subscriptionOptions?: SubscriptionOption[];
|
|
21479
|
-
}
|
|
21480
|
-
interface BulkDeleteSubscriptionOptionsRequest {
|
|
21481
|
-
/** IDs of the subscription options to delete. */
|
|
21482
|
-
ids: string[];
|
|
21483
|
-
}
|
|
21484
|
-
interface BulkDeleteSubscriptionOptionsResponse {
|
|
21450
|
+
interface GetSubscriptionOptionResponse {
|
|
21451
|
+
/** Subscription option. */
|
|
21452
|
+
subscriptionOption?: SubscriptionOption;
|
|
21485
21453
|
}
|
|
21486
|
-
interface
|
|
21454
|
+
interface GetSubscriptionOptionsForProductRequest {
|
|
21487
21455
|
/** Product ID. */
|
|
21488
21456
|
productId: string;
|
|
21489
|
-
/**
|
|
21490
|
-
|
|
21457
|
+
/** Whether to include hidden subscription options in the results. */
|
|
21458
|
+
includeHiddenSubscriptionOptions?: boolean;
|
|
21459
|
+
}
|
|
21460
|
+
interface GetSubscriptionOptionsForProductResponse {
|
|
21461
|
+
/** Subscription options. */
|
|
21462
|
+
subscriptionOptions?: SubscriptionOptionInProduct[];
|
|
21491
21463
|
}
|
|
21492
21464
|
interface SubscriptionOptionInProduct {
|
|
21493
21465
|
/** Subscription option ID. */
|
|
@@ -21515,34 +21487,6 @@ interface SubscriptionOptionInProduct {
|
|
|
21515
21487
|
*/
|
|
21516
21488
|
discount?: Discount;
|
|
21517
21489
|
}
|
|
21518
|
-
interface AssignSubscriptionOptionsToProductResponse {
|
|
21519
|
-
}
|
|
21520
|
-
interface AllowOneTimePurchasesRequest {
|
|
21521
|
-
/** Product ID. */
|
|
21522
|
-
productId: string;
|
|
21523
|
-
/** Pass `true` to offer product by subscription and as one-time purchase. Pass `false` to offer product as subscription only. */
|
|
21524
|
-
allowed: boolean | null;
|
|
21525
|
-
}
|
|
21526
|
-
interface AllowOneTimePurchasesResponse {
|
|
21527
|
-
}
|
|
21528
|
-
interface GetSubscriptionOptionRequest {
|
|
21529
|
-
/** Subscription option ID. */
|
|
21530
|
-
_id: string;
|
|
21531
|
-
}
|
|
21532
|
-
interface GetSubscriptionOptionResponse {
|
|
21533
|
-
/** Subscription option. */
|
|
21534
|
-
subscriptionOption?: SubscriptionOption;
|
|
21535
|
-
}
|
|
21536
|
-
interface GetSubscriptionOptionsForProductRequest {
|
|
21537
|
-
/** Product ID. */
|
|
21538
|
-
productId: string;
|
|
21539
|
-
/** Whether to include hidden subscription options in the results. */
|
|
21540
|
-
includeHiddenSubscriptionOptions?: boolean;
|
|
21541
|
-
}
|
|
21542
|
-
interface GetSubscriptionOptionsForProductResponse {
|
|
21543
|
-
/** Subscription options. */
|
|
21544
|
-
subscriptionOptions?: SubscriptionOptionInProduct[];
|
|
21545
|
-
}
|
|
21546
21490
|
interface GetProductIdsForSubscriptionOptionRequest {
|
|
21547
21491
|
/** Subscription option ID. */
|
|
21548
21492
|
_id: string;
|
|
@@ -21579,6 +21523,66 @@ interface GetOneTimePurchasesStatusResponse {
|
|
|
21579
21523
|
/** Whether the specified product is available for one-time purchase */
|
|
21580
21524
|
allowed?: boolean;
|
|
21581
21525
|
}
|
|
21526
|
+
interface CreateSubscriptionOptionRequest {
|
|
21527
|
+
/** Subscription option info. */
|
|
21528
|
+
subscriptionOption: SubscriptionOption;
|
|
21529
|
+
}
|
|
21530
|
+
interface CreateSubscriptionOptionResponse {
|
|
21531
|
+
/** Newly created subscription option. */
|
|
21532
|
+
subscriptionOption?: SubscriptionOption;
|
|
21533
|
+
}
|
|
21534
|
+
interface UpdateSubscriptionOptionRequest {
|
|
21535
|
+
/** Subscription option info. Only the passed parameters will be updated. */
|
|
21536
|
+
subscriptionOption: SubscriptionOption;
|
|
21537
|
+
}
|
|
21538
|
+
interface UpdateSubscriptionOptionResponse {
|
|
21539
|
+
/** Updated subscription option. */
|
|
21540
|
+
subscriptionOption?: SubscriptionOption;
|
|
21541
|
+
}
|
|
21542
|
+
interface DeleteSubscriptionOptionRequest {
|
|
21543
|
+
/** ID of the subscription option to delete. */
|
|
21544
|
+
_id: string;
|
|
21545
|
+
}
|
|
21546
|
+
interface DeleteSubscriptionOptionResponse {
|
|
21547
|
+
}
|
|
21548
|
+
interface BulkCreateSubscriptionOptionsRequest {
|
|
21549
|
+
/** Subscription options info. */
|
|
21550
|
+
subscriptionOptions: SubscriptionOption[];
|
|
21551
|
+
}
|
|
21552
|
+
interface BulkCreateSubscriptionOptionsResponse {
|
|
21553
|
+
/** Newly created subscription options. */
|
|
21554
|
+
subscriptionOptions?: SubscriptionOption[];
|
|
21555
|
+
}
|
|
21556
|
+
interface BulkUpdateSubscriptionOptionsRequest {
|
|
21557
|
+
/** Subscription options info. Only the passed parameters in each subscription option will be updated. */
|
|
21558
|
+
subscriptionOptions: SubscriptionOption[];
|
|
21559
|
+
}
|
|
21560
|
+
interface BulkUpdateSubscriptionOptionsResponse {
|
|
21561
|
+
/** Updated subscription options. */
|
|
21562
|
+
subscriptionOptions?: SubscriptionOption[];
|
|
21563
|
+
}
|
|
21564
|
+
interface BulkDeleteSubscriptionOptionsRequest {
|
|
21565
|
+
/** IDs of the subscription options to delete. */
|
|
21566
|
+
ids: string[];
|
|
21567
|
+
}
|
|
21568
|
+
interface BulkDeleteSubscriptionOptionsResponse {
|
|
21569
|
+
}
|
|
21570
|
+
interface AssignSubscriptionOptionsToProductRequest {
|
|
21571
|
+
/** Product ID. */
|
|
21572
|
+
productId: string;
|
|
21573
|
+
/** Ordered array of subscription options that will be assigned to the product. Pass an empty array to remove all subscription options from the product. */
|
|
21574
|
+
assignedSubscriptionOptions?: SubscriptionOptionInProduct[];
|
|
21575
|
+
}
|
|
21576
|
+
interface AssignSubscriptionOptionsToProductResponse {
|
|
21577
|
+
}
|
|
21578
|
+
interface AllowOneTimePurchasesRequest {
|
|
21579
|
+
/** Product ID. */
|
|
21580
|
+
productId: string;
|
|
21581
|
+
/** Pass `true` to offer product by subscription and as one-time purchase. Pass `false` to offer product as subscription only. */
|
|
21582
|
+
allowed: boolean | null;
|
|
21583
|
+
}
|
|
21584
|
+
interface AllowOneTimePurchasesResponse {
|
|
21585
|
+
}
|
|
21582
21586
|
interface SubscriptionSettingsNonNullableFields {
|
|
21583
21587
|
frequency: SubscriptionFrequency;
|
|
21584
21588
|
autoRenewal: boolean;
|
|
@@ -21591,18 +21595,6 @@ interface SubscriptionOptionNonNullableFields {
|
|
|
21591
21595
|
subscriptionSettings?: SubscriptionSettingsNonNullableFields;
|
|
21592
21596
|
discount?: DiscountNonNullableFields;
|
|
21593
21597
|
}
|
|
21594
|
-
interface CreateSubscriptionOptionResponseNonNullableFields {
|
|
21595
|
-
subscriptionOption?: SubscriptionOptionNonNullableFields;
|
|
21596
|
-
}
|
|
21597
|
-
interface UpdateSubscriptionOptionResponseNonNullableFields {
|
|
21598
|
-
subscriptionOption?: SubscriptionOptionNonNullableFields;
|
|
21599
|
-
}
|
|
21600
|
-
interface BulkCreateSubscriptionOptionsResponseNonNullableFields {
|
|
21601
|
-
subscriptionOptions: SubscriptionOptionNonNullableFields[];
|
|
21602
|
-
}
|
|
21603
|
-
interface BulkUpdateSubscriptionOptionsResponseNonNullableFields {
|
|
21604
|
-
subscriptionOptions: SubscriptionOptionNonNullableFields[];
|
|
21605
|
-
}
|
|
21606
21598
|
interface GetSubscriptionOptionResponseNonNullableFields {
|
|
21607
21599
|
subscriptionOption?: SubscriptionOptionNonNullableFields;
|
|
21608
21600
|
}
|
|
@@ -21627,6 +21619,18 @@ interface GetProductIdsForSubscriptionOptionResponseNonNullableFields {
|
|
|
21627
21619
|
interface GetOneTimePurchasesStatusResponseNonNullableFields {
|
|
21628
21620
|
allowed: boolean;
|
|
21629
21621
|
}
|
|
21622
|
+
interface CreateSubscriptionOptionResponseNonNullableFields {
|
|
21623
|
+
subscriptionOption?: SubscriptionOptionNonNullableFields;
|
|
21624
|
+
}
|
|
21625
|
+
interface UpdateSubscriptionOptionResponseNonNullableFields {
|
|
21626
|
+
subscriptionOption?: SubscriptionOptionNonNullableFields;
|
|
21627
|
+
}
|
|
21628
|
+
interface BulkCreateSubscriptionOptionsResponseNonNullableFields {
|
|
21629
|
+
subscriptionOptions: SubscriptionOptionNonNullableFields[];
|
|
21630
|
+
}
|
|
21631
|
+
interface BulkUpdateSubscriptionOptionsResponseNonNullableFields {
|
|
21632
|
+
subscriptionOptions: SubscriptionOptionNonNullableFields[];
|
|
21633
|
+
}
|
|
21630
21634
|
|
|
21631
21635
|
type __PublicMethodMetaInfo$1<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
|
|
21632
21636
|
getUrl: (context: any) => string;
|
|
@@ -21638,6 +21642,18 @@ type __PublicMethodMetaInfo$1<K = string, M = unknown, T = unknown, S = unknown,
|
|
|
21638
21642
|
__responseType: Q;
|
|
21639
21643
|
__originalResponseType: R;
|
|
21640
21644
|
};
|
|
21645
|
+
declare function getSubscriptionOption(): __PublicMethodMetaInfo$1<'GET', {
|
|
21646
|
+
id: string;
|
|
21647
|
+
}, GetSubscriptionOptionRequest, GetSubscriptionOptionRequest$1, GetSubscriptionOptionResponse & GetSubscriptionOptionResponseNonNullableFields, GetSubscriptionOptionResponse$1 & GetSubscriptionOptionResponseNonNullableFields$1>;
|
|
21648
|
+
declare function getSubscriptionOptionsForProduct(): __PublicMethodMetaInfo$1<'GET', {
|
|
21649
|
+
productId: string;
|
|
21650
|
+
}, GetSubscriptionOptionsForProductRequest, GetSubscriptionOptionsForProductRequest$1, GetSubscriptionOptionsForProductResponse & GetSubscriptionOptionsForProductResponseNonNullableFields, GetSubscriptionOptionsForProductResponse$1 & GetSubscriptionOptionsForProductResponseNonNullableFields$1>;
|
|
21651
|
+
declare function getProductIdsForSubscriptionOption(): __PublicMethodMetaInfo$1<'GET', {
|
|
21652
|
+
id: string;
|
|
21653
|
+
}, GetProductIdsForSubscriptionOptionRequest, GetProductIdsForSubscriptionOptionRequest$1, GetProductIdsForSubscriptionOptionResponse & GetProductIdsForSubscriptionOptionResponseNonNullableFields, GetProductIdsForSubscriptionOptionResponse$1 & GetProductIdsForSubscriptionOptionResponseNonNullableFields$1>;
|
|
21654
|
+
declare function getOneTimePurchasesStatus(): __PublicMethodMetaInfo$1<'GET', {
|
|
21655
|
+
productId: string;
|
|
21656
|
+
}, GetOneTimePurchasesStatusRequest, GetOneTimePurchasesStatusRequest$1, GetOneTimePurchasesStatusResponse & GetOneTimePurchasesStatusResponseNonNullableFields, GetOneTimePurchasesStatusResponse$1 & GetOneTimePurchasesStatusResponseNonNullableFields$1>;
|
|
21641
21657
|
declare function createSubscriptionOption(): __PublicMethodMetaInfo$1<'POST', {}, CreateSubscriptionOptionRequest, CreateSubscriptionOptionRequest$1, CreateSubscriptionOptionResponse & CreateSubscriptionOptionResponseNonNullableFields, CreateSubscriptionOptionResponse$1 & CreateSubscriptionOptionResponseNonNullableFields$1>;
|
|
21642
21658
|
declare function updateSubscriptionOption(): __PublicMethodMetaInfo$1<'PATCH', {
|
|
21643
21659
|
subscriptionOptionId: string;
|
|
@@ -21654,18 +21670,6 @@ declare function assignSubscriptionOptionsToProduct(): __PublicMethodMetaInfo$1<
|
|
|
21654
21670
|
declare function allowOneTimePurchases(): __PublicMethodMetaInfo$1<'PATCH', {
|
|
21655
21671
|
productId: string;
|
|
21656
21672
|
}, AllowOneTimePurchasesRequest, AllowOneTimePurchasesRequest$1, AllowOneTimePurchasesResponse, AllowOneTimePurchasesResponse$1>;
|
|
21657
|
-
declare function getSubscriptionOption(): __PublicMethodMetaInfo$1<'GET', {
|
|
21658
|
-
id: string;
|
|
21659
|
-
}, GetSubscriptionOptionRequest, GetSubscriptionOptionRequest$1, GetSubscriptionOptionResponse & GetSubscriptionOptionResponseNonNullableFields, GetSubscriptionOptionResponse$1 & GetSubscriptionOptionResponseNonNullableFields$1>;
|
|
21660
|
-
declare function getSubscriptionOptionsForProduct(): __PublicMethodMetaInfo$1<'GET', {
|
|
21661
|
-
productId: string;
|
|
21662
|
-
}, GetSubscriptionOptionsForProductRequest, GetSubscriptionOptionsForProductRequest$1, GetSubscriptionOptionsForProductResponse & GetSubscriptionOptionsForProductResponseNonNullableFields, GetSubscriptionOptionsForProductResponse$1 & GetSubscriptionOptionsForProductResponseNonNullableFields$1>;
|
|
21663
|
-
declare function getProductIdsForSubscriptionOption(): __PublicMethodMetaInfo$1<'GET', {
|
|
21664
|
-
id: string;
|
|
21665
|
-
}, GetProductIdsForSubscriptionOptionRequest, GetProductIdsForSubscriptionOptionRequest$1, GetProductIdsForSubscriptionOptionResponse & GetProductIdsForSubscriptionOptionResponseNonNullableFields, GetProductIdsForSubscriptionOptionResponse$1 & GetProductIdsForSubscriptionOptionResponseNonNullableFields$1>;
|
|
21666
|
-
declare function getOneTimePurchasesStatus(): __PublicMethodMetaInfo$1<'GET', {
|
|
21667
|
-
productId: string;
|
|
21668
|
-
}, GetOneTimePurchasesStatusRequest, GetOneTimePurchasesStatusRequest$1, GetOneTimePurchasesStatusResponse & GetOneTimePurchasesStatusResponseNonNullableFields, GetOneTimePurchasesStatusResponse$1 & GetOneTimePurchasesStatusResponseNonNullableFields$1>;
|
|
21669
21673
|
|
|
21670
21674
|
declare const meta$1_allowOneTimePurchases: typeof allowOneTimePurchases;
|
|
21671
21675
|
declare const meta$1_assignSubscriptionOptionsToProduct: typeof assignSubscriptionOptionsToProduct;
|
|
@@ -21721,85 +21725,22 @@ interface InventoryVariantV2$1 {
|
|
|
21721
21725
|
/** Variant ID. */
|
|
21722
21726
|
variantId?: string;
|
|
21723
21727
|
/** Whether the product is listed as in stock. */
|
|
21724
|
-
inStock?: boolean | null;
|
|
21725
|
-
/** Quantity currently left in inventory. */
|
|
21726
|
-
quantity?: number | null;
|
|
21727
|
-
/**
|
|
21728
|
-
* Whether the variant is available for preorder. When `true`, the variant is out of stock and preorder is enabled on inventory level.
|
|
21729
|
-
* @readonly
|
|
21730
|
-
*/
|
|
21731
|
-
availableForPreorder?: boolean;
|
|
21732
|
-
}
|
|
21733
|
-
interface PreorderInfo$1 {
|
|
21734
|
-
/** Whether the item is available for preorder. */
|
|
21735
|
-
enabled?: boolean;
|
|
21736
|
-
/** A message the buyer will see when the item is out of stock and preorder is enabled. */
|
|
21737
|
-
message?: string | null;
|
|
21738
|
-
/** Number of products that can be preordered after stock reaches zero. */
|
|
21739
|
-
limit?: number | null;
|
|
21740
|
-
}
|
|
21741
|
-
interface GetInventoryVariantsRequest$1 extends GetInventoryVariantsRequestIdOneOf$1 {
|
|
21742
|
-
/** Inventory item ID. */
|
|
21743
|
-
inventoryId: string;
|
|
21744
|
-
/**
|
|
21745
|
-
* Deprecated (use productID instead).
|
|
21746
|
-
* @deprecated Deprecated (use productID instead).
|
|
21747
|
-
* @replacedBy product_id
|
|
21748
|
-
* @targetRemovalDate 2024-12-31
|
|
21749
|
-
*/
|
|
21750
|
-
externalId?: string;
|
|
21751
|
-
/** Product ID. */
|
|
21752
|
-
productId?: string;
|
|
21753
|
-
/** Variant IDs to query for this inventory item (optional). */
|
|
21754
|
-
variantIds?: string[];
|
|
21755
|
-
}
|
|
21756
|
-
/** @oneof */
|
|
21757
|
-
interface GetInventoryVariantsRequestIdOneOf$1 {
|
|
21758
|
-
/** Inventory item ID. */
|
|
21759
|
-
inventoryId?: string;
|
|
21728
|
+
inStock?: boolean | null;
|
|
21729
|
+
/** Quantity currently left in inventory. */
|
|
21730
|
+
quantity?: number | null;
|
|
21760
21731
|
/**
|
|
21761
|
-
*
|
|
21762
|
-
* @
|
|
21763
|
-
* @replacedBy product_id
|
|
21764
|
-
* @targetRemovalDate 2024-12-31
|
|
21732
|
+
* Whether the variant is available for preorder. When `true`, the variant is out of stock and preorder is enabled on inventory level.
|
|
21733
|
+
* @readonly
|
|
21765
21734
|
*/
|
|
21766
|
-
|
|
21767
|
-
/** Product ID. */
|
|
21768
|
-
productId?: string;
|
|
21769
|
-
}
|
|
21770
|
-
interface GetInventoryVariantsResponse$1 {
|
|
21771
|
-
/** Inventory item. */
|
|
21772
|
-
inventoryItem?: InventoryItemV2$1;
|
|
21773
|
-
}
|
|
21774
|
-
interface QueryInventoryRequest$1 {
|
|
21775
|
-
query?: Query$1;
|
|
21776
|
-
}
|
|
21777
|
-
interface Query$1 {
|
|
21778
|
-
paging?: Paging$1;
|
|
21779
|
-
/** Filter string */
|
|
21780
|
-
filter?: string | null;
|
|
21781
|
-
/** Sort string */
|
|
21782
|
-
sort?: string | null;
|
|
21735
|
+
availableForPreorder?: boolean;
|
|
21783
21736
|
}
|
|
21784
|
-
interface
|
|
21785
|
-
/**
|
|
21737
|
+
interface PreorderInfo$1 {
|
|
21738
|
+
/** Whether the item is available for preorder. */
|
|
21739
|
+
enabled?: boolean;
|
|
21740
|
+
/** A message the buyer will see when the item is out of stock and preorder is enabled. */
|
|
21741
|
+
message?: string | null;
|
|
21742
|
+
/** Number of products that can be preordered after stock reaches zero. */
|
|
21786
21743
|
limit?: number | null;
|
|
21787
|
-
/** Number of items to skip in the display (relevant for all pages after the first) */
|
|
21788
|
-
offset?: number | null;
|
|
21789
|
-
}
|
|
21790
|
-
interface QueryInventoryResponse$1 {
|
|
21791
|
-
/** Inventory items. */
|
|
21792
|
-
inventoryItems?: InventoryItemV2$1[];
|
|
21793
|
-
/** Display metadata. */
|
|
21794
|
-
metadata?: PagingMetadata$1;
|
|
21795
|
-
/** Number of total results. */
|
|
21796
|
-
totalResults?: number;
|
|
21797
|
-
}
|
|
21798
|
-
interface PagingMetadata$1 {
|
|
21799
|
-
/** Amount of items to load per page */
|
|
21800
|
-
items?: number;
|
|
21801
|
-
/** Number of items to skip in the display (relevant for all pages after the first) */
|
|
21802
|
-
offset?: number;
|
|
21803
21744
|
}
|
|
21804
21745
|
interface UpdateInventoryVariantsRequest$1 {
|
|
21805
21746
|
/** Inventory item. */
|
|
@@ -21871,6 +21812,69 @@ interface IncrementDataIdOneOf$1 {
|
|
|
21871
21812
|
}
|
|
21872
21813
|
interface IncrementInventoryResponse$1 {
|
|
21873
21814
|
}
|
|
21815
|
+
interface GetInventoryVariantsRequest$1 extends GetInventoryVariantsRequestIdOneOf$1 {
|
|
21816
|
+
/** Inventory item ID. */
|
|
21817
|
+
inventoryId: string;
|
|
21818
|
+
/**
|
|
21819
|
+
* Deprecated (use productID instead).
|
|
21820
|
+
* @deprecated Deprecated (use productID instead).
|
|
21821
|
+
* @replacedBy product_id
|
|
21822
|
+
* @targetRemovalDate 2024-12-31
|
|
21823
|
+
*/
|
|
21824
|
+
externalId?: string;
|
|
21825
|
+
/** Product ID. */
|
|
21826
|
+
productId?: string;
|
|
21827
|
+
/** Variant IDs to query for this inventory item (optional). */
|
|
21828
|
+
variantIds?: string[];
|
|
21829
|
+
}
|
|
21830
|
+
/** @oneof */
|
|
21831
|
+
interface GetInventoryVariantsRequestIdOneOf$1 {
|
|
21832
|
+
/** Inventory item ID. */
|
|
21833
|
+
inventoryId?: string;
|
|
21834
|
+
/**
|
|
21835
|
+
* Deprecated (use productID instead).
|
|
21836
|
+
* @deprecated Deprecated (use productID instead).
|
|
21837
|
+
* @replacedBy product_id
|
|
21838
|
+
* @targetRemovalDate 2024-12-31
|
|
21839
|
+
*/
|
|
21840
|
+
externalId?: string;
|
|
21841
|
+
/** Product ID. */
|
|
21842
|
+
productId?: string;
|
|
21843
|
+
}
|
|
21844
|
+
interface GetInventoryVariantsResponse$1 {
|
|
21845
|
+
/** Inventory item. */
|
|
21846
|
+
inventoryItem?: InventoryItemV2$1;
|
|
21847
|
+
}
|
|
21848
|
+
interface QueryInventoryRequest$1 {
|
|
21849
|
+
query?: Query$1;
|
|
21850
|
+
}
|
|
21851
|
+
interface Query$1 {
|
|
21852
|
+
paging?: Paging$1;
|
|
21853
|
+
/** Filter string */
|
|
21854
|
+
filter?: string | null;
|
|
21855
|
+
/** Sort string */
|
|
21856
|
+
sort?: string | null;
|
|
21857
|
+
}
|
|
21858
|
+
interface Paging$1 {
|
|
21859
|
+
/** Amount of items to load per page */
|
|
21860
|
+
limit?: number | null;
|
|
21861
|
+
/** Number of items to skip in the display (relevant for all pages after the first) */
|
|
21862
|
+
offset?: number | null;
|
|
21863
|
+
}
|
|
21864
|
+
interface QueryInventoryResponse$1 {
|
|
21865
|
+
/** Inventory items. */
|
|
21866
|
+
inventoryItems?: InventoryItemV2$1[];
|
|
21867
|
+
/** Display metadata. */
|
|
21868
|
+
metadata?: PagingMetadata$1;
|
|
21869
|
+
/** Number of total results. */
|
|
21870
|
+
totalResults?: number;
|
|
21871
|
+
}
|
|
21872
|
+
interface PagingMetadata$1 {
|
|
21873
|
+
/** Amount of items to load per page */
|
|
21874
|
+
items?: number;
|
|
21875
|
+
/** Number of items to skip in the display (relevant for all pages after the first) */
|
|
21876
|
+
offset?: number;
|
|
21877
|
+
}
|
|
21874
21878
|
interface InventoryVariantV2NonNullableFields$1 {
|
|
21875
21879
|
variantId: string;
|
|
21876
21880
|
availableForPreorder: boolean;
|
|
@@ -21952,73 +21956,6 @@ interface PreorderInfo {
|
|
|
21952
21956
|
/** Number of products that can be preordered after stock reaches zero. */
|
|
21953
21957
|
limit?: number | null;
|
|
21954
21958
|
}
|
|
21955
|
-
interface GetInventoryVariantsRequest extends GetInventoryVariantsRequestIdOneOf {
|
|
21956
|
-
/** Inventory item ID. */
|
|
21957
|
-
inventoryId: string;
|
|
21958
|
-
/**
|
|
21959
|
-
* @internal
|
|
21960
|
-
* @internal
|
|
21961
|
-
* @deprecated Deprecated (use productID instead).
|
|
21962
|
-
* @replacedBy product_id
|
|
21963
|
-
* @targetRemovalDate 2024-12-31
|
|
21964
|
-
*/
|
|
21965
|
-
externalId?: string;
|
|
21966
|
-
/** Product ID. */
|
|
21967
|
-
productId?: string;
|
|
21968
|
-
/** Variant IDs to query for this inventory item (optional). */
|
|
21969
|
-
variantIds?: string[];
|
|
21970
|
-
}
|
|
21971
|
-
/** @oneof */
|
|
21972
|
-
interface GetInventoryVariantsRequestIdOneOf {
|
|
21973
|
-
/** Inventory item ID. */
|
|
21974
|
-
inventoryId?: string;
|
|
21975
|
-
/**
|
|
21976
|
-
* @internal
|
|
21977
|
-
* @internal
|
|
21978
|
-
* @deprecated Deprecated (use productID instead).
|
|
21979
|
-
* @replacedBy product_id
|
|
21980
|
-
* @targetRemovalDate 2024-12-31
|
|
21981
|
-
*/
|
|
21982
|
-
externalId?: string;
|
|
21983
|
-
/** Product ID. */
|
|
21984
|
-
productId?: string;
|
|
21985
|
-
}
|
|
21986
|
-
interface GetInventoryVariantsResponse {
|
|
21987
|
-
/** Inventory item. */
|
|
21988
|
-
inventoryItem?: InventoryItemV2;
|
|
21989
|
-
}
|
|
21990
|
-
interface QueryInventoryRequest {
|
|
21991
|
-
/** Information about paging, filters, sorting. */
|
|
21992
|
-
query?: Query;
|
|
21993
|
-
}
|
|
21994
|
-
interface Query {
|
|
21995
|
-
/** Paging options to limit and skip the number of items. */
|
|
21996
|
-
paging?: Paging;
|
|
21997
|
-
/** Filter string */
|
|
21998
|
-
filter?: string | null;
|
|
21999
|
-
/** Sort string */
|
|
22000
|
-
sort?: string | null;
|
|
22001
|
-
}
|
|
22002
|
-
interface Paging {
|
|
22003
|
-
/** Amount of items to load per page */
|
|
22004
|
-
limit?: number | null;
|
|
22005
|
-
/** Number of items to skip in the display (relevant for all pages after the first) */
|
|
22006
|
-
offset?: number | null;
|
|
22007
|
-
}
|
|
22008
|
-
interface QueryInventoryResponse {
|
|
22009
|
-
/** Inventory items. */
|
|
22010
|
-
inventoryItems?: InventoryItemV2[];
|
|
22011
|
-
/** Display metadata. */
|
|
22012
|
-
metadata?: PagingMetadata;
|
|
22013
|
-
/** Number of total results. */
|
|
22014
|
-
totalResults?: number;
|
|
22015
|
-
}
|
|
22016
|
-
interface PagingMetadata {
|
|
22017
|
-
/** Amount of items to load per page */
|
|
22018
|
-
items?: number;
|
|
22019
|
-
/** Number of items to skip in the display (relevant for all pages after the first) */
|
|
22020
|
-
offset?: number;
|
|
22021
|
-
}
|
|
22022
21959
|
interface UpdateInventoryVariantsRequest {
|
|
22023
21960
|
/** Inventory item. */
|
|
22024
21961
|
inventoryItem: InventoryItemV2;
|
|
@@ -22093,6 +22030,73 @@ interface IncrementDataIdOneOf {
|
|
|
22093
22030
|
}
|
|
22094
22031
|
interface IncrementInventoryResponse {
|
|
22095
22032
|
}
|
|
22033
|
+
interface GetInventoryVariantsRequest extends GetInventoryVariantsRequestIdOneOf {
|
|
22034
|
+
/** Inventory item ID. */
|
|
22035
|
+
inventoryId: string;
|
|
22036
|
+
/**
|
|
22037
|
+
* @internal
|
|
22038
|
+
* @internal
|
|
22039
|
+
* @deprecated Deprecated (use productID instead).
|
|
22040
|
+
* @replacedBy product_id
|
|
22041
|
+
* @targetRemovalDate 2024-12-31
|
|
22042
|
+
*/
|
|
22043
|
+
externalId?: string;
|
|
22044
|
+
/** Product ID. */
|
|
22045
|
+
productId?: string;
|
|
22046
|
+
/** Variant IDs to query for this inventory item (optional). */
|
|
22047
|
+
variantIds?: string[];
|
|
22048
|
+
}
|
|
22049
|
+
/** @oneof */
|
|
22050
|
+
interface GetInventoryVariantsRequestIdOneOf {
|
|
22051
|
+
/** Inventory item ID. */
|
|
22052
|
+
inventoryId?: string;
|
|
22053
|
+
/**
|
|
22054
|
+
* @internal
|
|
22055
|
+
* @internal
|
|
22056
|
+
* @deprecated Deprecated (use productID instead).
|
|
22057
|
+
* @replacedBy product_id
|
|
22058
|
+
* @targetRemovalDate 2024-12-31
|
|
22059
|
+
*/
|
|
22060
|
+
externalId?: string;
|
|
22061
|
+
/** Product ID. */
|
|
22062
|
+
productId?: string;
|
|
22063
|
+
}
|
|
22064
|
+
interface GetInventoryVariantsResponse {
|
|
22065
|
+
/** Inventory item. */
|
|
22066
|
+
inventoryItem?: InventoryItemV2;
|
|
22067
|
+
}
|
|
22068
|
+
interface QueryInventoryRequest {
|
|
22069
|
+
/** Information about paging, filters, sorting. */
|
|
22070
|
+
query?: Query;
|
|
22071
|
+
}
|
|
22072
|
+
interface Query {
|
|
22073
|
+
/** Paging options to limit and skip the number of items. */
|
|
22074
|
+
paging?: Paging;
|
|
22075
|
+
/** Filter string */
|
|
22076
|
+
filter?: string | null;
|
|
22077
|
+
/** Sort string */
|
|
22078
|
+
sort?: string | null;
|
|
22079
|
+
}
|
|
22080
|
+
interface Paging {
|
|
22081
|
+
/** Amount of items to load per page */
|
|
22082
|
+
limit?: number | null;
|
|
22083
|
+
/** Number of items to skip in the display (relevant for all pages after the first) */
|
|
22084
|
+
offset?: number | null;
|
|
22085
|
+
}
|
|
22086
|
+
interface QueryInventoryResponse {
|
|
22087
|
+
/** Inventory items. */
|
|
22088
|
+
inventoryItems?: InventoryItemV2[];
|
|
22089
|
+
/** Display metadata. */
|
|
22090
|
+
metadata?: PagingMetadata;
|
|
22091
|
+
/** Number of total results. */
|
|
22092
|
+
totalResults?: number;
|
|
22093
|
+
}
|
|
22094
|
+
interface PagingMetadata {
|
|
22095
|
+
/** Amount of items to load per page */
|
|
22096
|
+
items?: number;
|
|
22097
|
+
/** Number of items to skip in the display (relevant for all pages after the first) */
|
|
22098
|
+
offset?: number;
|
|
22099
|
+
}
|
|
22096
22100
|
interface InventoryVariantV2NonNullableFields {
|
|
22097
22101
|
variantId: string;
|
|
22098
22102
|
availableForPreorder: boolean;
|
|
@@ -22128,15 +22132,15 @@ type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q
|
|
|
22128
22132
|
__responseType: Q;
|
|
22129
22133
|
__originalResponseType: R;
|
|
22130
22134
|
};
|
|
22131
|
-
declare function getInventoryVariants(): __PublicMethodMetaInfo<'POST', {
|
|
22132
|
-
inventoryId: string;
|
|
22133
|
-
}, GetInventoryVariantsRequest, GetInventoryVariantsRequest$1, GetInventoryVariantsResponse & GetInventoryVariantsResponseNonNullableFields, GetInventoryVariantsResponse$1 & GetInventoryVariantsResponseNonNullableFields$1>;
|
|
22134
|
-
declare function queryInventory(): __PublicMethodMetaInfo<'POST', {}, QueryInventoryRequest, QueryInventoryRequest$1, QueryInventoryResponse & QueryInventoryResponseNonNullableFields, QueryInventoryResponse$1 & QueryInventoryResponseNonNullableFields$1>;
|
|
22135
22135
|
declare function updateInventoryVariants(): __PublicMethodMetaInfo<'PATCH', {
|
|
22136
22136
|
inventoryItemProductId: string;
|
|
22137
22137
|
}, UpdateInventoryVariantsRequest, UpdateInventoryVariantsRequest$1, UpdateInventoryVariantsResponse, UpdateInventoryVariantsResponse$1>;
|
|
22138
22138
|
declare function decrementInventory(): __PublicMethodMetaInfo<'POST', {}, DecrementInventoryRequest, DecrementInventoryRequest$1, DecrementInventoryResponse, DecrementInventoryResponse$1>;
|
|
22139
22139
|
declare function incrementInventory(): __PublicMethodMetaInfo<'POST', {}, IncrementInventoryRequest, IncrementInventoryRequest$1, IncrementInventoryResponse, IncrementInventoryResponse$1>;
|
|
22140
|
+
declare function getInventoryVariants(): __PublicMethodMetaInfo<'POST', {
|
|
22141
|
+
inventoryId: string;
|
|
22142
|
+
}, GetInventoryVariantsRequest, GetInventoryVariantsRequest$1, GetInventoryVariantsResponse & GetInventoryVariantsResponseNonNullableFields, GetInventoryVariantsResponse$1 & GetInventoryVariantsResponseNonNullableFields$1>;
|
|
22143
|
+
declare function queryInventory(): __PublicMethodMetaInfo<'POST', {}, QueryInventoryRequest, QueryInventoryRequest$1, QueryInventoryResponse & QueryInventoryResponseNonNullableFields, QueryInventoryResponse$1 & QueryInventoryResponseNonNullableFields$1>;
|
|
22140
22144
|
|
|
22141
22145
|
type meta___PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = __PublicMethodMetaInfo<K, M, T, S, Q, R>;
|
|
22142
22146
|
declare const meta_decrementInventory: typeof decrementInventory;
|