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