Import Requests

Import Requests represent how you send resources to the Import API.

To import resources into your Project, include them in the resources field of an ImportRequest, and create an Import Request. The system then creates one ImportOperation per resource in the ImportRequest, and returns the initial status of the import to you in an ImportResponse.

Import Requests are resource-specific and can contain up to 20 resources. After making the request, you can monitor the import process.

Multiple requests can be sent to the same ImportContainer at the same time. To achieve the best performance with the Import API, we recommend having fewer than 200 000 ImportOperations per ImportContainer.

When an import request updates an existing resource, values omitted from the imported data can be removed from the resource. Include all existing values you want to keep. For the values removed for each resource, see Omitted values are removed on update.

Create Import Request

for Product Variant Patches

for Product Selections

for Product Tailoring

for Orders

for Order Patches

for Standalone Prices

for Variants

for Types

for Business Units

POST

https://import.{region}.commercetools.com/{projectKey}/business-units/import-containers/{importContainerKey}

Creates an Import Request for Business Units.

OAuth 2.0 Scopes:

manage_project:{projectKey}manage_business_units:{projectKey}

Path parameters:

`region` String	The Region in which the Project is hosted.
`projectKey` String	`key` of the Project.
`importContainerKey` String	`key` of the ImportContainer to send this ImportRequest.

Request Body:BusinessUnitImportRequestasapplication/json

Response:

201

ImportResponse

application/json

curl https://import.{region}.commercetools.com/{projectKey}/business-units/import-containers/{importContainerKey} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}" \
--header 'Content-Type: application/json' \
--data-binary @- << DATA 
{
  "type" : "business-unit",
  "resources" : [ {
    "key" : "acme-business-unit",
    "name" : "ACME Business Unit",
    "unitType" : "Company"
  }, {
    "key" : "acme-business-unit-division-a",
    "name" : "ACME Business Unit: Division A",
    "unitType" : "Division",
    "parentUnit" : {
      "key" : "acme-business-unit",
      "typeId" : "business-unit"
    }
  } ]
}
DATA

{
  "operationStatus": [
    {
      "state": "processing",
      "operationId": "252c6ed3-c668-4610-afe9-87b9255e62e0"
    }
  ]
}

for Categories

POST

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

Creates an Import Request for Categories.

When updating existing Categories, assets and custom omitted from a CategoryImport are removed. Include all existing values you want to keep.

OAuth 2.0 Scopes:

manage_products:{projectKey}

Path parameters:

`region` String	The Region in which the Project is hosted.
`projectKey` String	`key` of the Project.
`importContainerKey` String	`key` of the ImportContainer to send this ImportRequest.

Request Body:CategoryImportRequestasapplication/json

Response:

201

ImportResponse

application/json

curl https://import.{region}.commercetools.com/{projectKey}/categories/import-containers/{importContainerKey} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}" \
--header 'Content-Type: application/json' \
--data-binary @- << DATA 
{
  "type" : "category",
  "resources" : [ {
    "key" : "category-to-import",
    "name" : {
      "en" : "Category to import"
    },
    "slug" : {
      "en" : "category-to-import-slug"
    },
    "description" : {
      "en" : "Description of category to import"
    },
    "parent" : {
      "typeId" : "category",
      "key" : "key-of-parent-category"
    }
  } ]
}
DATA

{
  "operationStatus": [
    {
      "state": "processing",
      "operationId": "252c6ed3-c668-4610-afe9-87b9255e62e0"
    }
  ]
}

for Customers

POST

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

Creates an Import Request for Customers.

When updating existing Customers, addresses, customerGroup, and custom omitted from a CustomerImport are removed. Include all existing values you want to keep.

OAuth 2.0 Scopes:

manage_customers:{projectKey}

Path parameters:

`region` String	The Region in which the Project is hosted.
`projectKey` String	`key` of the Project.
`importContainerKey` String	`key` of the ImportContainer to send this ImportRequest.

Request Body:CustomerImportRequestasapplication/json

Response:

201

ImportResponse

application/json

curl https://import.{region}.commercetools.com/{projectKey}/customers/import-containers/{importContainerKey} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}" \
--header 'Content-Type: application/json' \
--data-binary @- << DATA 
{
  "type" : "customer",
  "resources" : [ {
    "key" : "customer-to-import",
    "customerNumber" : "12345",
    "email" : "john@example.com",
    "password" : "D0cEx@mpl3!2025",
    "firstName" : "John",
    "lastName" : "Doe",
    "dateOfBirth" : "1980-01-01",
    "isEmailVerified" : false,
    "externalId" : "external-id-123",
    "customerGroup" : {
      "typeId" : "customer-group",
      "key" : "customer-group-key"
    },
    "addresses" : [ {
      "key" : "john-doe-address-key",
      "streetName" : "Main Street",
      "streetNumber" : "123",
      "postalCode" : "12345",
      "city" : "Berlin",
      "country" : "DE"
    } ],
    "authenticationMode" : "Password"
  } ]
}
DATA

{
  "operationStatus": [
    {
      "state": "processing",
      "operationId": "252c6ed3-c668-4610-afe9-87b9255e62e0"
    }
  ]
}

for Discount Codes

POST

https://import.{region}.commercetools.com/{projectKey}/discount-codes/import-containers/{importContainerKey}

Creates an Import Request for Discount Codes.

OAuth 2.0 Scopes:

manage_discount_codes:{projectKey}view_discount_codes:{projectKey}

Path parameters:

`region` String	The Region in which the Project is hosted.
`projectKey` String	`key` of the Project.
`importContainerKey` String	`key` of the ImportContainer to send this ImportRequest.

Request Body:DiscountCodeImportRequestasapplication/json

Response:

201

ImportResponse

application/json

curl https://import.{region}.commercetools.com/{projectKey}/discount-codes/import-containers/{importContainerKey} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}" \
--header 'Content-Type: application/json' \
--data-binary @- << DATA 
{
  "type" : "discount-code",
  "resources" : [ {
    "key" : "discountCodeKey",
    "code" : "Save10",
    "name" : {
      "en" : "Save10"
    },
    "cartDiscounts" : [ {
      "typeId" : "cart-discount",
      "key" : "cartDiscountKey"
    } ],
    "isActive" : false,
    "groups" : [ ]
  } ]
}
DATA

{
  "operationStatus": [
    {
      "state": "processing",
      "operationId": "252c6ed3-c668-4610-afe9-87b9255e62e0"
    }
  ]
}

for Embedded Prices

To create and update Standalone Prices, use the Standalone Prices endpoint instead.

