Updated API from documentation release

Author: ct-sdks[bot]

api-specs/api/resources/carts.raml

@@ -10,6 +10,7 @@ type:
 (createable): CartDraft
 description: A shopping cart holds product variants and can be ordered.
 get:
+  displayName: Query Carts
   securedBy: [oauth_2_0: { scopes: ['view_orders:{projectKey}'] }]
   description: Retrieves Carts in the Project.
   responses:
@@ -18,13 +19,14 @@ get:
         application/json:
           example: !include ../examples/carts.example.json
 head:
+  displayName: Check if Cart exists by Query Predicate
   securedBy: [oauth_2_0: { scopes: ['view_orders:{projectKey}'] }]
-  displayName: Check if a Cart exists by Query Predicate
   description: Checks if one or more Carts exist for the provided query predicate. Returns a `200 OK` status if any Carts match the query predicate, or [Not Found](/../api/errors#404-not-found) otherwise.
   queryParameters:
     where?:
       type: QueryPredicate[]
 post:
+  displayName: Create Cart
   securedBy: [oauth_2_0: { scopes: ['manage_orders:{projectKey}'] }]
   description: |
 
@@ -87,6 +89,7 @@ post:
       uriParameterName: customerId
       resourceType: Cart
   get:
+    displayName: Get Cart by Customer ID
     securedBy: [oauth_2_0: { scopes: ['view_orders:{projectKey}'] }]
     description: |
       Retrieves the most recently modified active Cart of a Customer with [CartOrigin](ctp:api:type:CartOrigin) `Customer`. If no active Cart exists, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error.
@@ -98,6 +101,7 @@ post:
           application/json:
             example: !include ../examples/cart.example.json
   head:
+    displayName: Check if Cart exists by Customer ID
     securedBy: [oauth_2_0: { scopes: ['view_orders:{projectKey}'] }]
     description: Checks if a Cart exists for a Customer. Returns a `200 OK` status if the Cart exists or [Not Found](/../api/errors#404-not-found) otherwise.
 /key={key}:
@@ -108,6 +112,7 @@ post:
       resourceType: Cart
       resourceUpdateType: CartUpdate
   get:
+    displayName: Get Cart by Key
     securedBy: [oauth_2_0: { scopes: ['view_orders:{projectKey}'] }]
     description: |
       Retrieves a Cart with the provided `key`.
@@ -118,9 +123,11 @@ post:
           application/json:
             example: !include ../examples/cart.example.json
   head:
+    displayName: Check if Cart exists by Key
     securedBy: [oauth_2_0: { scopes: ['view_orders:{projectKey}'] }]
     description: Checks if a Cart exists with the provided `key`. Returns a `200 OK` status if the Cart exists or [Not Found](/../api/errors#404-not-found) otherwise.
   post:
+    displayName: Update Cart by Key
     description: Updates a Cart in the Project using one or more [update actions](/../api/projects/carts#update-actions).
     securedBy: [oauth_2_0: { scopes: ['manage_orders:{projectKey}'] }]
     body:
@@ -132,6 +139,7 @@ post:
           application/json:
             example: !include ../examples/cart.example.json
   delete:
+    displayName: Delete Cart by Key
     is:
       - dataErasure
     securedBy: [oauth_2_0: { scopes: ['manage_orders:{projectKey}'] }]
@@ -149,6 +157,7 @@ post:
       resourceType: Cart
       resourceUpdateType: CartUpdate
   get:
+    displayName: Get Cart by ID
     securedBy: [oauth_2_0: { scopes: ['view_orders:{projectKey}'] }]
     description: |
       Retrieves a Cart with the provided `id`.
@@ -159,9 +168,11 @@ post:
           application/json:
             example: !include ../examples/cart.example.json
   head:
+    displayName: Check if Cart exists by ID
     securedBy: [oauth_2_0: { scopes: ['view_orders:{projectKey}'] }]
     description: Checks if a Cart exists for the provided `id`. Returns a `200 OK` status if the Cart exists or [Not Found](/../api/errors#404-not-found) otherwise.
   post:
+    displayName: Update Cart by ID
     securedBy: [oauth_2_0: { scopes: ['manage_orders:{projectKey}'] }]
     description: Updates a Cart in the Project using one or more [update actions](/../api/projects/carts#update-actions).
     body:
@@ -173,6 +184,7 @@ post:
           application/json:
             example: !include ../examples/cart.example.json
   delete:
+    displayName: Delete Cart by ID
     is:
       - dataErasure
     securedBy: [oauth_2_0: { scopes: ['manage_orders:{projectKey}'] }]

api-specs/api/resources/orders.raml

@@ -12,6 +12,7 @@ description:
   An order can be created from a order, usually after a checkout process has
   been completed.
 get:
+  displayName: Query Orders
   securedBy: [oauth_2_0: { scopes: ['view_orders:{projectKey}'] }]
   description: Retrieves Orders in the Project.
   responses:
@@ -20,12 +21,14 @@ get:
         application/json:
           example: !include ../examples/orders.example.json
 head:
+  displayName: Check if Order exists by Query Predicate
   securedBy: [oauth_2_0: { scopes: ['view_orders:{projectKey}'] }]
   description: Checks if one or more Orders exist for the provided query predicate. Returns a `200 OK` status if any Orders match the query predicate, or a `404 Not Found` otherwise.
   queryParameters:
     where?:
       type: QueryPredicate[]
 post:
+  displayName: Create Order
   securedBy: [oauth_2_0: { scopes: ['manage_orders:{projectKey}'] }]
   is:
     - conflicting
@@ -64,7 +67,7 @@ post:
   type: base
   displayName: import orders
   post:
-    displayName: Create an Order by Import
+    displayName: Create Order by Import
     description: |
       Creates an Order without needing to create a Cart first.
       Importing an Order produces the [Order Imported](ctp:api:type:OrderImportedMessage) Message.
@@ -89,7 +92,7 @@ post:
   type: base
   displayName: Order from Quote
   post:
-    displayName: Create an Order from a Quote
+    displayName: Create Order from Quote
     description: |
 
       Creates an Order from a Quote. The referenced Quote must have the `Pending` [state](ctp:api:type:QuoteState) and must be valid (not past the `validTo` date); otherwise, an [InvalidOperation](ctp:api:type:InvalidOperationError) error is returned.
@@ -126,6 +129,7 @@ post:
       resourceType: Order
       resourceUpdateType: OrderUpdate
   get:
+    displayName: Get Order by OrderNumber
     securedBy: [oauth_2_0: { scopes: ['view_orders:{projectKey}'] }]
     description: Retrieves an Order with the provided `orderNumber`.
     responses:
@@ -134,9 +138,11 @@ post:
           application/json:
             example: !include ../examples/order.example.json
   head:
+    displayName: Check if Order exists by OrderNumber
     securedBy: [oauth_2_0: { scopes: ['view_orders:{projectKey}'] }]
     description: Checks if an Order exists with the provided `orderNumber`. Returns a `200 OK` status if the Order exists or a `404 Not Found` otherwise.
   post:
+    displayName: Update Order by OrderNumber
     securedBy: [oauth_2_0: { scopes: ['manage_orders:{projectKey}'] }]
     description: Updates an Order in the Project using one or more [update actions](/../api/projects/orders#update-actions).
     body:
@@ -148,6 +154,7 @@ post:
           application/json:
             example: !include ../examples/order.example.json
   delete:
+    displayName: Delete Order by OrderNumber
     description: |
       Deletes an Order in the Project.
       Deleting an Order produces the [OrderDeleted](ctp:api:type:OrderDeletedMessage) Message.
@@ -174,6 +181,7 @@ post:
     OrderEdit are containers for financial changes after an Order has been
     placed.
   get:
+    displayName: Query OrderEdits
     securedBy: [oauth_2_0: { scopes: ['view_order_edits:{projectKey}'] }]
     description: Retrieves OrderEdits in the Project.
     responses:
@@ -182,12 +190,14 @@ post:
           application/json:
             example: !include ../examples/order-edits-query.example.json
   head:
+    displayName: Check if OrderEdit exists by Query Predicate
     securedBy: [oauth_2_0: { scopes: ['view_order_edits:{projectKey}'] }]
     description: Checks if one or more OrderEdits exist for the provided query predicate. Returns a `200 OK` status if any OrderEdits match the query predicate, or a `404 Not Found` otherwise.
     queryParameters:
       where?:
         type: QueryPredicate[]
   post:
+    displayName: Create OrderEdit
     description: |
       Creates an OrderEdit in the Project.
       You can either create multiple Order Edits for an Order and apply them sequentially to an Order, or create multiple Order Edits parallelly (as alternatives to each other) and apply one of them to the Order.
@@ -213,6 +223,7 @@ post:
         resourceType: OrderEdit
         resourceUpdateType: OrderEditUpdate
     get:
+      displayName: Get OrderEdit by Key
       securedBy: [oauth_2_0: { scopes: ['view_order_edits:{projectKey}'] }]
       description: Retrieves an OrderEdit with the provided `key`.
       responses:
@@ -221,9 +232,11 @@ post:
             application/json:
               example: !include ../examples/order-edits.example.json
     head:
+      displayName: Check if OrderEdit exists by Key
       securedBy: [oauth_2_0: { scopes: ['view_order_edits:{projectKey}'] }]
       description: Checks if an OrderEdit exists with the provided `key`. Returns a `200 OK` status if the OrderEdit exists or a `404 Not Found` otherwise.
     post:
+      displayName: Update OrderEdit by Key
       securedBy: [oauth_2_0: { scopes: ['manage_order_edits:{projectKey}'] }]
       description: Updates an OrderEdit in the Project using one or more [update actions](/../api/projects/order-edits#update-actions).
       body:
@@ -235,6 +248,7 @@ post:
             application/json:
               example: !include ../examples/order-edits.example.json
     delete:
+      displayName: Delete OrderEdit by Key
       securedBy: [oauth_2_0: { scopes: ['manage_order_edits:{projectKey}'] }]
       description: Deletes an OrderEdit in the Project.
       responses:
@@ -250,6 +264,7 @@ post:
         resourceType: OrderEdit
         resourceUpdateType: OrderEditUpdate
     get:
+      displayName: Get OrderEdit by ID
       securedBy: [oauth_2_0: { scopes: ['view_order_edits:{projectKey}'] }]
       description: Retrieves an OrderEdit with the provided `id`.
       responses:
@@ -258,9 +273,11 @@ post:
             application/json:
               example: !include ../examples/order-edits.example.json
     head:
+      displayName: Check if OrderEdit exists by ID
       securedBy: [oauth_2_0: { scopes: ['view_order_edits:{projectKey}'] }]
       description: Checks if an OrderEdit exists with the provided `id`. Returns a `200 OK` status if the OrderEdit exists or a `404 Not Found` otherwise.
     post:
+      displayName: Update OrderEdit by ID
       securedBy: [oauth_2_0: { scopes: ['manage_order_edits:{projectKey}'] }]
       description: Updates an OrderEdit in the Project using one or more [update actions](/../api/projects/order-edits#update-actions).
       body:
@@ -272,6 +289,7 @@ post:
             application/json:
               example: !include ../examples/order-edits.example.json
     delete:
+      displayName: Delete OrderEdit by ID
       securedBy: [oauth_2_0: { scopes: ['manage_order_edits:{projectKey}'] }]
       description: Deletes an OrderEdit in the Project.
       responses:
@@ -303,6 +321,7 @@ post:
       resourceType: Order
       resourceUpdateType: OrderUpdate
   get:
+    displayName: Get Order by ID
     securedBy: [oauth_2_0: { scopes: ['view_orders:{projectKey}'] }]
     description: Retrieves an Order with the provided `id`.
     responses:
@@ -311,9 +330,11 @@ post:
           application/json:
             example: !include ../examples/order.example.json
   head:
+    displayName: Check if Order exists by ID
     securedBy: [oauth_2_0: { scopes: ['view_orders:{projectKey}'] }]
     description: Checks if an Order exists with the provided `id`. Returns a `200 OK` status if the Order exists or a `404 Not Found` otherwise.
   post:
+    displayName: Update Order by ID
     securedBy: [oauth_2_0: { scopes: ['manage_orders:{projectKey}'] }]
     description: Updates an Order in the Project using one or more [update actions](/../api/projects/orders#update-actions).
     body:
@@ -325,6 +346,7 @@ post:
           application/json:
             example: !include ../examples/order.example.json
   delete:
+    displayName: Delete Order by ID
     description: |
       Deletes an Order in the Project.
       Deleting an Order produces the [OrderDeleted](ctp:api:type:OrderDeletedMessage) Message.

api-specs/api/resources/shopping-lists.raml

@@ -10,6 +10,7 @@ type:
 (createable): ShoppingListDraft
 description: shopping-lists e.g. for wishlist support
 get:
+  displayName: Query ShoppingLists
   securedBy: [oauth_2_0: { scopes: ['view_shopping_lists:{projectKey}'] }]
   queryParameters:
     expand:
@@ -24,12 +25,14 @@ get:
         application/json:
           example: !include ../examples/shopping-lists.example.json
 head:
+  displayName: Check if ShoppingList exists by Query Predicate
   securedBy: [oauth_2_0: { scopes: ['view_shopping_lists:{projectKey}'] }]
   description: Checks if one or more ShoppingLists exist for the provided query predicate. Returns a `200 OK` status if any ShoppingLists match the query predicate, or a `404 Not Found` otherwise.
   queryParameters:
     where?:
       type: QueryPredicate[]
 post:
+  displayName: Create ShoppingList
   securedBy: [oauth_2_0: { scopes: ['manage_shopping_lists:{projectKey}'] }]
   description: Create a ShoppingList in the Project.
   queryParameters:
@@ -54,6 +57,7 @@ post:
       resourceType: ShoppingList
       resourceUpdateType: ShoppingListUpdate
   get:
+    displayName: Get ShoppingList by Key
     securedBy: [oauth_2_0: { scopes: ['view_shopping_lists:{projectKey}'] }]
     queryParameters:
       expand:
@@ -68,9 +72,11 @@ post:
           application/json:
             example: !include ../examples/shopping-list.example.json
   head:
+    displayName: Check if ShoppingList exists by Key
     securedBy: [oauth_2_0: { scopes: ['view_shopping_lists:{projectKey}'] }]
     description: Checks if a ShoppingList exists with the provided `key`. Returns a `200 OK` status if the ShoppingList exists, or [Not Found](/../api/errors#404-not-found) otherwise.
   post:
+    displayName: Update ShoppingList by Key
     securedBy: [oauth_2_0: { scopes: ['manage_shopping_lists:{projectKey}'] }]
     queryParameters:
       expand:
@@ -88,6 +94,7 @@ post:
           application/json:
             example: !include ../examples/shopping-list.example.json
   delete:
+    displayName: Delete ShoppingList by Key
     is:
       - dataErasure
     securedBy: [oauth_2_0: { scopes: ['manage_shopping_lists:{projectKey}'] }]
@@ -111,6 +118,7 @@ post:
       resourceType: ShoppingList
       resourceUpdateType: ShoppingListUpdate
   get:
+    displayName: Get ShoppingList by ID
     securedBy: [oauth_2_0: { scopes: ['view_shopping_lists:{projectKey}'] }]
     queryParameters:
       expand:
@@ -125,9 +133,11 @@ post:
           application/json:
             example: !include ../examples/shopping-list.example.json
   head:
+    displayName: Check if ShoppingList exists by ID
     securedBy: [oauth_2_0: { scopes: ['view_shopping_lists:{projectKey}'] }]
     description: Checks if a ShoppingList exists with the provided `id`. Returns a `200 OK` status if the ShoppingList exists, or [Not Found](/../api/errors#404-not-found) otherwise.
   post:
+    displayName: Update ShoppingList by ID
     securedBy: [oauth_2_0: { scopes: ['manage_shopping_lists:{projectKey}'] }]
     queryParameters:
       expand:
@@ -145,6 +155,7 @@ post:
           application/json:
             example: !include ../examples/shopping-list.example.json
   delete:
+    displayName: Delete ShoppingList by ID
     is:
       - dataErasure
     securedBy: [oauth_2_0: { scopes: ['manage_shopping_lists:{projectKey}'] }]