This is the early access documentation preview for Custom Views. This documentation might not be in sync with our official documentation.

Importing Product Types

Create and update ProductTypes in your Project.

The ProductType data to import is represented by ProductTypeImport and included in a ProductTypeImportRequest, which is imported using Import ProductTypes.

Read the Nested Attribute tutorial to learn how to create/update nested Attribute values with the Import API.

Representations

ProductTypeImportRequest

ProductTypeImport

ProductTypeImportRequest

The request body to import ProductTypes. Contains data for ProductTypes to be created or updated in a Project.

`type` String	`"product-type"` The Product Type import resource type.
`resources` Array of ProductTypeImport	The product type import resources of this request. MaxItems: `20`

Example: json

{
  "type": "product-type",
  "resources": [
    {
      "key": "sample",
      "name": "test_product_type",
      "description": "Test product type.",
      "attributes": [
        {
          "name": "product-ref-attribute",
          "label": {
            "en": "selling product"
          },
          "isRequired": false,
          "isSearchable": false,
          "type": {
            "name": "reference",
            "referenceTypeId": "category"
          },
          "attributeConstraint": "Unique",
          "inputTip": {
            "en": "product input tip"
          },
          "inputHint": "SingleLine"
        }
      ]
    }
  ]
}

ProductTypeImport

The data representation for a ProductType to be imported that is persisted as a ProductType in the Project.

`key` String	User-defined unique identifier. If a ProductType with this `key` exists, it will be updated with the imported data.
`name` String	Maps to `ProductType.name`.
`description` String	Maps to `ProductType.description`.
`attributes` Array of AttributeDefinition	The `attributes` of ProductType.

Import ProductTypes

POST

https://import.{region}.commercetools.com/{projectKey}/product-types/import-containers/{importContainerKey}

Creates a request for creating new ProductTypes or updating existing ones.

OAuth 2.0 Scopes:

manage_products:{projectKey}

Path parameters:

`region` String	The Region in which the Project is hosted.
`projectKey` String	The Project key.
`importContainerKey` String	The ImportContainer used to create the new resource

Request Body:ProductTypeImportRequestasapplication/json

Response:

201ImportResponseasapplication/json