From 6d93e58c987c545142f8504c5eb6b464ac45da86 Mon Sep 17 00:00:00 2001
From: Nico Kroll <kroll@prm-ag.de>
Date: Wed, 15 Oct 2025 11:17:18 +0200
Subject: [PATCH] New Endpoint for StockDetails of an article

And some more descriptions for stock coloumns. The clients are using often abbreviations
---
 src/v2/shop.yaml | 79 +++++++++++++++++++++++++++++++++++++++---------
 1 file changed, 65 insertions(+), 14 deletions(-)

diff --git a/src/v2/shop.yaml b/src/v2/shop.yaml
index 8f88395..439861b 100644
--- a/src/v2/shop.yaml
+++ b/src/v2/shop.yaml
@@ -1,7 +1,7 @@
 openapi: 3.0.0
 info:
     title: "TyrePro-API, Shop"
-    version: "Version 10"
+    version: "Version 11"
 servers:
     - url: "https://musterreifen.com/api/shop"
       description: "Development server, customers domain"
@@ -511,6 +511,7 @@ paths:
       - $ref: "#/components/parameters/GuidHubBoreHole"
       - $ref: "#/components/parameters/GuidManufacturer"
       - $ref: "#/components/parameters/BinaryObjectContentType"
+      - $ref: "#/components/parameters/GuidDeliveryType"
       - name: "GuidBranch"
         description: "Required for providing stock and price information."
         in: "query"
@@ -519,14 +520,6 @@ paths:
           type: "string"
           default: null
           example: "ebb89e89-8d25-809e-7814-c53b686ae164"
-      - name: "GuidDeliveryType"
-        description: "For providing more accurate stock and price information."
-        in: "query"
-        required: false
-        schema:
-          type: "string"
-          default: null
-          example: "ebb89e89-8d25-809e-7814-c53b686ae164"
       - name: "GuidCalculationProfile"
         description: "If provided, the prices will base on this profile."
         in: "query"
@@ -580,6 +573,33 @@ paths:
           $ref: "#/components/responses/GenericError"
       security: 
       - SessionScheme: []
+  /ShopArticleStockDetails:
+    get:
+      tags:
+      - "Search"
+      parameters:
+      - $ref: "#/components/parameters/GuidOnlineService"
+      - $ref: "#/components/parameters/GuidDeliveryType"
+      - name: "GuidShopArticle"
+        in: "query"
+        required: true
+        schema:
+          type: "string"
+          default: null
+          example: "ebb89e89-8d25-809e-7814-c53b686ae164"
+      responses:
+        200:
+          description: "successful operation"
+          content:
+            application/json:
+              schema:
+                type: "array"
+                items:
+                  $ref: "#/components/schemas/ShopArticleStockDetail"
+        default:
+          $ref: "#/components/responses/GenericError"
+      security: 
+      - SessionScheme: []
 # Calculation
   /CalculationProfiles:
     get:
@@ -1348,13 +1368,19 @@ components:
               items:
                 type: "object"
                 required:
-                  - "Designation"
                   - "FieldName"
+                  - "Abbreviation"
+                  - "Designation"
                   - "DataType"
+                  - "StockDetailsAreAvailable"
                 properties:
+                  FieldName:
+                    type: "string"
+                  Abbreviation:
+                    type: "string"
                   Designation:
                     type: "string"
-                  FieldName:
+                  Description:
                     type: "string"
                   DataType:
                     type: "string"
@@ -1366,6 +1392,8 @@ components:
                       - "date"
                       - "dateTime"
                       - "stock"
+                  StockDetailsAreAvailable:
+                    type: "boolean"
         Module:
           type: "object"
           required:
@@ -1507,14 +1535,11 @@ components:
                 required:
                   - "FieldName"
                   - "Amount"
-                  - "StockType"
                 properties:
                   FieldName:
                     type: "string"
                   Amount:
                     type: "number"
-                  StockType:
-                    type: "string"
                   DeliveryDate:
                     type: "string"
                     format: "date"
@@ -1569,6 +1594,24 @@ components:
                     type: "string"
                   File:
                     $ref: "#/components/schemas/DbBlob"
+        ShopArticleStockDetail:
+          type: "object"
+          required:
+            - "FieldName"
+            - "Designation"
+            - "Amount"
+          properties:
+            FieldName:
+              type: "string"
+            Designation:
+              type: "string"
+            GuidBranch:
+              type: "string"
+            Amount:
+              type: "number"
+            DeliveryDate:
+              type: "string"
+              format: "date"
         MaterialType:
           type: "object"
           required:
@@ -2020,6 +2063,14 @@ components:
           type: "string"
           default: null
           example: "ebb89e89-8d25-809e-7814-c53b686ae164"          
+      GuidDeliveryType:
+        description: "For providing more accurate stock and price information."
+        in: "query"
+        required: false
+        schema:
+          type: "string"
+          default: null
+          example: "ebb89e89-8d25-809e-7814-c53b686ae164"
       GuidMaterialType:
         name: "GuidMaterialType"
         in: "query"