Updated API from documentation release

ct-sdks[bot] · ct-sdks[bot] · commit ed2d65abb425 · 2025-06-26T09:25:33.000Z
diff --git a/api-specs/api/examples/Product/ProductSetProductAttributeAction.json b/api-specs/api/examples/Product/ProductSetProductAttributeAction.json
@@ -0,0 +1,5 @@
+{
+  "action": "setProductAttribute",
+  "name": "ExampleStringTypeAttribute",
+  "value": "TextString"
+}
diff --git a/api-specs/api/examples/ProductTailoring/ProductTailoringSetProductAttributeAction.json b/api-specs/api/examples/ProductTailoring/ProductTailoringSetProductAttributeAction.json
@@ -0,0 +1,5 @@
+{
+  "action": "setProductAttribute",
+  "name": "ExampleStringTypeAttribute",
+  "value": "TextString"
+}
diff --git a/api-specs/api/examples/product-projection.example.json b/api-specs/api/examples/product-projection.example.json
@@ -32,5 +32,6 @@
       "hasStagedChanges": false,
       "published": true,
       "createdAt": "1970-01-01T00:00:00.001Z",
-      "lastModifiedAt": "2014-01-07T15:25:50.034Z"
-    }
+      "lastModifiedAt": "2014-01-07T15:25:50.034Z",
+      "attributes": []
+    }
diff --git a/api-specs/api/examples/product-projections-search.example.json b/api-specs/api/examples/product-projections-search.example.json
@@ -38,7 +38,8 @@
       "hasStagedChanges": false,
       "published": true,
       "createdAt": "1970-01-01T00:00:00.001Z",
-      "lastModifiedAt": "2014-01-07T15:25:50.034Z"
+      "lastModifiedAt": "2014-01-07T15:25:50.034Z",
+      "attributes": []
     },
     {
       "id": "e779ec1a-0a98-4135-8344-d51bdafd4fe6",
@@ -75,7 +76,8 @@
       "hasStagedChanges": true,
       "published": true,
       "createdAt": "2015-05-28T07:15:48.738Z",
-      "lastModifiedAt": "2015-05-28T07:19:38.624Z"
+      "lastModifiedAt": "2015-05-28T07:19:38.624Z",
+      "attributes": []
     }
   ],
   "facets": {
diff --git a/api-specs/api/examples/product-projections.example.json b/api-specs/api/examples/product-projections.example.json
@@ -38,7 +38,8 @@
       "hasStagedChanges": false,
       "published": true,
       "createdAt": "1970-01-01T00:00:00.001Z",
-      "lastModifiedAt": "2014-01-07T15:25:50.034Z"
+      "lastModifiedAt": "2014-01-07T15:25:50.034Z",
+      "attributes": []
     },
     {
       "id": "e779ec1a-0a98-4135-8344-d51bdafd4fe6",
@@ -75,7 +76,8 @@
       "hasStagedChanges": true,
       "published": true,
       "createdAt": "2015-05-28T07:15:48.738Z",
-      "lastModifiedAt": "2015-05-28T07:19:38.624Z"
+      "lastModifiedAt": "2015-05-28T07:19:38.624Z",
+      "attributes": []
     }
   ]
 }
diff --git a/api-specs/api/examples/product-type.example.json b/api-specs/api/examples/product-type.example.json
@@ -14,7 +14,8 @@
       "en": "The right size is important."
     },
     "isRequired": false,
-    "attributeConstraint": "CombinationUnique"
+    "attributeConstraint": "CombinationUnique",
+    "level": "Variant"
   }],
   "createdAt": "1970-01-01T00:00:00.001Z",
   "lastModifiedAt": "1970-01-01T00:00:00.001Z"
diff --git a/api-specs/api/examples/product-types.example.json b/api-specs/api/examples/product-types.example.json
@@ -20,7 +20,8 @@
           "en": "The right size is important."
         },
         "isRequired": false,
-        "attributeConstraint": "CombinationUnique"
+        "attributeConstraint": "CombinationUnique",
+        "level": "Variant"
       }],
       "createdAt": "1970-01-01T00:00:00.001Z",
       "lastModifiedAt": "1970-01-01T00:00:00.001Z"
