Importing Product Variant Patches

The Product Variant Patch endpoint can be used to update existing ProductVariants in a Project. The ProductVariant update data is represented by ProductVariantPatch and loaded in a ProductVariantPatchRequest, which is posted to import ProductVariantPatches.

To monitor an import status, use Get ImportSummary, Get ImportOperation, and Query ImportOperations.

Representations

ProductVariantPatchRequest

ProductVariantPatch

ProductVariantPatchRequest

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

`type` String	`"product-variant-patch"` The product variant patch import resource type.
`patches` Array of ProductVariantPatch	The product variant patches of this request. MaxItems: `20`

Example: json

{
  "type" : "product-variant-patch",
  "patches" : [ {
    "productVariant" : {
      "typeId" : "product-variant",
      "key" : "red-t-shirt"
    },
    "attributes" : {
      "attribute-to-update" : {
        "type" : "boolean",
        "value" : true
      },
      "attribute-to-delete" : null
    },
    "staged" : false
  } ]
}

ProductVariantPatch

Representation for an update of a ProductVariant. Use this type to import updates for existing ProductVariants in a Project.

`productVariant` ProductVariantKeyReference	The ProductVariant to which this patch is applied. The Reference to the ProductVariant with which the ProductVariantPatch is associated. If referenced ProductVariant does not exist, the `state` of the ImportOperation will be set to `unresolved` until the necessary ProductVariant is created.
`attributes` Attributes	Maps to `ProductVariant.attributes`. The referenced attribute must be defined in an already existing ProductType in the Project, or the `state` of the ImportOperation will be `unresolved`.
`staged` Boolean	If `false`, the attribute changes are applied to both current and staged projected representations of the Product. Default: `true`

Import ProductVariantPatches

POST

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

Creates a new import request for product variant patches

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:ProductVariantPatchRequest

Response:

201ImportResponse