POST

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

Creates an Import Request for Embedded Prices.

When updating an existing Embedded Price, optional values omitted from a PriceImport, such as country, channel, customerGroup, validFrom, validUntil, tiers, discounted, and custom, are removed. Include all existing values you want to keep. Other Prices of the ProductVariant are not changed.

OAuth 2.0 Scopes:

manage_products:{projectKey}

Path parameters:

`region` String	The Region in which the Project is hosted.
`projectKey` String	`key` of the Project.
`importContainerKey` String	`key` of the ImportContainer to send this ImportRequest.

Request Body:PriceImportRequestasapplication/json

Response:

201

ImportResponse

application/json

curl https://import.{region}.commercetools.com/{projectKey}/prices/import-containers/{importContainerKey} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}" \
--header 'Content-Type: application/json' \
--data-binary @- << DATA 
{
  "type" : "price",
  "resources" : [ {
    "key" : "price-key",
    "country" : "DE",
    "validFrom" : "2021-04-11T14:00:00.000Z",
    "validUntil" : "2022-04-11T14:00:00.000Z",
    "customerGroup" : {
      "typeId" : "customer-group",
      "key" : "customer-group-key"
    },
    "channel" : {
      "typeId" : "channel",
      "key" : "channel-key"
    },
    "productVariant" : {
      "typeId" : "product-variant",
      "key" : "red-t-shirt"
    },
    "product" : {
      "typeId" : "product",
      "key" : "t-shirt"
    },
    "value" : {
      "type" : "centPrecision",
      "currencyCode" : "EUR",
      "centAmount" : 300
    }
  } ]
}
DATA

{
  "operationStatus": [
    {
      "state": "processing",
      "operationId": "252c6ed3-c668-4610-afe9-87b9255e62e0"
    }
  ]
}

for Inventory

Use this endpoint to import inventory data to create and update InventoryEntry in a Project.

POST

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

Creates an Import Request for InventoryEntries.

When updating existing InventoryEntries, supplyChannel and custom omitted from an InventoryImport are removed. Include all existing values you want to keep.

OAuth 2.0 Scopes:

manage_products:{projectKey}

Path parameters:

`region` String	The Region in which the Project is hosted.
`projectKey` String	`key` of the Project.
`importContainerKey` String	`key` of the ImportContainer to send this ImportRequest.

Request Body:InventoryImportRequestasapplication/json

Response:

201

ImportResponse

application/json

curl https://import.{region}.commercetools.com/{projectKey}/inventories/import-containers/{importContainerKey} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}" \
--header 'Content-Type: application/json' \
--data-binary @- << DATA 
{
  "type" : "inventory",
  "resources" : [ {
    "key" : "inventory-import-key",
    "sku" : "product-variant-sku",
    "quantityOnStock" : 15,
    "restockableInDays" : 2,
    "expectedDelivery" : "2022-06-30T14:00:00.000Z",
    "supplyChannel" : {
      "typeId" : "channel",
      "key" : "channel-key"
    }
  } ]
}
DATA

{
  "operationStatus": [
    {
      "state": "processing",
      "operationId": "252c6ed3-c668-4610-afe9-87b9255e62e0"
    }
  ]
}

for Products

Use this endpoint to import Product data without Product Variant or Price information. This endpoint has a smaller payload than for Product Drafts and will result in faster performance as Product Variant and Price information is not involved.

When importing a Product to update an existing Product, include all existing values you want to keep. categories, taxCategory, and product-level attributes omitted from the ProductImport are removed. Omitting attributes removes all product-level Attributes, and a partial list removes every Attribute that is not in the list.

POST

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

Creates an Import Request for Products.

When updating existing Products, categories, taxCategory, and product-level attributes omitted from a ProductImport are removed. Omitting attributes removes all product-level Attributes, and a partial list removes every Attribute that is not in the list. Include all existing values you want to keep. ProductVariants and Prices are not changed.

OAuth 2.0 Scopes:

manage_products:{projectKey}

Path parameters:

`region` String	The Region in which the Project is hosted.
`projectKey` String	`key` of the Project.
`importContainerKey` String	`key` of the ImportContainer to send this ImportRequest.

Request Body:ProductImportRequestasapplication/json

Response:

201

ImportResponse

application/json

curl https://import.{region}.commercetools.com/{projectKey}/products/import-containers/{importContainerKey} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}" \
--header 'Content-Type: application/json' \
--data-binary @- << DATA 
{
  "type" : "product",
  "resources" : [ {
    "key" : "product-key",
    "name" : {
      "en" : "t-shirt"
    },
    "productType" : {
      "typeId" : "product-type",
      "key" : "product-type-key"
    },
    "slug" : {
      "en" : "t-shirt-slug"
    },
    "description" : {
      "en" : "t-shirt-description"
    },
    "categories" : [ {
      "typeId" : "category",
      "key" : "category-key"
    } ],
    "taxCategory" : {
      "typeId" : "tax-category",
      "key" : "tax-category-key"
    },
    "state" : {
      "typeId" : "state",
      "key" : "state-key"
    }
  } ]
}
DATA

{
  "operationStatus": [
    {
      "state": "processing",
      "operationId": "252c6ed3-c668-4610-afe9-87b9255e62e0"
    }
  ]
}

for Product Drafts

This endpoint allows you to import Products as well as Product Variants and Embedded Prices in a single import request. While using this endpoint (instead of calling three separate endpoints for Products, Product Variants, and Embedded Prices) reduces the number of API calls, this single request requires a relatively large payload.

When importing a Product Draft to update an existing Product, include all existing values you want to keep. ProductVariants, Embedded Prices, images, Assets, Attributes of the Product and its ProductVariants, categories, and taxCategory omitted from the ProductDraftImport are removed from the Product when it is imported. Omitting the product-level attributes removes all product-level Attributes, and a partial list removes every Attribute that is not in the list. To change only part of a Product, use a narrower endpoint such as Products, Product Variant Patches, or Embedded Prices.

POST

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

Creates an Import Request for Products.

When updating existing Products, ProductVariants, Embedded Prices, images, Assets, Attributes of the Product and its ProductVariants, categories, and taxCategory omitted from a ProductDraftImport are removed. Omitting the product-level attributes field removes all product-level Attributes, and a partial list removes every Attribute that is not in the list. Include all existing values you want to keep.

OAuth 2.0 Scopes:

manage_products:{projectKey}

Path parameters:

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

Request Body:ProductDraftImportRequestasapplication/json

Response:

201

ImportResponse

application/json

