Updated api-reference from documentation release (#1796)

Co-authored-by: Auto Mation <[email protected]>
commercetools · Aug 23, 2023 · 6e9c1f3 · 6e9c1f3
1 parent f9185c6
commit 6e9c1f3
Show file tree

Hide file tree

Showing 42 changed files with 169 additions and 52 deletions.
diff --git a/api-specs/api/types/cart/Cart.raml b/api-specs/api/types/cart/Cart.raml
@@ -40,7 +40,6 @@ properties:
       [Anonymous session](ctp:api:type:AnonymousSession) associated with the Cart.
   businessUnit?:
     type: BusinessUnitKeyReference
-    (beta): true
     description: |
       [Reference](ctp:api:type:Reference) to a Business Unit the Cart belongs to.
   store?:

diff --git a/api-specs/api/types/cart/CartDraft.raml b/api-specs/api/types/cart/CartDraft.raml
@@ -36,7 +36,6 @@ properties:
       [Anonymous session](ctp:api:type:AnonymousSession) associated with the Cart.
   businessUnit?:
     type: BusinessUnitResourceIdentifier
-    (beta): true
     description: |
       [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to the Business Unit the Cart should belong to. When the `customerId` of the Cart is also set, the [Customer](ctp:api:type:Customer) must be an [Associate](ctp:api:type:Associate) of the Business Unit.
   store?:

diff --git a/api-specs/api/types/common/Asset.raml b/api-specs/api/types/common/Asset.raml
@@ -29,7 +29,7 @@ properties:
   key?:
     type: string
     description: |
-      User-defined unique identifier of the Asset.
+      User-defined identifier of the Asset. It is unique per [Category](ctp:api:type:Category) or [ProductVariant](ctp:api:type:ProductVariant).
     pattern: ^[A-Za-z0-9_-]+$
     minLength: 2
     maxLength: 256
diff --git a/api-specs/api/types/common/AssetDraft.raml b/api-specs/api/types/common/AssetDraft.raml
@@ -25,7 +25,7 @@ properties:
   key?:
     type: string
     description: |
-      User-defined unique identifier for the Asset.
+      User-defined identifier for the Asset. Must be unique per [Category](ctp:api:type:Category) or [ProductVariant](ctp:api:type:ProductVariant).
     pattern: ^[A-Za-z0-9_-]+$
     minLength: 2
     maxLength: 256
diff --git a/api-specs/api/types/common/AssetSource.raml b/api-specs/api/types/common/AssetSource.raml
@@ -11,7 +11,7 @@ properties:
       URI of the AssetSource.
   key?:
     type: string
-    description: User-defined unique identifier of the AssetSource.
+    description: User-defined identifier of the AssetSource. Must be unique per [Asset](ctp:api:type:Asset).
     pattern: ^[A-Za-z0-9_-]+$
     minLength: 2
     maxLength: 256

diff --git a/api-specs/api/types/me/MyCartDraft.raml b/api-specs/api/types/me/MyCartDraft.raml
@@ -19,7 +19,6 @@ properties:
       Email address of the Customer the Cart belongs to.
   businessUnit?:
     type: BusinessUnitResourceIdentifier
-    (beta): true
     description: |
       [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to the Business Unit the Cart should belong to. The [Customer](ctp:api:type:Customer) must be an [Associate](ctp:api:type:Associate) of the Business Unit.
   store?:

diff --git a/api-specs/api/types/me/updates/MyShoppingListAddLineItemAction.raml b/api-specs/api/types/me/updates/MyShoppingListAddLineItemAction.raml
@@ -7,6 +7,12 @@ displayName: MyShoppingListAddLineItemAction
 discriminatorValue: addLineItem
 example: !include ../../../examples/ShoppingList/ShoppingListAddLineItemAction.json
 properties:
+  key?:
+    type: string
+    description: User-defined identifier of the ShoppingListLineItem. Must be unique per [ShoppingList](ctp:api:type:ShoppingList).
+    pattern: ^[a-zA-Z0-9_-]
+    minLength: 2
+    maxLength: 256
   sku?:
     type: string
     description: |

diff --git a/api-specs/api/types/me/updates/MyShoppingListAddTextLineItemAction.raml b/api-specs/api/types/me/updates/MyShoppingListAddTextLineItemAction.raml
@@ -11,6 +11,13 @@ properties:
     type: LocalizedString
     description: |
       Name of the [TextLineItem](ctp:api:type:TextLineItem).
+  key?:
+    type: string
+    description: |
+      User-defined identifier of the TextLineItem. Must be unique per [ShoppingList](ctp:api:type:ShoppingList).
+    pattern: ^[a-zA-Z0-9_-]
+    minLength: 2
+    maxLength: 256
   description?:
     type: LocalizedString
     description: |

diff --git a/api-specs/api/types/me/updates/MyShoppingListChangeLineItemQuantityAction.raml b/api-specs/api/types/me/updates/MyShoppingListChangeLineItemQuantityAction.raml
@@ -9,11 +9,11 @@ properties:
   lineItemId?:
     type: string
     description: |
-      `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
+      `id` of the ShoppingListLineItem to update. Either `lineItemId` or `lineItemKey` is required.
   lineItemKey?:
     type: string
     description: |
-      `key` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
+      `key` of the ShoppingListLineItem to update. Either `lineItemId` or `lineItemKey` is required.
   quantity:
     type: number
     minimum: 0

diff --git a/api-specs/api/types/me/updates/MyShoppingListChangeTextLineItemNameAction.raml b/api-specs/api/types/me/updates/MyShoppingListChangeTextLineItemNameAction.raml
@@ -6,10 +6,14 @@ displayName: MyShoppingListChangeTextLineItemNameAction
 discriminatorValue: changeTextLineItemName
 example: !include ../../../examples/ShoppingList/ShoppingListChangeTextLineItemNameAction.json
 properties:
-  textLineItemId:
+  textLineItemId?:
     type: string
     description: |
-      The `id` of the [TextLineItem](ctp:api:type:TextLineItem) to update.
+      The `id` of the [TextLineItem](ctp:api:type:TextLineItem) to update. Either `lineItemId` or `lineItemKey` is required.
+  textLineItemKey?:
+    type: string
+    description: |
+      The `key` of the [TextLineItem](ctp:api:type:TextLineItem) to update. Either `lineItemId` or `lineItemKey` is required.
   name:
     type: LocalizedString
     description: |

diff --git a/api-specs/api/types/me/updates/MyShoppingListChangeTextLineItemQuantityAction.raml b/api-specs/api/types/me/updates/MyShoppingListChangeTextLineItemQuantityAction.raml
@@ -6,10 +6,14 @@ displayName: MyShoppingListChangeTextLineItemQuantityAction
 discriminatorValue: changeTextLineItemQuantity
 example: !include ../../../examples/ShoppingList/ShoppingListChangeTextLineItemQuantityAction.json
 properties:
-  textLineItemId:
+  textLineItemId?:
     type: string
     description: |
-      The `id` of the [TextLineItem](ctp:api:type:TextLineItem) to update.
+      The `id` of the [TextLineItem](ctp:api:type:TextLineItem) to update. Either `lineItemId` or `lineItemKey` is required.
+  textLineItemKey?:
+    type: string
+    description: |
+      The `key` of the [TextLineItem](ctp:api:type:TextLineItem) to update. Either `lineItemId` or `lineItemKey` is required.
   quantity:
     type: number
     minimum: 0

diff --git a/api-specs/api/types/me/updates/MyShoppingListRemoveLineItemAction.raml b/api-specs/api/types/me/updates/MyShoppingListRemoveLineItemAction.raml
@@ -6,10 +6,14 @@ displayName: MyShoppingListRemoveLineItemAction
 discriminatorValue: removeLineItem
 example: !include ../../../examples/ShoppingList/ShoppingListRemoveLineItemAction.json
 properties:
-  lineItemId:
+  lineItemId?:
     type: string
     description: |
-      The `id` of the [ShoppingListLineItem](ctp:api:type:ShoppingListLineItem) to update.
+      The `id` of the [ShoppingListLineItem](ctp:api:type:ShoppingListLineItem) to update. Either `lineItemId` or `lineItemKey` is required.
+  lineItemKey?:
+    type: string
+    description: |
+      The `key` of the [ShoppingListLineItem](ctp:api:type:ShoppingListLineItem) to update. Either `lineItemId` or `lineItemKey` is required.
   quantity?:
     type: number
     format: int64

diff --git a/api-specs/api/types/me/updates/MyShoppingListRemoveTextLineItemAction.raml b/api-specs/api/types/me/updates/MyShoppingListRemoveTextLineItemAction.raml
@@ -6,10 +6,14 @@ displayName: MyShoppingListRemoveTextLineItemAction
 discriminatorValue: removeTextLineItem
 example: !include ../../../examples/ShoppingList/ShoppingListRemoveTextLineItemAction.json
 properties:
-  textLineItemId:
+  textLineItemId?:
     type: string
     description: |
-      The `id` of the [TextLineItem](ctp:api:type:TextLineItem) to update.
+      The `id` of the [TextLineItem](ctp:api:type:TextLineItem) to update. Either `lineItemId` or `lineItemKey` is required.
+  textLineItemKey?:
+    type: string
+    description: |
+      The `key` of the [TextLineItem](ctp:api:type:TextLineItem) to update. Either `lineItemId` or `lineItemKey` is required.
   quantity?:
     type: number
     format: int64

diff --git a/api-specs/api/types/me/updates/MyShoppingListSetLineItemCustomFieldAction.raml b/api-specs/api/types/me/updates/MyShoppingListSetLineItemCustomFieldAction.raml
@@ -6,10 +6,14 @@ displayName: MyShoppingListSetLineItemCustomFieldAction
 discriminatorValue: setLineItemCustomField
 example: !include ../../../examples/ShoppingList/ShoppingListSetLineItemCustomFieldAction.json
 properties:
-  lineItemId:
+  lineItemId?:
     type: string
     description: |
-      Unique identifier of an existing [ShoppingListLineItem](ctp:api:type:ShoppingListLineItem) in the [ShoppingList](ctp:api:type:ShoppingList).
+      Unique identifier of an the [ShoppingListLineItem](ctp:api:type:ShoppingListLineItem). Either `lineItemId` or `lineItemKey` is required.
+  lineItemKey?:
+    type: string
+    description: |
+      The `key` of the [ShoppingListLineItem](ctp:api:type:ShoppingListLineItem) to update. Either `lineItemId` or `lineItemKey` is required.
   name:
     type: string
     description: |

diff --git a/api-specs/api/types/me/updates/MyShoppingListSetTextLineItemCustomFieldAction.raml b/api-specs/api/types/me/updates/MyShoppingListSetTextLineItemCustomFieldAction.raml
@@ -6,10 +6,14 @@ displayName: MyShoppingListSetTextLineItemCustomFieldAction
 discriminatorValue: setTextLineItemCustomField
 example: !include ../../../examples/ShoppingList/ShoppingListSetTextLineItemCustomFieldAction.json
 properties:
-  textLineItemId:
+  textLineItemId?:
     type: string
     description: |
-      The `id` of the [TextLineItem](ctp:api:type:TextLineItem) to update.
+      The `id` of the [TextLineItem](ctp:api:type:TextLineItem) to update. Either `lineItemId` or `lineItemKey` is required.
+  textLineItemKey?:
+    type: string
+    description: |
+      The `key` of the [TextLineItem](ctp:api:type:TextLineItem) to update. Either `lineItemId` or `lineItemKey` is required.
   name:
     type: string
     description: |

diff --git a/api-specs/api/types/me/updates/MyShoppingListSetTextLineItemCustomTypeAction.raml b/api-specs/api/types/me/updates/MyShoppingListSetTextLineItemCustomTypeAction.raml
@@ -6,10 +6,14 @@ displayName: MyShoppingListSetTextLineItemCustomTypeAction
 discriminatorValue: setTextLineItemCustomType
 example: !include ../../../examples/ShoppingList/ShoppingListSetTextLineItemCustomTypeAction.json
 properties:
-  textLineItemId:
+  textLineItemId?:
     type: string
     description: |
-      The `id` of the [TextLineItem](ctp:api:type:TextLineItem) to update.
+      The `id` of the [TextLineItem](ctp:api:type:TextLineItem) to update. Either `lineItemId` or `lineItemKey` is required.
+  textLineItemKey?:
+    type: string
+    description: |
+      The `key` of the [TextLineItem](ctp:api:type:TextLineItem) to update. Either `lineItemId` or `lineItemKey` is required.
   type?:
     type: TypeResourceIdentifier
     description: |

diff --git a/api-specs/api/types/me/updates/MyShoppingListSetTextLineItemDescriptionAction.raml b/api-specs/api/types/me/updates/MyShoppingListSetTextLineItemDescriptionAction.raml
@@ -6,10 +6,14 @@ displayName: MyShoppingListSetTextLineItemDescriptionAction
 discriminatorValue: setTextLineItemDescription
 example: !include ../../../examples/ShoppingList/ShoppingListSetTextLineItemDescriptionAction.json
 properties:
-  textLineItemId:
+  textLineItemId?:
     type: string
     description: |
-      The `id` of the [TextLineItem](ctp:api:type:TextLineItem) to update.
+      The `id` of the [TextLineItem](ctp:api:type:TextLineItem) to update. Either `lineItemId` or `lineItemKey` is required.
+  textLineItemKey?:
+    type: string
+    description: |
+      The `key` of the [TextLineItem](ctp:api:type:TextLineItem) to update. Either `lineItemId` or `lineItemKey` is required.
   description?:
     type: LocalizedString
     description: |

diff --git a/api-specs/api/types/message/BusinessUnitCreatedMessage.raml b/api-specs/api/types/message/BusinessUnitCreatedMessage.raml
@@ -1,7 +1,6 @@
 #%RAML 1.0 DataType
 (package): Message
 type: Message
-(beta): true
 displayName: BusinessUnitCreatedMessage
 discriminatorValue: BusinessUnitCreated
 description: |

diff --git a/api-specs/api/types/message/payload/BusinessUnitCreatedMessagePayload.raml b/api-specs/api/types/message/payload/BusinessUnitCreatedMessagePayload.raml
@@ -1,7 +1,6 @@
 #%RAML 1.0 DataType
 (package): Message
 type: MessagePayload
-(beta): true
 displayName: BusinessUnitCreatedMessagePayload
 discriminatorValue: BusinessUnitCreated
 description: |

diff --git a/api-specs/api/types/order/Order.raml b/api-specs/api/types/order/Order.raml
@@ -44,7 +44,6 @@ properties:
       [Anonymous session](ctp:api:type:AnonymousSession) associated with the Order.
   businessUnit?:
     type: BusinessUnitKeyReference
-    (beta): true
     description: |
       [Reference](ctp:api:type:Reference) to a Business Unit the Order belongs to.
   store?:

diff --git a/api-specs/api/types/order/OrderImportDraft.raml b/api-specs/api/types/order/OrderImportDraft.raml
@@ -29,7 +29,6 @@ properties:
       The Customer Group of the Customer the Order belongs to.
   businessUnit?:
     type: BusinessUnitResourceIdentifier
-    (beta): true
     description: |
       [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to the Business Unit the Order should belong to.
       When the `customerId` of the Order is also set, the [Customer](ctp:api:type:Customer) must be an [Associate](ctp:api:type:Associate) of the Business Unit.

diff --git a/api-specs/api/types/project/BusinessUnitConfiguration.raml b/api-specs/api/types/project/BusinessUnitConfiguration.raml
@@ -6,6 +6,7 @@ properties:
   myBusinessUnitStatusOnCreation:
     type: BusinessUnitConfigurationStatus
     description: Status of Business Units created using the [My Business Unit endpoint](ctp:api:endpoint:/{projectKey}/me/business-units:POST).
+    default: Inactive
   myBusinessUnitAssociateRoleOnCreation?:
     type: AssociateRoleKeyReference
     description: |

diff --git a/api-specs/api/types/project/Project.raml b/api-specs/api/types/project/Project.raml
@@ -64,6 +64,5 @@ properties:
       Controls indexing of resources to be provided on high performance read-only search endpoints.
   businessUnits?:
     type: BusinessUnitConfiguration
-    (beta): true
     description: |
       Holds configuration specific to [Business Units](ctp:api:type:BusinessUnit).
diff --git a/api-specs/api/types/quote-request/QuoteRequest.raml b/api-specs/api/types/quote-request/QuoteRequest.raml
@@ -149,8 +149,11 @@ properties:
     description: |
       Identifier for a purchase order, usually in a B2B context.
       The Purchase Order Number is typically entered by the [Buyer](/quotes-overview#buyer).
+  cart?:
+    type: CartReference
+    description: |
+      The [Cart](ctp:api:type:Cart) from which a Quote is requested.
   businessUnit?:
     type: BusinessUnitKeyReference
-    (beta): true
     description: |
       The [BusinessUnit](ctp:api:type:BusinessUnit) for the Quote Request.
diff --git a/api-specs/api/types/quote/Quote.raml b/api-specs/api/types/quote/Quote.raml
@@ -167,6 +167,5 @@ properties:
       track the purchase order during the [quote and order flow](/../api/quotes-overview#intended-workflow).
   businessUnit?:
     type: BusinessUnitKeyReference
-    (beta): true
     description: |
       The [BusinessUnit](ctp:api:type:BusinessUnit) for the Quote.
diff --git a/api-specs/api/types/shopping-list/ShoppingListLineItem.raml b/api-specs/api/types/shopping-list/ShoppingListLineItem.raml
@@ -25,6 +25,12 @@ properties:
   id:
     type: string
     description: Unique identifier of the ShoppingListLineItem.
+  key?:
+    type: string
+    description: User-defined identifier of the ShoppingListLineItem. It is unique per [ShoppingList](ctp:api:type:ShoppingList).
+    pattern: ^[a-zA-Z0-9_-]
+    minLength: 2
+    maxLength: 256
   name:
     type: LocalizedString
     description: |

diff --git a/api-specs/api/types/shopping-list/ShoppingListLineItemDraft.raml b/api-specs/api/types/shopping-list/ShoppingListLineItemDraft.raml
@@ -6,6 +6,12 @@ example: !include ../../examples/ShoppingList/ShoppingListLineItemDraft.json
 description: |
   The [ProductVariant](ctp:api:type:ProductVariant) to be included in the ShoppingListLineItem must be specified using the `productID` and `variantID`, or by the `sku`.
 properties:
+  key?:
+    type: string
+    description: User-defined identifier of the ShoppingListLineItem. Must be unique per [ShoppingList](ctp:api:type:ShoppingList).
+    pattern: ^[a-zA-Z0-9_-]
+    minLength: 2
+    maxLength: 256
   productId?:
     type: string
     description: |

diff --git a/api-specs/api/types/shopping-list/TextLineItem.raml b/api-specs/api/types/shopping-list/TextLineItem.raml
@@ -21,6 +21,12 @@ properties:
   id:
     type: string
     description: Unique identifier of the TextLineItem.
+  key?:
+    type: string
+    description: User-defined identifier of the TextLineItem. It is unique per [ShoppingList](ctp:api:type:ShoppingList).
+    pattern: ^[a-zA-Z0-9_-]
+    minLength: 2
+    maxLength: 256
   name:
     type: LocalizedString
     description: |

diff --git a/api-specs/api/types/shopping-list/TextLineItemDraft.raml b/api-specs/api/types/shopping-list/TextLineItemDraft.raml
@@ -4,6 +4,12 @@ type: object
 displayName: TextLineItemDraft
 example: !include ../../examples/ShoppingList/TextLineItemDraft.json
 properties:
+  key?:
+    type: string
+    description: User-defined unique identifier of the TextLineItem. Must be unique per [ShoppingList](ctp:api:type:ShoppingList).
+    pattern: ^[a-zA-Z0-9_-]
+    minLength: 2
+    maxLength: 256
   addedAt?:
     type: datetime
     description: |

diff --git a/api-specs/api/types/shopping-list/updates/ShoppingListAddLineItemAction.raml b/api-specs/api/types/shopping-list/updates/ShoppingListAddLineItemAction.raml
@@ -10,6 +10,13 @@ description: |
   A ShoppingListLineItem with an empty `variantId` is not considered the same as a ShoppingListLineItem with a `variantId` currently referring to the Master Variant.
 example: !include ../../../examples/ShoppingList/ShoppingListAddLineItemAction.json
 properties:
+  key?:
+    type: string
+    description: |
+      User-defined identifier of the ShoppingListLineItem. Must be unique per [ShoppingList](ctp:api:type:ShoppingList).
+    pattern: ^[a-zA-Z0-9_-]
+    minLength: 2
+    maxLength: 256
   sku?:
     type: string
     description: |

diff --git a/api-specs/api/types/shopping-list/updates/ShoppingListAddTextLineItemAction.raml b/api-specs/api/types/shopping-list/updates/ShoppingListAddTextLineItemAction.raml
@@ -10,6 +10,13 @@ properties:
     type: LocalizedString
     description: |
       Name of the TextLineItem.
+  key?:
+    type: string
+    description: |
+      User-defined identifier of the TextLineItem. Must be unique per [ShoppingList](ctp:api:type:ShoppingList).
+    pattern: ^[a-zA-Z0-9_-]
+    minLength: 2
+    maxLength: 256
   description?:
     type: LocalizedString
     description: |

diff --git a/api-specs/api/types/shopping-list/updates/ShoppingListChangeLineItemQuantityAction.raml b/api-specs/api/types/shopping-list/updates/ShoppingListChangeLineItemQuantityAction.raml
@@ -6,10 +6,14 @@ displayName: ShoppingListChangeLineItemQuantityAction
 discriminatorValue: changeLineItemQuantity
 example: !include ../../../examples/ShoppingList/ShoppingListChangeLineItemQuantityAction.json
 properties:
-  lineItemId:
+  lineItemId?:
     type: string
     description: |
-      The `id` of the [ShoppingListLineItem](ctp:api:type:ShoppingListLineItem) to update.
+      The `id` of the [ShoppingListLineItem](ctp:api:type:ShoppingListLineItem) to update. Either `lineItemId` or `lineItemKey` is required.
+  lineItemKey?:
+    type: string
+    description: |
+      The `key` of the [ShoppingListLineItem](ctp:api:type:ShoppingListLineItem) to update. Either `lineItemId` or `lineItemKey` is required.
   quantity:
     type: number
     minimum: 0