@teemill/product-catalog 1.83.2 → 1.85.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 +6 -2
- package/api.ts +629 -34
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +339 -23
- package/dist/api.js +383 -29
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +339 -23
- package/dist/esm/api.js +378 -28
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/docs/ApplicationSetsApi.md +2 -2
- package/docs/ProductAnalyticsApi.md +127 -5
- package/docs/ProductType.md +22 -0
- package/docs/ProductTypeListResponse.md +22 -0
- package/docs/ProductTypesApi.md +69 -0
- package/docs/ProductsApi.md +27 -3
- package/docs/VariantsApi.md +2 -2
- package/index.ts +1 -1
- package/package.json +1 -1
package/dist/esm/api.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Product Catalog API
|
|
3
3
|
* Manage your Product Catalog. A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a warehouse product, plus listing information such as title, description and tags.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.85.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -1202,6 +1202,23 @@ export interface ProductBundleItemsInner {
|
|
|
1202
1202
|
'license'?: License;
|
|
1203
1203
|
'config'?: UpdateProductRequestBundleItemsInnerConfig;
|
|
1204
1204
|
}
|
|
1205
|
+
export interface ProductType {
|
|
1206
|
+
/**
|
|
1207
|
+
* Unique object identifier
|
|
1208
|
+
*/
|
|
1209
|
+
'id': string;
|
|
1210
|
+
/**
|
|
1211
|
+
* Name of the product type
|
|
1212
|
+
*/
|
|
1213
|
+
'name': string;
|
|
1214
|
+
}
|
|
1215
|
+
export interface ProductTypeListResponse {
|
|
1216
|
+
'productTypes': Array<ProductType>;
|
|
1217
|
+
/**
|
|
1218
|
+
* The token referencing the next page number
|
|
1219
|
+
*/
|
|
1220
|
+
'nextPageToken': number | null;
|
|
1221
|
+
}
|
|
1205
1222
|
export interface ProductWarehouseProduct {
|
|
1206
1223
|
/**
|
|
1207
1224
|
* Unique object identifier
|
|
@@ -2177,7 +2194,7 @@ export declare const ApplicationSetsApiAxiosParamCreator: (configuration?: Confi
|
|
|
2177
2194
|
* @summary List application sets
|
|
2178
2195
|
* @param {string} project What project it is
|
|
2179
2196
|
* @param {number} [pageToken] Page reference token
|
|
2180
|
-
* @param {string} [search] Search query string to filter results. Supports field-specific filters like \'enabled:true\', \'
|
|
2197
|
+
* @param {string} [search] Search query string to filter results. Supports field-specific filters like: \'enabled:true\', \'gfn_product_ids:<id>\', \'tag:\"tag name\"\', \'internal_tag:\"internal tag name\"\', \'includeArchived:false\', \'hasSearchPhrase:false\', \'inDataFeeds:true\', \'aiOptimised:true\', \'productType:<id>\', \'genderGroup:\"male,female,unisex\"\', \'hasBarcode:true\', \'onSale:true\', \'type:product,template,bundle\', \'collection:<id>\'. Multiple filters can be combined with spaces and commas.
|
|
2181
2198
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
2182
2199
|
* @param {*} [options] Override http request option.
|
|
2183
2200
|
* @throws {RequiredError}
|
|
@@ -2230,7 +2247,7 @@ export declare const ApplicationSetsApiFp: (configuration?: Configuration) => {
|
|
|
2230
2247
|
* @summary List application sets
|
|
2231
2248
|
* @param {string} project What project it is
|
|
2232
2249
|
* @param {number} [pageToken] Page reference token
|
|
2233
|
-
* @param {string} [search] Search query string to filter results. Supports field-specific filters like \'enabled:true\', \'
|
|
2250
|
+
* @param {string} [search] Search query string to filter results. Supports field-specific filters like: \'enabled:true\', \'gfn_product_ids:<id>\', \'tag:\"tag name\"\', \'internal_tag:\"internal tag name\"\', \'includeArchived:false\', \'hasSearchPhrase:false\', \'inDataFeeds:true\', \'aiOptimised:true\', \'productType:<id>\', \'genderGroup:\"male,female,unisex\"\', \'hasBarcode:true\', \'onSale:true\', \'type:product,template,bundle\', \'collection:<id>\'. Multiple filters can be combined with spaces and commas.
|
|
2234
2251
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
2235
2252
|
* @param {*} [options] Override http request option.
|
|
2236
2253
|
* @throws {RequiredError}
|
|
@@ -2344,7 +2361,7 @@ export interface ApplicationSetsApiListApplicationSetsRequest {
|
|
|
2344
2361
|
*/
|
|
2345
2362
|
readonly pageToken?: number;
|
|
2346
2363
|
/**
|
|
2347
|
-
* Search query string to filter results. Supports field-specific filters like \'enabled:true\', \'
|
|
2364
|
+
* Search query string to filter results. Supports field-specific filters like: \'enabled:true\', \'gfn_product_ids:<id>\', \'tag:\"tag name\"\', \'internal_tag:\"internal tag name\"\', \'includeArchived:false\', \'hasSearchPhrase:false\', \'inDataFeeds:true\', \'aiOptimised:true\', \'productType:<id>\', \'genderGroup:\"male,female,unisex\"\', \'hasBarcode:true\', \'onSale:true\', \'type:product,template,bundle\', \'collection:<id>\'. Multiple filters can be combined with spaces and commas.
|
|
2348
2365
|
*/
|
|
2349
2366
|
readonly search?: string;
|
|
2350
2367
|
/**
|
|
@@ -2479,40 +2496,108 @@ export declare class ApplicationTechnologiesApi extends BaseAPI {
|
|
|
2479
2496
|
* ProductAnalyticsApi - axios parameter creator
|
|
2480
2497
|
*/
|
|
2481
2498
|
export declare const ProductAnalyticsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
2499
|
+
/**
|
|
2500
|
+
* Exports all products with analytics data in a CSV file.
|
|
2501
|
+
* @summary Export product analytics
|
|
2502
|
+
* @param {string} project What project it is
|
|
2503
|
+
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
2504
|
+
* @param {string} [search] Search query string to filter results. Supports field-specific filters like: \'enabled:true\', \'gfn_product_ids:<id>\', \'tag:\"tag name\"\', \'internal_tag:\"internal tag name\"\', \'includeArchived:false\', \'hasSearchPhrase:false\', \'inDataFeeds:true\', \'aiOptimised:true\', \'productType:<id>\', \'genderGroup:\"male,female,unisex\"\', \'hasBarcode:true\', \'onSale:true\', \'type:product,template,bundle\', \'collection:<id>\'. Multiple filters can be combined with spaces and commas.
|
|
2505
|
+
* @param {string} [dateRangeStartDate] Start date for the date range filter (ISO 8601 format)
|
|
2506
|
+
* @param {string} [dateRangeEndDate] End date for the date range filter (ISO 8601 format)
|
|
2507
|
+
* @param {number} [minimumRevenue] Filter to only include products with total revenue greater than or equal to this amount
|
|
2508
|
+
* @param {number} [maximumRevenue] Filter to only include products with total revenue less than or equal to this amount
|
|
2509
|
+
* @param {number} [minimumSales] Filter to only include products with total sales greater than or equal to this number
|
|
2510
|
+
* @param {number} [maximumSales] Filter to only include products with total sales less than or equal to this number
|
|
2511
|
+
* @param {number} [minimumBasketPercent] Filter to only include products where the average basket percentage is greater than or equal to this value
|
|
2512
|
+
* @param {number} [maximumBasketPercent] Filter to only include products where the average basket percentage is less than or equal to this value
|
|
2513
|
+
* @param {number} [minimumTraffic] Filter to only include products with total traffic greater than or equal to this number
|
|
2514
|
+
* @param {number} [maximumTraffic] Filter to only include products with total traffic less than or equal to this number
|
|
2515
|
+
* @param {*} [options] Override http request option.
|
|
2516
|
+
* @throws {RequiredError}
|
|
2517
|
+
*/
|
|
2518
|
+
exportProductAnalytics: (project: string, sortBy?: Array<string>, search?: string, dateRangeStartDate?: string, dateRangeEndDate?: string, minimumRevenue?: number, maximumRevenue?: number, minimumSales?: number, maximumSales?: number, minimumBasketPercent?: number, maximumBasketPercent?: number, minimumTraffic?: number, maximumTraffic?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2482
2519
|
/**
|
|
2483
2520
|
* Lists all product analytics items.
|
|
2484
2521
|
* @summary List product analytics
|
|
2485
2522
|
* @param {string} project What project it is
|
|
2486
2523
|
* @param {number} [pageToken] Page reference token
|
|
2487
|
-
* @param {string} [search] Search query string to filter results. Supports field-specific filters like \'enabled:true\', \'uuid:<id>\', \'name:\"product name\"\', \'tag:\"tag name\"\', and \'type:product,template,bundle\'. Multiple filters can be combined with spaces and commas.
|
|
2488
|
-
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
2489
2524
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
2525
|
+
* @param {string} [search] Search query string to filter results. Supports field-specific filters like: \'enabled:true\', \'gfn_product_ids:<id>\', \'tag:\"tag name\"\', \'internal_tag:\"internal tag name\"\', \'includeArchived:false\', \'hasSearchPhrase:false\', \'inDataFeeds:true\', \'aiOptimised:true\', \'productType:<id>\', \'genderGroup:\"male,female,unisex\"\', \'hasBarcode:true\', \'onSale:true\', \'type:product,template,bundle\', \'collection:<id>\'. Multiple filters can be combined with spaces and commas.
|
|
2526
|
+
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
2527
|
+
* @param {string} [dateRangeStartDate] Start date for the date range filter (ISO 8601 format)
|
|
2528
|
+
* @param {string} [dateRangeEndDate] End date for the date range filter (ISO 8601 format)
|
|
2529
|
+
* @param {number} [minimumRevenue] Filter to only include products with total revenue greater than or equal to this amount
|
|
2530
|
+
* @param {number} [maximumRevenue] Filter to only include products with total revenue less than or equal to this amount
|
|
2531
|
+
* @param {number} [minimumSales] Filter to only include products with total sales greater than or equal to this number
|
|
2532
|
+
* @param {number} [maximumSales] Filter to only include products with total sales less than or equal to this number
|
|
2533
|
+
* @param {number} [minimumBasketPercent] Filter to only include products where the average basket percentage is greater than or equal to this value
|
|
2534
|
+
* @param {number} [maximumBasketPercent] Filter to only include products where the average basket percentage is less than or equal to this value
|
|
2535
|
+
* @param {number} [minimumTraffic] Filter to only include products with total traffic greater than or equal to this number
|
|
2536
|
+
* @param {number} [maximumTraffic] Filter to only include products with total traffic less than or equal to this number
|
|
2490
2537
|
* @param {*} [options] Override http request option.
|
|
2491
2538
|
* @throws {RequiredError}
|
|
2492
2539
|
*/
|
|
2493
|
-
listProductAnalytics: (project: string, pageToken?: number, search?: string, sortBy?: Array<string>,
|
|
2540
|
+
listProductAnalytics: (project: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<string>, dateRangeStartDate?: string, dateRangeEndDate?: string, minimumRevenue?: number, maximumRevenue?: number, minimumSales?: number, maximumSales?: number, minimumBasketPercent?: number, maximumBasketPercent?: number, minimumTraffic?: number, maximumTraffic?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2494
2541
|
};
|
|
2495
2542
|
/**
|
|
2496
2543
|
* ProductAnalyticsApi - functional programming interface
|
|
2497
2544
|
*/
|
|
2498
2545
|
export declare const ProductAnalyticsApiFp: (configuration?: Configuration) => {
|
|
2546
|
+
/**
|
|
2547
|
+
* Exports all products with analytics data in a CSV file.
|
|
2548
|
+
* @summary Export product analytics
|
|
2549
|
+
* @param {string} project What project it is
|
|
2550
|
+
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
2551
|
+
* @param {string} [search] Search query string to filter results. Supports field-specific filters like: \'enabled:true\', \'gfn_product_ids:<id>\', \'tag:\"tag name\"\', \'internal_tag:\"internal tag name\"\', \'includeArchived:false\', \'hasSearchPhrase:false\', \'inDataFeeds:true\', \'aiOptimised:true\', \'productType:<id>\', \'genderGroup:\"male,female,unisex\"\', \'hasBarcode:true\', \'onSale:true\', \'type:product,template,bundle\', \'collection:<id>\'. Multiple filters can be combined with spaces and commas.
|
|
2552
|
+
* @param {string} [dateRangeStartDate] Start date for the date range filter (ISO 8601 format)
|
|
2553
|
+
* @param {string} [dateRangeEndDate] End date for the date range filter (ISO 8601 format)
|
|
2554
|
+
* @param {number} [minimumRevenue] Filter to only include products with total revenue greater than or equal to this amount
|
|
2555
|
+
* @param {number} [maximumRevenue] Filter to only include products with total revenue less than or equal to this amount
|
|
2556
|
+
* @param {number} [minimumSales] Filter to only include products with total sales greater than or equal to this number
|
|
2557
|
+
* @param {number} [maximumSales] Filter to only include products with total sales less than or equal to this number
|
|
2558
|
+
* @param {number} [minimumBasketPercent] Filter to only include products where the average basket percentage is greater than or equal to this value
|
|
2559
|
+
* @param {number} [maximumBasketPercent] Filter to only include products where the average basket percentage is less than or equal to this value
|
|
2560
|
+
* @param {number} [minimumTraffic] Filter to only include products with total traffic greater than or equal to this number
|
|
2561
|
+
* @param {number} [maximumTraffic] Filter to only include products with total traffic less than or equal to this number
|
|
2562
|
+
* @param {*} [options] Override http request option.
|
|
2563
|
+
* @throws {RequiredError}
|
|
2564
|
+
*/
|
|
2565
|
+
exportProductAnalytics(project: string, sortBy?: Array<string>, search?: string, dateRangeStartDate?: string, dateRangeEndDate?: string, minimumRevenue?: number, maximumRevenue?: number, minimumSales?: number, maximumSales?: number, minimumBasketPercent?: number, maximumBasketPercent?: number, minimumTraffic?: number, maximumTraffic?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
|
|
2499
2566
|
/**
|
|
2500
2567
|
* Lists all product analytics items.
|
|
2501
2568
|
* @summary List product analytics
|
|
2502
2569
|
* @param {string} project What project it is
|
|
2503
2570
|
* @param {number} [pageToken] Page reference token
|
|
2504
|
-
* @param {string} [search] Search query string to filter results. Supports field-specific filters like \'enabled:true\', \'uuid:<id>\', \'name:\"product name\"\', \'tag:\"tag name\"\', and \'type:product,template,bundle\'. Multiple filters can be combined with spaces and commas.
|
|
2505
|
-
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
2506
2571
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
2572
|
+
* @param {string} [search] Search query string to filter results. Supports field-specific filters like: \'enabled:true\', \'gfn_product_ids:<id>\', \'tag:\"tag name\"\', \'internal_tag:\"internal tag name\"\', \'includeArchived:false\', \'hasSearchPhrase:false\', \'inDataFeeds:true\', \'aiOptimised:true\', \'productType:<id>\', \'genderGroup:\"male,female,unisex\"\', \'hasBarcode:true\', \'onSale:true\', \'type:product,template,bundle\', \'collection:<id>\'. Multiple filters can be combined with spaces and commas.
|
|
2573
|
+
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
2574
|
+
* @param {string} [dateRangeStartDate] Start date for the date range filter (ISO 8601 format)
|
|
2575
|
+
* @param {string} [dateRangeEndDate] End date for the date range filter (ISO 8601 format)
|
|
2576
|
+
* @param {number} [minimumRevenue] Filter to only include products with total revenue greater than or equal to this amount
|
|
2577
|
+
* @param {number} [maximumRevenue] Filter to only include products with total revenue less than or equal to this amount
|
|
2578
|
+
* @param {number} [minimumSales] Filter to only include products with total sales greater than or equal to this number
|
|
2579
|
+
* @param {number} [maximumSales] Filter to only include products with total sales less than or equal to this number
|
|
2580
|
+
* @param {number} [minimumBasketPercent] Filter to only include products where the average basket percentage is greater than or equal to this value
|
|
2581
|
+
* @param {number} [maximumBasketPercent] Filter to only include products where the average basket percentage is less than or equal to this value
|
|
2582
|
+
* @param {number} [minimumTraffic] Filter to only include products with total traffic greater than or equal to this number
|
|
2583
|
+
* @param {number} [maximumTraffic] Filter to only include products with total traffic less than or equal to this number
|
|
2507
2584
|
* @param {*} [options] Override http request option.
|
|
2508
2585
|
* @throws {RequiredError}
|
|
2509
2586
|
*/
|
|
2510
|
-
listProductAnalytics(project: string, pageToken?: number, search?: string, sortBy?: Array<string>,
|
|
2587
|
+
listProductAnalytics(project: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<string>, dateRangeStartDate?: string, dateRangeEndDate?: string, minimumRevenue?: number, maximumRevenue?: number, minimumSales?: number, maximumSales?: number, minimumBasketPercent?: number, maximumBasketPercent?: number, minimumTraffic?: number, maximumTraffic?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductAnalyticsResponse>>;
|
|
2511
2588
|
};
|
|
2512
2589
|
/**
|
|
2513
2590
|
* ProductAnalyticsApi - factory interface
|
|
2514
2591
|
*/
|
|
2515
2592
|
export declare const ProductAnalyticsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
2593
|
+
/**
|
|
2594
|
+
* Exports all products with analytics data in a CSV file.
|
|
2595
|
+
* @summary Export product analytics
|
|
2596
|
+
* @param {ProductAnalyticsApiExportProductAnalyticsRequest} requestParameters Request parameters.
|
|
2597
|
+
* @param {*} [options] Override http request option.
|
|
2598
|
+
* @throws {RequiredError}
|
|
2599
|
+
*/
|
|
2600
|
+
exportProductAnalytics(requestParameters: ProductAnalyticsApiExportProductAnalyticsRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
|
|
2516
2601
|
/**
|
|
2517
2602
|
* Lists all product analytics items.
|
|
2518
2603
|
* @summary List product analytics
|
|
@@ -2522,6 +2607,63 @@ export declare const ProductAnalyticsApiFactory: (configuration?: Configuration,
|
|
|
2522
2607
|
*/
|
|
2523
2608
|
listProductAnalytics(requestParameters: ProductAnalyticsApiListProductAnalyticsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProductAnalyticsResponse>;
|
|
2524
2609
|
};
|
|
2610
|
+
/**
|
|
2611
|
+
* Request parameters for exportProductAnalytics operation in ProductAnalyticsApi.
|
|
2612
|
+
*/
|
|
2613
|
+
export interface ProductAnalyticsApiExportProductAnalyticsRequest {
|
|
2614
|
+
/**
|
|
2615
|
+
* What project it is
|
|
2616
|
+
*/
|
|
2617
|
+
readonly project: string;
|
|
2618
|
+
/**
|
|
2619
|
+
* An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
2620
|
+
*/
|
|
2621
|
+
readonly sortBy?: Array<string>;
|
|
2622
|
+
/**
|
|
2623
|
+
* Search query string to filter results. Supports field-specific filters like: \'enabled:true\', \'gfn_product_ids:<id>\', \'tag:\"tag name\"\', \'internal_tag:\"internal tag name\"\', \'includeArchived:false\', \'hasSearchPhrase:false\', \'inDataFeeds:true\', \'aiOptimised:true\', \'productType:<id>\', \'genderGroup:\"male,female,unisex\"\', \'hasBarcode:true\', \'onSale:true\', \'type:product,template,bundle\', \'collection:<id>\'. Multiple filters can be combined with spaces and commas.
|
|
2624
|
+
*/
|
|
2625
|
+
readonly search?: string;
|
|
2626
|
+
/**
|
|
2627
|
+
* Start date for the date range filter (ISO 8601 format)
|
|
2628
|
+
*/
|
|
2629
|
+
readonly dateRangeStartDate?: string;
|
|
2630
|
+
/**
|
|
2631
|
+
* End date for the date range filter (ISO 8601 format)
|
|
2632
|
+
*/
|
|
2633
|
+
readonly dateRangeEndDate?: string;
|
|
2634
|
+
/**
|
|
2635
|
+
* Filter to only include products with total revenue greater than or equal to this amount
|
|
2636
|
+
*/
|
|
2637
|
+
readonly minimumRevenue?: number;
|
|
2638
|
+
/**
|
|
2639
|
+
* Filter to only include products with total revenue less than or equal to this amount
|
|
2640
|
+
*/
|
|
2641
|
+
readonly maximumRevenue?: number;
|
|
2642
|
+
/**
|
|
2643
|
+
* Filter to only include products with total sales greater than or equal to this number
|
|
2644
|
+
*/
|
|
2645
|
+
readonly minimumSales?: number;
|
|
2646
|
+
/**
|
|
2647
|
+
* Filter to only include products with total sales less than or equal to this number
|
|
2648
|
+
*/
|
|
2649
|
+
readonly maximumSales?: number;
|
|
2650
|
+
/**
|
|
2651
|
+
* Filter to only include products where the average basket percentage is greater than or equal to this value
|
|
2652
|
+
*/
|
|
2653
|
+
readonly minimumBasketPercent?: number;
|
|
2654
|
+
/**
|
|
2655
|
+
* Filter to only include products where the average basket percentage is less than or equal to this value
|
|
2656
|
+
*/
|
|
2657
|
+
readonly maximumBasketPercent?: number;
|
|
2658
|
+
/**
|
|
2659
|
+
* Filter to only include products with total traffic greater than or equal to this number
|
|
2660
|
+
*/
|
|
2661
|
+
readonly minimumTraffic?: number;
|
|
2662
|
+
/**
|
|
2663
|
+
* Filter to only include products with total traffic less than or equal to this number
|
|
2664
|
+
*/
|
|
2665
|
+
readonly maximumTraffic?: number;
|
|
2666
|
+
}
|
|
2525
2667
|
/**
|
|
2526
2668
|
* Request parameters for listProductAnalytics operation in ProductAnalyticsApi.
|
|
2527
2669
|
*/
|
|
@@ -2535,7 +2677,11 @@ export interface ProductAnalyticsApiListProductAnalyticsRequest {
|
|
|
2535
2677
|
*/
|
|
2536
2678
|
readonly pageToken?: number;
|
|
2537
2679
|
/**
|
|
2538
|
-
*
|
|
2680
|
+
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
2681
|
+
*/
|
|
2682
|
+
readonly pageSize?: number;
|
|
2683
|
+
/**
|
|
2684
|
+
* Search query string to filter results. Supports field-specific filters like: \'enabled:true\', \'gfn_product_ids:<id>\', \'tag:\"tag name\"\', \'internal_tag:\"internal tag name\"\', \'includeArchived:false\', \'hasSearchPhrase:false\', \'inDataFeeds:true\', \'aiOptimised:true\', \'productType:<id>\', \'genderGroup:\"male,female,unisex\"\', \'hasBarcode:true\', \'onSale:true\', \'type:product,template,bundle\', \'collection:<id>\'. Multiple filters can be combined with spaces and commas.
|
|
2539
2685
|
*/
|
|
2540
2686
|
readonly search?: string;
|
|
2541
2687
|
/**
|
|
@@ -2543,14 +2689,58 @@ export interface ProductAnalyticsApiListProductAnalyticsRequest {
|
|
|
2543
2689
|
*/
|
|
2544
2690
|
readonly sortBy?: Array<string>;
|
|
2545
2691
|
/**
|
|
2546
|
-
*
|
|
2692
|
+
* Start date for the date range filter (ISO 8601 format)
|
|
2547
2693
|
*/
|
|
2548
|
-
readonly
|
|
2694
|
+
readonly dateRangeStartDate?: string;
|
|
2695
|
+
/**
|
|
2696
|
+
* End date for the date range filter (ISO 8601 format)
|
|
2697
|
+
*/
|
|
2698
|
+
readonly dateRangeEndDate?: string;
|
|
2699
|
+
/**
|
|
2700
|
+
* Filter to only include products with total revenue greater than or equal to this amount
|
|
2701
|
+
*/
|
|
2702
|
+
readonly minimumRevenue?: number;
|
|
2703
|
+
/**
|
|
2704
|
+
* Filter to only include products with total revenue less than or equal to this amount
|
|
2705
|
+
*/
|
|
2706
|
+
readonly maximumRevenue?: number;
|
|
2707
|
+
/**
|
|
2708
|
+
* Filter to only include products with total sales greater than or equal to this number
|
|
2709
|
+
*/
|
|
2710
|
+
readonly minimumSales?: number;
|
|
2711
|
+
/**
|
|
2712
|
+
* Filter to only include products with total sales less than or equal to this number
|
|
2713
|
+
*/
|
|
2714
|
+
readonly maximumSales?: number;
|
|
2715
|
+
/**
|
|
2716
|
+
* Filter to only include products where the average basket percentage is greater than or equal to this value
|
|
2717
|
+
*/
|
|
2718
|
+
readonly minimumBasketPercent?: number;
|
|
2719
|
+
/**
|
|
2720
|
+
* Filter to only include products where the average basket percentage is less than or equal to this value
|
|
2721
|
+
*/
|
|
2722
|
+
readonly maximumBasketPercent?: number;
|
|
2723
|
+
/**
|
|
2724
|
+
* Filter to only include products with total traffic greater than or equal to this number
|
|
2725
|
+
*/
|
|
2726
|
+
readonly minimumTraffic?: number;
|
|
2727
|
+
/**
|
|
2728
|
+
* Filter to only include products with total traffic less than or equal to this number
|
|
2729
|
+
*/
|
|
2730
|
+
readonly maximumTraffic?: number;
|
|
2549
2731
|
}
|
|
2550
2732
|
/**
|
|
2551
2733
|
* ProductAnalyticsApi - object-oriented interface
|
|
2552
2734
|
*/
|
|
2553
2735
|
export declare class ProductAnalyticsApi extends BaseAPI {
|
|
2736
|
+
/**
|
|
2737
|
+
* Exports all products with analytics data in a CSV file.
|
|
2738
|
+
* @summary Export product analytics
|
|
2739
|
+
* @param {ProductAnalyticsApiExportProductAnalyticsRequest} requestParameters Request parameters.
|
|
2740
|
+
* @param {*} [options] Override http request option.
|
|
2741
|
+
* @throws {RequiredError}
|
|
2742
|
+
*/
|
|
2743
|
+
exportProductAnalytics(requestParameters: ProductAnalyticsApiExportProductAnalyticsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any, {}>>;
|
|
2554
2744
|
/**
|
|
2555
2745
|
* Lists all product analytics items.
|
|
2556
2746
|
* @summary List product analytics
|
|
@@ -2560,6 +2750,79 @@ export declare class ProductAnalyticsApi extends BaseAPI {
|
|
|
2560
2750
|
*/
|
|
2561
2751
|
listProductAnalytics(requestParameters: ProductAnalyticsApiListProductAnalyticsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProductAnalyticsResponse, any, {}>>;
|
|
2562
2752
|
}
|
|
2753
|
+
/**
|
|
2754
|
+
* ProductTypesApi - axios parameter creator
|
|
2755
|
+
*/
|
|
2756
|
+
export declare const ProductTypesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
2757
|
+
/**
|
|
2758
|
+
* Lists the product types used by the given project\'s catalog.
|
|
2759
|
+
* @summary List product types
|
|
2760
|
+
* @param {string} project What project it is
|
|
2761
|
+
* @param {number} [pageToken] Page reference token
|
|
2762
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
2763
|
+
* @param {*} [options] Override http request option.
|
|
2764
|
+
* @throws {RequiredError}
|
|
2765
|
+
*/
|
|
2766
|
+
listProductTypes: (project: string, pageToken?: number, pageSize?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2767
|
+
};
|
|
2768
|
+
/**
|
|
2769
|
+
* ProductTypesApi - functional programming interface
|
|
2770
|
+
*/
|
|
2771
|
+
export declare const ProductTypesApiFp: (configuration?: Configuration) => {
|
|
2772
|
+
/**
|
|
2773
|
+
* Lists the product types used by the given project\'s catalog.
|
|
2774
|
+
* @summary List product types
|
|
2775
|
+
* @param {string} project What project it is
|
|
2776
|
+
* @param {number} [pageToken] Page reference token
|
|
2777
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
2778
|
+
* @param {*} [options] Override http request option.
|
|
2779
|
+
* @throws {RequiredError}
|
|
2780
|
+
*/
|
|
2781
|
+
listProductTypes(project: string, pageToken?: number, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductTypeListResponse>>;
|
|
2782
|
+
};
|
|
2783
|
+
/**
|
|
2784
|
+
* ProductTypesApi - factory interface
|
|
2785
|
+
*/
|
|
2786
|
+
export declare const ProductTypesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
2787
|
+
/**
|
|
2788
|
+
* Lists the product types used by the given project\'s catalog.
|
|
2789
|
+
* @summary List product types
|
|
2790
|
+
* @param {ProductTypesApiListProductTypesRequest} requestParameters Request parameters.
|
|
2791
|
+
* @param {*} [options] Override http request option.
|
|
2792
|
+
* @throws {RequiredError}
|
|
2793
|
+
*/
|
|
2794
|
+
listProductTypes(requestParameters: ProductTypesApiListProductTypesRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProductTypeListResponse>;
|
|
2795
|
+
};
|
|
2796
|
+
/**
|
|
2797
|
+
* Request parameters for listProductTypes operation in ProductTypesApi.
|
|
2798
|
+
*/
|
|
2799
|
+
export interface ProductTypesApiListProductTypesRequest {
|
|
2800
|
+
/**
|
|
2801
|
+
* What project it is
|
|
2802
|
+
*/
|
|
2803
|
+
readonly project: string;
|
|
2804
|
+
/**
|
|
2805
|
+
* Page reference token
|
|
2806
|
+
*/
|
|
2807
|
+
readonly pageToken?: number;
|
|
2808
|
+
/**
|
|
2809
|
+
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
2810
|
+
*/
|
|
2811
|
+
readonly pageSize?: number;
|
|
2812
|
+
}
|
|
2813
|
+
/**
|
|
2814
|
+
* ProductTypesApi - object-oriented interface
|
|
2815
|
+
*/
|
|
2816
|
+
export declare class ProductTypesApi extends BaseAPI {
|
|
2817
|
+
/**
|
|
2818
|
+
* Lists the product types used by the given project\'s catalog.
|
|
2819
|
+
* @summary List product types
|
|
2820
|
+
* @param {ProductTypesApiListProductTypesRequest} requestParameters Request parameters.
|
|
2821
|
+
* @param {*} [options] Override http request option.
|
|
2822
|
+
* @throws {RequiredError}
|
|
2823
|
+
*/
|
|
2824
|
+
listProductTypes(requestParameters: ProductTypesApiListProductTypesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProductTypeListResponse, any, {}>>;
|
|
2825
|
+
}
|
|
2563
2826
|
/**
|
|
2564
2827
|
* ProductsApi - axios parameter creator
|
|
2565
2828
|
*/
|
|
@@ -2604,10 +2867,16 @@ export declare const ProductsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
2604
2867
|
* Export the project\'s products and variants as a CSV file.
|
|
2605
2868
|
* @summary Export products
|
|
2606
2869
|
* @param {string} project What project it is
|
|
2870
|
+
* @param {string} [search] Search query string to filter results. Supports field-specific filters like: \'enabled:true\', \'gfn_product_ids:<id>\', \'tag:\"tag name\"\', \'internal_tag:\"internal tag name\"\', \'includeArchived:false\', \'hasSearchPhrase:false\', \'inDataFeeds:true\', \'aiOptimised:true\', \'productType:<id>\', \'genderGroup:\"male,female,unisex\"\', \'hasBarcode:true\', \'onSale:true\', \'type:product,template,bundle\', \'collection:<id>\'. Multiple filters can be combined with spaces and commas.
|
|
2871
|
+
* @param {string} [start] Start of date range to filter
|
|
2872
|
+
* @param {string} [end] End of date range to filter
|
|
2873
|
+
* @param {ExportProductsDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
2874
|
+
* @param {number} [maxRetailPrice] Specify the maximum retail price to filter by. Products will be included so long as either at least one variant or the product itself (in the case of bundles) has a retail price less than or equal to the specified value.
|
|
2875
|
+
* @param {number} [minRetailPrice] Specify the minimum retail price to filter by. Products will be included so long as either at least one variant or the product itself (in the case of bundles) has a retail price greater than or equal to the specified value.
|
|
2607
2876
|
* @param {*} [options] Override http request option.
|
|
2608
2877
|
* @throws {RequiredError}
|
|
2609
2878
|
*/
|
|
2610
|
-
exportProducts: (project: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2879
|
+
exportProducts: (project: string, search?: string, start?: string, end?: string, dateFilterType?: ExportProductsDateFilterTypeEnum, maxRetailPrice?: number, minRetailPrice?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2611
2880
|
/**
|
|
2612
2881
|
* Gets a product by a given ID.
|
|
2613
2882
|
* @summary Get product
|
|
@@ -2632,17 +2901,19 @@ export declare const ProductsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
2632
2901
|
* @summary List products
|
|
2633
2902
|
* @param {string} project What project it is
|
|
2634
2903
|
* @param {number} [pageToken] Page reference token
|
|
2635
|
-
* @param {string} [search] Search query string to filter results. Supports field-specific filters like \'enabled:true\', \'
|
|
2904
|
+
* @param {string} [search] Search query string to filter results. Supports field-specific filters like: \'enabled:true\', \'gfn_product_ids:<id>\', \'tag:\"tag name\"\', \'internal_tag:\"internal tag name\"\', \'includeArchived:false\', \'hasSearchPhrase:false\', \'inDataFeeds:true\', \'aiOptimised:true\', \'productType:<id>\', \'genderGroup:\"male,female,unisex\"\', \'hasBarcode:true\', \'onSale:true\', \'type:product,template,bundle\', \'collection:<id>\'. Multiple filters can be combined with spaces and commas.
|
|
2636
2905
|
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
2637
2906
|
* @param {string} [start] Start of date range to filter
|
|
2638
2907
|
* @param {string} [end] End of date range to filter
|
|
2639
2908
|
* @param {ListProductsDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
2909
|
+
* @param {number} [maxRetailPrice] Specify the maximum retail price to filter by. Products will be included so long as either at least one variant or the product itself (in the case of bundles) has a retail price less than or equal to the specified value.
|
|
2910
|
+
* @param {number} [minRetailPrice] Specify the minimum retail price to filter by. Products will be included so long as either at least one variant or the product itself (in the case of bundles) has a retail price greater than or equal to the specified value.
|
|
2640
2911
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
2641
2912
|
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
2642
2913
|
* @param {*} [options] Override http request option.
|
|
2643
2914
|
* @throws {RequiredError}
|
|
2644
2915
|
*/
|
|
2645
|
-
listProducts: (project: string, pageToken?: number, search?: string, sortBy?: Array<string>, start?: string, end?: string, dateFilterType?: ListProductsDateFilterTypeEnum, pageSize?: number, fields?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2916
|
+
listProducts: (project: string, pageToken?: number, search?: string, sortBy?: Array<string>, start?: string, end?: string, dateFilterType?: ListProductsDateFilterTypeEnum, maxRetailPrice?: number, minRetailPrice?: number, pageSize?: number, fields?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2646
2917
|
/**
|
|
2647
2918
|
* AI SEO optimises products by a set of given IDs.
|
|
2648
2919
|
* @summary AI SEO optimise products.
|
|
@@ -2716,10 +2987,16 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
|
|
|
2716
2987
|
* Export the project\'s products and variants as a CSV file.
|
|
2717
2988
|
* @summary Export products
|
|
2718
2989
|
* @param {string} project What project it is
|
|
2990
|
+
* @param {string} [search] Search query string to filter results. Supports field-specific filters like: \'enabled:true\', \'gfn_product_ids:<id>\', \'tag:\"tag name\"\', \'internal_tag:\"internal tag name\"\', \'includeArchived:false\', \'hasSearchPhrase:false\', \'inDataFeeds:true\', \'aiOptimised:true\', \'productType:<id>\', \'genderGroup:\"male,female,unisex\"\', \'hasBarcode:true\', \'onSale:true\', \'type:product,template,bundle\', \'collection:<id>\'. Multiple filters can be combined with spaces and commas.
|
|
2991
|
+
* @param {string} [start] Start of date range to filter
|
|
2992
|
+
* @param {string} [end] End of date range to filter
|
|
2993
|
+
* @param {ExportProductsDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
2994
|
+
* @param {number} [maxRetailPrice] Specify the maximum retail price to filter by. Products will be included so long as either at least one variant or the product itself (in the case of bundles) has a retail price less than or equal to the specified value.
|
|
2995
|
+
* @param {number} [minRetailPrice] Specify the minimum retail price to filter by. Products will be included so long as either at least one variant or the product itself (in the case of bundles) has a retail price greater than or equal to the specified value.
|
|
2719
2996
|
* @param {*} [options] Override http request option.
|
|
2720
2997
|
* @throws {RequiredError}
|
|
2721
2998
|
*/
|
|
2722
|
-
exportProducts(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
|
|
2999
|
+
exportProducts(project: string, search?: string, start?: string, end?: string, dateFilterType?: ExportProductsDateFilterTypeEnum, maxRetailPrice?: number, minRetailPrice?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
|
|
2723
3000
|
/**
|
|
2724
3001
|
* Gets a product by a given ID.
|
|
2725
3002
|
* @summary Get product
|
|
@@ -2744,17 +3021,19 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
|
|
|
2744
3021
|
* @summary List products
|
|
2745
3022
|
* @param {string} project What project it is
|
|
2746
3023
|
* @param {number} [pageToken] Page reference token
|
|
2747
|
-
* @param {string} [search] Search query string to filter results. Supports field-specific filters like \'enabled:true\', \'
|
|
3024
|
+
* @param {string} [search] Search query string to filter results. Supports field-specific filters like: \'enabled:true\', \'gfn_product_ids:<id>\', \'tag:\"tag name\"\', \'internal_tag:\"internal tag name\"\', \'includeArchived:false\', \'hasSearchPhrase:false\', \'inDataFeeds:true\', \'aiOptimised:true\', \'productType:<id>\', \'genderGroup:\"male,female,unisex\"\', \'hasBarcode:true\', \'onSale:true\', \'type:product,template,bundle\', \'collection:<id>\'. Multiple filters can be combined with spaces and commas.
|
|
2748
3025
|
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
2749
3026
|
* @param {string} [start] Start of date range to filter
|
|
2750
3027
|
* @param {string} [end] End of date range to filter
|
|
2751
3028
|
* @param {ListProductsDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
3029
|
+
* @param {number} [maxRetailPrice] Specify the maximum retail price to filter by. Products will be included so long as either at least one variant or the product itself (in the case of bundles) has a retail price less than or equal to the specified value.
|
|
3030
|
+
* @param {number} [minRetailPrice] Specify the minimum retail price to filter by. Products will be included so long as either at least one variant or the product itself (in the case of bundles) has a retail price greater than or equal to the specified value.
|
|
2752
3031
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
2753
3032
|
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
2754
3033
|
* @param {*} [options] Override http request option.
|
|
2755
3034
|
* @throws {RequiredError}
|
|
2756
3035
|
*/
|
|
2757
|
-
listProducts(project: string, pageToken?: number, search?: string, sortBy?: Array<string>, start?: string, end?: string, dateFilterType?: ListProductsDateFilterTypeEnum, pageSize?: number, fields?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductsResponse>>;
|
|
3036
|
+
listProducts(project: string, pageToken?: number, search?: string, sortBy?: Array<string>, start?: string, end?: string, dateFilterType?: ListProductsDateFilterTypeEnum, maxRetailPrice?: number, minRetailPrice?: number, pageSize?: number, fields?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductsResponse>>;
|
|
2758
3037
|
/**
|
|
2759
3038
|
* AI SEO optimises products by a set of given IDs.
|
|
2760
3039
|
* @summary AI SEO optimise products.
|
|
@@ -2934,6 +3213,30 @@ export interface ProductsApiExportProductsRequest {
|
|
|
2934
3213
|
* What project it is
|
|
2935
3214
|
*/
|
|
2936
3215
|
readonly project: string;
|
|
3216
|
+
/**
|
|
3217
|
+
* Search query string to filter results. Supports field-specific filters like: \'enabled:true\', \'gfn_product_ids:<id>\', \'tag:\"tag name\"\', \'internal_tag:\"internal tag name\"\', \'includeArchived:false\', \'hasSearchPhrase:false\', \'inDataFeeds:true\', \'aiOptimised:true\', \'productType:<id>\', \'genderGroup:\"male,female,unisex\"\', \'hasBarcode:true\', \'onSale:true\', \'type:product,template,bundle\', \'collection:<id>\'. Multiple filters can be combined with spaces and commas.
|
|
3218
|
+
*/
|
|
3219
|
+
readonly search?: string;
|
|
3220
|
+
/**
|
|
3221
|
+
* Start of date range to filter
|
|
3222
|
+
*/
|
|
3223
|
+
readonly start?: string;
|
|
3224
|
+
/**
|
|
3225
|
+
* End of date range to filter
|
|
3226
|
+
*/
|
|
3227
|
+
readonly end?: string;
|
|
3228
|
+
/**
|
|
3229
|
+
* Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
3230
|
+
*/
|
|
3231
|
+
readonly dateFilterType?: ExportProductsDateFilterTypeEnum;
|
|
3232
|
+
/**
|
|
3233
|
+
* Specify the maximum retail price to filter by. Products will be included so long as either at least one variant or the product itself (in the case of bundles) has a retail price less than or equal to the specified value.
|
|
3234
|
+
*/
|
|
3235
|
+
readonly maxRetailPrice?: number;
|
|
3236
|
+
/**
|
|
3237
|
+
* Specify the minimum retail price to filter by. Products will be included so long as either at least one variant or the product itself (in the case of bundles) has a retail price greater than or equal to the specified value.
|
|
3238
|
+
*/
|
|
3239
|
+
readonly minRetailPrice?: number;
|
|
2937
3240
|
}
|
|
2938
3241
|
/**
|
|
2939
3242
|
* Request parameters for getProduct operation in ProductsApi.
|
|
@@ -2978,7 +3281,7 @@ export interface ProductsApiListProductsRequest {
|
|
|
2978
3281
|
*/
|
|
2979
3282
|
readonly pageToken?: number;
|
|
2980
3283
|
/**
|
|
2981
|
-
* Search query string to filter results. Supports field-specific filters like \'enabled:true\', \'
|
|
3284
|
+
* Search query string to filter results. Supports field-specific filters like: \'enabled:true\', \'gfn_product_ids:<id>\', \'tag:\"tag name\"\', \'internal_tag:\"internal tag name\"\', \'includeArchived:false\', \'hasSearchPhrase:false\', \'inDataFeeds:true\', \'aiOptimised:true\', \'productType:<id>\', \'genderGroup:\"male,female,unisex\"\', \'hasBarcode:true\', \'onSale:true\', \'type:product,template,bundle\', \'collection:<id>\'. Multiple filters can be combined with spaces and commas.
|
|
2982
3285
|
*/
|
|
2983
3286
|
readonly search?: string;
|
|
2984
3287
|
/**
|
|
@@ -2997,6 +3300,14 @@ export interface ProductsApiListProductsRequest {
|
|
|
2997
3300
|
* Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
2998
3301
|
*/
|
|
2999
3302
|
readonly dateFilterType?: ListProductsDateFilterTypeEnum;
|
|
3303
|
+
/**
|
|
3304
|
+
* Specify the maximum retail price to filter by. Products will be included so long as either at least one variant or the product itself (in the case of bundles) has a retail price less than or equal to the specified value.
|
|
3305
|
+
*/
|
|
3306
|
+
readonly maxRetailPrice?: number;
|
|
3307
|
+
/**
|
|
3308
|
+
* Specify the minimum retail price to filter by. Products will be included so long as either at least one variant or the product itself (in the case of bundles) has a retail price greater than or equal to the specified value.
|
|
3309
|
+
*/
|
|
3310
|
+
readonly minRetailPrice?: number;
|
|
3000
3311
|
/**
|
|
3001
3312
|
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
3002
3313
|
*/
|
|
@@ -3139,6 +3450,11 @@ export declare class ProductsApi extends BaseAPI {
|
|
|
3139
3450
|
*/
|
|
3140
3451
|
updateProducts(requestParameters: ProductsApiUpdateProductsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProductsResponse, any, {}>>;
|
|
3141
3452
|
}
|
|
3453
|
+
export declare const ExportProductsDateFilterTypeEnum: {
|
|
3454
|
+
readonly CreatedAt: "createdAt";
|
|
3455
|
+
readonly UpdatedAt: "updatedAt";
|
|
3456
|
+
};
|
|
3457
|
+
export type ExportProductsDateFilterTypeEnum = typeof ExportProductsDateFilterTypeEnum[keyof typeof ExportProductsDateFilterTypeEnum];
|
|
3142
3458
|
export declare const ListProductsDateFilterTypeEnum: {
|
|
3143
3459
|
readonly CreatedAt: "createdAt";
|
|
3144
3460
|
readonly UpdatedAt: "updatedAt";
|
|
@@ -3162,7 +3478,7 @@ export declare const VariantsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
3162
3478
|
* Lists all variants that belong to enabled products attached to the given project.
|
|
3163
3479
|
* @summary List variants
|
|
3164
3480
|
* @param {string} project What project it is
|
|
3165
|
-
* @param {string} [search] Search query string to filter results. Supports field-specific filters like \'enabled:true\', \'
|
|
3481
|
+
* @param {string} [search] Search query string to filter results. Supports field-specific filters like: \'enabled:true\', \'gfn_product_ids:<id>\', \'tag:\"tag name\"\', \'internal_tag:\"internal tag name\"\', \'includeArchived:false\', \'hasSearchPhrase:false\', \'inDataFeeds:true\', \'aiOptimised:true\', \'productType:<id>\', \'genderGroup:\"male,female,unisex\"\', \'hasBarcode:true\', \'onSale:true\', \'type:product,template,bundle\', \'collection:<id>\'. Multiple filters can be combined with spaces and commas.
|
|
3166
3482
|
* @param {number} [pageToken] Page reference token
|
|
3167
3483
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
3168
3484
|
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
@@ -3189,7 +3505,7 @@ export declare const VariantsApiFp: (configuration?: Configuration) => {
|
|
|
3189
3505
|
* Lists all variants that belong to enabled products attached to the given project.
|
|
3190
3506
|
* @summary List variants
|
|
3191
3507
|
* @param {string} project What project it is
|
|
3192
|
-
* @param {string} [search] Search query string to filter results. Supports field-specific filters like \'enabled:true\', \'
|
|
3508
|
+
* @param {string} [search] Search query string to filter results. Supports field-specific filters like: \'enabled:true\', \'gfn_product_ids:<id>\', \'tag:\"tag name\"\', \'internal_tag:\"internal tag name\"\', \'includeArchived:false\', \'hasSearchPhrase:false\', \'inDataFeeds:true\', \'aiOptimised:true\', \'productType:<id>\', \'genderGroup:\"male,female,unisex\"\', \'hasBarcode:true\', \'onSale:true\', \'type:product,template,bundle\', \'collection:<id>\'. Multiple filters can be combined with spaces and commas.
|
|
3193
3509
|
* @param {number} [pageToken] Page reference token
|
|
3194
3510
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
3195
3511
|
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
@@ -3245,7 +3561,7 @@ export interface VariantsApiListVariantsRequest {
|
|
|
3245
3561
|
*/
|
|
3246
3562
|
readonly project: string;
|
|
3247
3563
|
/**
|
|
3248
|
-
* Search query string to filter results. Supports field-specific filters like \'enabled:true\', \'
|
|
3564
|
+
* Search query string to filter results. Supports field-specific filters like: \'enabled:true\', \'gfn_product_ids:<id>\', \'tag:\"tag name\"\', \'internal_tag:\"internal tag name\"\', \'includeArchived:false\', \'hasSearchPhrase:false\', \'inDataFeeds:true\', \'aiOptimised:true\', \'productType:<id>\', \'genderGroup:\"male,female,unisex\"\', \'hasBarcode:true\', \'onSale:true\', \'type:product,template,bundle\', \'collection:<id>\'. Multiple filters can be combined with spaces and commas.
|
|
3249
3565
|
*/
|
|
3250
3566
|
readonly search?: string;
|
|
3251
3567
|
/**
|