curl https://import.{region}.commercetools.com/{projectKey}/product-drafts/import-containers/{importContainerKey} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}" \
--header 'Content-Type: application/json' \
--data-binary @- << DATA 
{
  "type" : "product-draft",
  "resources" : [ {
    "key" : "product-draft-key",
    "name" : {
      "en" : "blue shirt"
    },
    "slug" : {
      "en" : "blue-t-shirt"
    },
    "productType" : {
      "typeId" : "product-type",
      "key" : "sample"
    },
    "masterVariant" : {
      "key" : "master-variant-key",
      "attributes" : [ {
        "type" : "reference",
        "name" : "product-ref-attribute",
        "value" : {
          "key" : "category-key",
          "typeId" : "category"
        }
      }, {
        "type" : "reference",
        "name" : "product-custom-object-ref-attribute",
        "value" : {
          "key" : "custom-object-key",
          "container" : "custom-object-container-key",
          "typeId" : "key-value-document"
        }
      } ]
    }
  } ]
}
DATA

{
  "operationStatus": [
    {
      "state": "processing",
      "operationId": "252c6ed3-c668-4610-afe9-87b9255e62e0"
    }
  ]
}

for Product Types

When importing a Product Type to update an existing Product Type, include every AttributeDefinition you want to keep. AttributeDefinitions omitted from attributes are removed, and the corresponding Attribute values are deleted from all Products with the Product Type. Omitting the entire attributes removes all AttributeDefinitions. This data cannot be recovered.

POST

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

Creates an Import Request for ProductTypes.

When updating existing ProductTypes, AttributeDefinitions omitted from a ProductTypeImport are removed, and the corresponding Attribute values are deleted from all Products with this ProductType. Omitting the attributes field removes all AttributeDefinitions. This data cannot be recovered.

OAuth 2.0 Scopes:

manage_products:{projectKey}

Path parameters:

`region` String	The Region in which the Project is hosted.
`projectKey` String	`key` of the Project.
`importContainerKey` String	`key` of the ImportContainer to send this ImportRequest.

Request Body:ProductTypeImportRequestasapplication/json

Response:

201

ImportResponse

application/json

curl https://import.{region}.commercetools.com/{projectKey}/product-types/import-containers/{importContainerKey} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}" \
--header 'Content-Type: application/json' \
--data-binary @- << DATA 
{
  "type" : "product-type",
  "resources" : [ {
    "key" : "product-type-key",
    "name" : "Product Type name",
    "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"
    } ]
  } ]
}
DATA

{
  "operationStatus": [
    {
      "state": "processing",
      "operationId": "252c6ed3-c668-4610-afe9-87b9255e62e0"
    }
  ]
}

for Product Variants

When importing a Product Variant to update an existing Product Variant, include all existing values you want to keep. The sku, attributes, images, and assets omitted from the ProductVariantImport are removed from the Product Variant. To change only some Attribute values, use Product Variant Patches. The import does not change the Embedded Prices of an existing Product Variant. A new Product Variant created by this import has no Embedded Prices, so import them separately with Embedded Prices. StandalonePrices are not affected.

POST

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

Creates an Import Request for ProductVariants.

When updating existing ProductVariants, sku, attributes, images, and assets omitted from a ProductVariantImport are removed. Include all existing values you want to keep. To update only some Attributes, use the Product Variant Patches endpoint.

ProductVariantImport does not change the Embedded Prices of an existing ProductVariant. A new ProductVariant created by this import has no Embedded Prices. Import them separately with the Embedded Prices endpoint. StandalonePrices are not affected.

OAuth 2.0 Scopes:

manage_products:{projectKey}

Path parameters:

`region` String	The Region in which the Project is hosted.
`projectKey` String	`key` of the Project.
`importContainerKey` String	`key` of the ImportContainer to send this ImportRequest.

Request Body:ProductVariantImportRequestasapplication/json

Response:

201

ImportResponse

application/json

curl https://import.{region}.commercetools.com/{projectKey}/product-variants/import-containers/{importContainerKey} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}" \
--header 'Content-Type: application/json' \
--data-binary @- << DATA 
{
  "type" : "product-variant",
  "resources" : [ {
    "key" : "red-t-shirt",
    "sku" : "red-t-shirt",
    "product" : {
      "key" : "t-shirt",
      "typeId" : "product"
    },
    "isMasterVariant" : true,
    "attributes" : [ {
      "name" : "new",
      "type" : "boolean",
      "value" : true
    }, {
      "name" : "weight",
      "type" : "number",
      "value" : 12.5
    } ],
    "images" : [ {
      "url" : "https://example.com/images/red-t-shirt-front.jpg",
      "label" : "Front view",
      "dimensions" : {
        "w" : 1400,
        "h" : 1400
      }
    } ],
    "assets" : [ {
      "key" : "red-t-shirt-size-guide",
      "name" : {
        "en" : "Size guide"
      },
      "sources" : [ {
        "uri" : "https://example.com/assets/red-t-shirt-size-guide.pdf",
        "contentType" : "application/pdf"
      } ]
    } ]
  } ]
}
DATA

{
  "operationStatus": [
    {
      "state": "processing",
      "operationId": "252c6ed3-c668-4610-afe9-87b9255e62e0"
    }
  ]
}

for Product Variant Patches

The Product Variant Patch endpoint can be used to update existing Product Variants in a Project. Only the Attributes included in the patch are changed. All other Attributes, images, Assets, and Prices of the Product Variant remain unchanged. For importing new Product Variants, use the Product Variants endpoint.

POST

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

Creates an Import Request for updating Product Variants. Only the Attributes included in the patch are changed. All other Attributes, images, Assets, and Prices of the Product Variant remain unchanged. Returns an InvalidField error if the ProductVariantPatchRequest contains patches with and without the product field set.

OAuth 2.0 Scopes:

manage_products:{projectKey}

Path parameters:

`region` String	The Region in which the Project is hosted.
`projectKey` String	`key` of the Project.
`importContainerKey` String	`key` of the ImportContainer to send this ImportRequest.

Request Body:ProductVariantPatchRequestasapplication/json

Response:

201

ImportResponse

application/json

