@teemill/product-catalog 1.95.0 → 1.96.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/.openapi-generator/FILES +11 -0
- package/.openapi-generator/VERSION +1 -1
- package/README.md +16 -2
- package/api.ts +450 -20
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +3 -3
- package/dist/api.d.ts +275 -7
- package/dist/api.js +262 -18
- 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 +3 -3
- package/dist/esm/api.d.ts +275 -7
- package/dist/esm/api.js +262 -18
- 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 +3 -3
- 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/Application.md +1 -1
- package/docs/BulkUpdateMarketplaceListing.md +23 -0
- package/docs/BulkUpdateMarketplaceListingProduct.md +33 -0
- package/docs/BulkUpdateMarketplaceListingRequest.md +21 -0
- package/docs/BulkUpdateMarketplaceListingResponse.md +21 -0
- package/docs/BulkUpdatedMarketplaceListing.md +23 -0
- package/docs/BulkUpdatedMarketplaceListings.md +23 -0
- package/docs/CreateApplication.md +1 -1
- package/docs/MarketplaceListing.md +35 -0
- package/docs/MarketplaceListingFields.md +31 -0
- package/docs/MarketplaceListingsResponse.md +20 -0
- package/docs/Product.md +2 -0
- package/docs/ProductsApi.md +189 -1
- package/docs/UpdateMarketplaceListing.md +33 -0
- package/docs/UpdateMarketplaceListingRequest.md +21 -0
- package/index.ts +1 -1
- package/package.json +2 -2
package/api.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Product Catalog
|
|
5
5
|
* 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 product from the GFN Catalog, plus listing information such as title, description and tags.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.
|
|
7
|
+
* The version of the OpenAPI document: 1.96.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -128,7 +128,7 @@ export interface Application {
|
|
|
128
128
|
*/
|
|
129
129
|
'id'?: string;
|
|
130
130
|
/**
|
|
131
|
-
* The application technology used for this design application. `mug_sublimation` is deprecated. Use `
|
|
131
|
+
* The application technology used for this design application. `mug_sublimation` is deprecated. Use `mini_sublimation` instead.
|
|
132
132
|
*/
|
|
133
133
|
'technology': ApplicationTechnologyEnum;
|
|
134
134
|
/**
|
|
@@ -165,7 +165,7 @@ export const ApplicationTechnologyEnum = {
|
|
|
165
165
|
Dtf: 'dtf',
|
|
166
166
|
Pretreat: 'pretreat',
|
|
167
167
|
MugSublimation: 'mug_sublimation',
|
|
168
|
-
|
|
168
|
+
MiniSublimation: 'mini_sublimation',
|
|
169
169
|
ManualPrint: 'manual_print',
|
|
170
170
|
AdditionalApplication: 'additional_application',
|
|
171
171
|
NotebookSublimation: 'notebook_sublimation',
|
|
@@ -535,6 +535,63 @@ export const AutoMerchProductsRequestFieldsEnum = {
|
|
|
535
535
|
|
|
536
536
|
export type AutoMerchProductsRequestFieldsEnum = typeof AutoMerchProductsRequestFieldsEnum[keyof typeof AutoMerchProductsRequestFieldsEnum];
|
|
537
537
|
|
|
538
|
+
/**
|
|
539
|
+
* Product marketplace listing updates grouped by marketplace.
|
|
540
|
+
*/
|
|
541
|
+
export interface BulkUpdateMarketplaceListing {
|
|
542
|
+
/**
|
|
543
|
+
* The marketplace code to update.
|
|
544
|
+
*/
|
|
545
|
+
'code': string;
|
|
546
|
+
'products': Array<BulkUpdateMarketplaceListingProduct>;
|
|
547
|
+
}
|
|
548
|
+
/**
|
|
549
|
+
* Marketplace listing fields to update for a single product within a marketplace group.
|
|
550
|
+
*/
|
|
551
|
+
export interface BulkUpdateMarketplaceListingProduct {
|
|
552
|
+
/**
|
|
553
|
+
* Unique object identifier
|
|
554
|
+
*/
|
|
555
|
+
'id': string;
|
|
556
|
+
'title'?: string | null;
|
|
557
|
+
'description'?: string | null;
|
|
558
|
+
'metaTitle'?: string | null;
|
|
559
|
+
'metaDescription'?: string | null;
|
|
560
|
+
'price'?: number | null;
|
|
561
|
+
'images'?: Array<ImageFile> | null;
|
|
562
|
+
}
|
|
563
|
+
/**
|
|
564
|
+
* Listing updates scoped to exactly one marketplace per HTTP request. To change another marketplace, issue another request.
|
|
565
|
+
*/
|
|
566
|
+
export interface BulkUpdateMarketplaceListingRequest {
|
|
567
|
+
/**
|
|
568
|
+
* Must contain exactly one marketplace group (`code` plus the `products` to update).
|
|
569
|
+
*/
|
|
570
|
+
'marketplace': Array<BulkUpdateMarketplaceListing>;
|
|
571
|
+
}
|
|
572
|
+
/**
|
|
573
|
+
* Updated marketplace listing data grouped by marketplace.
|
|
574
|
+
*/
|
|
575
|
+
export interface BulkUpdateMarketplaceListingResponse {
|
|
576
|
+
'marketplaceListings': Array<BulkUpdatedMarketplaceListings>;
|
|
577
|
+
}
|
|
578
|
+
/**
|
|
579
|
+
* Updated marketplace listing data for a product.
|
|
580
|
+
*/
|
|
581
|
+
export interface BulkUpdatedMarketplaceListing {
|
|
582
|
+
/**
|
|
583
|
+
* Unique object identifier
|
|
584
|
+
*/
|
|
585
|
+
'id': string;
|
|
586
|
+
'listing': MarketplaceListingFields | null;
|
|
587
|
+
}
|
|
588
|
+
/**
|
|
589
|
+
* Updated product listings for a marketplace.
|
|
590
|
+
*/
|
|
591
|
+
export interface BulkUpdatedMarketplaceListings {
|
|
592
|
+
'code': string;
|
|
593
|
+
'products': Array<BulkUpdatedMarketplaceListing>;
|
|
594
|
+
}
|
|
538
595
|
/**
|
|
539
596
|
* A bundle product that groups multiple items together at a combined price.
|
|
540
597
|
*/
|
|
@@ -648,7 +705,7 @@ export interface BundleProduct {
|
|
|
648
705
|
*/
|
|
649
706
|
export interface CreateApplication {
|
|
650
707
|
/**
|
|
651
|
-
* The application technology used for this design application. `mug_sublimation` is deprecated. Use `
|
|
708
|
+
* The application technology used for this design application. `mug_sublimation` is deprecated. Use `mini_sublimation` instead.
|
|
652
709
|
*/
|
|
653
710
|
'technology': CreateApplicationTechnologyEnum;
|
|
654
711
|
/**
|
|
@@ -684,7 +741,7 @@ export const CreateApplicationTechnologyEnum = {
|
|
|
684
741
|
Dtf: 'dtf',
|
|
685
742
|
Pretreat: 'pretreat',
|
|
686
743
|
MugSublimation: 'mug_sublimation',
|
|
687
|
-
|
|
744
|
+
MiniSublimation: 'mini_sublimation',
|
|
688
745
|
ManualPrint: 'manual_print',
|
|
689
746
|
AdditionalApplication: 'additional_application',
|
|
690
747
|
NotebookSublimation: 'notebook_sublimation',
|
|
@@ -1225,6 +1282,39 @@ export interface Location {
|
|
|
1225
1282
|
*/
|
|
1226
1283
|
'country': string;
|
|
1227
1284
|
}
|
|
1285
|
+
/**
|
|
1286
|
+
* Product listing data for a marketplace.
|
|
1287
|
+
*/
|
|
1288
|
+
export interface MarketplaceListing {
|
|
1289
|
+
/**
|
|
1290
|
+
* The marketplace code.
|
|
1291
|
+
*/
|
|
1292
|
+
'code': string;
|
|
1293
|
+
/**
|
|
1294
|
+
* The display name of the marketplace.
|
|
1295
|
+
*/
|
|
1296
|
+
'name': string;
|
|
1297
|
+
'title'?: string | null;
|
|
1298
|
+
'description'?: string | null;
|
|
1299
|
+
'metaTitle'?: string | null;
|
|
1300
|
+
'metaDescription'?: string | null;
|
|
1301
|
+
'price'?: number | null;
|
|
1302
|
+
'images'?: Array<Image>;
|
|
1303
|
+
}
|
|
1304
|
+
/**
|
|
1305
|
+
* Product listing fields for a marketplace.
|
|
1306
|
+
*/
|
|
1307
|
+
export interface MarketplaceListingFields {
|
|
1308
|
+
'title'?: string | null;
|
|
1309
|
+
'description'?: string | null;
|
|
1310
|
+
'metaTitle'?: string | null;
|
|
1311
|
+
'metaDescription'?: string | null;
|
|
1312
|
+
'price'?: number | null;
|
|
1313
|
+
'images'?: Array<Image> | null;
|
|
1314
|
+
}
|
|
1315
|
+
export interface MarketplaceListingsResponse {
|
|
1316
|
+
'marketplaceListings': Array<MarketplaceListing>;
|
|
1317
|
+
}
|
|
1228
1318
|
/**
|
|
1229
1319
|
* Key/value pairs that can be used to store additional information on the product
|
|
1230
1320
|
*/
|
|
@@ -1394,6 +1484,10 @@ export interface Product {
|
|
|
1394
1484
|
*/
|
|
1395
1485
|
'optimisationHistory'?: Array<OptimisationHistoryItem>;
|
|
1396
1486
|
'integrationConnections'?: Array<UpdateProductsRequestProductsInnerIntegrationConnectionsInner>;
|
|
1487
|
+
/**
|
|
1488
|
+
* Marketplace-specific listing data that can override product fields during integration syncs.
|
|
1489
|
+
*/
|
|
1490
|
+
'marketplaceListings'?: Array<MarketplaceListing>;
|
|
1397
1491
|
/**
|
|
1398
1492
|
* Whether to show a sale badge on the product
|
|
1399
1493
|
*/
|
|
@@ -1978,6 +2072,27 @@ export interface UpdateApplicationSetRequestRecordsInnerAttributesInner {
|
|
|
1978
2072
|
*/
|
|
1979
2073
|
'value'?: string;
|
|
1980
2074
|
}
|
|
2075
|
+
/**
|
|
2076
|
+
* Marketplace listing fields to update for a product.
|
|
2077
|
+
*/
|
|
2078
|
+
export interface UpdateMarketplaceListing {
|
|
2079
|
+
/**
|
|
2080
|
+
* The marketplace code to update.
|
|
2081
|
+
*/
|
|
2082
|
+
'code': string;
|
|
2083
|
+
'title'?: string | null;
|
|
2084
|
+
'description'?: string | null;
|
|
2085
|
+
'metaTitle'?: string | null;
|
|
2086
|
+
'metaDescription'?: string | null;
|
|
2087
|
+
'price'?: number | null;
|
|
2088
|
+
'images'?: Array<ImageFile> | null;
|
|
2089
|
+
}
|
|
2090
|
+
/**
|
|
2091
|
+
* Marketplace listings to update for a product.
|
|
2092
|
+
*/
|
|
2093
|
+
export interface UpdateMarketplaceListingRequest {
|
|
2094
|
+
'marketplaces': Array<UpdateMarketplaceListing>;
|
|
2095
|
+
}
|
|
1981
2096
|
export interface UpdateProductRequest {
|
|
1982
2097
|
/**
|
|
1983
2098
|
* Reference to the product in the GFN catalog that will be used as a base for this product. A list of available products for the given project can be obtained from the GFN Catalog API.
|
|
@@ -2560,7 +2675,7 @@ export const ApplicationGroupsApiAxiosParamCreator = function (configuration?: C
|
|
|
2560
2675
|
// verify required parameter 'applicationGroupId' is not null or undefined
|
|
2561
2676
|
assertParamExists('deleteApplicationGroup', 'applicationGroupId', applicationGroupId)
|
|
2562
2677
|
const localVarPath = `/v1/catalog/applications/groups/{applicationGroupId}`
|
|
2563
|
-
.replace(
|
|
2678
|
+
.replace('{applicationGroupId}', encodeURIComponent(String(applicationGroupId)));
|
|
2564
2679
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2565
2680
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2566
2681
|
let baseOptions;
|
|
@@ -2608,7 +2723,7 @@ export const ApplicationGroupsApiAxiosParamCreator = function (configuration?: C
|
|
|
2608
2723
|
// verify required parameter 'applicationGroupId' is not null or undefined
|
|
2609
2724
|
assertParamExists('getApplicationGroup', 'applicationGroupId', applicationGroupId)
|
|
2610
2725
|
const localVarPath = `/v1/catalog/applications/groups/{applicationGroupId}`
|
|
2611
|
-
.replace(
|
|
2726
|
+
.replace('{applicationGroupId}', encodeURIComponent(String(applicationGroupId)));
|
|
2612
2727
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2613
2728
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2614
2729
|
let baseOptions;
|
|
@@ -2716,7 +2831,7 @@ export const ApplicationGroupsApiAxiosParamCreator = function (configuration?: C
|
|
|
2716
2831
|
// verify required parameter 'applicationGroupId' is not null or undefined
|
|
2717
2832
|
assertParamExists('updateApplicationGroup', 'applicationGroupId', applicationGroupId)
|
|
2718
2833
|
const localVarPath = `/v1/catalog/applications/groups/{applicationGroupId}`
|
|
2719
|
-
.replace(
|
|
2834
|
+
.replace('{applicationGroupId}', encodeURIComponent(String(applicationGroupId)));
|
|
2720
2835
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2721
2836
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2722
2837
|
let baseOptions;
|
|
@@ -3114,7 +3229,7 @@ export const ApplicationSetsApiAxiosParamCreator = function (configuration?: Con
|
|
|
3114
3229
|
// verify required parameter 'applicationSetId' is not null or undefined
|
|
3115
3230
|
assertParamExists('deleteApplicationSet', 'applicationSetId', applicationSetId)
|
|
3116
3231
|
const localVarPath = `/v1/catalog/applications/sets/{applicationSetId}`
|
|
3117
|
-
.replace(
|
|
3232
|
+
.replace('{applicationSetId}', encodeURIComponent(String(applicationSetId)));
|
|
3118
3233
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3119
3234
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
3120
3235
|
let baseOptions;
|
|
@@ -3162,7 +3277,7 @@ export const ApplicationSetsApiAxiosParamCreator = function (configuration?: Con
|
|
|
3162
3277
|
// verify required parameter 'applicationSetId' is not null or undefined
|
|
3163
3278
|
assertParamExists('getApplicationSet', 'applicationSetId', applicationSetId)
|
|
3164
3279
|
const localVarPath = `/v1/catalog/applications/sets/{applicationSetId}`
|
|
3165
|
-
.replace(
|
|
3280
|
+
.replace('{applicationSetId}', encodeURIComponent(String(applicationSetId)));
|
|
3166
3281
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3167
3282
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
3168
3283
|
let baseOptions;
|
|
@@ -3270,7 +3385,7 @@ export const ApplicationSetsApiAxiosParamCreator = function (configuration?: Con
|
|
|
3270
3385
|
// verify required parameter 'applicationSetId' is not null or undefined
|
|
3271
3386
|
assertParamExists('updateApplicationSet', 'applicationSetId', applicationSetId)
|
|
3272
3387
|
const localVarPath = `/v1/catalog/applications/sets/{applicationSetId}`
|
|
3273
|
-
.replace(
|
|
3388
|
+
.replace('{applicationSetId}', encodeURIComponent(String(applicationSetId)));
|
|
3274
3389
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3275
3390
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
3276
3391
|
let baseOptions;
|
|
@@ -4778,6 +4893,55 @@ export const ProductsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
4778
4893
|
options: localVarRequestOptions,
|
|
4779
4894
|
};
|
|
4780
4895
|
},
|
|
4896
|
+
/**
|
|
4897
|
+
* Updates marketplace listing data for multiple products under a single marketplace. Each request carries exactly one marketplace group (see `BulkUpdateMarketplaceListingRequest.marketplace`); send additional requests to update another marketplace code.
|
|
4898
|
+
* @summary Bulk update product marketplaces
|
|
4899
|
+
* @param {string} project What project it is
|
|
4900
|
+
* @param {BulkUpdateMarketplaceListingRequest} bulkUpdateMarketplaceListingRequest Update marketplace listing fields for multiple products for one marketplace only. The `marketplaces` array must contain exactly one item (one `code` and its `products`).
|
|
4901
|
+
* @param {*} [options] Override http request option.
|
|
4902
|
+
* @throws {RequiredError}
|
|
4903
|
+
*/
|
|
4904
|
+
bulkUpdateProductMarketplaceListings: async (project: string, bulkUpdateMarketplaceListingRequest: BulkUpdateMarketplaceListingRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
4905
|
+
// verify required parameter 'project' is not null or undefined
|
|
4906
|
+
assertParamExists('bulkUpdateProductMarketplaceListings', 'project', project)
|
|
4907
|
+
// verify required parameter 'bulkUpdateMarketplaceListingRequest' is not null or undefined
|
|
4908
|
+
assertParamExists('bulkUpdateProductMarketplaceListings', 'bulkUpdateMarketplaceListingRequest', bulkUpdateMarketplaceListingRequest)
|
|
4909
|
+
const localVarPath = `/v1/catalog/products/marketplace-listings`;
|
|
4910
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
4911
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
4912
|
+
let baseOptions;
|
|
4913
|
+
if (configuration) {
|
|
4914
|
+
baseOptions = configuration.baseOptions;
|
|
4915
|
+
}
|
|
4916
|
+
|
|
4917
|
+
const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
|
|
4918
|
+
const localVarHeaderParameter = {} as any;
|
|
4919
|
+
const localVarQueryParameter = {} as any;
|
|
4920
|
+
|
|
4921
|
+
// authentication session-oauth required
|
|
4922
|
+
// oauth required
|
|
4923
|
+
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
4924
|
+
|
|
4925
|
+
// authentication api-key required
|
|
4926
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
4927
|
+
|
|
4928
|
+
if (project !== undefined) {
|
|
4929
|
+
localVarQueryParameter['project'] = project;
|
|
4930
|
+
}
|
|
4931
|
+
|
|
4932
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
4933
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
4934
|
+
|
|
4935
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4936
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
4937
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
4938
|
+
localVarRequestOptions.data = serializeDataIfNeeded(bulkUpdateMarketplaceListingRequest, localVarRequestOptions, configuration)
|
|
4939
|
+
|
|
4940
|
+
return {
|
|
4941
|
+
url: toPathString(localVarUrlObj),
|
|
4942
|
+
options: localVarRequestOptions,
|
|
4943
|
+
};
|
|
4944
|
+
},
|
|
4781
4945
|
/**
|
|
4782
4946
|
* Creates a new catalog product based on a product from the GFN Catalog, with the variants and design applications you provide. Use the [GFN Catalog API](/developer/api/gfn-catalog) to list available products and their variants (including exact attribute names and values) for the project.
|
|
4783
4947
|
* @summary Create product
|
|
@@ -4839,7 +5003,7 @@ export const ProductsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
4839
5003
|
// verify required parameter 'productId' is not null or undefined
|
|
4840
5004
|
assertParamExists('deleteProduct', 'productId', productId)
|
|
4841
5005
|
const localVarPath = `/v1/catalog/products/{productId}`
|
|
4842
|
-
.replace(
|
|
5006
|
+
.replace('{productId}', encodeURIComponent(String(productId)));
|
|
4843
5007
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
4844
5008
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
4845
5009
|
let baseOptions;
|
|
@@ -4979,10 +5143,11 @@ export const ProductsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
4979
5143
|
* @param {ExportProductsDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
4980
5144
|
* @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.
|
|
4981
5145
|
* @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.
|
|
5146
|
+
* @param {string} [marketplaceCode] Export product data in the listing format for the selected marketplace code.
|
|
4982
5147
|
* @param {*} [options] Override http request option.
|
|
4983
5148
|
* @throws {RequiredError}
|
|
4984
5149
|
*/
|
|
4985
|
-
exportProducts: async (project: string, search?: string, start?: string, end?: string, dateFilterType?: ExportProductsDateFilterTypeEnum, maxRetailPrice?: number, minRetailPrice?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
5150
|
+
exportProducts: async (project: string, search?: string, start?: string, end?: string, dateFilterType?: ExportProductsDateFilterTypeEnum, maxRetailPrice?: number, minRetailPrice?: number, marketplaceCode?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
4986
5151
|
// verify required parameter 'project' is not null or undefined
|
|
4987
5152
|
assertParamExists('exportProducts', 'project', project)
|
|
4988
5153
|
const localVarPath = `/v1/catalog/products/export`;
|
|
@@ -5036,6 +5201,10 @@ export const ProductsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
5036
5201
|
localVarQueryParameter['minRetailPrice'] = minRetailPrice;
|
|
5037
5202
|
}
|
|
5038
5203
|
|
|
5204
|
+
if (marketplaceCode !== undefined) {
|
|
5205
|
+
localVarQueryParameter['marketplaceCode'] = marketplaceCode;
|
|
5206
|
+
}
|
|
5207
|
+
|
|
5039
5208
|
localVarHeaderParameter['Accept'] = 'text/csv; charset=utf-8,application/json';
|
|
5040
5209
|
|
|
5041
5210
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -5047,6 +5216,54 @@ export const ProductsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
5047
5216
|
options: localVarRequestOptions,
|
|
5048
5217
|
};
|
|
5049
5218
|
},
|
|
5219
|
+
/**
|
|
5220
|
+
* Gets marketplace listing data for a product.
|
|
5221
|
+
* @summary Get product marketplaces
|
|
5222
|
+
* @param {string} project What project it is
|
|
5223
|
+
* @param {string} productId Product\'s unique identifier
|
|
5224
|
+
* @param {*} [options] Override http request option.
|
|
5225
|
+
* @throws {RequiredError}
|
|
5226
|
+
*/
|
|
5227
|
+
getMarketplaceListings: async (project: string, productId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
5228
|
+
// verify required parameter 'project' is not null or undefined
|
|
5229
|
+
assertParamExists('getMarketplaceListings', 'project', project)
|
|
5230
|
+
// verify required parameter 'productId' is not null or undefined
|
|
5231
|
+
assertParamExists('getMarketplaceListings', 'productId', productId)
|
|
5232
|
+
const localVarPath = `/v1/catalog/products/{productId}/marketplace-listings`
|
|
5233
|
+
.replace('{productId}', encodeURIComponent(String(productId)));
|
|
5234
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5235
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
5236
|
+
let baseOptions;
|
|
5237
|
+
if (configuration) {
|
|
5238
|
+
baseOptions = configuration.baseOptions;
|
|
5239
|
+
}
|
|
5240
|
+
|
|
5241
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
5242
|
+
const localVarHeaderParameter = {} as any;
|
|
5243
|
+
const localVarQueryParameter = {} as any;
|
|
5244
|
+
|
|
5245
|
+
// authentication session-oauth required
|
|
5246
|
+
// oauth required
|
|
5247
|
+
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
5248
|
+
|
|
5249
|
+
// authentication api-key required
|
|
5250
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
5251
|
+
|
|
5252
|
+
if (project !== undefined) {
|
|
5253
|
+
localVarQueryParameter['project'] = project;
|
|
5254
|
+
}
|
|
5255
|
+
|
|
5256
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
5257
|
+
|
|
5258
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5259
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
5260
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
5261
|
+
|
|
5262
|
+
return {
|
|
5263
|
+
url: toPathString(localVarUrlObj),
|
|
5264
|
+
options: localVarRequestOptions,
|
|
5265
|
+
};
|
|
5266
|
+
},
|
|
5050
5267
|
/**
|
|
5051
5268
|
* Gets a product by a given ID.
|
|
5052
5269
|
* @summary Get product
|
|
@@ -5062,7 +5279,7 @@ export const ProductsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
5062
5279
|
// verify required parameter 'productId' is not null or undefined
|
|
5063
5280
|
assertParamExists('getProduct', 'productId', productId)
|
|
5064
5281
|
const localVarPath = `/v1/catalog/products/{productId}`
|
|
5065
|
-
.replace(
|
|
5282
|
+
.replace('{productId}', encodeURIComponent(String(productId)));
|
|
5066
5283
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5067
5284
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
5068
5285
|
let baseOptions;
|
|
@@ -5374,6 +5591,57 @@ export const ProductsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
5374
5591
|
options: localVarRequestOptions,
|
|
5375
5592
|
};
|
|
5376
5593
|
},
|
|
5594
|
+
/**
|
|
5595
|
+
* Updates marketplace listing data for a product.
|
|
5596
|
+
* @summary Update product marketplaces
|
|
5597
|
+
* @param {string} project What project it is
|
|
5598
|
+
* @param {string} productId Product\'s unique identifier
|
|
5599
|
+
* @param {UpdateMarketplaceListingRequest} [updateMarketplaceListingRequest] The marketplace listing fields to update. Only the fields provided will be modified.
|
|
5600
|
+
* @param {*} [options] Override http request option.
|
|
5601
|
+
* @throws {RequiredError}
|
|
5602
|
+
*/
|
|
5603
|
+
updateMarketplaceListings: async (project: string, productId: string, updateMarketplaceListingRequest?: UpdateMarketplaceListingRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
5604
|
+
// verify required parameter 'project' is not null or undefined
|
|
5605
|
+
assertParamExists('updateMarketplaceListings', 'project', project)
|
|
5606
|
+
// verify required parameter 'productId' is not null or undefined
|
|
5607
|
+
assertParamExists('updateMarketplaceListings', 'productId', productId)
|
|
5608
|
+
const localVarPath = `/v1/catalog/products/{productId}/marketplace-listings`
|
|
5609
|
+
.replace('{productId}', encodeURIComponent(String(productId)));
|
|
5610
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5611
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
5612
|
+
let baseOptions;
|
|
5613
|
+
if (configuration) {
|
|
5614
|
+
baseOptions = configuration.baseOptions;
|
|
5615
|
+
}
|
|
5616
|
+
|
|
5617
|
+
const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
|
|
5618
|
+
const localVarHeaderParameter = {} as any;
|
|
5619
|
+
const localVarQueryParameter = {} as any;
|
|
5620
|
+
|
|
5621
|
+
// authentication session-oauth required
|
|
5622
|
+
// oauth required
|
|
5623
|
+
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
5624
|
+
|
|
5625
|
+
// authentication api-key required
|
|
5626
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
5627
|
+
|
|
5628
|
+
if (project !== undefined) {
|
|
5629
|
+
localVarQueryParameter['project'] = project;
|
|
5630
|
+
}
|
|
5631
|
+
|
|
5632
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
5633
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
5634
|
+
|
|
5635
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5636
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
5637
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
5638
|
+
localVarRequestOptions.data = serializeDataIfNeeded(updateMarketplaceListingRequest, localVarRequestOptions, configuration)
|
|
5639
|
+
|
|
5640
|
+
return {
|
|
5641
|
+
url: toPathString(localVarUrlObj),
|
|
5642
|
+
options: localVarRequestOptions,
|
|
5643
|
+
};
|
|
5644
|
+
},
|
|
5377
5645
|
/**
|
|
5378
5646
|
* Updates a product by a given ID.
|
|
5379
5647
|
* @summary Update product
|
|
@@ -5389,7 +5657,7 @@ export const ProductsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
5389
5657
|
// verify required parameter 'productId' is not null or undefined
|
|
5390
5658
|
assertParamExists('updateProduct', 'productId', productId)
|
|
5391
5659
|
const localVarPath = `/v1/catalog/products/{productId}`
|
|
5392
|
-
.replace(
|
|
5660
|
+
.replace('{productId}', encodeURIComponent(String(productId)));
|
|
5393
5661
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5394
5662
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
5395
5663
|
let baseOptions;
|
|
@@ -5497,6 +5765,20 @@ export const ProductsApiFp = function(configuration?: Configuration) {
|
|
|
5497
5765
|
const localVarOperationServerBasePath = operationServerMap['ProductsApi.autoMerchProducts']?.[localVarOperationServerIndex]?.url;
|
|
5498
5766
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
5499
5767
|
},
|
|
5768
|
+
/**
|
|
5769
|
+
* Updates marketplace listing data for multiple products under a single marketplace. Each request carries exactly one marketplace group (see `BulkUpdateMarketplaceListingRequest.marketplace`); send additional requests to update another marketplace code.
|
|
5770
|
+
* @summary Bulk update product marketplaces
|
|
5771
|
+
* @param {string} project What project it is
|
|
5772
|
+
* @param {BulkUpdateMarketplaceListingRequest} bulkUpdateMarketplaceListingRequest Update marketplace listing fields for multiple products for one marketplace only. The `marketplaces` array must contain exactly one item (one `code` and its `products`).
|
|
5773
|
+
* @param {*} [options] Override http request option.
|
|
5774
|
+
* @throws {RequiredError}
|
|
5775
|
+
*/
|
|
5776
|
+
async bulkUpdateProductMarketplaceListings(project: string, bulkUpdateMarketplaceListingRequest: BulkUpdateMarketplaceListingRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BulkUpdateMarketplaceListingResponse>> {
|
|
5777
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.bulkUpdateProductMarketplaceListings(project, bulkUpdateMarketplaceListingRequest, options);
|
|
5778
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
5779
|
+
const localVarOperationServerBasePath = operationServerMap['ProductsApi.bulkUpdateProductMarketplaceListings']?.[localVarOperationServerIndex]?.url;
|
|
5780
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
5781
|
+
},
|
|
5500
5782
|
/**
|
|
5501
5783
|
* Creates a new catalog product based on a product from the GFN Catalog, with the variants and design applications you provide. Use the [GFN Catalog API](/developer/api/gfn-catalog) to list available products and their variants (including exact attribute names and values) for the project.
|
|
5502
5784
|
* @summary Create product
|
|
@@ -5563,15 +5845,30 @@ export const ProductsApiFp = function(configuration?: Configuration) {
|
|
|
5563
5845
|
* @param {ExportProductsDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
5564
5846
|
* @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.
|
|
5565
5847
|
* @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.
|
|
5848
|
+
* @param {string} [marketplaceCode] Export product data in the listing format for the selected marketplace code.
|
|
5566
5849
|
* @param {*} [options] Override http request option.
|
|
5567
5850
|
* @throws {RequiredError}
|
|
5568
5851
|
*/
|
|
5569
|
-
async exportProducts(project: string, search?: string, start?: string, end?: string, dateFilterType?: ExportProductsDateFilterTypeEnum, maxRetailPrice?: number, minRetailPrice?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>> {
|
|
5570
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.exportProducts(project, search, start, end, dateFilterType, maxRetailPrice, minRetailPrice, options);
|
|
5852
|
+
async exportProducts(project: string, search?: string, start?: string, end?: string, dateFilterType?: ExportProductsDateFilterTypeEnum, maxRetailPrice?: number, minRetailPrice?: number, marketplaceCode?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>> {
|
|
5853
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.exportProducts(project, search, start, end, dateFilterType, maxRetailPrice, minRetailPrice, marketplaceCode, options);
|
|
5571
5854
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
5572
5855
|
const localVarOperationServerBasePath = operationServerMap['ProductsApi.exportProducts']?.[localVarOperationServerIndex]?.url;
|
|
5573
5856
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
5574
5857
|
},
|
|
5858
|
+
/**
|
|
5859
|
+
* Gets marketplace listing data for a product.
|
|
5860
|
+
* @summary Get product marketplaces
|
|
5861
|
+
* @param {string} project What project it is
|
|
5862
|
+
* @param {string} productId Product\'s unique identifier
|
|
5863
|
+
* @param {*} [options] Override http request option.
|
|
5864
|
+
* @throws {RequiredError}
|
|
5865
|
+
*/
|
|
5866
|
+
async getMarketplaceListings(project: string, productId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MarketplaceListingsResponse>> {
|
|
5867
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getMarketplaceListings(project, productId, options);
|
|
5868
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
5869
|
+
const localVarOperationServerBasePath = operationServerMap['ProductsApi.getMarketplaceListings']?.[localVarOperationServerIndex]?.url;
|
|
5870
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
5871
|
+
},
|
|
5575
5872
|
/**
|
|
5576
5873
|
* Gets a product by a given ID.
|
|
5577
5874
|
* @summary Get product
|
|
@@ -5652,6 +5949,21 @@ export const ProductsApiFp = function(configuration?: Configuration) {
|
|
|
5652
5949
|
const localVarOperationServerBasePath = operationServerMap['ProductsApi.seoOptimiseProducts']?.[localVarOperationServerIndex]?.url;
|
|
5653
5950
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
5654
5951
|
},
|
|
5952
|
+
/**
|
|
5953
|
+
* Updates marketplace listing data for a product.
|
|
5954
|
+
* @summary Update product marketplaces
|
|
5955
|
+
* @param {string} project What project it is
|
|
5956
|
+
* @param {string} productId Product\'s unique identifier
|
|
5957
|
+
* @param {UpdateMarketplaceListingRequest} [updateMarketplaceListingRequest] The marketplace listing fields to update. Only the fields provided will be modified.
|
|
5958
|
+
* @param {*} [options] Override http request option.
|
|
5959
|
+
* @throws {RequiredError}
|
|
5960
|
+
*/
|
|
5961
|
+
async updateMarketplaceListings(project: string, productId: string, updateMarketplaceListingRequest?: UpdateMarketplaceListingRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MarketplaceListingsResponse>> {
|
|
5962
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.updateMarketplaceListings(project, productId, updateMarketplaceListingRequest, options);
|
|
5963
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
5964
|
+
const localVarOperationServerBasePath = operationServerMap['ProductsApi.updateMarketplaceListings']?.[localVarOperationServerIndex]?.url;
|
|
5965
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
5966
|
+
},
|
|
5655
5967
|
/**
|
|
5656
5968
|
* Updates a product by a given ID.
|
|
5657
5969
|
* @summary Update product
|
|
@@ -5700,6 +6012,16 @@ export const ProductsApiFactory = function (configuration?: Configuration, baseP
|
|
|
5700
6012
|
autoMerchProducts(requestParameters: ProductsApiAutoMerchProductsRequest, options?: RawAxiosRequestConfig): AxiosPromise<AutoMerchProducts202Response> {
|
|
5701
6013
|
return localVarFp.autoMerchProducts(requestParameters.project, requestParameters.autoMerchProductsRequest, options).then((request) => request(axios, basePath));
|
|
5702
6014
|
},
|
|
6015
|
+
/**
|
|
6016
|
+
* Updates marketplace listing data for multiple products under a single marketplace. Each request carries exactly one marketplace group (see `BulkUpdateMarketplaceListingRequest.marketplace`); send additional requests to update another marketplace code.
|
|
6017
|
+
* @summary Bulk update product marketplaces
|
|
6018
|
+
* @param {ProductsApiBulkUpdateProductMarketplaceListingsRequest} requestParameters Request parameters.
|
|
6019
|
+
* @param {*} [options] Override http request option.
|
|
6020
|
+
* @throws {RequiredError}
|
|
6021
|
+
*/
|
|
6022
|
+
bulkUpdateProductMarketplaceListings(requestParameters: ProductsApiBulkUpdateProductMarketplaceListingsRequest, options?: RawAxiosRequestConfig): AxiosPromise<BulkUpdateMarketplaceListingResponse> {
|
|
6023
|
+
return localVarFp.bulkUpdateProductMarketplaceListings(requestParameters.project, requestParameters.bulkUpdateMarketplaceListingRequest, options).then((request) => request(axios, basePath));
|
|
6024
|
+
},
|
|
5703
6025
|
/**
|
|
5704
6026
|
* Creates a new catalog product based on a product from the GFN Catalog, with the variants and design applications you provide. Use the [GFN Catalog API](/developer/api/gfn-catalog) to list available products and their variants (including exact attribute names and values) for the project.
|
|
5705
6027
|
* @summary Create product
|
|
@@ -5748,7 +6070,17 @@ export const ProductsApiFactory = function (configuration?: Configuration, baseP
|
|
|
5748
6070
|
* @throws {RequiredError}
|
|
5749
6071
|
*/
|
|
5750
6072
|
exportProducts(requestParameters: ProductsApiExportProductsRequest, options?: RawAxiosRequestConfig): AxiosPromise<File> {
|
|
5751
|
-
return localVarFp.exportProducts(requestParameters.project, requestParameters.search, requestParameters.start, requestParameters.end, requestParameters.dateFilterType, requestParameters.maxRetailPrice, requestParameters.minRetailPrice, options).then((request) => request(axios, basePath));
|
|
6073
|
+
return localVarFp.exportProducts(requestParameters.project, requestParameters.search, requestParameters.start, requestParameters.end, requestParameters.dateFilterType, requestParameters.maxRetailPrice, requestParameters.minRetailPrice, requestParameters.marketplaceCode, options).then((request) => request(axios, basePath));
|
|
6074
|
+
},
|
|
6075
|
+
/**
|
|
6076
|
+
* Gets marketplace listing data for a product.
|
|
6077
|
+
* @summary Get product marketplaces
|
|
6078
|
+
* @param {ProductsApiGetMarketplaceListingsRequest} requestParameters Request parameters.
|
|
6079
|
+
* @param {*} [options] Override http request option.
|
|
6080
|
+
* @throws {RequiredError}
|
|
6081
|
+
*/
|
|
6082
|
+
getMarketplaceListings(requestParameters: ProductsApiGetMarketplaceListingsRequest, options?: RawAxiosRequestConfig): AxiosPromise<MarketplaceListingsResponse> {
|
|
6083
|
+
return localVarFp.getMarketplaceListings(requestParameters.project, requestParameters.productId, options).then((request) => request(axios, basePath));
|
|
5752
6084
|
},
|
|
5753
6085
|
/**
|
|
5754
6086
|
* Gets a product by a given ID.
|
|
@@ -5790,6 +6122,16 @@ export const ProductsApiFactory = function (configuration?: Configuration, baseP
|
|
|
5790
6122
|
seoOptimiseProducts(requestParameters: ProductsApiSeoOptimiseProductsRequest, options?: RawAxiosRequestConfig): AxiosPromise<SeoOptimiseProducts202Response> {
|
|
5791
6123
|
return localVarFp.seoOptimiseProducts(requestParameters.project, requestParameters.seoOptimiseProductsRequest, options).then((request) => request(axios, basePath));
|
|
5792
6124
|
},
|
|
6125
|
+
/**
|
|
6126
|
+
* Updates marketplace listing data for a product.
|
|
6127
|
+
* @summary Update product marketplaces
|
|
6128
|
+
* @param {ProductsApiUpdateMarketplaceListingsRequest} requestParameters Request parameters.
|
|
6129
|
+
* @param {*} [options] Override http request option.
|
|
6130
|
+
* @throws {RequiredError}
|
|
6131
|
+
*/
|
|
6132
|
+
updateMarketplaceListings(requestParameters: ProductsApiUpdateMarketplaceListingsRequest, options?: RawAxiosRequestConfig): AxiosPromise<MarketplaceListingsResponse> {
|
|
6133
|
+
return localVarFp.updateMarketplaceListings(requestParameters.project, requestParameters.productId, requestParameters.updateMarketplaceListingRequest, options).then((request) => request(axios, basePath));
|
|
6134
|
+
},
|
|
5793
6135
|
/**
|
|
5794
6136
|
* Updates a product by a given ID.
|
|
5795
6137
|
* @summary Update product
|
|
@@ -5828,6 +6170,21 @@ export interface ProductsApiAutoMerchProductsRequest {
|
|
|
5828
6170
|
readonly autoMerchProductsRequest?: AutoMerchProductsRequest
|
|
5829
6171
|
}
|
|
5830
6172
|
|
|
6173
|
+
/**
|
|
6174
|
+
* Request parameters for bulkUpdateProductMarketplaceListings operation in ProductsApi.
|
|
6175
|
+
*/
|
|
6176
|
+
export interface ProductsApiBulkUpdateProductMarketplaceListingsRequest {
|
|
6177
|
+
/**
|
|
6178
|
+
* What project it is
|
|
6179
|
+
*/
|
|
6180
|
+
readonly project: string
|
|
6181
|
+
|
|
6182
|
+
/**
|
|
6183
|
+
* Update marketplace listing fields for multiple products for one marketplace only. The `marketplaces` array must contain exactly one item (one `code` and its `products`).
|
|
6184
|
+
*/
|
|
6185
|
+
readonly bulkUpdateMarketplaceListingRequest: BulkUpdateMarketplaceListingRequest
|
|
6186
|
+
}
|
|
6187
|
+
|
|
5831
6188
|
/**
|
|
5832
6189
|
* Request parameters for createProduct operation in ProductsApi.
|
|
5833
6190
|
*/
|
|
@@ -5926,6 +6283,26 @@ export interface ProductsApiExportProductsRequest {
|
|
|
5926
6283
|
* 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.
|
|
5927
6284
|
*/
|
|
5928
6285
|
readonly minRetailPrice?: number
|
|
6286
|
+
|
|
6287
|
+
/**
|
|
6288
|
+
* Export product data in the listing format for the selected marketplace code.
|
|
6289
|
+
*/
|
|
6290
|
+
readonly marketplaceCode?: string
|
|
6291
|
+
}
|
|
6292
|
+
|
|
6293
|
+
/**
|
|
6294
|
+
* Request parameters for getMarketplaceListings operation in ProductsApi.
|
|
6295
|
+
*/
|
|
6296
|
+
export interface ProductsApiGetMarketplaceListingsRequest {
|
|
6297
|
+
/**
|
|
6298
|
+
* What project it is
|
|
6299
|
+
*/
|
|
6300
|
+
readonly project: string
|
|
6301
|
+
|
|
6302
|
+
/**
|
|
6303
|
+
* Product\'s unique identifier
|
|
6304
|
+
*/
|
|
6305
|
+
readonly productId: string
|
|
5929
6306
|
}
|
|
5930
6307
|
|
|
5931
6308
|
/**
|
|
@@ -6108,6 +6485,26 @@ export interface ProductsApiSeoOptimiseProductsRequest {
|
|
|
6108
6485
|
readonly seoOptimiseProductsRequest?: SeoOptimiseProductsRequest
|
|
6109
6486
|
}
|
|
6110
6487
|
|
|
6488
|
+
/**
|
|
6489
|
+
* Request parameters for updateMarketplaceListings operation in ProductsApi.
|
|
6490
|
+
*/
|
|
6491
|
+
export interface ProductsApiUpdateMarketplaceListingsRequest {
|
|
6492
|
+
/**
|
|
6493
|
+
* What project it is
|
|
6494
|
+
*/
|
|
6495
|
+
readonly project: string
|
|
6496
|
+
|
|
6497
|
+
/**
|
|
6498
|
+
* Product\'s unique identifier
|
|
6499
|
+
*/
|
|
6500
|
+
readonly productId: string
|
|
6501
|
+
|
|
6502
|
+
/**
|
|
6503
|
+
* The marketplace listing fields to update. Only the fields provided will be modified.
|
|
6504
|
+
*/
|
|
6505
|
+
readonly updateMarketplaceListingRequest?: UpdateMarketplaceListingRequest
|
|
6506
|
+
}
|
|
6507
|
+
|
|
6111
6508
|
/**
|
|
6112
6509
|
* Request parameters for updateProduct operation in ProductsApi.
|
|
6113
6510
|
*/
|
|
@@ -6158,6 +6555,17 @@ export class ProductsApi extends BaseAPI {
|
|
|
6158
6555
|
return ProductsApiFp(this.configuration).autoMerchProducts(requestParameters.project, requestParameters.autoMerchProductsRequest, options).then((request) => request(this.axios, this.basePath));
|
|
6159
6556
|
}
|
|
6160
6557
|
|
|
6558
|
+
/**
|
|
6559
|
+
* Updates marketplace listing data for multiple products under a single marketplace. Each request carries exactly one marketplace group (see `BulkUpdateMarketplaceListingRequest.marketplace`); send additional requests to update another marketplace code.
|
|
6560
|
+
* @summary Bulk update product marketplaces
|
|
6561
|
+
* @param {ProductsApiBulkUpdateProductMarketplaceListingsRequest} requestParameters Request parameters.
|
|
6562
|
+
* @param {*} [options] Override http request option.
|
|
6563
|
+
* @throws {RequiredError}
|
|
6564
|
+
*/
|
|
6565
|
+
public bulkUpdateProductMarketplaceListings(requestParameters: ProductsApiBulkUpdateProductMarketplaceListingsRequest, options?: RawAxiosRequestConfig) {
|
|
6566
|
+
return ProductsApiFp(this.configuration).bulkUpdateProductMarketplaceListings(requestParameters.project, requestParameters.bulkUpdateMarketplaceListingRequest, options).then((request) => request(this.axios, this.basePath));
|
|
6567
|
+
}
|
|
6568
|
+
|
|
6161
6569
|
/**
|
|
6162
6570
|
* Creates a new catalog product based on a product from the GFN Catalog, with the variants and design applications you provide. Use the [GFN Catalog API](/developer/api/gfn-catalog) to list available products and their variants (including exact attribute names and values) for the project.
|
|
6163
6571
|
* @summary Create product
|
|
@@ -6210,7 +6618,18 @@ export class ProductsApi extends BaseAPI {
|
|
|
6210
6618
|
* @throws {RequiredError}
|
|
6211
6619
|
*/
|
|
6212
6620
|
public exportProducts(requestParameters: ProductsApiExportProductsRequest, options?: RawAxiosRequestConfig) {
|
|
6213
|
-
return ProductsApiFp(this.configuration).exportProducts(requestParameters.project, requestParameters.search, requestParameters.start, requestParameters.end, requestParameters.dateFilterType, requestParameters.maxRetailPrice, requestParameters.minRetailPrice, options).then((request) => request(this.axios, this.basePath));
|
|
6621
|
+
return ProductsApiFp(this.configuration).exportProducts(requestParameters.project, requestParameters.search, requestParameters.start, requestParameters.end, requestParameters.dateFilterType, requestParameters.maxRetailPrice, requestParameters.minRetailPrice, requestParameters.marketplaceCode, options).then((request) => request(this.axios, this.basePath));
|
|
6622
|
+
}
|
|
6623
|
+
|
|
6624
|
+
/**
|
|
6625
|
+
* Gets marketplace listing data for a product.
|
|
6626
|
+
* @summary Get product marketplaces
|
|
6627
|
+
* @param {ProductsApiGetMarketplaceListingsRequest} requestParameters Request parameters.
|
|
6628
|
+
* @param {*} [options] Override http request option.
|
|
6629
|
+
* @throws {RequiredError}
|
|
6630
|
+
*/
|
|
6631
|
+
public getMarketplaceListings(requestParameters: ProductsApiGetMarketplaceListingsRequest, options?: RawAxiosRequestConfig) {
|
|
6632
|
+
return ProductsApiFp(this.configuration).getMarketplaceListings(requestParameters.project, requestParameters.productId, options).then((request) => request(this.axios, this.basePath));
|
|
6214
6633
|
}
|
|
6215
6634
|
|
|
6216
6635
|
/**
|
|
@@ -6257,6 +6676,17 @@ export class ProductsApi extends BaseAPI {
|
|
|
6257
6676
|
return ProductsApiFp(this.configuration).seoOptimiseProducts(requestParameters.project, requestParameters.seoOptimiseProductsRequest, options).then((request) => request(this.axios, this.basePath));
|
|
6258
6677
|
}
|
|
6259
6678
|
|
|
6679
|
+
/**
|
|
6680
|
+
* Updates marketplace listing data for a product.
|
|
6681
|
+
* @summary Update product marketplaces
|
|
6682
|
+
* @param {ProductsApiUpdateMarketplaceListingsRequest} requestParameters Request parameters.
|
|
6683
|
+
* @param {*} [options] Override http request option.
|
|
6684
|
+
* @throws {RequiredError}
|
|
6685
|
+
*/
|
|
6686
|
+
public updateMarketplaceListings(requestParameters: ProductsApiUpdateMarketplaceListingsRequest, options?: RawAxiosRequestConfig) {
|
|
6687
|
+
return ProductsApiFp(this.configuration).updateMarketplaceListings(requestParameters.project, requestParameters.productId, requestParameters.updateMarketplaceListingRequest, options).then((request) => request(this.axios, this.basePath));
|
|
6688
|
+
}
|
|
6689
|
+
|
|
6260
6690
|
/**
|
|
6261
6691
|
* Updates a product by a given ID.
|
|
6262
6692
|
* @summary Update product
|
|
@@ -6312,7 +6742,7 @@ export const VariantsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
6312
6742
|
// verify required parameter 'variantId' is not null or undefined
|
|
6313
6743
|
assertParamExists('getVariant', 'variantId', variantId)
|
|
6314
6744
|
const localVarPath = `/v1/catalog/variants/{variantId}`
|
|
6315
|
-
.replace(
|
|
6745
|
+
.replace('{variantId}', encodeURIComponent(String(variantId)));
|
|
6316
6746
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
6317
6747
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
6318
6748
|
let baseOptions;
|