src/openapi/products/SE-vouchers-TP.yaml

@@ -6,16 +6,16 @@ info:
 servers:
   - url: https://services.acc.api.htm.nl/abt/abtvouchersTouchpoint/1.0
 paths:
-  /issuedvouchers/{voucherCode}:
+  /issuedvouchers:
     get:
-      summary: Get details of a voucher, that was issued for a specific touch point
+      summary: Get a list of issued vouchers that were issued for a specific touch point
       description:
-        Get details of an issued voucher for a specific touch point. This means that only products that the calling touch point is allowed to see or sell
+        Retrieve all issued vouchers for a specific touch point. This means that only products that the calling touch point is allowed to see or sell
         (i.e. has active sellingPeriods for touchPointId of the calling touch point) are returned.
       parameters:
         - name: voucherCode
-          in: path
+          in: query
-          required: true
+          required: false
           description: The unique code of the issued voucher to retrieve.
           schema:
             type: string
@@ -33,12 +33,16 @@ paths:
                 Voucher for a product with required attributes:
                   summary: Voucher for a single product with required attributes
                   value:
+                    {
+                      "issuedVouchers":
+                        [
                           {
                             "issuedVoucherId": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90",
                             "voucherCode": "VOUCHER123",
                             "fromInclusive": "2024-10-04T00:00:00.000",
                             "untilInclusive": "2024-11-04T00:00:00.000",
-                      "voucherStatus": { "voucherStatusId": 1, "name": "New" },
+                            "voucherStatus":
+                              { "voucherStatusId": 1, "name": "New" },
                             "product":
                               {
                                 "productId": 263,
@@ -80,23 +84,29 @@ paths:
                               [
                                 {
                                   "mandatoryCustomerDataItemId": 8,
-                            "customerDataItem": "padBirthDate",
+                                  "customerDataItem": "padBirthDate"                                 
                                 },
                                 {
                                   "mandatoryCustomerDataItemId": 4,
-                            "customerDataItem": "emailAddress",
+                                  "customerDataItem": "emailAddress"                                 
+                                },
+                              ],
                           },
                         ],
                     }
                 Voucher for a whole order:
                   summary: Voucher for a whole order
                   value:
+                    {
+                      "issuedVouchers":
+                        [
                           {
                             "issuedVoucherId": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90",
                             "voucherCode": "VOUCHER123",
                             "fromInclusive": "2024-10-04T00:00:00.000",
                             "untilInclusive": "2024-11-04T00:00:00.000",
-                      "voucherStatus": { "voucherStatusId": 1, "name": "New" },
+                            "voucherStatus":
+                              { "voucherStatusId": 1, "name": "New" },
                             "product":
                               {
                                 "productId": 263,
@@ -119,7 +129,9 @@ paths:
                                       },
                                   },
                               },
+                          },
                           "mandatoryCustomerDataItems": [],
+                        ],
                     }
         "403":
           description: Forbidden