curl https://import.{region}.commercetools.com/{projectKey}/product-variant-patches/import-containers/{importContainerKey} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}" \
--header 'Content-Type: application/json' \
--data-binary @- << DATA 
{
  "type" : "product-variant-patch",
  "patches" : [ {
    "productVariant" : {
      "typeId" : "product-variant",
      "key" : "red-t-shirt"
    },
    "attributes" : {
      "attribute-to-update" : {
        "type" : "boolean",
        "value" : true
      },
      "name-of-attribute-to-delete" : null,
      "name-of-localized-attribute-to-update" : {
        "type" : "ltext",
        "value" : {
          "en" : "Existing field",
          "es" : null,
          "de" : "Updating field"
        }
      },
      "name-of-localized-attribute-set-to-update" : {
        "type" : "ltext-set",
        "value" : [ {
          "en" : "Existing field",
          "es" : null,
          "de" : "Updating field",
          "br" : "New field"
        }, {
          "en" : "Another Existing field",
          "es" : null,
          "de" : "Another Updating field",
          "br" : "Another New field"
        } ]
      }
    },
    "staged" : false
  } ]
}
DATA

{
  "operationStatus": [
    {
      "state": "processing",
      "operationId": "252c6ed3-c668-4610-afe9-87b9255e62e0"
    }
  ]
}

for Product Selections

POST

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

Creates an Import Request for Product Selections.

When updating existing Product Selections, an assignments list in a ProductSelectionImport becomes the complete set of assignments, and Products omitted from the list are removed from the Product Selection.

OAuth 2.0 Scopes:

manage_product_selections:{projectKey}view_product_selections:{projectKey}

Path parameters:

`region` String	The Region in which the Project is hosted.
`projectKey` String	`key` of the Project.
`importContainerKey` String	`key` of the ImportContainer to send this ImportRequest.

Request Body:ProductSelectionImportRequestasapplication/json

Response:

201

ImportResponse

application/json

curl https://import.{region}.commercetools.com/{projectKey}/product-selections/import-containers/{importContainerKey} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}" \
--header 'Content-Type: application/json' \
--data-binary @- << DATA 
{
  "type" : "product-selection",
  "resources" : [ {
    "key" : "selection-001",
    "name" : {
      "en" : "Featured Products",
      "de" : "Empfohlene Produkte"
    },
    "mode" : "Individual",
    "assignments" : [ {
      "product" : {
        "key" : "product-123",
        "typeId" : "product"
      },
      "variantSelection" : {
        "type" : "includeOnly",
        "skus" : [ "SKU-1", "SKU-2" ]
      }
    } ]
  } ]
}
DATA

{
  "operationStatus": [
    {
      "state": "processing",
      "operationId": "252c6ed3-c668-4610-afe9-87b9255e62e0"
    }
  ]
}

for Product Tailoring

POST

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

Creates an Import Request for Product Tailoring.

OAuth 2.0 Scopes:

manage_products:{projectKey}

Path parameters:

`region` String	The Region in which the Project is hosted.
`projectKey` String	`key` of the Project.
`importContainerKey` String	`key` of the ImportContainer to send this ImportRequest.

Request Body:ProductTailoringImportRequestasapplication/json

Response:

201

ImportResponse

application/json

curl https://import.{region}.commercetools.com/{projectKey}/product-tailorings/import-containers/{importContainerKey} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}" \
--header 'Content-Type: application/json' \
--data-binary @- << DATA 
{
  "type" : "product-tailoring",
  "resources" : [ {
    "key" : "product-tailoring-key",
    "store" : {
      "typeId" : "store",
      "key" : "store-key"
    },
    "product" : {
      "typeId" : "product",
      "key" : "product-key"
    },
    "name" : {
      "en" : "Tailored Product Name"
    },
    "description" : {
      "en" : "Tailored product description"
    },
    "slug" : {
      "en" : "tailored-product-slug"
    },
    "publish" : false,
    "variants" : [ {
      "sku" : "tailored-variant-sku",
      "images" : [ {
        "url" : "https://example.com/image.png",
        "dimensions" : {
          "w" : 100,
          "h" : 100
        },
        "label" : "Tailored image"
      } ]
    } ]
  } ]
}
DATA

{
  "operationStatus": [
    {
      "state": "processing",
      "operationId": "252c6ed3-c668-4610-afe9-87b9255e62e0"
    }
  ]
}

for Orders

Use this endpoint to bulk create Orders in a Project. This endpoint only supports the creation of new Orders. For updating fulfillment information on existing Orders, use the Order Patches endpoint. POST

To import a single Order, use the Create Order by Import endpoint instead.

POST

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

Creates an Import Request for creating Orders.

OAuth 2.0 Scopes:

manage_orders:{projectKey}

Path parameters:

`region` String	The Region in which the Project is hosted.
`projectKey` String	`key` of the Project.
`importContainerKey` String	`key` of the ImportContainer to send this ImportRequest.

Request Body:OrderImportRequestasapplication/json

Response:

201

ImportResponse

application/json

curl https://import.{region}.commercetools.com/{projectKey}/orders/import-containers/{importContainerKey} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}" \
--header 'Content-Type: application/json' \
--data-binary @- << DATA 
{
  "type" : "order",
  "resources" : [ {
    "orderNumber" : "order-number",
    "customer" : {
      "typeId" : "customer",
      "key" : "order-customer-key"
    },
    "lineItems" : [ {
      "name" : {
        "en" : "abc"
      },
      "quantity" : 10,
      "price" : {
        "value" : {
          "type" : "centPrecision",
          "centAmount" : 100,
          "currencyCode" : "EUR"
        }
      },
      "supplyChannel" : {
        "typeId" : "channel",
        "key" : "supplier-channel-key"
      },
      "variant" : {
        "productVariant" : {
          "typeId" : "product-variant",
          "key" : "product-key"
        },
        "sku" : "variant-sku"
      }
    } ],
    "customerGroup" : {
      "typeId" : "customer-group",
      "key" : "customer-group-key"
    },
    "totalPrice" : {
      "type" : "centPrecision",
      "currencyCode" : "EUR",
      "centAmount" : 4200
    }
  } ]
}
DATA

{
  "operationStatus": [
    {
      "state": "processing",
      "operationId": "252c6ed3-c668-4610-afe9-87b9255e62e0"
    }
  ]
}

for Order Patches

Use this endpoint to import updates to ReturnInfo, Parcel, and Delivery of an existing Order.

POST

https://import.{region}.commercetools.com/{projectKey}/order-patches/import-containers/{importContainerKey}

Creates an Import Request for updating Orders.

OAuth 2.0 Scopes:

manage_orders:{projectKey}

Path parameters:

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

Request Body:OrderPatchImportRequestasapplication/json

Response:

201

ImportResponse

application/json