@@ -41,7 +42,8 @@
           "en": "The right color is important."
         },
         "isRequired": false,
-        "attributeConstraint": "CombinationUnique"
+        "attributeConstraint": "CombinationUnique",
+        "level": "Variant"
       }],
       "createdAt": "1970-01-01T00:00:00.001Z",
       "lastModifiedAt": "1970-01-01T00:00:00.001Z"
diff --git a/api-specs/api/examples/product-with-image-processing-warning.example.json b/api-specs/api/examples/product-with-image-processing-warning.example.json
@@ -44,7 +44,8 @@
                 "en": "mb-premium-tech-t1369226795424"
             },
             "variants": [],
-            "searchKeywords": {}
+            "searchKeywords": {},
+            "attributes": []
         },
         "hasStagedChanges": false,
         "published": true,
@@ -90,7 +91,8 @@
                 "en": "mb-premium-tech-t1369226795424"
             },
             "variants": [],
-            "searchKeywords": {}
+            "searchKeywords": {},
+            "attributes": []
         }
     },
     "productType": {
diff --git a/api-specs/api/examples/product.example.json b/api-specs/api/examples/product.example.json
@@ -44,7 +44,8 @@
                 "en": "mb-premium-tech-t1369226795424"
             },
             "variants": [],
-            "searchKeywords": {}
+            "searchKeywords": {},
+            "attributes": []
         },
         "hasStagedChanges": false,
         "published": true,
@@ -90,7 +91,8 @@
                 "en": "mb-premium-tech-t1369226795424"
             },
             "variants": [],
-            "searchKeywords": {}
+            "searchKeywords": {},
+            "attributes": []
         }
     },
     "productType": {
diff --git a/api-specs/api/examples/products.example.json b/api-specs/api/examples/products.example.json
@@ -49,7 +49,8 @@
             "en": "mb-premium-tech-t1369226795424"
         },
         "variants": [],
-        "searchKeywords": {}
+        "searchKeywords": {},
+        "attributes": []
       },
       "hasStagedChanges": false,
       "published": true,
@@ -95,7 +96,8 @@
             "en": "mb-premium-tech-t1369226795424"
         },
         "variants": [],
