@gofynd/fdk-client-javascript 3.11.0 → 3.13.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/package.json +1 -1
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +16 -6
- package/sdk/application/Catalog/CatalogApplicationClient.js +71 -12
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +80 -80
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +48 -48
- package/sdk/platform/Cart/CartPlatformModel.d.ts +6 -18
- package/sdk/platform/Cart/CartPlatformModel.js +2 -36
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +14 -48
- package/sdk/platform/Catalog/CatalogPlatformClient.js +85 -338
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +207 -763
- package/sdk/platform/Catalog/CatalogPlatformModel.js +107 -392
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +15 -71
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +14 -60
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +36 -0
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +252 -0
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +34 -1
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +42 -0
- package/sdk/platform/Order/OrderPlatformClient.d.ts +69 -7
- package/sdk/platform/Order/OrderPlatformClient.js +453 -7
- package/sdk/platform/Order/OrderPlatformModel.d.ts +1938 -493
- package/sdk/platform/Order/OrderPlatformModel.js +1238 -506
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +162 -16
- package/sdk/platform/Order/OrderPlatformValidator.js +111 -9
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +14 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +85 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +17 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +16 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +861 -178
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +534 -84
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +5 -0
- package/sdk/public/Webhook/WebhookPublicModel.js +2 -0
|
@@ -1754,51 +1754,6 @@ export = CatalogPlatformModel;
|
|
|
1754
1754
|
* @property {CompanyOptIn[]} items
|
|
1755
1755
|
* @property {Page} page
|
|
1756
1756
|
*/
|
|
1757
|
-
/**
|
|
1758
|
-
* @typedef GetProductBundleCreateResponseSchema
|
|
1759
|
-
* @property {string} choice - Specifies the type of bundle, e.g., single or multi.
|
|
1760
|
-
* @property {number} [company_id] - Unique identifier for the company that owns
|
|
1761
|
-
* the product bundle.
|
|
1762
|
-
* @property {CreatedBy} [created_by]
|
|
1763
|
-
* @property {string} [created_on] - Timestamp when the product bundle was created.
|
|
1764
|
-
* @property {string} [id] - Unique identifier for the product bundle.
|
|
1765
|
-
* @property {boolean} is_active - Indicates if the product bundle is active or not.
|
|
1766
|
-
* @property {string} [logo] - URL of the product bundle's logo, or null if not available.
|
|
1767
|
-
* @property {Object} [meta] - Additional metadata about the product bundle.
|
|
1768
|
-
* @property {ModifiedBy} [modified_by]
|
|
1769
|
-
* @property {string} [modified_on] - Timestamp when the product bundle was last modified.
|
|
1770
|
-
* @property {string} name - Name of the product bundle.
|
|
1771
|
-
* @property {string[]} [page_visibility] - Visibility settings for the product
|
|
1772
|
-
* bundle across different pages.
|
|
1773
|
-
* @property {ProductBundleItem[]} products - List of products that are part of
|
|
1774
|
-
* the product bundle.
|
|
1775
|
-
* @property {boolean} [same_store_assignment] - Indicates whether all products
|
|
1776
|
-
* in the bundle belong to the same store.
|
|
1777
|
-
* @property {string} slug - Unique slug used to identify the product bundle in URLs.
|
|
1778
|
-
*/
|
|
1779
|
-
/**
|
|
1780
|
-
* @typedef GetProductBundleListingResponseSchema
|
|
1781
|
-
* @property {GetProductBundleCreateResponseSchema[]} [items] - List of product
|
|
1782
|
-
* bundles that are returned in the response.
|
|
1783
|
-
* @property {Page} [page]
|
|
1784
|
-
*/
|
|
1785
|
-
/**
|
|
1786
|
-
* @typedef GetProductBundleResponseSchema
|
|
1787
|
-
* @property {string} [choice] - Specifies the type of product bundle, e.g.,
|
|
1788
|
-
* 'single' or 'multi'.
|
|
1789
|
-
* @property {number} [company_id] - The unique identifier of the company that
|
|
1790
|
-
* owns the product bundle.
|
|
1791
|
-
* @property {boolean} [is_active] - Indicates whether the product bundle is active.
|
|
1792
|
-
* @property {string} [logo] - URL of the logo associated with the product bundle.
|
|
1793
|
-
* @property {Object} [meta] - Additional metadata for the product bundle.
|
|
1794
|
-
* @property {string} [name] - The name of the product bundle.
|
|
1795
|
-
* @property {string[]} [page_visibility] - List of pages where the product
|
|
1796
|
-
* bundle is visible, e.g., 'pdp'.
|
|
1797
|
-
* @property {GetProducts[]} [products] - A list of products included in the bundle.
|
|
1798
|
-
* @property {boolean} [same_store_assignment] - Indicates whether all products
|
|
1799
|
-
* in the bundle are assigned to the same store.
|
|
1800
|
-
* @property {string} [slug] - Unique URL-friendly identifier for the product bundle.
|
|
1801
|
-
*/
|
|
1802
1757
|
/**
|
|
1803
1758
|
* @typedef GetProducts
|
|
1804
1759
|
* @property {boolean} [allow_remove] - Indicates whether the product can be
|
|
@@ -2645,6 +2600,13 @@ export = CatalogPlatformModel;
|
|
|
2645
2600
|
* @property {string} [url] - The URL where the media file is hosted, typically
|
|
2646
2601
|
* a link to an image or video resource.
|
|
2647
2602
|
*/
|
|
2603
|
+
/**
|
|
2604
|
+
* @typedef BundleDetails
|
|
2605
|
+
* @property {string} seller_identifier - Seller identifier of child sku.
|
|
2606
|
+
* @property {number} net_quantity - The net quantity of the product in the bundle.
|
|
2607
|
+
* @property {boolean} [is_base] - Indicates whether this product is the base
|
|
2608
|
+
* product in the bundle.
|
|
2609
|
+
*/
|
|
2648
2610
|
/**
|
|
2649
2611
|
* @typedef Meta
|
|
2650
2612
|
* @property {Object} [headers]
|
|
@@ -2976,132 +2938,13 @@ export = CatalogPlatformModel;
|
|
|
2976
2938
|
* @property {Object} [items]
|
|
2977
2939
|
* @property {Page} [page]
|
|
2978
2940
|
*/
|
|
2979
|
-
/**
|
|
2980
|
-
* @typedef ProductBundleItem
|
|
2981
|
-
* @property {boolean} [allow_remove] - Indicates whether the product can be
|
|
2982
|
-
* removed from the bundle.
|
|
2983
|
-
* @property {boolean} [auto_add_to_cart] - Specifies if the product is
|
|
2984
|
-
* automatically added to the cart.
|
|
2985
|
-
* @property {boolean} [auto_select] - Indicates if the product is automatically
|
|
2986
|
-
* selected in the bundle.
|
|
2987
|
-
* @property {number} max_quantity - Maximum quantity of the product that can be
|
|
2988
|
-
* added to the bundle.
|
|
2989
|
-
* @property {number} min_quantity - Minimum quantity of the product that must
|
|
2990
|
-
* be added to the bundle.
|
|
2991
|
-
* @property {number} product_uid - Unique identifier for the product.
|
|
2992
|
-
*/
|
|
2993
|
-
/**
|
|
2994
|
-
* @typedef ProductBundleRequestSchema
|
|
2995
|
-
* @property {string} choice - Specifies the type of product bundle (e.g.,
|
|
2996
|
-
* 'single' or 'multi').
|
|
2997
|
-
* @property {number} [company_id] - The unique identifier of the company to
|
|
2998
|
-
* which the product bundle belongs.
|
|
2999
|
-
* @property {Object} [created_by] - Information about the user who created the
|
|
3000
|
-
* product bundle, including user ID and username.
|
|
3001
|
-
* @property {string} [created_on] - The timestamp when the product bundle was created.
|
|
3002
|
-
* @property {boolean} is_active - Indicates whether the product bundle is
|
|
3003
|
-
* currently active.
|
|
3004
|
-
* @property {string} [logo] - URL of the logo associated with the product
|
|
3005
|
-
* bundle, if available. Can be null.
|
|
3006
|
-
* @property {Object} [meta] - Additional metadata for the product bundle.
|
|
3007
|
-
* @property {Object} [modified_by] - Information about the user who last
|
|
3008
|
-
* modified the product bundle, including user ID and username.
|
|
3009
|
-
* @property {string} [modified_on] - The timestamp when the product bundle was
|
|
3010
|
-
* last modified.
|
|
3011
|
-
* @property {string} name - The name of the product bundle.
|
|
3012
|
-
* @property {string[]} [page_visibility] - Pages where the product bundle is
|
|
3013
|
-
* visible (e.g., 'pdp' for product display page).
|
|
3014
|
-
* @property {ProductBundleItem[]} products - A list of products included in the
|
|
3015
|
-
* bundle. A maximum of 10 products can be added.
|
|
3016
|
-
* @property {boolean} [same_store_assignment] - Indicates whether all products
|
|
3017
|
-
* in the bundle are assigned to the same store.
|
|
3018
|
-
* @property {string} slug - A URL-friendly unique identifier for the product bundle.
|
|
3019
|
-
*/
|
|
3020
|
-
/**
|
|
3021
|
-
* @typedef ProductBundleUpdateRequestSchema
|
|
3022
|
-
* @property {string} choice - Specifies the type of product bundle (e.g.,
|
|
3023
|
-
* 'single' or 'multi').
|
|
3024
|
-
* @property {number} [company_id] - The unique identifier of the company to
|
|
3025
|
-
* which the product bundle belongs.
|
|
3026
|
-
* @property {boolean} is_active - Indicates whether the product bundle is
|
|
3027
|
-
* currently active.
|
|
3028
|
-
* @property {string} [logo] - URL of the logo associated with the product
|
|
3029
|
-
* bundle, if available. Can be null.
|
|
3030
|
-
* @property {Object} [meta] - Additional metadata for the product bundle.
|
|
3031
|
-
* @property {string} name - The name of the product bundle.
|
|
3032
|
-
* @property {string[]} [page_visibility] - Pages where the product bundle is
|
|
3033
|
-
* visible (e.g., 'pdp' for product display page).
|
|
3034
|
-
* @property {ProductBundleItem[]} products - A list of products included in the
|
|
3035
|
-
* bundle. A maximum of 10 products can be added.
|
|
3036
|
-
* @property {boolean} [same_store_assignment] - Indicates whether all products
|
|
3037
|
-
* in the bundle are assigned to the same store.
|
|
3038
|
-
* @property {string} slug - A URL-friendly unique identifier for the product bundle.
|
|
3039
|
-
*/
|
|
3040
2941
|
/**
|
|
3041
2942
|
* @typedef ProductConfigurationDownloads
|
|
3042
2943
|
* @property {Object[]} [data]
|
|
3043
2944
|
* @property {boolean} [multivalue]
|
|
3044
2945
|
*/
|
|
3045
2946
|
/**
|
|
3046
|
-
* @typedef
|
|
3047
|
-
* @property {Object} [_custom_json] - Custom JSON data that can be used for
|
|
3048
|
-
* additional product properties.
|
|
3049
|
-
* @property {string} [action] - The action to perform wrt to the product (e.g.,
|
|
3050
|
-
* upsert, update, delete).
|
|
3051
|
-
* @property {Object} [attributes] - Additional attributes related to the product.
|
|
3052
|
-
* @property {number} brand_uid - Unique identifier for the product's brand.
|
|
3053
|
-
* @property {string} [bulk_job_id] - Job ID associated with bulk operations.
|
|
3054
|
-
* @property {string} category_slug - The category to which the product belongs.
|
|
3055
|
-
* @property {string} [change_request_id] - Change request identifier for product updates.
|
|
3056
|
-
* @property {number} company_id - Unique identifier for the company associated
|
|
3057
|
-
* with the product.
|
|
3058
|
-
* @property {string} country_of_origin - The country where the product was
|
|
3059
|
-
* manufactured or sourced.
|
|
3060
|
-
* @property {string} currency - The currency in which the product's price is listed.
|
|
3061
|
-
* @property {CustomOrder} [custom_order]
|
|
3062
|
-
* @property {number[]} departments - List of department IDs associated with the product.
|
|
3063
|
-
* @property {string} [description] - A detailed description of the product.
|
|
3064
|
-
* @property {string[]} [highlights] - Product highlights or key features.
|
|
3065
|
-
* @property {boolean} [is_active] - Flag to indicate if the product is active.
|
|
3066
|
-
* @property {boolean} [is_dependent] - Flag to indicate if the product is
|
|
3067
|
-
* dependent on other products.
|
|
3068
|
-
* @property {boolean} [is_image_less_product] - Flag to indicate if the product
|
|
3069
|
-
* does not have associated images.
|
|
3070
|
-
* @property {boolean} [is_set] - Flag to indicate if the product is part of a set.
|
|
3071
|
-
* @property {string} item_code - Unique item code or SKU of the product.
|
|
3072
|
-
* @property {string} item_type - Type of the product (e.g., standard, set,
|
|
3073
|
-
* composite, digital).
|
|
3074
|
-
* @property {Media[]} [media] - List of media URLs (images, videos) associated
|
|
3075
|
-
* with the product.
|
|
3076
|
-
* @property {boolean} [multi_size] - Indicates if the product supports multiple sizes.
|
|
3077
|
-
* @property {string} name - The name of the product.
|
|
3078
|
-
* @property {NetQuantity} [net_quantity]
|
|
3079
|
-
* @property {number} [no_of_boxes] - Number of boxes required to package the product.
|
|
3080
|
-
* @property {string[]} [product_group_tag] - Tags to group products together
|
|
3081
|
-
* for classification.
|
|
3082
|
-
* @property {ProductPublish} [product_publish]
|
|
3083
|
-
* @property {string} [requester] - The role requesting the product operation
|
|
3084
|
-
* (admin or user).
|
|
3085
|
-
* @property {ReturnConfig} return_config
|
|
3086
|
-
* @property {string} [short_description] - A short description of the product,
|
|
3087
|
-
* up to 50 characters.
|
|
3088
|
-
* @property {string} [size_guide] - Identifier for the product's size guide.
|
|
3089
|
-
* @property {Object[]} sizes - List of sizes available for the product.
|
|
3090
|
-
* @property {string} slug - URL-friendly identifier for the product.
|
|
3091
|
-
* @property {string[]} [tags] - List of tags associated with the product.
|
|
3092
|
-
* @property {TaxIdentifier} tax_identifier
|
|
3093
|
-
* @property {string} [hs_code] - HS Code for the product.
|
|
3094
|
-
* @property {TeaserTag} [teaser_tag]
|
|
3095
|
-
* @property {string} template_tag - Template tag for the product, used for
|
|
3096
|
-
* classification.
|
|
3097
|
-
* @property {Trader[]} trader - List of traders associated with the product.
|
|
3098
|
-
* @property {number} [uid] - Unique identifier for the product.
|
|
3099
|
-
* @property {Object} [variant_group] - Variant group information for the product.
|
|
3100
|
-
* @property {Object} [variant_media] - Media related to product variants.
|
|
3101
|
-
* @property {Object} [variants] - Variants information for the product.
|
|
3102
|
-
*/
|
|
3103
|
-
/**
|
|
3104
|
-
* @typedef ProductCreateSchemaV2
|
|
2947
|
+
* @typedef ProductCreateSchemaV3
|
|
3105
2948
|
* @property {Object} [_custom_json] - Custom JSON data that can be used for
|
|
3106
2949
|
* additional product properties.
|
|
3107
2950
|
* @property {string} [action] - The action to perform wrt to the product (e.g.,
|
|
@@ -3127,8 +2970,11 @@ export = CatalogPlatformModel;
|
|
|
3127
2970
|
* does not have associated images.
|
|
3128
2971
|
* @property {boolean} [is_set] - Flag to indicate if the product is part of a set.
|
|
3129
2972
|
* @property {string} item_code - Unique item code or SKU of the product.
|
|
3130
|
-
* @property {string} item_type -
|
|
3131
|
-
* composite, digital
|
|
2973
|
+
* @property {string} item_type - Specifies the type of product, such as
|
|
2974
|
+
* standard, set, composite, digital, virtual_bundle, or physical_bundle. For
|
|
2975
|
+
* bundle types (virtual_bundle or physical_bundle), use the category,
|
|
2976
|
+
* department, and brand of the base child SKU. In this case, attributes are
|
|
2977
|
+
* optional. The bundle_details attribute must be included for bundle types.
|
|
3132
2978
|
* @property {Media[]} [media] - List of media URLs (images, videos) associated
|
|
3133
2979
|
* with the product.
|
|
3134
2980
|
* @property {boolean} [multi_size] - Indicates if the product supports multiple sizes.
|
|
@@ -3147,7 +2993,7 @@ export = CatalogPlatformModel;
|
|
|
3147
2993
|
* @property {Object[]} sizes - List of sizes available for the product.
|
|
3148
2994
|
* @property {string} slug - URL-friendly identifier for the product.
|
|
3149
2995
|
* @property {string[]} [tags] - List of tags associated with the product.
|
|
3150
|
-
* @property {
|
|
2996
|
+
* @property {TaxIdentifierV3} tax_identifier
|
|
3151
2997
|
* @property {TeaserTag} [teaser_tag]
|
|
3152
2998
|
* @property {string} template_tag - Template tag for the product, used for
|
|
3153
2999
|
* classification.
|
|
@@ -3155,9 +3001,13 @@ export = CatalogPlatformModel;
|
|
|
3155
3001
|
* @property {Object} [variant_group] - Variant group information for the product.
|
|
3156
3002
|
* @property {Object} [variant_media] - Media related to product variants.
|
|
3157
3003
|
* @property {Object} [variants] - Variants information for the product.
|
|
3004
|
+
* @property {string} [hs_code] - HS Code for the product. This is required for
|
|
3005
|
+
* indian companies.
|
|
3006
|
+
* @property {BundleDetails[]} [bundle_details] - List of bundle details for
|
|
3007
|
+
* products that are part of a bundle.
|
|
3158
3008
|
*/
|
|
3159
3009
|
/**
|
|
3160
|
-
* @typedef
|
|
3010
|
+
* @typedef ProductUpdateSchemaV3
|
|
3161
3011
|
* @property {Object} [_custom_json] - Custom JSON data that can be used for
|
|
3162
3012
|
* additional product properties.
|
|
3163
3013
|
* @property {string} [action] - The action to perform wrt to the product (e.g.,
|
|
@@ -3183,8 +3033,11 @@ export = CatalogPlatformModel;
|
|
|
3183
3033
|
* does not have associated images.
|
|
3184
3034
|
* @property {boolean} [is_set] - Flag to indicate if the product is part of a set.
|
|
3185
3035
|
* @property {string} item_code - Unique item code or SKU of the product.
|
|
3186
|
-
* @property {string} item_type -
|
|
3187
|
-
* composite, digital
|
|
3036
|
+
* @property {string} item_type - Specifies the type of product, such as
|
|
3037
|
+
* standard, set, composite, digital, virtual_bundle, or physical_bundle. For
|
|
3038
|
+
* bundle types (virtual_bundle or physical_bundle), use the category,
|
|
3039
|
+
* department, and brand of the base child SKU. In this case, attributes are
|
|
3040
|
+
* optional. The bundle_details attribute must be included for bundle types.
|
|
3188
3041
|
* @property {Media[]} [media] - List of media URLs (images, videos) associated
|
|
3189
3042
|
* with the product.
|
|
3190
3043
|
* @property {boolean} [multi_size] - Indicates if the product supports multiple sizes.
|
|
@@ -3204,75 +3057,76 @@ export = CatalogPlatformModel;
|
|
|
3204
3057
|
* @property {string} slug - URL-friendly identifier for the product.
|
|
3205
3058
|
* @property {string[]} [tags] - List of tags associated with the product.
|
|
3206
3059
|
* @property {TaxIdentifierV3} tax_identifier
|
|
3060
|
+
* @property {string} [hs_code] - HS Code for the product. This is required for
|
|
3061
|
+
* indian companies.
|
|
3207
3062
|
* @property {TeaserTag} [teaser_tag]
|
|
3208
3063
|
* @property {string} template_tag - Template tag for the product, used for
|
|
3209
3064
|
* classification.
|
|
3210
3065
|
* @property {Trader[]} trader - List of traders associated with the product.
|
|
3066
|
+
* @property {number} [uid] - Unique identifier for the product.
|
|
3211
3067
|
* @property {Object} [variant_group] - Variant group information for the product.
|
|
3212
3068
|
* @property {Object} [variant_media] - Media related to product variants.
|
|
3213
3069
|
* @property {Object} [variants] - Variants information for the product.
|
|
3214
|
-
* @property {
|
|
3215
|
-
*
|
|
3070
|
+
* @property {BundleDetails[]} [bundle_details] - List of bundle details for
|
|
3071
|
+
* products that are part of a bundle. This will have child skus along with
|
|
3072
|
+
* net quantity used in bundle formation.
|
|
3216
3073
|
*/
|
|
3217
3074
|
/**
|
|
3218
|
-
* @typedef
|
|
3075
|
+
* @typedef ProductPatchSchemaV3
|
|
3219
3076
|
* @property {Object} [_custom_json] - Custom JSON data that can be used for
|
|
3220
3077
|
* additional product properties.
|
|
3221
|
-
* @property {string} [action] - The action to perform wrt to the product (e.g.,
|
|
3222
|
-
* upsert, update, delete).
|
|
3223
3078
|
* @property {Object} [attributes] - Additional attributes related to the product.
|
|
3224
|
-
* @property {
|
|
3225
|
-
* @property {string} [bulk_job_id] - Job ID associated with bulk operations.
|
|
3226
|
-
* @property {string} category_slug - The category to which the product belongs.
|
|
3227
|
-
* @property {string} [change_request_id] - Change request identifier for product updates.
|
|
3228
|
-
* @property {number} company_id - Unique identifier for the company associated
|
|
3229
|
-
* with the product.
|
|
3230
|
-
* @property {string} country_of_origin - The country where the product was
|
|
3079
|
+
* @property {string} [country_of_origin] - The country where the product was
|
|
3231
3080
|
* manufactured or sourced.
|
|
3232
|
-
* @property {string} currency - The currency in which the product's price is listed.
|
|
3233
3081
|
* @property {CustomOrder} [custom_order]
|
|
3234
|
-
* @property {number[]} departments - List of department IDs associated with the product.
|
|
3235
3082
|
* @property {string} [description] - A detailed description of the product.
|
|
3083
|
+
* Provide base64 encoded value in input.
|
|
3236
3084
|
* @property {string[]} [highlights] - Product highlights or key features.
|
|
3237
3085
|
* @property {boolean} [is_active] - Flag to indicate if the product is active.
|
|
3238
3086
|
* @property {boolean} [is_dependent] - Flag to indicate if the product is
|
|
3239
3087
|
* dependent on other products.
|
|
3240
|
-
* @property {boolean} [is_image_less_product] - Flag to indicate if the product
|
|
3241
|
-
* does not have associated images.
|
|
3242
|
-
* @property {boolean} [is_set] - Flag to indicate if the product is part of a set.
|
|
3243
|
-
* @property {string} item_code - Unique item code or SKU of the product.
|
|
3244
|
-
* @property {string} item_type - Type of the product (e.g., standard, set,
|
|
3245
|
-
* composite, digital).
|
|
3246
3088
|
* @property {Media[]} [media] - List of media URLs (images, videos) associated
|
|
3247
3089
|
* with the product.
|
|
3248
3090
|
* @property {boolean} [multi_size] - Indicates if the product supports multiple sizes.
|
|
3249
|
-
* @property {string} name - The name of the product.
|
|
3091
|
+
* @property {string} [name] - The name of the product.
|
|
3250
3092
|
* @property {NetQuantity} [net_quantity]
|
|
3251
3093
|
* @property {number} [no_of_boxes] - Number of boxes required to package the product.
|
|
3252
3094
|
* @property {string[]} [product_group_tag] - Tags to group products together
|
|
3253
3095
|
* for classification.
|
|
3254
3096
|
* @property {ProductPublish} [product_publish]
|
|
3255
|
-
* @property {
|
|
3256
|
-
* (admin or user).
|
|
3257
|
-
* @property {ReturnConfig} return_config
|
|
3097
|
+
* @property {ReturnConfig} [return_config]
|
|
3258
3098
|
* @property {string} [short_description] - A short description of the product,
|
|
3259
3099
|
* up to 50 characters.
|
|
3260
3100
|
* @property {string} [size_guide] - Identifier for the product's size guide.
|
|
3261
|
-
* @property {
|
|
3262
|
-
* @property {string} slug - URL-friendly identifier for the product.
|
|
3101
|
+
* @property {ProductSizePatch[]} [sizes] - List of sizes available for the product.
|
|
3263
3102
|
* @property {string[]} [tags] - List of tags associated with the product.
|
|
3264
|
-
* @property {TaxIdentifierV3} tax_identifier
|
|
3103
|
+
* @property {TaxIdentifierV3} [tax_identifier]
|
|
3265
3104
|
* @property {string} [hs_code] - HS Code for the product. This is required for
|
|
3266
3105
|
* indian companies.
|
|
3267
3106
|
* @property {TeaserTag} [teaser_tag]
|
|
3268
|
-
* @property {string} template_tag - Template tag for the product, used for
|
|
3107
|
+
* @property {string} [template_tag] - Template tag for the product, used for
|
|
3269
3108
|
* classification.
|
|
3270
|
-
* @property {Trader[]} trader - List of traders associated with the product.
|
|
3271
|
-
* @property {number} [uid] - Unique identifier for the product.
|
|
3109
|
+
* @property {Trader[]} [trader] - List of traders associated with the product.
|
|
3272
3110
|
* @property {Object} [variant_group] - Variant group information for the product.
|
|
3273
3111
|
* @property {Object} [variant_media] - Media related to product variants.
|
|
3274
3112
|
* @property {Object} [variants] - Variants information for the product.
|
|
3275
3113
|
*/
|
|
3114
|
+
/**
|
|
3115
|
+
* @typedef ProductSizePatch
|
|
3116
|
+
* @property {number} [item_width] - Width of the item in the specified dimension unit.
|
|
3117
|
+
* @property {number} [item_height] - Height of the item in the specified dimension unit.
|
|
3118
|
+
* @property {number} [item_weight] - Weight of the item in the specified weight unit.
|
|
3119
|
+
* @property {number} [price] - Listed price of the product before discounts.
|
|
3120
|
+
* @property {boolean} [track_inventory] - Indicates whether inventory tracking
|
|
3121
|
+
* is enabled for this item.
|
|
3122
|
+
* @property {Object} [_custom_json] - Custom attributes or additional metadata
|
|
3123
|
+
* for the product.
|
|
3124
|
+
* @property {string} [seller_identifier] - Unique identifier assigned by the
|
|
3125
|
+
* seller for this product or size variant.
|
|
3126
|
+
* @property {number} [item_length] - Length of the item in the specified dimension unit.
|
|
3127
|
+
* @property {number} [price_effective] - Effective or discounted price after
|
|
3128
|
+
* applying promotions.
|
|
3129
|
+
*/
|
|
3276
3130
|
/**
|
|
3277
3131
|
* @typedef ProductDetail
|
|
3278
3132
|
* @property {Object} [attributes] - Key-value pairs representing various
|
|
@@ -3656,6 +3510,9 @@ export = CatalogPlatformModel;
|
|
|
3656
3510
|
* typically used in business transactions.
|
|
3657
3511
|
* @property {boolean} [track_inventory] - Indicates if inventory is being
|
|
3658
3512
|
* tracked for this size.
|
|
3513
|
+
* @property {BundleDetails[]} [bundle_details] - List of bundle details for
|
|
3514
|
+
* products that are part of a bundle. This will have child skus along with
|
|
3515
|
+
* net quantity used in bundle formation.
|
|
3659
3516
|
*/
|
|
3660
3517
|
/**
|
|
3661
3518
|
* @typedef ProductSchemaV2
|
|
@@ -3713,7 +3570,8 @@ export = CatalogPlatformModel;
|
|
|
3713
3570
|
* @property {string} [item_code] - Unique code used to identify the product,
|
|
3714
3571
|
* often used internally or by sellers.
|
|
3715
3572
|
* @property {string} [item_type] - Describes the type of product (e.g.,
|
|
3716
|
-
* "standard" or "set").
|
|
3573
|
+
* "standard" or "set"). In case of bundle items type will be
|
|
3574
|
+
* ("virtual_bundle" or "physical_bundle")
|
|
3717
3575
|
* @property {string[]} [l3_mapping] - Hierarchical mapping of the product to
|
|
3718
3576
|
* categories (e.g., "electronics>qled_television").
|
|
3719
3577
|
* @property {Media[]} [media] - Media assets associated with the product, such
|
|
@@ -4799,7 +4657,7 @@ export = CatalogPlatformModel;
|
|
|
4799
4657
|
declare class CatalogPlatformModel {
|
|
4800
4658
|
}
|
|
4801
4659
|
declare namespace CatalogPlatformModel {
|
|
4802
|
-
export { Action, ValidationErrors, AllSizes, AllowSingleRequestSchema, AppCatalogConfiguration, AppCategoryReturnConfig, AppCategoryReturnConfigResponseSchema, AppConfiguration, AppConfigurationDetail, AppConfigurationsSort, ApplicationBrandJson, ApplicationCategoryJson, ApplicationDepartment, ApplicationDepartmentJson, ApplicationDepartmentListingResponseSchema, ApplicationItemMOQ, Scores, ApplicationItemMeta, ApplicationItemSeoSitemap, ApplicationItemSEO, ApplicationProductsSchema, ApplicationProductListingResponseSchema, ApplicationStoreJson, AppReturnConfigResponseSchema, ArticleAssignment, ArticleAssignment1, ArticleQuery, ArticleStoreResponseSchema, AssignStore, AssignStoreArticle, AttributeDetailsGroup, AttributeMaster, AttributeMasterDetails, AttributeMasterFilter, AttributeMasterMandatoryDetails, AttributeMasterMeta, AttributeMasterSchema, AttributeSchemaRange, AutoCompleteMedia, AutocompleteAction, AutocompletePageAction, AutocompleteResult, BannerImage, BaseAppCategoryReturnConfig, BaseAppCategoryReturnConfigResponseSchema, Brand, BrandItem, BrandListingResponseSchema, ApplicationBrandListingItemSchema, ApplicationBrandListingSchema, ApplicationCategoryListingSchema, ApplicationCategoryListingItemSchema, BrandMeta, InventoryBrandMeta, BulkAssetResponseSchema, BulkHsnResponseSchema, BulkHsnUpsert, BulkInventoryGet, FailedRecord, BulkInventoryGetItems, BulkMeta, BulkProductJob, BulkJob, BulkProductRequestSchema, BulkResponseSchema, CatalogInsightBrand, CatalogInsightItem, CatalogInsightResponseSchema, CategoriesResponseSchema, Category, CategoryItems, CategoryListingResponseSchema, CategoryMapping, CategoryMappingValues, CategoryResponseSchema, Child, CollectionBadge, CollectionBanner, CollectionCreateResponseSchema, CollectionDetailResponseSchema, CollectionImage, CollectionItem, CollectionItemUpdate, CollectionListingFilter, CollectionListingFilterTag, CollectionListingFilterType, CollectionQuery, CollectionSchedule, CompanyBrandDetail, CompanyMeta, InventoryCompanyMeta, CompanyOptIn, ConfigErrorResponseSchema, ConfigSuccessResponseSchema, ConfigurationBucketPoints, ConfigurationListing, ConfigurationListingFilter, ConfigurationListingFilterConfig, ConfigurationListingFilterValue, ConfigurationListingSort, ConfigurationListingSortConfig, ConfigurationProduct, ConfigurationProductConfig, ConfigurationProductSimilar, ConfigurationProductVariant, ConfigurationProductVariantConfig, CreateAutocompleteKeyword, CreateAutocompleteWordsResponseSchema, CreateCollection, CreateSearchConfigurationRequestSchema, CreateSearchConfigurationResponseSchema, CreateSearchKeyword, CreateUpdateAppReturnConfig, CrossSellingData, CrossSellingResponseSchema, CustomOrder, DateMeta, DefaultKeyRequestSchema, DeleteAppCategoryReturnConfig, DeleteResponseSchema, DeleteSearchConfigurationResponseSchema, Department, DepartmentCategoryTree, DepartmentErrorResponseSchema, DepartmentIdentifier, DepartmentResponseSchema, DepartmentsResponseSchema, DimensionResponseSchema, InventoryDimensionResponseSchema, Document, EntityConfiguration, ErrorResponseSchema, FilerList, RawProduct, RawProductListingResponseSchema, GTIN, AttributeDetail, LatLong, ApplicationLocationAddressSchema, GetAddressSchema, GetAllSizes, GetAppCatalogConfiguration, GetAppCatalogEntityConfiguration, GetAutocompleteWordsData, GetAutocompleteWordsResponseSchema, GetCatalogConfigurationDetailsProduct, GetCatalogConfigurationDetailsSchemaListing, GetCatalogConfigurationMetaData, GetCollectionDetailNest, GetCollectionItemsResponseSchema, GetCollectionListingResponseSchema, GetCollectionQueryOptionResponseSchema, GetCompanySchema, ConditionItem, DataItem, ValueTypeItem, SortTypeItem, GetConfigMetadataResponseSchema, GetConfigMetadataValues, GetConfigResponseSchema, ConfigItem, AttributeConfig, GetDepartment, GetInventories, GetInventoriesResponseSchema, GetLocationSchema, GetOptInPlatform, GetProductBundleCreateResponseSchema, GetProductBundleListingResponseSchema, GetProductBundleResponseSchema, GetProducts, ProductDetails, GetCollectionDetailResponseSchema, CommonResponseSchemaCollection, GetQueryFiltersKeysResponseSchema, GetQueryFiltersResponseSchema, GetCollectionItemsResponseSchemaV2, Page1, CollectionItemSchemaV2, CollectionItemUpdateSchema, CollectionQuerySchemaV2, ProductDetailV2, GetSearchConfigurationResponseSchema, GetSearchWordsData, GetSearchWordsDetailResponseSchema, GetSearchWordsResponseSchema, GlobalValidation, Guide, HSNCodesResponseSchema, HSNData, CreatedBySchema, ModifiedBySchema, HSNDataInsertV2, Hierarchy, HsnCode, HsnCodesListingResponseSchemaV2, HsnCodesObject, HsnUpsert, Image, ImageUrls, InvSize, InventoryBulkRequestSchema, InventoryConfig, InventoryCreateRequestSchema, InventoryExportAdvanceOption, InventoryExportFilter, InventoryExportJob, InventoryExportJobListResponseSchema, InventoryExportQuantityFilter, InventoryExportRequestSchema, InventoryExportResponseSchema, InventoryFailedReason, InventoryJobDetailResponseSchema, InventoryJobFilters, InventoryJobPayload, InventoryPage, AddInventoryRequestPayload, InventoryPayload, InventoryRequestSchema, InventoryRequestSchemaV2, InventoryResponseSchema, InventoryResponseItem, InventoryResponsePaginated, InventorySellerIdentifierResponsePaginated, ApplicationInventorySellerIdentifierResponsePaginated, InventorySellerResponseSchema, ApplicationInventorySellerResponseSchema, InventorySet, InventoryStockResponseSchema, InventoryUpdateResponseSchema, InventoryValidationResponseSchema, InvoiceCredSchema, InvoiceDetailsSchema, ItemQuery, Items, LimitedProductData, SizeGuideItem, ListSizeGuide, LocationDayWiseSchema, LocationIntegrationType, LocationListSchema, LocationManagerSchema, LocationTimingSchema, Logo, MOQData, ManufacturerResponseSchema, InventoryManufacturerResponseSchema, Media, Media1, DepartmentMedia, BrandMedia, Meta, MetaDataListingFilterMetaResponseSchema, MetaDataListingFilterResponseSchema, MetaDataListingResponseSchema, MetaDataListingSortMetaResponseSchema, MetaDataListingSortResponseSchema, MetaFields, NetQuantity, NetQuantityResponseSchema, NextSchedule, LocationPriceRequestSchema, LocationQuantityRequestSchema, LocationPriceQuantitySuccessResponseSchema, OptInPostRequestSchema, OptinCompanyBrandDetailsView, OptinCompanyDetail, OptinCompanyMetrics, OptinStoreDetails, OwnerAppItemResponseSchema, PTErrorResponseSchema, Page, PageResponseSchema, PageResponseType, Price, ProductListingDetailPrice, PriceArticle, PriceMeta, ProdcutTemplateCategoriesResponseSchema, Product, ProductAttributesResponseSchema, ProductBrand, ProductBulkAssets, ProductBulkRequestSchema, ProductBulkRequestList, ProductBundleItem, ProductBundleRequestSchema, ProductBundleUpdateRequestSchema, ProductConfigurationDownloads, ProductUpdateSchemaV2, ProductCreateSchemaV2, ProductCreateSchemaV3, ProductUpdateSchemaV3, ProductDetail, ProductDetailAttribute, ProductDetailGroupedAttribute, ProductDownloadsResponseSchema, CollectionProductFilters, ProductFilters, GetQueryFiltersValuesResponseSchema, ProductFiltersKeysOnly, ProductFiltersKey, ProductQueryFiltersValue, CollectionProductFiltersValue, ProductFiltersValue, CollectionProductListingDetail, ProductCategory, ApplicationCategoryAction, ApplicationCategoryItem, ApplicationProductMedia, ApplicationProductCategoryItem, CategoryPageAction, CategoryQuery, CategoryImage, ProductListingDetail, ActionObject, PageAction, ProductListingPrice, ProductListingResponseSchema, ProductListingResponseV2, ProductPublish, ProductPublished, ProductReturnConfigSchema, ProductReturnConfigBaseSchema, Identifier, SizeDetails, ProductSchemaV2, ProductSize, ProductSizeDeleteDataResponseSchema, ProductSizeDeleteResponseSchema, CollectionProductSortOn, ProductSortOn, ProductTagsViewResponseSchema, CreatedBy, ModifiedBy, ProductTemplate, ProductTemplateDownloadsExport, ProductTemplateExportFilterRequestSchema, ProductTemplateExportResponseSchema, ProductVariants, ProductVariantsResponseSchema, Properties, Quantities, QuantitiesArticle, Quantity, QuantityBase, ReturnConfig, InventoryReturnConfig, ReturnConfig2, ReturnConfigResponseSchema, Sitemap, PageQuery, ApplicationCollectionItemSeoPage, ApplicationCollectionItemSeoAction, ApplicationItemSeoAction, ApplicationItemSeoBreadcrumbs, ApplicationCollectionItemSeoBreadcrumbs, ApplicationItemSeoMetaTagItem, ApplicationItemSeoMetaTags, Metatags, SizePromotionThreshold, SEOData, SearchKeywordResult, SearchableAttribute, SecondLevelChild, SellerPhoneNumber, CollectionSeoDetail, SeoDetail, SetSize, SingleCategoryResponseSchema, SingleProductResponseSchema, Size, SizeDistribution, SizeGuideResponseSchema, StoreAssignResponseSchema, StoreDetail, StoreMeta, SuccessResponseSchema, SuccessResponseObject, TaxIdentifier, TaxIdentifierV3, TaxSlab, TeaserTag, TemplateDetails, TemplateGlobalValidationData, TemplateValidationData, TemplatesResponseSchema, TemplatesGlobalValidationResponseSchema, TemplatesValidationResponseSchema, ThirdLevelChild, Trader, Trader1, TraderResponseSchema, UpdateCollection, UpdateSearchConfigurationRequestSchema, UpdateSearchConfigurationResponseSchema, CreateMarketplaceOptinResponseSchema, UserCommon, UserDetail, UserDetail1, UserInfo, UserSchema, RequestUserSchema, ValidateIdentifier, ValidateProduct, ValidateSizeGuide, VerifiedBy, WeightResponseSchema, InventoryWeightResponseSchema, BulkInventoryJob, Marketplaces, GetAllMarketplaces, UpdateMarketplaceOptinRequestSchema, UpdateMarketplaceOptinResponseSchema, Filters, FollowedProducts, FollowProduct, TaxReqBodyRule, TaxThreshold, TaxComponent, TaxComponentResponseSchema, TaxComponentName, CreateTaxComponentNameRequestSchema, TaxReqBodyVersion, CreateTaxRequestBody, TaxVersion, UpdateTaxVersionRequestBody, CreateTaxVersionRequestBody, TaxRule, TaxVersionDetail, CreateTax, UpdateTaxVersion, UpdateTaxRequestBody, TaxRuleItem, TaxRules, TaxVersionPastData, TaxRuleVersion, HSCodeItem, HSCodes, GetTaxComponents, ActionPage, ValidationError, Price1, MultiCategoriesSchema, NetQuantitySchema, CustomMeta, TaxStatusEnum, HsTypeEnum, PageType };
|
|
4660
|
+
export { Action, ValidationErrors, AllSizes, AllowSingleRequestSchema, AppCatalogConfiguration, AppCategoryReturnConfig, AppCategoryReturnConfigResponseSchema, AppConfiguration, AppConfigurationDetail, AppConfigurationsSort, ApplicationBrandJson, ApplicationCategoryJson, ApplicationDepartment, ApplicationDepartmentJson, ApplicationDepartmentListingResponseSchema, ApplicationItemMOQ, Scores, ApplicationItemMeta, ApplicationItemSeoSitemap, ApplicationItemSEO, ApplicationProductsSchema, ApplicationProductListingResponseSchema, ApplicationStoreJson, AppReturnConfigResponseSchema, ArticleAssignment, ArticleAssignment1, ArticleQuery, ArticleStoreResponseSchema, AssignStore, AssignStoreArticle, AttributeDetailsGroup, AttributeMaster, AttributeMasterDetails, AttributeMasterFilter, AttributeMasterMandatoryDetails, AttributeMasterMeta, AttributeMasterSchema, AttributeSchemaRange, AutoCompleteMedia, AutocompleteAction, AutocompletePageAction, AutocompleteResult, BannerImage, BaseAppCategoryReturnConfig, BaseAppCategoryReturnConfigResponseSchema, Brand, BrandItem, BrandListingResponseSchema, ApplicationBrandListingItemSchema, ApplicationBrandListingSchema, ApplicationCategoryListingSchema, ApplicationCategoryListingItemSchema, BrandMeta, InventoryBrandMeta, BulkAssetResponseSchema, BulkHsnResponseSchema, BulkHsnUpsert, BulkInventoryGet, FailedRecord, BulkInventoryGetItems, BulkMeta, BulkProductJob, BulkJob, BulkProductRequestSchema, BulkResponseSchema, CatalogInsightBrand, CatalogInsightItem, CatalogInsightResponseSchema, CategoriesResponseSchema, Category, CategoryItems, CategoryListingResponseSchema, CategoryMapping, CategoryMappingValues, CategoryResponseSchema, Child, CollectionBadge, CollectionBanner, CollectionCreateResponseSchema, CollectionDetailResponseSchema, CollectionImage, CollectionItem, CollectionItemUpdate, CollectionListingFilter, CollectionListingFilterTag, CollectionListingFilterType, CollectionQuery, CollectionSchedule, CompanyBrandDetail, CompanyMeta, InventoryCompanyMeta, CompanyOptIn, ConfigErrorResponseSchema, ConfigSuccessResponseSchema, ConfigurationBucketPoints, ConfigurationListing, ConfigurationListingFilter, ConfigurationListingFilterConfig, ConfigurationListingFilterValue, ConfigurationListingSort, ConfigurationListingSortConfig, ConfigurationProduct, ConfigurationProductConfig, ConfigurationProductSimilar, ConfigurationProductVariant, ConfigurationProductVariantConfig, CreateAutocompleteKeyword, CreateAutocompleteWordsResponseSchema, CreateCollection, CreateSearchConfigurationRequestSchema, CreateSearchConfigurationResponseSchema, CreateSearchKeyword, CreateUpdateAppReturnConfig, CrossSellingData, CrossSellingResponseSchema, CustomOrder, DateMeta, DefaultKeyRequestSchema, DeleteAppCategoryReturnConfig, DeleteResponseSchema, DeleteSearchConfigurationResponseSchema, Department, DepartmentCategoryTree, DepartmentErrorResponseSchema, DepartmentIdentifier, DepartmentResponseSchema, DepartmentsResponseSchema, DimensionResponseSchema, InventoryDimensionResponseSchema, Document, EntityConfiguration, ErrorResponseSchema, FilerList, RawProduct, RawProductListingResponseSchema, GTIN, AttributeDetail, LatLong, ApplicationLocationAddressSchema, GetAddressSchema, GetAllSizes, GetAppCatalogConfiguration, GetAppCatalogEntityConfiguration, GetAutocompleteWordsData, GetAutocompleteWordsResponseSchema, GetCatalogConfigurationDetailsProduct, GetCatalogConfigurationDetailsSchemaListing, GetCatalogConfigurationMetaData, GetCollectionDetailNest, GetCollectionItemsResponseSchema, GetCollectionListingResponseSchema, GetCollectionQueryOptionResponseSchema, GetCompanySchema, ConditionItem, DataItem, ValueTypeItem, SortTypeItem, GetConfigMetadataResponseSchema, GetConfigMetadataValues, GetConfigResponseSchema, ConfigItem, AttributeConfig, GetDepartment, GetInventories, GetInventoriesResponseSchema, GetLocationSchema, GetOptInPlatform, GetProducts, ProductDetails, GetCollectionDetailResponseSchema, CommonResponseSchemaCollection, GetQueryFiltersKeysResponseSchema, GetQueryFiltersResponseSchema, GetCollectionItemsResponseSchemaV2, Page1, CollectionItemSchemaV2, CollectionItemUpdateSchema, CollectionQuerySchemaV2, ProductDetailV2, GetSearchConfigurationResponseSchema, GetSearchWordsData, GetSearchWordsDetailResponseSchema, GetSearchWordsResponseSchema, GlobalValidation, Guide, HSNCodesResponseSchema, HSNData, CreatedBySchema, ModifiedBySchema, HSNDataInsertV2, Hierarchy, HsnCode, HsnCodesListingResponseSchemaV2, HsnCodesObject, HsnUpsert, Image, ImageUrls, InvSize, InventoryBulkRequestSchema, InventoryConfig, InventoryCreateRequestSchema, InventoryExportAdvanceOption, InventoryExportFilter, InventoryExportJob, InventoryExportJobListResponseSchema, InventoryExportQuantityFilter, InventoryExportRequestSchema, InventoryExportResponseSchema, InventoryFailedReason, InventoryJobDetailResponseSchema, InventoryJobFilters, InventoryJobPayload, InventoryPage, AddInventoryRequestPayload, InventoryPayload, InventoryRequestSchema, InventoryRequestSchemaV2, InventoryResponseSchema, InventoryResponseItem, InventoryResponsePaginated, InventorySellerIdentifierResponsePaginated, ApplicationInventorySellerIdentifierResponsePaginated, InventorySellerResponseSchema, ApplicationInventorySellerResponseSchema, InventorySet, InventoryStockResponseSchema, InventoryUpdateResponseSchema, InventoryValidationResponseSchema, InvoiceCredSchema, InvoiceDetailsSchema, ItemQuery, Items, LimitedProductData, SizeGuideItem, ListSizeGuide, LocationDayWiseSchema, LocationIntegrationType, LocationListSchema, LocationManagerSchema, LocationTimingSchema, Logo, MOQData, ManufacturerResponseSchema, InventoryManufacturerResponseSchema, Media, Media1, DepartmentMedia, BrandMedia, BundleDetails, Meta, MetaDataListingFilterMetaResponseSchema, MetaDataListingFilterResponseSchema, MetaDataListingResponseSchema, MetaDataListingSortMetaResponseSchema, MetaDataListingSortResponseSchema, MetaFields, NetQuantity, NetQuantityResponseSchema, NextSchedule, LocationPriceRequestSchema, LocationQuantityRequestSchema, LocationPriceQuantitySuccessResponseSchema, OptInPostRequestSchema, OptinCompanyBrandDetailsView, OptinCompanyDetail, OptinCompanyMetrics, OptinStoreDetails, OwnerAppItemResponseSchema, PTErrorResponseSchema, Page, PageResponseSchema, PageResponseType, Price, ProductListingDetailPrice, PriceArticle, PriceMeta, ProdcutTemplateCategoriesResponseSchema, Product, ProductAttributesResponseSchema, ProductBrand, ProductBulkAssets, ProductBulkRequestSchema, ProductBulkRequestList, ProductConfigurationDownloads, ProductCreateSchemaV3, ProductUpdateSchemaV3, ProductPatchSchemaV3, ProductSizePatch, ProductDetail, ProductDetailAttribute, ProductDetailGroupedAttribute, ProductDownloadsResponseSchema, CollectionProductFilters, ProductFilters, GetQueryFiltersValuesResponseSchema, ProductFiltersKeysOnly, ProductFiltersKey, ProductQueryFiltersValue, CollectionProductFiltersValue, ProductFiltersValue, CollectionProductListingDetail, ProductCategory, ApplicationCategoryAction, ApplicationCategoryItem, ApplicationProductMedia, ApplicationProductCategoryItem, CategoryPageAction, CategoryQuery, CategoryImage, ProductListingDetail, ActionObject, PageAction, ProductListingPrice, ProductListingResponseSchema, ProductListingResponseV2, ProductPublish, ProductPublished, ProductReturnConfigSchema, ProductReturnConfigBaseSchema, Identifier, SizeDetails, ProductSchemaV2, ProductSize, ProductSizeDeleteDataResponseSchema, ProductSizeDeleteResponseSchema, CollectionProductSortOn, ProductSortOn, ProductTagsViewResponseSchema, CreatedBy, ModifiedBy, ProductTemplate, ProductTemplateDownloadsExport, ProductTemplateExportFilterRequestSchema, ProductTemplateExportResponseSchema, ProductVariants, ProductVariantsResponseSchema, Properties, Quantities, QuantitiesArticle, Quantity, QuantityBase, ReturnConfig, InventoryReturnConfig, ReturnConfig2, ReturnConfigResponseSchema, Sitemap, PageQuery, ApplicationCollectionItemSeoPage, ApplicationCollectionItemSeoAction, ApplicationItemSeoAction, ApplicationItemSeoBreadcrumbs, ApplicationCollectionItemSeoBreadcrumbs, ApplicationItemSeoMetaTagItem, ApplicationItemSeoMetaTags, Metatags, SizePromotionThreshold, SEOData, SearchKeywordResult, SearchableAttribute, SecondLevelChild, SellerPhoneNumber, CollectionSeoDetail, SeoDetail, SetSize, SingleCategoryResponseSchema, SingleProductResponseSchema, Size, SizeDistribution, SizeGuideResponseSchema, StoreAssignResponseSchema, StoreDetail, StoreMeta, SuccessResponseSchema, SuccessResponseObject, TaxIdentifier, TaxIdentifierV3, TaxSlab, TeaserTag, TemplateDetails, TemplateGlobalValidationData, TemplateValidationData, TemplatesResponseSchema, TemplatesGlobalValidationResponseSchema, TemplatesValidationResponseSchema, ThirdLevelChild, Trader, Trader1, TraderResponseSchema, UpdateCollection, UpdateSearchConfigurationRequestSchema, UpdateSearchConfigurationResponseSchema, CreateMarketplaceOptinResponseSchema, UserCommon, UserDetail, UserDetail1, UserInfo, UserSchema, RequestUserSchema, ValidateIdentifier, ValidateProduct, ValidateSizeGuide, VerifiedBy, WeightResponseSchema, InventoryWeightResponseSchema, BulkInventoryJob, Marketplaces, GetAllMarketplaces, UpdateMarketplaceOptinRequestSchema, UpdateMarketplaceOptinResponseSchema, Filters, FollowedProducts, FollowProduct, TaxReqBodyRule, TaxThreshold, TaxComponent, TaxComponentResponseSchema, TaxComponentName, CreateTaxComponentNameRequestSchema, TaxReqBodyVersion, CreateTaxRequestBody, TaxVersion, UpdateTaxVersionRequestBody, CreateTaxVersionRequestBody, TaxRule, TaxVersionDetail, CreateTax, UpdateTaxVersion, UpdateTaxRequestBody, TaxRuleItem, TaxRules, TaxVersionPastData, TaxRuleVersion, HSCodeItem, HSCodes, GetTaxComponents, ActionPage, ValidationError, Price1, MultiCategoriesSchema, NetQuantitySchema, CustomMeta, TaxStatusEnum, HsTypeEnum, PageType };
|
|
4803
4661
|
}
|
|
4804
4662
|
/** @returns {Action} */
|
|
4805
4663
|
declare function Action(): Action;
|
|
@@ -8391,126 +8249,6 @@ type GetOptInPlatform = {
|
|
|
8391
8249
|
items: CompanyOptIn[];
|
|
8392
8250
|
page: Page;
|
|
8393
8251
|
};
|
|
8394
|
-
/** @returns {GetProductBundleCreateResponseSchema} */
|
|
8395
|
-
declare function GetProductBundleCreateResponseSchema(): GetProductBundleCreateResponseSchema;
|
|
8396
|
-
type GetProductBundleCreateResponseSchema = {
|
|
8397
|
-
/**
|
|
8398
|
-
* - Specifies the type of bundle, e.g., single or multi.
|
|
8399
|
-
*/
|
|
8400
|
-
choice: string;
|
|
8401
|
-
/**
|
|
8402
|
-
* - Unique identifier for the company that owns
|
|
8403
|
-
* the product bundle.
|
|
8404
|
-
*/
|
|
8405
|
-
company_id?: number;
|
|
8406
|
-
created_by?: CreatedBy;
|
|
8407
|
-
/**
|
|
8408
|
-
* - Timestamp when the product bundle was created.
|
|
8409
|
-
*/
|
|
8410
|
-
created_on?: string;
|
|
8411
|
-
/**
|
|
8412
|
-
* - Unique identifier for the product bundle.
|
|
8413
|
-
*/
|
|
8414
|
-
id?: string;
|
|
8415
|
-
/**
|
|
8416
|
-
* - Indicates if the product bundle is active or not.
|
|
8417
|
-
*/
|
|
8418
|
-
is_active: boolean;
|
|
8419
|
-
/**
|
|
8420
|
-
* - URL of the product bundle's logo, or null if not available.
|
|
8421
|
-
*/
|
|
8422
|
-
logo?: string;
|
|
8423
|
-
/**
|
|
8424
|
-
* - Additional metadata about the product bundle.
|
|
8425
|
-
*/
|
|
8426
|
-
meta?: any;
|
|
8427
|
-
modified_by?: ModifiedBy;
|
|
8428
|
-
/**
|
|
8429
|
-
* - Timestamp when the product bundle was last modified.
|
|
8430
|
-
*/
|
|
8431
|
-
modified_on?: string;
|
|
8432
|
-
/**
|
|
8433
|
-
* - Name of the product bundle.
|
|
8434
|
-
*/
|
|
8435
|
-
name: string;
|
|
8436
|
-
/**
|
|
8437
|
-
* - Visibility settings for the product
|
|
8438
|
-
* bundle across different pages.
|
|
8439
|
-
*/
|
|
8440
|
-
page_visibility?: string[];
|
|
8441
|
-
/**
|
|
8442
|
-
* - List of products that are part of
|
|
8443
|
-
* the product bundle.
|
|
8444
|
-
*/
|
|
8445
|
-
products: ProductBundleItem[];
|
|
8446
|
-
/**
|
|
8447
|
-
* - Indicates whether all products
|
|
8448
|
-
* in the bundle belong to the same store.
|
|
8449
|
-
*/
|
|
8450
|
-
same_store_assignment?: boolean;
|
|
8451
|
-
/**
|
|
8452
|
-
* - Unique slug used to identify the product bundle in URLs.
|
|
8453
|
-
*/
|
|
8454
|
-
slug: string;
|
|
8455
|
-
};
|
|
8456
|
-
/** @returns {GetProductBundleListingResponseSchema} */
|
|
8457
|
-
declare function GetProductBundleListingResponseSchema(): GetProductBundleListingResponseSchema;
|
|
8458
|
-
type GetProductBundleListingResponseSchema = {
|
|
8459
|
-
/**
|
|
8460
|
-
* - List of product
|
|
8461
|
-
* bundles that are returned in the response.
|
|
8462
|
-
*/
|
|
8463
|
-
items?: GetProductBundleCreateResponseSchema[];
|
|
8464
|
-
page?: Page;
|
|
8465
|
-
};
|
|
8466
|
-
/** @returns {GetProductBundleResponseSchema} */
|
|
8467
|
-
declare function GetProductBundleResponseSchema(): GetProductBundleResponseSchema;
|
|
8468
|
-
type GetProductBundleResponseSchema = {
|
|
8469
|
-
/**
|
|
8470
|
-
* - Specifies the type of product bundle, e.g.,
|
|
8471
|
-
* 'single' or 'multi'.
|
|
8472
|
-
*/
|
|
8473
|
-
choice?: string;
|
|
8474
|
-
/**
|
|
8475
|
-
* - The unique identifier of the company that
|
|
8476
|
-
* owns the product bundle.
|
|
8477
|
-
*/
|
|
8478
|
-
company_id?: number;
|
|
8479
|
-
/**
|
|
8480
|
-
* - Indicates whether the product bundle is active.
|
|
8481
|
-
*/
|
|
8482
|
-
is_active?: boolean;
|
|
8483
|
-
/**
|
|
8484
|
-
* - URL of the logo associated with the product bundle.
|
|
8485
|
-
*/
|
|
8486
|
-
logo?: string;
|
|
8487
|
-
/**
|
|
8488
|
-
* - Additional metadata for the product bundle.
|
|
8489
|
-
*/
|
|
8490
|
-
meta?: any;
|
|
8491
|
-
/**
|
|
8492
|
-
* - The name of the product bundle.
|
|
8493
|
-
*/
|
|
8494
|
-
name?: string;
|
|
8495
|
-
/**
|
|
8496
|
-
* - List of pages where the product
|
|
8497
|
-
* bundle is visible, e.g., 'pdp'.
|
|
8498
|
-
*/
|
|
8499
|
-
page_visibility?: string[];
|
|
8500
|
-
/**
|
|
8501
|
-
* - A list of products included in the bundle.
|
|
8502
|
-
*/
|
|
8503
|
-
products?: GetProducts[];
|
|
8504
|
-
/**
|
|
8505
|
-
* - Indicates whether all products
|
|
8506
|
-
* in the bundle are assigned to the same store.
|
|
8507
|
-
*/
|
|
8508
|
-
same_store_assignment?: boolean;
|
|
8509
|
-
/**
|
|
8510
|
-
* - Unique URL-friendly identifier for the product bundle.
|
|
8511
|
-
*/
|
|
8512
|
-
slug?: string;
|
|
8513
|
-
};
|
|
8514
8252
|
/** @returns {GetProducts} */
|
|
8515
8253
|
declare function GetProducts(): GetProducts;
|
|
8516
8254
|
type GetProducts = {
|
|
@@ -10437,6 +10175,23 @@ type BrandMedia = {
|
|
|
10437
10175
|
*/
|
|
10438
10176
|
url?: string;
|
|
10439
10177
|
};
|
|
10178
|
+
/** @returns {BundleDetails} */
|
|
10179
|
+
declare function BundleDetails(): BundleDetails;
|
|
10180
|
+
type BundleDetails = {
|
|
10181
|
+
/**
|
|
10182
|
+
* - Seller identifier of child sku.
|
|
10183
|
+
*/
|
|
10184
|
+
seller_identifier: string;
|
|
10185
|
+
/**
|
|
10186
|
+
* - The net quantity of the product in the bundle.
|
|
10187
|
+
*/
|
|
10188
|
+
net_quantity: number;
|
|
10189
|
+
/**
|
|
10190
|
+
* - Indicates whether this product is the base
|
|
10191
|
+
* product in the bundle.
|
|
10192
|
+
*/
|
|
10193
|
+
is_base?: boolean;
|
|
10194
|
+
};
|
|
10440
10195
|
/** @returns {Meta} */
|
|
10441
10196
|
declare function Meta(): Meta;
|
|
10442
10197
|
type Meta = {
|
|
@@ -11105,226 +10860,72 @@ type ProductBulkRequestList = {
|
|
|
11105
10860
|
items?: any;
|
|
11106
10861
|
page?: Page;
|
|
11107
10862
|
};
|
|
11108
|
-
/** @returns {
|
|
11109
|
-
declare function
|
|
11110
|
-
type
|
|
10863
|
+
/** @returns {ProductConfigurationDownloads} */
|
|
10864
|
+
declare function ProductConfigurationDownloads(): ProductConfigurationDownloads;
|
|
10865
|
+
type ProductConfigurationDownloads = {
|
|
10866
|
+
data?: any[];
|
|
10867
|
+
multivalue?: boolean;
|
|
10868
|
+
};
|
|
10869
|
+
/** @returns {ProductCreateSchemaV3} */
|
|
10870
|
+
declare function ProductCreateSchemaV3(): ProductCreateSchemaV3;
|
|
10871
|
+
type ProductCreateSchemaV3 = {
|
|
11111
10872
|
/**
|
|
11112
|
-
* -
|
|
11113
|
-
*
|
|
10873
|
+
* - Custom JSON data that can be used for
|
|
10874
|
+
* additional product properties.
|
|
11114
10875
|
*/
|
|
11115
|
-
|
|
10876
|
+
_custom_json?: any;
|
|
11116
10877
|
/**
|
|
11117
|
-
* -
|
|
11118
|
-
*
|
|
10878
|
+
* - The action to perform wrt to the product (e.g.,
|
|
10879
|
+
* upsert, update, delete).
|
|
11119
10880
|
*/
|
|
11120
|
-
|
|
10881
|
+
action?: string;
|
|
11121
10882
|
/**
|
|
11122
|
-
* -
|
|
11123
|
-
* selected in the bundle.
|
|
10883
|
+
* - Additional attributes related to the product.
|
|
11124
10884
|
*/
|
|
11125
|
-
|
|
10885
|
+
attributes?: any;
|
|
11126
10886
|
/**
|
|
11127
|
-
* -
|
|
11128
|
-
* added to the bundle.
|
|
10887
|
+
* - Unique identifier for the product's brand.
|
|
11129
10888
|
*/
|
|
11130
|
-
|
|
10889
|
+
brand_uid: number;
|
|
11131
10890
|
/**
|
|
11132
|
-
* -
|
|
11133
|
-
* be added to the bundle.
|
|
10891
|
+
* - Job ID associated with bulk operations.
|
|
11134
10892
|
*/
|
|
11135
|
-
|
|
10893
|
+
bulk_job_id?: string;
|
|
11136
10894
|
/**
|
|
11137
|
-
* -
|
|
10895
|
+
* - The category to which the product belongs.
|
|
11138
10896
|
*/
|
|
11139
|
-
|
|
11140
|
-
};
|
|
11141
|
-
/** @returns {ProductBundleRequestSchema} */
|
|
11142
|
-
declare function ProductBundleRequestSchema(): ProductBundleRequestSchema;
|
|
11143
|
-
type ProductBundleRequestSchema = {
|
|
10897
|
+
category_slug: string;
|
|
11144
10898
|
/**
|
|
11145
|
-
* -
|
|
11146
|
-
* 'single' or 'multi').
|
|
10899
|
+
* - Change request identifier for product updates.
|
|
11147
10900
|
*/
|
|
11148
|
-
|
|
10901
|
+
change_request_id?: string;
|
|
11149
10902
|
/**
|
|
11150
|
-
* -
|
|
11151
|
-
*
|
|
10903
|
+
* - Unique identifier for the company associated
|
|
10904
|
+
* with the product.
|
|
11152
10905
|
*/
|
|
11153
|
-
company_id
|
|
10906
|
+
company_id: number;
|
|
11154
10907
|
/**
|
|
11155
|
-
* -
|
|
11156
|
-
*
|
|
10908
|
+
* - The country where the product was
|
|
10909
|
+
* manufactured or sourced.
|
|
11157
10910
|
*/
|
|
11158
|
-
|
|
10911
|
+
country_of_origin: string;
|
|
11159
10912
|
/**
|
|
11160
|
-
* - The
|
|
10913
|
+
* - The currency in which the product's price is listed.
|
|
11161
10914
|
*/
|
|
11162
|
-
|
|
10915
|
+
currency: string;
|
|
10916
|
+
custom_order?: CustomOrder;
|
|
11163
10917
|
/**
|
|
11164
|
-
* -
|
|
11165
|
-
* currently active.
|
|
10918
|
+
* - List of department IDs associated with the product.
|
|
11166
10919
|
*/
|
|
11167
|
-
|
|
10920
|
+
departments: number[];
|
|
11168
10921
|
/**
|
|
11169
|
-
* -
|
|
11170
|
-
* bundle, if available. Can be null.
|
|
10922
|
+
* - A detailed description of the product.
|
|
11171
10923
|
*/
|
|
11172
|
-
|
|
10924
|
+
description?: string;
|
|
11173
10925
|
/**
|
|
11174
|
-
* -
|
|
10926
|
+
* - Product highlights or key features.
|
|
11175
10927
|
*/
|
|
11176
|
-
|
|
11177
|
-
/**
|
|
11178
|
-
* - Information about the user who last
|
|
11179
|
-
* modified the product bundle, including user ID and username.
|
|
11180
|
-
*/
|
|
11181
|
-
modified_by?: any;
|
|
11182
|
-
/**
|
|
11183
|
-
* - The timestamp when the product bundle was
|
|
11184
|
-
* last modified.
|
|
11185
|
-
*/
|
|
11186
|
-
modified_on?: string;
|
|
11187
|
-
/**
|
|
11188
|
-
* - The name of the product bundle.
|
|
11189
|
-
*/
|
|
11190
|
-
name: string;
|
|
11191
|
-
/**
|
|
11192
|
-
* - Pages where the product bundle is
|
|
11193
|
-
* visible (e.g., 'pdp' for product display page).
|
|
11194
|
-
*/
|
|
11195
|
-
page_visibility?: string[];
|
|
11196
|
-
/**
|
|
11197
|
-
* - A list of products included in the
|
|
11198
|
-
* bundle. A maximum of 10 products can be added.
|
|
11199
|
-
*/
|
|
11200
|
-
products: ProductBundleItem[];
|
|
11201
|
-
/**
|
|
11202
|
-
* - Indicates whether all products
|
|
11203
|
-
* in the bundle are assigned to the same store.
|
|
11204
|
-
*/
|
|
11205
|
-
same_store_assignment?: boolean;
|
|
11206
|
-
/**
|
|
11207
|
-
* - A URL-friendly unique identifier for the product bundle.
|
|
11208
|
-
*/
|
|
11209
|
-
slug: string;
|
|
11210
|
-
};
|
|
11211
|
-
/** @returns {ProductBundleUpdateRequestSchema} */
|
|
11212
|
-
declare function ProductBundleUpdateRequestSchema(): ProductBundleUpdateRequestSchema;
|
|
11213
|
-
type ProductBundleUpdateRequestSchema = {
|
|
11214
|
-
/**
|
|
11215
|
-
* - Specifies the type of product bundle (e.g.,
|
|
11216
|
-
* 'single' or 'multi').
|
|
11217
|
-
*/
|
|
11218
|
-
choice: string;
|
|
11219
|
-
/**
|
|
11220
|
-
* - The unique identifier of the company to
|
|
11221
|
-
* which the product bundle belongs.
|
|
11222
|
-
*/
|
|
11223
|
-
company_id?: number;
|
|
11224
|
-
/**
|
|
11225
|
-
* - Indicates whether the product bundle is
|
|
11226
|
-
* currently active.
|
|
11227
|
-
*/
|
|
11228
|
-
is_active: boolean;
|
|
11229
|
-
/**
|
|
11230
|
-
* - URL of the logo associated with the product
|
|
11231
|
-
* bundle, if available. Can be null.
|
|
11232
|
-
*/
|
|
11233
|
-
logo?: string;
|
|
11234
|
-
/**
|
|
11235
|
-
* - Additional metadata for the product bundle.
|
|
11236
|
-
*/
|
|
11237
|
-
meta?: any;
|
|
11238
|
-
/**
|
|
11239
|
-
* - The name of the product bundle.
|
|
11240
|
-
*/
|
|
11241
|
-
name: string;
|
|
11242
|
-
/**
|
|
11243
|
-
* - Pages where the product bundle is
|
|
11244
|
-
* visible (e.g., 'pdp' for product display page).
|
|
11245
|
-
*/
|
|
11246
|
-
page_visibility?: string[];
|
|
11247
|
-
/**
|
|
11248
|
-
* - A list of products included in the
|
|
11249
|
-
* bundle. A maximum of 10 products can be added.
|
|
11250
|
-
*/
|
|
11251
|
-
products: ProductBundleItem[];
|
|
11252
|
-
/**
|
|
11253
|
-
* - Indicates whether all products
|
|
11254
|
-
* in the bundle are assigned to the same store.
|
|
11255
|
-
*/
|
|
11256
|
-
same_store_assignment?: boolean;
|
|
11257
|
-
/**
|
|
11258
|
-
* - A URL-friendly unique identifier for the product bundle.
|
|
11259
|
-
*/
|
|
11260
|
-
slug: string;
|
|
11261
|
-
};
|
|
11262
|
-
/** @returns {ProductConfigurationDownloads} */
|
|
11263
|
-
declare function ProductConfigurationDownloads(): ProductConfigurationDownloads;
|
|
11264
|
-
type ProductConfigurationDownloads = {
|
|
11265
|
-
data?: any[];
|
|
11266
|
-
multivalue?: boolean;
|
|
11267
|
-
};
|
|
11268
|
-
/** @returns {ProductUpdateSchemaV2} */
|
|
11269
|
-
declare function ProductUpdateSchemaV2(): ProductUpdateSchemaV2;
|
|
11270
|
-
type ProductUpdateSchemaV2 = {
|
|
11271
|
-
/**
|
|
11272
|
-
* - Custom JSON data that can be used for
|
|
11273
|
-
* additional product properties.
|
|
11274
|
-
*/
|
|
11275
|
-
_custom_json?: any;
|
|
11276
|
-
/**
|
|
11277
|
-
* - The action to perform wrt to the product (e.g.,
|
|
11278
|
-
* upsert, update, delete).
|
|
11279
|
-
*/
|
|
11280
|
-
action?: string;
|
|
11281
|
-
/**
|
|
11282
|
-
* - Additional attributes related to the product.
|
|
11283
|
-
*/
|
|
11284
|
-
attributes?: any;
|
|
11285
|
-
/**
|
|
11286
|
-
* - Unique identifier for the product's brand.
|
|
11287
|
-
*/
|
|
11288
|
-
brand_uid: number;
|
|
11289
|
-
/**
|
|
11290
|
-
* - Job ID associated with bulk operations.
|
|
11291
|
-
*/
|
|
11292
|
-
bulk_job_id?: string;
|
|
11293
|
-
/**
|
|
11294
|
-
* - The category to which the product belongs.
|
|
11295
|
-
*/
|
|
11296
|
-
category_slug: string;
|
|
11297
|
-
/**
|
|
11298
|
-
* - Change request identifier for product updates.
|
|
11299
|
-
*/
|
|
11300
|
-
change_request_id?: string;
|
|
11301
|
-
/**
|
|
11302
|
-
* - Unique identifier for the company associated
|
|
11303
|
-
* with the product.
|
|
11304
|
-
*/
|
|
11305
|
-
company_id: number;
|
|
11306
|
-
/**
|
|
11307
|
-
* - The country where the product was
|
|
11308
|
-
* manufactured or sourced.
|
|
11309
|
-
*/
|
|
11310
|
-
country_of_origin: string;
|
|
11311
|
-
/**
|
|
11312
|
-
* - The currency in which the product's price is listed.
|
|
11313
|
-
*/
|
|
11314
|
-
currency: string;
|
|
11315
|
-
custom_order?: CustomOrder;
|
|
11316
|
-
/**
|
|
11317
|
-
* - List of department IDs associated with the product.
|
|
11318
|
-
*/
|
|
11319
|
-
departments: number[];
|
|
11320
|
-
/**
|
|
11321
|
-
* - A detailed description of the product.
|
|
11322
|
-
*/
|
|
11323
|
-
description?: string;
|
|
11324
|
-
/**
|
|
11325
|
-
* - Product highlights or key features.
|
|
11326
|
-
*/
|
|
11327
|
-
highlights?: string[];
|
|
10928
|
+
highlights?: string[];
|
|
11328
10929
|
/**
|
|
11329
10930
|
* - Flag to indicate if the product is active.
|
|
11330
10931
|
*/
|
|
@@ -11348,8 +10949,11 @@ type ProductUpdateSchemaV2 = {
|
|
|
11348
10949
|
*/
|
|
11349
10950
|
item_code: string;
|
|
11350
10951
|
/**
|
|
11351
|
-
* -
|
|
11352
|
-
* composite, digital
|
|
10952
|
+
* - Specifies the type of product, such as
|
|
10953
|
+
* standard, set, composite, digital, virtual_bundle, or physical_bundle. For
|
|
10954
|
+
* bundle types (virtual_bundle or physical_bundle), use the category,
|
|
10955
|
+
* department, and brand of the base child SKU. In this case, attributes are
|
|
10956
|
+
* optional. The bundle_details attribute must be included for bundle types.
|
|
11353
10957
|
*/
|
|
11354
10958
|
item_type: string;
|
|
11355
10959
|
/**
|
|
@@ -11403,11 +11007,7 @@ type ProductUpdateSchemaV2 = {
|
|
|
11403
11007
|
* - List of tags associated with the product.
|
|
11404
11008
|
*/
|
|
11405
11009
|
tags?: string[];
|
|
11406
|
-
tax_identifier:
|
|
11407
|
-
/**
|
|
11408
|
-
* - HS Code for the product.
|
|
11409
|
-
*/
|
|
11410
|
-
hs_code?: string;
|
|
11010
|
+
tax_identifier: TaxIdentifierV3;
|
|
11411
11011
|
teaser_tag?: TeaserTag;
|
|
11412
11012
|
/**
|
|
11413
11013
|
* - Template tag for the product, used for
|
|
@@ -11418,10 +11018,6 @@ type ProductUpdateSchemaV2 = {
|
|
|
11418
11018
|
* - List of traders associated with the product.
|
|
11419
11019
|
*/
|
|
11420
11020
|
trader: Trader[];
|
|
11421
|
-
/**
|
|
11422
|
-
* - Unique identifier for the product.
|
|
11423
|
-
*/
|
|
11424
|
-
uid?: number;
|
|
11425
11021
|
/**
|
|
11426
11022
|
* - Variant group information for the product.
|
|
11427
11023
|
*/
|
|
@@ -11434,10 +11030,20 @@ type ProductUpdateSchemaV2 = {
|
|
|
11434
11030
|
* - Variants information for the product.
|
|
11435
11031
|
*/
|
|
11436
11032
|
variants?: any;
|
|
11033
|
+
/**
|
|
11034
|
+
* - HS Code for the product. This is required for
|
|
11035
|
+
* indian companies.
|
|
11036
|
+
*/
|
|
11037
|
+
hs_code?: string;
|
|
11038
|
+
/**
|
|
11039
|
+
* - List of bundle details for
|
|
11040
|
+
* products that are part of a bundle.
|
|
11041
|
+
*/
|
|
11042
|
+
bundle_details?: BundleDetails[];
|
|
11437
11043
|
};
|
|
11438
|
-
/** @returns {
|
|
11439
|
-
declare function
|
|
11440
|
-
type
|
|
11044
|
+
/** @returns {ProductUpdateSchemaV3} */
|
|
11045
|
+
declare function ProductUpdateSchemaV3(): ProductUpdateSchemaV3;
|
|
11046
|
+
type ProductUpdateSchemaV3 = {
|
|
11441
11047
|
/**
|
|
11442
11048
|
* - Custom JSON data that can be used for
|
|
11443
11049
|
* additional product properties.
|
|
@@ -11518,8 +11124,11 @@ type ProductCreateSchemaV2 = {
|
|
|
11518
11124
|
*/
|
|
11519
11125
|
item_code: string;
|
|
11520
11126
|
/**
|
|
11521
|
-
* -
|
|
11522
|
-
* composite, digital
|
|
11127
|
+
* - Specifies the type of product, such as
|
|
11128
|
+
* standard, set, composite, digital, virtual_bundle, or physical_bundle. For
|
|
11129
|
+
* bundle types (virtual_bundle or physical_bundle), use the category,
|
|
11130
|
+
* department, and brand of the base child SKU. In this case, attributes are
|
|
11131
|
+
* optional. The bundle_details attribute must be included for bundle types.
|
|
11523
11132
|
*/
|
|
11524
11133
|
item_type: string;
|
|
11525
11134
|
/**
|
|
@@ -11573,7 +11182,12 @@ type ProductCreateSchemaV2 = {
|
|
|
11573
11182
|
* - List of tags associated with the product.
|
|
11574
11183
|
*/
|
|
11575
11184
|
tags?: string[];
|
|
11576
|
-
tax_identifier:
|
|
11185
|
+
tax_identifier: TaxIdentifierV3;
|
|
11186
|
+
/**
|
|
11187
|
+
* - HS Code for the product. This is required for
|
|
11188
|
+
* indian companies.
|
|
11189
|
+
*/
|
|
11190
|
+
hs_code?: string;
|
|
11577
11191
|
teaser_tag?: TeaserTag;
|
|
11578
11192
|
/**
|
|
11579
11193
|
* - Template tag for the product, used for
|
|
@@ -11584,6 +11198,10 @@ type ProductCreateSchemaV2 = {
|
|
|
11584
11198
|
* - List of traders associated with the product.
|
|
11585
11199
|
*/
|
|
11586
11200
|
trader: Trader[];
|
|
11201
|
+
/**
|
|
11202
|
+
* - Unique identifier for the product.
|
|
11203
|
+
*/
|
|
11204
|
+
uid?: number;
|
|
11587
11205
|
/**
|
|
11588
11206
|
* - Variant group information for the product.
|
|
11589
11207
|
*/
|
|
@@ -11596,61 +11214,34 @@ type ProductCreateSchemaV2 = {
|
|
|
11596
11214
|
* - Variants information for the product.
|
|
11597
11215
|
*/
|
|
11598
11216
|
variants?: any;
|
|
11217
|
+
/**
|
|
11218
|
+
* - List of bundle details for
|
|
11219
|
+
* products that are part of a bundle. This will have child skus along with
|
|
11220
|
+
* net quantity used in bundle formation.
|
|
11221
|
+
*/
|
|
11222
|
+
bundle_details?: BundleDetails[];
|
|
11599
11223
|
};
|
|
11600
|
-
/** @returns {
|
|
11601
|
-
declare function
|
|
11602
|
-
type
|
|
11224
|
+
/** @returns {ProductPatchSchemaV3} */
|
|
11225
|
+
declare function ProductPatchSchemaV3(): ProductPatchSchemaV3;
|
|
11226
|
+
type ProductPatchSchemaV3 = {
|
|
11603
11227
|
/**
|
|
11604
11228
|
* - Custom JSON data that can be used for
|
|
11605
11229
|
* additional product properties.
|
|
11606
11230
|
*/
|
|
11607
11231
|
_custom_json?: any;
|
|
11608
|
-
/**
|
|
11609
|
-
* - The action to perform wrt to the product (e.g.,
|
|
11610
|
-
* upsert, update, delete).
|
|
11611
|
-
*/
|
|
11612
|
-
action?: string;
|
|
11613
11232
|
/**
|
|
11614
11233
|
* - Additional attributes related to the product.
|
|
11615
11234
|
*/
|
|
11616
11235
|
attributes?: any;
|
|
11617
|
-
/**
|
|
11618
|
-
* - Unique identifier for the product's brand.
|
|
11619
|
-
*/
|
|
11620
|
-
brand_uid: number;
|
|
11621
|
-
/**
|
|
11622
|
-
* - Job ID associated with bulk operations.
|
|
11623
|
-
*/
|
|
11624
|
-
bulk_job_id?: string;
|
|
11625
|
-
/**
|
|
11626
|
-
* - The category to which the product belongs.
|
|
11627
|
-
*/
|
|
11628
|
-
category_slug: string;
|
|
11629
|
-
/**
|
|
11630
|
-
* - Change request identifier for product updates.
|
|
11631
|
-
*/
|
|
11632
|
-
change_request_id?: string;
|
|
11633
|
-
/**
|
|
11634
|
-
* - Unique identifier for the company associated
|
|
11635
|
-
* with the product.
|
|
11636
|
-
*/
|
|
11637
|
-
company_id: number;
|
|
11638
11236
|
/**
|
|
11639
11237
|
* - The country where the product was
|
|
11640
11238
|
* manufactured or sourced.
|
|
11641
11239
|
*/
|
|
11642
|
-
country_of_origin
|
|
11643
|
-
/**
|
|
11644
|
-
* - The currency in which the product's price is listed.
|
|
11645
|
-
*/
|
|
11646
|
-
currency: string;
|
|
11240
|
+
country_of_origin?: string;
|
|
11647
11241
|
custom_order?: CustomOrder;
|
|
11648
|
-
/**
|
|
11649
|
-
* - List of department IDs associated with the product.
|
|
11650
|
-
*/
|
|
11651
|
-
departments: number[];
|
|
11652
11242
|
/**
|
|
11653
11243
|
* - A detailed description of the product.
|
|
11244
|
+
* Provide base64 encoded value in input.
|
|
11654
11245
|
*/
|
|
11655
11246
|
description?: string;
|
|
11656
11247
|
/**
|
|
@@ -11666,24 +11257,6 @@ type ProductCreateSchemaV3 = {
|
|
|
11666
11257
|
* dependent on other products.
|
|
11667
11258
|
*/
|
|
11668
11259
|
is_dependent?: boolean;
|
|
11669
|
-
/**
|
|
11670
|
-
* - Flag to indicate if the product
|
|
11671
|
-
* does not have associated images.
|
|
11672
|
-
*/
|
|
11673
|
-
is_image_less_product?: boolean;
|
|
11674
|
-
/**
|
|
11675
|
-
* - Flag to indicate if the product is part of a set.
|
|
11676
|
-
*/
|
|
11677
|
-
is_set?: boolean;
|
|
11678
|
-
/**
|
|
11679
|
-
* - Unique item code or SKU of the product.
|
|
11680
|
-
*/
|
|
11681
|
-
item_code: string;
|
|
11682
|
-
/**
|
|
11683
|
-
* - Type of the product (e.g., standard, set,
|
|
11684
|
-
* composite, digital).
|
|
11685
|
-
*/
|
|
11686
|
-
item_type: string;
|
|
11687
11260
|
/**
|
|
11688
11261
|
* - List of media URLs (images, videos) associated
|
|
11689
11262
|
* with the product.
|
|
@@ -11696,7 +11269,7 @@ type ProductCreateSchemaV3 = {
|
|
|
11696
11269
|
/**
|
|
11697
11270
|
* - The name of the product.
|
|
11698
11271
|
*/
|
|
11699
|
-
name
|
|
11272
|
+
name?: string;
|
|
11700
11273
|
net_quantity?: NetQuantity;
|
|
11701
11274
|
/**
|
|
11702
11275
|
* - Number of boxes required to package the product.
|
|
@@ -11708,12 +11281,7 @@ type ProductCreateSchemaV3 = {
|
|
|
11708
11281
|
*/
|
|
11709
11282
|
product_group_tag?: string[];
|
|
11710
11283
|
product_publish?: ProductPublish;
|
|
11711
|
-
|
|
11712
|
-
* - The role requesting the product operation
|
|
11713
|
-
* (admin or user).
|
|
11714
|
-
*/
|
|
11715
|
-
requester?: string;
|
|
11716
|
-
return_config: ReturnConfig;
|
|
11284
|
+
return_config?: ReturnConfig;
|
|
11717
11285
|
/**
|
|
11718
11286
|
* - A short description of the product,
|
|
11719
11287
|
* up to 50 characters.
|
|
@@ -11726,26 +11294,27 @@ type ProductCreateSchemaV3 = {
|
|
|
11726
11294
|
/**
|
|
11727
11295
|
* - List of sizes available for the product.
|
|
11728
11296
|
*/
|
|
11729
|
-
sizes
|
|
11730
|
-
/**
|
|
11731
|
-
* - URL-friendly identifier for the product.
|
|
11732
|
-
*/
|
|
11733
|
-
slug: string;
|
|
11297
|
+
sizes?: ProductSizePatch[];
|
|
11734
11298
|
/**
|
|
11735
11299
|
* - List of tags associated with the product.
|
|
11736
11300
|
*/
|
|
11737
11301
|
tags?: string[];
|
|
11738
|
-
tax_identifier
|
|
11302
|
+
tax_identifier?: TaxIdentifierV3;
|
|
11303
|
+
/**
|
|
11304
|
+
* - HS Code for the product. This is required for
|
|
11305
|
+
* indian companies.
|
|
11306
|
+
*/
|
|
11307
|
+
hs_code?: string;
|
|
11739
11308
|
teaser_tag?: TeaserTag;
|
|
11740
11309
|
/**
|
|
11741
11310
|
* - Template tag for the product, used for
|
|
11742
11311
|
* classification.
|
|
11743
11312
|
*/
|
|
11744
|
-
template_tag
|
|
11313
|
+
template_tag?: string;
|
|
11745
11314
|
/**
|
|
11746
11315
|
* - List of traders associated with the product.
|
|
11747
11316
|
*/
|
|
11748
|
-
trader
|
|
11317
|
+
trader?: Trader[];
|
|
11749
11318
|
/**
|
|
11750
11319
|
* - Variant group information for the product.
|
|
11751
11320
|
*/
|
|
@@ -11758,182 +11327,50 @@ type ProductCreateSchemaV3 = {
|
|
|
11758
11327
|
* - Variants information for the product.
|
|
11759
11328
|
*/
|
|
11760
11329
|
variants?: any;
|
|
11761
|
-
/**
|
|
11762
|
-
* - HS Code for the product. This is required for
|
|
11763
|
-
* indian companies.
|
|
11764
|
-
*/
|
|
11765
|
-
hs_code?: string;
|
|
11766
11330
|
};
|
|
11767
|
-
/** @returns {
|
|
11768
|
-
declare function
|
|
11769
|
-
type
|
|
11770
|
-
/**
|
|
11771
|
-
* - Custom JSON data that can be used for
|
|
11772
|
-
* additional product properties.
|
|
11773
|
-
*/
|
|
11774
|
-
_custom_json?: any;
|
|
11775
|
-
/**
|
|
11776
|
-
* - The action to perform wrt to the product (e.g.,
|
|
11777
|
-
* upsert, update, delete).
|
|
11778
|
-
*/
|
|
11779
|
-
action?: string;
|
|
11780
|
-
/**
|
|
11781
|
-
* - Additional attributes related to the product.
|
|
11782
|
-
*/
|
|
11783
|
-
attributes?: any;
|
|
11331
|
+
/** @returns {ProductSizePatch} */
|
|
11332
|
+
declare function ProductSizePatch(): ProductSizePatch;
|
|
11333
|
+
type ProductSizePatch = {
|
|
11784
11334
|
/**
|
|
11785
|
-
* -
|
|
11786
|
-
*/
|
|
11787
|
-
brand_uid: number;
|
|
11788
|
-
/**
|
|
11789
|
-
* - Job ID associated with bulk operations.
|
|
11790
|
-
*/
|
|
11791
|
-
bulk_job_id?: string;
|
|
11792
|
-
/**
|
|
11793
|
-
* - The category to which the product belongs.
|
|
11794
|
-
*/
|
|
11795
|
-
category_slug: string;
|
|
11796
|
-
/**
|
|
11797
|
-
* - Change request identifier for product updates.
|
|
11798
|
-
*/
|
|
11799
|
-
change_request_id?: string;
|
|
11800
|
-
/**
|
|
11801
|
-
* - Unique identifier for the company associated
|
|
11802
|
-
* with the product.
|
|
11803
|
-
*/
|
|
11804
|
-
company_id: number;
|
|
11805
|
-
/**
|
|
11806
|
-
* - The country where the product was
|
|
11807
|
-
* manufactured or sourced.
|
|
11808
|
-
*/
|
|
11809
|
-
country_of_origin: string;
|
|
11810
|
-
/**
|
|
11811
|
-
* - The currency in which the product's price is listed.
|
|
11812
|
-
*/
|
|
11813
|
-
currency: string;
|
|
11814
|
-
custom_order?: CustomOrder;
|
|
11815
|
-
/**
|
|
11816
|
-
* - List of department IDs associated with the product.
|
|
11817
|
-
*/
|
|
11818
|
-
departments: number[];
|
|
11819
|
-
/**
|
|
11820
|
-
* - A detailed description of the product.
|
|
11821
|
-
*/
|
|
11822
|
-
description?: string;
|
|
11823
|
-
/**
|
|
11824
|
-
* - Product highlights or key features.
|
|
11825
|
-
*/
|
|
11826
|
-
highlights?: string[];
|
|
11827
|
-
/**
|
|
11828
|
-
* - Flag to indicate if the product is active.
|
|
11829
|
-
*/
|
|
11830
|
-
is_active?: boolean;
|
|
11831
|
-
/**
|
|
11832
|
-
* - Flag to indicate if the product is
|
|
11833
|
-
* dependent on other products.
|
|
11335
|
+
* - Width of the item in the specified dimension unit.
|
|
11834
11336
|
*/
|
|
11835
|
-
|
|
11836
|
-
/**
|
|
11837
|
-
* - Flag to indicate if the product
|
|
11838
|
-
* does not have associated images.
|
|
11839
|
-
*/
|
|
11840
|
-
is_image_less_product?: boolean;
|
|
11841
|
-
/**
|
|
11842
|
-
* - Flag to indicate if the product is part of a set.
|
|
11843
|
-
*/
|
|
11844
|
-
is_set?: boolean;
|
|
11845
|
-
/**
|
|
11846
|
-
* - Unique item code or SKU of the product.
|
|
11847
|
-
*/
|
|
11848
|
-
item_code: string;
|
|
11849
|
-
/**
|
|
11850
|
-
* - Type of the product (e.g., standard, set,
|
|
11851
|
-
* composite, digital).
|
|
11852
|
-
*/
|
|
11853
|
-
item_type: string;
|
|
11854
|
-
/**
|
|
11855
|
-
* - List of media URLs (images, videos) associated
|
|
11856
|
-
* with the product.
|
|
11857
|
-
*/
|
|
11858
|
-
media?: Media[];
|
|
11859
|
-
/**
|
|
11860
|
-
* - Indicates if the product supports multiple sizes.
|
|
11861
|
-
*/
|
|
11862
|
-
multi_size?: boolean;
|
|
11863
|
-
/**
|
|
11864
|
-
* - The name of the product.
|
|
11865
|
-
*/
|
|
11866
|
-
name: string;
|
|
11867
|
-
net_quantity?: NetQuantity;
|
|
11868
|
-
/**
|
|
11869
|
-
* - Number of boxes required to package the product.
|
|
11870
|
-
*/
|
|
11871
|
-
no_of_boxes?: number;
|
|
11872
|
-
/**
|
|
11873
|
-
* - Tags to group products together
|
|
11874
|
-
* for classification.
|
|
11875
|
-
*/
|
|
11876
|
-
product_group_tag?: string[];
|
|
11877
|
-
product_publish?: ProductPublish;
|
|
11878
|
-
/**
|
|
11879
|
-
* - The role requesting the product operation
|
|
11880
|
-
* (admin or user).
|
|
11881
|
-
*/
|
|
11882
|
-
requester?: string;
|
|
11883
|
-
return_config: ReturnConfig;
|
|
11884
|
-
/**
|
|
11885
|
-
* - A short description of the product,
|
|
11886
|
-
* up to 50 characters.
|
|
11887
|
-
*/
|
|
11888
|
-
short_description?: string;
|
|
11889
|
-
/**
|
|
11890
|
-
* - Identifier for the product's size guide.
|
|
11891
|
-
*/
|
|
11892
|
-
size_guide?: string;
|
|
11893
|
-
/**
|
|
11894
|
-
* - List of sizes available for the product.
|
|
11895
|
-
*/
|
|
11896
|
-
sizes: any[];
|
|
11897
|
-
/**
|
|
11898
|
-
* - URL-friendly identifier for the product.
|
|
11899
|
-
*/
|
|
11900
|
-
slug: string;
|
|
11337
|
+
item_width?: number;
|
|
11901
11338
|
/**
|
|
11902
|
-
* -
|
|
11339
|
+
* - Height of the item in the specified dimension unit.
|
|
11903
11340
|
*/
|
|
11904
|
-
|
|
11905
|
-
tax_identifier: TaxIdentifierV3;
|
|
11341
|
+
item_height?: number;
|
|
11906
11342
|
/**
|
|
11907
|
-
* -
|
|
11908
|
-
* indian companies.
|
|
11343
|
+
* - Weight of the item in the specified weight unit.
|
|
11909
11344
|
*/
|
|
11910
|
-
|
|
11911
|
-
teaser_tag?: TeaserTag;
|
|
11345
|
+
item_weight?: number;
|
|
11912
11346
|
/**
|
|
11913
|
-
* -
|
|
11914
|
-
* classification.
|
|
11347
|
+
* - Listed price of the product before discounts.
|
|
11915
11348
|
*/
|
|
11916
|
-
|
|
11349
|
+
price?: number;
|
|
11917
11350
|
/**
|
|
11918
|
-
* -
|
|
11351
|
+
* - Indicates whether inventory tracking
|
|
11352
|
+
* is enabled for this item.
|
|
11919
11353
|
*/
|
|
11920
|
-
|
|
11354
|
+
track_inventory?: boolean;
|
|
11921
11355
|
/**
|
|
11922
|
-
* -
|
|
11356
|
+
* - Custom attributes or additional metadata
|
|
11357
|
+
* for the product.
|
|
11923
11358
|
*/
|
|
11924
|
-
|
|
11359
|
+
_custom_json?: any;
|
|
11925
11360
|
/**
|
|
11926
|
-
* -
|
|
11361
|
+
* - Unique identifier assigned by the
|
|
11362
|
+
* seller for this product or size variant.
|
|
11927
11363
|
*/
|
|
11928
|
-
|
|
11364
|
+
seller_identifier?: string;
|
|
11929
11365
|
/**
|
|
11930
|
-
* -
|
|
11366
|
+
* - Length of the item in the specified dimension unit.
|
|
11931
11367
|
*/
|
|
11932
|
-
|
|
11368
|
+
item_length?: number;
|
|
11933
11369
|
/**
|
|
11934
|
-
* -
|
|
11370
|
+
* - Effective or discounted price after
|
|
11371
|
+
* applying promotions.
|
|
11935
11372
|
*/
|
|
11936
|
-
|
|
11373
|
+
price_effective?: number;
|
|
11937
11374
|
};
|
|
11938
11375
|
/** @returns {ProductDetail} */
|
|
11939
11376
|
declare function ProductDetail(): ProductDetail;
|
|
@@ -12924,6 +12361,12 @@ type SizeDetails = {
|
|
|
12924
12361
|
* tracked for this size.
|
|
12925
12362
|
*/
|
|
12926
12363
|
track_inventory?: boolean;
|
|
12364
|
+
/**
|
|
12365
|
+
* - List of bundle details for
|
|
12366
|
+
* products that are part of a bundle. This will have child skus along with
|
|
12367
|
+
* net quantity used in bundle formation.
|
|
12368
|
+
*/
|
|
12369
|
+
bundle_details?: BundleDetails[];
|
|
12927
12370
|
};
|
|
12928
12371
|
/** @returns {ProductSchemaV2} */
|
|
12929
12372
|
declare function ProductSchemaV2(): ProductSchemaV2;
|
|
@@ -13073,7 +12516,8 @@ type ProductSchemaV2 = {
|
|
|
13073
12516
|
item_code?: string;
|
|
13074
12517
|
/**
|
|
13075
12518
|
* - Describes the type of product (e.g.,
|
|
13076
|
-
* "standard" or "set").
|
|
12519
|
+
* "standard" or "set"). In case of bundle items type will be
|
|
12520
|
+
* ("virtual_bundle" or "physical_bundle")
|
|
13077
12521
|
*/
|
|
13078
12522
|
item_type?: string;
|
|
13079
12523
|
/**
|