curl https://import.{region}.commercetools.com/{projectKey}/order-patches/import-containers/{importContainerKey} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}" \
--header 'Content-Type: application/json' \
--data-binary @- << DATA 
{
  "type" : "order-patch",
  "patches" : [ {
    "orderNumber" : "order-number",
    "fields" : {
      "addReturnInfo" : {
        "items" : [ {
          "quantity" : 1,
          "lineItemId" : "1",
          "comment" : "any comment",
          "shipmentState" : "Advised"
        } ],
        "returnTrackingId" : "returnTrackingId-example",
        "returnDate" : "2021-04-30T09:21:15.003Z"
      },
      "addDeliveries" : [ {
        "items" : [ {
          "id" : "4ce24c27-cce5-447c-890e-0d6b70b690be",
          "quantity" : 5
        } ],
        "parcels" : [ {
          "measurements" : {
            "heightInMillimeter" : 20,
            "lengthInMillimeter" : 40,
            "widthInMillimeter" : 5,
            "weightInGram" : 10
          }
        } ]
      } ],
      "removeDelivery" : {
        "id" : "95a6e7a7-b74e-4397-b0b4-37473d2e3573"
      },
      "removeParcelFromDelivery" : {
        "parcelId" : "98840afa-ac20-4a34-a904-88d3407e2d76"
      },
      "addParcelToDelivery" : {
        "deliveryId" : "95a6e7a7-b74e-4397-b0b4-37473d2e3573",
        "measurements" : {
          "heightInMillimeter" : 20,
          "lengthInMillimeter" : 40,
          "widthInMillimeter" : 5,
          "weightInGram" : 10
        }
      },
      "setParcelMeasurements" : {
        "parcelId" : "98840afa-ac20-4a34-a904-88d3407e2d76",
        "measurements" : {
          "heightInMillimeter" : 20,
          "lengthInMillimeter" : 40,
          "widthInMillimeter" : 5,
          "weightInGram" : 10
        }
      },
      "setParcelTrackingData" : {
        "parcelId" : "98840afa-ac20-4a34-a904-88d3407e2d76",
        "trackingData" : {
          "carrier" : "carrier data"
        }
      },
      "setParcelItems" : [ {
        "parcelId" : "98840afa-ac20-4a34-a904-88d3407e2d76",
        "items" : [ {
          "id" : "4ce24c27-cce5-447c-890e-0d6b70b690be",
          "quantity" : 5
        } ]
      } ]
    }
  } ]
}
DATA

{
  "operationStatus": [
    {
      "state": "processing",
      "operationId": "252c6ed3-c668-4610-afe9-87b9255e62e0"
    }
  ]
}

for Standalone Prices

Use this endpoint to import Standalone Price data to create and update Standalone Prices in a Project.

To create and update Embedded Prices, use the Embedded Prices endpoint instead.

POST

https://import.{region}.commercetools.com/{projectKey}/standalone-prices/import-containers/{importContainerKey}

Creates an Import Request for Standalone Prices.

When updating existing Standalone Prices, optional values omitted from a StandalonePriceImport, such as validFrom, validUntil, tiers, discounted, and custom, are removed. Include all existing values you want to keep.

StandalonePriceImport has no staged field. If the existing StandalonePrice has staged changes, every update through the Import API discards them, even if the imported value is the same. To keep the staged changes, first apply them with the Apply Staged Changes update action.

OAuth 2.0 Scopes:

manage_standalone_prices:{projectKey}view_standalone_prices:{projectKey}

Path parameters:

`region` String	The Region in which the Project is hosted.
`projectKey` String	`key` of the Project.
`importContainerKey` String	`key` of the ImportContainer to send this ImportRequest.

Request Body:StandalonePriceImportRequestasapplication/json

Response:

201

ImportResponse

application/json

curl https://import.{region}.commercetools.com/{projectKey}/standalone-prices/import-containers/{importContainerKey} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}" \
--header 'Content-Type: application/json' \
--data-binary @- << DATA 
{
  "type" : "standalone-price",
  "resources" : [ {
    "key" : "standalone-price-key",
    "sku" : "variantSku",
    "value" : {
      "type" : "centPrecision",
      "currencyCode" : "EUR",
      "centAmount" : 100
    }
  } ]
}
DATA

{
  "operationStatus": [
    {
      "state": "processing",
      "operationId": "252c6ed3-c668-4610-afe9-87b9255e62e0"
    }
  ]
}

for Variants

Use this endpoint to import Variant data to create and update Variants in a Project.

This endpoint is only available for Projects with productCatalogModel set to Modular.

POST

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

Creates an Import Request for Variants.

This endpoint is only available for Projects with productCatalogModel set to Modular.

When updating existing Variants, images, attributes, and assets omitted from a VariantImport are removed. Include all existing values you want to keep.

OAuth 2.0 Scopes:

manage_products:{projectKey}

Path parameters:

`region` String	The Region in which the Project is hosted.
`projectKey` String	`key` of the Project.
`importContainerKey` String	`key` of the ImportContainer to send this ImportRequest.

Request Body:VariantImportRequestasapplication/json

Response:

201

ImportResponse

application/json

curl https://import.{region}.commercetools.com/{projectKey}/variants/import-containers/{importContainerKey} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}" \
--header 'Content-Type: application/json' \
--data-binary @- << DATA 
{
  "type" : "variant",
  "resources" : [ {
    "key" : "variant-1",
    "sku" : "VARIANT-SKU-001",
    "product" : {
      "typeId" : "product",
      "key" : "product-1"
    },
    "publish" : false,
    "images" : [ {
      "url" : "https://example.com/images/variant-1.jpg",
      "label" : "Variant image",
      "dimensions" : {
        "w" : 800,
        "h" : 600
      }
    } ],
    "attributes" : [ {
      "name" : "color",
      "type" : "text",
      "value" : "blue"
    } ],
    "assets" : [ {
      "key" : "variant-asset-1",
      "sources" : [ {
        "uri" : "https://example.com/assets/variant-1.mp4",
        "key" : "variant-video"
      } ],
      "name" : {
        "en" : "Variant Demo"
      },
      "description" : {
        "en" : "Variant demo video"
      },
      "tags" : [ "video", "demo" ]
    } ]
  } ]
}
DATA

{
  "operationStatus": [
    {
      "state": "processing",
      "operationId": "252c6ed3-c668-4610-afe9-87b9255e62e0"
    }
  ]
}

for Types

POST

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

Creates an Import Request for Types.

OAuth 2.0 Scopes:

manage_project:{projectKey}manage_types:{projectKey}

Path parameters:

