Skip to content

Commit 505b3af

Browse files
committed
Updated API from documentation release
1 parent b747e1f commit 505b3af

File tree

2 files changed

+8
-2
lines changed

2 files changed

+8
-2
lines changed

api-specs/import/api.raml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -529,7 +529,9 @@ traits:
529529
description: The ImportContainer used to create the new resource
530530
type: string
531531
post:
532-
description: Creates a new import request for product variant patches
532+
description: |
533+
Creates a new import request for Product Variant Patches.
534+
Returns an [InvalidField](/error#invalidfielderror) error if the [ProductVariantPatchRequest](ctp:import:type:ProductVariantPatchRequest) contains patches with and without the `product` field set.
533535
is:
534536
- secured_by_manage_products
535537
body:

api-specs/import/types/product-variant-import.raml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -278,7 +278,11 @@ types:
278278
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).
279279
product?:
280280
description: |
281-
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).
281+
Reference to the [Product](/../api/projects/products#product) that contains the ProductVariant.
282+
283+
We recommend to set this value to minimize concurrency errors.
284+
If set, this field is required for every ProductVariantPatch in the [ProductVariantPatchRequest](ctp:import:type:ProductVariantPatchRequest).
285+
282286
type: common.ProductKeyReference
283287
Attributes:
284288
properties:

0 commit comments

Comments
 (0)