Updated api-reference from documentation release

commercetools · Nov 14, 2023 · 7c7f77f · 7c7f77f
1 parent 67ef6f8
commit 7c7f77f
Show file tree

Hide file tree

Showing 29 changed files with 81 additions and 81 deletions.
diff --git a/api-specs/api/types/associate-role/AssociateRoleResourceIdentifier.raml b/api-specs/api/types/associate-role/AssociateRoleResourceIdentifier.raml
@@ -5,13 +5,13 @@ type: ResourceIdentifier
 displayName: AssociateRoleResourceIdentifier
 discriminatorValue: associate-role
 description: |
-  [ResourceIdentifier](ctp:api:type:TypeResourceIdentifier) of an [AssociateRole](ctp:api:type:AssociateRole).
+  [ResourceIdentifier](ctp:api:type:TypeResourceIdentifier) of an [AssociateRole](ctp:api:type:AssociateRole). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned.
 properties:
   id?:
     type: string
     description: |
-      Unique identifier of the referenced [AssociateRole](ctp:api:type:AssociateRole). Either `id` or `key` is required.
+      Unique identifier of the referenced [AssociateRole](ctp:api:type:AssociateRole). Required if `key` is absent.
   key?:
     type: string
     description: |
-      Unique key of the referenced [AssociateRole](ctp:api:type:AssociateRole). Either `id` or `key` is required.
+      Unique key of the referenced [AssociateRole](ctp:api:type:AssociateRole). Required if `id` is absent.
diff --git a/api-specs/api/types/attribute-group/AttributeGroupResourceIdentifier.raml b/api-specs/api/types/attribute-group/AttributeGroupResourceIdentifier.raml
@@ -5,13 +5,13 @@ type: ResourceIdentifier
 displayName: AttributeGroupResourceIdentifier
 discriminatorValue: attribute-group
 description: |