`region` String	The Region in which the Project is hosted.
`projectKey` String	`key` of the Project.
`importContainerKey` String	`key` of the ImportContainer to send this ImportRequest.

Request Body:TypeImportRequestasapplication/json

Response:

201

ImportResponse

application/json

curl https://import.{region}.commercetools.com/{projectKey}/types/import-containers/{importContainerKey} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}" \
--header 'Content-Type: application/json' \
--data-binary @- << DATA 
{
  "type" : "type",
  "resources" : [ {
    "key" : "type-key",
    "name" : {
      "en" : "Name of type"
    },
    "description" : {
      "en" : "Description of type"
    },
    "resourceTypeIds" : [ "customer" ],
    "fieldDefinitions" : [ {
      "type" : {
        "name" : "String"
      },
      "name" : "exampleStringField",
      "label" : {
        "en" : "Example string field."
      },
      "required" : false,
      "inputHint" : "SingleLine"
    } ]
  } ]
}
DATA

{
  "operationStatus": [
    {
      "state": "processing",
      "operationId": "252c6ed3-c668-4610-afe9-87b9255e62e0"
    }
  ]
}

ImportRequest

BusinessUnitImportRequest

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

`type` ImportResourceType	`business-unit` The resource type that can be imported.
`resources` Array of BusinessUnitImport	The Business Unit import resources of this request. Can contain CompanyBusinessUnitImport or DivisionBusinessUnitImport. MinItems: `1`MaxItems: `20`

{
  "type": "business-unit",
  "resources": [
    {
      "key": "acme-business-unit",
      "name": "ACME Business Unit",
      "unitType": "Company"
    },
    {
      "key": "acme-business-unit-division-a",
      "name": "ACME Business Unit: Division A",
      "unitType": "Division",
      "parentUnit": {
        "key": "acme-business-unit",
        "typeId": "business-unit"
      }
    }
  ]
}

CategoryImportRequest

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

`type` ImportResourceType	`category` The resource type that can be imported.
`resources` Array of CategoryImport	The category import resources of this request. MaxItems: `20`

{
  "type": "category",
  "resources": [
    {
      "key": "category-to-import",
      "name": {
        "en": "Category to import"
      },
      "slug": {
        "en": "category-to-import-slug"
      },
      "description": {
        "en": "Description of category to import"
      },
      "parent": {
        "typeId": "category",
        "key": "key-of-parent-category"
      }
    }
  ]
}

CustomerImportRequest

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

`type` ImportResourceType	`customer` The resource type that can be imported.
`resources` Array of CustomerImport	The customer import resources of this request. MaxItems: `20`

{
  "type": "customer",
  "resources": [
    {
      "key": "customer-to-import",
      "customerNumber": "12345",
      "email": "john@example.com",
      "password": "D0cEx@mpl3!2025",
      "firstName": "John",
      "lastName": "Doe",
      "dateOfBirth": "1980-01-01",
      "isEmailVerified": false,
      "externalId": "external-id-123",
      "customerGroup": {
        "typeId": "customer-group",
        "key": "customer-group-key"
      },
      "addresses": [
        {
          "key": "john-doe-address-key",
          "streetName": "Main Street",
          "streetNumber": "123",
          "postalCode": "12345",
          "city": "Berlin",
          "country": "DE"
        }
      ],
      "authenticationMode": "Password"
    }
  ]
}

DiscountCodeImportRequest

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

`type` ImportResourceType	`discount-code` The resource type that can be imported.
`resources` Array of DiscountCodeImport	The Discount Code import resources of this request. MaxItems: `20`

{
  "type": "discount-code",
  "resources": [
    {
      "key": "discountCodeKey",
      "code": "Save10",
      "name": {
        "en": "Save10"
      },
      "cartDiscounts": [
        {
          "typeId": "cart-discount",
          "key": "cartDiscountKey"
        }
      ],
      "isActive": false,
      "groups": []
    }
  ]
}

EmbeddedPriceImportRequest

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

`type` ImportResourceType	`price` The resource type that can be imported.
`resources` Array of PriceImport	The price import resources of this request. MaxItems: `20`

{
  "type": "price",
  "resources": [
    {
      "key": "price-key",
      "country": "DE",
      "validFrom": "2021-04-11T14:00:00.000Z",
      "validUntil": "2022-04-11T14:00:00.000Z",
      "customerGroup": {
        "typeId": "customer-group",
        "key": "customer-group-key"
      },
      "channel": {
        "typeId": "channel",
        "key": "channel-key"
      },
      "productVariant": {
        "typeId": "product-variant",
        "key": "red-t-shirt"
      },
      "product": {
        "typeId": "product",
        "key": "t-shirt"
      },
      "value": {
        "type": "centPrecision",
        "currencyCode": "EUR",
        "centAmount": 300
      }
    }
  ]
}

InventoryImportRequest

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

`type` ImportResourceType	`inventory` The resource type that can be imported.
`resources` Array of InventoryImport	The inventory import resources of this request. MaxItems: `20`

{
  "type": "inventory",
  "resources": [
    {
      "key": "inventory-import-key",
      "sku": "product-variant-sku",
      "quantityOnStock": 15,
      "restockableInDays": 2,
      "expectedDelivery": "2022-06-30T14:00:00.000Z",
      "supplyChannel": {
        "typeId": "channel",
        "key": "channel-key"
      }
    }
  ]
}

StandalonePriceImportRequest

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

`type` ImportResourceType	`standalone-price` The resource type that can be imported.
`resources` Array of StandalonePriceImport	The Standalone Price import resources of this request. MaxItems: `20`

{
  "type": "standalone-price",
  "resources": [
    {
      "key": "standalone-price-key",
      "sku": "variantSku",
      "value": {
        "type": "centPrecision",
        "currencyCode": "EUR",
        "centAmount": 100
      }
    }
  ]
}

OrderImportRequest

The request body to import Orders. Contains data for Orders to be created in a Project.

`type` ImportResourceType	`order` The resource type that can be imported.
`resources` Array of OrderImport	The order import resources of this request. MaxItems: `20`

{
  "type": "order",
  "resources": [
    {
      "orderNumber": "order-number",
      "customer": {
        "typeId": "customer",
        "key": "order-customer-key"
      },
      "lineItems": [
        {
          "name": {
            "en": "abc"
          },
          "quantity": 10,
          "price": {
            "value": {
              "type": "centPrecision",
              "centAmount": 100,
              "currencyCode": "EUR"
            }
          },
          "supplyChannel": {
            "typeId": "channel",
            "key": "supplier-channel-key"
          },
          "variant": {
            "productVariant": {
              "typeId": "product-variant",
              "key": "product-key"
            },
            "sku": "variant-sku"
          }
        }
      ],
      "customerGroup": {
        "typeId": "customer-group",
        "key": "customer-group-key"
      },
      "totalPrice": {
        "type": "centPrecision",
        "currencyCode": "EUR",
        "centAmount": 4200
      }
    }
  ]
}

