@teemill/product-catalog 1.48.0 → 1.49.0

package/docs/SeoOptimiseProductsRequest.md

@@ -0,0 +1,22 @@
+# SeoOptimiseProductsRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ids** | **Array<string>** | A set of product IDs to AI SEO optimise. | [optional] [default to undefined]
+**fields** | **Array<string>** | If provided, only the specified fields will be updated. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SeoOptimiseProductsRequest } from '@teemill/product-catalog';
+
+const instance: SeoOptimiseProductsRequest = {
+    ids,
+    fields,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/Stock.md

@@ -0,0 +1,22 @@
+# Stock
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**level** | **number** |  | [optional] [default to undefined]
+**locations** | [**Array<Location>**](Location.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Stock } from '@teemill/product-catalog';
+
+const instance: Stock = {
+    level,
+    locations,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/TargetSearchPhraseData.md

@@ -0,0 +1,22 @@
+# TargetSearchPhraseData
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**targetSearchPhrase** | **string** | The primary target search phrase for the product that you wish to rank for in search engine results. | [optional] [default to undefined]
+**targetSearchPhraseSynonyms** | **Array<string>** | Synonyms for the target search phrase. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { TargetSearchPhraseData } from '@teemill/product-catalog';
+
+const instance: TargetSearchPhraseData = {
+    targetSearchPhrase,
+    targetSearchPhraseSynonyms,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/UpdateApplicationSetRequest.md

@@ -0,0 +1,30 @@
+# UpdateApplicationSetRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** | Name of the application set | [optional] [default to undefined]
+**description** | **string** | Description of the application set | [optional] [default to undefined]
+**width** | **number** | The width, in pixels of the images in the set | [optional] [default to undefined]
+**height** | **number** | The height, in pixels of the images in the set | [optional] [default to undefined]
+**dpi** | **number** | The DPI used when printing the images in the set | [optional] [default to undefined]
+**records** | [**Array<UpdateApplicationSetRequestRecordsInner>**](UpdateApplicationSetRequestRecordsInner.md) | List of application set records | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UpdateApplicationSetRequest } from '@teemill/product-catalog';
+
+const instance: UpdateApplicationSetRequest = {
+    name,
+    description,
+    width,
+    height,
+    dpi,
+    records,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/UpdateApplicationSetRequestRecordsInner.md

@@ -0,0 +1,22 @@
+# UpdateApplicationSetRequestRecordsInner
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**attributes** | [**Array<UpdateApplicationSetRequestRecordsInnerAttributesInner>**](UpdateApplicationSetRequestRecordsInnerAttributesInner.md) | List of attributes this record applies to. Providing an empty array will apply the application set to all variants. | [optional] [default to undefined]
+**applications** | [**Array<Application>**](Application.md) | List of applications for this record | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UpdateApplicationSetRequestRecordsInner } from '@teemill/product-catalog';
+
+const instance: UpdateApplicationSetRequestRecordsInner = {
+    attributes,
+    applications,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/UpdateApplicationSetRequestRecordsInnerAttributesInner.md

@@ -0,0 +1,22 @@
+# UpdateApplicationSetRequestRecordsInnerAttributesInner
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** | The name of the option type. e.g. Size, Colour | [optional] [default to undefined]
+**value** | **string** | The value of the option this record applies to | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UpdateApplicationSetRequestRecordsInnerAttributesInner } from '@teemill/product-catalog';
+
+const instance: UpdateApplicationSetRequestRecordsInnerAttributesInner = {
+    name,
+    value,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/UpdateProductRequest.md

@@ -0,0 +1,64 @@
+# UpdateProductRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**gfnProductRef** | **string** | 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. | [optional] [default to undefined]
+**title** | **string** | Product title | [optional] [default to undefined]
+**description** | **string** | Product description | [optional] [default to undefined]
+**enabled** | **boolean** | Whether the product is enabled upon creation. | [optional] [default to undefined]
+**slug** | **string** | A custom URL slug for the product. This must be unique for each product on the project. | [optional] [default to undefined]
+**seoMetadata** | [**UpdateProductsRequestProductsInnerSeoMetadata**](UpdateProductsRequestProductsInnerSeoMetadata.md) |  | [optional] [default to undefined]
+**targetSearchPhrase** | **string** | The primary target search phrase for the product that you wish to rank for in search engine results.  **Note:** This field requires the website integration | [optional] [default to undefined]
+**targetSearchPhraseSynonyms** | **Array<string>** | Synonyms for the target search phrase. **Note:** This field requires the website integration | [optional] [default to undefined]
+**tags** | **Array<string>** | Additional product tags used for searching and filtering. | [optional] [default to undefined]
+**internalTags** | **Array<string>** | Additional product tags used for internal searching and filtering. | [optional] [default to undefined]
+**variants** | [**Array<CreateProductVariant>**](CreateProductVariant.md) | Variants | [optional] [default to undefined]
+**bundleItems** | **Array<string>** | A list of product uuids to be in this bundle. Only valid if the product is already a bundle. | [optional] [default to undefined]
+**retailPrice** | [**Price**](Price.md) |  | [optional] [default to undefined]
+**salePrice** | [**Price**](Price.md) |  | [optional] [default to undefined]
+**images** | [**Array<ImageFile>**](ImageFile.md) | Images to attach to the product. For example, photos of models using/wearing the product. | [optional] [default to undefined]
+**videos** | [**Array<VideoFile>**](VideoFile.md) | Videos to attach to the product. | [optional] [default to undefined]
+**additionalFiles** | [**Array<AdditionalFile>**](AdditionalFile.md) | Additional files to attach to the product. For example, original design files e.g. PSD, AI, etc. | [optional] [default to undefined]
+**applicationSets** | **Array<string>** | List of application set UUIDs to associate with this product | [optional] [default to undefined]
+**includeInDataFeeds** | **boolean** | Whether the product should be included in data feeds that can be provided to Google, Meta etc for advertising. | [optional] [default to true]
+**shopifyId** | **number** | For use with the Shopify integration. Use this to provide a Shopify product ID to link to an existing Shopify product rather than creating a new one. | [optional] [default to undefined]
+**metafields** | [**Array<MetaField>**](MetaField.md) | Key/value pairs that can be used to store additional information about the product | [optional] [default to undefined]
+**personalizationTemplate** | **string** | A JSON object that defines the personalization template for the product. | [optional] [default to undefined]
+**integrationConnections** | [**Array<UpdateProductRequestIntegrationConnectionsInner>**](UpdateProductRequestIntegrationConnectionsInner.md) | Integration connections for the product | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UpdateProductRequest } from '@teemill/product-catalog';
+
+const instance: UpdateProductRequest = {
+    gfnProductRef,
+    title,
+    description,
+    enabled,
+    slug,
+    seoMetadata,
+    targetSearchPhrase,
+    targetSearchPhraseSynonyms,
+    tags,
+    internalTags,
+    variants,
+    bundleItems,
+    retailPrice,
+    salePrice,
+    images,
+    videos,
+    additionalFiles,
+    applicationSets,
+    includeInDataFeeds,
+    shopifyId,
+    metafields,
+    personalizationTemplate,
+    integrationConnections,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/UpdateProductRequestIntegrationConnectionsInner.md

@@ -0,0 +1,22 @@
+# UpdateProductRequestIntegrationConnectionsInner
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**integrationCode** | **string** | Code identifying the integration | [default to undefined]
+**foreignKey** | **string** | The value of the identifying property on the foreign product | [default to undefined]
+
+## Example
+
+```typescript
+import { UpdateProductRequestIntegrationConnectionsInner } from '@teemill/product-catalog';
+
+const instance: UpdateProductRequestIntegrationConnectionsInner = {
+    integrationCode,
+    foreignKey,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/UpdateProductsRequest.md

@@ -0,0 +1,20 @@
+# UpdateProductsRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**products** | [**Array<UpdateProductsRequestProductsInner>**](UpdateProductsRequestProductsInner.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UpdateProductsRequest } from '@teemill/product-catalog';
+
+const instance: UpdateProductsRequest = {
+    products,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/UpdateProductsRequestProductsInner.md

@@ -0,0 +1,42 @@
+# UpdateProductsRequestProductsInner
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Unique object identifier | [default to undefined]
+**title** | **string** | Product title | [optional] [default to undefined]
+**description** | **string** | Product description | [optional] [default to undefined]
+**enabled** | **boolean** | Whether the product is enabled. | [optional] [default to undefined]
+**seoMetadata** | [**UpdateProductsRequestProductsInnerSeoMetadata**](UpdateProductsRequestProductsInnerSeoMetadata.md) |  | [optional] [default to undefined]
+**targetSearchPhrase** | **string** | The primary target search phrase for the product that you wish to rank for in search engine results.  **Note:** This field requires the website integration | [optional] [default to undefined]
+**targetSearchPhraseSynonyms** | **Array<string>** | Synonyms for the target search phrase. **Note:** This field requires the website integration | [optional] [default to undefined]
+**tags** | **Array<string>** | Additional product tags used for searching and filtering. | [optional] [default to undefined]
+**variants** | [**Array<UpdateProductsRequestProductsInnerVariantsInner>**](UpdateProductsRequestProductsInnerVariantsInner.md) | List of variants to update. | [optional] [default to undefined]
+**includeInDataFeeds** | **boolean** | Whether the product should be included in data feeds that can be provided to Google, Meta etc for advertising. | [optional] [default to true]
+**shopifyId** | **number** | For use with the Shopify integration. Use this to provide a Shopify product ID to link to an existing Shopify product rather than creating a new one. | [optional] [default to undefined]
+**integrationConnections** | [**Array<UpdateProductsRequestProductsInnerIntegrationConnectionsInner>**](UpdateProductsRequestProductsInnerIntegrationConnectionsInner.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UpdateProductsRequestProductsInner } from '@teemill/product-catalog';
+
+const instance: UpdateProductsRequestProductsInner = {
+    id,
+    title,
+    description,
+    enabled,
+    seoMetadata,
+    targetSearchPhrase,
+    targetSearchPhraseSynonyms,
+    tags,
+    variants,
+    includeInDataFeeds,
+    shopifyId,
+    integrationConnections,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/UpdateProductsRequestProductsInnerIntegrationConnectionsInner.md

@@ -0,0 +1,22 @@
+# UpdateProductsRequestProductsInnerIntegrationConnectionsInner
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**integrationCode** | **string** |  | [default to undefined]
+**foreignKey** | **string** | The value of the identifying property on the foreign product | [default to undefined]
+
+## Example
+
+```typescript
+import { UpdateProductsRequestProductsInnerIntegrationConnectionsInner } from '@teemill/product-catalog';
+
+const instance: UpdateProductsRequestProductsInnerIntegrationConnectionsInner = {
+    integrationCode,
+    foreignKey,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/UpdateProductsRequestProductsInnerSeoMetadata.md

@@ -0,0 +1,22 @@
+# UpdateProductsRequestProductsInnerSeoMetadata
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**title** | **string** | Meta title for the product. This appears in search engine results and social shares. If not provided, the product title will be used. | [optional] [default to undefined]
+**description** | **string** | Meta description for the product. This appears in search engine results and social shares. If not provided, the product description will be used. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UpdateProductsRequestProductsInnerSeoMetadata } from '@teemill/product-catalog';
+
+const instance: UpdateProductsRequestProductsInnerSeoMetadata = {
+    title,
+    description,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/UpdateProductsRequestProductsInnerVariantsInner.md

@@ -0,0 +1,30 @@
+# UpdateProductsRequestProductsInnerVariantsInner
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**attributes** | [**Array<UpdateProductsRequestProductsInnerVariantsInnerAttributesInner>**](UpdateProductsRequestProductsInnerVariantsInnerAttributesInner.md) | Attributes associated to a variant such as Colour and Size. | [default to undefined]
+**retailPrice** | [**UpdateProductsRequestProductsInnerVariantsInnerRetailPrice**](UpdateProductsRequestProductsInnerVariantsInnerRetailPrice.md) |  | [default to undefined]
+**salePrice** | [**UpdateProductsRequestProductsInnerVariantsInnerSalePrice**](UpdateProductsRequestProductsInnerVariantsInnerSalePrice.md) |  | [optional] [default to undefined]
+**barcode** | **string** | The GTIN (Global Trade Item Number) or EAN (European Article Number) of the variant. Please note that a barcode can only be attached after the Barcodes module has been installed. | [optional] [default to undefined]
+**shopifyId** | **number** | For use with the Shopify integration. Use this to provide a Shopify variant ID to link to an existing Shopify variant rather than creating a new one. | [optional] [default to undefined]
+**integrationConnections** | [**Array<UpdateProductsRequestProductsInnerVariantsInnerIntegrationConnectionsInner>**](UpdateProductsRequestProductsInnerVariantsInnerIntegrationConnectionsInner.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UpdateProductsRequestProductsInnerVariantsInner } from '@teemill/product-catalog';
+
+const instance: UpdateProductsRequestProductsInnerVariantsInner = {
+    attributes,
+    retailPrice,
+    salePrice,
+    barcode,
+    shopifyId,
+    integrationConnections,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/UpdateProductsRequestProductsInnerVariantsInnerAttributesInner.md

@@ -0,0 +1,22 @@
+# UpdateProductsRequestProductsInnerVariantsInnerAttributesInner
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** | Attribute name | [default to undefined]
+**value** | **string** | Attribute value | [default to undefined]
+
+## Example
+
+```typescript
+import { UpdateProductsRequestProductsInnerVariantsInnerAttributesInner } from '@teemill/product-catalog';
+
+const instance: UpdateProductsRequestProductsInnerVariantsInnerAttributesInner = {
+    name,
+    value,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/UpdateProductsRequestProductsInnerVariantsInnerIntegrationConnectionsInner.md

@@ -0,0 +1,22 @@
+# UpdateProductsRequestProductsInnerVariantsInnerIntegrationConnectionsInner
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**integrationCode** | **string** |  | [default to undefined]
+**foreignKey** | **string** | The value of the identifying property on the foreign variant | [default to undefined]
+
+## Example
+
+```typescript
+import { UpdateProductsRequestProductsInnerVariantsInnerIntegrationConnectionsInner } from '@teemill/product-catalog';
+
+const instance: UpdateProductsRequestProductsInnerVariantsInnerIntegrationConnectionsInner = {
+    integrationCode,
+    foreignKey,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/UpdateProductsRequestProductsInnerVariantsInnerRetailPrice.md

@@ -0,0 +1,23 @@
+# UpdateProductsRequestProductsInnerVariantsInnerRetailPrice
+
+Variant retail price including tax.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**amount** | **number** | Price including tax in the specified currency. | [default to undefined]
+**currencyCode** | **string** | Currency code for the currency the price is valued in. | [default to undefined]
+
+## Example
+
+```typescript
+import { UpdateProductsRequestProductsInnerVariantsInnerRetailPrice } from '@teemill/product-catalog';
+
+const instance: UpdateProductsRequestProductsInnerVariantsInnerRetailPrice = {
+    amount,
+    currencyCode,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/UpdateProductsRequestProductsInnerVariantsInnerSalePrice.md

@@ -0,0 +1,23 @@
+# UpdateProductsRequestProductsInnerVariantsInnerSalePrice
+
+Variant discounted price including tax.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**amount** | **number** | Sale price including tax in the specified currency. | [default to undefined]
+**currencyCode** | **string** | Currency code for the currency the sale price is valued in. | [default to undefined]
+
+## Example
+
+```typescript
+import { UpdateProductsRequestProductsInnerVariantsInnerSalePrice } from '@teemill/product-catalog';
+
+const instance: UpdateProductsRequestProductsInnerVariantsInnerSalePrice = {
+    amount,
+    currencyCode,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/Variant.md

@@ -0,0 +1,58 @@
+# Variant
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Unique object identifier | [optional] [default to undefined]
+**attributes** | [**Array<Attribute>**](Attribute.md) | Attributes associated to a variant such as Colour and Size. An attribute can have thumbnail type of `text`, `color`, or `image`. Attribute tags are intended for grouping and filtering, e.g. by a group of colours. | [default to undefined]
+**sku** | **string** |  | [default to undefined]
+**ref** | **string** | A reference to the resource location | [optional] [default to undefined]
+**product** | [**VariantProduct**](VariantProduct.md) |  | [optional] [default to undefined]
+**sortOrder** | **number** |  | [optional] [readonly] [default to undefined]
+**retailPrice** | [**Price**](Price.md) |  | [optional] [default to undefined]
+**salePrice** | [**Price**](Price.md) |  | [optional] [default to undefined]
+**price** | [**Price**](Price.md) |  | [optional] [readonly] [default to undefined]
+**stock** | [**Stock**](Stock.md) |  | [optional] [default to undefined]
+**createdAt** | **string** |  | [optional] [default to undefined]
+**updatedAt** | **string** |  | [optional] [default to undefined]
+**publishedAt** | **string** |  | [optional] [default to undefined]
+**images** | [**Array<Image>**](Image.md) | Images | [optional] [default to undefined]
+**applications** | [**Array<Application>**](Application.md) | Design applications. If not provided, the product will be blank. | [optional] [default to undefined]
+**barcode** | **string** | The GTIN (Global Trade Item Number) or EAN (European Article Number) of the variant. Please note that a barcode can only be attached after the Barcodes module has been installed. | [optional] [default to undefined]
+**gtin** | **string** | Deprecated. Please use `barcode` instead. | [optional] [default to undefined]
+**shopifyId** | **number** | For use with the Shopify integration. The Shopify variant ID that this variant is linked to. | [optional] [default to undefined]
+**metafields** | [**Array<MetaField>**](MetaField.md) | Key/value pairs that can be used to store additional information about the variant | [optional] [default to undefined]
+**integrationConnections** | [**Array<VariantIntegrationConnectionsInner>**](VariantIntegrationConnectionsInner.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Variant } from '@teemill/product-catalog';
+
+const instance: Variant = {
+    id,
+    attributes,
+    sku,
+    ref,
+    product,
+    sortOrder,
+    retailPrice,
+    salePrice,
+    price,
+    stock,
+    createdAt,
+    updatedAt,
+    publishedAt,
+    images,
+    applications,
+    barcode,
+    gtin,
+    shopifyId,
+    metafields,
+    integrationConnections,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/VariantIntegrationConnectionsInner.md

@@ -0,0 +1,22 @@
+# VariantIntegrationConnectionsInner
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**integrationCode** | **string** |  | [default to undefined]
+**foreignKey** | **string** | The value of the identifying property on the foreign variant | [default to undefined]
+
+## Example
+
+```typescript
+import { VariantIntegrationConnectionsInner } from '@teemill/product-catalog';
+
+const instance: VariantIntegrationConnectionsInner = {
+    integrationCode,
+    foreignKey,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/VariantProduct.md

@@ -0,0 +1,22 @@
+# VariantProduct
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Unique object identifier | [optional] [default to undefined]
+**ref** | **string** | A reference to the resource location | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { VariantProduct } from '@teemill/product-catalog';
+
+const instance: VariantProduct = {
+    id,
+    ref,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)