-  [ResourceIdentifier](/../api/types#resourceidentifier) to an [AttributeGroup](ctp:api:type:AttributeGroup).
+  [ResourceIdentifier](/../api/types#resourceidentifier) to an [AttributeGroup](ctp:api:type:AttributeGroup). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned.
 properties:
   id?:
     type: string
     description: |
-      Platform-generated unique identifier of the referenced [AttributeGroup](ctp:api:type:AttributeGroup). Either `id` or `key` is required.
+      Platform-generated unique identifier of the referenced [AttributeGroup](ctp:api:type:AttributeGroup). Required if `key` is absent.
   key?:
     type: string
     description: |
-      User-generated unique identifier of the referenced [AttributeGroup](ctp:api:type:AttributeGroup). Either `id` or `key` is required.
+      User-generated unique identifier of the referenced [AttributeGroup](ctp:api:type:AttributeGroup). Required if `id` is absent.
diff --git a/api-specs/api/types/business-unit/Associate.raml b/api-specs/api/types/business-unit/Associate.raml
@@ -11,7 +11,7 @@ properties:
     (deprecated): true
     type: AssociateRoleDeprecated[]
     description: |
-      Deprecated type. Use `associateRoleAssignment` instead.
+      Deprecated type. Use `associateRoleAssignments` instead.
   customer:
     type: CustomerReference
     description: |

diff --git a/api-specs/api/types/business-unit/AssociateDraft.raml b/api-specs/api/types/business-unit/AssociateDraft.raml
@@ -12,7 +12,7 @@ properties:
     (deprecated): true
     type: AssociateRoleDeprecated[]
     description: |
-      Deprecated type. Use `associateRoleAssignment` instead.
+      Deprecated type. Use `associateRoleAssignments` instead.
   customer:
     type: CustomerResourceIdentifier
     description: |

diff --git a/api-specs/api/types/business-unit/BusinessUnitResourceIdentifier.raml b/api-specs/api/types/business-unit/BusinessUnitResourceIdentifier.raml
@@ -5,13 +5,13 @@ type: ResourceIdentifier
 displayName: BusinessUnitResourceIdentifier
 discriminatorValue: business-unit
 description: |
-  [ResourceIdentifier](/../api/types#resourceidentifier) to a [BusinessUnit](ctp:api:type:BusinessUnit).
+  [ResourceIdentifier](/../api/types#resourceidentifier) to a [BusinessUnit](ctp:api:type:BusinessUnit). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned.
 properties:
   id?:
     type: string
     description: |
-      Unique identifier of the referenced [BusinessUnit](ctp:api:type:BusinessUnit). Either `id` or `key` is required.
+      Unique identifier of the referenced [BusinessUnit](ctp:api:type:BusinessUnit). Required if `key` is absent.
   key?:
     type: string
     description: |
-      Unique key of the referenced [BusinessUnit](ctp:api:type:BusinessUnit). Either `id` or `key` is required.
+      Unique key of the referenced [BusinessUnit](ctp:api:type:BusinessUnit). Required if `id` is absent.
diff --git a/api-specs/api/types/cart-discount/CartDiscountResourceIdentifier.raml b/api-specs/api/types/cart-discount/CartDiscountResourceIdentifier.raml
@@ -5,13 +5,13 @@ type: ResourceIdentifier
 displayName: CartDiscountResourceIdentifier
 discriminatorValue: cart-discount
 description: |
-  [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [CartDiscount](ctp:api:type:CartDiscount).
+  [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [CartDiscount](ctp:api:type:CartDiscount). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned.
 properties:
   id?:
     type: string
     description: |
-      Unique identifier of the referenced [CartDiscount](ctp:api:type:CartDiscount). Either `id` or `key` is required.
+      Unique identifier of the referenced [CartDiscount](ctp:api:type:CartDiscount). Required if `key` is absent.
   key?:
     type: string
     description: |
-      User-defined unique identifier of the referenced [CartDiscount](ctp:api:type:CartDiscount). Either `id` or `key` is required.
+      User-defined unique identifier of the referenced [CartDiscount](ctp:api:type:CartDiscount). Required if `id` is absent.
diff --git a/api-specs/api/types/cart/Cart.raml b/api-specs/api/types/cart/Cart.raml
@@ -115,7 +115,7 @@ properties:
   shippingAddress?:
     type: Address
     description: |
-      Shipping address associated with the Cart. Determines eligible [ShippingMethod](ctp:api:type:ShippingMethod) rates and Tax Rates of Line Items.
+      Shipping address for a Cart with `Single` [ShippingMode](ctp:api:type:ShippingMode). Determines eligible [ShippingMethod](ctp:api:type:ShippingMethod) rates and Tax Rates of Line Items.
   shippingMode:
     type: ShippingMode
     description: |-
@@ -152,7 +152,7 @@ properties:
     description: |
       Additional shipping addresses of the Cart as specified by [LineItems](ctp:api:type:LineItem) using the `shippingDetails` field.
 
-      Eligible Shipping Methods or applicable Tax Rates are determined by the address in `shippingAddress`, and not `itemShippingAddresses`.
+      For Carts with `Single` [ShippingMode](ctp:api:type:ShippingMode): eligible Shipping Methods or applicable Tax Rates are determined by the address in `shippingAddress`, and not `itemShippingAddresses`.
   discountCodes:
     type: DiscountCodeInfo[]
     description: |

diff --git a/api-specs/api/types/cart/CartDraft.raml b/api-specs/api/types/cart/CartDraft.raml
@@ -81,7 +81,7 @@ properties:
   shippingAddress?:
     type: BaseAddress
     description: |
-      Shipping address associated with the Cart. Determines eligible [ShippingMethod](ctp:api:type:ShippingMethod) rates and Tax Rates of Line Items.
+      Shipping address for a Cart with `Single` [ShippingMode](ctp:api:type:ShippingMode). Determines eligible [ShippingMethod](ctp:api:type:ShippingMethod) rates and Tax Rates of Line Items.
   shippingMethod?:
     type: ShippingMethodResourceIdentifier
     description: |
@@ -115,7 +115,7 @@ properties:
       Multiple shipping addresses of the Cart. Each address must contain a `key` that is unique in this Cart.
       The keys are used by [LineItems](ctp:api:type:LineItem) to reference these addresses under their `shippingDetails`.
 
-      Eligible Shipping Methods or applicable Tax Rates are determined by the address `shippingAddress`, and not `itemShippingAddresses`.
+      For Carts with `Single` [ShippingMode](ctp:api:type:ShippingMode): eligible Shipping Methods or applicable Tax Rates are determined by the address `shippingAddress`, and not `itemShippingAddresses`.
   discountCodes?:
     type: string[]
     description: |

diff --git a/api-specs/api/types/cart/CartResourceIdentifier.raml b/api-specs/api/types/cart/CartResourceIdentifier.raml
@@ -5,13 +5,13 @@ type: ResourceIdentifier
 displayName: CartResourceIdentifier
 discriminatorValue: cart
 description: |
-  [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [Cart](ctp:api:type:Cart).
+  [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [Cart](ctp:api:type:Cart). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned.
 properties:
   id?:
     type: string
     description: |
-      Unique identifier of the referenced [Cart](ctp:api:type:Cart). Either `id` or `key` is required.
+      Unique identifier of the referenced [Cart](ctp:api:type:Cart). Required if `key` is absent.
   key?:
     type: string
     description: |
-      User-defined unique identifier of the referenced [Cart](ctp:api:type:Cart). Either `id` or `key` is required.
+      User-defined unique identifier of the referenced [Cart](ctp:api:type:Cart). Required if `id` is absent.
diff --git a/api-specs/api/types/category/CategoryResourceIdentifier.raml b/api-specs/api/types/category/CategoryResourceIdentifier.raml
@@ -5,13 +5,13 @@ type: ResourceIdentifier
 displayName: CategoryResourceIdentifier
 discriminatorValue: category
 description: |
-  [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [Category](ctp:api:type:Category).
+  [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [Category](ctp:api:type:Category). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned.
 properties:
   id?:
     type: string
     description: |
-      Unique identifier of the referenced [Category](ctp:api:type:Channel). Either `id` or `key` is required.
+      Unique identifier of the referenced [Category](ctp:api:type:Channel). Required if `key` is absent.
   key?:
     type: string
     description: |
-      User-defined unique identifier of the referenced [Category](ctp:api:type:Category). Either `id` or `key` is required.
+      User-defined unique identifier of the referenced [Category](ctp:api:type:Category). Required if `id` is absent.
diff --git a/api-specs/api/types/channel/ChannelResourceIdentifier.raml b/api-specs/api/types/channel/ChannelResourceIdentifier.raml
@@ -5,13 +5,13 @@ type: ResourceIdentifier
 displayName: ChannelResourceIdentifier
 discriminatorValue: channel
 description: |
-  [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [Channel](ctp:api:type:Channel).
+  [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [Channel](ctp:api:type:Channel). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned.
 properties:
   id?:
     type: string
     description: |
-      Unique identifier of the referenced [Channel](ctp:api:type:Channel). Either `id` or `key` is required.
+      Unique identifier of the referenced [Channel](ctp:api:type:Channel). Required if `key` is absent.
   key?:
     type: string
     description: |
-      User-defined unique identifier of the referenced [Channel](ctp:api:type:Channel). Either `id` or `key` is required.
+      User-defined unique identifier of the referenced [Channel](ctp:api:type:Channel). Required if `id` is absent.
diff --git a/api-specs/api/types/customer-group/CustomerGroupResourceIdentifier.raml b/api-specs/api/types/customer-group/CustomerGroupResourceIdentifier.raml
@@ -5,13 +5,13 @@ type: ResourceIdentifier
 displayName: CustomerGroupResourceIdentifier
 discriminatorValue: customer-group
 description: |
-  [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [CustomerGroup](ctp:api:type:CustomerGroup).
+  [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [CustomerGroup](ctp:api:type:CustomerGroup). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned.
 properties:
   id?:
     type: string
     description: |
-      Unique identifier of the referenced [CustomerGroup](ctp:api:type:CustomerGroup). Either `id` or `key` is required.
+      Unique identifier of the referenced [CustomerGroup](ctp:api:type:CustomerGroup). Required if `key` is absent.
   key?:
     type: string
     description: |
-      User-defined unique identifier of the referenced [CustomerGroup](ctp:api:type:CustomerGroup). Either `id` or `key` is required.
+      User-defined unique identifier of the referenced [CustomerGroup](ctp:api:type:CustomerGroup). Required if `id` is absent.
diff --git a/api-specs/api/types/customer/CustomerResourceIdentifier.raml b/api-specs/api/types/customer/CustomerResourceIdentifier.raml
@@ -5,13 +5,13 @@ type: ResourceIdentifier
 displayName: CustomerResourceIdentifier
 discriminatorValue: customer
 description: |
-  [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [Customer](ctp:api:type:Customer). Either `id` or `key` is required.
+  [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [Customer](ctp:api:type:Customer). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned.
 properties:
   id?:
     type: string
     description: |
-      Unique identifier of the referenced [Customer](ctp:api:type:Customer).
+      Unique identifier of the referenced [Customer](ctp:api:type:Customer). Required if `key` is absent.
   key?:
     type: string
     description: |
-      User-defined unique identifier of the referenced [Customer](ctp:api:type:Customer).
+      User-defined unique identifier of the referenced [Customer](ctp:api:type:Customer). Required if `id` is absent.
diff --git a/api-specs/api/types/discount-code/DiscountCodeResourceIdentifier.raml b/api-specs/api/types/discount-code/DiscountCodeResourceIdentifier.raml
@@ -5,13 +5,13 @@ type: ResourceIdentifier
 displayName: DiscountCodeResourceIdentifier
 discriminatorValue: discount-code
 description: |
-  [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [DiscountCode](ctp:api:type:DiscountCode).
+  [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [DiscountCode](ctp:api:type:DiscountCode). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned.
 properties:
   id?:
     type: string
     description: |
-      Unique identifier of the referenced [DiscountCode](ctp:api:type:DiscountCode). Either `id` or `key` is required.
+      Unique identifier of the referenced [DiscountCode](ctp:api:type:DiscountCode). Required if `key` is absent.
   key?:
     type: string
     description: |
-      User-defined unique identifier of the referenced [DiscountCode](ctp:api:type:DiscountCode). Either `id` or `key` is required.
+      User-defined unique identifier of the referenced [DiscountCode](ctp:api:type:DiscountCode). Required if `id` is absent.
diff --git a/api-specs/api/types/inventory/InventoryEntryResourceIdentifier.raml b/api-specs/api/types/inventory/InventoryEntryResourceIdentifier.raml
@@ -4,13 +4,13 @@ type: ResourceIdentifier
 displayName: InventoryEntryResourceIdentifier
 discriminatorValue: inventory-entry
 description: |
-  [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to an [InventoryEntry](ctp:api:type:InventoryEntry).
+  [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to an [InventoryEntry](ctp:api:type:InventoryEntry). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned.
 properties:
   id?:
     type: string
     description: |
-      Unique identifier of the referenced [InventoryEntry](ctp:api:type:InventoryEntry). Either `id` or `key` is required.
+      Unique identifier of the referenced [InventoryEntry](ctp:api:type:InventoryEntry). Required if `key` is absent.
   key?:
     type: string
     description: |
-      User-defined unique identifier of the referenced [InventoryEntry](ctp:api:type:InventoryEntry). Either `id` or `key` is required.
+      User-defined unique identifier of the referenced [InventoryEntry](ctp:api:type:InventoryEntry). Required if `id` is absent.
diff --git a/api-specs/api/types/order-edit/OrderEditResourceIdentifier.raml b/api-specs/api/types/order-edit/OrderEditResourceIdentifier.raml
@@ -4,13 +4,13 @@ type: ResourceIdentifier
 displayName: OrderEditResourceIdentifier
 discriminatorValue: order-edit
 description: |
-  [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to an [OrderEdit](ctp:api:type:OrderEdit). Either `id` or `key` is required.
+  [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to an [OrderEdit](ctp:api:type:OrderEdit). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned.
 properties:
   id?:
     type: string
     description: |
-      Unique identifier of the referenced [OrderEdit](ctp:api:type:OrderEdit).
+      Unique identifier of the referenced [OrderEdit](ctp:api:type:OrderEdit). Required if `key` is absent.
   key?:
     type: string
     description: |
-      User-defined unique identifier of the referenced [OrderEdit](ctp:api:type:OrderEdit).
+      User-defined unique identifier of the referenced [OrderEdit](ctp:api:type:OrderEdit). Required if `id` is absent.
diff --git a/api-specs/api/types/payment/PaymentResourceIdentifier.raml b/api-specs/api/types/payment/PaymentResourceIdentifier.raml
@@ -5,13 +5,13 @@ type: ResourceIdentifier
 displayName: PaymentResourceIdentifier
 discriminatorValue: payment
 description: |
-  [ResourceIdentifier](ctp:api:type:ResourceIdentifier) of a [Payment](ctp:api:type:Payment).
+  [ResourceIdentifier](ctp:api:type:ResourceIdentifier) of a [Payment](ctp:api:type:Payment). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned.
 properties:
   id?:
     type: string
     description: |
-      Unique identifier of the referenced [Payment](ctp:api:type:Payment). Either `id` or `key` is required.
+      Unique identifier of the referenced [Payment](ctp:api:type:Payment). Required if `key` is absent.
   key?:
     type: string
     description: |
-      User-defined unique identifier of the referenced [Payment](ctp:api:type:Payment). Either `id` or `key` is required.
+      User-defined unique identifier of the referenced [Payment](ctp:api:type:Payment). Required if `id` is absent.
diff --git a/api-specs/api/types/product-discount/ProductDiscountResourceIdentifier.raml b/api-specs/api/types/product-discount/ProductDiscountResourceIdentifier.raml
@@ -5,13 +5,13 @@ type: ResourceIdentifier
 displayName: ProductDiscountResourceIdentifier
 discriminatorValue: product-discount
 description: |
-  [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [ProductDiscount](ctp:api:type:ProductDiscount).
+  [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [ProductDiscount](ctp:api:type:ProductDiscount). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned.
 properties:
   id?:
     type: string
     description: |
-      Unique identifier of the referenced [ProductDiscount](ctp:api:type:ProductDiscount). Either `id` or `key` is required.
+      Unique identifier of the referenced [ProductDiscount](ctp:api:type:ProductDiscount). Required if `key` is absent.
   key?:
     type: string
     description: |
-      User-defined unique identifier of the referenced [ProductDiscount](ctp:api:type:ProductDiscount). Either `id` or `key` is required.
+      User-defined unique identifier of the referenced [ProductDiscount](ctp:api:type:ProductDiscount). Required if `id` is absent.
diff --git a/api-specs/api/types/product-selection/ProductSelectionResourceIdentifier.raml b/api-specs/api/types/product-selection/ProductSelectionResourceIdentifier.raml
@@ -5,13 +5,13 @@ type: ResourceIdentifier
 displayName: ProductSelectionResourceIdentifier
 discriminatorValue: product-selection
 description: |
-  [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [ProductSelection](ctp:api:type:ProductSelection).
+  [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [ProductSelection](ctp:api:type:ProductSelection). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned.
 properties:
   id?:
     type: string
     description: |
-      Unique identifier of the referenced [ProductSelection](ctp:api:type:ProductSelection). Either `id` or `key` is required.
+      Unique identifier of the referenced [ProductSelection](ctp:api:type:ProductSelection). Required if `key` is absent.
   key?:
     type: string
     description: |
-      User-defined unique identifier of the referenced [ProductSelection](ctp:api:type:ProductSelection). Either `id` or `key` is required.
+      User-defined unique identifier of the referenced [ProductSelection](ctp:api:type:ProductSelection). Required if `id` is absent.
diff --git a/api-specs/api/types/product-type/ProductTypeResourceIdentifier.raml b/api-specs/api/types/product-type/ProductTypeResourceIdentifier.raml
@@ -5,13 +5,13 @@ type: ResourceIdentifier
 displayName: ProductTypeResourceIdentifier
 discriminatorValue: product-type
 description: |
-  [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [ProductType](ctp:api:type:ProductType).
+  [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [ProductType](ctp:api:type:ProductType). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned.
 properties:
   id?:
     type: string
     description: |
-      Unique identifier of the referenced [ProductType](ctp:api:type:ProductType). Either `id` or `key` is required.
+      Unique identifier of the referenced [ProductType](ctp:api:type:ProductType). Required if `key` is absent.
   key?:
     type: string
     description: |
-      User-defined unique identifier of the referenced [ProductType](ctp:api:type:ProductType). Either `id` or `key` is required.
+      User-defined unique identifier of the referenced [ProductType](ctp:api:type:ProductType). Required if `id` is absent.