-        "searchKeywords": {}
+        "searchKeywords": {},
+        "attributes": []
       }
     },
     "productType": {
diff --git a/api-specs/api/resources/product-types.raml b/api-specs/api/resources/product-types.raml
@@ -24,7 +24,7 @@ head:
   queryParameters:
     where?:
       type: QueryPredicate
-      description: Query Predicates on Product Attributes are limited to `text`, `enum`, `boolean`, `number`, `date`, `time`, and `datetime` attribute types.
+      description: Query Predicates on Attributes are limited to `text`, `enum`, `boolean`, `number`, `date`, `time`, and `datetime` attribute types.
 post:
   securedBy: [oauth_2_0: { scopes: ['manage_products:{projectKey}'] }]
   body:
diff --git a/api-specs/api/resources/products.raml b/api-specs/api/resources/products.raml
@@ -30,7 +30,7 @@ get:
     where:
       type: QueryPredicate[]
       description: |-
-        Query Predicates on Product Attributes are limited to [Text](ctp:api:type:AttributeTextType),
+        Query Predicates on Attributes are limited to [Text](ctp:api:type:AttributeTextType),
         [Enum](ctp:api:type:AttributeEnumType), [Boolean](ctp:api:type:AttributeBooleanType),
         [Number](ctp:api:type:AttributeNumberType), [Date](ctp:api:type:AttributeDateType),
         [Time](ctp:api:type:AttributeTimeType), and [DateTime](ctp:api:type:AttributeDateTimeType) attribute types.
@@ -46,7 +46,7 @@ head:
     where?:
       type: QueryPredicate[]
       description: |-
-        Query Predicates on Product Attributes are limited to [Text](ctp:api:type:AttributeTextType),
+        Query Predicates on Attributes are limited to [Text](ctp:api:type:AttributeTextType),
         [Enum](ctp:api:type:AttributeEnumType), [Boolean](ctp:api:type:AttributeBooleanType),
         [Number](ctp:api:type:AttributeNumberType), [Date](ctp:api:type:AttributeDateType),
         [Time](ctp:api:type:AttributeTimeType), and [DateTime](ctp:api:type:AttributeDateTimeType) attribute types.
diff --git a/api-specs/api/types/cart/LineItemDraft.raml b/api-specs/api/types/cart/LineItemDraft.raml
@@ -4,6 +4,7 @@ displayName: LineItemDraft
 type: object
 description: |
   For Product Variant identification, either the `productId` and `variantId`, or `sku` must be provided.
+  Product Attributes are merged with Variant Attributes to ensure the full Attribute context of the Product Variant.
 properties:
   key?:
     type: string
diff --git a/api-specs/api/types/cart/updates/CartRecalculateAction.raml b/api-specs/api/types/cart/updates/CartRecalculateAction.raml
@@ -17,5 +17,5 @@ properties:
     type: boolean
     default: false
     description: |
-      - Leave empty or set to `false` to only update the Prices and TaxRates of the Line Items.
-      - Set to `true` to update the Line Items' product data (like `name`, `variant` and `productType`) also.
+      - Leave empty or set as `false` to update only the Prices and TaxRates of the Line Items.
+      - Set as `true` to update the Product data (such as `name`, `variant`, `productType`, and Product Attributes) of the Line Items.
diff --git a/api-specs/api/types/message/ProductTailoringCreatedMessage.raml b/api-specs/api/types/message/ProductTailoringCreatedMessage.raml
@@ -51,6 +51,12 @@ properties:
     type: ProductVariantTailoring[]
     description: |
       The variants of the [Product Tailoring](ctp:api:type:ProductTailoring) at the time of creation.
+  attributes?:
+    type: ProductTailoringAttribute[]
+    (beta): true
+    description: |
+      Attributes of the tailored Product.
+      If available, these Attributes are selectively merged into the `attributes` of the corresponding [Product](ctp:api:type:Product). If the Product contains an Attribute with the same `name`, then its `value` is overwritten. Otherwise, the Attribute and its `value` are added to the Product.
   published:
     type: boolean
     description: |
diff --git a/api-specs/api/types/message/payload/ProductTailoringCreatedMessagePayload.raml b/api-specs/api/types/message/payload/ProductTailoringCreatedMessagePayload.raml
@@ -51,6 +51,12 @@ properties:
     type: ProductVariantTailoring[]
     description: |
       The variants of the [Product Tailoring](ctp:api:type:ProductTailoring) at the time of creation.
+  attributes?:
+    type: ProductTailoringAttribute[]
+    (beta): true
+    description: |
+      Attributes of the tailored Product.
+      If available, these Attributes are selectively merged into the `attributes` of the corresponding [Product](ctp:api:type:Product). If the Product contains an Attribute with the same `name`, then its `value` is overwritten. Otherwise, the Attribute and its `value` are added to the Product.
   published:
     type: boolean
     description: |
diff --git a/api-specs/api/types/product-tailoring/ProductTailoringData.raml b/api-specs/api/types/product-tailoring/ProductTailoringData.raml
@@ -34,3 +34,9 @@ properties:
     type: ProductVariantTailoring[]
     description: |
       Tailored Variants of the Product.
+  attributes?:
+    type: ProductTailoringAttribute[]
+    (beta): true
+    description: |
+      Attributes of the tailored Product.
+      If available, these Attributes are selectively merged into the `attributes` of the corresponding [Product](ctp:api:type:Product). If the Product contains an Attribute with the same `name`, then its `value` is overwritten. Otherwise, the Attribute and its `value` are added to the Product.
diff --git a/api-specs/api/types/product-tailoring/ProductTailoringDraft.raml b/api-specs/api/types/product-tailoring/ProductTailoringDraft.raml
@@ -52,3 +52,9 @@ properties:
     type: ProductVariantTailoringDraft[]
     description: |
       Tailored Variants of the Product.
+  attributes?:
+    type: ProductTailoringAttribute[]
+    (beta): true
+    description: |
+      Attributes of the tailored Product.
+      If provided, these Attributes are selectively merged into the `attributes` of the corresponding [Product](ctp:api:type:Product). If the Product contains an Attribute with the same `name`, then its `value` is overwritten. Otherwise, the Attribute and its `value` are added to the Product.
diff --git a/api-specs/api/types/product-tailoring/ProductTailoringInStoreDraft.raml b/api-specs/api/types/product-tailoring/ProductTailoringInStoreDraft.raml
@@ -47,3 +47,9 @@ properties:
     type: ProductVariantTailoringDraft[]
     description: |
       Tailored Variants of the Product.
+  attributes?:
+    type: ProductTailoringAttribute[]
+    (beta): true
+    description: |
+      Attributes of the tailored Product.
+      If provided, these Attributes are selectively merged into the `attributes` of the corresponding [Product](ctp:api:type:Product). If the Product contains an Attribute with the same `name`, then its `value` is overwritten. Otherwise, the Attribute and its `value` are added to the Product.
diff --git a/api-specs/api/types/product-tailoring/updates/ProductTailoringSetProductAttributeAction.raml b/api-specs/api/types/product-tailoring/updates/ProductTailoringSetProductAttributeAction.raml
@@ -0,0 +1,32 @@
+#%RAML 1.0 DataType
+(package): ProductTailoring
+(beta): true
+type: ProductTailoringUpdateAction
+displayName: ProductTailoringSetProductAttributeAction
+discriminatorValue: setProductAttribute
+example: !include ../../../examples/ProductTailoring/ProductTailoringSetProductAttributeAction.json
+properties:
+  name:
+    type: string
+    description: |
+      Name of the Attribute to set.
+  value?:
+    type: any
+    description: |
+      Value to set for the Attribute. If empty, then any existing value will be removed.
+
+      [AttributeType](ctp:api:type:AttributeType) determines the format of the Attribute `value` to be provided:
+
+      - For [Enum Type](ctp:api:type:AttributeEnumType) and [Localized Enum Type](ctp:api:type:AttributeLocalizedEnumType),
+        use either the `key` of the [Plain Enum Value](ctp:api:type:AttributePlainEnumValue) or [Localized Enum Value](ctp:api:type:AttributeLocalizedEnumValue) object or the complete object as `value`.
+      - For [Localizable Text Type](ctp:api:type:AttributeLocalizableTextType), use the [LocalizedString](ctp:api:type:LocalizedString) object as `value`.
+      - For [Money Type](ctp:api:type:AttributeMoneyType) Attributes, use the [Money](ctp:api:type:Money) object as `value`.
+      - For [Set Type](ctp:api:type:AttributeSetType) Attributes, use the entire `set` object  as `value`.
+      - For [Reference Type](ctp:api:type:AttributeReferenceType) Attributes, use the [Reference](ctp:api:type:Reference) object as `value`.
+
+      Tailoring of [Nested Type](ctp:api:type:AttributeNestedType) Attributes is **not supported**.
+  staged?:
+    type: boolean
+    description: |
+      If `true`, then only the staged Attribute is set. If `false`, then both the current and staged Attributes are set.
+    default: true
diff --git a/api-specs/api/types/product-type/AttributeDefinition.raml b/api-specs/api/types/product-type/AttributeDefinition.raml
@@ -3,7 +3,7 @@
 displayName: AttributeDefinition
 type: object
 description: |
-  Describes a Product Attribute and allows you to define meta-information associated with the Attribute (like whether it should be searchable, or its constraints).
+  Describes an Attribute and allows you to define meta-information associated with the Attribute (like whether it should be searchable, or its constraints).
 properties:
   type:
     type: AttributeType
@@ -21,6 +21,12 @@ properties:
   isRequired:
     type: boolean
     description: If `true`, the Attribute must have a value on a [ProductVariant](ctp:api:type:ProductVariant).
+  level:
+    type: AttributeLevelEnum
+    (beta): true
+    description: |
+      Specifies whether the Attribute is defined at the Product or Variant level.
+    default: Variant
   attributeConstraint:
     type: AttributeConstraintEnum
     description: |
diff --git a/api-specs/api/types/product-type/AttributeDefinitionDraft.raml b/api-specs/api/types/product-type/AttributeDefinitionDraft.raml
@@ -28,10 +28,17 @@ properties:
     type: boolean
     description: |
       Set to `true` if the Attribute is required to have a value on a [ProductVariant](ctp:api:type:ProductVariant).
+  level?:
+    type: AttributeLevelEnum
+    (beta): true
+    description: |
+      Specifies whether the Attribute is defined at the Product or Variant level.
+    default: Variant
   attributeConstraint?:
     type: AttributeConstraintEnum
     description: |
       Specifies how an Attribute or a combination of Attributes should be validated across all variants of a Product.
+      If the Attribute is defined at Product level, then `attributeConstraint` must be `None`. Otherwise, an [InvalidOperation](ctp:api:type:InvalidOperationError) error is returned.
     default: None
   inputTip?:
     type: LocalizedString
diff --git a/api-specs/api/types/product-type/AttributeLevelEnum.raml b/api-specs/api/types/product-type/AttributeLevelEnum.raml
@@ -0,0 +1,12 @@
+#%RAML 1.0 DataType
+(package): ProductType
+displayName: AttributeLevelEnum
+type: string
+(beta): true
+enum:
+  - Product
+  - Variant
+(enumDescriptions):
+  Product: Attribute is defined at Product level.
+  Variant: Attributes are defined at the Product Variant level.
+  default: Variant
diff --git a/api-specs/api/types/product-type/updates/ProductTypeChangeIsSearchableAction.raml b/api-specs/api/types/product-type/updates/ProductTypeChangeIsSearchableAction.raml
@@ -5,7 +5,7 @@ displayName: ProductTypeChangeIsSearchableAction
 discriminatorValue: changeIsSearchable
 example: !include ../../../examples/ProductType/ProductTypeChangeIsSearchableAction.json
 description: |
-  Following this update the Products are reindexed asynchronously to reflect this change on the search endpoint. When enabling search on an existing Attribute type definition, the constraint regarding the maximum size of a searchable Attribute will not be enforced. Instead, Product AttributeDefinitions exceeding this limit will be treated as not searchable and will not be available for full-text search.
+  Following this update the Products are reindexed asynchronously to reflect this change on the search endpoint. When enabling search on an existing Attribute type definition, the constraint regarding the maximum size of a searchable Attribute will not be enforced. Instead, AttributeDefinitions exceeding this limit will be treated as not searchable and will not be available for full-text search.
 properties:
   attributeName:
     type: string
diff --git a/api-specs/api/types/product/ProductData.raml b/api-specs/api/types/product/ProductData.raml
@@ -53,3 +53,8 @@ properties:
     type: SearchKeywords
     description: |
       Used by [Product Suggestions](/projects/products-suggestions), but is also considered for a [full text search](/projects/product-projection-search#full-text-search).
+  attributes:
+    type: Attribute[]
+    (beta): true
+    description: |
+      Attributes according to the respective [AttributeDefinition](ctp:api:type:AttributeDefinition).
diff --git a/api-specs/api/types/product/ProductDraft.raml b/api-specs/api/types/product/ProductDraft.raml
@@ -81,3 +81,8 @@ properties:
     description: |
       Specifies the type of prices used when looking up a price for the Product.
     default: Embedded
+  attributes?:
+    type: Attribute[]
+    (beta): true
+    description: |
+      Attributes according to the respective [AttributeDefinition](ctp:api:type:AttributeDefinitionDraft).
diff --git a/api-specs/api/types/product/ProductProjection.raml b/api-specs/api/types/product/ProductProjection.raml
@@ -100,3 +100,8 @@ properties:
     type: ProductPriceModeEnum
     description: |
       Indicates whether the Prices of the Product Projection are [embedded](ctp:api:type:Price) or [standalone](ctp:api:type:StandalonePrice). [Projecting Prices](#prices) only works with `Embedded`, there is currently no support for `Standalone`.
+  attributes:
+    type: Attribute[]
+    (beta): true
+    description: |
+      Attributes according to the respective [AttributeDefinition](ctp:api:type:AttributeDefinitionDraft).
diff --git a/api-specs/api/types/product/updates/ProductSetAttributeAction.raml b/api-specs/api/types/product/updates/ProductSetAttributeAction.raml
@@ -19,17 +19,15 @@ properties:
   name:
     type: string
     description: |
-      The name of the Attribute to set.
+      Name of the Attribute to set.
   value?:
     type: any
     description: |
       Value to set for the Attribute. If empty, any existing value will be removed.
 
       The [AttributeType](ctp:api:type:AttributeType) determines the format of the Attribute `value` to be provided:
 
-      - For [Enum Type](ctp:api:type:AttributeEnumType) and [Localized Enum Type](ctp:api:type:AttributeLocalizedEnumType),
-        use the `key` of the [Plain Enum Value](ctp:api:type:AttributePlainEnumValue) or [Localized Enum Value](ctp:api:type:AttributeLocalizedEnumValue) objects,
-        or the complete objects as `value`.
+      - For [Enum Type](ctp:api:type:AttributeEnumType) and [Localized Enum Type](ctp:api:type:AttributeLocalizedEnumType), use the `key` of the [Plain Enum Value](ctp:api:type:AttributePlainEnumValue) or [Localized Enum Value](ctp:api:type:AttributeLocalizedEnumValue) object or the complete object as `value`.
       - For [Localizable Text Type](ctp:api:type:AttributeLocalizableTextType), use the [LocalizedString](ctp:api:type:LocalizedString) object as `value`.
       - For [Money Type](ctp:api:type:AttributeMoneyType) Attributes, use the [Money](ctp:api:type:Money) object as `value`.
       - For [Set Type](ctp:api:type:AttributeSetType) Attributes, use the entire `set` object  as `value`.
@@ -39,5 +37,5 @@ properties:
   staged?:
     type: boolean
     description: |
-      If `true`, only the staged Attribute is set. If `false`, both current and staged Attribute is set.
+      If `true`, only the staged Attribute is set. If `false`, both the current and staged Attributes are set.
     default: true
diff --git a/api-specs/api/types/product/updates/ProductSetAttributeInAllVariantsAction.raml b/api-specs/api/types/product/updates/ProductSetAttributeInAllVariantsAction.raml
diff --git a/api-specs/api/types/product/updates/ProductSetProductAttributeAction.raml b/api-specs/api/types/product/updates/ProductSetProductAttributeAction.raml
diff --git a/api-specs/api/types/shopping-list/ShoppingListLineItem.raml b/api-specs/api/types/shopping-list/ShoppingListLineItem.raml
diff --git a/api-specs/api/types/shopping-list/updates/ShoppingListAddLineItemAction.raml b/api-specs/api/types/shopping-list/updates/ShoppingListAddLineItemAction.raml
diff --git a/api-specs/api/types/types.raml b/api-specs/api/types/types.raml
diff --git a/api-specs/graphql/schema.sdl b/api-specs/graphql/schema.sdl
diff --git a/api-specs/import/types/order-import.raml b/api-specs/import/types/order-import.raml
diff --git a/api-specs/import/types/product-draft-import.raml b/api-specs/import/types/product-draft-import.raml
diff --git a/api-specs/import/types/product-import.raml b/api-specs/import/types/product-import.raml
diff --git a/api-specs/import/types/product-type-import.raml b/api-specs/import/types/product-type-import.raml

Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,8 @@`
`38`	`38`	`"hasStagedChanges": false,`
`39`	`39`	`"published": true,`
`40`	`40`	`"createdAt": "1970-01-01T00:00:00.001Z",`
`41`		`- "lastModifiedAt": "2014-01-07T15:25:50.034Z"`
	`41`	`+ "lastModifiedAt": "2014-01-07T15:25:50.034Z",`
	`42`	`+ "attributes": []`
`42`	`43`	`},`
`43`	`44`	`{`
`44`	`45`	`"id": "e779ec1a-0a98-4135-8344-d51bdafd4fe6",`
`@@ -75,7 +76,8 @@`
`75`	`76`	`"hasStagedChanges": true,`
`76`	`77`	`"published": true,`
`77`	`78`	`"createdAt": "2015-05-28T07:15:48.738Z",`
`78`		`- "lastModifiedAt": "2015-05-28T07:19:38.624Z"`
	`79`	`+ "lastModifiedAt": "2015-05-28T07:19:38.624Z",`
	`80`	`+ "attributes": []`
`79`	`81`	`}`
`80`	`82`	`]`
`81`	`83`	`}`