OrderPatchImportRequest

The request body to import OrderPatches. The data to be imported are represented by OrderPatchImport.

`type` ImportResourceType	`order-patch` The resource type that can be imported.
`patches` Array of OrderPatchImport	The order patches of this request MaxItems: `20`

{
  "type": "order-patch",
  "patches": [
    {
      "orderNumber": "order-number",
      "fields": {
        "addReturnInfo": {
          "items": [
            {
              "quantity": 1,
              "lineItemId": "1",
              "comment": "any comment",
              "shipmentState": "Advised"
            }
          ],
          "returnTrackingId": "returnTrackingId-example",
          "returnDate": "2021-04-30T09:21:15.003Z"
        },
        "addDeliveries": [
          {
            "items": [
              {
                "id": "4ce24c27-cce5-447c-890e-0d6b70b690be",
                "quantity": 5
              }
            ],
            "parcels": [
              {
                "measurements": {
                  "heightInMillimeter": 20,
                  "lengthInMillimeter": 40,
                  "widthInMillimeter": 5,
                  "weightInGram": 10
                }
              }
            ]
          }
        ],
        "removeDelivery": {
          "id": "95a6e7a7-b74e-4397-b0b4-37473d2e3573"
        },
        "removeParcelFromDelivery": {
          "parcelId": "98840afa-ac20-4a34-a904-88d3407e2d76"
        },
        "addParcelToDelivery": {
          "deliveryId": "95a6e7a7-b74e-4397-b0b4-37473d2e3573",
          "measurements": {
            "heightInMillimeter": 20,
            "lengthInMillimeter": 40,
            "widthInMillimeter": 5,
            "weightInGram": 10
          }
        },
        "setParcelMeasurements": {
          "parcelId": "98840afa-ac20-4a34-a904-88d3407e2d76",
          "measurements": {
            "heightInMillimeter": 20,
            "lengthInMillimeter": 40,
            "widthInMillimeter": 5,
            "weightInGram": 10
          }
        },
        "setParcelTrackingData": {
          "parcelId": "98840afa-ac20-4a34-a904-88d3407e2d76",
          "trackingData": {
            "carrier": "carrier data"
          }
        },
        "setParcelItems": [
          {
            "parcelId": "98840afa-ac20-4a34-a904-88d3407e2d76",
            "items": [
              {
                "id": "4ce24c27-cce5-447c-890e-0d6b70b690be",
                "quantity": 5
              }
            ]
          }
        ]
      }
    }
  ]
}

ProductTypeImportRequest

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

`type` ImportResourceType	`product-type` The resource type that can be imported.
`resources` Array of ProductTypeImport	The product type import resources of this request. MaxItems: `20`

{
  "type": "product-type",
  "resources": [
    {
      "key": "product-type-key",
      "name": "Product Type name",
      "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"
        }
      ]
    }
  ]
}

ProductImportRequest

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

`type` ImportResourceType	`product` The resource type that can be imported.
`resources` Array of ProductImport	The product import resources of this request. MaxItems: `20`

{
  "type": "product",
  "resources": [
    {
      "key": "product-key",
      "name": {
        "en": "t-shirt"
      },
      "productType": {
        "typeId": "product-type",
        "key": "product-type-key"
      },
      "slug": {
        "en": "t-shirt-slug"
      },
      "description": {
        "en": "t-shirt-description"
      },
      "categories": [
        {
          "typeId": "category",
          "key": "category-key"
        }
      ],
      "taxCategory": {
        "typeId": "tax-category",
        "key": "tax-category-key"
      },
      "state": {
        "typeId": "state",
        "key": "state-key"
      }
    }
  ]
}

ProductDraftImportRequest

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

`type` ImportResourceType	`product-draft` The resource type that can be imported.
`resources` Array of ProductDraftImport	The product draft import resources of this request. MaxItems: `20`

{
  "type": "product-draft",
  "resources": [
    {
      "key": "product-draft-key",
      "name": {
        "en": "blue shirt"
      },
      "slug": {
        "en": "blue-t-shirt"
      },
      "productType": {
        "typeId": "product-type",
        "key": "sample"
      },
      "masterVariant": {
        "key": "master-variant-key",
        "attributes": [
          {
            "type": "reference",
            "name": "product-ref-attribute",
            "value": {
              "key": "category-key",
              "typeId": "category"
            }
          },
          {
            "type": "reference",
            "name": "product-custom-object-ref-attribute",
            "value": {
              "key": "custom-object-key",
              "container": "custom-object-container-key",
              "typeId": "key-value-document"
            }
          }
        ]
      }
    }
  ]
}

ProductVariantImportRequest

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

`type` ImportResourceType	`product-variant` The resource type that can be imported.
`resources` Array of ProductVariantImport	The product variant import resources of this request. MaxItems: `20`

{
  "type": "product-variant",
  "resources": [
    {
      "key": "red-t-shirt",
      "sku": "red-t-shirt",
      "product": {
        "key": "t-shirt",
        "typeId": "product"
      },
      "isMasterVariant": true,
      "attributes": [
        {
          "name": "new",
          "type": "boolean",
          "value": true
        },
        {
          "name": "weight",
          "type": "number",
          "value": 12.5
        }
      ],
      "images": [
        {
          "url": "https://example.com/images/red-t-shirt-front.jpg",
          "label": "Front view",
          "dimensions": {
            "w": 1400,
            "h": 1400
          }
        }
      ],
      "assets": [
        {
          "key": "red-t-shirt-size-guide",
          "name": {
            "en": "Size guide"
          },
          "sources": [
            {
              "uri": "https://example.com/assets/red-t-shirt-size-guide.pdf",
              "contentType": "application/pdf"
            }
          ]
        }
      ]
    }
  ]
}

ProductVariantPatchRequest

The request body to import ProductVariantPatches. The data to be imported are represented by ProductVariantPatch.

`type` ImportResourceType	`product-variant-patch` The resource type that can be imported.
`patches` Array of ProductVariantPatch	The product variant patches of this request. MaxItems: `20`

