Updated API from documentation release

commercetools · Nov 26, 2024 · 505b3af · 505b3af
1 parent b747e1f
commit 505b3af
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 2 deletions.
diff --git a/api-specs/import/api.raml b/api-specs/import/api.raml
@@ -529,7 +529,9 @@ traits:
             description: The ImportContainer used to create the new resource
             type: string
         post:
-          description: Creates a new import request for product variant patches
+          description: |
+            Creates a new import request for Product Variant Patches.
+            Returns an [InvalidField](/error#invalidfielderror) error if the [ProductVariantPatchRequest](ctp:import:type:ProductVariantPatchRequest) contains patches with and without the `product` field set.
           is:
             - secured_by_manage_products
           body:

diff --git a/api-specs/import/types/product-variant-import.raml b/api-specs/import/types/product-variant-import.raml
@@ -278,7 +278,11 @@ types:
           If `false`, the attribute changes are applied to both [current and staged projected representations](/../api/projects/productProjections#current--staged) of the [Product](/../api/projects/products#product).
       product?:
         description: |
-          Reference to the [Product](/../api/projects/products#product) which contains the ProductVariant. Setting a value will batch process the import operations to minimize concurrency errors. If set, this field is required for every ProductVariantPatch in the [ProductVariantPatchRequest](ctp:import:type:ProductVariantPatchRequest).
+          Reference to the [Product](/../api/projects/products#product) that contains the ProductVariant.
+
+          We recommend to set this value to minimize concurrency errors.
+          If set, this field is required for every ProductVariantPatch in the [ProductVariantPatchRequest](ctp:import:type:ProductVariantPatchRequest).
+
         type: common.ProductKeyReference
   Attributes:
     properties: