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