{
  "type": "product-variant-patch",
  "patches": [
    {
      "productVariant": {
        "typeId": "product-variant",
        "key": "red-t-shirt"
      },
      "attributes": {
        "attribute-to-update": {
          "type": "boolean",
          "value": true
        },
        "name-of-attribute-to-delete": null,
        "name-of-localized-attribute-to-update": {
          "type": "ltext",
          "value": {
            "en": "Existing field",
            "es": null,
            "de": "Updating field"
          }
        },
        "name-of-localized-attribute-set-to-update": {
          "type": "ltext-set",
          "value": [
            {
              "en": "Existing field",
              "es": null,
              "de": "Updating field",
              "br": "New field"
            },
            {
              "en": "Another Existing field",
              "es": null,
              "de": "Another Updating field",
              "br": "Another New field"
            }
          ]
        }
      },
      "staged": false
    }
  ]
}

VariantImportRequest

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

This import resource is only available for Projects with productCatalogModel set to Modular.

`type` ImportResourceType	`variant` The resource type that can be imported.
`resources` Array of VariantImport	The Variant import resources of this request. MinItems: `1`MaxItems: `20`

{
  "type": "variant",
  "resources": [
    {
      "key": "variant-1",
      "sku": "VARIANT-SKU-001",
      "product": {
        "typeId": "product",
        "key": "product-1"
      },
      "publish": false,
      "images": [
        {
          "url": "https://example.com/images/variant-1.jpg",
          "label": "Variant image",
          "dimensions": {
            "w": 800,
            "h": 600
          }
        }
      ],
      "attributes": [
        {
          "name": "color",
          "type": "text",
          "value": "blue"
        }
      ],
      "assets": [
        {
          "key": "variant-asset-1",
          "sources": [
            {
              "uri": "https://example.com/assets/variant-1.mp4",
              "key": "variant-video"
            }
          ],
          "name": {
            "en": "Variant Demo"
          },
          "description": {
            "en": "Variant demo video"
          },
          "tags": [
            "video",
            "demo"
          ]
        }
      ]
    }
  ]
}

ProductSelectionImportRequest

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

`type` ImportResourceType	`product-selection` The resource type that can be imported.
`resources` Array of ProductSelectionImport	The Product Selection import resources of this request. MaxItems: `20`

{
  "type": "product-selection",
  "resources": [
    {
      "key": "selection-001",
      "name": {
        "en": "Featured Products",
        "de": "Empfohlene Produkte"
      },
      "mode": "Individual",
      "assignments": [
        {
          "product": {
            "key": "product-123",
            "typeId": "product"
          },
          "variantSelection": {
            "type": "includeOnly",
            "skus": [
              "SKU-1",
              "SKU-2"
            ]
          }
        }
      ]
    }
  ]
}

ProductTailoringImportRequest

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

`type` ImportResourceType	`product-tailoring` The resource type that can be imported.
`resources` Array of ProductTailoringImport	The Product Tailoring import resources of this request. MaxItems: `20`

{
  "type": "product-tailoring",
  "resources": [
    {
      "key": "product-tailoring-key",
      "store": {
        "typeId": "store",
        "key": "store-key"
      },
      "product": {
        "typeId": "product",
        "key": "product-key"
      },
      "name": {
        "en": "Tailored Product Name"
      },
      "description": {
        "en": "Tailored product description"
      },
      "slug": {
        "en": "tailored-product-slug"
      },
      "publish": false,
      "variants": [
        {
          "sku": "tailored-variant-sku",
          "images": [
            {
              "url": "https://example.com/image.png",
              "dimensions": {
                "w": 100,
                "h": 100
              },
              "label": "Tailored image"
            }
          ]
        }
      ]
    }
  ]
}

TypeImportRequest

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

`type` ImportResourceType	`type` The resource type that can be imported.
`resources` Array of TypeImport	The type import resources of this request. MaxItems: `20`

{
  "type": "type",
  "resources": [
    {
      "key": "type-key",
      "name": {
        "en": "Name of type"
      },
      "description": {
        "en": "Description of type"
      },
      "resourceTypeIds": [
        "customer"
      ],
      "fieldDefinitions": [
        {
          "type": {
            "name": "String"
          },
          "name": "exampleStringField",
          "label": {
            "en": "Example string field."
          },
          "required": false,
          "inputHint": "SingleLine"
        }
      ]
    }
  ]
}

ImportResponse

The response of each Import Request.

operationStatus

Array of ImportOperationStatus

The identifiers and status of the ImportOperations created by the ImportRequest.

MaxItems: 20

{
  "operationStatus": [
    {
      "state": "processing",
      "operationId": "252c6ed3-c668-4610-afe9-87b9255e62e0"
    }
  ]
}

Import Requests

Create Import Request.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

for Business Units.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

for Categories.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

for Customers.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

for Discount Codes.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

for Embedded Prices.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

for Inventory.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

for Products.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

for Product Drafts.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

for Product Types.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

for Product Variants.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

for Product Variant Patches.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

for Product Selections.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

for Product Tailoring.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

for Orders.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

for Order Patches.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

for Standalone Prices.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

for Variants.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

for Types.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

Representations.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

ImportRequest.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

BusinessUnitImportRequest.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

CategoryImportRequest.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

CustomerImportRequest.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

DiscountCodeImportRequest.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

EmbeddedPriceImportRequest.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

InventoryImportRequest.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

StandalonePriceImportRequest.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

OrderImportRequest.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

OrderPatchImportRequest.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

ProductTypeImportRequest.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

ProductImportRequest.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

ProductDraftImportRequest.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

ProductVariantImportRequest.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

ProductVariantPatchRequest.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

VariantImportRequest.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

ProductSelectionImportRequest.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

ProductTailoringImportRequest.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

TypeImportRequest.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

ImportResponse.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

Create Import Request

for Business Units

for Categories

for Customers

for Discount Codes

for Embedded Prices

for Inventory

for Products

for Product Drafts

for Product Types

for Product Variants

for Product Variant Patches

for Product Selections

for Product Tailoring

for Orders

for Order Patches

for Standalone Prices

for Variants

for Types

Representations

ImportRequest

BusinessUnitImportRequest

CategoryImportRequest

CustomerImportRequest

DiscountCodeImportRequest

EmbeddedPriceImportRequest

InventoryImportRequest

StandalonePriceImportRequest

OrderImportRequest

OrderPatchImportRequest

ProductTypeImportRequest

ProductImportRequest

ProductDraftImportRequest

ProductVariantImportRequest

ProductVariantPatchRequest

VariantImportRequest

ProductSelectionImportRequest

ProductTailoringImportRequest

TypeImportRequest

ImportResponse