@teemill/product-catalog 1.87.0 → 1.88.1
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 +5 -2
- package/api.ts +95 -13
- package/base.ts +2 -2
- package/common.ts +2 -2
- package/configuration.ts +2 -2
- package/dist/api.d.ts +92 -13
- package/dist/api.js +12 -8
- package/dist/base.d.ts +2 -2
- package/dist/base.js +2 -2
- package/dist/common.d.ts +2 -2
- package/dist/common.js +2 -2
- package/dist/configuration.d.ts +2 -2
- package/dist/configuration.js +2 -2
- package/dist/esm/api.d.ts +92 -13
- package/dist/esm/api.js +10 -6
- package/dist/esm/base.d.ts +2 -2
- package/dist/esm/base.js +2 -2
- package/dist/esm/common.d.ts +2 -2
- package/dist/esm/common.js +2 -2
- package/dist/esm/configuration.d.ts +2 -2
- package/dist/esm/configuration.js +2 -2
- package/dist/esm/index.d.ts +2 -2
- package/dist/esm/index.js +2 -2
- package/dist/index.d.ts +2 -2
- package/dist/index.js +2 -2
- package/docs/Application.md +1 -1
- package/docs/ApplicationPropertiesPositionInference.md +1 -1
- package/docs/BundleProduct.md +2 -0
- package/docs/CreateApplication.md +1 -1
- package/docs/CreateProduct.md +2 -2
- package/docs/CreateProductRequest.md +1 -1
- package/docs/CreateProductVariant.md +2 -2
- package/docs/CreateProductVariantAttributesInner.md +22 -0
- package/docs/Product.md +2 -0
- package/docs/ProductBundleItemsInner.md +2 -0
- package/docs/ProductGfnProduct.md +25 -0
- package/docs/ProductWarehouseProduct.md +3 -0
- package/docs/ProductsApi.md +1 -1
- package/docs/Variant.md +2 -0
- package/docs/VariantGfnVariant.md +25 -0
- package/docs/VariantWarehouseVariant.md +3 -0
- package/index.ts +2 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @teemill/product-catalog@1.
|
|
1
|
+
## @teemill/product-catalog@1.88.1
|
|
2
2
|
|
|
3
3
|
This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
|
|
4
4
|
|
|
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
|
|
|
36
36
|
_published:_
|
|
37
37
|
|
|
38
38
|
```
|
|
39
|
-
npm install @teemill/product-catalog@1.
|
|
39
|
+
npm install @teemill/product-catalog@1.88.1 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
|
@@ -126,6 +126,7 @@ Class | Method | HTTP request | Description
|
|
|
126
126
|
- [CreateProductImagesInner](docs/CreateProductImagesInner.md)
|
|
127
127
|
- [CreateProductRequest](docs/CreateProductRequest.md)
|
|
128
128
|
- [CreateProductVariant](docs/CreateProductVariant.md)
|
|
129
|
+
- [CreateProductVariantAttributesInner](docs/CreateProductVariantAttributesInner.md)
|
|
129
130
|
- [CreateProductVariantImagesInner](docs/CreateProductVariantImagesInner.md)
|
|
130
131
|
- [CreateProductVideosInner](docs/CreateProductVideosInner.md)
|
|
131
132
|
- [DeleteProductsRequest](docs/DeleteProductsRequest.md)
|
|
@@ -147,6 +148,7 @@ Class | Method | HTTP request | Description
|
|
|
147
148
|
- [ProductAnalyticsResponse](docs/ProductAnalyticsResponse.md)
|
|
148
149
|
- [ProductApplicationSetsInner](docs/ProductApplicationSetsInner.md)
|
|
149
150
|
- [ProductBundleItemsInner](docs/ProductBundleItemsInner.md)
|
|
151
|
+
- [ProductGfnProduct](docs/ProductGfnProduct.md)
|
|
150
152
|
- [ProductType](docs/ProductType.md)
|
|
151
153
|
- [ProductTypeListResponse](docs/ProductTypeListResponse.md)
|
|
152
154
|
- [ProductWarehouseProduct](docs/ProductWarehouseProduct.md)
|
|
@@ -187,6 +189,7 @@ Class | Method | HTTP request | Description
|
|
|
187
189
|
- [UserListCreatorsInner](docs/UserListCreatorsInner.md)
|
|
188
190
|
- [UserListCreatorsInnerAvatar](docs/UserListCreatorsInnerAvatar.md)
|
|
189
191
|
- [Variant](docs/Variant.md)
|
|
192
|
+
- [VariantGfnVariant](docs/VariantGfnVariant.md)
|
|
190
193
|
- [VariantIntegrationConnectionsInner](docs/VariantIntegrationConnectionsInner.md)
|
|
191
194
|
- [VariantProduct](docs/VariantProduct.md)
|
|
192
195
|
- [VariantWarehouseVariant](docs/VariantWarehouseVariant.md)
|
package/api.ts
CHANGED
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Product Catalog API
|
|
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
|
|
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.88.1
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -116,7 +116,7 @@ export interface Application {
|
|
|
116
116
|
*/
|
|
117
117
|
'additionalInstructions'?: string | null;
|
|
118
118
|
/**
|
|
119
|
-
* Publicly available design file URL. This will fill the design area of the
|
|
119
|
+
* Publicly available design file URL. This will fill the design area of the GFN Catalog product. It will be centered horizontally and aligned to the top of the design area.
|
|
120
120
|
*/
|
|
121
121
|
'src'?: string;
|
|
122
122
|
/**
|
|
@@ -250,7 +250,7 @@ export interface ApplicationPropertiesPosition {
|
|
|
250
250
|
'z'?: number;
|
|
251
251
|
}
|
|
252
252
|
/**
|
|
253
|
-
* Set these properties when you don\'t have position information for the application. We will use the mockup and baseFlat to calculate the position of the application relative to the bounding box of the
|
|
253
|
+
* Set these properties when you don\'t have position information for the application. We will use the mockup and baseFlat to calculate the position of the application relative to the bounding box of the GFN Catalog product.
|
|
254
254
|
*/
|
|
255
255
|
export interface ApplicationPropertiesPositionInference {
|
|
256
256
|
/**
|
|
@@ -514,7 +514,11 @@ export interface BundleProduct {
|
|
|
514
514
|
* For use with the Shopify integration. The Shopify product ID that this product is linked to.
|
|
515
515
|
*/
|
|
516
516
|
'shopifyId'?: number | null;
|
|
517
|
+
/**
|
|
518
|
+
* @deprecated
|
|
519
|
+
*/
|
|
517
520
|
'warehouseProduct'?: ProductWarehouseProduct;
|
|
521
|
+
'gfnProduct'?: ProductGfnProduct;
|
|
518
522
|
/**
|
|
519
523
|
* Key/value pairs that can be used to store additional information about the product
|
|
520
524
|
*/
|
|
@@ -548,7 +552,7 @@ export interface CreateApplication {
|
|
|
548
552
|
*/
|
|
549
553
|
'additionalInstructions'?: string | null;
|
|
550
554
|
/**
|
|
551
|
-
* Publicly available design file URL. This will fill the design area of the
|
|
555
|
+
* Publicly available design file URL. This will fill the design area of the GFN Catalog product. It will be centered horizontally and aligned to the top of the design area.
|
|
552
556
|
*/
|
|
553
557
|
'src': string;
|
|
554
558
|
/**
|
|
@@ -817,7 +821,7 @@ export interface CreateProduct {
|
|
|
817
821
|
*/
|
|
818
822
|
'internalTags'?: Array<string>;
|
|
819
823
|
/**
|
|
820
|
-
*
|
|
824
|
+
* The variants to create for this product. Each variant must specify attributes that match a variant in the GFN Catalog for the product referenced by gfnProductRef. Use the GFN Catalog API to list products and variants (e.g. GET /v1/gfn/catalog/products/{productId} and GET /v1/gfn/catalog/variants) to get the exact attribute names and values — they must match exactly, including casing.
|
|
821
825
|
*/
|
|
822
826
|
'variants': Array<CreateProductVariant>;
|
|
823
827
|
/**
|
|
@@ -877,9 +881,9 @@ export type CreateProductRequest = CreateBundleProduct | CreateProduct;
|
|
|
877
881
|
|
|
878
882
|
export interface CreateProductVariant {
|
|
879
883
|
/**
|
|
880
|
-
*
|
|
884
|
+
* One entry per attribute (e.g. Size, Colour). The name and value of each attribute must match the GFN Catalog API exactly — use the GFN Catalog API to list the product and its variants to get the exact strings (casing and spelling must match).
|
|
881
885
|
*/
|
|
882
|
-
'attributes': Array<
|
|
886
|
+
'attributes': Array<CreateProductVariantAttributesInner>;
|
|
883
887
|
'retailPrice': UpdateProductsRequestProductsInnerVariantsInnerRetailPrice;
|
|
884
888
|
'salePrice'?: UpdateProductsRequestProductsInnerVariantsInnerSalePrice | null;
|
|
885
889
|
/**
|
|
@@ -891,7 +895,7 @@ export interface CreateProductVariant {
|
|
|
891
895
|
*/
|
|
892
896
|
'applications'?: Array<Application>;
|
|
893
897
|
/**
|
|
894
|
-
* Only use if you want to override the main product image. If not provided, mockups will be generated using the design applications and the
|
|
898
|
+
* Only use if you want to override the main product image. If not provided, mockups will be generated using the design applications and the GFN Catalog product. Accepts PNG and JPEG files.
|
|
895
899
|
*/
|
|
896
900
|
'images'?: Array<CreateProductVariantImagesInner>;
|
|
897
901
|
/**
|
|
@@ -904,6 +908,24 @@ export interface CreateProductVariant {
|
|
|
904
908
|
'shopifyId'?: number | null;
|
|
905
909
|
'integrationConnections'?: Array<UpdateProductsRequestProductsInnerVariantsInnerIntegrationConnectionsInner>;
|
|
906
910
|
}
|
|
911
|
+
export interface CreateProductVariantAttributesInner {
|
|
912
|
+
/**
|
|
913
|
+
* Attribute name as returned by the GFN Catalog API for this product (e.g. \"Size\", \"Colour\"). Must match exactly, including casing.
|
|
914
|
+
*/
|
|
915
|
+
'name': CreateProductVariantAttributesInnerNameEnum;
|
|
916
|
+
/**
|
|
917
|
+
* Attribute value as returned by the GFN Catalog API for this product (e.g. \"S\", \"White\"). Must match exactly, including casing.
|
|
918
|
+
*/
|
|
919
|
+
'value': string;
|
|
920
|
+
}
|
|
921
|
+
|
|
922
|
+
export const CreateProductVariantAttributesInnerNameEnum = {
|
|
923
|
+
Size: 'Size',
|
|
924
|
+
Colour: 'Colour'
|
|
925
|
+
} as const;
|
|
926
|
+
|
|
927
|
+
export type CreateProductVariantAttributesInnerNameEnum = typeof CreateProductVariantAttributesInnerNameEnum[keyof typeof CreateProductVariantAttributesInnerNameEnum];
|
|
928
|
+
|
|
907
929
|
export interface CreateProductVariantImagesInner {
|
|
908
930
|
/**
|
|
909
931
|
* ID of the image if it already exists. A new image will be created if this is not provided.
|
|
@@ -1143,7 +1165,11 @@ export interface Product {
|
|
|
1143
1165
|
* For use with the Shopify integration. The Shopify product ID that this product is linked to.
|
|
1144
1166
|
*/
|
|
1145
1167
|
'shopifyId'?: number | null;
|
|
1168
|
+
/**
|
|
1169
|
+
* @deprecated
|
|
1170
|
+
*/
|
|
1146
1171
|
'warehouseProduct'?: ProductWarehouseProduct;
|
|
1172
|
+
'gfnProduct'?: ProductGfnProduct;
|
|
1147
1173
|
/**
|
|
1148
1174
|
* Key/value pairs that can be used to store additional information about the product
|
|
1149
1175
|
*/
|
|
@@ -1257,7 +1283,11 @@ export interface ProductBundleItemsInner {
|
|
|
1257
1283
|
* For use with the Shopify integration. The Shopify product ID that this product is linked to.
|
|
1258
1284
|
*/
|
|
1259
1285
|
'shopifyId'?: number | null;
|
|
1286
|
+
/**
|
|
1287
|
+
* @deprecated
|
|
1288
|
+
*/
|
|
1260
1289
|
'warehouseProduct'?: ProductWarehouseProduct;
|
|
1290
|
+
'gfnProduct'?: ProductGfnProduct;
|
|
1261
1291
|
/**
|
|
1262
1292
|
* Key/value pairs that can be used to store additional information about the product
|
|
1263
1293
|
*/
|
|
@@ -1278,6 +1308,23 @@ export interface ProductBundleItemsInner {
|
|
|
1278
1308
|
'license'?: License;
|
|
1279
1309
|
'config'?: UpdateProductRequestBundleItemsInnerConfig;
|
|
1280
1310
|
}
|
|
1311
|
+
/**
|
|
1312
|
+
* The GFN Catalog product this catalog product is based on. Use the GFN Catalog API to list available products.
|
|
1313
|
+
*/
|
|
1314
|
+
export interface ProductGfnProduct {
|
|
1315
|
+
/**
|
|
1316
|
+
* Unique object identifier
|
|
1317
|
+
*/
|
|
1318
|
+
'id'?: string;
|
|
1319
|
+
/**
|
|
1320
|
+
* Reference to the product in the Global Fulfillment Network (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.
|
|
1321
|
+
*/
|
|
1322
|
+
'gfnProductRef'?: string;
|
|
1323
|
+
/**
|
|
1324
|
+
* Meta fields from the GFN Catalog product
|
|
1325
|
+
*/
|
|
1326
|
+
'metafields'?: Array<MetaField>;
|
|
1327
|
+
}
|
|
1281
1328
|
export interface ProductType {
|
|
1282
1329
|
/**
|
|
1283
1330
|
* Unique object identifier
|
|
@@ -1295,6 +1342,9 @@ export interface ProductTypeListResponse {
|
|
|
1295
1342
|
*/
|
|
1296
1343
|
'nextPageToken': number | null;
|
|
1297
1344
|
}
|
|
1345
|
+
/**
|
|
1346
|
+
* The GFN Catalog product this catalog product is based on. Use the GFN Catalog API to list available products. (Deprecated Use `gfnProduct` instead)
|
|
1347
|
+
*/
|
|
1298
1348
|
export interface ProductWarehouseProduct {
|
|
1299
1349
|
/**
|
|
1300
1350
|
* Unique object identifier
|
|
@@ -1304,6 +1354,10 @@ export interface ProductWarehouseProduct {
|
|
|
1304
1354
|
* Reference to the product in the Global Fulfillment Network (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.
|
|
1305
1355
|
*/
|
|
1306
1356
|
'gfnProductRef'?: string;
|
|
1357
|
+
/**
|
|
1358
|
+
* Meta fields from the GFN Catalog product
|
|
1359
|
+
*/
|
|
1360
|
+
'metafields'?: Array<MetaField>;
|
|
1307
1361
|
}
|
|
1308
1362
|
export interface ProductsResponse {
|
|
1309
1363
|
'products'?: Array<Product>;
|
|
@@ -1970,7 +2024,28 @@ export interface Variant {
|
|
|
1970
2024
|
'metafields'?: Array<MetaField>;
|
|
1971
2025
|
'integrationConnections'?: Array<VariantIntegrationConnectionsInner>;
|
|
1972
2026
|
'wholesaleCost'?: VariantWholesaleCost;
|
|
2027
|
+
/**
|
|
2028
|
+
* @deprecated
|
|
2029
|
+
*/
|
|
1973
2030
|
'warehouseVariant'?: VariantWarehouseVariant;
|
|
2031
|
+
'gfnVariant'?: VariantGfnVariant;
|
|
2032
|
+
}
|
|
2033
|
+
/**
|
|
2034
|
+
* The GFN Catalog variant this catalog variant corresponds to. Use the GFN Catalog API to list variants and their attributes.
|
|
2035
|
+
*/
|
|
2036
|
+
export interface VariantGfnVariant {
|
|
2037
|
+
/**
|
|
2038
|
+
* Unique object identifier
|
|
2039
|
+
*/
|
|
2040
|
+
'id'?: string;
|
|
2041
|
+
/**
|
|
2042
|
+
* Reference to the variant in the Global Fulfillment Network (GFN) catalog.
|
|
2043
|
+
*/
|
|
2044
|
+
'gfnVariantRef'?: string;
|
|
2045
|
+
/**
|
|
2046
|
+
* Meta fields from the GFN Catalog variant
|
|
2047
|
+
*/
|
|
2048
|
+
'metafields'?: Array<MetaField>;
|
|
1974
2049
|
}
|
|
1975
2050
|
export interface VariantIntegrationConnectionsInner {
|
|
1976
2051
|
'integrationCode': string;
|
|
@@ -1989,6 +2064,9 @@ export interface VariantProduct {
|
|
|
1989
2064
|
*/
|
|
1990
2065
|
'ref'?: string;
|
|
1991
2066
|
}
|
|
2067
|
+
/**
|
|
2068
|
+
* The GFN Catalog variant this catalog variant corresponds to. Use the GFN Catalog API to list variants and their attributes. (Deprecated Use `gfnVariant` instead)
|
|
2069
|
+
*/
|
|
1992
2070
|
export interface VariantWarehouseVariant {
|
|
1993
2071
|
/**
|
|
1994
2072
|
* Unique object identifier
|
|
@@ -1998,6 +2076,10 @@ export interface VariantWarehouseVariant {
|
|
|
1998
2076
|
* Reference to the variant in the Global Fulfillment Network (GFN) catalog.
|
|
1999
2077
|
*/
|
|
2000
2078
|
'gfnVariantRef'?: string;
|
|
2079
|
+
/**
|
|
2080
|
+
* Meta fields from the GFN Catalog variant
|
|
2081
|
+
*/
|
|
2082
|
+
'metafields'?: Array<MetaField>;
|
|
2001
2083
|
}
|
|
2002
2084
|
export interface VariantWholesaleCost {
|
|
2003
2085
|
'item': RequiredPrice;
|
|
@@ -4233,7 +4315,7 @@ export class ProductTypesApi extends BaseAPI {
|
|
|
4233
4315
|
export const ProductsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
4234
4316
|
return {
|
|
4235
4317
|
/**
|
|
4236
|
-
* Creates a new catalog product based on a
|
|
4318
|
+
* 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.
|
|
4237
4319
|
* @summary Create product
|
|
4238
4320
|
* @param {string} project What project it is
|
|
4239
4321
|
* @param {CreateProductRequest} [createProductRequest]
|
|
@@ -4856,7 +4938,7 @@ export const ProductsApiFp = function(configuration?: Configuration) {
|
|
|
4856
4938
|
const localVarAxiosParamCreator = ProductsApiAxiosParamCreator(configuration)
|
|
4857
4939
|
return {
|
|
4858
4940
|
/**
|
|
4859
|
-
* Creates a new catalog product based on a
|
|
4941
|
+
* 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.
|
|
4860
4942
|
* @summary Create product
|
|
4861
4943
|
* @param {string} project What project it is
|
|
4862
4944
|
* @param {CreateProductRequest} [createProductRequest]
|
|
@@ -5035,7 +5117,7 @@ export const ProductsApiFactory = function (configuration?: Configuration, baseP
|
|
|
5035
5117
|
const localVarFp = ProductsApiFp(configuration)
|
|
5036
5118
|
return {
|
|
5037
5119
|
/**
|
|
5038
|
-
* Creates a new catalog product based on a
|
|
5120
|
+
* 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.
|
|
5039
5121
|
* @summary Create product
|
|
5040
5122
|
* @param {ProductsApiCreateProductRequest} requestParameters Request parameters.
|
|
5041
5123
|
* @param {*} [options] Override http request option.
|
|
@@ -5391,7 +5473,7 @@ export interface ProductsApiUpdateProductsRequest {
|
|
|
5391
5473
|
*/
|
|
5392
5474
|
export class ProductsApi extends BaseAPI {
|
|
5393
5475
|
/**
|
|
5394
|
-
* Creates a new catalog product based on a
|
|
5476
|
+
* 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.
|
|
5395
5477
|
* @summary Create product
|
|
5396
5478
|
* @param {ProductsApiCreateProductRequest} requestParameters Request parameters.
|
|
5397
5479
|
* @param {*} [options] Override http request option.
|
package/base.ts
CHANGED
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Product Catalog API
|
|
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
|
|
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.88.1
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/common.ts
CHANGED
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Product Catalog API
|
|
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
|
|
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.88.1
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/configuration.ts
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
/* tslint:disable */
|
|
2
2
|
/**
|
|
3
3
|
* Product Catalog API
|
|
4
|
-
* 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
|
|
4
|
+
* 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.
|
|
5
5
|
*
|
|
6
|
-
* The version of the OpenAPI document: 1.
|
|
6
|
+
* The version of the OpenAPI document: 1.88.1
|
|
7
7
|
*
|
|
8
8
|
*
|
|
9
9
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/api.d.ts
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Product Catalog API
|
|
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
|
|
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 product from the GFN Catalog, 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.88.1
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -103,7 +103,7 @@ export interface Application {
|
|
|
103
103
|
*/
|
|
104
104
|
'additionalInstructions'?: string | null;
|
|
105
105
|
/**
|
|
106
|
-
* Publicly available design file URL. This will fill the design area of the
|
|
106
|
+
* Publicly available design file URL. This will fill the design area of the GFN Catalog product. It will be centered horizontally and aligned to the top of the design area.
|
|
107
107
|
*/
|
|
108
108
|
'src'?: string;
|
|
109
109
|
/**
|
|
@@ -229,7 +229,7 @@ export interface ApplicationPropertiesPosition {
|
|
|
229
229
|
'z'?: number;
|
|
230
230
|
}
|
|
231
231
|
/**
|
|
232
|
-
* Set these properties when you don\'t have position information for the application. We will use the mockup and baseFlat to calculate the position of the application relative to the bounding box of the
|
|
232
|
+
* Set these properties when you don\'t have position information for the application. We will use the mockup and baseFlat to calculate the position of the application relative to the bounding box of the GFN Catalog product.
|
|
233
233
|
*/
|
|
234
234
|
export interface ApplicationPropertiesPositionInference {
|
|
235
235
|
/**
|
|
@@ -486,7 +486,11 @@ export interface BundleProduct {
|
|
|
486
486
|
* For use with the Shopify integration. The Shopify product ID that this product is linked to.
|
|
487
487
|
*/
|
|
488
488
|
'shopifyId'?: number | null;
|
|
489
|
+
/**
|
|
490
|
+
* @deprecated
|
|
491
|
+
*/
|
|
489
492
|
'warehouseProduct'?: ProductWarehouseProduct;
|
|
493
|
+
'gfnProduct'?: ProductGfnProduct;
|
|
490
494
|
/**
|
|
491
495
|
* Key/value pairs that can be used to store additional information about the product
|
|
492
496
|
*/
|
|
@@ -520,7 +524,7 @@ export interface CreateApplication {
|
|
|
520
524
|
*/
|
|
521
525
|
'additionalInstructions'?: string | null;
|
|
522
526
|
/**
|
|
523
|
-
* Publicly available design file URL. This will fill the design area of the
|
|
527
|
+
* Publicly available design file URL. This will fill the design area of the GFN Catalog product. It will be centered horizontally and aligned to the top of the design area.
|
|
524
528
|
*/
|
|
525
529
|
'src': string;
|
|
526
530
|
/**
|
|
@@ -781,7 +785,7 @@ export interface CreateProduct {
|
|
|
781
785
|
*/
|
|
782
786
|
'internalTags'?: Array<string>;
|
|
783
787
|
/**
|
|
784
|
-
*
|
|
788
|
+
* The variants to create for this product. Each variant must specify attributes that match a variant in the GFN Catalog for the product referenced by gfnProductRef. Use the GFN Catalog API to list products and variants (e.g. GET /v1/gfn/catalog/products/{productId} and GET /v1/gfn/catalog/variants) to get the exact attribute names and values — they must match exactly, including casing.
|
|
785
789
|
*/
|
|
786
790
|
'variants': Array<CreateProductVariant>;
|
|
787
791
|
/**
|
|
@@ -840,9 +844,9 @@ export interface CreateProductImagesInner {
|
|
|
840
844
|
export type CreateProductRequest = CreateBundleProduct | CreateProduct;
|
|
841
845
|
export interface CreateProductVariant {
|
|
842
846
|
/**
|
|
843
|
-
*
|
|
847
|
+
* One entry per attribute (e.g. Size, Colour). The name and value of each attribute must match the GFN Catalog API exactly — use the GFN Catalog API to list the product and its variants to get the exact strings (casing and spelling must match).
|
|
844
848
|
*/
|
|
845
|
-
'attributes': Array<
|
|
849
|
+
'attributes': Array<CreateProductVariantAttributesInner>;
|
|
846
850
|
'retailPrice': UpdateProductsRequestProductsInnerVariantsInnerRetailPrice;
|
|
847
851
|
'salePrice'?: UpdateProductsRequestProductsInnerVariantsInnerSalePrice | null;
|
|
848
852
|
/**
|
|
@@ -854,7 +858,7 @@ export interface CreateProductVariant {
|
|
|
854
858
|
*/
|
|
855
859
|
'applications'?: Array<Application>;
|
|
856
860
|
/**
|
|
857
|
-
* Only use if you want to override the main product image. If not provided, mockups will be generated using the design applications and the
|
|
861
|
+
* Only use if you want to override the main product image. If not provided, mockups will be generated using the design applications and the GFN Catalog product. Accepts PNG and JPEG files.
|
|
858
862
|
*/
|
|
859
863
|
'images'?: Array<CreateProductVariantImagesInner>;
|
|
860
864
|
/**
|
|
@@ -867,6 +871,21 @@ export interface CreateProductVariant {
|
|
|
867
871
|
'shopifyId'?: number | null;
|
|
868
872
|
'integrationConnections'?: Array<UpdateProductsRequestProductsInnerVariantsInnerIntegrationConnectionsInner>;
|
|
869
873
|
}
|
|
874
|
+
export interface CreateProductVariantAttributesInner {
|
|
875
|
+
/**
|
|
876
|
+
* Attribute name as returned by the GFN Catalog API for this product (e.g. \"Size\", \"Colour\"). Must match exactly, including casing.
|
|
877
|
+
*/
|
|
878
|
+
'name': CreateProductVariantAttributesInnerNameEnum;
|
|
879
|
+
/**
|
|
880
|
+
* Attribute value as returned by the GFN Catalog API for this product (e.g. \"S\", \"White\"). Must match exactly, including casing.
|
|
881
|
+
*/
|
|
882
|
+
'value': string;
|
|
883
|
+
}
|
|
884
|
+
export declare const CreateProductVariantAttributesInnerNameEnum: {
|
|
885
|
+
readonly Size: "Size";
|
|
886
|
+
readonly Colour: "Colour";
|
|
887
|
+
};
|
|
888
|
+
export type CreateProductVariantAttributesInnerNameEnum = typeof CreateProductVariantAttributesInnerNameEnum[keyof typeof CreateProductVariantAttributesInnerNameEnum];
|
|
870
889
|
export interface CreateProductVariantImagesInner {
|
|
871
890
|
/**
|
|
872
891
|
* ID of the image if it already exists. A new image will be created if this is not provided.
|
|
@@ -1103,7 +1122,11 @@ export interface Product {
|
|
|
1103
1122
|
* For use with the Shopify integration. The Shopify product ID that this product is linked to.
|
|
1104
1123
|
*/
|
|
1105
1124
|
'shopifyId'?: number | null;
|
|
1125
|
+
/**
|
|
1126
|
+
* @deprecated
|
|
1127
|
+
*/
|
|
1106
1128
|
'warehouseProduct'?: ProductWarehouseProduct;
|
|
1129
|
+
'gfnProduct'?: ProductGfnProduct;
|
|
1107
1130
|
/**
|
|
1108
1131
|
* Key/value pairs that can be used to store additional information about the product
|
|
1109
1132
|
*/
|
|
@@ -1217,7 +1240,11 @@ export interface ProductBundleItemsInner {
|
|
|
1217
1240
|
* For use with the Shopify integration. The Shopify product ID that this product is linked to.
|
|
1218
1241
|
*/
|
|
1219
1242
|
'shopifyId'?: number | null;
|
|
1243
|
+
/**
|
|
1244
|
+
* @deprecated
|
|
1245
|
+
*/
|
|
1220
1246
|
'warehouseProduct'?: ProductWarehouseProduct;
|
|
1247
|
+
'gfnProduct'?: ProductGfnProduct;
|
|
1221
1248
|
/**
|
|
1222
1249
|
* Key/value pairs that can be used to store additional information about the product
|
|
1223
1250
|
*/
|
|
@@ -1238,6 +1265,23 @@ export interface ProductBundleItemsInner {
|
|
|
1238
1265
|
'license'?: License;
|
|
1239
1266
|
'config'?: UpdateProductRequestBundleItemsInnerConfig;
|
|
1240
1267
|
}
|
|
1268
|
+
/**
|
|
1269
|
+
* The GFN Catalog product this catalog product is based on. Use the GFN Catalog API to list available products.
|
|
1270
|
+
*/
|
|
1271
|
+
export interface ProductGfnProduct {
|
|
1272
|
+
/**
|
|
1273
|
+
* Unique object identifier
|
|
1274
|
+
*/
|
|
1275
|
+
'id'?: string;
|
|
1276
|
+
/**
|
|
1277
|
+
* Reference to the product in the Global Fulfillment Network (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.
|
|
1278
|
+
*/
|
|
1279
|
+
'gfnProductRef'?: string;
|
|
1280
|
+
/**
|
|
1281
|
+
* Meta fields from the GFN Catalog product
|
|
1282
|
+
*/
|
|
1283
|
+
'metafields'?: Array<MetaField>;
|
|
1284
|
+
}
|
|
1241
1285
|
export interface ProductType {
|
|
1242
1286
|
/**
|
|
1243
1287
|
* Unique object identifier
|
|
@@ -1255,6 +1299,9 @@ export interface ProductTypeListResponse {
|
|
|
1255
1299
|
*/
|
|
1256
1300
|
'nextPageToken': number | null;
|
|
1257
1301
|
}
|
|
1302
|
+
/**
|
|
1303
|
+
* The GFN Catalog product this catalog product is based on. Use the GFN Catalog API to list available products. (Deprecated Use `gfnProduct` instead)
|
|
1304
|
+
*/
|
|
1258
1305
|
export interface ProductWarehouseProduct {
|
|
1259
1306
|
/**
|
|
1260
1307
|
* Unique object identifier
|
|
@@ -1264,6 +1311,10 @@ export interface ProductWarehouseProduct {
|
|
|
1264
1311
|
* Reference to the product in the Global Fulfillment Network (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.
|
|
1265
1312
|
*/
|
|
1266
1313
|
'gfnProductRef'?: string;
|
|
1314
|
+
/**
|
|
1315
|
+
* Meta fields from the GFN Catalog product
|
|
1316
|
+
*/
|
|
1317
|
+
'metafields'?: Array<MetaField>;
|
|
1267
1318
|
}
|
|
1268
1319
|
export interface ProductsResponse {
|
|
1269
1320
|
'products'?: Array<Product>;
|
|
@@ -1905,7 +1956,28 @@ export interface Variant {
|
|
|
1905
1956
|
'metafields'?: Array<MetaField>;
|
|
1906
1957
|
'integrationConnections'?: Array<VariantIntegrationConnectionsInner>;
|
|
1907
1958
|
'wholesaleCost'?: VariantWholesaleCost;
|
|
1959
|
+
/**
|
|
1960
|
+
* @deprecated
|
|
1961
|
+
*/
|
|
1908
1962
|
'warehouseVariant'?: VariantWarehouseVariant;
|
|
1963
|
+
'gfnVariant'?: VariantGfnVariant;
|
|
1964
|
+
}
|
|
1965
|
+
/**
|
|
1966
|
+
* The GFN Catalog variant this catalog variant corresponds to. Use the GFN Catalog API to list variants and their attributes.
|
|
1967
|
+
*/
|
|
1968
|
+
export interface VariantGfnVariant {
|
|
1969
|
+
/**
|
|
1970
|
+
* Unique object identifier
|
|
1971
|
+
*/
|
|
1972
|
+
'id'?: string;
|
|
1973
|
+
/**
|
|
1974
|
+
* Reference to the variant in the Global Fulfillment Network (GFN) catalog.
|
|
1975
|
+
*/
|
|
1976
|
+
'gfnVariantRef'?: string;
|
|
1977
|
+
/**
|
|
1978
|
+
* Meta fields from the GFN Catalog variant
|
|
1979
|
+
*/
|
|
1980
|
+
'metafields'?: Array<MetaField>;
|
|
1909
1981
|
}
|
|
1910
1982
|
export interface VariantIntegrationConnectionsInner {
|
|
1911
1983
|
'integrationCode': string;
|
|
@@ -1924,6 +1996,9 @@ export interface VariantProduct {
|
|
|
1924
1996
|
*/
|
|
1925
1997
|
'ref'?: string;
|
|
1926
1998
|
}
|
|
1999
|
+
/**
|
|
2000
|
+
* The GFN Catalog variant this catalog variant corresponds to. Use the GFN Catalog API to list variants and their attributes. (Deprecated Use `gfnVariant` instead)
|
|
2001
|
+
*/
|
|
1927
2002
|
export interface VariantWarehouseVariant {
|
|
1928
2003
|
/**
|
|
1929
2004
|
* Unique object identifier
|
|
@@ -1933,6 +2008,10 @@ export interface VariantWarehouseVariant {
|
|
|
1933
2008
|
* Reference to the variant in the Global Fulfillment Network (GFN) catalog.
|
|
1934
2009
|
*/
|
|
1935
2010
|
'gfnVariantRef'?: string;
|
|
2011
|
+
/**
|
|
2012
|
+
* Meta fields from the GFN Catalog variant
|
|
2013
|
+
*/
|
|
2014
|
+
'metafields'?: Array<MetaField>;
|
|
1936
2015
|
}
|
|
1937
2016
|
export interface VariantWholesaleCost {
|
|
1938
2017
|
'item': RequiredPrice;
|
|
@@ -3066,7 +3145,7 @@ export declare class ProductTypesApi extends BaseAPI {
|
|
|
3066
3145
|
*/
|
|
3067
3146
|
export declare const ProductsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
3068
3147
|
/**
|
|
3069
|
-
* Creates a new catalog product based on a
|
|
3148
|
+
* 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.
|
|
3070
3149
|
* @summary Create product
|
|
3071
3150
|
* @param {string} project What project it is
|
|
3072
3151
|
* @param {CreateProductRequest} [createProductRequest]
|
|
@@ -3186,7 +3265,7 @@ export declare const ProductsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
3186
3265
|
*/
|
|
3187
3266
|
export declare const ProductsApiFp: (configuration?: Configuration) => {
|
|
3188
3267
|
/**
|
|
3189
|
-
* Creates a new catalog product based on a
|
|
3268
|
+
* 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.
|
|
3190
3269
|
* @summary Create product
|
|
3191
3270
|
* @param {string} project What project it is
|
|
3192
3271
|
* @param {CreateProductRequest} [createProductRequest]
|
|
@@ -3306,7 +3385,7 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
|
|
|
3306
3385
|
*/
|
|
3307
3386
|
export declare const ProductsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
3308
3387
|
/**
|
|
3309
|
-
* Creates a new catalog product based on a
|
|
3388
|
+
* 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.
|
|
3310
3389
|
* @summary Create product
|
|
3311
3390
|
* @param {ProductsApiCreateProductRequest} requestParameters Request parameters.
|
|
3312
3391
|
* @param {*} [options] Override http request option.
|
|
@@ -3600,7 +3679,7 @@ export interface ProductsApiUpdateProductsRequest {
|
|
|
3600
3679
|
*/
|
|
3601
3680
|
export declare class ProductsApi extends BaseAPI {
|
|
3602
3681
|
/**
|
|
3603
|
-
* Creates a new catalog product based on a
|
|
3682
|
+
* 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.
|
|
3604
3683
|
* @summary Create product
|
|
3605
3684
|
* @param {ProductsApiCreateProductRequest} requestParameters Request parameters.
|
|
3606
3685
|
* @param {*} [options] Override http request option.
|